@munchi_oy/core 2.3.0 → 2.5.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/dist/generated/api.d.ts +1405 -44
- package/dist/generated/api.d.ts.map +1 -1
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/dist/src/version.d.ts +1 -1
- package/dist/tsconfig.build.tsbuildinfo +1 -1
- package/generated/api.ts +1728 -45
- package/package.json +1 -1
- package/src/version.ts +1 -1
package/dist/generated/api.d.ts
CHANGED
|
@@ -2572,6 +2572,31 @@ export interface ChangeEmployeeRoleDto {
|
|
|
2572
2572
|
*/
|
|
2573
2573
|
'permissionKeys'?: Array<PosPermission>;
|
|
2574
2574
|
}
|
|
2575
|
+
/**
|
|
2576
|
+
*
|
|
2577
|
+
* @export
|
|
2578
|
+
* @interface ChangeKioskDto
|
|
2579
|
+
*/
|
|
2580
|
+
export interface ChangeKioskDto {
|
|
2581
|
+
/**
|
|
2582
|
+
* The kiosk\'s new name; left out, it keeps its name
|
|
2583
|
+
* @type {string}
|
|
2584
|
+
* @memberof ChangeKioskDto
|
|
2585
|
+
*/
|
|
2586
|
+
'name'?: string;
|
|
2587
|
+
/**
|
|
2588
|
+
* What the kiosk\'s order numbers start with, an empty text for none; left out, it keeps its prefix
|
|
2589
|
+
* @type {string}
|
|
2590
|
+
* @memberof ChangeKioskDto
|
|
2591
|
+
*/
|
|
2592
|
+
'prefix'?: string;
|
|
2593
|
+
/**
|
|
2594
|
+
*
|
|
2595
|
+
* @type {Status}
|
|
2596
|
+
* @memberof ChangeKioskDto
|
|
2597
|
+
*/
|
|
2598
|
+
'status'?: Status;
|
|
2599
|
+
}
|
|
2575
2600
|
/**
|
|
2576
2601
|
*
|
|
2577
2602
|
* @export
|
|
@@ -3025,6 +3050,31 @@ export declare const CheckoutModelEnum: {
|
|
|
3025
3050
|
readonly Full: "FULL";
|
|
3026
3051
|
};
|
|
3027
3052
|
export type CheckoutModelEnum = typeof CheckoutModelEnum[keyof typeof CheckoutModelEnum];
|
|
3053
|
+
/**
|
|
3054
|
+
*
|
|
3055
|
+
* @export
|
|
3056
|
+
* @interface ClaimKioskDto
|
|
3057
|
+
*/
|
|
3058
|
+
export interface ClaimKioskDto {
|
|
3059
|
+
/**
|
|
3060
|
+
* The Hardware ID the kiosk shows on its Getting started screen, exactly as shown; it is the id the device sends in X-Munchi-Hardware-Id
|
|
3061
|
+
* @type {string}
|
|
3062
|
+
* @memberof ClaimKioskDto
|
|
3063
|
+
*/
|
|
3064
|
+
'hardwareId': string;
|
|
3065
|
+
/**
|
|
3066
|
+
* The kiosk\'s name, as the venue\'s staff call it
|
|
3067
|
+
* @type {string}
|
|
3068
|
+
* @memberof ClaimKioskDto
|
|
3069
|
+
*/
|
|
3070
|
+
'name': string;
|
|
3071
|
+
/**
|
|
3072
|
+
* What the kiosk\'s order numbers start with. Left out, a new kiosk has none and a kiosk the venue had keeps its own
|
|
3073
|
+
* @type {string}
|
|
3074
|
+
* @memberof ClaimKioskDto
|
|
3075
|
+
*/
|
|
3076
|
+
'prefix'?: string;
|
|
3077
|
+
}
|
|
3028
3078
|
/**
|
|
3029
3079
|
*
|
|
3030
3080
|
* @export
|
|
@@ -11026,6 +11076,31 @@ export interface KioskStatusDto {
|
|
|
11026
11076
|
*/
|
|
11027
11077
|
'payment_event': PaymentEventType;
|
|
11028
11078
|
}
|
|
11079
|
+
/**
|
|
11080
|
+
*
|
|
11081
|
+
* @export
|
|
11082
|
+
* @interface KioskTerminalDto
|
|
11083
|
+
*/
|
|
11084
|
+
export interface KioskTerminalDto {
|
|
11085
|
+
/**
|
|
11086
|
+
* The payment terminal\'s id
|
|
11087
|
+
* @type {string}
|
|
11088
|
+
* @memberof KioskTerminalDto
|
|
11089
|
+
*/
|
|
11090
|
+
'id': string;
|
|
11091
|
+
/**
|
|
11092
|
+
*
|
|
11093
|
+
* @type {PaymentProvider}
|
|
11094
|
+
* @memberof KioskTerminalDto
|
|
11095
|
+
*/
|
|
11096
|
+
'provider': PaymentProvider;
|
|
11097
|
+
/**
|
|
11098
|
+
* The terminal\'s label; null when it was given none
|
|
11099
|
+
* @type {string}
|
|
11100
|
+
* @memberof KioskTerminalDto
|
|
11101
|
+
*/
|
|
11102
|
+
'label': string | null;
|
|
11103
|
+
}
|
|
11029
11104
|
/**
|
|
11030
11105
|
*
|
|
11031
11106
|
* @export
|
|
@@ -11152,6 +11227,19 @@ export interface LapseResponseDto {
|
|
|
11152
11227
|
*/
|
|
11153
11228
|
'businessDayScheduleId': string;
|
|
11154
11229
|
}
|
|
11230
|
+
/**
|
|
11231
|
+
*
|
|
11232
|
+
* @export
|
|
11233
|
+
* @interface LinkKioskTerminalDto
|
|
11234
|
+
*/
|
|
11235
|
+
export interface LinkKioskTerminalDto {
|
|
11236
|
+
/**
|
|
11237
|
+
* The id of one of the venue\'s payment terminals, as the venue\'s terminal list answers it, or null to unlink the kiosk\'s terminal
|
|
11238
|
+
* @type {string}
|
|
11239
|
+
* @memberof LinkKioskTerminalDto
|
|
11240
|
+
*/
|
|
11241
|
+
'paymentTerminalId': string | null;
|
|
11242
|
+
}
|
|
11155
11243
|
/**
|
|
11156
11244
|
*
|
|
11157
11245
|
* @export
|
|
@@ -14328,7 +14416,7 @@ export interface OrderHistoryPosResponseDtoV2Pagination {
|
|
|
14328
14416
|
*/
|
|
14329
14417
|
export interface OrderHistoryPosResponseDtoV2Summary {
|
|
14330
14418
|
/**
|
|
14331
|
-
* How many orders of the period count: online, every order
|
|
14419
|
+
* How many orders of the period count: online, every order neither rejected nor fully refunded; POS, every order not fully refunded (with a payment filter, only those with a matching payment). 0 when the person on the till may not see it.
|
|
14332
14420
|
* @type {number}
|
|
14333
14421
|
* @memberof OrderHistoryPosResponseDtoV2Summary
|
|
14334
14422
|
*/
|
|
@@ -14340,7 +14428,7 @@ export interface OrderHistoryPosResponseDtoV2Summary {
|
|
|
14340
14428
|
*/
|
|
14341
14429
|
'rejectedOrders': number;
|
|
14342
14430
|
/**
|
|
14343
|
-
* The period\'s sales in euros (not cents): online, the net total of the orders
|
|
14431
|
+
* The period\'s sales in euros (not cents): online, the net total of the orders neither rejected nor fully refunded, less their completed refunds; POS, the payments less successful refunds. 0 when the person on the till may not see it.
|
|
14344
14432
|
* @type {number}
|
|
14345
14433
|
* @memberof OrderHistoryPosResponseDtoV2Summary
|
|
14346
14434
|
*/
|
|
@@ -14398,7 +14486,7 @@ export interface OrderHistoryResponseDto {
|
|
|
14398
14486
|
*/
|
|
14399
14487
|
export interface OrderHistoryResponseDtoSummary {
|
|
14400
14488
|
/**
|
|
14401
|
-
* How many orders of the period count: online, every order
|
|
14489
|
+
* How many orders of the period count: online, every order neither rejected nor fully refunded; POS, every order not fully refunded (with a payment filter, only those with a matching payment). 0 when the person on the till may not see it.
|
|
14402
14490
|
* @type {number}
|
|
14403
14491
|
* @memberof OrderHistoryResponseDtoSummary
|
|
14404
14492
|
*/
|
|
@@ -14410,7 +14498,7 @@ export interface OrderHistoryResponseDtoSummary {
|
|
|
14410
14498
|
*/
|
|
14411
14499
|
'rejectedOrders': number;
|
|
14412
14500
|
/**
|
|
14413
|
-
* The period\'s sales in euros (not cents): online, the net total of the orders
|
|
14501
|
+
* The period\'s sales in euros (not cents): online, the net total of the orders neither rejected nor fully refunded, less their completed refunds; POS, the payments less successful refunds. 0 when the person on the till may not see it.
|
|
14414
14502
|
* @type {number}
|
|
14415
14503
|
* @memberof OrderHistoryResponseDtoSummary
|
|
14416
14504
|
*/
|
|
@@ -15408,7 +15496,7 @@ export interface OrderStatusResponseDtoOrder {
|
|
|
15408
15496
|
*/
|
|
15409
15497
|
export interface OrderSummaryDto {
|
|
15410
15498
|
/**
|
|
15411
|
-
* How many orders of the period count: online, every order
|
|
15499
|
+
* How many orders of the period count: online, every order neither rejected nor fully refunded; POS, every order not fully refunded (with a payment filter, only those with a matching payment). 0 when the person on the till may not see it.
|
|
15412
15500
|
* @type {number}
|
|
15413
15501
|
* @memberof OrderSummaryDto
|
|
15414
15502
|
*/
|
|
@@ -15420,7 +15508,7 @@ export interface OrderSummaryDto {
|
|
|
15420
15508
|
*/
|
|
15421
15509
|
'rejectedOrders': number;
|
|
15422
15510
|
/**
|
|
15423
|
-
* The period\'s sales in euros (not cents): online, the net total of the orders
|
|
15511
|
+
* The period\'s sales in euros (not cents): online, the net total of the orders neither rejected nor fully refunded, less their completed refunds; POS, the payments less successful refunds. 0 when the person on the till may not see it.
|
|
15424
15512
|
* @type {number}
|
|
15425
15513
|
* @memberof OrderSummaryDto
|
|
15426
15514
|
*/
|
|
@@ -21159,7 +21247,7 @@ export interface PosOrderSuboptionDto {
|
|
|
21159
21247
|
*/
|
|
21160
21248
|
export interface PosOrderSummaryDto {
|
|
21161
21249
|
/**
|
|
21162
|
-
* How many orders of the period count: online, every order
|
|
21250
|
+
* How many orders of the period count: online, every order neither rejected nor fully refunded; POS, every order not fully refunded (with a payment filter, only those with a matching payment). 0 when the person on the till may not see it.
|
|
21163
21251
|
* @type {number}
|
|
21164
21252
|
* @memberof PosOrderSummaryDto
|
|
21165
21253
|
*/
|
|
@@ -21171,7 +21259,7 @@ export interface PosOrderSummaryDto {
|
|
|
21171
21259
|
*/
|
|
21172
21260
|
'rejectedOrders': number;
|
|
21173
21261
|
/**
|
|
21174
|
-
* The period\'s sales in euros (not cents): online, the net total of the orders
|
|
21262
|
+
* The period\'s sales in euros (not cents): online, the net total of the orders neither rejected nor fully refunded, less their completed refunds; POS, the payments less successful refunds. 0 when the person on the till may not see it.
|
|
21175
21263
|
* @type {number}
|
|
21176
21264
|
* @memberof PosOrderSummaryDto
|
|
21177
21265
|
*/
|
|
@@ -23405,6 +23493,686 @@ export declare const PubSubTarget: {
|
|
|
23405
23493
|
readonly Kds: "KDS";
|
|
23406
23494
|
};
|
|
23407
23495
|
export type PubSubTarget = typeof PubSubTarget[keyof typeof PubSubTarget];
|
|
23496
|
+
/**
|
|
23497
|
+
*
|
|
23498
|
+
* @export
|
|
23499
|
+
* @interface PublicReportHoursDto
|
|
23500
|
+
*/
|
|
23501
|
+
export interface PublicReportHoursDto {
|
|
23502
|
+
/**
|
|
23503
|
+
*
|
|
23504
|
+
* @type {PublicReportHoursDtoPeriod}
|
|
23505
|
+
* @memberof PublicReportHoursDto
|
|
23506
|
+
*/
|
|
23507
|
+
'period': PublicReportHoursDtoPeriod;
|
|
23508
|
+
/**
|
|
23509
|
+
*
|
|
23510
|
+
* @type {PublicReportHoursDtoToday}
|
|
23511
|
+
* @memberof PublicReportHoursDto
|
|
23512
|
+
*/
|
|
23513
|
+
'today': PublicReportHoursDtoToday;
|
|
23514
|
+
/**
|
|
23515
|
+
*
|
|
23516
|
+
* @type {PublicReportHoursDtoNormal}
|
|
23517
|
+
* @memberof PublicReportHoursDto
|
|
23518
|
+
*/
|
|
23519
|
+
'normal': PublicReportHoursDtoNormal;
|
|
23520
|
+
}
|
|
23521
|
+
/**
|
|
23522
|
+
* A normal day: today\'s weekday over the 8 weeks before today, averaged per hour (isoWeekday)
|
|
23523
|
+
* @export
|
|
23524
|
+
* @interface PublicReportHoursDtoNormal
|
|
23525
|
+
*/
|
|
23526
|
+
export interface PublicReportHoursDtoNormal {
|
|
23527
|
+
/**
|
|
23528
|
+
* The first instant of the period, ISO 8601 in UTC
|
|
23529
|
+
* @type {string}
|
|
23530
|
+
* @memberof PublicReportHoursDtoNormal
|
|
23531
|
+
*/
|
|
23532
|
+
'reportDateStart': string;
|
|
23533
|
+
/**
|
|
23534
|
+
* The last instant of the period, ISO 8601 in UTC; now, when the period ends later
|
|
23535
|
+
* @type {string}
|
|
23536
|
+
* @memberof PublicReportHoursDtoNormal
|
|
23537
|
+
*/
|
|
23538
|
+
'reportDateEnd': string;
|
|
23539
|
+
/**
|
|
23540
|
+
* The IANA time zone the period\'s days are read in
|
|
23541
|
+
* @type {string}
|
|
23542
|
+
* @memberof PublicReportHoursDtoNormal
|
|
23543
|
+
*/
|
|
23544
|
+
'timezone': string;
|
|
23545
|
+
/**
|
|
23546
|
+
* The first business day, YYYY-MM-DD
|
|
23547
|
+
* @type {string}
|
|
23548
|
+
* @memberof PublicReportHoursDtoNormal
|
|
23549
|
+
*/
|
|
23550
|
+
'firstBusinessDay': string;
|
|
23551
|
+
/**
|
|
23552
|
+
* The last business day, YYYY-MM-DD, inclusive
|
|
23553
|
+
* @type {string}
|
|
23554
|
+
* @memberof PublicReportHoursDtoNormal
|
|
23555
|
+
*/
|
|
23556
|
+
'lastBusinessDay': string;
|
|
23557
|
+
/**
|
|
23558
|
+
* The ISO weekday counted, 1 Monday to 7 Sunday, or null for every day
|
|
23559
|
+
* @type {number}
|
|
23560
|
+
* @memberof PublicReportHoursDtoNormal
|
|
23561
|
+
*/
|
|
23562
|
+
'isoWeekday': number | null;
|
|
23563
|
+
/**
|
|
23564
|
+
* 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
|
|
23565
|
+
* @type {number}
|
|
23566
|
+
* @memberof PublicReportHoursDtoNormal
|
|
23567
|
+
*/
|
|
23568
|
+
'daysCounted': number;
|
|
23569
|
+
/**
|
|
23570
|
+
* The newest BigQuery rebuild the rows read, ISO 8601 in UTC; null when none
|
|
23571
|
+
* @type {string}
|
|
23572
|
+
* @memberof PublicReportHoursDtoNormal
|
|
23573
|
+
*/
|
|
23574
|
+
'dataUntil': string | null;
|
|
23575
|
+
/**
|
|
23576
|
+
* One group per venue, app and currency the breakdown keeps
|
|
23577
|
+
* @type {Array<SalesReportHoursGroupDto>}
|
|
23578
|
+
* @memberof PublicReportHoursDtoNormal
|
|
23579
|
+
*/
|
|
23580
|
+
'groups': Array<SalesReportHoursGroupDto>;
|
|
23581
|
+
}
|
|
23582
|
+
/**
|
|
23583
|
+
* The period\'s hours
|
|
23584
|
+
* @export
|
|
23585
|
+
* @interface PublicReportHoursDtoPeriod
|
|
23586
|
+
*/
|
|
23587
|
+
export interface PublicReportHoursDtoPeriod {
|
|
23588
|
+
/**
|
|
23589
|
+
* The first instant of the period, ISO 8601 in UTC
|
|
23590
|
+
* @type {string}
|
|
23591
|
+
* @memberof PublicReportHoursDtoPeriod
|
|
23592
|
+
*/
|
|
23593
|
+
'reportDateStart': string;
|
|
23594
|
+
/**
|
|
23595
|
+
* The last instant of the period, ISO 8601 in UTC; now, when the period ends later
|
|
23596
|
+
* @type {string}
|
|
23597
|
+
* @memberof PublicReportHoursDtoPeriod
|
|
23598
|
+
*/
|
|
23599
|
+
'reportDateEnd': string;
|
|
23600
|
+
/**
|
|
23601
|
+
* The IANA time zone the period\'s days are read in
|
|
23602
|
+
* @type {string}
|
|
23603
|
+
* @memberof PublicReportHoursDtoPeriod
|
|
23604
|
+
*/
|
|
23605
|
+
'timezone': string;
|
|
23606
|
+
/**
|
|
23607
|
+
* The first business day, YYYY-MM-DD
|
|
23608
|
+
* @type {string}
|
|
23609
|
+
* @memberof PublicReportHoursDtoPeriod
|
|
23610
|
+
*/
|
|
23611
|
+
'firstBusinessDay': string;
|
|
23612
|
+
/**
|
|
23613
|
+
* The last business day, YYYY-MM-DD, inclusive
|
|
23614
|
+
* @type {string}
|
|
23615
|
+
* @memberof PublicReportHoursDtoPeriod
|
|
23616
|
+
*/
|
|
23617
|
+
'lastBusinessDay': string;
|
|
23618
|
+
/**
|
|
23619
|
+
* The ISO weekday counted, 1 Monday to 7 Sunday, or null for every day
|
|
23620
|
+
* @type {number}
|
|
23621
|
+
* @memberof PublicReportHoursDtoPeriod
|
|
23622
|
+
*/
|
|
23623
|
+
'isoWeekday': number | null;
|
|
23624
|
+
/**
|
|
23625
|
+
* 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
|
|
23626
|
+
* @type {number}
|
|
23627
|
+
* @memberof PublicReportHoursDtoPeriod
|
|
23628
|
+
*/
|
|
23629
|
+
'daysCounted': number;
|
|
23630
|
+
/**
|
|
23631
|
+
* The newest BigQuery rebuild the rows read, ISO 8601 in UTC; null when none
|
|
23632
|
+
* @type {string}
|
|
23633
|
+
* @memberof PublicReportHoursDtoPeriod
|
|
23634
|
+
*/
|
|
23635
|
+
'dataUntil': string | null;
|
|
23636
|
+
/**
|
|
23637
|
+
* One group per venue, app and currency the breakdown keeps
|
|
23638
|
+
* @type {Array<SalesReportHoursGroupDto>}
|
|
23639
|
+
* @memberof PublicReportHoursDtoPeriod
|
|
23640
|
+
*/
|
|
23641
|
+
'groups': Array<SalesReportHoursGroupDto>;
|
|
23642
|
+
}
|
|
23643
|
+
/**
|
|
23644
|
+
* Today\'s hours on the side\'s clock, so far
|
|
23645
|
+
* @export
|
|
23646
|
+
* @interface PublicReportHoursDtoToday
|
|
23647
|
+
*/
|
|
23648
|
+
export interface PublicReportHoursDtoToday {
|
|
23649
|
+
/**
|
|
23650
|
+
* The first instant of the period, ISO 8601 in UTC
|
|
23651
|
+
* @type {string}
|
|
23652
|
+
* @memberof PublicReportHoursDtoToday
|
|
23653
|
+
*/
|
|
23654
|
+
'reportDateStart': string;
|
|
23655
|
+
/**
|
|
23656
|
+
* The last instant of the period, ISO 8601 in UTC; now, when the period ends later
|
|
23657
|
+
* @type {string}
|
|
23658
|
+
* @memberof PublicReportHoursDtoToday
|
|
23659
|
+
*/
|
|
23660
|
+
'reportDateEnd': string;
|
|
23661
|
+
/**
|
|
23662
|
+
* The IANA time zone the period\'s days are read in
|
|
23663
|
+
* @type {string}
|
|
23664
|
+
* @memberof PublicReportHoursDtoToday
|
|
23665
|
+
*/
|
|
23666
|
+
'timezone': string;
|
|
23667
|
+
/**
|
|
23668
|
+
* The first business day, YYYY-MM-DD
|
|
23669
|
+
* @type {string}
|
|
23670
|
+
* @memberof PublicReportHoursDtoToday
|
|
23671
|
+
*/
|
|
23672
|
+
'firstBusinessDay': string;
|
|
23673
|
+
/**
|
|
23674
|
+
* The last business day, YYYY-MM-DD, inclusive
|
|
23675
|
+
* @type {string}
|
|
23676
|
+
* @memberof PublicReportHoursDtoToday
|
|
23677
|
+
*/
|
|
23678
|
+
'lastBusinessDay': string;
|
|
23679
|
+
/**
|
|
23680
|
+
* The ISO weekday counted, 1 Monday to 7 Sunday, or null for every day
|
|
23681
|
+
* @type {number}
|
|
23682
|
+
* @memberof PublicReportHoursDtoToday
|
|
23683
|
+
*/
|
|
23684
|
+
'isoWeekday': number | null;
|
|
23685
|
+
/**
|
|
23686
|
+
* 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
|
|
23687
|
+
* @type {number}
|
|
23688
|
+
* @memberof PublicReportHoursDtoToday
|
|
23689
|
+
*/
|
|
23690
|
+
'daysCounted': number;
|
|
23691
|
+
/**
|
|
23692
|
+
* The newest BigQuery rebuild the rows read, ISO 8601 in UTC; null when none
|
|
23693
|
+
* @type {string}
|
|
23694
|
+
* @memberof PublicReportHoursDtoToday
|
|
23695
|
+
*/
|
|
23696
|
+
'dataUntil': string | null;
|
|
23697
|
+
/**
|
|
23698
|
+
* One group per venue, app and currency the breakdown keeps
|
|
23699
|
+
* @type {Array<SalesReportHoursGroupDto>}
|
|
23700
|
+
* @memberof PublicReportHoursDtoToday
|
|
23701
|
+
*/
|
|
23702
|
+
'groups': Array<SalesReportHoursGroupDto>;
|
|
23703
|
+
}
|
|
23704
|
+
/**
|
|
23705
|
+
*
|
|
23706
|
+
* @export
|
|
23707
|
+
* @interface PublicReportNumbersDto
|
|
23708
|
+
*/
|
|
23709
|
+
export interface PublicReportNumbersDto {
|
|
23710
|
+
/**
|
|
23711
|
+
*
|
|
23712
|
+
* @type {PublicReportNumbersDtoA}
|
|
23713
|
+
* @memberof PublicReportNumbersDto
|
|
23714
|
+
*/
|
|
23715
|
+
'a': PublicReportNumbersDtoA | null;
|
|
23716
|
+
/**
|
|
23717
|
+
*
|
|
23718
|
+
* @type {PublicReportNumbersDtoB}
|
|
23719
|
+
* @memberof PublicReportNumbersDto
|
|
23720
|
+
*/
|
|
23721
|
+
'b'?: PublicReportNumbersDtoB | null;
|
|
23722
|
+
}
|
|
23723
|
+
/**
|
|
23724
|
+
* Side A\'s numbers; null when its stores are none of the report\'s own or it could not be read
|
|
23725
|
+
* @export
|
|
23726
|
+
* @interface PublicReportNumbersDtoA
|
|
23727
|
+
*/
|
|
23728
|
+
export interface PublicReportNumbersDtoA {
|
|
23729
|
+
/**
|
|
23730
|
+
* 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
|
|
23731
|
+
* @type {Array<number>}
|
|
23732
|
+
* @memberof PublicReportNumbersDtoA
|
|
23733
|
+
*/
|
|
23734
|
+
'stores': Array<number>;
|
|
23735
|
+
/**
|
|
23736
|
+
*
|
|
23737
|
+
* @type {PublicReportSideNumbersDtoSales}
|
|
23738
|
+
* @memberof PublicReportNumbersDtoA
|
|
23739
|
+
*/
|
|
23740
|
+
'sales': PublicReportSideNumbersDtoSales;
|
|
23741
|
+
/**
|
|
23742
|
+
*
|
|
23743
|
+
* @type {PublicReportSideNumbersDtoTrend}
|
|
23744
|
+
* @memberof PublicReportNumbersDtoA
|
|
23745
|
+
*/
|
|
23746
|
+
'trend'?: PublicReportSideNumbersDtoTrend;
|
|
23747
|
+
/**
|
|
23748
|
+
*
|
|
23749
|
+
* @type {PublicReportSideNumbersDtoYear}
|
|
23750
|
+
* @memberof PublicReportNumbersDtoA
|
|
23751
|
+
*/
|
|
23752
|
+
'year'?: PublicReportSideNumbersDtoYear;
|
|
23753
|
+
/**
|
|
23754
|
+
*
|
|
23755
|
+
* @type {PublicReportSideNumbersDtoHours}
|
|
23756
|
+
* @memberof PublicReportNumbersDtoA
|
|
23757
|
+
*/
|
|
23758
|
+
'hours'?: PublicReportSideNumbersDtoHours;
|
|
23759
|
+
/**
|
|
23760
|
+
*
|
|
23761
|
+
* @type {PublicReportSideNumbersDtoBoughtTogether}
|
|
23762
|
+
* @memberof PublicReportNumbersDtoA
|
|
23763
|
+
*/
|
|
23764
|
+
'boughtTogether'?: PublicReportSideNumbersDtoBoughtTogether;
|
|
23765
|
+
/**
|
|
23766
|
+
*
|
|
23767
|
+
* @type {PublicReportSideNumbersDtoOrderTypes}
|
|
23768
|
+
* @memberof PublicReportNumbersDtoA
|
|
23769
|
+
*/
|
|
23770
|
+
'orderTypes'?: PublicReportSideNumbersDtoOrderTypes;
|
|
23771
|
+
}
|
|
23772
|
+
/**
|
|
23773
|
+
* A comparison\'s side B; absent for a report
|
|
23774
|
+
* @export
|
|
23775
|
+
* @interface PublicReportNumbersDtoB
|
|
23776
|
+
*/
|
|
23777
|
+
export interface PublicReportNumbersDtoB {
|
|
23778
|
+
/**
|
|
23779
|
+
* 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
|
|
23780
|
+
* @type {Array<number>}
|
|
23781
|
+
* @memberof PublicReportNumbersDtoB
|
|
23782
|
+
*/
|
|
23783
|
+
'stores': Array<number>;
|
|
23784
|
+
/**
|
|
23785
|
+
*
|
|
23786
|
+
* @type {PublicReportSideNumbersDtoSales}
|
|
23787
|
+
* @memberof PublicReportNumbersDtoB
|
|
23788
|
+
*/
|
|
23789
|
+
'sales': PublicReportSideNumbersDtoSales;
|
|
23790
|
+
/**
|
|
23791
|
+
*
|
|
23792
|
+
* @type {PublicReportSideNumbersDtoTrend}
|
|
23793
|
+
* @memberof PublicReportNumbersDtoB
|
|
23794
|
+
*/
|
|
23795
|
+
'trend'?: PublicReportSideNumbersDtoTrend;
|
|
23796
|
+
/**
|
|
23797
|
+
*
|
|
23798
|
+
* @type {PublicReportSideNumbersDtoYear}
|
|
23799
|
+
* @memberof PublicReportNumbersDtoB
|
|
23800
|
+
*/
|
|
23801
|
+
'year'?: PublicReportSideNumbersDtoYear;
|
|
23802
|
+
/**
|
|
23803
|
+
*
|
|
23804
|
+
* @type {PublicReportSideNumbersDtoHours}
|
|
23805
|
+
* @memberof PublicReportNumbersDtoB
|
|
23806
|
+
*/
|
|
23807
|
+
'hours'?: PublicReportSideNumbersDtoHours;
|
|
23808
|
+
/**
|
|
23809
|
+
*
|
|
23810
|
+
* @type {PublicReportSideNumbersDtoBoughtTogether}
|
|
23811
|
+
* @memberof PublicReportNumbersDtoB
|
|
23812
|
+
*/
|
|
23813
|
+
'boughtTogether'?: PublicReportSideNumbersDtoBoughtTogether;
|
|
23814
|
+
/**
|
|
23815
|
+
*
|
|
23816
|
+
* @type {PublicReportSideNumbersDtoOrderTypes}
|
|
23817
|
+
* @memberof PublicReportNumbersDtoB
|
|
23818
|
+
*/
|
|
23819
|
+
'orderTypes'?: PublicReportSideNumbersDtoOrderTypes;
|
|
23820
|
+
}
|
|
23821
|
+
/**
|
|
23822
|
+
*
|
|
23823
|
+
* @export
|
|
23824
|
+
* @interface PublicReportSideNumbersDto
|
|
23825
|
+
*/
|
|
23826
|
+
export interface PublicReportSideNumbersDto {
|
|
23827
|
+
/**
|
|
23828
|
+
* 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
|
|
23829
|
+
* @type {Array<number>}
|
|
23830
|
+
* @memberof PublicReportSideNumbersDto
|
|
23831
|
+
*/
|
|
23832
|
+
'stores': Array<number>;
|
|
23833
|
+
/**
|
|
23834
|
+
*
|
|
23835
|
+
* @type {PublicReportSideNumbersDtoSales}
|
|
23836
|
+
* @memberof PublicReportSideNumbersDto
|
|
23837
|
+
*/
|
|
23838
|
+
'sales': PublicReportSideNumbersDtoSales;
|
|
23839
|
+
/**
|
|
23840
|
+
*
|
|
23841
|
+
* @type {PublicReportSideNumbersDtoTrend}
|
|
23842
|
+
* @memberof PublicReportSideNumbersDto
|
|
23843
|
+
*/
|
|
23844
|
+
'trend'?: PublicReportSideNumbersDtoTrend;
|
|
23845
|
+
/**
|
|
23846
|
+
*
|
|
23847
|
+
* @type {PublicReportSideNumbersDtoYear}
|
|
23848
|
+
* @memberof PublicReportSideNumbersDto
|
|
23849
|
+
*/
|
|
23850
|
+
'year'?: PublicReportSideNumbersDtoYear;
|
|
23851
|
+
/**
|
|
23852
|
+
*
|
|
23853
|
+
* @type {PublicReportSideNumbersDtoHours}
|
|
23854
|
+
* @memberof PublicReportSideNumbersDto
|
|
23855
|
+
*/
|
|
23856
|
+
'hours'?: PublicReportSideNumbersDtoHours;
|
|
23857
|
+
/**
|
|
23858
|
+
*
|
|
23859
|
+
* @type {PublicReportSideNumbersDtoBoughtTogether}
|
|
23860
|
+
* @memberof PublicReportSideNumbersDto
|
|
23861
|
+
*/
|
|
23862
|
+
'boughtTogether'?: PublicReportSideNumbersDtoBoughtTogether;
|
|
23863
|
+
/**
|
|
23864
|
+
*
|
|
23865
|
+
* @type {PublicReportSideNumbersDtoOrderTypes}
|
|
23866
|
+
* @memberof PublicReportSideNumbersDto
|
|
23867
|
+
*/
|
|
23868
|
+
'orderTypes'?: PublicReportSideNumbersDtoOrderTypes;
|
|
23869
|
+
}
|
|
23870
|
+
/**
|
|
23871
|
+
* Items bought together, as GET /api/v6/report/sales/bought-together; only when a card shows them
|
|
23872
|
+
* @export
|
|
23873
|
+
* @interface PublicReportSideNumbersDtoBoughtTogether
|
|
23874
|
+
*/
|
|
23875
|
+
export interface PublicReportSideNumbersDtoBoughtTogether {
|
|
23876
|
+
/**
|
|
23877
|
+
* The first instant of the period, ISO 8601 in UTC
|
|
23878
|
+
* @type {string}
|
|
23879
|
+
* @memberof PublicReportSideNumbersDtoBoughtTogether
|
|
23880
|
+
*/
|
|
23881
|
+
'reportDateStart': string;
|
|
23882
|
+
/**
|
|
23883
|
+
* The last instant of the period, ISO 8601 in UTC; now, when the period ends later
|
|
23884
|
+
* @type {string}
|
|
23885
|
+
* @memberof PublicReportSideNumbersDtoBoughtTogether
|
|
23886
|
+
*/
|
|
23887
|
+
'reportDateEnd': string;
|
|
23888
|
+
/**
|
|
23889
|
+
* The IANA time zone the period\'s days are read in
|
|
23890
|
+
* @type {string}
|
|
23891
|
+
* @memberof PublicReportSideNumbersDtoBoughtTogether
|
|
23892
|
+
*/
|
|
23893
|
+
'timezone': string;
|
|
23894
|
+
/**
|
|
23895
|
+
* The first business day, YYYY-MM-DD
|
|
23896
|
+
* @type {string}
|
|
23897
|
+
* @memberof PublicReportSideNumbersDtoBoughtTogether
|
|
23898
|
+
*/
|
|
23899
|
+
'firstBusinessDay': string;
|
|
23900
|
+
/**
|
|
23901
|
+
* The last business day, YYYY-MM-DD, inclusive
|
|
23902
|
+
* @type {string}
|
|
23903
|
+
* @memberof PublicReportSideNumbersDtoBoughtTogether
|
|
23904
|
+
*/
|
|
23905
|
+
'lastBusinessDay': string;
|
|
23906
|
+
/**
|
|
23907
|
+
* The newest BigQuery rebuild the rows read, ISO 8601 in UTC; null when none
|
|
23908
|
+
* @type {string}
|
|
23909
|
+
* @memberof PublicReportSideNumbersDtoBoughtTogether
|
|
23910
|
+
*/
|
|
23911
|
+
'dataUntil': string | null;
|
|
23912
|
+
/**
|
|
23913
|
+
* One group per venue, app and currency the breakdown keeps
|
|
23914
|
+
* @type {Array<SalesReportBoughtTogetherGroupDto>}
|
|
23915
|
+
* @memberof PublicReportSideNumbersDtoBoughtTogether
|
|
23916
|
+
*/
|
|
23917
|
+
'groups': Array<SalesReportBoughtTogetherGroupDto>;
|
|
23918
|
+
}
|
|
23919
|
+
/**
|
|
23920
|
+
* Sales per hour of the day, as GET /api/v6/report/sales/hours; only when a card shows hours
|
|
23921
|
+
* @export
|
|
23922
|
+
* @interface PublicReportSideNumbersDtoHours
|
|
23923
|
+
*/
|
|
23924
|
+
export interface PublicReportSideNumbersDtoHours {
|
|
23925
|
+
/**
|
|
23926
|
+
*
|
|
23927
|
+
* @type {PublicReportHoursDtoPeriod}
|
|
23928
|
+
* @memberof PublicReportSideNumbersDtoHours
|
|
23929
|
+
*/
|
|
23930
|
+
'period': PublicReportHoursDtoPeriod;
|
|
23931
|
+
/**
|
|
23932
|
+
*
|
|
23933
|
+
* @type {PublicReportHoursDtoToday}
|
|
23934
|
+
* @memberof PublicReportSideNumbersDtoHours
|
|
23935
|
+
*/
|
|
23936
|
+
'today': PublicReportHoursDtoToday;
|
|
23937
|
+
/**
|
|
23938
|
+
*
|
|
23939
|
+
* @type {PublicReportHoursDtoNormal}
|
|
23940
|
+
* @memberof PublicReportSideNumbersDtoHours
|
|
23941
|
+
*/
|
|
23942
|
+
'normal': PublicReportHoursDtoNormal;
|
|
23943
|
+
}
|
|
23944
|
+
/**
|
|
23945
|
+
* Sales per order type, as GET /api/v6/report/sales/order-types; only when a card shows them
|
|
23946
|
+
* @export
|
|
23947
|
+
* @interface PublicReportSideNumbersDtoOrderTypes
|
|
23948
|
+
*/
|
|
23949
|
+
export interface PublicReportSideNumbersDtoOrderTypes {
|
|
23950
|
+
/**
|
|
23951
|
+
* The first instant of the period, ISO 8601 in UTC
|
|
23952
|
+
* @type {string}
|
|
23953
|
+
* @memberof PublicReportSideNumbersDtoOrderTypes
|
|
23954
|
+
*/
|
|
23955
|
+
'reportDateStart': string;
|
|
23956
|
+
/**
|
|
23957
|
+
* The last instant of the period, ISO 8601 in UTC; now, when the period ends later
|
|
23958
|
+
* @type {string}
|
|
23959
|
+
* @memberof PublicReportSideNumbersDtoOrderTypes
|
|
23960
|
+
*/
|
|
23961
|
+
'reportDateEnd': string;
|
|
23962
|
+
/**
|
|
23963
|
+
* The IANA time zone the period\'s days are read in
|
|
23964
|
+
* @type {string}
|
|
23965
|
+
* @memberof PublicReportSideNumbersDtoOrderTypes
|
|
23966
|
+
*/
|
|
23967
|
+
'timezone': string;
|
|
23968
|
+
/**
|
|
23969
|
+
* The first business day, YYYY-MM-DD
|
|
23970
|
+
* @type {string}
|
|
23971
|
+
* @memberof PublicReportSideNumbersDtoOrderTypes
|
|
23972
|
+
*/
|
|
23973
|
+
'firstBusinessDay': string;
|
|
23974
|
+
/**
|
|
23975
|
+
* The last business day, YYYY-MM-DD, inclusive
|
|
23976
|
+
* @type {string}
|
|
23977
|
+
* @memberof PublicReportSideNumbersDtoOrderTypes
|
|
23978
|
+
*/
|
|
23979
|
+
'lastBusinessDay': string;
|
|
23980
|
+
/**
|
|
23981
|
+
* The newest BigQuery rebuild the rows read, ISO 8601 in UTC; null when none
|
|
23982
|
+
* @type {string}
|
|
23983
|
+
* @memberof PublicReportSideNumbersDtoOrderTypes
|
|
23984
|
+
*/
|
|
23985
|
+
'dataUntil': string | null;
|
|
23986
|
+
/**
|
|
23987
|
+
* One group per venue, app and currency the breakdown keeps
|
|
23988
|
+
* @type {Array<SalesReportOrderTypesGroupDto>}
|
|
23989
|
+
* @memberof PublicReportSideNumbersDtoOrderTypes
|
|
23990
|
+
*/
|
|
23991
|
+
'groups': Array<SalesReportOrderTypesGroupDto>;
|
|
23992
|
+
}
|
|
23993
|
+
/**
|
|
23994
|
+
* 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
|
|
23995
|
+
* @export
|
|
23996
|
+
* @interface PublicReportSideNumbersDtoSales
|
|
23997
|
+
*/
|
|
23998
|
+
export interface PublicReportSideNumbersDtoSales {
|
|
23999
|
+
/**
|
|
24000
|
+
* The first instant of the period, ISO 8601 in UTC
|
|
24001
|
+
* @type {string}
|
|
24002
|
+
* @memberof PublicReportSideNumbersDtoSales
|
|
24003
|
+
*/
|
|
24004
|
+
'reportDateStart': string;
|
|
24005
|
+
/**
|
|
24006
|
+
* The last instant of the period, ISO 8601 in UTC; now, when the period ends later
|
|
24007
|
+
* @type {string}
|
|
24008
|
+
* @memberof PublicReportSideNumbersDtoSales
|
|
24009
|
+
*/
|
|
24010
|
+
'reportDateEnd': string;
|
|
24011
|
+
/**
|
|
24012
|
+
* When the report was answered, ISO 8601 in UTC
|
|
24013
|
+
* @type {string}
|
|
24014
|
+
* @memberof PublicReportSideNumbersDtoSales
|
|
24015
|
+
*/
|
|
24016
|
+
'reportGeneratedAt': string;
|
|
24017
|
+
/**
|
|
24018
|
+
* The time zone the period was read in: the request\'s, or else the first venue\'s
|
|
24019
|
+
* @type {string}
|
|
24020
|
+
* @memberof PublicReportSideNumbersDtoSales
|
|
24021
|
+
*/
|
|
24022
|
+
'timezone': string;
|
|
24023
|
+
/**
|
|
24024
|
+
* The first business day added up, YYYY-MM-DD; each venue\'s rows of that date in its own zone
|
|
24025
|
+
* @type {string}
|
|
24026
|
+
* @memberof PublicReportSideNumbersDtoSales
|
|
24027
|
+
*/
|
|
24028
|
+
'firstBusinessDay': string;
|
|
24029
|
+
/**
|
|
24030
|
+
* The last business day added up, YYYY-MM-DD, inclusive
|
|
24031
|
+
* @type {string}
|
|
24032
|
+
* @memberof PublicReportSideNumbersDtoSales
|
|
24033
|
+
*/
|
|
24034
|
+
'lastBusinessDay': string;
|
|
24035
|
+
/**
|
|
24036
|
+
* 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
|
|
24037
|
+
* @type {object}
|
|
24038
|
+
* @memberof PublicReportSideNumbersDtoSales
|
|
24039
|
+
*/
|
|
24040
|
+
'dataUntil': object | null;
|
|
24041
|
+
/**
|
|
24042
|
+
* One group per venue, app and currency the breakdown keeps; an asked venue that sold nothing answers zeros
|
|
24043
|
+
* @type {Array<SalesReportGroupDto>}
|
|
24044
|
+
* @memberof PublicReportSideNumbersDtoSales
|
|
24045
|
+
*/
|
|
24046
|
+
'reports': Array<SalesReportGroupDto>;
|
|
24047
|
+
/**
|
|
24048
|
+
* 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
|
|
24049
|
+
* @type {Array<SalesReportGroupDto>}
|
|
24050
|
+
* @memberof PublicReportSideNumbersDtoSales
|
|
24051
|
+
*/
|
|
24052
|
+
'totals'?: Array<SalesReportGroupDto>;
|
|
24053
|
+
}
|
|
24054
|
+
/**
|
|
24055
|
+
* 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
|
|
24056
|
+
* @export
|
|
24057
|
+
* @interface PublicReportSideNumbersDtoTrend
|
|
24058
|
+
*/
|
|
24059
|
+
export interface PublicReportSideNumbersDtoTrend {
|
|
24060
|
+
/**
|
|
24061
|
+
* The first instant of the period, ISO 8601 in UTC
|
|
24062
|
+
* @type {string}
|
|
24063
|
+
* @memberof PublicReportSideNumbersDtoTrend
|
|
24064
|
+
*/
|
|
24065
|
+
'reportDateStart': string;
|
|
24066
|
+
/**
|
|
24067
|
+
* The last instant of the period, ISO 8601 in UTC; now, when the period ends later
|
|
24068
|
+
* @type {string}
|
|
24069
|
+
* @memberof PublicReportSideNumbersDtoTrend
|
|
24070
|
+
*/
|
|
24071
|
+
'reportDateEnd': string;
|
|
24072
|
+
/**
|
|
24073
|
+
* When the report was answered, ISO 8601 in UTC
|
|
24074
|
+
* @type {string}
|
|
24075
|
+
* @memberof PublicReportSideNumbersDtoTrend
|
|
24076
|
+
*/
|
|
24077
|
+
'reportGeneratedAt': string;
|
|
24078
|
+
/**
|
|
24079
|
+
* The time zone the period was read in: the request\'s, or else the first venue\'s
|
|
24080
|
+
* @type {string}
|
|
24081
|
+
* @memberof PublicReportSideNumbersDtoTrend
|
|
24082
|
+
*/
|
|
24083
|
+
'timezone': string;
|
|
24084
|
+
/**
|
|
24085
|
+
* The first business day added up, YYYY-MM-DD; each venue\'s rows of that date in its own zone
|
|
24086
|
+
* @type {string}
|
|
24087
|
+
* @memberof PublicReportSideNumbersDtoTrend
|
|
24088
|
+
*/
|
|
24089
|
+
'firstBusinessDay': string;
|
|
24090
|
+
/**
|
|
24091
|
+
* The last business day added up, YYYY-MM-DD, inclusive
|
|
24092
|
+
* @type {string}
|
|
24093
|
+
* @memberof PublicReportSideNumbersDtoTrend
|
|
24094
|
+
*/
|
|
24095
|
+
'lastBusinessDay': string;
|
|
24096
|
+
/**
|
|
24097
|
+
* 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
|
|
24098
|
+
* @type {object}
|
|
24099
|
+
* @memberof PublicReportSideNumbersDtoTrend
|
|
24100
|
+
*/
|
|
24101
|
+
'dataUntil': object | null;
|
|
24102
|
+
/**
|
|
24103
|
+
* One group per venue, app and currency the breakdown keeps; an asked venue that sold nothing answers zeros
|
|
24104
|
+
* @type {Array<SalesReportGroupDto>}
|
|
24105
|
+
* @memberof PublicReportSideNumbersDtoTrend
|
|
24106
|
+
*/
|
|
24107
|
+
'reports': Array<SalesReportGroupDto>;
|
|
24108
|
+
/**
|
|
24109
|
+
* 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
|
|
24110
|
+
* @type {Array<SalesReportGroupDto>}
|
|
24111
|
+
* @memberof PublicReportSideNumbersDtoTrend
|
|
24112
|
+
*/
|
|
24113
|
+
'totals'?: Array<SalesReportGroupDto>;
|
|
24114
|
+
}
|
|
24115
|
+
/**
|
|
24116
|
+
* The summary of the 26 weeks up to today, day by day; only when the report shows the year card
|
|
24117
|
+
* @export
|
|
24118
|
+
* @interface PublicReportSideNumbersDtoYear
|
|
24119
|
+
*/
|
|
24120
|
+
export interface PublicReportSideNumbersDtoYear {
|
|
24121
|
+
/**
|
|
24122
|
+
* The first instant of the period, ISO 8601 in UTC
|
|
24123
|
+
* @type {string}
|
|
24124
|
+
* @memberof PublicReportSideNumbersDtoYear
|
|
24125
|
+
*/
|
|
24126
|
+
'reportDateStart': string;
|
|
24127
|
+
/**
|
|
24128
|
+
* The last instant of the period, ISO 8601 in UTC; now, when the period ends later
|
|
24129
|
+
* @type {string}
|
|
24130
|
+
* @memberof PublicReportSideNumbersDtoYear
|
|
24131
|
+
*/
|
|
24132
|
+
'reportDateEnd': string;
|
|
24133
|
+
/**
|
|
24134
|
+
* When the report was answered, ISO 8601 in UTC
|
|
24135
|
+
* @type {string}
|
|
24136
|
+
* @memberof PublicReportSideNumbersDtoYear
|
|
24137
|
+
*/
|
|
24138
|
+
'reportGeneratedAt': string;
|
|
24139
|
+
/**
|
|
24140
|
+
* The time zone the period was read in: the request\'s, or else the first venue\'s
|
|
24141
|
+
* @type {string}
|
|
24142
|
+
* @memberof PublicReportSideNumbersDtoYear
|
|
24143
|
+
*/
|
|
24144
|
+
'timezone': string;
|
|
24145
|
+
/**
|
|
24146
|
+
* The first business day added up, YYYY-MM-DD; each venue\'s rows of that date in its own zone
|
|
24147
|
+
* @type {string}
|
|
24148
|
+
* @memberof PublicReportSideNumbersDtoYear
|
|
24149
|
+
*/
|
|
24150
|
+
'firstBusinessDay': string;
|
|
24151
|
+
/**
|
|
24152
|
+
* The last business day added up, YYYY-MM-DD, inclusive
|
|
24153
|
+
* @type {string}
|
|
24154
|
+
* @memberof PublicReportSideNumbersDtoYear
|
|
24155
|
+
*/
|
|
24156
|
+
'lastBusinessDay': string;
|
|
24157
|
+
/**
|
|
24158
|
+
* 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
|
|
24159
|
+
* @type {object}
|
|
24160
|
+
* @memberof PublicReportSideNumbersDtoYear
|
|
24161
|
+
*/
|
|
24162
|
+
'dataUntil': object | null;
|
|
24163
|
+
/**
|
|
24164
|
+
* One group per venue, app and currency the breakdown keeps; an asked venue that sold nothing answers zeros
|
|
24165
|
+
* @type {Array<SalesReportGroupDto>}
|
|
24166
|
+
* @memberof PublicReportSideNumbersDtoYear
|
|
24167
|
+
*/
|
|
24168
|
+
'reports': Array<SalesReportGroupDto>;
|
|
24169
|
+
/**
|
|
24170
|
+
* 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
|
|
24171
|
+
* @type {Array<SalesReportGroupDto>}
|
|
24172
|
+
* @memberof PublicReportSideNumbersDtoYear
|
|
24173
|
+
*/
|
|
24174
|
+
'totals'?: Array<SalesReportGroupDto>;
|
|
24175
|
+
}
|
|
23408
24176
|
/**
|
|
23409
24177
|
*
|
|
23410
24178
|
* @export
|
|
@@ -23453,6 +24221,31 @@ export interface PublicSavedReportDto {
|
|
|
23453
24221
|
* @memberof PublicSavedReportDto
|
|
23454
24222
|
*/
|
|
23455
24223
|
'updatedAt': string;
|
|
24224
|
+
/**
|
|
24225
|
+
*
|
|
24226
|
+
* @type {PublicSavedReportDtoNumbers}
|
|
24227
|
+
* @memberof PublicSavedReportDto
|
|
24228
|
+
*/
|
|
24229
|
+
'numbers': PublicSavedReportDtoNumbers | null;
|
|
24230
|
+
}
|
|
24231
|
+
/**
|
|
24232
|
+
* 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)
|
|
24233
|
+
* @export
|
|
24234
|
+
* @interface PublicSavedReportDtoNumbers
|
|
24235
|
+
*/
|
|
24236
|
+
export interface PublicSavedReportDtoNumbers {
|
|
24237
|
+
/**
|
|
24238
|
+
*
|
|
24239
|
+
* @type {PublicReportNumbersDtoA}
|
|
24240
|
+
* @memberof PublicSavedReportDtoNumbers
|
|
24241
|
+
*/
|
|
24242
|
+
'a': PublicReportNumbersDtoA | null;
|
|
24243
|
+
/**
|
|
24244
|
+
*
|
|
24245
|
+
* @type {PublicReportNumbersDtoB}
|
|
24246
|
+
* @memberof PublicSavedReportDtoNumbers
|
|
24247
|
+
*/
|
|
24248
|
+
'b'?: PublicReportNumbersDtoB | null;
|
|
23456
24249
|
}
|
|
23457
24250
|
/**
|
|
23458
24251
|
*
|
|
@@ -23517,6 +24310,12 @@ export interface RankedCategoryDto {
|
|
|
23517
24310
|
*/
|
|
23518
24311
|
export declare const ReadyMadeReport: {
|
|
23519
24312
|
readonly Sales: "sales";
|
|
24313
|
+
readonly ZReport: "zReport";
|
|
24314
|
+
readonly SalesVat: "salesVat";
|
|
24315
|
+
readonly Payments: "payments";
|
|
24316
|
+
readonly ProductSales: "productSales";
|
|
24317
|
+
readonly CashSessions: "cashSessions";
|
|
24318
|
+
readonly Staff: "staff";
|
|
23520
24319
|
};
|
|
23521
24320
|
export type ReadyMadeReport = typeof ReadyMadeReport[keyof typeof ReadyMadeReport];
|
|
23522
24321
|
/**
|
|
@@ -27827,6 +28626,12 @@ export interface SalesReportStaffMemberDto {
|
|
|
27827
28626
|
* @memberof SalesReportStaffMemberDto
|
|
27828
28627
|
*/
|
|
27829
28628
|
'staffId': string;
|
|
28629
|
+
/**
|
|
28630
|
+
* The staff member\'s name; null for the orders that name nobody, or a person who left the venue
|
|
28631
|
+
* @type {string}
|
|
28632
|
+
* @memberof SalesReportStaffMemberDto
|
|
28633
|
+
*/
|
|
28634
|
+
'staffName': string | null;
|
|
27830
28635
|
/**
|
|
27831
28636
|
* Orders not refunded, or refunded in part (the POS app\'s totalOrders)
|
|
27832
28637
|
* @type {number}
|
|
@@ -34016,6 +34821,18 @@ export interface UpsertConfigDto {
|
|
|
34016
34821
|
* @memberof UpsertConfigDto
|
|
34017
34822
|
*/
|
|
34018
34823
|
'productDetailLayout'?: ProductDetailLayout;
|
|
34824
|
+
/**
|
|
34825
|
+
*
|
|
34826
|
+
* @type {KioskLayout}
|
|
34827
|
+
* @memberof UpsertConfigDto
|
|
34828
|
+
*/
|
|
34829
|
+
'layout'?: KioskLayout;
|
|
34830
|
+
/**
|
|
34831
|
+
*
|
|
34832
|
+
* @type {UpsellMode}
|
|
34833
|
+
* @memberof UpsertConfigDto
|
|
34834
|
+
*/
|
|
34835
|
+
'upsellMode'?: UpsellMode;
|
|
34019
34836
|
/**
|
|
34020
34837
|
* Whether the kiosk prints the receipt without asking. Absent keeps the stored value.
|
|
34021
34838
|
* @type {boolean}
|
|
@@ -34930,6 +35747,99 @@ export interface VenueFoundDto {
|
|
|
34930
35747
|
*/
|
|
34931
35748
|
'chainId': string | null;
|
|
34932
35749
|
}
|
|
35750
|
+
/**
|
|
35751
|
+
*
|
|
35752
|
+
* @export
|
|
35753
|
+
* @interface VenueKioskDto
|
|
35754
|
+
*/
|
|
35755
|
+
export interface VenueKioskDto {
|
|
35756
|
+
/**
|
|
35757
|
+
* The kiosk\'s station id
|
|
35758
|
+
* @type {string}
|
|
35759
|
+
* @memberof VenueKioskDto
|
|
35760
|
+
*/
|
|
35761
|
+
'id': string;
|
|
35762
|
+
/**
|
|
35763
|
+
* The kiosk\'s name
|
|
35764
|
+
* @type {string}
|
|
35765
|
+
* @memberof VenueKioskDto
|
|
35766
|
+
*/
|
|
35767
|
+
'name': string;
|
|
35768
|
+
/**
|
|
35769
|
+
* What the kiosk\'s order numbers start with; empty for none
|
|
35770
|
+
* @type {string}
|
|
35771
|
+
* @memberof VenueKioskDto
|
|
35772
|
+
*/
|
|
35773
|
+
'prefix': string;
|
|
35774
|
+
/**
|
|
35775
|
+
* The device\'s Hardware ID, as it shows it
|
|
35776
|
+
* @type {string}
|
|
35777
|
+
* @memberof VenueKioskDto
|
|
35778
|
+
*/
|
|
35779
|
+
'hardwareId': string;
|
|
35780
|
+
/**
|
|
35781
|
+
*
|
|
35782
|
+
* @type {Status}
|
|
35783
|
+
* @memberof VenueKioskDto
|
|
35784
|
+
*/
|
|
35785
|
+
'status': Status;
|
|
35786
|
+
/**
|
|
35787
|
+
*
|
|
35788
|
+
* @type {VenueKioskDtoTerminal}
|
|
35789
|
+
* @memberof VenueKioskDto
|
|
35790
|
+
*/
|
|
35791
|
+
'terminal': VenueKioskDtoTerminal | null;
|
|
35792
|
+
/**
|
|
35793
|
+
* When the kiosk was first linked to the venue, ISO 8601
|
|
35794
|
+
* @type {string}
|
|
35795
|
+
* @memberof VenueKioskDto
|
|
35796
|
+
*/
|
|
35797
|
+
'createdAt': string;
|
|
35798
|
+
/**
|
|
35799
|
+
* When the kiosk last changed, ISO 8601
|
|
35800
|
+
* @type {string}
|
|
35801
|
+
* @memberof VenueKioskDto
|
|
35802
|
+
*/
|
|
35803
|
+
'updatedAt': string;
|
|
35804
|
+
}
|
|
35805
|
+
/**
|
|
35806
|
+
* The payment terminal linked to the kiosk; null when it has none
|
|
35807
|
+
* @export
|
|
35808
|
+
* @interface VenueKioskDtoTerminal
|
|
35809
|
+
*/
|
|
35810
|
+
export interface VenueKioskDtoTerminal {
|
|
35811
|
+
/**
|
|
35812
|
+
* The payment terminal\'s id
|
|
35813
|
+
* @type {string}
|
|
35814
|
+
* @memberof VenueKioskDtoTerminal
|
|
35815
|
+
*/
|
|
35816
|
+
'id': string;
|
|
35817
|
+
/**
|
|
35818
|
+
*
|
|
35819
|
+
* @type {PaymentProvider}
|
|
35820
|
+
* @memberof VenueKioskDtoTerminal
|
|
35821
|
+
*/
|
|
35822
|
+
'provider': PaymentProvider;
|
|
35823
|
+
/**
|
|
35824
|
+
* The terminal\'s label; null when it was given none
|
|
35825
|
+
* @type {string}
|
|
35826
|
+
* @memberof VenueKioskDtoTerminal
|
|
35827
|
+
*/
|
|
35828
|
+
'label': string | null;
|
|
35829
|
+
}
|
|
35830
|
+
/**
|
|
35831
|
+
*
|
|
35832
|
+
* @export
|
|
35833
|
+
* @interface VenueKiosksDto
|
|
35834
|
+
*/
|
|
35835
|
+
export interface VenueKiosksDto {
|
|
35836
|
+
/**
|
|
35837
|
+
* The venue\'s kiosks, active and inactive, oldest first
|
|
35838
|
+
* @type {Array<VenueKioskDto>}
|
|
35839
|
+
* @memberof VenueKiosksDto
|
|
35840
|
+
*/
|
|
35841
|
+
'kiosks': Array<VenueKioskDto>;
|
|
35842
|
+
}
|
|
34933
35843
|
/**
|
|
34934
35844
|
*
|
|
34935
35845
|
* @export
|
|
@@ -34949,6 +35859,56 @@ export interface VenueListEntryDto {
|
|
|
34949
35859
|
*/
|
|
34950
35860
|
'businessName': string;
|
|
34951
35861
|
}
|
|
35862
|
+
/**
|
|
35863
|
+
*
|
|
35864
|
+
* @export
|
|
35865
|
+
* @interface VenuePaymentTerminalDto
|
|
35866
|
+
*/
|
|
35867
|
+
export interface VenuePaymentTerminalDto {
|
|
35868
|
+
/**
|
|
35869
|
+
* The payment terminal\'s id, the one a kiosk is linked to
|
|
35870
|
+
* @type {string}
|
|
35871
|
+
* @memberof VenuePaymentTerminalDto
|
|
35872
|
+
*/
|
|
35873
|
+
'id': string;
|
|
35874
|
+
/**
|
|
35875
|
+
*
|
|
35876
|
+
* @type {PaymentProvider}
|
|
35877
|
+
* @memberof VenuePaymentTerminalDto
|
|
35878
|
+
*/
|
|
35879
|
+
'provider': PaymentProvider;
|
|
35880
|
+
/**
|
|
35881
|
+
* The terminal\'s label; null when it was given none
|
|
35882
|
+
* @type {string}
|
|
35883
|
+
* @memberof VenuePaymentTerminalDto
|
|
35884
|
+
*/
|
|
35885
|
+
'label': string | null;
|
|
35886
|
+
/**
|
|
35887
|
+
* The terminal\'s own id at its provider, as printed on the device
|
|
35888
|
+
* @type {string}
|
|
35889
|
+
* @memberof VenuePaymentTerminalDto
|
|
35890
|
+
*/
|
|
35891
|
+
'hardwareId': string;
|
|
35892
|
+
/**
|
|
35893
|
+
* The id of the station, a kiosk\'s or a till\'s, the terminal is linked to; null when it is free
|
|
35894
|
+
* @type {string}
|
|
35895
|
+
* @memberof VenuePaymentTerminalDto
|
|
35896
|
+
*/
|
|
35897
|
+
'stationId': string | null;
|
|
35898
|
+
}
|
|
35899
|
+
/**
|
|
35900
|
+
*
|
|
35901
|
+
* @export
|
|
35902
|
+
* @interface VenuePaymentTerminalsDto
|
|
35903
|
+
*/
|
|
35904
|
+
export interface VenuePaymentTerminalsDto {
|
|
35905
|
+
/**
|
|
35906
|
+
* The venue\'s payment terminals as stored, oldest first; a terminal is stored once a till has discovered it
|
|
35907
|
+
* @type {Array<VenuePaymentTerminalDto>}
|
|
35908
|
+
* @memberof VenuePaymentTerminalsDto
|
|
35909
|
+
*/
|
|
35910
|
+
'terminals': Array<VenuePaymentTerminalDto>;
|
|
35911
|
+
}
|
|
34952
35912
|
/**
|
|
34953
35913
|
*
|
|
34954
35914
|
* @export
|
|
@@ -35053,7 +36013,7 @@ export interface VenueProviderOutcomeDto {
|
|
|
35053
36013
|
*/
|
|
35054
36014
|
'rowsChanged': number;
|
|
35055
36015
|
/**
|
|
35056
|
-
* Whether the channel is on, as its row reads after the change: the first active row, else the
|
|
36016
|
+
* Whether the channel is on, as its row reads after the change: the first active row, else the newest row, by createdAt and then id
|
|
35057
36017
|
* @type {boolean}
|
|
35058
36018
|
* @memberof VenueProviderOutcomeDto
|
|
35059
36019
|
*/
|
|
@@ -35071,6 +36031,50 @@ export interface VenueProviderOutcomeDto {
|
|
|
35071
36031
|
*/
|
|
35072
36032
|
'integrations': Array<IntegrationType>;
|
|
35073
36033
|
}
|
|
36034
|
+
/**
|
|
36035
|
+
*
|
|
36036
|
+
* @export
|
|
36037
|
+
* @interface VenueProviderStateDto
|
|
36038
|
+
*/
|
|
36039
|
+
export interface VenueProviderStateDto {
|
|
36040
|
+
/**
|
|
36041
|
+
*
|
|
36042
|
+
* @type {ProviderEnum}
|
|
36043
|
+
* @memberof VenueProviderStateDto
|
|
36044
|
+
*/
|
|
36045
|
+
'channel': ProviderEnum;
|
|
36046
|
+
/**
|
|
36047
|
+
* Whether the channel is on, as its row reads: the first active row, else the newest row, by createdAt and then id
|
|
36048
|
+
* @type {boolean}
|
|
36049
|
+
* @memberof VenueProviderStateDto
|
|
36050
|
+
*/
|
|
36051
|
+
'isActive': boolean;
|
|
36052
|
+
/**
|
|
36053
|
+
* Whether the channel\'s orders are accepted without the till, as the same row reads
|
|
36054
|
+
* @type {boolean}
|
|
36055
|
+
* @memberof VenueProviderStateDto
|
|
36056
|
+
*/
|
|
36057
|
+
'autoAccept': boolean;
|
|
36058
|
+
/**
|
|
36059
|
+
* The integrations the same row takes
|
|
36060
|
+
* @type {Array<IntegrationType>}
|
|
36061
|
+
* @memberof VenueProviderStateDto
|
|
36062
|
+
*/
|
|
36063
|
+
'integrations': Array<IntegrationType>;
|
|
36064
|
+
}
|
|
36065
|
+
/**
|
|
36066
|
+
*
|
|
36067
|
+
* @export
|
|
36068
|
+
* @interface VenueProvidersDto
|
|
36069
|
+
*/
|
|
36070
|
+
export interface VenueProvidersDto {
|
|
36071
|
+
/**
|
|
36072
|
+
* One entry per own channel (those PUT adds a row for when the venue has none) the venue has rows on, active or not, by channel name. Empty when it has none
|
|
36073
|
+
* @type {Array<VenueProviderStateDto>}
|
|
36074
|
+
* @memberof VenueProvidersDto
|
|
36075
|
+
*/
|
|
36076
|
+
'providers': Array<VenueProviderStateDto>;
|
|
36077
|
+
}
|
|
35074
36078
|
/**
|
|
35075
36079
|
*
|
|
35076
36080
|
* @export
|
|
@@ -49752,6 +50756,14 @@ export declare const ProviderApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
49752
50756
|
* @throws {RequiredError}
|
|
49753
50757
|
*/
|
|
49754
50758
|
getOnboardingStatus: (channel: ProviderEnum, businessId: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
50759
|
+
/**
|
|
50760
|
+
* One entry per own channel the venue has rows on, active or not, by channel name: the channels this path\'s PUT adds a row for when the venue has none. A channel with several rows reads from the row PUT on this path answers with: the first active row, else the newest, by createdAt and then id. Nothing is changed.
|
|
50761
|
+
* @summary Read whether each of a venue\'s own channels is on and auto-accepting, and its integrations
|
|
50762
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
50763
|
+
* @param {*} [options] Override http request option.
|
|
50764
|
+
* @throws {RequiredError}
|
|
50765
|
+
*/
|
|
50766
|
+
getVenueProviders: (businessId: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
49755
50767
|
/**
|
|
49756
50768
|
* Asked once the owner has signed in to Uber Eats, with the session\'s state; ubereats-service\'s list is answered as it is.
|
|
49757
50769
|
* @summary The Uber Eats stores the signed-in owner can connect
|
|
@@ -49830,6 +50842,14 @@ export declare const ProviderApiFp: (configuration?: Configuration) => {
|
|
|
49830
50842
|
* @throws {RequiredError}
|
|
49831
50843
|
*/
|
|
49832
50844
|
getOnboardingStatus(channel: ProviderEnum, businessId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOnboardingStatus200Response>>;
|
|
50845
|
+
/**
|
|
50846
|
+
* One entry per own channel the venue has rows on, active or not, by channel name: the channels this path\'s PUT adds a row for when the venue has none. A channel with several rows reads from the row PUT on this path answers with: the first active row, else the newest, by createdAt and then id. Nothing is changed.
|
|
50847
|
+
* @summary Read whether each of a venue\'s own channels is on and auto-accepting, and its integrations
|
|
50848
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
50849
|
+
* @param {*} [options] Override http request option.
|
|
50850
|
+
* @throws {RequiredError}
|
|
50851
|
+
*/
|
|
50852
|
+
getVenueProviders(businessId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueProvidersDto>>;
|
|
49833
50853
|
/**
|
|
49834
50854
|
* Asked once the owner has signed in to Uber Eats, with the session\'s state; ubereats-service\'s list is answered as it is.
|
|
49835
50855
|
* @summary The Uber Eats stores the signed-in owner can connect
|
|
@@ -49908,6 +50928,14 @@ export declare const ProviderApiFactory: (configuration?: Configuration, basePat
|
|
|
49908
50928
|
* @throws {RequiredError}
|
|
49909
50929
|
*/
|
|
49910
50930
|
getOnboardingStatus(channel: ProviderEnum, businessId: number, options?: any): AxiosPromise<GetOnboardingStatus200Response>;
|
|
50931
|
+
/**
|
|
50932
|
+
* One entry per own channel the venue has rows on, active or not, by channel name: the channels this path\'s PUT adds a row for when the venue has none. A channel with several rows reads from the row PUT on this path answers with: the first active row, else the newest, by createdAt and then id. Nothing is changed.
|
|
50933
|
+
* @summary Read whether each of a venue\'s own channels is on and auto-accepting, and its integrations
|
|
50934
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
50935
|
+
* @param {*} [options] Override http request option.
|
|
50936
|
+
* @throws {RequiredError}
|
|
50937
|
+
*/
|
|
50938
|
+
getVenueProviders(businessId: number, options?: any): AxiosPromise<VenueProvidersDto>;
|
|
49911
50939
|
/**
|
|
49912
50940
|
* Asked once the owner has signed in to Uber Eats, with the session\'s state; ubereats-service\'s list is answered as it is.
|
|
49913
50941
|
* @summary The Uber Eats stores the signed-in owner can connect
|
|
@@ -49991,6 +51019,15 @@ export interface ProviderApiInterface {
|
|
|
49991
51019
|
* @memberof ProviderApiInterface
|
|
49992
51020
|
*/
|
|
49993
51021
|
getOnboardingStatus(channel: ProviderEnum, businessId: number, options?: AxiosRequestConfig): AxiosPromise<GetOnboardingStatus200Response>;
|
|
51022
|
+
/**
|
|
51023
|
+
* One entry per own channel the venue has rows on, active or not, by channel name: the channels this path\'s PUT adds a row for when the venue has none. A channel with several rows reads from the row PUT on this path answers with: the first active row, else the newest, by createdAt and then id. Nothing is changed.
|
|
51024
|
+
* @summary Read whether each of a venue\'s own channels is on and auto-accepting, and its integrations
|
|
51025
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
51026
|
+
* @param {*} [options] Override http request option.
|
|
51027
|
+
* @throws {RequiredError}
|
|
51028
|
+
* @memberof ProviderApiInterface
|
|
51029
|
+
*/
|
|
51030
|
+
getVenueProviders(businessId: number, options?: AxiosRequestConfig): AxiosPromise<VenueProvidersDto>;
|
|
49994
51031
|
/**
|
|
49995
51032
|
* Asked once the owner has signed in to Uber Eats, with the session\'s state; ubereats-service\'s list is answered as it is.
|
|
49996
51033
|
* @summary The Uber Eats stores the signed-in owner can connect
|
|
@@ -50079,6 +51116,15 @@ export declare class ProviderApi extends BaseAPI implements ProviderApiInterface
|
|
|
50079
51116
|
* @memberof ProviderApi
|
|
50080
51117
|
*/
|
|
50081
51118
|
getOnboardingStatus(channel: ProviderEnum, businessId: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetOnboardingStatus200Response, any, {}>>;
|
|
51119
|
+
/**
|
|
51120
|
+
* One entry per own channel the venue has rows on, active or not, by channel name: the channels this path\'s PUT adds a row for when the venue has none. A channel with several rows reads from the row PUT on this path answers with: the first active row, else the newest, by createdAt and then id. Nothing is changed.
|
|
51121
|
+
* @summary Read whether each of a venue\'s own channels is on and auto-accepting, and its integrations
|
|
51122
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
51123
|
+
* @param {*} [options] Override http request option.
|
|
51124
|
+
* @throws {RequiredError}
|
|
51125
|
+
* @memberof ProviderApi
|
|
51126
|
+
*/
|
|
51127
|
+
getVenueProviders(businessId: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VenueProvidersDto, any, {}>>;
|
|
50082
51128
|
/**
|
|
50083
51129
|
* Asked once the owner has signed in to Uber Eats, with the session\'s state; ubereats-service\'s list is answered as it is.
|
|
50084
51130
|
* @summary The Uber Eats stores the signed-in owner can connect
|
|
@@ -51534,7 +52580,7 @@ export declare const ReportSchedulesApiAxiosParamCreator: (configuration?: Confi
|
|
|
51534
52580
|
* Its schedule: cadence, time and zone, recipients and when it next sends. 404 when none is saved. Managers only.
|
|
51535
52581
|
* @summary Read when a store\'s ready-made report is emailed
|
|
51536
52582
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
51537
|
-
* @param {ReadyMadeReport} readyMadeReport The ready-made report
|
|
52583
|
+
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
|
|
51538
52584
|
* @param {*} [options] Override http request option.
|
|
51539
52585
|
* @throws {RequiredError}
|
|
51540
52586
|
*/
|
|
@@ -51573,7 +52619,7 @@ export declare const ReportSchedulesApiAxiosParamCreator: (configuration?: Confi
|
|
|
51573
52619
|
* Every time it was emailed, newest first, a page at a time: the days it covered, who it went to and the files it kept.
|
|
51574
52620
|
* @summary List the past runs of a store\'s ready-made report
|
|
51575
52621
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
51576
|
-
* @param {ReadyMadeReport} readyMadeReport The ready-made report
|
|
52622
|
+
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
|
|
51577
52623
|
* @param {number} [limit] At most this many runs, 1 to 100. Absent: 30
|
|
51578
52624
|
* @param {string} [after] The id of the last run of the page before; the list goes on after it
|
|
51579
52625
|
* @param {*} [options] Override http request option.
|
|
@@ -51592,7 +52638,7 @@ export declare const ReportSchedulesApiAxiosParamCreator: (configuration?: Confi
|
|
|
51592
52638
|
*/
|
|
51593
52639
|
listStoreSavedReportRuns: (businessId: number, reportId: string, limit?: number, after?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
51594
52640
|
/**
|
|
51595
|
-
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its PDF and Excel
|
|
52641
|
+
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its files, as dashboard-one\'s Reports downloads them: the sales report\'s PDF and Excel for sales, salesVat, payments and productSales, the end-of-day PDF for zReport, none for cashSessions and staff, whose email opens the report for its days) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
|
|
51596
52642
|
* @summary Set when an organisation\'s saved report is emailed
|
|
51597
52643
|
* @param {string} groupId The organisation\'s id: its group\'s accountId in the licence server
|
|
51598
52644
|
* @param {string} reportId The saved report\'s id
|
|
@@ -51602,17 +52648,17 @@ export declare const ReportSchedulesApiAxiosParamCreator: (configuration?: Confi
|
|
|
51602
52648
|
*/
|
|
51603
52649
|
setOrganisationSavedReportSchedule: (groupId: string, reportId: string, setReportScheduleDto: SetReportScheduleDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
51604
52650
|
/**
|
|
51605
|
-
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its PDF and Excel
|
|
52651
|
+
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its files, as dashboard-one\'s Reports downloads them: the sales report\'s PDF and Excel for sales, salesVat, payments and productSales, the end-of-day PDF for zReport, none for cashSessions and staff, whose email opens the report for its days) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
|
|
51606
52652
|
* @summary Set when a store\'s ready-made report is emailed
|
|
51607
52653
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
51608
|
-
* @param {ReadyMadeReport} readyMadeReport The ready-made report
|
|
52654
|
+
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
|
|
51609
52655
|
* @param {SetReportScheduleDto} setReportScheduleDto
|
|
51610
52656
|
* @param {*} [options] Override http request option.
|
|
51611
52657
|
* @throws {RequiredError}
|
|
51612
52658
|
*/
|
|
51613
52659
|
setStoreReadyMadeReportSchedule: (businessId: number, readyMadeReport: ReadyMadeReport, setReportScheduleDto: SetReportScheduleDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
51614
52660
|
/**
|
|
51615
|
-
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its PDF and Excel
|
|
52661
|
+
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its files, as dashboard-one\'s Reports downloads them: the sales report\'s PDF and Excel for sales, salesVat, payments and productSales, the end-of-day PDF for zReport, none for cashSessions and staff, whose email opens the report for its days) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
|
|
51616
52662
|
* @summary Set when a store\'s saved report is emailed
|
|
51617
52663
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
51618
52664
|
* @param {string} reportId The saved report\'s id
|
|
@@ -51658,7 +52704,7 @@ export declare const ReportSchedulesApiFp: (configuration?: Configuration) => {
|
|
|
51658
52704
|
* Its schedule: cadence, time and zone, recipients and when it next sends. 404 when none is saved. Managers only.
|
|
51659
52705
|
* @summary Read when a store\'s ready-made report is emailed
|
|
51660
52706
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
51661
|
-
* @param {ReadyMadeReport} readyMadeReport The ready-made report
|
|
52707
|
+
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
|
|
51662
52708
|
* @param {*} [options] Override http request option.
|
|
51663
52709
|
* @throws {RequiredError}
|
|
51664
52710
|
*/
|
|
@@ -51697,7 +52743,7 @@ export declare const ReportSchedulesApiFp: (configuration?: Configuration) => {
|
|
|
51697
52743
|
* Every time it was emailed, newest first, a page at a time: the days it covered, who it went to and the files it kept.
|
|
51698
52744
|
* @summary List the past runs of a store\'s ready-made report
|
|
51699
52745
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
51700
|
-
* @param {ReadyMadeReport} readyMadeReport The ready-made report
|
|
52746
|
+
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
|
|
51701
52747
|
* @param {number} [limit] At most this many runs, 1 to 100. Absent: 30
|
|
51702
52748
|
* @param {string} [after] The id of the last run of the page before; the list goes on after it
|
|
51703
52749
|
* @param {*} [options] Override http request option.
|
|
@@ -51716,7 +52762,7 @@ export declare const ReportSchedulesApiFp: (configuration?: Configuration) => {
|
|
|
51716
52762
|
*/
|
|
51717
52763
|
listStoreSavedReportRuns(businessId: number, reportId: string, limit?: number, after?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReportRunListDto>>;
|
|
51718
52764
|
/**
|
|
51719
|
-
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its PDF and Excel
|
|
52765
|
+
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its files, as dashboard-one\'s Reports downloads them: the sales report\'s PDF and Excel for sales, salesVat, payments and productSales, the end-of-day PDF for zReport, none for cashSessions and staff, whose email opens the report for its days) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
|
|
51720
52766
|
* @summary Set when an organisation\'s saved report is emailed
|
|
51721
52767
|
* @param {string} groupId The organisation\'s id: its group\'s accountId in the licence server
|
|
51722
52768
|
* @param {string} reportId The saved report\'s id
|
|
@@ -51726,17 +52772,17 @@ export declare const ReportSchedulesApiFp: (configuration?: Configuration) => {
|
|
|
51726
52772
|
*/
|
|
51727
52773
|
setOrganisationSavedReportSchedule(groupId: string, reportId: string, setReportScheduleDto: SetReportScheduleDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReportScheduleDto>>;
|
|
51728
52774
|
/**
|
|
51729
|
-
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its PDF and Excel
|
|
52775
|
+
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its files, as dashboard-one\'s Reports downloads them: the sales report\'s PDF and Excel for sales, salesVat, payments and productSales, the end-of-day PDF for zReport, none for cashSessions and staff, whose email opens the report for its days) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
|
|
51730
52776
|
* @summary Set when a store\'s ready-made report is emailed
|
|
51731
52777
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
51732
|
-
* @param {ReadyMadeReport} readyMadeReport The ready-made report
|
|
52778
|
+
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
|
|
51733
52779
|
* @param {SetReportScheduleDto} setReportScheduleDto
|
|
51734
52780
|
* @param {*} [options] Override http request option.
|
|
51735
52781
|
* @throws {RequiredError}
|
|
51736
52782
|
*/
|
|
51737
52783
|
setStoreReadyMadeReportSchedule(businessId: number, readyMadeReport: ReadyMadeReport, setReportScheduleDto: SetReportScheduleDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReportScheduleDto>>;
|
|
51738
52784
|
/**
|
|
51739
|
-
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its PDF and Excel
|
|
52785
|
+
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its files, as dashboard-one\'s Reports downloads them: the sales report\'s PDF and Excel for sales, salesVat, payments and productSales, the end-of-day PDF for zReport, none for cashSessions and staff, whose email opens the report for its days) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
|
|
51740
52786
|
* @summary Set when a store\'s saved report is emailed
|
|
51741
52787
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
51742
52788
|
* @param {string} reportId The saved report\'s id
|
|
@@ -51782,7 +52828,7 @@ export declare const ReportSchedulesApiFactory: (configuration?: Configuration,
|
|
|
51782
52828
|
* Its schedule: cadence, time and zone, recipients and when it next sends. 404 when none is saved. Managers only.
|
|
51783
52829
|
* @summary Read when a store\'s ready-made report is emailed
|
|
51784
52830
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
51785
|
-
* @param {ReadyMadeReport} readyMadeReport The ready-made report
|
|
52831
|
+
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
|
|
51786
52832
|
* @param {*} [options] Override http request option.
|
|
51787
52833
|
* @throws {RequiredError}
|
|
51788
52834
|
*/
|
|
@@ -51821,7 +52867,7 @@ export declare const ReportSchedulesApiFactory: (configuration?: Configuration,
|
|
|
51821
52867
|
* Every time it was emailed, newest first, a page at a time: the days it covered, who it went to and the files it kept.
|
|
51822
52868
|
* @summary List the past runs of a store\'s ready-made report
|
|
51823
52869
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
51824
|
-
* @param {ReadyMadeReport} readyMadeReport The ready-made report
|
|
52870
|
+
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
|
|
51825
52871
|
* @param {number} [limit] At most this many runs, 1 to 100. Absent: 30
|
|
51826
52872
|
* @param {string} [after] The id of the last run of the page before; the list goes on after it
|
|
51827
52873
|
* @param {*} [options] Override http request option.
|
|
@@ -51840,7 +52886,7 @@ export declare const ReportSchedulesApiFactory: (configuration?: Configuration,
|
|
|
51840
52886
|
*/
|
|
51841
52887
|
listStoreSavedReportRuns(businessId: number, reportId: string, limit?: number, after?: string, options?: any): AxiosPromise<ReportRunListDto>;
|
|
51842
52888
|
/**
|
|
51843
|
-
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its PDF and Excel
|
|
52889
|
+
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its files, as dashboard-one\'s Reports downloads them: the sales report\'s PDF and Excel for sales, salesVat, payments and productSales, the end-of-day PDF for zReport, none for cashSessions and staff, whose email opens the report for its days) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
|
|
51844
52890
|
* @summary Set when an organisation\'s saved report is emailed
|
|
51845
52891
|
* @param {string} groupId The organisation\'s id: its group\'s accountId in the licence server
|
|
51846
52892
|
* @param {string} reportId The saved report\'s id
|
|
@@ -51850,17 +52896,17 @@ export declare const ReportSchedulesApiFactory: (configuration?: Configuration,
|
|
|
51850
52896
|
*/
|
|
51851
52897
|
setOrganisationSavedReportSchedule(groupId: string, reportId: string, setReportScheduleDto: SetReportScheduleDto, options?: any): AxiosPromise<ReportScheduleDto>;
|
|
51852
52898
|
/**
|
|
51853
|
-
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its PDF and Excel
|
|
52899
|
+
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its files, as dashboard-one\'s Reports downloads them: the sales report\'s PDF and Excel for sales, salesVat, payments and productSales, the end-of-day PDF for zReport, none for cashSessions and staff, whose email opens the report for its days) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
|
|
51854
52900
|
* @summary Set when a store\'s ready-made report is emailed
|
|
51855
52901
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
51856
|
-
* @param {ReadyMadeReport} readyMadeReport The ready-made report
|
|
52902
|
+
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
|
|
51857
52903
|
* @param {SetReportScheduleDto} setReportScheduleDto
|
|
51858
52904
|
* @param {*} [options] Override http request option.
|
|
51859
52905
|
* @throws {RequiredError}
|
|
51860
52906
|
*/
|
|
51861
52907
|
setStoreReadyMadeReportSchedule(businessId: number, readyMadeReport: ReadyMadeReport, setReportScheduleDto: SetReportScheduleDto, options?: any): AxiosPromise<ReportScheduleDto>;
|
|
51862
52908
|
/**
|
|
51863
|
-
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its PDF and Excel
|
|
52909
|
+
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its files, as dashboard-one\'s Reports downloads them: the sales report\'s PDF and Excel for sales, salesVat, payments and productSales, the end-of-day PDF for zReport, none for cashSessions and staff, whose email opens the report for its days) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
|
|
51864
52910
|
* @summary Set when a store\'s saved report is emailed
|
|
51865
52911
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
51866
52912
|
* @param {string} reportId The saved report\'s id
|
|
@@ -51910,7 +52956,7 @@ export interface ReportSchedulesApiInterface {
|
|
|
51910
52956
|
* Its schedule: cadence, time and zone, recipients and when it next sends. 404 when none is saved. Managers only.
|
|
51911
52957
|
* @summary Read when a store\'s ready-made report is emailed
|
|
51912
52958
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
51913
|
-
* @param {ReadyMadeReport} readyMadeReport The ready-made report
|
|
52959
|
+
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
|
|
51914
52960
|
* @param {*} [options] Override http request option.
|
|
51915
52961
|
* @throws {RequiredError}
|
|
51916
52962
|
* @memberof ReportSchedulesApiInterface
|
|
@@ -51953,7 +52999,7 @@ export interface ReportSchedulesApiInterface {
|
|
|
51953
52999
|
* Every time it was emailed, newest first, a page at a time: the days it covered, who it went to and the files it kept.
|
|
51954
53000
|
* @summary List the past runs of a store\'s ready-made report
|
|
51955
53001
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
51956
|
-
* @param {ReadyMadeReport} readyMadeReport The ready-made report
|
|
53002
|
+
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
|
|
51957
53003
|
* @param {number} [limit] At most this many runs, 1 to 100. Absent: 30
|
|
51958
53004
|
* @param {string} [after] The id of the last run of the page before; the list goes on after it
|
|
51959
53005
|
* @param {*} [options] Override http request option.
|
|
@@ -51974,7 +53020,7 @@ export interface ReportSchedulesApiInterface {
|
|
|
51974
53020
|
*/
|
|
51975
53021
|
listStoreSavedReportRuns(businessId: number, reportId: string, limit?: number, after?: string, options?: AxiosRequestConfig): AxiosPromise<ReportRunListDto>;
|
|
51976
53022
|
/**
|
|
51977
|
-
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its PDF and Excel
|
|
53023
|
+
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its files, as dashboard-one\'s Reports downloads them: the sales report\'s PDF and Excel for sales, salesVat, payments and productSales, the end-of-day PDF for zReport, none for cashSessions and staff, whose email opens the report for its days) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
|
|
51978
53024
|
* @summary Set when an organisation\'s saved report is emailed
|
|
51979
53025
|
* @param {string} groupId The organisation\'s id: its group\'s accountId in the licence server
|
|
51980
53026
|
* @param {string} reportId The saved report\'s id
|
|
@@ -51985,10 +53031,10 @@ export interface ReportSchedulesApiInterface {
|
|
|
51985
53031
|
*/
|
|
51986
53032
|
setOrganisationSavedReportSchedule(groupId: string, reportId: string, setReportScheduleDto: SetReportScheduleDto, options?: AxiosRequestConfig): AxiosPromise<ReportScheduleDto>;
|
|
51987
53033
|
/**
|
|
51988
|
-
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its PDF and Excel
|
|
53034
|
+
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its files, as dashboard-one\'s Reports downloads them: the sales report\'s PDF and Excel for sales, salesVat, payments and productSales, the end-of-day PDF for zReport, none for cashSessions and staff, whose email opens the report for its days) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
|
|
51989
53035
|
* @summary Set when a store\'s ready-made report is emailed
|
|
51990
53036
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
51991
|
-
* @param {ReadyMadeReport} readyMadeReport The ready-made report
|
|
53037
|
+
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
|
|
51992
53038
|
* @param {SetReportScheduleDto} setReportScheduleDto
|
|
51993
53039
|
* @param {*} [options] Override http request option.
|
|
51994
53040
|
* @throws {RequiredError}
|
|
@@ -51996,7 +53042,7 @@ export interface ReportSchedulesApiInterface {
|
|
|
51996
53042
|
*/
|
|
51997
53043
|
setStoreReadyMadeReportSchedule(businessId: number, readyMadeReport: ReadyMadeReport, setReportScheduleDto: SetReportScheduleDto, options?: AxiosRequestConfig): AxiosPromise<ReportScheduleDto>;
|
|
51998
53044
|
/**
|
|
51999
|
-
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its PDF and Excel
|
|
53045
|
+
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its files, as dashboard-one\'s Reports downloads them: the sales report\'s PDF and Excel for sales, salesVat, payments and productSales, the end-of-day PDF for zReport, none for cashSessions and staff, whose email opens the report for its days) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
|
|
52000
53046
|
* @summary Set when a store\'s saved report is emailed
|
|
52001
53047
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
52002
53048
|
* @param {string} reportId The saved report\'s id
|
|
@@ -52048,7 +53094,7 @@ export declare class ReportSchedulesApi extends BaseAPI implements ReportSchedul
|
|
|
52048
53094
|
* Its schedule: cadence, time and zone, recipients and when it next sends. 404 when none is saved. Managers only.
|
|
52049
53095
|
* @summary Read when a store\'s ready-made report is emailed
|
|
52050
53096
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
52051
|
-
* @param {ReadyMadeReport} readyMadeReport The ready-made report
|
|
53097
|
+
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
|
|
52052
53098
|
* @param {*} [options] Override http request option.
|
|
52053
53099
|
* @throws {RequiredError}
|
|
52054
53100
|
* @memberof ReportSchedulesApi
|
|
@@ -52091,7 +53137,7 @@ export declare class ReportSchedulesApi extends BaseAPI implements ReportSchedul
|
|
|
52091
53137
|
* Every time it was emailed, newest first, a page at a time: the days it covered, who it went to and the files it kept.
|
|
52092
53138
|
* @summary List the past runs of a store\'s ready-made report
|
|
52093
53139
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
52094
|
-
* @param {ReadyMadeReport} readyMadeReport The ready-made report
|
|
53140
|
+
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
|
|
52095
53141
|
* @param {number} [limit] At most this many runs, 1 to 100. Absent: 30
|
|
52096
53142
|
* @param {string} [after] The id of the last run of the page before; the list goes on after it
|
|
52097
53143
|
* @param {*} [options] Override http request option.
|
|
@@ -52112,7 +53158,7 @@ export declare class ReportSchedulesApi extends BaseAPI implements ReportSchedul
|
|
|
52112
53158
|
*/
|
|
52113
53159
|
listStoreSavedReportRuns(businessId: number, reportId: string, limit?: number, after?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ReportRunListDto, any, {}>>;
|
|
52114
53160
|
/**
|
|
52115
|
-
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its PDF and Excel
|
|
53161
|
+
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its files, as dashboard-one\'s Reports downloads them: the sales report\'s PDF and Excel for sales, salesVat, payments and productSales, the end-of-day PDF for zReport, none for cashSessions and staff, whose email opens the report for its days) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
|
|
52116
53162
|
* @summary Set when an organisation\'s saved report is emailed
|
|
52117
53163
|
* @param {string} groupId The organisation\'s id: its group\'s accountId in the licence server
|
|
52118
53164
|
* @param {string} reportId The saved report\'s id
|
|
@@ -52123,10 +53169,10 @@ export declare class ReportSchedulesApi extends BaseAPI implements ReportSchedul
|
|
|
52123
53169
|
*/
|
|
52124
53170
|
setOrganisationSavedReportSchedule(groupId: string, reportId: string, setReportScheduleDto: SetReportScheduleDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ReportScheduleDto, any, {}>>;
|
|
52125
53171
|
/**
|
|
52126
|
-
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its PDF and Excel
|
|
53172
|
+
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its files, as dashboard-one\'s Reports downloads them: the sales report\'s PDF and Excel for sales, salesVat, payments and productSales, the end-of-day PDF for zReport, none for cashSessions and staff, whose email opens the report for its days) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
|
|
52127
53173
|
* @summary Set when a store\'s ready-made report is emailed
|
|
52128
53174
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
52129
|
-
* @param {ReadyMadeReport} readyMadeReport The ready-made report
|
|
53175
|
+
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
|
|
52130
53176
|
* @param {SetReportScheduleDto} setReportScheduleDto
|
|
52131
53177
|
* @param {*} [options] Override http request option.
|
|
52132
53178
|
* @throws {RequiredError}
|
|
@@ -52134,7 +53180,7 @@ export declare class ReportSchedulesApi extends BaseAPI implements ReportSchedul
|
|
|
52134
53180
|
*/
|
|
52135
53181
|
setStoreReadyMadeReportSchedule(businessId: number, readyMadeReport: ReadyMadeReport, setReportScheduleDto: SetReportScheduleDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ReportScheduleDto, any, {}>>;
|
|
52136
53182
|
/**
|
|
52137
|
-
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its PDF and Excel
|
|
53183
|
+
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its files, as dashboard-one\'s Reports downloads them: the sales report\'s PDF and Excel for sales, salesVat, payments and productSales, the end-of-day PDF for zReport, none for cashSessions and staff, whose email opens the report for its days) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
|
|
52138
53184
|
* @summary Set when a store\'s saved report is emailed
|
|
52139
53185
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
52140
53186
|
* @param {string} reportId The saved report\'s id
|
|
@@ -53211,7 +54257,7 @@ export declare const SavedReportsApiAxiosParamCreator: (configuration?: Configur
|
|
|
53211
54257
|
*/
|
|
53212
54258
|
getOrganisationSavedReport: (groupId: string, reportId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
53213
54259
|
/**
|
|
53214
|
-
* No sign-in. The report\'s name, kind, cards and filters,
|
|
54260
|
+
* No sign-in. The report\'s name, kind, cards and filters, the store or organisation whose data it reads, and numbers: what dashboard-one\'s Analytics dashboard reads for the same cards, read now for each side\'s saved period and apps: the sales report (as GET /api/v6/report/sales: summary, items, payments and discounts, by store and app, with totals, compared with the same weekdays before, up to the same time while the period runs) and, when its cards show them, a one-day period\'s 14-day trend, the year\'s 26 weeks, the hours (the period\'s, today\'s and a normal day\'s), items bought together and order types. Aggregates only: no order, person or customer. Answered only while the report\'s owner still manages its store or organisation (404 once they do not). A custom period is read for its last 366 days at most. Never kept by a cache (Cache-Control: no-store). Only the report\'s own store, or its organisation\'s stores as the licence server names them now, are ever read: a store its filters name that is neither is left out. Nothing but the token is taken from the request. numbers is null, and the definition still answers, when they could not be read. 404 when no report is public under that token (never made public, made private again, or published again with a new link).
|
|
53215
54261
|
* @summary Read a public report by its link
|
|
53216
54262
|
* @param {string} token The public link\'s token, 43 characters
|
|
53217
54263
|
* @param {*} [options] Override http request option.
|
|
@@ -53359,7 +54405,7 @@ export declare const SavedReportsApiFp: (configuration?: Configuration) => {
|
|
|
53359
54405
|
*/
|
|
53360
54406
|
getOrganisationSavedReport(groupId: string, reportId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SavedReportDto>>;
|
|
53361
54407
|
/**
|
|
53362
|
-
* No sign-in. The report\'s name, kind, cards and filters,
|
|
54408
|
+
* No sign-in. The report\'s name, kind, cards and filters, the store or organisation whose data it reads, and numbers: what dashboard-one\'s Analytics dashboard reads for the same cards, read now for each side\'s saved period and apps: the sales report (as GET /api/v6/report/sales: summary, items, payments and discounts, by store and app, with totals, compared with the same weekdays before, up to the same time while the period runs) and, when its cards show them, a one-day period\'s 14-day trend, the year\'s 26 weeks, the hours (the period\'s, today\'s and a normal day\'s), items bought together and order types. Aggregates only: no order, person or customer. Answered only while the report\'s owner still manages its store or organisation (404 once they do not). A custom period is read for its last 366 days at most. Never kept by a cache (Cache-Control: no-store). Only the report\'s own store, or its organisation\'s stores as the licence server names them now, are ever read: a store its filters name that is neither is left out. Nothing but the token is taken from the request. numbers is null, and the definition still answers, when they could not be read. 404 when no report is public under that token (never made public, made private again, or published again with a new link).
|
|
53363
54409
|
* @summary Read a public report by its link
|
|
53364
54410
|
* @param {string} token The public link\'s token, 43 characters
|
|
53365
54411
|
* @param {*} [options] Override http request option.
|
|
@@ -53507,7 +54553,7 @@ export declare const SavedReportsApiFactory: (configuration?: Configuration, bas
|
|
|
53507
54553
|
*/
|
|
53508
54554
|
getOrganisationSavedReport(groupId: string, reportId: string, options?: any): AxiosPromise<SavedReportDto>;
|
|
53509
54555
|
/**
|
|
53510
|
-
* No sign-in. The report\'s name, kind, cards and filters,
|
|
54556
|
+
* No sign-in. The report\'s name, kind, cards and filters, the store or organisation whose data it reads, and numbers: what dashboard-one\'s Analytics dashboard reads for the same cards, read now for each side\'s saved period and apps: the sales report (as GET /api/v6/report/sales: summary, items, payments and discounts, by store and app, with totals, compared with the same weekdays before, up to the same time while the period runs) and, when its cards show them, a one-day period\'s 14-day trend, the year\'s 26 weeks, the hours (the period\'s, today\'s and a normal day\'s), items bought together and order types. Aggregates only: no order, person or customer. Answered only while the report\'s owner still manages its store or organisation (404 once they do not). A custom period is read for its last 366 days at most. Never kept by a cache (Cache-Control: no-store). Only the report\'s own store, or its organisation\'s stores as the licence server names them now, are ever read: a store its filters name that is neither is left out. Nothing but the token is taken from the request. numbers is null, and the definition still answers, when they could not be read. 404 when no report is public under that token (never made public, made private again, or published again with a new link).
|
|
53511
54557
|
* @summary Read a public report by its link
|
|
53512
54558
|
* @param {string} token The public link\'s token, 43 characters
|
|
53513
54559
|
* @param {*} [options] Override http request option.
|
|
@@ -53663,7 +54709,7 @@ export interface SavedReportsApiInterface {
|
|
|
53663
54709
|
*/
|
|
53664
54710
|
getOrganisationSavedReport(groupId: string, reportId: string, options?: AxiosRequestConfig): AxiosPromise<SavedReportDto>;
|
|
53665
54711
|
/**
|
|
53666
|
-
* No sign-in. The report\'s name, kind, cards and filters,
|
|
54712
|
+
* No sign-in. The report\'s name, kind, cards and filters, the store or organisation whose data it reads, and numbers: what dashboard-one\'s Analytics dashboard reads for the same cards, read now for each side\'s saved period and apps: the sales report (as GET /api/v6/report/sales: summary, items, payments and discounts, by store and app, with totals, compared with the same weekdays before, up to the same time while the period runs) and, when its cards show them, a one-day period\'s 14-day trend, the year\'s 26 weeks, the hours (the period\'s, today\'s and a normal day\'s), items bought together and order types. Aggregates only: no order, person or customer. Answered only while the report\'s owner still manages its store or organisation (404 once they do not). A custom period is read for its last 366 days at most. Never kept by a cache (Cache-Control: no-store). Only the report\'s own store, or its organisation\'s stores as the licence server names them now, are ever read: a store its filters name that is neither is left out. Nothing but the token is taken from the request. numbers is null, and the definition still answers, when they could not be read. 404 when no report is public under that token (never made public, made private again, or published again with a new link).
|
|
53667
54713
|
* @summary Read a public report by its link
|
|
53668
54714
|
* @param {string} token The public link\'s token, 43 characters
|
|
53669
54715
|
* @param {*} [options] Override http request option.
|
|
@@ -53828,7 +54874,7 @@ export declare class SavedReportsApi extends BaseAPI implements SavedReportsApiI
|
|
|
53828
54874
|
*/
|
|
53829
54875
|
getOrganisationSavedReport(groupId: string, reportId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SavedReportDto, any, {}>>;
|
|
53830
54876
|
/**
|
|
53831
|
-
* No sign-in. The report\'s name, kind, cards and filters,
|
|
54877
|
+
* No sign-in. The report\'s name, kind, cards and filters, the store or organisation whose data it reads, and numbers: what dashboard-one\'s Analytics dashboard reads for the same cards, read now for each side\'s saved period and apps: the sales report (as GET /api/v6/report/sales: summary, items, payments and discounts, by store and app, with totals, compared with the same weekdays before, up to the same time while the period runs) and, when its cards show them, a one-day period\'s 14-day trend, the year\'s 26 weeks, the hours (the period\'s, today\'s and a normal day\'s), items bought together and order types. Aggregates only: no order, person or customer. Answered only while the report\'s owner still manages its store or organisation (404 once they do not). A custom period is read for its last 366 days at most. Never kept by a cache (Cache-Control: no-store). Only the report\'s own store, or its organisation\'s stores as the licence server names them now, are ever read: a store its filters name that is neither is left out. Nothing but the token is taken from the request. numbers is null, and the definition still answers, when they could not be read. 404 when no report is public under that token (never made public, made private again, or published again with a new link).
|
|
53832
54878
|
* @summary Read a public report by its link
|
|
53833
54879
|
* @param {string} token The public link\'s token, 43 characters
|
|
53834
54880
|
* @param {*} [options] Override http request option.
|
|
@@ -54787,6 +55833,321 @@ export declare class VendureSellerApi extends BaseAPI implements VendureSellerAp
|
|
|
54787
55833
|
*/
|
|
54788
55834
|
upsert(vendureSellerUpsertDto: VendureSellerUpsertDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VendureSellerSavedDto, any, {}>>;
|
|
54789
55835
|
}
|
|
55836
|
+
/**
|
|
55837
|
+
* VenueKiosksApi - axios parameter creator
|
|
55838
|
+
* @export
|
|
55839
|
+
*/
|
|
55840
|
+
export declare const VenueKiosksApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
55841
|
+
/**
|
|
55842
|
+
* Only the fields sent change. status ACTIVE on a removed kiosk puts it back in use, asks the licence exactly as a claim does, and makes it the station the device resolves to. Every other change keeps the kiosk\'s updatedAt, so it never takes the device from a venue it moved to (the device resolves to its station with the newest updatedAt), and changes only a kiosk in use: one removed meanwhile answers 409. status INACTIVE takes the kiosk out of use and unlinks its terminal; on a kiosk already removed it answers the kiosk unchanged. Any other change of a removed kiosk is refused. The kiosk\'s kept station is forgotten, so the device sees the change on its next request.
|
|
55843
|
+
* @summary Rename a kiosk, change its prefix, or put it in or out of use
|
|
55844
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
55845
|
+
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
55846
|
+
* @param {ChangeKioskDto} changeKioskDto
|
|
55847
|
+
* @param {*} [options] Override http request option.
|
|
55848
|
+
* @throws {RequiredError}
|
|
55849
|
+
*/
|
|
55850
|
+
changeVenueKiosk: (businessId: number, stationId: string, changeKioskDto: ChangeKioskDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
55851
|
+
/**
|
|
55852
|
+
* The kiosk shows its Hardware ID on its Getting started screen until it is linked; the id is trimmed and written in the case the device sends it (an iOS vendor id upper case, an Android id lower case). A device that is one of the venue\'s tills, in use or not, or active at another venue, is refused first, before the licence is asked. A kiosk already in use here is only renamed, with no licence check. Otherwise the licence is read from the license server and must have the kiosk add-on; then, under a lock on the venue\'s kiosks and then one on the device, the device\'s other uses are checked again and the venue\'s active kiosks with this one must fit the licence\'s kiosk limit. The venue\'s station of the device becomes an active kiosk (type KIOSK), created when the venue has none (device KIOSK_STAND, prefix empty unless sent), with the name sent, and becomes the station the device resolves to; the kiosk then continues on its next check. A kiosk the venue already had, inactive, counts like a new one. Nothing is claimed unchecked: when the licence cannot be read, the claim is refused.
|
|
55853
|
+
* @summary Link a kiosk to the venue by the Hardware ID it shows
|
|
55854
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
55855
|
+
* @param {ClaimKioskDto} claimKioskDto
|
|
55856
|
+
* @param {*} [options] Override http request option.
|
|
55857
|
+
* @throws {RequiredError}
|
|
55858
|
+
*/
|
|
55859
|
+
claimVenueKiosk: (businessId: number, claimKioskDto: ClaimKioskDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
55860
|
+
/**
|
|
55861
|
+
* paymentTerminalId names one of the venue\'s stored terminals, or null unlinks the kiosk\'s terminal. A terminal another kiosk or till holds is refused, never taken from it. The kiosk\'s kept station is forgotten, so the kiosk pays on the new terminal from its next request.
|
|
55862
|
+
* @summary Link one of the venue\'s payment terminals to a kiosk, or unlink it
|
|
55863
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
55864
|
+
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
55865
|
+
* @param {LinkKioskTerminalDto} linkKioskTerminalDto
|
|
55866
|
+
* @param {*} [options] Override http request option.
|
|
55867
|
+
* @throws {RequiredError}
|
|
55868
|
+
*/
|
|
55869
|
+
linkVenueKioskTerminal: (businessId: number, stationId: string, linkKioskTerminalDto: LinkKioskTerminalDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
55870
|
+
/**
|
|
55871
|
+
* Every kiosk station of the venue, active or removed, oldest first, with its linked payment terminal. Read from the database every time.
|
|
55872
|
+
* @summary List the venue\'s kiosks
|
|
55873
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
55874
|
+
* @param {*} [options] Override http request option.
|
|
55875
|
+
* @throws {RequiredError}
|
|
55876
|
+
*/
|
|
55877
|
+
listVenueKiosks: (businessId: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
55878
|
+
/**
|
|
55879
|
+
* The venue\'s stored terminals, oldest first, each with the station it is linked to. A terminal is stored once a till discovered it at its provider (POST /v1/terminal/discover); this route asks no provider.
|
|
55880
|
+
* @summary List the venue\'s payment terminals, for linking one to a kiosk
|
|
55881
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
55882
|
+
* @param {*} [options] Override http request option.
|
|
55883
|
+
* @throws {RequiredError}
|
|
55884
|
+
*/
|
|
55885
|
+
listVenuePaymentTerminals: (businessId: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
55886
|
+
/**
|
|
55887
|
+
* The kiosk is set INACTIVE and its terminal unlinked; its row stays, so its orders keep their station and it can be claimed again. It no longer counts against the licence, and the kiosk shows its Getting started screen on its next check. Nothing is deleted. A kiosk already removed is answered as it is, unchanged.
|
|
55888
|
+
* @summary Remove a kiosk from use
|
|
55889
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
55890
|
+
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
55891
|
+
* @param {*} [options] Override http request option.
|
|
55892
|
+
* @throws {RequiredError}
|
|
55893
|
+
*/
|
|
55894
|
+
removeVenueKiosk: (businessId: number, stationId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
55895
|
+
};
|
|
55896
|
+
/**
|
|
55897
|
+
* VenueKiosksApi - functional programming interface
|
|
55898
|
+
* @export
|
|
55899
|
+
*/
|
|
55900
|
+
export declare const VenueKiosksApiFp: (configuration?: Configuration) => {
|
|
55901
|
+
/**
|
|
55902
|
+
* Only the fields sent change. status ACTIVE on a removed kiosk puts it back in use, asks the licence exactly as a claim does, and makes it the station the device resolves to. Every other change keeps the kiosk\'s updatedAt, so it never takes the device from a venue it moved to (the device resolves to its station with the newest updatedAt), and changes only a kiosk in use: one removed meanwhile answers 409. status INACTIVE takes the kiosk out of use and unlinks its terminal; on a kiosk already removed it answers the kiosk unchanged. Any other change of a removed kiosk is refused. The kiosk\'s kept station is forgotten, so the device sees the change on its next request.
|
|
55903
|
+
* @summary Rename a kiosk, change its prefix, or put it in or out of use
|
|
55904
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
55905
|
+
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
55906
|
+
* @param {ChangeKioskDto} changeKioskDto
|
|
55907
|
+
* @param {*} [options] Override http request option.
|
|
55908
|
+
* @throws {RequiredError}
|
|
55909
|
+
*/
|
|
55910
|
+
changeVenueKiosk(businessId: number, stationId: string, changeKioskDto: ChangeKioskDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueKioskDto>>;
|
|
55911
|
+
/**
|
|
55912
|
+
* The kiosk shows its Hardware ID on its Getting started screen until it is linked; the id is trimmed and written in the case the device sends it (an iOS vendor id upper case, an Android id lower case). A device that is one of the venue\'s tills, in use or not, or active at another venue, is refused first, before the licence is asked. A kiosk already in use here is only renamed, with no licence check. Otherwise the licence is read from the license server and must have the kiosk add-on; then, under a lock on the venue\'s kiosks and then one on the device, the device\'s other uses are checked again and the venue\'s active kiosks with this one must fit the licence\'s kiosk limit. The venue\'s station of the device becomes an active kiosk (type KIOSK), created when the venue has none (device KIOSK_STAND, prefix empty unless sent), with the name sent, and becomes the station the device resolves to; the kiosk then continues on its next check. A kiosk the venue already had, inactive, counts like a new one. Nothing is claimed unchecked: when the licence cannot be read, the claim is refused.
|
|
55913
|
+
* @summary Link a kiosk to the venue by the Hardware ID it shows
|
|
55914
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
55915
|
+
* @param {ClaimKioskDto} claimKioskDto
|
|
55916
|
+
* @param {*} [options] Override http request option.
|
|
55917
|
+
* @throws {RequiredError}
|
|
55918
|
+
*/
|
|
55919
|
+
claimVenueKiosk(businessId: number, claimKioskDto: ClaimKioskDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueKioskDto>>;
|
|
55920
|
+
/**
|
|
55921
|
+
* paymentTerminalId names one of the venue\'s stored terminals, or null unlinks the kiosk\'s terminal. A terminal another kiosk or till holds is refused, never taken from it. The kiosk\'s kept station is forgotten, so the kiosk pays on the new terminal from its next request.
|
|
55922
|
+
* @summary Link one of the venue\'s payment terminals to a kiosk, or unlink it
|
|
55923
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
55924
|
+
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
55925
|
+
* @param {LinkKioskTerminalDto} linkKioskTerminalDto
|
|
55926
|
+
* @param {*} [options] Override http request option.
|
|
55927
|
+
* @throws {RequiredError}
|
|
55928
|
+
*/
|
|
55929
|
+
linkVenueKioskTerminal(businessId: number, stationId: string, linkKioskTerminalDto: LinkKioskTerminalDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueKioskDto>>;
|
|
55930
|
+
/**
|
|
55931
|
+
* Every kiosk station of the venue, active or removed, oldest first, with its linked payment terminal. Read from the database every time.
|
|
55932
|
+
* @summary List the venue\'s kiosks
|
|
55933
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
55934
|
+
* @param {*} [options] Override http request option.
|
|
55935
|
+
* @throws {RequiredError}
|
|
55936
|
+
*/
|
|
55937
|
+
listVenueKiosks(businessId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueKiosksDto>>;
|
|
55938
|
+
/**
|
|
55939
|
+
* The venue\'s stored terminals, oldest first, each with the station it is linked to. A terminal is stored once a till discovered it at its provider (POST /v1/terminal/discover); this route asks no provider.
|
|
55940
|
+
* @summary List the venue\'s payment terminals, for linking one to a kiosk
|
|
55941
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
55942
|
+
* @param {*} [options] Override http request option.
|
|
55943
|
+
* @throws {RequiredError}
|
|
55944
|
+
*/
|
|
55945
|
+
listVenuePaymentTerminals(businessId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenuePaymentTerminalsDto>>;
|
|
55946
|
+
/**
|
|
55947
|
+
* The kiosk is set INACTIVE and its terminal unlinked; its row stays, so its orders keep their station and it can be claimed again. It no longer counts against the licence, and the kiosk shows its Getting started screen on its next check. Nothing is deleted. A kiosk already removed is answered as it is, unchanged.
|
|
55948
|
+
* @summary Remove a kiosk from use
|
|
55949
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
55950
|
+
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
55951
|
+
* @param {*} [options] Override http request option.
|
|
55952
|
+
* @throws {RequiredError}
|
|
55953
|
+
*/
|
|
55954
|
+
removeVenueKiosk(businessId: number, stationId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueKioskDto>>;
|
|
55955
|
+
};
|
|
55956
|
+
/**
|
|
55957
|
+
* VenueKiosksApi - factory interface
|
|
55958
|
+
* @export
|
|
55959
|
+
*/
|
|
55960
|
+
export declare const VenueKiosksApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
55961
|
+
/**
|
|
55962
|
+
* Only the fields sent change. status ACTIVE on a removed kiosk puts it back in use, asks the licence exactly as a claim does, and makes it the station the device resolves to. Every other change keeps the kiosk\'s updatedAt, so it never takes the device from a venue it moved to (the device resolves to its station with the newest updatedAt), and changes only a kiosk in use: one removed meanwhile answers 409. status INACTIVE takes the kiosk out of use and unlinks its terminal; on a kiosk already removed it answers the kiosk unchanged. Any other change of a removed kiosk is refused. The kiosk\'s kept station is forgotten, so the device sees the change on its next request.
|
|
55963
|
+
* @summary Rename a kiosk, change its prefix, or put it in or out of use
|
|
55964
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
55965
|
+
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
55966
|
+
* @param {ChangeKioskDto} changeKioskDto
|
|
55967
|
+
* @param {*} [options] Override http request option.
|
|
55968
|
+
* @throws {RequiredError}
|
|
55969
|
+
*/
|
|
55970
|
+
changeVenueKiosk(businessId: number, stationId: string, changeKioskDto: ChangeKioskDto, options?: any): AxiosPromise<VenueKioskDto>;
|
|
55971
|
+
/**
|
|
55972
|
+
* The kiosk shows its Hardware ID on its Getting started screen until it is linked; the id is trimmed and written in the case the device sends it (an iOS vendor id upper case, an Android id lower case). A device that is one of the venue\'s tills, in use or not, or active at another venue, is refused first, before the licence is asked. A kiosk already in use here is only renamed, with no licence check. Otherwise the licence is read from the license server and must have the kiosk add-on; then, under a lock on the venue\'s kiosks and then one on the device, the device\'s other uses are checked again and the venue\'s active kiosks with this one must fit the licence\'s kiosk limit. The venue\'s station of the device becomes an active kiosk (type KIOSK), created when the venue has none (device KIOSK_STAND, prefix empty unless sent), with the name sent, and becomes the station the device resolves to; the kiosk then continues on its next check. A kiosk the venue already had, inactive, counts like a new one. Nothing is claimed unchecked: when the licence cannot be read, the claim is refused.
|
|
55973
|
+
* @summary Link a kiosk to the venue by the Hardware ID it shows
|
|
55974
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
55975
|
+
* @param {ClaimKioskDto} claimKioskDto
|
|
55976
|
+
* @param {*} [options] Override http request option.
|
|
55977
|
+
* @throws {RequiredError}
|
|
55978
|
+
*/
|
|
55979
|
+
claimVenueKiosk(businessId: number, claimKioskDto: ClaimKioskDto, options?: any): AxiosPromise<VenueKioskDto>;
|
|
55980
|
+
/**
|
|
55981
|
+
* paymentTerminalId names one of the venue\'s stored terminals, or null unlinks the kiosk\'s terminal. A terminal another kiosk or till holds is refused, never taken from it. The kiosk\'s kept station is forgotten, so the kiosk pays on the new terminal from its next request.
|
|
55982
|
+
* @summary Link one of the venue\'s payment terminals to a kiosk, or unlink it
|
|
55983
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
55984
|
+
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
55985
|
+
* @param {LinkKioskTerminalDto} linkKioskTerminalDto
|
|
55986
|
+
* @param {*} [options] Override http request option.
|
|
55987
|
+
* @throws {RequiredError}
|
|
55988
|
+
*/
|
|
55989
|
+
linkVenueKioskTerminal(businessId: number, stationId: string, linkKioskTerminalDto: LinkKioskTerminalDto, options?: any): AxiosPromise<VenueKioskDto>;
|
|
55990
|
+
/**
|
|
55991
|
+
* Every kiosk station of the venue, active or removed, oldest first, with its linked payment terminal. Read from the database every time.
|
|
55992
|
+
* @summary List the venue\'s kiosks
|
|
55993
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
55994
|
+
* @param {*} [options] Override http request option.
|
|
55995
|
+
* @throws {RequiredError}
|
|
55996
|
+
*/
|
|
55997
|
+
listVenueKiosks(businessId: number, options?: any): AxiosPromise<VenueKiosksDto>;
|
|
55998
|
+
/**
|
|
55999
|
+
* The venue\'s stored terminals, oldest first, each with the station it is linked to. A terminal is stored once a till discovered it at its provider (POST /v1/terminal/discover); this route asks no provider.
|
|
56000
|
+
* @summary List the venue\'s payment terminals, for linking one to a kiosk
|
|
56001
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56002
|
+
* @param {*} [options] Override http request option.
|
|
56003
|
+
* @throws {RequiredError}
|
|
56004
|
+
*/
|
|
56005
|
+
listVenuePaymentTerminals(businessId: number, options?: any): AxiosPromise<VenuePaymentTerminalsDto>;
|
|
56006
|
+
/**
|
|
56007
|
+
* The kiosk is set INACTIVE and its terminal unlinked; its row stays, so its orders keep their station and it can be claimed again. It no longer counts against the licence, and the kiosk shows its Getting started screen on its next check. Nothing is deleted. A kiosk already removed is answered as it is, unchanged.
|
|
56008
|
+
* @summary Remove a kiosk from use
|
|
56009
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56010
|
+
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
56011
|
+
* @param {*} [options] Override http request option.
|
|
56012
|
+
* @throws {RequiredError}
|
|
56013
|
+
*/
|
|
56014
|
+
removeVenueKiosk(businessId: number, stationId: string, options?: any): AxiosPromise<VenueKioskDto>;
|
|
56015
|
+
};
|
|
56016
|
+
/**
|
|
56017
|
+
* VenueKiosksApi - interface
|
|
56018
|
+
* @export
|
|
56019
|
+
* @interface VenueKiosksApi
|
|
56020
|
+
*/
|
|
56021
|
+
export interface VenueKiosksApiInterface {
|
|
56022
|
+
/**
|
|
56023
|
+
* Only the fields sent change. status ACTIVE on a removed kiosk puts it back in use, asks the licence exactly as a claim does, and makes it the station the device resolves to. Every other change keeps the kiosk\'s updatedAt, so it never takes the device from a venue it moved to (the device resolves to its station with the newest updatedAt), and changes only a kiosk in use: one removed meanwhile answers 409. status INACTIVE takes the kiosk out of use and unlinks its terminal; on a kiosk already removed it answers the kiosk unchanged. Any other change of a removed kiosk is refused. The kiosk\'s kept station is forgotten, so the device sees the change on its next request.
|
|
56024
|
+
* @summary Rename a kiosk, change its prefix, or put it in or out of use
|
|
56025
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56026
|
+
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
56027
|
+
* @param {ChangeKioskDto} changeKioskDto
|
|
56028
|
+
* @param {*} [options] Override http request option.
|
|
56029
|
+
* @throws {RequiredError}
|
|
56030
|
+
* @memberof VenueKiosksApiInterface
|
|
56031
|
+
*/
|
|
56032
|
+
changeVenueKiosk(businessId: number, stationId: string, changeKioskDto: ChangeKioskDto, options?: AxiosRequestConfig): AxiosPromise<VenueKioskDto>;
|
|
56033
|
+
/**
|
|
56034
|
+
* The kiosk shows its Hardware ID on its Getting started screen until it is linked; the id is trimmed and written in the case the device sends it (an iOS vendor id upper case, an Android id lower case). A device that is one of the venue\'s tills, in use or not, or active at another venue, is refused first, before the licence is asked. A kiosk already in use here is only renamed, with no licence check. Otherwise the licence is read from the license server and must have the kiosk add-on; then, under a lock on the venue\'s kiosks and then one on the device, the device\'s other uses are checked again and the venue\'s active kiosks with this one must fit the licence\'s kiosk limit. The venue\'s station of the device becomes an active kiosk (type KIOSK), created when the venue has none (device KIOSK_STAND, prefix empty unless sent), with the name sent, and becomes the station the device resolves to; the kiosk then continues on its next check. A kiosk the venue already had, inactive, counts like a new one. Nothing is claimed unchecked: when the licence cannot be read, the claim is refused.
|
|
56035
|
+
* @summary Link a kiosk to the venue by the Hardware ID it shows
|
|
56036
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56037
|
+
* @param {ClaimKioskDto} claimKioskDto
|
|
56038
|
+
* @param {*} [options] Override http request option.
|
|
56039
|
+
* @throws {RequiredError}
|
|
56040
|
+
* @memberof VenueKiosksApiInterface
|
|
56041
|
+
*/
|
|
56042
|
+
claimVenueKiosk(businessId: number, claimKioskDto: ClaimKioskDto, options?: AxiosRequestConfig): AxiosPromise<VenueKioskDto>;
|
|
56043
|
+
/**
|
|
56044
|
+
* paymentTerminalId names one of the venue\'s stored terminals, or null unlinks the kiosk\'s terminal. A terminal another kiosk or till holds is refused, never taken from it. The kiosk\'s kept station is forgotten, so the kiosk pays on the new terminal from its next request.
|
|
56045
|
+
* @summary Link one of the venue\'s payment terminals to a kiosk, or unlink it
|
|
56046
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56047
|
+
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
56048
|
+
* @param {LinkKioskTerminalDto} linkKioskTerminalDto
|
|
56049
|
+
* @param {*} [options] Override http request option.
|
|
56050
|
+
* @throws {RequiredError}
|
|
56051
|
+
* @memberof VenueKiosksApiInterface
|
|
56052
|
+
*/
|
|
56053
|
+
linkVenueKioskTerminal(businessId: number, stationId: string, linkKioskTerminalDto: LinkKioskTerminalDto, options?: AxiosRequestConfig): AxiosPromise<VenueKioskDto>;
|
|
56054
|
+
/**
|
|
56055
|
+
* Every kiosk station of the venue, active or removed, oldest first, with its linked payment terminal. Read from the database every time.
|
|
56056
|
+
* @summary List the venue\'s kiosks
|
|
56057
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56058
|
+
* @param {*} [options] Override http request option.
|
|
56059
|
+
* @throws {RequiredError}
|
|
56060
|
+
* @memberof VenueKiosksApiInterface
|
|
56061
|
+
*/
|
|
56062
|
+
listVenueKiosks(businessId: number, options?: AxiosRequestConfig): AxiosPromise<VenueKiosksDto>;
|
|
56063
|
+
/**
|
|
56064
|
+
* The venue\'s stored terminals, oldest first, each with the station it is linked to. A terminal is stored once a till discovered it at its provider (POST /v1/terminal/discover); this route asks no provider.
|
|
56065
|
+
* @summary List the venue\'s payment terminals, for linking one to a kiosk
|
|
56066
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56067
|
+
* @param {*} [options] Override http request option.
|
|
56068
|
+
* @throws {RequiredError}
|
|
56069
|
+
* @memberof VenueKiosksApiInterface
|
|
56070
|
+
*/
|
|
56071
|
+
listVenuePaymentTerminals(businessId: number, options?: AxiosRequestConfig): AxiosPromise<VenuePaymentTerminalsDto>;
|
|
56072
|
+
/**
|
|
56073
|
+
* The kiosk is set INACTIVE and its terminal unlinked; its row stays, so its orders keep their station and it can be claimed again. It no longer counts against the licence, and the kiosk shows its Getting started screen on its next check. Nothing is deleted. A kiosk already removed is answered as it is, unchanged.
|
|
56074
|
+
* @summary Remove a kiosk from use
|
|
56075
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56076
|
+
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
56077
|
+
* @param {*} [options] Override http request option.
|
|
56078
|
+
* @throws {RequiredError}
|
|
56079
|
+
* @memberof VenueKiosksApiInterface
|
|
56080
|
+
*/
|
|
56081
|
+
removeVenueKiosk(businessId: number, stationId: string, options?: AxiosRequestConfig): AxiosPromise<VenueKioskDto>;
|
|
56082
|
+
}
|
|
56083
|
+
/**
|
|
56084
|
+
* VenueKiosksApi - object-oriented interface
|
|
56085
|
+
* @export
|
|
56086
|
+
* @class VenueKiosksApi
|
|
56087
|
+
* @extends {BaseAPI}
|
|
56088
|
+
*/
|
|
56089
|
+
export declare class VenueKiosksApi extends BaseAPI implements VenueKiosksApiInterface {
|
|
56090
|
+
/**
|
|
56091
|
+
* Only the fields sent change. status ACTIVE on a removed kiosk puts it back in use, asks the licence exactly as a claim does, and makes it the station the device resolves to. Every other change keeps the kiosk\'s updatedAt, so it never takes the device from a venue it moved to (the device resolves to its station with the newest updatedAt), and changes only a kiosk in use: one removed meanwhile answers 409. status INACTIVE takes the kiosk out of use and unlinks its terminal; on a kiosk already removed it answers the kiosk unchanged. Any other change of a removed kiosk is refused. The kiosk\'s kept station is forgotten, so the device sees the change on its next request.
|
|
56092
|
+
* @summary Rename a kiosk, change its prefix, or put it in or out of use
|
|
56093
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56094
|
+
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
56095
|
+
* @param {ChangeKioskDto} changeKioskDto
|
|
56096
|
+
* @param {*} [options] Override http request option.
|
|
56097
|
+
* @throws {RequiredError}
|
|
56098
|
+
* @memberof VenueKiosksApi
|
|
56099
|
+
*/
|
|
56100
|
+
changeVenueKiosk(businessId: number, stationId: string, changeKioskDto: ChangeKioskDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VenueKioskDto, any, {}>>;
|
|
56101
|
+
/**
|
|
56102
|
+
* The kiosk shows its Hardware ID on its Getting started screen until it is linked; the id is trimmed and written in the case the device sends it (an iOS vendor id upper case, an Android id lower case). A device that is one of the venue\'s tills, in use or not, or active at another venue, is refused first, before the licence is asked. A kiosk already in use here is only renamed, with no licence check. Otherwise the licence is read from the license server and must have the kiosk add-on; then, under a lock on the venue\'s kiosks and then one on the device, the device\'s other uses are checked again and the venue\'s active kiosks with this one must fit the licence\'s kiosk limit. The venue\'s station of the device becomes an active kiosk (type KIOSK), created when the venue has none (device KIOSK_STAND, prefix empty unless sent), with the name sent, and becomes the station the device resolves to; the kiosk then continues on its next check. A kiosk the venue already had, inactive, counts like a new one. Nothing is claimed unchecked: when the licence cannot be read, the claim is refused.
|
|
56103
|
+
* @summary Link a kiosk to the venue by the Hardware ID it shows
|
|
56104
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56105
|
+
* @param {ClaimKioskDto} claimKioskDto
|
|
56106
|
+
* @param {*} [options] Override http request option.
|
|
56107
|
+
* @throws {RequiredError}
|
|
56108
|
+
* @memberof VenueKiosksApi
|
|
56109
|
+
*/
|
|
56110
|
+
claimVenueKiosk(businessId: number, claimKioskDto: ClaimKioskDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VenueKioskDto, any, {}>>;
|
|
56111
|
+
/**
|
|
56112
|
+
* paymentTerminalId names one of the venue\'s stored terminals, or null unlinks the kiosk\'s terminal. A terminal another kiosk or till holds is refused, never taken from it. The kiosk\'s kept station is forgotten, so the kiosk pays on the new terminal from its next request.
|
|
56113
|
+
* @summary Link one of the venue\'s payment terminals to a kiosk, or unlink it
|
|
56114
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56115
|
+
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
56116
|
+
* @param {LinkKioskTerminalDto} linkKioskTerminalDto
|
|
56117
|
+
* @param {*} [options] Override http request option.
|
|
56118
|
+
* @throws {RequiredError}
|
|
56119
|
+
* @memberof VenueKiosksApi
|
|
56120
|
+
*/
|
|
56121
|
+
linkVenueKioskTerminal(businessId: number, stationId: string, linkKioskTerminalDto: LinkKioskTerminalDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VenueKioskDto, any, {}>>;
|
|
56122
|
+
/**
|
|
56123
|
+
* Every kiosk station of the venue, active or removed, oldest first, with its linked payment terminal. Read from the database every time.
|
|
56124
|
+
* @summary List the venue\'s kiosks
|
|
56125
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56126
|
+
* @param {*} [options] Override http request option.
|
|
56127
|
+
* @throws {RequiredError}
|
|
56128
|
+
* @memberof VenueKiosksApi
|
|
56129
|
+
*/
|
|
56130
|
+
listVenueKiosks(businessId: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VenueKiosksDto, any, {}>>;
|
|
56131
|
+
/**
|
|
56132
|
+
* The venue\'s stored terminals, oldest first, each with the station it is linked to. A terminal is stored once a till discovered it at its provider (POST /v1/terminal/discover); this route asks no provider.
|
|
56133
|
+
* @summary List the venue\'s payment terminals, for linking one to a kiosk
|
|
56134
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56135
|
+
* @param {*} [options] Override http request option.
|
|
56136
|
+
* @throws {RequiredError}
|
|
56137
|
+
* @memberof VenueKiosksApi
|
|
56138
|
+
*/
|
|
56139
|
+
listVenuePaymentTerminals(businessId: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VenuePaymentTerminalsDto, any, {}>>;
|
|
56140
|
+
/**
|
|
56141
|
+
* The kiosk is set INACTIVE and its terminal unlinked; its row stays, so its orders keep their station and it can be claimed again. It no longer counts against the licence, and the kiosk shows its Getting started screen on its next check. Nothing is deleted. A kiosk already removed is answered as it is, unchanged.
|
|
56142
|
+
* @summary Remove a kiosk from use
|
|
56143
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56144
|
+
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
56145
|
+
* @param {*} [options] Override http request option.
|
|
56146
|
+
* @throws {RequiredError}
|
|
56147
|
+
* @memberof VenueKiosksApi
|
|
56148
|
+
*/
|
|
56149
|
+
removeVenueKiosk(businessId: number, stationId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VenueKioskDto, any, {}>>;
|
|
56150
|
+
}
|
|
54790
56151
|
/**
|
|
54791
56152
|
* VivaApi - axios parameter creator
|
|
54792
56153
|
* @export
|