@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/generated/api.ts
CHANGED
|
@@ -2669,6 +2669,33 @@ export interface ChangeEmployeeRoleDto {
|
|
|
2669
2669
|
*/
|
|
2670
2670
|
'permissionKeys'?: Array<PosPermission>;
|
|
2671
2671
|
}
|
|
2672
|
+
/**
|
|
2673
|
+
*
|
|
2674
|
+
* @export
|
|
2675
|
+
* @interface ChangeKioskDto
|
|
2676
|
+
*/
|
|
2677
|
+
export interface ChangeKioskDto {
|
|
2678
|
+
/**
|
|
2679
|
+
* The kiosk\'s new name; left out, it keeps its name
|
|
2680
|
+
* @type {string}
|
|
2681
|
+
* @memberof ChangeKioskDto
|
|
2682
|
+
*/
|
|
2683
|
+
'name'?: string;
|
|
2684
|
+
/**
|
|
2685
|
+
* What the kiosk\'s order numbers start with, an empty text for none; left out, it keeps its prefix
|
|
2686
|
+
* @type {string}
|
|
2687
|
+
* @memberof ChangeKioskDto
|
|
2688
|
+
*/
|
|
2689
|
+
'prefix'?: string;
|
|
2690
|
+
/**
|
|
2691
|
+
*
|
|
2692
|
+
* @type {Status}
|
|
2693
|
+
* @memberof ChangeKioskDto
|
|
2694
|
+
*/
|
|
2695
|
+
'status'?: Status;
|
|
2696
|
+
}
|
|
2697
|
+
|
|
2698
|
+
|
|
2672
2699
|
/**
|
|
2673
2700
|
*
|
|
2674
2701
|
* @export
|
|
@@ -3145,6 +3172,31 @@ export const CheckoutModelEnum = {
|
|
|
3145
3172
|
export type CheckoutModelEnum = typeof CheckoutModelEnum[keyof typeof CheckoutModelEnum];
|
|
3146
3173
|
|
|
3147
3174
|
|
|
3175
|
+
/**
|
|
3176
|
+
*
|
|
3177
|
+
* @export
|
|
3178
|
+
* @interface ClaimKioskDto
|
|
3179
|
+
*/
|
|
3180
|
+
export interface ClaimKioskDto {
|
|
3181
|
+
/**
|
|
3182
|
+
* 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
|
|
3183
|
+
* @type {string}
|
|
3184
|
+
* @memberof ClaimKioskDto
|
|
3185
|
+
*/
|
|
3186
|
+
'hardwareId': string;
|
|
3187
|
+
/**
|
|
3188
|
+
* The kiosk\'s name, as the venue\'s staff call it
|
|
3189
|
+
* @type {string}
|
|
3190
|
+
* @memberof ClaimKioskDto
|
|
3191
|
+
*/
|
|
3192
|
+
'name': string;
|
|
3193
|
+
/**
|
|
3194
|
+
* What the kiosk\'s order numbers start with. Left out, a new kiosk has none and a kiosk the venue had keeps its own
|
|
3195
|
+
* @type {string}
|
|
3196
|
+
* @memberof ClaimKioskDto
|
|
3197
|
+
*/
|
|
3198
|
+
'prefix'?: string;
|
|
3199
|
+
}
|
|
3148
3200
|
/**
|
|
3149
3201
|
*
|
|
3150
3202
|
* @export
|
|
@@ -11403,6 +11455,33 @@ export interface KioskStatusDto {
|
|
|
11403
11455
|
}
|
|
11404
11456
|
|
|
11405
11457
|
|
|
11458
|
+
/**
|
|
11459
|
+
*
|
|
11460
|
+
* @export
|
|
11461
|
+
* @interface KioskTerminalDto
|
|
11462
|
+
*/
|
|
11463
|
+
export interface KioskTerminalDto {
|
|
11464
|
+
/**
|
|
11465
|
+
* The payment terminal\'s id
|
|
11466
|
+
* @type {string}
|
|
11467
|
+
* @memberof KioskTerminalDto
|
|
11468
|
+
*/
|
|
11469
|
+
'id': string;
|
|
11470
|
+
/**
|
|
11471
|
+
*
|
|
11472
|
+
* @type {PaymentProvider}
|
|
11473
|
+
* @memberof KioskTerminalDto
|
|
11474
|
+
*/
|
|
11475
|
+
'provider': PaymentProvider;
|
|
11476
|
+
/**
|
|
11477
|
+
* The terminal\'s label; null when it was given none
|
|
11478
|
+
* @type {string}
|
|
11479
|
+
* @memberof KioskTerminalDto
|
|
11480
|
+
*/
|
|
11481
|
+
'label': string | null;
|
|
11482
|
+
}
|
|
11483
|
+
|
|
11484
|
+
|
|
11406
11485
|
/**
|
|
11407
11486
|
*
|
|
11408
11487
|
* @export
|
|
@@ -11537,6 +11616,19 @@ export interface LapseResponseDto {
|
|
|
11537
11616
|
*/
|
|
11538
11617
|
'businessDayScheduleId': string;
|
|
11539
11618
|
}
|
|
11619
|
+
/**
|
|
11620
|
+
*
|
|
11621
|
+
* @export
|
|
11622
|
+
* @interface LinkKioskTerminalDto
|
|
11623
|
+
*/
|
|
11624
|
+
export interface LinkKioskTerminalDto {
|
|
11625
|
+
/**
|
|
11626
|
+
* 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
|
|
11627
|
+
* @type {string}
|
|
11628
|
+
* @memberof LinkKioskTerminalDto
|
|
11629
|
+
*/
|
|
11630
|
+
'paymentTerminalId': string | null;
|
|
11631
|
+
}
|
|
11540
11632
|
/**
|
|
11541
11633
|
*
|
|
11542
11634
|
* @export
|
|
@@ -14805,7 +14897,7 @@ export interface OrderHistoryPosResponseDtoV2Pagination {
|
|
|
14805
14897
|
*/
|
|
14806
14898
|
export interface OrderHistoryPosResponseDtoV2Summary {
|
|
14807
14899
|
/**
|
|
14808
|
-
* How many orders of the period count: online, every order
|
|
14900
|
+
* 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.
|
|
14809
14901
|
* @type {number}
|
|
14810
14902
|
* @memberof OrderHistoryPosResponseDtoV2Summary
|
|
14811
14903
|
*/
|
|
@@ -14817,7 +14909,7 @@ export interface OrderHistoryPosResponseDtoV2Summary {
|
|
|
14817
14909
|
*/
|
|
14818
14910
|
'rejectedOrders': number;
|
|
14819
14911
|
/**
|
|
14820
|
-
* The period\'s sales in euros (not cents): online, the net total of the orders
|
|
14912
|
+
* 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.
|
|
14821
14913
|
* @type {number}
|
|
14822
14914
|
* @memberof OrderHistoryPosResponseDtoV2Summary
|
|
14823
14915
|
*/
|
|
@@ -14873,7 +14965,7 @@ export interface OrderHistoryResponseDto {
|
|
|
14873
14965
|
*/
|
|
14874
14966
|
export interface OrderHistoryResponseDtoSummary {
|
|
14875
14967
|
/**
|
|
14876
|
-
* How many orders of the period count: online, every order
|
|
14968
|
+
* 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.
|
|
14877
14969
|
* @type {number}
|
|
14878
14970
|
* @memberof OrderHistoryResponseDtoSummary
|
|
14879
14971
|
*/
|
|
@@ -14885,7 +14977,7 @@ export interface OrderHistoryResponseDtoSummary {
|
|
|
14885
14977
|
*/
|
|
14886
14978
|
'rejectedOrders': number;
|
|
14887
14979
|
/**
|
|
14888
|
-
* The period\'s sales in euros (not cents): online, the net total of the orders
|
|
14980
|
+
* 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.
|
|
14889
14981
|
* @type {number}
|
|
14890
14982
|
* @memberof OrderHistoryResponseDtoSummary
|
|
14891
14983
|
*/
|
|
@@ -15911,7 +16003,7 @@ export interface OrderStatusResponseDtoOrder {
|
|
|
15911
16003
|
*/
|
|
15912
16004
|
export interface OrderSummaryDto {
|
|
15913
16005
|
/**
|
|
15914
|
-
* How many orders of the period count: online, every order
|
|
16006
|
+
* 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.
|
|
15915
16007
|
* @type {number}
|
|
15916
16008
|
* @memberof OrderSummaryDto
|
|
15917
16009
|
*/
|
|
@@ -15923,7 +16015,7 @@ export interface OrderSummaryDto {
|
|
|
15923
16015
|
*/
|
|
15924
16016
|
'rejectedOrders': number;
|
|
15925
16017
|
/**
|
|
15926
|
-
* The period\'s sales in euros (not cents): online, the net total of the orders
|
|
16018
|
+
* 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.
|
|
15927
16019
|
* @type {number}
|
|
15928
16020
|
* @memberof OrderSummaryDto
|
|
15929
16021
|
*/
|
|
@@ -21802,7 +21894,7 @@ export interface PosOrderSuboptionDto {
|
|
|
21802
21894
|
*/
|
|
21803
21895
|
export interface PosOrderSummaryDto {
|
|
21804
21896
|
/**
|
|
21805
|
-
* How many orders of the period count: online, every order
|
|
21897
|
+
* 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.
|
|
21806
21898
|
* @type {number}
|
|
21807
21899
|
* @memberof PosOrderSummaryDto
|
|
21808
21900
|
*/
|
|
@@ -21814,7 +21906,7 @@ export interface PosOrderSummaryDto {
|
|
|
21814
21906
|
*/
|
|
21815
21907
|
'rejectedOrders': number;
|
|
21816
21908
|
/**
|
|
21817
|
-
* The period\'s sales in euros (not cents): online, the net total of the orders
|
|
21909
|
+
* 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.
|
|
21818
21910
|
* @type {number}
|
|
21819
21911
|
* @memberof PosOrderSummaryDto
|
|
21820
21912
|
*/
|
|
@@ -24140,6 +24232,686 @@ export const PubSubTarget = {
|
|
|
24140
24232
|
export type PubSubTarget = typeof PubSubTarget[keyof typeof PubSubTarget];
|
|
24141
24233
|
|
|
24142
24234
|
|
|
24235
|
+
/**
|
|
24236
|
+
*
|
|
24237
|
+
* @export
|
|
24238
|
+
* @interface PublicReportHoursDto
|
|
24239
|
+
*/
|
|
24240
|
+
export interface PublicReportHoursDto {
|
|
24241
|
+
/**
|
|
24242
|
+
*
|
|
24243
|
+
* @type {PublicReportHoursDtoPeriod}
|
|
24244
|
+
* @memberof PublicReportHoursDto
|
|
24245
|
+
*/
|
|
24246
|
+
'period': PublicReportHoursDtoPeriod;
|
|
24247
|
+
/**
|
|
24248
|
+
*
|
|
24249
|
+
* @type {PublicReportHoursDtoToday}
|
|
24250
|
+
* @memberof PublicReportHoursDto
|
|
24251
|
+
*/
|
|
24252
|
+
'today': PublicReportHoursDtoToday;
|
|
24253
|
+
/**
|
|
24254
|
+
*
|
|
24255
|
+
* @type {PublicReportHoursDtoNormal}
|
|
24256
|
+
* @memberof PublicReportHoursDto
|
|
24257
|
+
*/
|
|
24258
|
+
'normal': PublicReportHoursDtoNormal;
|
|
24259
|
+
}
|
|
24260
|
+
/**
|
|
24261
|
+
* A normal day: today\'s weekday over the 8 weeks before today, averaged per hour (isoWeekday)
|
|
24262
|
+
* @export
|
|
24263
|
+
* @interface PublicReportHoursDtoNormal
|
|
24264
|
+
*/
|
|
24265
|
+
export interface PublicReportHoursDtoNormal {
|
|
24266
|
+
/**
|
|
24267
|
+
* The first instant of the period, ISO 8601 in UTC
|
|
24268
|
+
* @type {string}
|
|
24269
|
+
* @memberof PublicReportHoursDtoNormal
|
|
24270
|
+
*/
|
|
24271
|
+
'reportDateStart': string;
|
|
24272
|
+
/**
|
|
24273
|
+
* The last instant of the period, ISO 8601 in UTC; now, when the period ends later
|
|
24274
|
+
* @type {string}
|
|
24275
|
+
* @memberof PublicReportHoursDtoNormal
|
|
24276
|
+
*/
|
|
24277
|
+
'reportDateEnd': string;
|
|
24278
|
+
/**
|
|
24279
|
+
* The IANA time zone the period\'s days are read in
|
|
24280
|
+
* @type {string}
|
|
24281
|
+
* @memberof PublicReportHoursDtoNormal
|
|
24282
|
+
*/
|
|
24283
|
+
'timezone': string;
|
|
24284
|
+
/**
|
|
24285
|
+
* The first business day, YYYY-MM-DD
|
|
24286
|
+
* @type {string}
|
|
24287
|
+
* @memberof PublicReportHoursDtoNormal
|
|
24288
|
+
*/
|
|
24289
|
+
'firstBusinessDay': string;
|
|
24290
|
+
/**
|
|
24291
|
+
* The last business day, YYYY-MM-DD, inclusive
|
|
24292
|
+
* @type {string}
|
|
24293
|
+
* @memberof PublicReportHoursDtoNormal
|
|
24294
|
+
*/
|
|
24295
|
+
'lastBusinessDay': string;
|
|
24296
|
+
/**
|
|
24297
|
+
* The ISO weekday counted, 1 Monday to 7 Sunday, or null for every day
|
|
24298
|
+
* @type {number}
|
|
24299
|
+
* @memberof PublicReportHoursDtoNormal
|
|
24300
|
+
*/
|
|
24301
|
+
'isoWeekday': number | null;
|
|
24302
|
+
/**
|
|
24303
|
+
* 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
|
|
24304
|
+
* @type {number}
|
|
24305
|
+
* @memberof PublicReportHoursDtoNormal
|
|
24306
|
+
*/
|
|
24307
|
+
'daysCounted': number;
|
|
24308
|
+
/**
|
|
24309
|
+
* The newest BigQuery rebuild the rows read, ISO 8601 in UTC; null when none
|
|
24310
|
+
* @type {string}
|
|
24311
|
+
* @memberof PublicReportHoursDtoNormal
|
|
24312
|
+
*/
|
|
24313
|
+
'dataUntil': string | null;
|
|
24314
|
+
/**
|
|
24315
|
+
* One group per venue, app and currency the breakdown keeps
|
|
24316
|
+
* @type {Array<SalesReportHoursGroupDto>}
|
|
24317
|
+
* @memberof PublicReportHoursDtoNormal
|
|
24318
|
+
*/
|
|
24319
|
+
'groups': Array<SalesReportHoursGroupDto>;
|
|
24320
|
+
}
|
|
24321
|
+
/**
|
|
24322
|
+
* The period\'s hours
|
|
24323
|
+
* @export
|
|
24324
|
+
* @interface PublicReportHoursDtoPeriod
|
|
24325
|
+
*/
|
|
24326
|
+
export interface PublicReportHoursDtoPeriod {
|
|
24327
|
+
/**
|
|
24328
|
+
* The first instant of the period, ISO 8601 in UTC
|
|
24329
|
+
* @type {string}
|
|
24330
|
+
* @memberof PublicReportHoursDtoPeriod
|
|
24331
|
+
*/
|
|
24332
|
+
'reportDateStart': string;
|
|
24333
|
+
/**
|
|
24334
|
+
* The last instant of the period, ISO 8601 in UTC; now, when the period ends later
|
|
24335
|
+
* @type {string}
|
|
24336
|
+
* @memberof PublicReportHoursDtoPeriod
|
|
24337
|
+
*/
|
|
24338
|
+
'reportDateEnd': string;
|
|
24339
|
+
/**
|
|
24340
|
+
* The IANA time zone the period\'s days are read in
|
|
24341
|
+
* @type {string}
|
|
24342
|
+
* @memberof PublicReportHoursDtoPeriod
|
|
24343
|
+
*/
|
|
24344
|
+
'timezone': string;
|
|
24345
|
+
/**
|
|
24346
|
+
* The first business day, YYYY-MM-DD
|
|
24347
|
+
* @type {string}
|
|
24348
|
+
* @memberof PublicReportHoursDtoPeriod
|
|
24349
|
+
*/
|
|
24350
|
+
'firstBusinessDay': string;
|
|
24351
|
+
/**
|
|
24352
|
+
* The last business day, YYYY-MM-DD, inclusive
|
|
24353
|
+
* @type {string}
|
|
24354
|
+
* @memberof PublicReportHoursDtoPeriod
|
|
24355
|
+
*/
|
|
24356
|
+
'lastBusinessDay': string;
|
|
24357
|
+
/**
|
|
24358
|
+
* The ISO weekday counted, 1 Monday to 7 Sunday, or null for every day
|
|
24359
|
+
* @type {number}
|
|
24360
|
+
* @memberof PublicReportHoursDtoPeriod
|
|
24361
|
+
*/
|
|
24362
|
+
'isoWeekday': number | null;
|
|
24363
|
+
/**
|
|
24364
|
+
* 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
|
|
24365
|
+
* @type {number}
|
|
24366
|
+
* @memberof PublicReportHoursDtoPeriod
|
|
24367
|
+
*/
|
|
24368
|
+
'daysCounted': number;
|
|
24369
|
+
/**
|
|
24370
|
+
* The newest BigQuery rebuild the rows read, ISO 8601 in UTC; null when none
|
|
24371
|
+
* @type {string}
|
|
24372
|
+
* @memberof PublicReportHoursDtoPeriod
|
|
24373
|
+
*/
|
|
24374
|
+
'dataUntil': string | null;
|
|
24375
|
+
/**
|
|
24376
|
+
* One group per venue, app and currency the breakdown keeps
|
|
24377
|
+
* @type {Array<SalesReportHoursGroupDto>}
|
|
24378
|
+
* @memberof PublicReportHoursDtoPeriod
|
|
24379
|
+
*/
|
|
24380
|
+
'groups': Array<SalesReportHoursGroupDto>;
|
|
24381
|
+
}
|
|
24382
|
+
/**
|
|
24383
|
+
* Today\'s hours on the side\'s clock, so far
|
|
24384
|
+
* @export
|
|
24385
|
+
* @interface PublicReportHoursDtoToday
|
|
24386
|
+
*/
|
|
24387
|
+
export interface PublicReportHoursDtoToday {
|
|
24388
|
+
/**
|
|
24389
|
+
* The first instant of the period, ISO 8601 in UTC
|
|
24390
|
+
* @type {string}
|
|
24391
|
+
* @memberof PublicReportHoursDtoToday
|
|
24392
|
+
*/
|
|
24393
|
+
'reportDateStart': string;
|
|
24394
|
+
/**
|
|
24395
|
+
* The last instant of the period, ISO 8601 in UTC; now, when the period ends later
|
|
24396
|
+
* @type {string}
|
|
24397
|
+
* @memberof PublicReportHoursDtoToday
|
|
24398
|
+
*/
|
|
24399
|
+
'reportDateEnd': string;
|
|
24400
|
+
/**
|
|
24401
|
+
* The IANA time zone the period\'s days are read in
|
|
24402
|
+
* @type {string}
|
|
24403
|
+
* @memberof PublicReportHoursDtoToday
|
|
24404
|
+
*/
|
|
24405
|
+
'timezone': string;
|
|
24406
|
+
/**
|
|
24407
|
+
* The first business day, YYYY-MM-DD
|
|
24408
|
+
* @type {string}
|
|
24409
|
+
* @memberof PublicReportHoursDtoToday
|
|
24410
|
+
*/
|
|
24411
|
+
'firstBusinessDay': string;
|
|
24412
|
+
/**
|
|
24413
|
+
* The last business day, YYYY-MM-DD, inclusive
|
|
24414
|
+
* @type {string}
|
|
24415
|
+
* @memberof PublicReportHoursDtoToday
|
|
24416
|
+
*/
|
|
24417
|
+
'lastBusinessDay': string;
|
|
24418
|
+
/**
|
|
24419
|
+
* The ISO weekday counted, 1 Monday to 7 Sunday, or null for every day
|
|
24420
|
+
* @type {number}
|
|
24421
|
+
* @memberof PublicReportHoursDtoToday
|
|
24422
|
+
*/
|
|
24423
|
+
'isoWeekday': number | null;
|
|
24424
|
+
/**
|
|
24425
|
+
* 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
|
|
24426
|
+
* @type {number}
|
|
24427
|
+
* @memberof PublicReportHoursDtoToday
|
|
24428
|
+
*/
|
|
24429
|
+
'daysCounted': number;
|
|
24430
|
+
/**
|
|
24431
|
+
* The newest BigQuery rebuild the rows read, ISO 8601 in UTC; null when none
|
|
24432
|
+
* @type {string}
|
|
24433
|
+
* @memberof PublicReportHoursDtoToday
|
|
24434
|
+
*/
|
|
24435
|
+
'dataUntil': string | null;
|
|
24436
|
+
/**
|
|
24437
|
+
* One group per venue, app and currency the breakdown keeps
|
|
24438
|
+
* @type {Array<SalesReportHoursGroupDto>}
|
|
24439
|
+
* @memberof PublicReportHoursDtoToday
|
|
24440
|
+
*/
|
|
24441
|
+
'groups': Array<SalesReportHoursGroupDto>;
|
|
24442
|
+
}
|
|
24443
|
+
/**
|
|
24444
|
+
*
|
|
24445
|
+
* @export
|
|
24446
|
+
* @interface PublicReportNumbersDto
|
|
24447
|
+
*/
|
|
24448
|
+
export interface PublicReportNumbersDto {
|
|
24449
|
+
/**
|
|
24450
|
+
*
|
|
24451
|
+
* @type {PublicReportNumbersDtoA}
|
|
24452
|
+
* @memberof PublicReportNumbersDto
|
|
24453
|
+
*/
|
|
24454
|
+
'a': PublicReportNumbersDtoA | null;
|
|
24455
|
+
/**
|
|
24456
|
+
*
|
|
24457
|
+
* @type {PublicReportNumbersDtoB}
|
|
24458
|
+
* @memberof PublicReportNumbersDto
|
|
24459
|
+
*/
|
|
24460
|
+
'b'?: PublicReportNumbersDtoB | null;
|
|
24461
|
+
}
|
|
24462
|
+
/**
|
|
24463
|
+
* Side A\'s numbers; null when its stores are none of the report\'s own or it could not be read
|
|
24464
|
+
* @export
|
|
24465
|
+
* @interface PublicReportNumbersDtoA
|
|
24466
|
+
*/
|
|
24467
|
+
export interface PublicReportNumbersDtoA {
|
|
24468
|
+
/**
|
|
24469
|
+
* 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
|
|
24470
|
+
* @type {Array<number>}
|
|
24471
|
+
* @memberof PublicReportNumbersDtoA
|
|
24472
|
+
*/
|
|
24473
|
+
'stores': Array<number>;
|
|
24474
|
+
/**
|
|
24475
|
+
*
|
|
24476
|
+
* @type {PublicReportSideNumbersDtoSales}
|
|
24477
|
+
* @memberof PublicReportNumbersDtoA
|
|
24478
|
+
*/
|
|
24479
|
+
'sales': PublicReportSideNumbersDtoSales;
|
|
24480
|
+
/**
|
|
24481
|
+
*
|
|
24482
|
+
* @type {PublicReportSideNumbersDtoTrend}
|
|
24483
|
+
* @memberof PublicReportNumbersDtoA
|
|
24484
|
+
*/
|
|
24485
|
+
'trend'?: PublicReportSideNumbersDtoTrend;
|
|
24486
|
+
/**
|
|
24487
|
+
*
|
|
24488
|
+
* @type {PublicReportSideNumbersDtoYear}
|
|
24489
|
+
* @memberof PublicReportNumbersDtoA
|
|
24490
|
+
*/
|
|
24491
|
+
'year'?: PublicReportSideNumbersDtoYear;
|
|
24492
|
+
/**
|
|
24493
|
+
*
|
|
24494
|
+
* @type {PublicReportSideNumbersDtoHours}
|
|
24495
|
+
* @memberof PublicReportNumbersDtoA
|
|
24496
|
+
*/
|
|
24497
|
+
'hours'?: PublicReportSideNumbersDtoHours;
|
|
24498
|
+
/**
|
|
24499
|
+
*
|
|
24500
|
+
* @type {PublicReportSideNumbersDtoBoughtTogether}
|
|
24501
|
+
* @memberof PublicReportNumbersDtoA
|
|
24502
|
+
*/
|
|
24503
|
+
'boughtTogether'?: PublicReportSideNumbersDtoBoughtTogether;
|
|
24504
|
+
/**
|
|
24505
|
+
*
|
|
24506
|
+
* @type {PublicReportSideNumbersDtoOrderTypes}
|
|
24507
|
+
* @memberof PublicReportNumbersDtoA
|
|
24508
|
+
*/
|
|
24509
|
+
'orderTypes'?: PublicReportSideNumbersDtoOrderTypes;
|
|
24510
|
+
}
|
|
24511
|
+
/**
|
|
24512
|
+
* A comparison\'s side B; absent for a report
|
|
24513
|
+
* @export
|
|
24514
|
+
* @interface PublicReportNumbersDtoB
|
|
24515
|
+
*/
|
|
24516
|
+
export interface PublicReportNumbersDtoB {
|
|
24517
|
+
/**
|
|
24518
|
+
* 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
|
|
24519
|
+
* @type {Array<number>}
|
|
24520
|
+
* @memberof PublicReportNumbersDtoB
|
|
24521
|
+
*/
|
|
24522
|
+
'stores': Array<number>;
|
|
24523
|
+
/**
|
|
24524
|
+
*
|
|
24525
|
+
* @type {PublicReportSideNumbersDtoSales}
|
|
24526
|
+
* @memberof PublicReportNumbersDtoB
|
|
24527
|
+
*/
|
|
24528
|
+
'sales': PublicReportSideNumbersDtoSales;
|
|
24529
|
+
/**
|
|
24530
|
+
*
|
|
24531
|
+
* @type {PublicReportSideNumbersDtoTrend}
|
|
24532
|
+
* @memberof PublicReportNumbersDtoB
|
|
24533
|
+
*/
|
|
24534
|
+
'trend'?: PublicReportSideNumbersDtoTrend;
|
|
24535
|
+
/**
|
|
24536
|
+
*
|
|
24537
|
+
* @type {PublicReportSideNumbersDtoYear}
|
|
24538
|
+
* @memberof PublicReportNumbersDtoB
|
|
24539
|
+
*/
|
|
24540
|
+
'year'?: PublicReportSideNumbersDtoYear;
|
|
24541
|
+
/**
|
|
24542
|
+
*
|
|
24543
|
+
* @type {PublicReportSideNumbersDtoHours}
|
|
24544
|
+
* @memberof PublicReportNumbersDtoB
|
|
24545
|
+
*/
|
|
24546
|
+
'hours'?: PublicReportSideNumbersDtoHours;
|
|
24547
|
+
/**
|
|
24548
|
+
*
|
|
24549
|
+
* @type {PublicReportSideNumbersDtoBoughtTogether}
|
|
24550
|
+
* @memberof PublicReportNumbersDtoB
|
|
24551
|
+
*/
|
|
24552
|
+
'boughtTogether'?: PublicReportSideNumbersDtoBoughtTogether;
|
|
24553
|
+
/**
|
|
24554
|
+
*
|
|
24555
|
+
* @type {PublicReportSideNumbersDtoOrderTypes}
|
|
24556
|
+
* @memberof PublicReportNumbersDtoB
|
|
24557
|
+
*/
|
|
24558
|
+
'orderTypes'?: PublicReportSideNumbersDtoOrderTypes;
|
|
24559
|
+
}
|
|
24560
|
+
/**
|
|
24561
|
+
*
|
|
24562
|
+
* @export
|
|
24563
|
+
* @interface PublicReportSideNumbersDto
|
|
24564
|
+
*/
|
|
24565
|
+
export interface PublicReportSideNumbersDto {
|
|
24566
|
+
/**
|
|
24567
|
+
* 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
|
|
24568
|
+
* @type {Array<number>}
|
|
24569
|
+
* @memberof PublicReportSideNumbersDto
|
|
24570
|
+
*/
|
|
24571
|
+
'stores': Array<number>;
|
|
24572
|
+
/**
|
|
24573
|
+
*
|
|
24574
|
+
* @type {PublicReportSideNumbersDtoSales}
|
|
24575
|
+
* @memberof PublicReportSideNumbersDto
|
|
24576
|
+
*/
|
|
24577
|
+
'sales': PublicReportSideNumbersDtoSales;
|
|
24578
|
+
/**
|
|
24579
|
+
*
|
|
24580
|
+
* @type {PublicReportSideNumbersDtoTrend}
|
|
24581
|
+
* @memberof PublicReportSideNumbersDto
|
|
24582
|
+
*/
|
|
24583
|
+
'trend'?: PublicReportSideNumbersDtoTrend;
|
|
24584
|
+
/**
|
|
24585
|
+
*
|
|
24586
|
+
* @type {PublicReportSideNumbersDtoYear}
|
|
24587
|
+
* @memberof PublicReportSideNumbersDto
|
|
24588
|
+
*/
|
|
24589
|
+
'year'?: PublicReportSideNumbersDtoYear;
|
|
24590
|
+
/**
|
|
24591
|
+
*
|
|
24592
|
+
* @type {PublicReportSideNumbersDtoHours}
|
|
24593
|
+
* @memberof PublicReportSideNumbersDto
|
|
24594
|
+
*/
|
|
24595
|
+
'hours'?: PublicReportSideNumbersDtoHours;
|
|
24596
|
+
/**
|
|
24597
|
+
*
|
|
24598
|
+
* @type {PublicReportSideNumbersDtoBoughtTogether}
|
|
24599
|
+
* @memberof PublicReportSideNumbersDto
|
|
24600
|
+
*/
|
|
24601
|
+
'boughtTogether'?: PublicReportSideNumbersDtoBoughtTogether;
|
|
24602
|
+
/**
|
|
24603
|
+
*
|
|
24604
|
+
* @type {PublicReportSideNumbersDtoOrderTypes}
|
|
24605
|
+
* @memberof PublicReportSideNumbersDto
|
|
24606
|
+
*/
|
|
24607
|
+
'orderTypes'?: PublicReportSideNumbersDtoOrderTypes;
|
|
24608
|
+
}
|
|
24609
|
+
/**
|
|
24610
|
+
* Items bought together, as GET /api/v6/report/sales/bought-together; only when a card shows them
|
|
24611
|
+
* @export
|
|
24612
|
+
* @interface PublicReportSideNumbersDtoBoughtTogether
|
|
24613
|
+
*/
|
|
24614
|
+
export interface PublicReportSideNumbersDtoBoughtTogether {
|
|
24615
|
+
/**
|
|
24616
|
+
* The first instant of the period, ISO 8601 in UTC
|
|
24617
|
+
* @type {string}
|
|
24618
|
+
* @memberof PublicReportSideNumbersDtoBoughtTogether
|
|
24619
|
+
*/
|
|
24620
|
+
'reportDateStart': string;
|
|
24621
|
+
/**
|
|
24622
|
+
* The last instant of the period, ISO 8601 in UTC; now, when the period ends later
|
|
24623
|
+
* @type {string}
|
|
24624
|
+
* @memberof PublicReportSideNumbersDtoBoughtTogether
|
|
24625
|
+
*/
|
|
24626
|
+
'reportDateEnd': string;
|
|
24627
|
+
/**
|
|
24628
|
+
* The IANA time zone the period\'s days are read in
|
|
24629
|
+
* @type {string}
|
|
24630
|
+
* @memberof PublicReportSideNumbersDtoBoughtTogether
|
|
24631
|
+
*/
|
|
24632
|
+
'timezone': string;
|
|
24633
|
+
/**
|
|
24634
|
+
* The first business day, YYYY-MM-DD
|
|
24635
|
+
* @type {string}
|
|
24636
|
+
* @memberof PublicReportSideNumbersDtoBoughtTogether
|
|
24637
|
+
*/
|
|
24638
|
+
'firstBusinessDay': string;
|
|
24639
|
+
/**
|
|
24640
|
+
* The last business day, YYYY-MM-DD, inclusive
|
|
24641
|
+
* @type {string}
|
|
24642
|
+
* @memberof PublicReportSideNumbersDtoBoughtTogether
|
|
24643
|
+
*/
|
|
24644
|
+
'lastBusinessDay': string;
|
|
24645
|
+
/**
|
|
24646
|
+
* The newest BigQuery rebuild the rows read, ISO 8601 in UTC; null when none
|
|
24647
|
+
* @type {string}
|
|
24648
|
+
* @memberof PublicReportSideNumbersDtoBoughtTogether
|
|
24649
|
+
*/
|
|
24650
|
+
'dataUntil': string | null;
|
|
24651
|
+
/**
|
|
24652
|
+
* One group per venue, app and currency the breakdown keeps
|
|
24653
|
+
* @type {Array<SalesReportBoughtTogetherGroupDto>}
|
|
24654
|
+
* @memberof PublicReportSideNumbersDtoBoughtTogether
|
|
24655
|
+
*/
|
|
24656
|
+
'groups': Array<SalesReportBoughtTogetherGroupDto>;
|
|
24657
|
+
}
|
|
24658
|
+
/**
|
|
24659
|
+
* Sales per hour of the day, as GET /api/v6/report/sales/hours; only when a card shows hours
|
|
24660
|
+
* @export
|
|
24661
|
+
* @interface PublicReportSideNumbersDtoHours
|
|
24662
|
+
*/
|
|
24663
|
+
export interface PublicReportSideNumbersDtoHours {
|
|
24664
|
+
/**
|
|
24665
|
+
*
|
|
24666
|
+
* @type {PublicReportHoursDtoPeriod}
|
|
24667
|
+
* @memberof PublicReportSideNumbersDtoHours
|
|
24668
|
+
*/
|
|
24669
|
+
'period': PublicReportHoursDtoPeriod;
|
|
24670
|
+
/**
|
|
24671
|
+
*
|
|
24672
|
+
* @type {PublicReportHoursDtoToday}
|
|
24673
|
+
* @memberof PublicReportSideNumbersDtoHours
|
|
24674
|
+
*/
|
|
24675
|
+
'today': PublicReportHoursDtoToday;
|
|
24676
|
+
/**
|
|
24677
|
+
*
|
|
24678
|
+
* @type {PublicReportHoursDtoNormal}
|
|
24679
|
+
* @memberof PublicReportSideNumbersDtoHours
|
|
24680
|
+
*/
|
|
24681
|
+
'normal': PublicReportHoursDtoNormal;
|
|
24682
|
+
}
|
|
24683
|
+
/**
|
|
24684
|
+
* Sales per order type, as GET /api/v6/report/sales/order-types; only when a card shows them
|
|
24685
|
+
* @export
|
|
24686
|
+
* @interface PublicReportSideNumbersDtoOrderTypes
|
|
24687
|
+
*/
|
|
24688
|
+
export interface PublicReportSideNumbersDtoOrderTypes {
|
|
24689
|
+
/**
|
|
24690
|
+
* The first instant of the period, ISO 8601 in UTC
|
|
24691
|
+
* @type {string}
|
|
24692
|
+
* @memberof PublicReportSideNumbersDtoOrderTypes
|
|
24693
|
+
*/
|
|
24694
|
+
'reportDateStart': string;
|
|
24695
|
+
/**
|
|
24696
|
+
* The last instant of the period, ISO 8601 in UTC; now, when the period ends later
|
|
24697
|
+
* @type {string}
|
|
24698
|
+
* @memberof PublicReportSideNumbersDtoOrderTypes
|
|
24699
|
+
*/
|
|
24700
|
+
'reportDateEnd': string;
|
|
24701
|
+
/**
|
|
24702
|
+
* The IANA time zone the period\'s days are read in
|
|
24703
|
+
* @type {string}
|
|
24704
|
+
* @memberof PublicReportSideNumbersDtoOrderTypes
|
|
24705
|
+
*/
|
|
24706
|
+
'timezone': string;
|
|
24707
|
+
/**
|
|
24708
|
+
* The first business day, YYYY-MM-DD
|
|
24709
|
+
* @type {string}
|
|
24710
|
+
* @memberof PublicReportSideNumbersDtoOrderTypes
|
|
24711
|
+
*/
|
|
24712
|
+
'firstBusinessDay': string;
|
|
24713
|
+
/**
|
|
24714
|
+
* The last business day, YYYY-MM-DD, inclusive
|
|
24715
|
+
* @type {string}
|
|
24716
|
+
* @memberof PublicReportSideNumbersDtoOrderTypes
|
|
24717
|
+
*/
|
|
24718
|
+
'lastBusinessDay': string;
|
|
24719
|
+
/**
|
|
24720
|
+
* The newest BigQuery rebuild the rows read, ISO 8601 in UTC; null when none
|
|
24721
|
+
* @type {string}
|
|
24722
|
+
* @memberof PublicReportSideNumbersDtoOrderTypes
|
|
24723
|
+
*/
|
|
24724
|
+
'dataUntil': string | null;
|
|
24725
|
+
/**
|
|
24726
|
+
* One group per venue, app and currency the breakdown keeps
|
|
24727
|
+
* @type {Array<SalesReportOrderTypesGroupDto>}
|
|
24728
|
+
* @memberof PublicReportSideNumbersDtoOrderTypes
|
|
24729
|
+
*/
|
|
24730
|
+
'groups': Array<SalesReportOrderTypesGroupDto>;
|
|
24731
|
+
}
|
|
24732
|
+
/**
|
|
24733
|
+
* 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
|
|
24734
|
+
* @export
|
|
24735
|
+
* @interface PublicReportSideNumbersDtoSales
|
|
24736
|
+
*/
|
|
24737
|
+
export interface PublicReportSideNumbersDtoSales {
|
|
24738
|
+
/**
|
|
24739
|
+
* The first instant of the period, ISO 8601 in UTC
|
|
24740
|
+
* @type {string}
|
|
24741
|
+
* @memberof PublicReportSideNumbersDtoSales
|
|
24742
|
+
*/
|
|
24743
|
+
'reportDateStart': string;
|
|
24744
|
+
/**
|
|
24745
|
+
* The last instant of the period, ISO 8601 in UTC; now, when the period ends later
|
|
24746
|
+
* @type {string}
|
|
24747
|
+
* @memberof PublicReportSideNumbersDtoSales
|
|
24748
|
+
*/
|
|
24749
|
+
'reportDateEnd': string;
|
|
24750
|
+
/**
|
|
24751
|
+
* When the report was answered, ISO 8601 in UTC
|
|
24752
|
+
* @type {string}
|
|
24753
|
+
* @memberof PublicReportSideNumbersDtoSales
|
|
24754
|
+
*/
|
|
24755
|
+
'reportGeneratedAt': string;
|
|
24756
|
+
/**
|
|
24757
|
+
* The time zone the period was read in: the request\'s, or else the first venue\'s
|
|
24758
|
+
* @type {string}
|
|
24759
|
+
* @memberof PublicReportSideNumbersDtoSales
|
|
24760
|
+
*/
|
|
24761
|
+
'timezone': string;
|
|
24762
|
+
/**
|
|
24763
|
+
* The first business day added up, YYYY-MM-DD; each venue\'s rows of that date in its own zone
|
|
24764
|
+
* @type {string}
|
|
24765
|
+
* @memberof PublicReportSideNumbersDtoSales
|
|
24766
|
+
*/
|
|
24767
|
+
'firstBusinessDay': string;
|
|
24768
|
+
/**
|
|
24769
|
+
* The last business day added up, YYYY-MM-DD, inclusive
|
|
24770
|
+
* @type {string}
|
|
24771
|
+
* @memberof PublicReportSideNumbersDtoSales
|
|
24772
|
+
*/
|
|
24773
|
+
'lastBusinessDay': string;
|
|
24774
|
+
/**
|
|
24775
|
+
* 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
|
|
24776
|
+
* @type {object}
|
|
24777
|
+
* @memberof PublicReportSideNumbersDtoSales
|
|
24778
|
+
*/
|
|
24779
|
+
'dataUntil': object | null;
|
|
24780
|
+
/**
|
|
24781
|
+
* One group per venue, app and currency the breakdown keeps; an asked venue that sold nothing answers zeros
|
|
24782
|
+
* @type {Array<SalesReportGroupDto>}
|
|
24783
|
+
* @memberof PublicReportSideNumbersDtoSales
|
|
24784
|
+
*/
|
|
24785
|
+
'reports': Array<SalesReportGroupDto>;
|
|
24786
|
+
/**
|
|
24787
|
+
* 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
|
|
24788
|
+
* @type {Array<SalesReportGroupDto>}
|
|
24789
|
+
* @memberof PublicReportSideNumbersDtoSales
|
|
24790
|
+
*/
|
|
24791
|
+
'totals'?: Array<SalesReportGroupDto>;
|
|
24792
|
+
}
|
|
24793
|
+
/**
|
|
24794
|
+
* 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
|
|
24795
|
+
* @export
|
|
24796
|
+
* @interface PublicReportSideNumbersDtoTrend
|
|
24797
|
+
*/
|
|
24798
|
+
export interface PublicReportSideNumbersDtoTrend {
|
|
24799
|
+
/**
|
|
24800
|
+
* The first instant of the period, ISO 8601 in UTC
|
|
24801
|
+
* @type {string}
|
|
24802
|
+
* @memberof PublicReportSideNumbersDtoTrend
|
|
24803
|
+
*/
|
|
24804
|
+
'reportDateStart': string;
|
|
24805
|
+
/**
|
|
24806
|
+
* The last instant of the period, ISO 8601 in UTC; now, when the period ends later
|
|
24807
|
+
* @type {string}
|
|
24808
|
+
* @memberof PublicReportSideNumbersDtoTrend
|
|
24809
|
+
*/
|
|
24810
|
+
'reportDateEnd': string;
|
|
24811
|
+
/**
|
|
24812
|
+
* When the report was answered, ISO 8601 in UTC
|
|
24813
|
+
* @type {string}
|
|
24814
|
+
* @memberof PublicReportSideNumbersDtoTrend
|
|
24815
|
+
*/
|
|
24816
|
+
'reportGeneratedAt': string;
|
|
24817
|
+
/**
|
|
24818
|
+
* The time zone the period was read in: the request\'s, or else the first venue\'s
|
|
24819
|
+
* @type {string}
|
|
24820
|
+
* @memberof PublicReportSideNumbersDtoTrend
|
|
24821
|
+
*/
|
|
24822
|
+
'timezone': string;
|
|
24823
|
+
/**
|
|
24824
|
+
* The first business day added up, YYYY-MM-DD; each venue\'s rows of that date in its own zone
|
|
24825
|
+
* @type {string}
|
|
24826
|
+
* @memberof PublicReportSideNumbersDtoTrend
|
|
24827
|
+
*/
|
|
24828
|
+
'firstBusinessDay': string;
|
|
24829
|
+
/**
|
|
24830
|
+
* The last business day added up, YYYY-MM-DD, inclusive
|
|
24831
|
+
* @type {string}
|
|
24832
|
+
* @memberof PublicReportSideNumbersDtoTrend
|
|
24833
|
+
*/
|
|
24834
|
+
'lastBusinessDay': string;
|
|
24835
|
+
/**
|
|
24836
|
+
* 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
|
|
24837
|
+
* @type {object}
|
|
24838
|
+
* @memberof PublicReportSideNumbersDtoTrend
|
|
24839
|
+
*/
|
|
24840
|
+
'dataUntil': object | null;
|
|
24841
|
+
/**
|
|
24842
|
+
* One group per venue, app and currency the breakdown keeps; an asked venue that sold nothing answers zeros
|
|
24843
|
+
* @type {Array<SalesReportGroupDto>}
|
|
24844
|
+
* @memberof PublicReportSideNumbersDtoTrend
|
|
24845
|
+
*/
|
|
24846
|
+
'reports': Array<SalesReportGroupDto>;
|
|
24847
|
+
/**
|
|
24848
|
+
* 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
|
|
24849
|
+
* @type {Array<SalesReportGroupDto>}
|
|
24850
|
+
* @memberof PublicReportSideNumbersDtoTrend
|
|
24851
|
+
*/
|
|
24852
|
+
'totals'?: Array<SalesReportGroupDto>;
|
|
24853
|
+
}
|
|
24854
|
+
/**
|
|
24855
|
+
* The summary of the 26 weeks up to today, day by day; only when the report shows the year card
|
|
24856
|
+
* @export
|
|
24857
|
+
* @interface PublicReportSideNumbersDtoYear
|
|
24858
|
+
*/
|
|
24859
|
+
export interface PublicReportSideNumbersDtoYear {
|
|
24860
|
+
/**
|
|
24861
|
+
* The first instant of the period, ISO 8601 in UTC
|
|
24862
|
+
* @type {string}
|
|
24863
|
+
* @memberof PublicReportSideNumbersDtoYear
|
|
24864
|
+
*/
|
|
24865
|
+
'reportDateStart': string;
|
|
24866
|
+
/**
|
|
24867
|
+
* The last instant of the period, ISO 8601 in UTC; now, when the period ends later
|
|
24868
|
+
* @type {string}
|
|
24869
|
+
* @memberof PublicReportSideNumbersDtoYear
|
|
24870
|
+
*/
|
|
24871
|
+
'reportDateEnd': string;
|
|
24872
|
+
/**
|
|
24873
|
+
* When the report was answered, ISO 8601 in UTC
|
|
24874
|
+
* @type {string}
|
|
24875
|
+
* @memberof PublicReportSideNumbersDtoYear
|
|
24876
|
+
*/
|
|
24877
|
+
'reportGeneratedAt': string;
|
|
24878
|
+
/**
|
|
24879
|
+
* The time zone the period was read in: the request\'s, or else the first venue\'s
|
|
24880
|
+
* @type {string}
|
|
24881
|
+
* @memberof PublicReportSideNumbersDtoYear
|
|
24882
|
+
*/
|
|
24883
|
+
'timezone': string;
|
|
24884
|
+
/**
|
|
24885
|
+
* The first business day added up, YYYY-MM-DD; each venue\'s rows of that date in its own zone
|
|
24886
|
+
* @type {string}
|
|
24887
|
+
* @memberof PublicReportSideNumbersDtoYear
|
|
24888
|
+
*/
|
|
24889
|
+
'firstBusinessDay': string;
|
|
24890
|
+
/**
|
|
24891
|
+
* The last business day added up, YYYY-MM-DD, inclusive
|
|
24892
|
+
* @type {string}
|
|
24893
|
+
* @memberof PublicReportSideNumbersDtoYear
|
|
24894
|
+
*/
|
|
24895
|
+
'lastBusinessDay': string;
|
|
24896
|
+
/**
|
|
24897
|
+
* 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
|
|
24898
|
+
* @type {object}
|
|
24899
|
+
* @memberof PublicReportSideNumbersDtoYear
|
|
24900
|
+
*/
|
|
24901
|
+
'dataUntil': object | null;
|
|
24902
|
+
/**
|
|
24903
|
+
* One group per venue, app and currency the breakdown keeps; an asked venue that sold nothing answers zeros
|
|
24904
|
+
* @type {Array<SalesReportGroupDto>}
|
|
24905
|
+
* @memberof PublicReportSideNumbersDtoYear
|
|
24906
|
+
*/
|
|
24907
|
+
'reports': Array<SalesReportGroupDto>;
|
|
24908
|
+
/**
|
|
24909
|
+
* 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
|
|
24910
|
+
* @type {Array<SalesReportGroupDto>}
|
|
24911
|
+
* @memberof PublicReportSideNumbersDtoYear
|
|
24912
|
+
*/
|
|
24913
|
+
'totals'?: Array<SalesReportGroupDto>;
|
|
24914
|
+
}
|
|
24143
24915
|
/**
|
|
24144
24916
|
*
|
|
24145
24917
|
* @export
|
|
@@ -24188,9 +24960,34 @@ export interface PublicSavedReportDto {
|
|
|
24188
24960
|
* @memberof PublicSavedReportDto
|
|
24189
24961
|
*/
|
|
24190
24962
|
'updatedAt': string;
|
|
24963
|
+
/**
|
|
24964
|
+
*
|
|
24965
|
+
* @type {PublicSavedReportDtoNumbers}
|
|
24966
|
+
* @memberof PublicSavedReportDto
|
|
24967
|
+
*/
|
|
24968
|
+
'numbers': PublicSavedReportDtoNumbers | null;
|
|
24191
24969
|
}
|
|
24192
24970
|
|
|
24193
24971
|
|
|
24972
|
+
/**
|
|
24973
|
+
* 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)
|
|
24974
|
+
* @export
|
|
24975
|
+
* @interface PublicSavedReportDtoNumbers
|
|
24976
|
+
*/
|
|
24977
|
+
export interface PublicSavedReportDtoNumbers {
|
|
24978
|
+
/**
|
|
24979
|
+
*
|
|
24980
|
+
* @type {PublicReportNumbersDtoA}
|
|
24981
|
+
* @memberof PublicSavedReportDtoNumbers
|
|
24982
|
+
*/
|
|
24983
|
+
'a': PublicReportNumbersDtoA | null;
|
|
24984
|
+
/**
|
|
24985
|
+
*
|
|
24986
|
+
* @type {PublicReportNumbersDtoB}
|
|
24987
|
+
* @memberof PublicSavedReportDtoNumbers
|
|
24988
|
+
*/
|
|
24989
|
+
'b'?: PublicReportNumbersDtoB | null;
|
|
24990
|
+
}
|
|
24194
24991
|
/**
|
|
24195
24992
|
*
|
|
24196
24993
|
* @export
|
|
@@ -24254,7 +25051,13 @@ export interface RankedCategoryDto {
|
|
|
24254
25051
|
*/
|
|
24255
25052
|
|
|
24256
25053
|
export const ReadyMadeReport = {
|
|
24257
|
-
Sales: 'sales'
|
|
25054
|
+
Sales: 'sales',
|
|
25055
|
+
ZReport: 'zReport',
|
|
25056
|
+
SalesVat: 'salesVat',
|
|
25057
|
+
Payments: 'payments',
|
|
25058
|
+
ProductSales: 'productSales',
|
|
25059
|
+
CashSessions: 'cashSessions',
|
|
25060
|
+
Staff: 'staff'
|
|
24258
25061
|
} as const;
|
|
24259
25062
|
|
|
24260
25063
|
export type ReadyMadeReport = typeof ReadyMadeReport[keyof typeof ReadyMadeReport];
|
|
@@ -28696,6 +29499,12 @@ export interface SalesReportStaffMemberDto {
|
|
|
28696
29499
|
* @memberof SalesReportStaffMemberDto
|
|
28697
29500
|
*/
|
|
28698
29501
|
'staffId': string;
|
|
29502
|
+
/**
|
|
29503
|
+
* The staff member\'s name; null for the orders that name nobody, or a person who left the venue
|
|
29504
|
+
* @type {string}
|
|
29505
|
+
* @memberof SalesReportStaffMemberDto
|
|
29506
|
+
*/
|
|
29507
|
+
'staffName': string | null;
|
|
28699
29508
|
/**
|
|
28700
29509
|
* Orders not refunded, or refunded in part (the POS app\'s totalOrders)
|
|
28701
29510
|
* @type {number}
|
|
@@ -35054,6 +35863,18 @@ export interface UpsertConfigDto {
|
|
|
35054
35863
|
* @memberof UpsertConfigDto
|
|
35055
35864
|
*/
|
|
35056
35865
|
'productDetailLayout'?: ProductDetailLayout;
|
|
35866
|
+
/**
|
|
35867
|
+
*
|
|
35868
|
+
* @type {KioskLayout}
|
|
35869
|
+
* @memberof UpsertConfigDto
|
|
35870
|
+
*/
|
|
35871
|
+
'layout'?: KioskLayout;
|
|
35872
|
+
/**
|
|
35873
|
+
*
|
|
35874
|
+
* @type {UpsellMode}
|
|
35875
|
+
* @memberof UpsertConfigDto
|
|
35876
|
+
*/
|
|
35877
|
+
'upsellMode'?: UpsellMode;
|
|
35057
35878
|
/**
|
|
35058
35879
|
* Whether the kiosk prints the receipt without asking. Absent keeps the stored value.
|
|
35059
35880
|
* @type {boolean}
|
|
@@ -35984,6 +36805,103 @@ export interface VenueFoundDto {
|
|
|
35984
36805
|
*/
|
|
35985
36806
|
'chainId': string | null;
|
|
35986
36807
|
}
|
|
36808
|
+
/**
|
|
36809
|
+
*
|
|
36810
|
+
* @export
|
|
36811
|
+
* @interface VenueKioskDto
|
|
36812
|
+
*/
|
|
36813
|
+
export interface VenueKioskDto {
|
|
36814
|
+
/**
|
|
36815
|
+
* The kiosk\'s station id
|
|
36816
|
+
* @type {string}
|
|
36817
|
+
* @memberof VenueKioskDto
|
|
36818
|
+
*/
|
|
36819
|
+
'id': string;
|
|
36820
|
+
/**
|
|
36821
|
+
* The kiosk\'s name
|
|
36822
|
+
* @type {string}
|
|
36823
|
+
* @memberof VenueKioskDto
|
|
36824
|
+
*/
|
|
36825
|
+
'name': string;
|
|
36826
|
+
/**
|
|
36827
|
+
* What the kiosk\'s order numbers start with; empty for none
|
|
36828
|
+
* @type {string}
|
|
36829
|
+
* @memberof VenueKioskDto
|
|
36830
|
+
*/
|
|
36831
|
+
'prefix': string;
|
|
36832
|
+
/**
|
|
36833
|
+
* The device\'s Hardware ID, as it shows it
|
|
36834
|
+
* @type {string}
|
|
36835
|
+
* @memberof VenueKioskDto
|
|
36836
|
+
*/
|
|
36837
|
+
'hardwareId': string;
|
|
36838
|
+
/**
|
|
36839
|
+
*
|
|
36840
|
+
* @type {Status}
|
|
36841
|
+
* @memberof VenueKioskDto
|
|
36842
|
+
*/
|
|
36843
|
+
'status': Status;
|
|
36844
|
+
/**
|
|
36845
|
+
*
|
|
36846
|
+
* @type {VenueKioskDtoTerminal}
|
|
36847
|
+
* @memberof VenueKioskDto
|
|
36848
|
+
*/
|
|
36849
|
+
'terminal': VenueKioskDtoTerminal | null;
|
|
36850
|
+
/**
|
|
36851
|
+
* When the kiosk was first linked to the venue, ISO 8601
|
|
36852
|
+
* @type {string}
|
|
36853
|
+
* @memberof VenueKioskDto
|
|
36854
|
+
*/
|
|
36855
|
+
'createdAt': string;
|
|
36856
|
+
/**
|
|
36857
|
+
* When the kiosk last changed, ISO 8601
|
|
36858
|
+
* @type {string}
|
|
36859
|
+
* @memberof VenueKioskDto
|
|
36860
|
+
*/
|
|
36861
|
+
'updatedAt': string;
|
|
36862
|
+
}
|
|
36863
|
+
|
|
36864
|
+
|
|
36865
|
+
/**
|
|
36866
|
+
* The payment terminal linked to the kiosk; null when it has none
|
|
36867
|
+
* @export
|
|
36868
|
+
* @interface VenueKioskDtoTerminal
|
|
36869
|
+
*/
|
|
36870
|
+
export interface VenueKioskDtoTerminal {
|
|
36871
|
+
/**
|
|
36872
|
+
* The payment terminal\'s id
|
|
36873
|
+
* @type {string}
|
|
36874
|
+
* @memberof VenueKioskDtoTerminal
|
|
36875
|
+
*/
|
|
36876
|
+
'id': string;
|
|
36877
|
+
/**
|
|
36878
|
+
*
|
|
36879
|
+
* @type {PaymentProvider}
|
|
36880
|
+
* @memberof VenueKioskDtoTerminal
|
|
36881
|
+
*/
|
|
36882
|
+
'provider': PaymentProvider;
|
|
36883
|
+
/**
|
|
36884
|
+
* The terminal\'s label; null when it was given none
|
|
36885
|
+
* @type {string}
|
|
36886
|
+
* @memberof VenueKioskDtoTerminal
|
|
36887
|
+
*/
|
|
36888
|
+
'label': string | null;
|
|
36889
|
+
}
|
|
36890
|
+
|
|
36891
|
+
|
|
36892
|
+
/**
|
|
36893
|
+
*
|
|
36894
|
+
* @export
|
|
36895
|
+
* @interface VenueKiosksDto
|
|
36896
|
+
*/
|
|
36897
|
+
export interface VenueKiosksDto {
|
|
36898
|
+
/**
|
|
36899
|
+
* The venue\'s kiosks, active and inactive, oldest first
|
|
36900
|
+
* @type {Array<VenueKioskDto>}
|
|
36901
|
+
* @memberof VenueKiosksDto
|
|
36902
|
+
*/
|
|
36903
|
+
'kiosks': Array<VenueKioskDto>;
|
|
36904
|
+
}
|
|
35987
36905
|
/**
|
|
35988
36906
|
*
|
|
35989
36907
|
* @export
|
|
@@ -36003,6 +36921,58 @@ export interface VenueListEntryDto {
|
|
|
36003
36921
|
*/
|
|
36004
36922
|
'businessName': string;
|
|
36005
36923
|
}
|
|
36924
|
+
/**
|
|
36925
|
+
*
|
|
36926
|
+
* @export
|
|
36927
|
+
* @interface VenuePaymentTerminalDto
|
|
36928
|
+
*/
|
|
36929
|
+
export interface VenuePaymentTerminalDto {
|
|
36930
|
+
/**
|
|
36931
|
+
* The payment terminal\'s id, the one a kiosk is linked to
|
|
36932
|
+
* @type {string}
|
|
36933
|
+
* @memberof VenuePaymentTerminalDto
|
|
36934
|
+
*/
|
|
36935
|
+
'id': string;
|
|
36936
|
+
/**
|
|
36937
|
+
*
|
|
36938
|
+
* @type {PaymentProvider}
|
|
36939
|
+
* @memberof VenuePaymentTerminalDto
|
|
36940
|
+
*/
|
|
36941
|
+
'provider': PaymentProvider;
|
|
36942
|
+
/**
|
|
36943
|
+
* The terminal\'s label; null when it was given none
|
|
36944
|
+
* @type {string}
|
|
36945
|
+
* @memberof VenuePaymentTerminalDto
|
|
36946
|
+
*/
|
|
36947
|
+
'label': string | null;
|
|
36948
|
+
/**
|
|
36949
|
+
* The terminal\'s own id at its provider, as printed on the device
|
|
36950
|
+
* @type {string}
|
|
36951
|
+
* @memberof VenuePaymentTerminalDto
|
|
36952
|
+
*/
|
|
36953
|
+
'hardwareId': string;
|
|
36954
|
+
/**
|
|
36955
|
+
* The id of the station, a kiosk\'s or a till\'s, the terminal is linked to; null when it is free
|
|
36956
|
+
* @type {string}
|
|
36957
|
+
* @memberof VenuePaymentTerminalDto
|
|
36958
|
+
*/
|
|
36959
|
+
'stationId': string | null;
|
|
36960
|
+
}
|
|
36961
|
+
|
|
36962
|
+
|
|
36963
|
+
/**
|
|
36964
|
+
*
|
|
36965
|
+
* @export
|
|
36966
|
+
* @interface VenuePaymentTerminalsDto
|
|
36967
|
+
*/
|
|
36968
|
+
export interface VenuePaymentTerminalsDto {
|
|
36969
|
+
/**
|
|
36970
|
+
* The venue\'s payment terminals as stored, oldest first; a terminal is stored once a till has discovered it
|
|
36971
|
+
* @type {Array<VenuePaymentTerminalDto>}
|
|
36972
|
+
* @memberof VenuePaymentTerminalsDto
|
|
36973
|
+
*/
|
|
36974
|
+
'terminals': Array<VenuePaymentTerminalDto>;
|
|
36975
|
+
}
|
|
36006
36976
|
/**
|
|
36007
36977
|
*
|
|
36008
36978
|
* @export
|
|
@@ -36113,7 +37083,7 @@ export interface VenueProviderOutcomeDto {
|
|
|
36113
37083
|
*/
|
|
36114
37084
|
'rowsChanged': number;
|
|
36115
37085
|
/**
|
|
36116
|
-
* Whether the channel is on, as its row reads after the change: the first active row, else the
|
|
37086
|
+
* 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
|
|
36117
37087
|
* @type {boolean}
|
|
36118
37088
|
* @memberof VenueProviderOutcomeDto
|
|
36119
37089
|
*/
|
|
@@ -36133,6 +37103,52 @@ export interface VenueProviderOutcomeDto {
|
|
|
36133
37103
|
}
|
|
36134
37104
|
|
|
36135
37105
|
|
|
37106
|
+
/**
|
|
37107
|
+
*
|
|
37108
|
+
* @export
|
|
37109
|
+
* @interface VenueProviderStateDto
|
|
37110
|
+
*/
|
|
37111
|
+
export interface VenueProviderStateDto {
|
|
37112
|
+
/**
|
|
37113
|
+
*
|
|
37114
|
+
* @type {ProviderEnum}
|
|
37115
|
+
* @memberof VenueProviderStateDto
|
|
37116
|
+
*/
|
|
37117
|
+
'channel': ProviderEnum;
|
|
37118
|
+
/**
|
|
37119
|
+
* Whether the channel is on, as its row reads: the first active row, else the newest row, by createdAt and then id
|
|
37120
|
+
* @type {boolean}
|
|
37121
|
+
* @memberof VenueProviderStateDto
|
|
37122
|
+
*/
|
|
37123
|
+
'isActive': boolean;
|
|
37124
|
+
/**
|
|
37125
|
+
* Whether the channel\'s orders are accepted without the till, as the same row reads
|
|
37126
|
+
* @type {boolean}
|
|
37127
|
+
* @memberof VenueProviderStateDto
|
|
37128
|
+
*/
|
|
37129
|
+
'autoAccept': boolean;
|
|
37130
|
+
/**
|
|
37131
|
+
* The integrations the same row takes
|
|
37132
|
+
* @type {Array<IntegrationType>}
|
|
37133
|
+
* @memberof VenueProviderStateDto
|
|
37134
|
+
*/
|
|
37135
|
+
'integrations': Array<IntegrationType>;
|
|
37136
|
+
}
|
|
37137
|
+
|
|
37138
|
+
|
|
37139
|
+
/**
|
|
37140
|
+
*
|
|
37141
|
+
* @export
|
|
37142
|
+
* @interface VenueProvidersDto
|
|
37143
|
+
*/
|
|
37144
|
+
export interface VenueProvidersDto {
|
|
37145
|
+
/**
|
|
37146
|
+
* 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
|
|
37147
|
+
* @type {Array<VenueProviderStateDto>}
|
|
37148
|
+
* @memberof VenueProvidersDto
|
|
37149
|
+
*/
|
|
37150
|
+
'providers': Array<VenueProviderStateDto>;
|
|
37151
|
+
}
|
|
36136
37152
|
/**
|
|
36137
37153
|
*
|
|
36138
37154
|
* @export
|
|
@@ -60911,6 +61927,44 @@ export const ProviderApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
60911
61927
|
|
|
60912
61928
|
|
|
60913
61929
|
|
|
61930
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
61931
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
61932
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
61933
|
+
|
|
61934
|
+
return {
|
|
61935
|
+
url: toPathString(localVarUrlObj),
|
|
61936
|
+
options: localVarRequestOptions,
|
|
61937
|
+
};
|
|
61938
|
+
},
|
|
61939
|
+
/**
|
|
61940
|
+
* 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.
|
|
61941
|
+
* @summary Read whether each of a venue\'s own channels is on and auto-accepting, and its integrations
|
|
61942
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
61943
|
+
* @param {*} [options] Override http request option.
|
|
61944
|
+
* @throws {RequiredError}
|
|
61945
|
+
*/
|
|
61946
|
+
getVenueProviders: async (businessId: number, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
61947
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
61948
|
+
assertParamExists('getVenueProviders', 'businessId', businessId)
|
|
61949
|
+
const localVarPath = `/api/v2/venues/{businessId}/providers`
|
|
61950
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)));
|
|
61951
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
61952
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
61953
|
+
let baseOptions;
|
|
61954
|
+
if (configuration) {
|
|
61955
|
+
baseOptions = configuration.baseOptions;
|
|
61956
|
+
}
|
|
61957
|
+
|
|
61958
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
61959
|
+
const localVarHeaderParameter = {} as any;
|
|
61960
|
+
const localVarQueryParameter = {} as any;
|
|
61961
|
+
|
|
61962
|
+
// authentication JWT-auth required
|
|
61963
|
+
// http bearer authentication required
|
|
61964
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
61965
|
+
|
|
61966
|
+
|
|
61967
|
+
|
|
60914
61968
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
60915
61969
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
60916
61970
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -61143,6 +62197,17 @@ export const ProviderApiFp = function(configuration?: Configuration) {
|
|
|
61143
62197
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getOnboardingStatus(channel, businessId, options);
|
|
61144
62198
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
61145
62199
|
},
|
|
62200
|
+
/**
|
|
62201
|
+
* 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.
|
|
62202
|
+
* @summary Read whether each of a venue\'s own channels is on and auto-accepting, and its integrations
|
|
62203
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
62204
|
+
* @param {*} [options] Override http request option.
|
|
62205
|
+
* @throws {RequiredError}
|
|
62206
|
+
*/
|
|
62207
|
+
async getVenueProviders(businessId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueProvidersDto>> {
|
|
62208
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getVenueProviders(businessId, options);
|
|
62209
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
62210
|
+
},
|
|
61146
62211
|
/**
|
|
61147
62212
|
* Asked once the owner has signed in to Uber Eats, with the session\'s state; ubereats-service\'s list is answered as it is.
|
|
61148
62213
|
* @summary The Uber Eats stores the signed-in owner can connect
|
|
@@ -61245,6 +62310,16 @@ export const ProviderApiFactory = function (configuration?: Configuration, baseP
|
|
|
61245
62310
|
getOnboardingStatus(channel: ProviderEnum, businessId: number, options?: any): AxiosPromise<GetOnboardingStatus200Response> {
|
|
61246
62311
|
return localVarFp.getOnboardingStatus(channel, businessId, options).then((request) => request(axios, basePath));
|
|
61247
62312
|
},
|
|
62313
|
+
/**
|
|
62314
|
+
* 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.
|
|
62315
|
+
* @summary Read whether each of a venue\'s own channels is on and auto-accepting, and its integrations
|
|
62316
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
62317
|
+
* @param {*} [options] Override http request option.
|
|
62318
|
+
* @throws {RequiredError}
|
|
62319
|
+
*/
|
|
62320
|
+
getVenueProviders(businessId: number, options?: any): AxiosPromise<VenueProvidersDto> {
|
|
62321
|
+
return localVarFp.getVenueProviders(businessId, options).then((request) => request(axios, basePath));
|
|
62322
|
+
},
|
|
61248
62323
|
/**
|
|
61249
62324
|
* Asked once the owner has signed in to Uber Eats, with the session\'s state; ubereats-service\'s list is answered as it is.
|
|
61250
62325
|
* @summary The Uber Eats stores the signed-in owner can connect
|
|
@@ -61342,6 +62417,16 @@ export interface ProviderApiInterface {
|
|
|
61342
62417
|
*/
|
|
61343
62418
|
getOnboardingStatus(channel: ProviderEnum, businessId: number, options?: AxiosRequestConfig): AxiosPromise<GetOnboardingStatus200Response>;
|
|
61344
62419
|
|
|
62420
|
+
/**
|
|
62421
|
+
* 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.
|
|
62422
|
+
* @summary Read whether each of a venue\'s own channels is on and auto-accepting, and its integrations
|
|
62423
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
62424
|
+
* @param {*} [options] Override http request option.
|
|
62425
|
+
* @throws {RequiredError}
|
|
62426
|
+
* @memberof ProviderApiInterface
|
|
62427
|
+
*/
|
|
62428
|
+
getVenueProviders(businessId: number, options?: AxiosRequestConfig): AxiosPromise<VenueProvidersDto>;
|
|
62429
|
+
|
|
61345
62430
|
/**
|
|
61346
62431
|
* Asked once the owner has signed in to Uber Eats, with the session\'s state; ubereats-service\'s list is answered as it is.
|
|
61347
62432
|
* @summary The Uber Eats stores the signed-in owner can connect
|
|
@@ -61447,6 +62532,18 @@ export class ProviderApi extends BaseAPI implements ProviderApiInterface {
|
|
|
61447
62532
|
return ProviderApiFp(this.configuration).getOnboardingStatus(channel, businessId, options).then((request) => request(this.axios, this.basePath));
|
|
61448
62533
|
}
|
|
61449
62534
|
|
|
62535
|
+
/**
|
|
62536
|
+
* 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.
|
|
62537
|
+
* @summary Read whether each of a venue\'s own channels is on and auto-accepting, and its integrations
|
|
62538
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
62539
|
+
* @param {*} [options] Override http request option.
|
|
62540
|
+
* @throws {RequiredError}
|
|
62541
|
+
* @memberof ProviderApi
|
|
62542
|
+
*/
|
|
62543
|
+
public getVenueProviders(businessId: number, options?: AxiosRequestConfig) {
|
|
62544
|
+
return ProviderApiFp(this.configuration).getVenueProviders(businessId, options).then((request) => request(this.axios, this.basePath));
|
|
62545
|
+
}
|
|
62546
|
+
|
|
61450
62547
|
/**
|
|
61451
62548
|
* Asked once the owner has signed in to Uber Eats, with the session\'s state; ubereats-service\'s list is answered as it is.
|
|
61452
62549
|
* @summary The Uber Eats stores the signed-in owner can connect
|
|
@@ -64180,7 +65277,7 @@ export const ReportSchedulesApiAxiosParamCreator = function (configuration?: Con
|
|
|
64180
65277
|
* Its schedule: cadence, time and zone, recipients and when it next sends. 404 when none is saved. Managers only.
|
|
64181
65278
|
* @summary Read when a store\'s ready-made report is emailed
|
|
64182
65279
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
64183
|
-
* @param {ReadyMadeReport} readyMadeReport The ready-made report
|
|
65280
|
+
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
|
|
64184
65281
|
* @param {*} [options] Override http request option.
|
|
64185
65282
|
* @throws {RequiredError}
|
|
64186
65283
|
*/
|
|
@@ -64365,7 +65462,7 @@ export const ReportSchedulesApiAxiosParamCreator = function (configuration?: Con
|
|
|
64365
65462
|
* Every time it was emailed, newest first, a page at a time: the days it covered, who it went to and the files it kept.
|
|
64366
65463
|
* @summary List the past runs of a store\'s ready-made report
|
|
64367
65464
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
64368
|
-
* @param {ReadyMadeReport} readyMadeReport The ready-made report
|
|
65465
|
+
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
|
|
64369
65466
|
* @param {number} [limit] At most this many runs, 1 to 100. Absent: 30
|
|
64370
65467
|
* @param {string} [after] The id of the last run of the page before; the list goes on after it
|
|
64371
65468
|
* @param {*} [options] Override http request option.
|
|
@@ -64466,7 +65563,7 @@ export const ReportSchedulesApiAxiosParamCreator = function (configuration?: Con
|
|
|
64466
65563
|
};
|
|
64467
65564
|
},
|
|
64468
65565
|
/**
|
|
64469
|
-
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its PDF and Excel
|
|
65566
|
+
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its files, as dashboard-one\'s Reports downloads them: the sales report\'s PDF and Excel for sales, salesVat, payments and productSales, the end-of-day PDF for zReport, none for cashSessions and staff, whose email opens the report for its days) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
|
|
64470
65567
|
* @summary Set when an organisation\'s saved report is emailed
|
|
64471
65568
|
* @param {string} groupId The organisation\'s id: its group\'s accountId in the licence server
|
|
64472
65569
|
* @param {string} reportId The saved report\'s id
|
|
@@ -64514,10 +65611,10 @@ export const ReportSchedulesApiAxiosParamCreator = function (configuration?: Con
|
|
|
64514
65611
|
};
|
|
64515
65612
|
},
|
|
64516
65613
|
/**
|
|
64517
|
-
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its PDF and Excel
|
|
65614
|
+
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its files, as dashboard-one\'s Reports downloads them: the sales report\'s PDF and Excel for sales, salesVat, payments and productSales, the end-of-day PDF for zReport, none for cashSessions and staff, whose email opens the report for its days) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
|
|
64518
65615
|
* @summary Set when a store\'s ready-made report is emailed
|
|
64519
65616
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
64520
|
-
* @param {ReadyMadeReport} readyMadeReport The ready-made report
|
|
65617
|
+
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
|
|
64521
65618
|
* @param {SetReportScheduleDto} setReportScheduleDto
|
|
64522
65619
|
* @param {*} [options] Override http request option.
|
|
64523
65620
|
* @throws {RequiredError}
|
|
@@ -64562,7 +65659,7 @@ export const ReportSchedulesApiAxiosParamCreator = function (configuration?: Con
|
|
|
64562
65659
|
};
|
|
64563
65660
|
},
|
|
64564
65661
|
/**
|
|
64565
|
-
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its PDF and Excel
|
|
65662
|
+
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its files, as dashboard-one\'s Reports downloads them: the sales report\'s PDF and Excel for sales, salesVat, payments and productSales, the end-of-day PDF for zReport, none for cashSessions and staff, whose email opens the report for its days) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
|
|
64566
65663
|
* @summary Set when a store\'s saved report is emailed
|
|
64567
65664
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
64568
65665
|
* @param {string} reportId The saved report\'s id
|
|
@@ -64659,7 +65756,7 @@ export const ReportSchedulesApiFp = function(configuration?: Configuration) {
|
|
|
64659
65756
|
* Its schedule: cadence, time and zone, recipients and when it next sends. 404 when none is saved. Managers only.
|
|
64660
65757
|
* @summary Read when a store\'s ready-made report is emailed
|
|
64661
65758
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
64662
|
-
* @param {ReadyMadeReport} readyMadeReport The ready-made report
|
|
65759
|
+
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
|
|
64663
65760
|
* @param {*} [options] Override http request option.
|
|
64664
65761
|
* @throws {RequiredError}
|
|
64665
65762
|
*/
|
|
@@ -64710,7 +65807,7 @@ export const ReportSchedulesApiFp = function(configuration?: Configuration) {
|
|
|
64710
65807
|
* Every time it was emailed, newest first, a page at a time: the days it covered, who it went to and the files it kept.
|
|
64711
65808
|
* @summary List the past runs of a store\'s ready-made report
|
|
64712
65809
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
64713
|
-
* @param {ReadyMadeReport} readyMadeReport The ready-made report
|
|
65810
|
+
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
|
|
64714
65811
|
* @param {number} [limit] At most this many runs, 1 to 100. Absent: 30
|
|
64715
65812
|
* @param {string} [after] The id of the last run of the page before; the list goes on after it
|
|
64716
65813
|
* @param {*} [options] Override http request option.
|
|
@@ -64735,7 +65832,7 @@ export const ReportSchedulesApiFp = function(configuration?: Configuration) {
|
|
|
64735
65832
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
64736
65833
|
},
|
|
64737
65834
|
/**
|
|
64738
|
-
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its PDF and Excel
|
|
65835
|
+
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its files, as dashboard-one\'s Reports downloads them: the sales report\'s PDF and Excel for sales, salesVat, payments and productSales, the end-of-day PDF for zReport, none for cashSessions and staff, whose email opens the report for its days) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
|
|
64739
65836
|
* @summary Set when an organisation\'s saved report is emailed
|
|
64740
65837
|
* @param {string} groupId The organisation\'s id: its group\'s accountId in the licence server
|
|
64741
65838
|
* @param {string} reportId The saved report\'s id
|
|
@@ -64748,10 +65845,10 @@ export const ReportSchedulesApiFp = function(configuration?: Configuration) {
|
|
|
64748
65845
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
64749
65846
|
},
|
|
64750
65847
|
/**
|
|
64751
|
-
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its PDF and Excel
|
|
65848
|
+
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its files, as dashboard-one\'s Reports downloads them: the sales report\'s PDF and Excel for sales, salesVat, payments and productSales, the end-of-day PDF for zReport, none for cashSessions and staff, whose email opens the report for its days) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
|
|
64752
65849
|
* @summary Set when a store\'s ready-made report is emailed
|
|
64753
65850
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
64754
|
-
* @param {ReadyMadeReport} readyMadeReport The ready-made report
|
|
65851
|
+
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
|
|
64755
65852
|
* @param {SetReportScheduleDto} setReportScheduleDto
|
|
64756
65853
|
* @param {*} [options] Override http request option.
|
|
64757
65854
|
* @throws {RequiredError}
|
|
@@ -64761,7 +65858,7 @@ export const ReportSchedulesApiFp = function(configuration?: Configuration) {
|
|
|
64761
65858
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
64762
65859
|
},
|
|
64763
65860
|
/**
|
|
64764
|
-
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its PDF and Excel
|
|
65861
|
+
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its files, as dashboard-one\'s Reports downloads them: the sales report\'s PDF and Excel for sales, salesVat, payments and productSales, the end-of-day PDF for zReport, none for cashSessions and staff, whose email opens the report for its days) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
|
|
64765
65862
|
* @summary Set when a store\'s saved report is emailed
|
|
64766
65863
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
64767
65864
|
* @param {string} reportId The saved report\'s id
|
|
@@ -64820,7 +65917,7 @@ export const ReportSchedulesApiFactory = function (configuration?: Configuration
|
|
|
64820
65917
|
* Its schedule: cadence, time and zone, recipients and when it next sends. 404 when none is saved. Managers only.
|
|
64821
65918
|
* @summary Read when a store\'s ready-made report is emailed
|
|
64822
65919
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
64823
|
-
* @param {ReadyMadeReport} readyMadeReport The ready-made report
|
|
65920
|
+
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
|
|
64824
65921
|
* @param {*} [options] Override http request option.
|
|
64825
65922
|
* @throws {RequiredError}
|
|
64826
65923
|
*/
|
|
@@ -64867,7 +65964,7 @@ export const ReportSchedulesApiFactory = function (configuration?: Configuration
|
|
|
64867
65964
|
* Every time it was emailed, newest first, a page at a time: the days it covered, who it went to and the files it kept.
|
|
64868
65965
|
* @summary List the past runs of a store\'s ready-made report
|
|
64869
65966
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
64870
|
-
* @param {ReadyMadeReport} readyMadeReport The ready-made report
|
|
65967
|
+
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
|
|
64871
65968
|
* @param {number} [limit] At most this many runs, 1 to 100. Absent: 30
|
|
64872
65969
|
* @param {string} [after] The id of the last run of the page before; the list goes on after it
|
|
64873
65970
|
* @param {*} [options] Override http request option.
|
|
@@ -64890,7 +65987,7 @@ export const ReportSchedulesApiFactory = function (configuration?: Configuration
|
|
|
64890
65987
|
return localVarFp.listStoreSavedReportRuns(businessId, reportId, limit, after, options).then((request) => request(axios, basePath));
|
|
64891
65988
|
},
|
|
64892
65989
|
/**
|
|
64893
|
-
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its PDF and Excel
|
|
65990
|
+
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its files, as dashboard-one\'s Reports downloads them: the sales report\'s PDF and Excel for sales, salesVat, payments and productSales, the end-of-day PDF for zReport, none for cashSessions and staff, whose email opens the report for its days) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
|
|
64894
65991
|
* @summary Set when an organisation\'s saved report is emailed
|
|
64895
65992
|
* @param {string} groupId The organisation\'s id: its group\'s accountId in the licence server
|
|
64896
65993
|
* @param {string} reportId The saved report\'s id
|
|
@@ -64902,10 +65999,10 @@ export const ReportSchedulesApiFactory = function (configuration?: Configuration
|
|
|
64902
65999
|
return localVarFp.setOrganisationSavedReportSchedule(groupId, reportId, setReportScheduleDto, options).then((request) => request(axios, basePath));
|
|
64903
66000
|
},
|
|
64904
66001
|
/**
|
|
64905
|
-
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its PDF and Excel
|
|
66002
|
+
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its files, as dashboard-one\'s Reports downloads them: the sales report\'s PDF and Excel for sales, salesVat, payments and productSales, the end-of-day PDF for zReport, none for cashSessions and staff, whose email opens the report for its days) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
|
|
64906
66003
|
* @summary Set when a store\'s ready-made report is emailed
|
|
64907
66004
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
64908
|
-
* @param {ReadyMadeReport} readyMadeReport The ready-made report
|
|
66005
|
+
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
|
|
64909
66006
|
* @param {SetReportScheduleDto} setReportScheduleDto
|
|
64910
66007
|
* @param {*} [options] Override http request option.
|
|
64911
66008
|
* @throws {RequiredError}
|
|
@@ -64914,7 +66011,7 @@ export const ReportSchedulesApiFactory = function (configuration?: Configuration
|
|
|
64914
66011
|
return localVarFp.setStoreReadyMadeReportSchedule(businessId, readyMadeReport, setReportScheduleDto, options).then((request) => request(axios, basePath));
|
|
64915
66012
|
},
|
|
64916
66013
|
/**
|
|
64917
|
-
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its PDF and Excel
|
|
66014
|
+
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its files, as dashboard-one\'s Reports downloads them: the sales report\'s PDF and Excel for sales, salesVat, payments and productSales, the end-of-day PDF for zReport, none for cashSessions and staff, whose email opens the report for its days) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
|
|
64918
66015
|
* @summary Set when a store\'s saved report is emailed
|
|
64919
66016
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
64920
66017
|
* @param {string} reportId The saved report\'s id
|
|
@@ -64971,7 +66068,7 @@ export interface ReportSchedulesApiInterface {
|
|
|
64971
66068
|
* Its schedule: cadence, time and zone, recipients and when it next sends. 404 when none is saved. Managers only.
|
|
64972
66069
|
* @summary Read when a store\'s ready-made report is emailed
|
|
64973
66070
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
64974
|
-
* @param {ReadyMadeReport} readyMadeReport The ready-made report
|
|
66071
|
+
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
|
|
64975
66072
|
* @param {*} [options] Override http request option.
|
|
64976
66073
|
* @throws {RequiredError}
|
|
64977
66074
|
* @memberof ReportSchedulesApiInterface
|
|
@@ -65018,7 +66115,7 @@ export interface ReportSchedulesApiInterface {
|
|
|
65018
66115
|
* Every time it was emailed, newest first, a page at a time: the days it covered, who it went to and the files it kept.
|
|
65019
66116
|
* @summary List the past runs of a store\'s ready-made report
|
|
65020
66117
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
65021
|
-
* @param {ReadyMadeReport} readyMadeReport The ready-made report
|
|
66118
|
+
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
|
|
65022
66119
|
* @param {number} [limit] At most this many runs, 1 to 100. Absent: 30
|
|
65023
66120
|
* @param {string} [after] The id of the last run of the page before; the list goes on after it
|
|
65024
66121
|
* @param {*} [options] Override http request option.
|
|
@@ -65041,7 +66138,7 @@ export interface ReportSchedulesApiInterface {
|
|
|
65041
66138
|
listStoreSavedReportRuns(businessId: number, reportId: string, limit?: number, after?: string, options?: AxiosRequestConfig): AxiosPromise<ReportRunListDto>;
|
|
65042
66139
|
|
|
65043
66140
|
/**
|
|
65044
|
-
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its PDF and Excel
|
|
66141
|
+
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its files, as dashboard-one\'s Reports downloads them: the sales report\'s PDF and Excel for sales, salesVat, payments and productSales, the end-of-day PDF for zReport, none for cashSessions and staff, whose email opens the report for its days) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
|
|
65045
66142
|
* @summary Set when an organisation\'s saved report is emailed
|
|
65046
66143
|
* @param {string} groupId The organisation\'s id: its group\'s accountId in the licence server
|
|
65047
66144
|
* @param {string} reportId The saved report\'s id
|
|
@@ -65053,10 +66150,10 @@ export interface ReportSchedulesApiInterface {
|
|
|
65053
66150
|
setOrganisationSavedReportSchedule(groupId: string, reportId: string, setReportScheduleDto: SetReportScheduleDto, options?: AxiosRequestConfig): AxiosPromise<ReportScheduleDto>;
|
|
65054
66151
|
|
|
65055
66152
|
/**
|
|
65056
|
-
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its PDF and Excel
|
|
66153
|
+
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its files, as dashboard-one\'s Reports downloads them: the sales report\'s PDF and Excel for sales, salesVat, payments and productSales, the end-of-day PDF for zReport, none for cashSessions and staff, whose email opens the report for its days) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
|
|
65057
66154
|
* @summary Set when a store\'s ready-made report is emailed
|
|
65058
66155
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
65059
|
-
* @param {ReadyMadeReport} readyMadeReport The ready-made report
|
|
66156
|
+
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
|
|
65060
66157
|
* @param {SetReportScheduleDto} setReportScheduleDto
|
|
65061
66158
|
* @param {*} [options] Override http request option.
|
|
65062
66159
|
* @throws {RequiredError}
|
|
@@ -65065,7 +66162,7 @@ export interface ReportSchedulesApiInterface {
|
|
|
65065
66162
|
setStoreReadyMadeReportSchedule(businessId: number, readyMadeReport: ReadyMadeReport, setReportScheduleDto: SetReportScheduleDto, options?: AxiosRequestConfig): AxiosPromise<ReportScheduleDto>;
|
|
65066
66163
|
|
|
65067
66164
|
/**
|
|
65068
|
-
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its PDF and Excel
|
|
66165
|
+
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its files, as dashboard-one\'s Reports downloads them: the sales report\'s PDF and Excel for sales, salesVat, payments and productSales, the end-of-day PDF for zReport, none for cashSessions and staff, whose email opens the report for its days) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
|
|
65069
66166
|
* @summary Set when a store\'s saved report is emailed
|
|
65070
66167
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
65071
66168
|
* @param {string} reportId The saved report\'s id
|
|
@@ -65128,7 +66225,7 @@ export class ReportSchedulesApi extends BaseAPI implements ReportSchedulesApiInt
|
|
|
65128
66225
|
* Its schedule: cadence, time and zone, recipients and when it next sends. 404 when none is saved. Managers only.
|
|
65129
66226
|
* @summary Read when a store\'s ready-made report is emailed
|
|
65130
66227
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
65131
|
-
* @param {ReadyMadeReport} readyMadeReport The ready-made report
|
|
66228
|
+
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
|
|
65132
66229
|
* @param {*} [options] Override http request option.
|
|
65133
66230
|
* @throws {RequiredError}
|
|
65134
66231
|
* @memberof ReportSchedulesApi
|
|
@@ -65183,7 +66280,7 @@ export class ReportSchedulesApi extends BaseAPI implements ReportSchedulesApiInt
|
|
|
65183
66280
|
* Every time it was emailed, newest first, a page at a time: the days it covered, who it went to and the files it kept.
|
|
65184
66281
|
* @summary List the past runs of a store\'s ready-made report
|
|
65185
66282
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
65186
|
-
* @param {ReadyMadeReport} readyMadeReport The ready-made report
|
|
66283
|
+
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
|
|
65187
66284
|
* @param {number} [limit] At most this many runs, 1 to 100. Absent: 30
|
|
65188
66285
|
* @param {string} [after] The id of the last run of the page before; the list goes on after it
|
|
65189
66286
|
* @param {*} [options] Override http request option.
|
|
@@ -65210,7 +66307,7 @@ export class ReportSchedulesApi extends BaseAPI implements ReportSchedulesApiInt
|
|
|
65210
66307
|
}
|
|
65211
66308
|
|
|
65212
66309
|
/**
|
|
65213
|
-
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its PDF and Excel
|
|
66310
|
+
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its files, as dashboard-one\'s Reports downloads them: the sales report\'s PDF and Excel for sales, salesVat, payments and productSales, the end-of-day PDF for zReport, none for cashSessions and staff, whose email opens the report for its days) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
|
|
65214
66311
|
* @summary Set when an organisation\'s saved report is emailed
|
|
65215
66312
|
* @param {string} groupId The organisation\'s id: its group\'s accountId in the licence server
|
|
65216
66313
|
* @param {string} reportId The saved report\'s id
|
|
@@ -65224,10 +66321,10 @@ export class ReportSchedulesApi extends BaseAPI implements ReportSchedulesApiInt
|
|
|
65224
66321
|
}
|
|
65225
66322
|
|
|
65226
66323
|
/**
|
|
65227
|
-
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its PDF and Excel
|
|
66324
|
+
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its files, as dashboard-one\'s Reports downloads them: the sales report\'s PDF and Excel for sales, salesVat, payments and productSales, the end-of-day PDF for zReport, none for cashSessions and staff, whose email opens the report for its days) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
|
|
65228
66325
|
* @summary Set when a store\'s ready-made report is emailed
|
|
65229
66326
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
65230
|
-
* @param {ReadyMadeReport} readyMadeReport The ready-made report
|
|
66327
|
+
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
|
|
65231
66328
|
* @param {SetReportScheduleDto} setReportScheduleDto
|
|
65232
66329
|
* @param {*} [options] Override http request option.
|
|
65233
66330
|
* @throws {RequiredError}
|
|
@@ -65238,7 +66335,7 @@ export class ReportSchedulesApi extends BaseAPI implements ReportSchedulesApiInt
|
|
|
65238
66335
|
}
|
|
65239
66336
|
|
|
65240
66337
|
/**
|
|
65241
|
-
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its PDF and Excel
|
|
66338
|
+
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its files, as dashboard-one\'s Reports downloads them: the sales report\'s PDF and Excel for sales, salesVat, payments and productSales, the end-of-day PDF for zReport, none for cashSessions and staff, whose email opens the report for its days) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
|
|
65242
66339
|
* @summary Set when a store\'s saved report is emailed
|
|
65243
66340
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
65244
66341
|
* @param {string} reportId The saved report\'s id
|
|
@@ -67454,7 +68551,7 @@ export const SavedReportsApiAxiosParamCreator = function (configuration?: Config
|
|
|
67454
68551
|
};
|
|
67455
68552
|
},
|
|
67456
68553
|
/**
|
|
67457
|
-
* No sign-in. The report\'s name, kind, cards and filters,
|
|
68554
|
+
* No sign-in. The report\'s name, kind, cards and filters, the store or organisation whose data it reads, and numbers: what dashboard-one\'s Analytics dashboard reads for the same cards, read now for each side\'s saved period and apps: the sales report (as GET /api/v6/report/sales: summary, items, payments and discounts, by store and app, with totals, compared with the same weekdays before, up to the same time while the period runs) and, when its cards show them, a one-day period\'s 14-day trend, the year\'s 26 weeks, the hours (the period\'s, today\'s and a normal day\'s), items bought together and order types. Aggregates only: no order, person or customer. Answered only while the report\'s owner still manages its store or organisation (404 once they do not). A custom period is read for its last 366 days at most. Never kept by a cache (Cache-Control: no-store). Only the report\'s own store, or its organisation\'s stores as the licence server names them now, are ever read: a store its filters name that is neither is left out. Nothing but the token is taken from the request. numbers is null, and the definition still answers, when they could not be read. 404 when no report is public under that token (never made public, made private again, or published again with a new link).
|
|
67458
68555
|
* @summary Read a public report by its link
|
|
67459
68556
|
* @param {string} token The public link\'s token, 43 characters
|
|
67460
68557
|
* @param {*} [options] Override http request option.
|
|
@@ -67914,7 +69011,7 @@ export const SavedReportsApiFp = function(configuration?: Configuration) {
|
|
|
67914
69011
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
67915
69012
|
},
|
|
67916
69013
|
/**
|
|
67917
|
-
* No sign-in. The report\'s name, kind, cards and filters,
|
|
69014
|
+
* No sign-in. The report\'s name, kind, cards and filters, the store or organisation whose data it reads, and numbers: what dashboard-one\'s Analytics dashboard reads for the same cards, read now for each side\'s saved period and apps: the sales report (as GET /api/v6/report/sales: summary, items, payments and discounts, by store and app, with totals, compared with the same weekdays before, up to the same time while the period runs) and, when its cards show them, a one-day period\'s 14-day trend, the year\'s 26 weeks, the hours (the period\'s, today\'s and a normal day\'s), items bought together and order types. Aggregates only: no order, person or customer. Answered only while the report\'s owner still manages its store or organisation (404 once they do not). A custom period is read for its last 366 days at most. Never kept by a cache (Cache-Control: no-store). Only the report\'s own store, or its organisation\'s stores as the licence server names them now, are ever read: a store its filters name that is neither is left out. Nothing but the token is taken from the request. numbers is null, and the definition still answers, when they could not be read. 404 when no report is public under that token (never made public, made private again, or published again with a new link).
|
|
67918
69015
|
* @summary Read a public report by its link
|
|
67919
69016
|
* @param {string} token The public link\'s token, 43 characters
|
|
67920
69017
|
* @param {*} [options] Override http request option.
|
|
@@ -68104,7 +69201,7 @@ export const SavedReportsApiFactory = function (configuration?: Configuration, b
|
|
|
68104
69201
|
return localVarFp.getOrganisationSavedReport(groupId, reportId, options).then((request) => request(axios, basePath));
|
|
68105
69202
|
},
|
|
68106
69203
|
/**
|
|
68107
|
-
* No sign-in. The report\'s name, kind, cards and filters,
|
|
69204
|
+
* No sign-in. The report\'s name, kind, cards and filters, the store or organisation whose data it reads, and numbers: what dashboard-one\'s Analytics dashboard reads for the same cards, read now for each side\'s saved period and apps: the sales report (as GET /api/v6/report/sales: summary, items, payments and discounts, by store and app, with totals, compared with the same weekdays before, up to the same time while the period runs) and, when its cards show them, a one-day period\'s 14-day trend, the year\'s 26 weeks, the hours (the period\'s, today\'s and a normal day\'s), items bought together and order types. Aggregates only: no order, person or customer. Answered only while the report\'s owner still manages its store or organisation (404 once they do not). A custom period is read for its last 366 days at most. Never kept by a cache (Cache-Control: no-store). Only the report\'s own store, or its organisation\'s stores as the licence server names them now, are ever read: a store its filters name that is neither is left out. Nothing but the token is taken from the request. numbers is null, and the definition still answers, when they could not be read. 404 when no report is public under that token (never made public, made private again, or published again with a new link).
|
|
68108
69205
|
* @summary Read a public report by its link
|
|
68109
69206
|
* @param {string} token The public link\'s token, 43 characters
|
|
68110
69207
|
* @param {*} [options] Override http request option.
|
|
@@ -68285,7 +69382,7 @@ export interface SavedReportsApiInterface {
|
|
|
68285
69382
|
getOrganisationSavedReport(groupId: string, reportId: string, options?: AxiosRequestConfig): AxiosPromise<SavedReportDto>;
|
|
68286
69383
|
|
|
68287
69384
|
/**
|
|
68288
|
-
* No sign-in. The report\'s name, kind, cards and filters,
|
|
69385
|
+
* No sign-in. The report\'s name, kind, cards and filters, the store or organisation whose data it reads, and numbers: what dashboard-one\'s Analytics dashboard reads for the same cards, read now for each side\'s saved period and apps: the sales report (as GET /api/v6/report/sales: summary, items, payments and discounts, by store and app, with totals, compared with the same weekdays before, up to the same time while the period runs) and, when its cards show them, a one-day period\'s 14-day trend, the year\'s 26 weeks, the hours (the period\'s, today\'s and a normal day\'s), items bought together and order types. Aggregates only: no order, person or customer. Answered only while the report\'s owner still manages its store or organisation (404 once they do not). A custom period is read for its last 366 days at most. Never kept by a cache (Cache-Control: no-store). Only the report\'s own store, or its organisation\'s stores as the licence server names them now, are ever read: a store its filters name that is neither is left out. Nothing but the token is taken from the request. numbers is null, and the definition still answers, when they could not be read. 404 when no report is public under that token (never made public, made private again, or published again with a new link).
|
|
68289
69386
|
* @summary Read a public report by its link
|
|
68290
69387
|
* @param {string} token The public link\'s token, 43 characters
|
|
68291
69388
|
* @param {*} [options] Override http request option.
|
|
@@ -68480,7 +69577,7 @@ export class SavedReportsApi extends BaseAPI implements SavedReportsApiInterface
|
|
|
68480
69577
|
}
|
|
68481
69578
|
|
|
68482
69579
|
/**
|
|
68483
|
-
* No sign-in. The report\'s name, kind, cards and filters,
|
|
69580
|
+
* No sign-in. The report\'s name, kind, cards and filters, the store or organisation whose data it reads, and numbers: what dashboard-one\'s Analytics dashboard reads for the same cards, read now for each side\'s saved period and apps: the sales report (as GET /api/v6/report/sales: summary, items, payments and discounts, by store and app, with totals, compared with the same weekdays before, up to the same time while the period runs) and, when its cards show them, a one-day period\'s 14-day trend, the year\'s 26 weeks, the hours (the period\'s, today\'s and a normal day\'s), items bought together and order types. Aggregates only: no order, person or customer. Answered only while the report\'s owner still manages its store or organisation (404 once they do not). A custom period is read for its last 366 days at most. Never kept by a cache (Cache-Control: no-store). Only the report\'s own store, or its organisation\'s stores as the licence server names them now, are ever read: a store its filters name that is neither is left out. Nothing but the token is taken from the request. numbers is null, and the definition still answers, when they could not be read. 404 when no report is public under that token (never made public, made private again, or published again with a new link).
|
|
68484
69581
|
* @summary Read a public report by its link
|
|
68485
69582
|
* @param {string} token The public link\'s token, 43 characters
|
|
68486
69583
|
* @param {*} [options] Override http request option.
|
|
@@ -70165,6 +71262,592 @@ export class VendureSellerApi extends BaseAPI implements VendureSellerApiInterfa
|
|
|
70165
71262
|
}
|
|
70166
71263
|
|
|
70167
71264
|
|
|
71265
|
+
/**
|
|
71266
|
+
* VenueKiosksApi - axios parameter creator
|
|
71267
|
+
* @export
|
|
71268
|
+
*/
|
|
71269
|
+
export const VenueKiosksApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
71270
|
+
return {
|
|
71271
|
+
/**
|
|
71272
|
+
* 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.
|
|
71273
|
+
* @summary Rename a kiosk, change its prefix, or put it in or out of use
|
|
71274
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71275
|
+
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
71276
|
+
* @param {ChangeKioskDto} changeKioskDto
|
|
71277
|
+
* @param {*} [options] Override http request option.
|
|
71278
|
+
* @throws {RequiredError}
|
|
71279
|
+
*/
|
|
71280
|
+
changeVenueKiosk: async (businessId: number, stationId: string, changeKioskDto: ChangeKioskDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
71281
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
71282
|
+
assertParamExists('changeVenueKiosk', 'businessId', businessId)
|
|
71283
|
+
// verify required parameter 'stationId' is not null or undefined
|
|
71284
|
+
assertParamExists('changeVenueKiosk', 'stationId', stationId)
|
|
71285
|
+
// verify required parameter 'changeKioskDto' is not null or undefined
|
|
71286
|
+
assertParamExists('changeVenueKiosk', 'changeKioskDto', changeKioskDto)
|
|
71287
|
+
const localVarPath = `/api/v2/venues/{businessId}/kiosks/{stationId}`
|
|
71288
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)))
|
|
71289
|
+
.replace(`{${"stationId"}}`, encodeURIComponent(String(stationId)));
|
|
71290
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
71291
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
71292
|
+
let baseOptions;
|
|
71293
|
+
if (configuration) {
|
|
71294
|
+
baseOptions = configuration.baseOptions;
|
|
71295
|
+
}
|
|
71296
|
+
|
|
71297
|
+
const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
|
|
71298
|
+
const localVarHeaderParameter = {} as any;
|
|
71299
|
+
const localVarQueryParameter = {} as any;
|
|
71300
|
+
|
|
71301
|
+
// authentication JWT-auth required
|
|
71302
|
+
// http bearer authentication required
|
|
71303
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
71304
|
+
|
|
71305
|
+
|
|
71306
|
+
|
|
71307
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
71308
|
+
|
|
71309
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
71310
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
71311
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
71312
|
+
localVarRequestOptions.data = serializeDataIfNeeded(changeKioskDto, localVarRequestOptions, configuration)
|
|
71313
|
+
|
|
71314
|
+
return {
|
|
71315
|
+
url: toPathString(localVarUrlObj),
|
|
71316
|
+
options: localVarRequestOptions,
|
|
71317
|
+
};
|
|
71318
|
+
},
|
|
71319
|
+
/**
|
|
71320
|
+
* 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.
|
|
71321
|
+
* @summary Link a kiosk to the venue by the Hardware ID it shows
|
|
71322
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71323
|
+
* @param {ClaimKioskDto} claimKioskDto
|
|
71324
|
+
* @param {*} [options] Override http request option.
|
|
71325
|
+
* @throws {RequiredError}
|
|
71326
|
+
*/
|
|
71327
|
+
claimVenueKiosk: async (businessId: number, claimKioskDto: ClaimKioskDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
71328
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
71329
|
+
assertParamExists('claimVenueKiosk', 'businessId', businessId)
|
|
71330
|
+
// verify required parameter 'claimKioskDto' is not null or undefined
|
|
71331
|
+
assertParamExists('claimVenueKiosk', 'claimKioskDto', claimKioskDto)
|
|
71332
|
+
const localVarPath = `/api/v2/venues/{businessId}/kiosks`
|
|
71333
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)));
|
|
71334
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
71335
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
71336
|
+
let baseOptions;
|
|
71337
|
+
if (configuration) {
|
|
71338
|
+
baseOptions = configuration.baseOptions;
|
|
71339
|
+
}
|
|
71340
|
+
|
|
71341
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
71342
|
+
const localVarHeaderParameter = {} as any;
|
|
71343
|
+
const localVarQueryParameter = {} as any;
|
|
71344
|
+
|
|
71345
|
+
// authentication JWT-auth required
|
|
71346
|
+
// http bearer authentication required
|
|
71347
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
71348
|
+
|
|
71349
|
+
|
|
71350
|
+
|
|
71351
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
71352
|
+
|
|
71353
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
71354
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
71355
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
71356
|
+
localVarRequestOptions.data = serializeDataIfNeeded(claimKioskDto, localVarRequestOptions, configuration)
|
|
71357
|
+
|
|
71358
|
+
return {
|
|
71359
|
+
url: toPathString(localVarUrlObj),
|
|
71360
|
+
options: localVarRequestOptions,
|
|
71361
|
+
};
|
|
71362
|
+
},
|
|
71363
|
+
/**
|
|
71364
|
+
* 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.
|
|
71365
|
+
* @summary Link one of the venue\'s payment terminals to a kiosk, or unlink it
|
|
71366
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71367
|
+
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
71368
|
+
* @param {LinkKioskTerminalDto} linkKioskTerminalDto
|
|
71369
|
+
* @param {*} [options] Override http request option.
|
|
71370
|
+
* @throws {RequiredError}
|
|
71371
|
+
*/
|
|
71372
|
+
linkVenueKioskTerminal: async (businessId: number, stationId: string, linkKioskTerminalDto: LinkKioskTerminalDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
71373
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
71374
|
+
assertParamExists('linkVenueKioskTerminal', 'businessId', businessId)
|
|
71375
|
+
// verify required parameter 'stationId' is not null or undefined
|
|
71376
|
+
assertParamExists('linkVenueKioskTerminal', 'stationId', stationId)
|
|
71377
|
+
// verify required parameter 'linkKioskTerminalDto' is not null or undefined
|
|
71378
|
+
assertParamExists('linkVenueKioskTerminal', 'linkKioskTerminalDto', linkKioskTerminalDto)
|
|
71379
|
+
const localVarPath = `/api/v2/venues/{businessId}/kiosks/{stationId}/terminal`
|
|
71380
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)))
|
|
71381
|
+
.replace(`{${"stationId"}}`, encodeURIComponent(String(stationId)));
|
|
71382
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
71383
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
71384
|
+
let baseOptions;
|
|
71385
|
+
if (configuration) {
|
|
71386
|
+
baseOptions = configuration.baseOptions;
|
|
71387
|
+
}
|
|
71388
|
+
|
|
71389
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
|
|
71390
|
+
const localVarHeaderParameter = {} as any;
|
|
71391
|
+
const localVarQueryParameter = {} as any;
|
|
71392
|
+
|
|
71393
|
+
// authentication JWT-auth required
|
|
71394
|
+
// http bearer authentication required
|
|
71395
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
71396
|
+
|
|
71397
|
+
|
|
71398
|
+
|
|
71399
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
71400
|
+
|
|
71401
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
71402
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
71403
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
71404
|
+
localVarRequestOptions.data = serializeDataIfNeeded(linkKioskTerminalDto, localVarRequestOptions, configuration)
|
|
71405
|
+
|
|
71406
|
+
return {
|
|
71407
|
+
url: toPathString(localVarUrlObj),
|
|
71408
|
+
options: localVarRequestOptions,
|
|
71409
|
+
};
|
|
71410
|
+
},
|
|
71411
|
+
/**
|
|
71412
|
+
* Every kiosk station of the venue, active or removed, oldest first, with its linked payment terminal. Read from the database every time.
|
|
71413
|
+
* @summary List the venue\'s kiosks
|
|
71414
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71415
|
+
* @param {*} [options] Override http request option.
|
|
71416
|
+
* @throws {RequiredError}
|
|
71417
|
+
*/
|
|
71418
|
+
listVenueKiosks: async (businessId: number, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
71419
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
71420
|
+
assertParamExists('listVenueKiosks', 'businessId', businessId)
|
|
71421
|
+
const localVarPath = `/api/v2/venues/{businessId}/kiosks`
|
|
71422
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)));
|
|
71423
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
71424
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
71425
|
+
let baseOptions;
|
|
71426
|
+
if (configuration) {
|
|
71427
|
+
baseOptions = configuration.baseOptions;
|
|
71428
|
+
}
|
|
71429
|
+
|
|
71430
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
71431
|
+
const localVarHeaderParameter = {} as any;
|
|
71432
|
+
const localVarQueryParameter = {} as any;
|
|
71433
|
+
|
|
71434
|
+
// authentication JWT-auth required
|
|
71435
|
+
// http bearer authentication required
|
|
71436
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
71437
|
+
|
|
71438
|
+
|
|
71439
|
+
|
|
71440
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
71441
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
71442
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
71443
|
+
|
|
71444
|
+
return {
|
|
71445
|
+
url: toPathString(localVarUrlObj),
|
|
71446
|
+
options: localVarRequestOptions,
|
|
71447
|
+
};
|
|
71448
|
+
},
|
|
71449
|
+
/**
|
|
71450
|
+
* 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.
|
|
71451
|
+
* @summary List the venue\'s payment terminals, for linking one to a kiosk
|
|
71452
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71453
|
+
* @param {*} [options] Override http request option.
|
|
71454
|
+
* @throws {RequiredError}
|
|
71455
|
+
*/
|
|
71456
|
+
listVenuePaymentTerminals: async (businessId: number, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
71457
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
71458
|
+
assertParamExists('listVenuePaymentTerminals', 'businessId', businessId)
|
|
71459
|
+
const localVarPath = `/api/v2/venues/{businessId}/payment-terminals`
|
|
71460
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)));
|
|
71461
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
71462
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
71463
|
+
let baseOptions;
|
|
71464
|
+
if (configuration) {
|
|
71465
|
+
baseOptions = configuration.baseOptions;
|
|
71466
|
+
}
|
|
71467
|
+
|
|
71468
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
71469
|
+
const localVarHeaderParameter = {} as any;
|
|
71470
|
+
const localVarQueryParameter = {} as any;
|
|
71471
|
+
|
|
71472
|
+
// authentication JWT-auth required
|
|
71473
|
+
// http bearer authentication required
|
|
71474
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
71475
|
+
|
|
71476
|
+
|
|
71477
|
+
|
|
71478
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
71479
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
71480
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
71481
|
+
|
|
71482
|
+
return {
|
|
71483
|
+
url: toPathString(localVarUrlObj),
|
|
71484
|
+
options: localVarRequestOptions,
|
|
71485
|
+
};
|
|
71486
|
+
},
|
|
71487
|
+
/**
|
|
71488
|
+
* 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.
|
|
71489
|
+
* @summary Remove a kiosk from use
|
|
71490
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71491
|
+
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
71492
|
+
* @param {*} [options] Override http request option.
|
|
71493
|
+
* @throws {RequiredError}
|
|
71494
|
+
*/
|
|
71495
|
+
removeVenueKiosk: async (businessId: number, stationId: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
71496
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
71497
|
+
assertParamExists('removeVenueKiosk', 'businessId', businessId)
|
|
71498
|
+
// verify required parameter 'stationId' is not null or undefined
|
|
71499
|
+
assertParamExists('removeVenueKiosk', 'stationId', stationId)
|
|
71500
|
+
const localVarPath = `/api/v2/venues/{businessId}/kiosks/{stationId}`
|
|
71501
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)))
|
|
71502
|
+
.replace(`{${"stationId"}}`, encodeURIComponent(String(stationId)));
|
|
71503
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
71504
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
71505
|
+
let baseOptions;
|
|
71506
|
+
if (configuration) {
|
|
71507
|
+
baseOptions = configuration.baseOptions;
|
|
71508
|
+
}
|
|
71509
|
+
|
|
71510
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
|
|
71511
|
+
const localVarHeaderParameter = {} as any;
|
|
71512
|
+
const localVarQueryParameter = {} as any;
|
|
71513
|
+
|
|
71514
|
+
// authentication JWT-auth required
|
|
71515
|
+
// http bearer authentication required
|
|
71516
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
71517
|
+
|
|
71518
|
+
|
|
71519
|
+
|
|
71520
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
71521
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
71522
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
71523
|
+
|
|
71524
|
+
return {
|
|
71525
|
+
url: toPathString(localVarUrlObj),
|
|
71526
|
+
options: localVarRequestOptions,
|
|
71527
|
+
};
|
|
71528
|
+
},
|
|
71529
|
+
}
|
|
71530
|
+
};
|
|
71531
|
+
|
|
71532
|
+
/**
|
|
71533
|
+
* VenueKiosksApi - functional programming interface
|
|
71534
|
+
* @export
|
|
71535
|
+
*/
|
|
71536
|
+
export const VenueKiosksApiFp = function(configuration?: Configuration) {
|
|
71537
|
+
const localVarAxiosParamCreator = VenueKiosksApiAxiosParamCreator(configuration)
|
|
71538
|
+
return {
|
|
71539
|
+
/**
|
|
71540
|
+
* 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.
|
|
71541
|
+
* @summary Rename a kiosk, change its prefix, or put it in or out of use
|
|
71542
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71543
|
+
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
71544
|
+
* @param {ChangeKioskDto} changeKioskDto
|
|
71545
|
+
* @param {*} [options] Override http request option.
|
|
71546
|
+
* @throws {RequiredError}
|
|
71547
|
+
*/
|
|
71548
|
+
async changeVenueKiosk(businessId: number, stationId: string, changeKioskDto: ChangeKioskDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueKioskDto>> {
|
|
71549
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.changeVenueKiosk(businessId, stationId, changeKioskDto, options);
|
|
71550
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
71551
|
+
},
|
|
71552
|
+
/**
|
|
71553
|
+
* 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.
|
|
71554
|
+
* @summary Link a kiosk to the venue by the Hardware ID it shows
|
|
71555
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71556
|
+
* @param {ClaimKioskDto} claimKioskDto
|
|
71557
|
+
* @param {*} [options] Override http request option.
|
|
71558
|
+
* @throws {RequiredError}
|
|
71559
|
+
*/
|
|
71560
|
+
async claimVenueKiosk(businessId: number, claimKioskDto: ClaimKioskDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueKioskDto>> {
|
|
71561
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.claimVenueKiosk(businessId, claimKioskDto, options);
|
|
71562
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
71563
|
+
},
|
|
71564
|
+
/**
|
|
71565
|
+
* 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.
|
|
71566
|
+
* @summary Link one of the venue\'s payment terminals to a kiosk, or unlink it
|
|
71567
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71568
|
+
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
71569
|
+
* @param {LinkKioskTerminalDto} linkKioskTerminalDto
|
|
71570
|
+
* @param {*} [options] Override http request option.
|
|
71571
|
+
* @throws {RequiredError}
|
|
71572
|
+
*/
|
|
71573
|
+
async linkVenueKioskTerminal(businessId: number, stationId: string, linkKioskTerminalDto: LinkKioskTerminalDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueKioskDto>> {
|
|
71574
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.linkVenueKioskTerminal(businessId, stationId, linkKioskTerminalDto, options);
|
|
71575
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
71576
|
+
},
|
|
71577
|
+
/**
|
|
71578
|
+
* Every kiosk station of the venue, active or removed, oldest first, with its linked payment terminal. Read from the database every time.
|
|
71579
|
+
* @summary List the venue\'s kiosks
|
|
71580
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71581
|
+
* @param {*} [options] Override http request option.
|
|
71582
|
+
* @throws {RequiredError}
|
|
71583
|
+
*/
|
|
71584
|
+
async listVenueKiosks(businessId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueKiosksDto>> {
|
|
71585
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listVenueKiosks(businessId, options);
|
|
71586
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
71587
|
+
},
|
|
71588
|
+
/**
|
|
71589
|
+
* 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.
|
|
71590
|
+
* @summary List the venue\'s payment terminals, for linking one to a kiosk
|
|
71591
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71592
|
+
* @param {*} [options] Override http request option.
|
|
71593
|
+
* @throws {RequiredError}
|
|
71594
|
+
*/
|
|
71595
|
+
async listVenuePaymentTerminals(businessId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenuePaymentTerminalsDto>> {
|
|
71596
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listVenuePaymentTerminals(businessId, options);
|
|
71597
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
71598
|
+
},
|
|
71599
|
+
/**
|
|
71600
|
+
* 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.
|
|
71601
|
+
* @summary Remove a kiosk from use
|
|
71602
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71603
|
+
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
71604
|
+
* @param {*} [options] Override http request option.
|
|
71605
|
+
* @throws {RequiredError}
|
|
71606
|
+
*/
|
|
71607
|
+
async removeVenueKiosk(businessId: number, stationId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueKioskDto>> {
|
|
71608
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.removeVenueKiosk(businessId, stationId, options);
|
|
71609
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
71610
|
+
},
|
|
71611
|
+
}
|
|
71612
|
+
};
|
|
71613
|
+
|
|
71614
|
+
/**
|
|
71615
|
+
* VenueKiosksApi - factory interface
|
|
71616
|
+
* @export
|
|
71617
|
+
*/
|
|
71618
|
+
export const VenueKiosksApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
71619
|
+
const localVarFp = VenueKiosksApiFp(configuration)
|
|
71620
|
+
return {
|
|
71621
|
+
/**
|
|
71622
|
+
* 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.
|
|
71623
|
+
* @summary Rename a kiosk, change its prefix, or put it in or out of use
|
|
71624
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71625
|
+
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
71626
|
+
* @param {ChangeKioskDto} changeKioskDto
|
|
71627
|
+
* @param {*} [options] Override http request option.
|
|
71628
|
+
* @throws {RequiredError}
|
|
71629
|
+
*/
|
|
71630
|
+
changeVenueKiosk(businessId: number, stationId: string, changeKioskDto: ChangeKioskDto, options?: any): AxiosPromise<VenueKioskDto> {
|
|
71631
|
+
return localVarFp.changeVenueKiosk(businessId, stationId, changeKioskDto, options).then((request) => request(axios, basePath));
|
|
71632
|
+
},
|
|
71633
|
+
/**
|
|
71634
|
+
* 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.
|
|
71635
|
+
* @summary Link a kiosk to the venue by the Hardware ID it shows
|
|
71636
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71637
|
+
* @param {ClaimKioskDto} claimKioskDto
|
|
71638
|
+
* @param {*} [options] Override http request option.
|
|
71639
|
+
* @throws {RequiredError}
|
|
71640
|
+
*/
|
|
71641
|
+
claimVenueKiosk(businessId: number, claimKioskDto: ClaimKioskDto, options?: any): AxiosPromise<VenueKioskDto> {
|
|
71642
|
+
return localVarFp.claimVenueKiosk(businessId, claimKioskDto, options).then((request) => request(axios, basePath));
|
|
71643
|
+
},
|
|
71644
|
+
/**
|
|
71645
|
+
* 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.
|
|
71646
|
+
* @summary Link one of the venue\'s payment terminals to a kiosk, or unlink it
|
|
71647
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71648
|
+
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
71649
|
+
* @param {LinkKioskTerminalDto} linkKioskTerminalDto
|
|
71650
|
+
* @param {*} [options] Override http request option.
|
|
71651
|
+
* @throws {RequiredError}
|
|
71652
|
+
*/
|
|
71653
|
+
linkVenueKioskTerminal(businessId: number, stationId: string, linkKioskTerminalDto: LinkKioskTerminalDto, options?: any): AxiosPromise<VenueKioskDto> {
|
|
71654
|
+
return localVarFp.linkVenueKioskTerminal(businessId, stationId, linkKioskTerminalDto, options).then((request) => request(axios, basePath));
|
|
71655
|
+
},
|
|
71656
|
+
/**
|
|
71657
|
+
* Every kiosk station of the venue, active or removed, oldest first, with its linked payment terminal. Read from the database every time.
|
|
71658
|
+
* @summary List the venue\'s kiosks
|
|
71659
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71660
|
+
* @param {*} [options] Override http request option.
|
|
71661
|
+
* @throws {RequiredError}
|
|
71662
|
+
*/
|
|
71663
|
+
listVenueKiosks(businessId: number, options?: any): AxiosPromise<VenueKiosksDto> {
|
|
71664
|
+
return localVarFp.listVenueKiosks(businessId, options).then((request) => request(axios, basePath));
|
|
71665
|
+
},
|
|
71666
|
+
/**
|
|
71667
|
+
* 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.
|
|
71668
|
+
* @summary List the venue\'s payment terminals, for linking one to a kiosk
|
|
71669
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71670
|
+
* @param {*} [options] Override http request option.
|
|
71671
|
+
* @throws {RequiredError}
|
|
71672
|
+
*/
|
|
71673
|
+
listVenuePaymentTerminals(businessId: number, options?: any): AxiosPromise<VenuePaymentTerminalsDto> {
|
|
71674
|
+
return localVarFp.listVenuePaymentTerminals(businessId, options).then((request) => request(axios, basePath));
|
|
71675
|
+
},
|
|
71676
|
+
/**
|
|
71677
|
+
* 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.
|
|
71678
|
+
* @summary Remove a kiosk from use
|
|
71679
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71680
|
+
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
71681
|
+
* @param {*} [options] Override http request option.
|
|
71682
|
+
* @throws {RequiredError}
|
|
71683
|
+
*/
|
|
71684
|
+
removeVenueKiosk(businessId: number, stationId: string, options?: any): AxiosPromise<VenueKioskDto> {
|
|
71685
|
+
return localVarFp.removeVenueKiosk(businessId, stationId, options).then((request) => request(axios, basePath));
|
|
71686
|
+
},
|
|
71687
|
+
};
|
|
71688
|
+
};
|
|
71689
|
+
|
|
71690
|
+
/**
|
|
71691
|
+
* VenueKiosksApi - interface
|
|
71692
|
+
* @export
|
|
71693
|
+
* @interface VenueKiosksApi
|
|
71694
|
+
*/
|
|
71695
|
+
export interface VenueKiosksApiInterface {
|
|
71696
|
+
/**
|
|
71697
|
+
* 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.
|
|
71698
|
+
* @summary Rename a kiosk, change its prefix, or put it in or out of use
|
|
71699
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71700
|
+
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
71701
|
+
* @param {ChangeKioskDto} changeKioskDto
|
|
71702
|
+
* @param {*} [options] Override http request option.
|
|
71703
|
+
* @throws {RequiredError}
|
|
71704
|
+
* @memberof VenueKiosksApiInterface
|
|
71705
|
+
*/
|
|
71706
|
+
changeVenueKiosk(businessId: number, stationId: string, changeKioskDto: ChangeKioskDto, options?: AxiosRequestConfig): AxiosPromise<VenueKioskDto>;
|
|
71707
|
+
|
|
71708
|
+
/**
|
|
71709
|
+
* 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.
|
|
71710
|
+
* @summary Link a kiosk to the venue by the Hardware ID it shows
|
|
71711
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71712
|
+
* @param {ClaimKioskDto} claimKioskDto
|
|
71713
|
+
* @param {*} [options] Override http request option.
|
|
71714
|
+
* @throws {RequiredError}
|
|
71715
|
+
* @memberof VenueKiosksApiInterface
|
|
71716
|
+
*/
|
|
71717
|
+
claimVenueKiosk(businessId: number, claimKioskDto: ClaimKioskDto, options?: AxiosRequestConfig): AxiosPromise<VenueKioskDto>;
|
|
71718
|
+
|
|
71719
|
+
/**
|
|
71720
|
+
* 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.
|
|
71721
|
+
* @summary Link one of the venue\'s payment terminals to a kiosk, or unlink it
|
|
71722
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71723
|
+
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
71724
|
+
* @param {LinkKioskTerminalDto} linkKioskTerminalDto
|
|
71725
|
+
* @param {*} [options] Override http request option.
|
|
71726
|
+
* @throws {RequiredError}
|
|
71727
|
+
* @memberof VenueKiosksApiInterface
|
|
71728
|
+
*/
|
|
71729
|
+
linkVenueKioskTerminal(businessId: number, stationId: string, linkKioskTerminalDto: LinkKioskTerminalDto, options?: AxiosRequestConfig): AxiosPromise<VenueKioskDto>;
|
|
71730
|
+
|
|
71731
|
+
/**
|
|
71732
|
+
* Every kiosk station of the venue, active or removed, oldest first, with its linked payment terminal. Read from the database every time.
|
|
71733
|
+
* @summary List the venue\'s kiosks
|
|
71734
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71735
|
+
* @param {*} [options] Override http request option.
|
|
71736
|
+
* @throws {RequiredError}
|
|
71737
|
+
* @memberof VenueKiosksApiInterface
|
|
71738
|
+
*/
|
|
71739
|
+
listVenueKiosks(businessId: number, options?: AxiosRequestConfig): AxiosPromise<VenueKiosksDto>;
|
|
71740
|
+
|
|
71741
|
+
/**
|
|
71742
|
+
* 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.
|
|
71743
|
+
* @summary List the venue\'s payment terminals, for linking one to a kiosk
|
|
71744
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71745
|
+
* @param {*} [options] Override http request option.
|
|
71746
|
+
* @throws {RequiredError}
|
|
71747
|
+
* @memberof VenueKiosksApiInterface
|
|
71748
|
+
*/
|
|
71749
|
+
listVenuePaymentTerminals(businessId: number, options?: AxiosRequestConfig): AxiosPromise<VenuePaymentTerminalsDto>;
|
|
71750
|
+
|
|
71751
|
+
/**
|
|
71752
|
+
* 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.
|
|
71753
|
+
* @summary Remove a kiosk from use
|
|
71754
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71755
|
+
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
71756
|
+
* @param {*} [options] Override http request option.
|
|
71757
|
+
* @throws {RequiredError}
|
|
71758
|
+
* @memberof VenueKiosksApiInterface
|
|
71759
|
+
*/
|
|
71760
|
+
removeVenueKiosk(businessId: number, stationId: string, options?: AxiosRequestConfig): AxiosPromise<VenueKioskDto>;
|
|
71761
|
+
|
|
71762
|
+
}
|
|
71763
|
+
|
|
71764
|
+
/**
|
|
71765
|
+
* VenueKiosksApi - object-oriented interface
|
|
71766
|
+
* @export
|
|
71767
|
+
* @class VenueKiosksApi
|
|
71768
|
+
* @extends {BaseAPI}
|
|
71769
|
+
*/
|
|
71770
|
+
export class VenueKiosksApi extends BaseAPI implements VenueKiosksApiInterface {
|
|
71771
|
+
/**
|
|
71772
|
+
* 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.
|
|
71773
|
+
* @summary Rename a kiosk, change its prefix, or put it in or out of use
|
|
71774
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71775
|
+
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
71776
|
+
* @param {ChangeKioskDto} changeKioskDto
|
|
71777
|
+
* @param {*} [options] Override http request option.
|
|
71778
|
+
* @throws {RequiredError}
|
|
71779
|
+
* @memberof VenueKiosksApi
|
|
71780
|
+
*/
|
|
71781
|
+
public changeVenueKiosk(businessId: number, stationId: string, changeKioskDto: ChangeKioskDto, options?: AxiosRequestConfig) {
|
|
71782
|
+
return VenueKiosksApiFp(this.configuration).changeVenueKiosk(businessId, stationId, changeKioskDto, options).then((request) => request(this.axios, this.basePath));
|
|
71783
|
+
}
|
|
71784
|
+
|
|
71785
|
+
/**
|
|
71786
|
+
* 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.
|
|
71787
|
+
* @summary Link a kiosk to the venue by the Hardware ID it shows
|
|
71788
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71789
|
+
* @param {ClaimKioskDto} claimKioskDto
|
|
71790
|
+
* @param {*} [options] Override http request option.
|
|
71791
|
+
* @throws {RequiredError}
|
|
71792
|
+
* @memberof VenueKiosksApi
|
|
71793
|
+
*/
|
|
71794
|
+
public claimVenueKiosk(businessId: number, claimKioskDto: ClaimKioskDto, options?: AxiosRequestConfig) {
|
|
71795
|
+
return VenueKiosksApiFp(this.configuration).claimVenueKiosk(businessId, claimKioskDto, options).then((request) => request(this.axios, this.basePath));
|
|
71796
|
+
}
|
|
71797
|
+
|
|
71798
|
+
/**
|
|
71799
|
+
* 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.
|
|
71800
|
+
* @summary Link one of the venue\'s payment terminals to a kiosk, or unlink it
|
|
71801
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71802
|
+
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
71803
|
+
* @param {LinkKioskTerminalDto} linkKioskTerminalDto
|
|
71804
|
+
* @param {*} [options] Override http request option.
|
|
71805
|
+
* @throws {RequiredError}
|
|
71806
|
+
* @memberof VenueKiosksApi
|
|
71807
|
+
*/
|
|
71808
|
+
public linkVenueKioskTerminal(businessId: number, stationId: string, linkKioskTerminalDto: LinkKioskTerminalDto, options?: AxiosRequestConfig) {
|
|
71809
|
+
return VenueKiosksApiFp(this.configuration).linkVenueKioskTerminal(businessId, stationId, linkKioskTerminalDto, options).then((request) => request(this.axios, this.basePath));
|
|
71810
|
+
}
|
|
71811
|
+
|
|
71812
|
+
/**
|
|
71813
|
+
* Every kiosk station of the venue, active or removed, oldest first, with its linked payment terminal. Read from the database every time.
|
|
71814
|
+
* @summary List the venue\'s kiosks
|
|
71815
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71816
|
+
* @param {*} [options] Override http request option.
|
|
71817
|
+
* @throws {RequiredError}
|
|
71818
|
+
* @memberof VenueKiosksApi
|
|
71819
|
+
*/
|
|
71820
|
+
public listVenueKiosks(businessId: number, options?: AxiosRequestConfig) {
|
|
71821
|
+
return VenueKiosksApiFp(this.configuration).listVenueKiosks(businessId, options).then((request) => request(this.axios, this.basePath));
|
|
71822
|
+
}
|
|
71823
|
+
|
|
71824
|
+
/**
|
|
71825
|
+
* 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.
|
|
71826
|
+
* @summary List the venue\'s payment terminals, for linking one to a kiosk
|
|
71827
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71828
|
+
* @param {*} [options] Override http request option.
|
|
71829
|
+
* @throws {RequiredError}
|
|
71830
|
+
* @memberof VenueKiosksApi
|
|
71831
|
+
*/
|
|
71832
|
+
public listVenuePaymentTerminals(businessId: number, options?: AxiosRequestConfig) {
|
|
71833
|
+
return VenueKiosksApiFp(this.configuration).listVenuePaymentTerminals(businessId, options).then((request) => request(this.axios, this.basePath));
|
|
71834
|
+
}
|
|
71835
|
+
|
|
71836
|
+
/**
|
|
71837
|
+
* 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.
|
|
71838
|
+
* @summary Remove a kiosk from use
|
|
71839
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71840
|
+
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
71841
|
+
* @param {*} [options] Override http request option.
|
|
71842
|
+
* @throws {RequiredError}
|
|
71843
|
+
* @memberof VenueKiosksApi
|
|
71844
|
+
*/
|
|
71845
|
+
public removeVenueKiosk(businessId: number, stationId: string, options?: AxiosRequestConfig) {
|
|
71846
|
+
return VenueKiosksApiFp(this.configuration).removeVenueKiosk(businessId, stationId, options).then((request) => request(this.axios, this.basePath));
|
|
71847
|
+
}
|
|
71848
|
+
}
|
|
71849
|
+
|
|
71850
|
+
|
|
70168
71851
|
/**
|
|
70169
71852
|
* VivaApi - axios parameter creator
|
|
70170
71853
|
* @export
|