@munchi_oy/core 2.4.0 → 2.6.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 +683 -9
- 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 +1005 -9
- package/package.json +13 -15
- package/src/version.ts +1 -1
package/dist/generated/api.d.ts
CHANGED
|
@@ -2572,6 +2572,31 @@ export interface ChangeEmployeeRoleDto {
|
|
|
2572
2572
|
*/
|
|
2573
2573
|
'permissionKeys'?: Array<PosPermission>;
|
|
2574
2574
|
}
|
|
2575
|
+
/**
|
|
2576
|
+
*
|
|
2577
|
+
* @export
|
|
2578
|
+
* @interface ChangeKioskDto
|
|
2579
|
+
*/
|
|
2580
|
+
export interface ChangeKioskDto {
|
|
2581
|
+
/**
|
|
2582
|
+
* The kiosk\'s new name; left out, it keeps its name
|
|
2583
|
+
* @type {string}
|
|
2584
|
+
* @memberof ChangeKioskDto
|
|
2585
|
+
*/
|
|
2586
|
+
'name'?: string;
|
|
2587
|
+
/**
|
|
2588
|
+
* What the kiosk\'s order numbers start with, an empty text for none; left out, it keeps its prefix
|
|
2589
|
+
* @type {string}
|
|
2590
|
+
* @memberof ChangeKioskDto
|
|
2591
|
+
*/
|
|
2592
|
+
'prefix'?: string;
|
|
2593
|
+
/**
|
|
2594
|
+
*
|
|
2595
|
+
* @type {Status}
|
|
2596
|
+
* @memberof ChangeKioskDto
|
|
2597
|
+
*/
|
|
2598
|
+
'status'?: Status;
|
|
2599
|
+
}
|
|
2575
2600
|
/**
|
|
2576
2601
|
*
|
|
2577
2602
|
* @export
|
|
@@ -3025,6 +3050,31 @@ export declare const CheckoutModelEnum: {
|
|
|
3025
3050
|
readonly Full: "FULL";
|
|
3026
3051
|
};
|
|
3027
3052
|
export type CheckoutModelEnum = typeof CheckoutModelEnum[keyof typeof CheckoutModelEnum];
|
|
3053
|
+
/**
|
|
3054
|
+
*
|
|
3055
|
+
* @export
|
|
3056
|
+
* @interface ClaimKioskDto
|
|
3057
|
+
*/
|
|
3058
|
+
export interface ClaimKioskDto {
|
|
3059
|
+
/**
|
|
3060
|
+
* The Hardware ID the kiosk shows on its Getting started screen, exactly as shown; it is the id the device sends in X-Munchi-Hardware-Id
|
|
3061
|
+
* @type {string}
|
|
3062
|
+
* @memberof ClaimKioskDto
|
|
3063
|
+
*/
|
|
3064
|
+
'hardwareId': string;
|
|
3065
|
+
/**
|
|
3066
|
+
* The kiosk\'s name, as the venue\'s staff call it
|
|
3067
|
+
* @type {string}
|
|
3068
|
+
* @memberof ClaimKioskDto
|
|
3069
|
+
*/
|
|
3070
|
+
'name': string;
|
|
3071
|
+
/**
|
|
3072
|
+
* What the kiosk\'s order numbers start with. Left out, a new kiosk has none and a kiosk the venue had keeps its own
|
|
3073
|
+
* @type {string}
|
|
3074
|
+
* @memberof ClaimKioskDto
|
|
3075
|
+
*/
|
|
3076
|
+
'prefix'?: string;
|
|
3077
|
+
}
|
|
3028
3078
|
/**
|
|
3029
3079
|
*
|
|
3030
3080
|
* @export
|
|
@@ -4952,6 +5002,12 @@ export interface CreateSavedReportDto {
|
|
|
4952
5002
|
* @memberof CreateSavedReportDto
|
|
4953
5003
|
*/
|
|
4954
5004
|
'filters': SavedReportDtoFilters;
|
|
5005
|
+
/**
|
|
5006
|
+
*
|
|
5007
|
+
* @type {ReadyMadeReport}
|
|
5008
|
+
* @memberof CreateSavedReportDto
|
|
5009
|
+
*/
|
|
5010
|
+
'readyMadeReport'?: ReadyMadeReport | null;
|
|
4955
5011
|
/**
|
|
4956
5012
|
*
|
|
4957
5013
|
* @type {SavedReportVisibility}
|
|
@@ -11026,6 +11082,31 @@ export interface KioskStatusDto {
|
|
|
11026
11082
|
*/
|
|
11027
11083
|
'payment_event': PaymentEventType;
|
|
11028
11084
|
}
|
|
11085
|
+
/**
|
|
11086
|
+
*
|
|
11087
|
+
* @export
|
|
11088
|
+
* @interface KioskTerminalDto
|
|
11089
|
+
*/
|
|
11090
|
+
export interface KioskTerminalDto {
|
|
11091
|
+
/**
|
|
11092
|
+
* The payment terminal\'s id
|
|
11093
|
+
* @type {string}
|
|
11094
|
+
* @memberof KioskTerminalDto
|
|
11095
|
+
*/
|
|
11096
|
+
'id': string;
|
|
11097
|
+
/**
|
|
11098
|
+
*
|
|
11099
|
+
* @type {PaymentProvider}
|
|
11100
|
+
* @memberof KioskTerminalDto
|
|
11101
|
+
*/
|
|
11102
|
+
'provider': PaymentProvider;
|
|
11103
|
+
/**
|
|
11104
|
+
* The terminal\'s label; null when it was given none
|
|
11105
|
+
* @type {string}
|
|
11106
|
+
* @memberof KioskTerminalDto
|
|
11107
|
+
*/
|
|
11108
|
+
'label': string | null;
|
|
11109
|
+
}
|
|
11029
11110
|
/**
|
|
11030
11111
|
*
|
|
11031
11112
|
* @export
|
|
@@ -11152,6 +11233,19 @@ export interface LapseResponseDto {
|
|
|
11152
11233
|
*/
|
|
11153
11234
|
'businessDayScheduleId': string;
|
|
11154
11235
|
}
|
|
11236
|
+
/**
|
|
11237
|
+
*
|
|
11238
|
+
* @export
|
|
11239
|
+
* @interface LinkKioskTerminalDto
|
|
11240
|
+
*/
|
|
11241
|
+
export interface LinkKioskTerminalDto {
|
|
11242
|
+
/**
|
|
11243
|
+
* 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
|
|
11244
|
+
* @type {string}
|
|
11245
|
+
* @memberof LinkKioskTerminalDto
|
|
11246
|
+
*/
|
|
11247
|
+
'paymentTerminalId': string | null;
|
|
11248
|
+
}
|
|
11155
11249
|
/**
|
|
11156
11250
|
*
|
|
11157
11251
|
* @export
|
|
@@ -14328,7 +14422,7 @@ export interface OrderHistoryPosResponseDtoV2Pagination {
|
|
|
14328
14422
|
*/
|
|
14329
14423
|
export interface OrderHistoryPosResponseDtoV2Summary {
|
|
14330
14424
|
/**
|
|
14331
|
-
* How many orders of the period count: online, every order
|
|
14425
|
+
* How many orders of the period count: online, every order neither rejected nor fully refunded; POS, every order not fully refunded (with a payment filter, only those with a matching payment). 0 when the person on the till may not see it.
|
|
14332
14426
|
* @type {number}
|
|
14333
14427
|
* @memberof OrderHistoryPosResponseDtoV2Summary
|
|
14334
14428
|
*/
|
|
@@ -14340,7 +14434,7 @@ export interface OrderHistoryPosResponseDtoV2Summary {
|
|
|
14340
14434
|
*/
|
|
14341
14435
|
'rejectedOrders': number;
|
|
14342
14436
|
/**
|
|
14343
|
-
* The period\'s sales in euros (not cents): online, the net total of the orders
|
|
14437
|
+
* The period\'s sales in euros (not cents): online, the net total of the orders neither rejected nor fully refunded, less their completed refunds; POS, the payments less successful refunds. 0 when the person on the till may not see it.
|
|
14344
14438
|
* @type {number}
|
|
14345
14439
|
* @memberof OrderHistoryPosResponseDtoV2Summary
|
|
14346
14440
|
*/
|
|
@@ -14398,7 +14492,7 @@ export interface OrderHistoryResponseDto {
|
|
|
14398
14492
|
*/
|
|
14399
14493
|
export interface OrderHistoryResponseDtoSummary {
|
|
14400
14494
|
/**
|
|
14401
|
-
* How many orders of the period count: online, every order
|
|
14495
|
+
* How many orders of the period count: online, every order neither rejected nor fully refunded; POS, every order not fully refunded (with a payment filter, only those with a matching payment). 0 when the person on the till may not see it.
|
|
14402
14496
|
* @type {number}
|
|
14403
14497
|
* @memberof OrderHistoryResponseDtoSummary
|
|
14404
14498
|
*/
|
|
@@ -14410,7 +14504,7 @@ export interface OrderHistoryResponseDtoSummary {
|
|
|
14410
14504
|
*/
|
|
14411
14505
|
'rejectedOrders': number;
|
|
14412
14506
|
/**
|
|
14413
|
-
* The period\'s sales in euros (not cents): online, the net total of the orders
|
|
14507
|
+
* The period\'s sales in euros (not cents): online, the net total of the orders neither rejected nor fully refunded, less their completed refunds; POS, the payments less successful refunds. 0 when the person on the till may not see it.
|
|
14414
14508
|
* @type {number}
|
|
14415
14509
|
* @memberof OrderHistoryResponseDtoSummary
|
|
14416
14510
|
*/
|
|
@@ -15408,7 +15502,7 @@ export interface OrderStatusResponseDtoOrder {
|
|
|
15408
15502
|
*/
|
|
15409
15503
|
export interface OrderSummaryDto {
|
|
15410
15504
|
/**
|
|
15411
|
-
* How many orders of the period count: online, every order
|
|
15505
|
+
* How many orders of the period count: online, every order neither rejected nor fully refunded; POS, every order not fully refunded (with a payment filter, only those with a matching payment). 0 when the person on the till may not see it.
|
|
15412
15506
|
* @type {number}
|
|
15413
15507
|
* @memberof OrderSummaryDto
|
|
15414
15508
|
*/
|
|
@@ -15420,7 +15514,7 @@ export interface OrderSummaryDto {
|
|
|
15420
15514
|
*/
|
|
15421
15515
|
'rejectedOrders': number;
|
|
15422
15516
|
/**
|
|
15423
|
-
* The period\'s sales in euros (not cents): online, the net total of the orders
|
|
15517
|
+
* The period\'s sales in euros (not cents): online, the net total of the orders neither rejected nor fully refunded, less their completed refunds; POS, the payments less successful refunds. 0 when the person on the till may not see it.
|
|
15424
15518
|
* @type {number}
|
|
15425
15519
|
* @memberof OrderSummaryDto
|
|
15426
15520
|
*/
|
|
@@ -21159,7 +21253,7 @@ export interface PosOrderSuboptionDto {
|
|
|
21159
21253
|
*/
|
|
21160
21254
|
export interface PosOrderSummaryDto {
|
|
21161
21255
|
/**
|
|
21162
|
-
* How many orders of the period count: online, every order
|
|
21256
|
+
* How many orders of the period count: online, every order neither rejected nor fully refunded; POS, every order not fully refunded (with a payment filter, only those with a matching payment). 0 when the person on the till may not see it.
|
|
21163
21257
|
* @type {number}
|
|
21164
21258
|
* @memberof PosOrderSummaryDto
|
|
21165
21259
|
*/
|
|
@@ -21171,7 +21265,7 @@ export interface PosOrderSummaryDto {
|
|
|
21171
21265
|
*/
|
|
21172
21266
|
'rejectedOrders': number;
|
|
21173
21267
|
/**
|
|
21174
|
-
* The period\'s sales in euros (not cents): online, the net total of the orders
|
|
21268
|
+
* The period\'s sales in euros (not cents): online, the net total of the orders neither rejected nor fully refunded, less their completed refunds; POS, the payments less successful refunds. 0 when the person on the till may not see it.
|
|
21175
21269
|
* @type {number}
|
|
21176
21270
|
* @memberof PosOrderSummaryDto
|
|
21177
21271
|
*/
|
|
@@ -24115,6 +24209,12 @@ export interface PublicSavedReportDto {
|
|
|
24115
24209
|
* @memberof PublicSavedReportDto
|
|
24116
24210
|
*/
|
|
24117
24211
|
'filters': SavedReportDtoFilters;
|
|
24212
|
+
/**
|
|
24213
|
+
*
|
|
24214
|
+
* @type {ReadyMadeReport}
|
|
24215
|
+
* @memberof PublicSavedReportDto
|
|
24216
|
+
*/
|
|
24217
|
+
'readyMadeReport'?: ReadyMadeReport | null;
|
|
24118
24218
|
/**
|
|
24119
24219
|
* The store whose data the report reads, by orderingBusinessId; null for an organisation\'s
|
|
24120
24220
|
* @type {number}
|
|
@@ -28538,6 +28638,12 @@ export interface SalesReportStaffMemberDto {
|
|
|
28538
28638
|
* @memberof SalesReportStaffMemberDto
|
|
28539
28639
|
*/
|
|
28540
28640
|
'staffId': string;
|
|
28641
|
+
/**
|
|
28642
|
+
* The staff member\'s name; null for the orders that name nobody, or a person who left the venue
|
|
28643
|
+
* @type {string}
|
|
28644
|
+
* @memberof SalesReportStaffMemberDto
|
|
28645
|
+
*/
|
|
28646
|
+
'staffName': string | null;
|
|
28541
28647
|
/**
|
|
28542
28648
|
* Orders not refunded, or refunded in part (the POS app\'s totalOrders)
|
|
28543
28649
|
* @type {number}
|
|
@@ -28938,6 +29044,12 @@ export interface SavedReportDto {
|
|
|
28938
29044
|
* @memberof SavedReportDto
|
|
28939
29045
|
*/
|
|
28940
29046
|
'filters': SavedReportDtoFilters;
|
|
29047
|
+
/**
|
|
29048
|
+
*
|
|
29049
|
+
* @type {ReadyMadeReport}
|
|
29050
|
+
* @memberof SavedReportDto
|
|
29051
|
+
*/
|
|
29052
|
+
'readyMadeReport'?: ReadyMadeReport | null;
|
|
28941
29053
|
/**
|
|
28942
29054
|
* The report\'s id
|
|
28943
29055
|
* @type {string}
|
|
@@ -34455,6 +34567,12 @@ export interface UpdateSavedReportDto {
|
|
|
34455
34567
|
* @memberof UpdateSavedReportDto
|
|
34456
34568
|
*/
|
|
34457
34569
|
'filters': SavedReportDtoFilters;
|
|
34570
|
+
/**
|
|
34571
|
+
*
|
|
34572
|
+
* @type {ReadyMadeReport}
|
|
34573
|
+
* @memberof UpdateSavedReportDto
|
|
34574
|
+
*/
|
|
34575
|
+
'readyMadeReport'?: ReadyMadeReport | null;
|
|
34458
34576
|
/**
|
|
34459
34577
|
* The version the report was read at; answered 409 when someone saved it since
|
|
34460
34578
|
* @type {number}
|
|
@@ -34727,6 +34845,18 @@ export interface UpsertConfigDto {
|
|
|
34727
34845
|
* @memberof UpsertConfigDto
|
|
34728
34846
|
*/
|
|
34729
34847
|
'productDetailLayout'?: ProductDetailLayout;
|
|
34848
|
+
/**
|
|
34849
|
+
*
|
|
34850
|
+
* @type {KioskLayout}
|
|
34851
|
+
* @memberof UpsertConfigDto
|
|
34852
|
+
*/
|
|
34853
|
+
'layout'?: KioskLayout;
|
|
34854
|
+
/**
|
|
34855
|
+
*
|
|
34856
|
+
* @type {UpsellMode}
|
|
34857
|
+
* @memberof UpsertConfigDto
|
|
34858
|
+
*/
|
|
34859
|
+
'upsellMode'?: UpsellMode;
|
|
34730
34860
|
/**
|
|
34731
34861
|
* Whether the kiosk prints the receipt without asking. Absent keeps the stored value.
|
|
34732
34862
|
* @type {boolean}
|
|
@@ -35641,6 +35771,99 @@ export interface VenueFoundDto {
|
|
|
35641
35771
|
*/
|
|
35642
35772
|
'chainId': string | null;
|
|
35643
35773
|
}
|
|
35774
|
+
/**
|
|
35775
|
+
*
|
|
35776
|
+
* @export
|
|
35777
|
+
* @interface VenueKioskDto
|
|
35778
|
+
*/
|
|
35779
|
+
export interface VenueKioskDto {
|
|
35780
|
+
/**
|
|
35781
|
+
* The kiosk\'s station id
|
|
35782
|
+
* @type {string}
|
|
35783
|
+
* @memberof VenueKioskDto
|
|
35784
|
+
*/
|
|
35785
|
+
'id': string;
|
|
35786
|
+
/**
|
|
35787
|
+
* The kiosk\'s name
|
|
35788
|
+
* @type {string}
|
|
35789
|
+
* @memberof VenueKioskDto
|
|
35790
|
+
*/
|
|
35791
|
+
'name': string;
|
|
35792
|
+
/**
|
|
35793
|
+
* What the kiosk\'s order numbers start with; empty for none
|
|
35794
|
+
* @type {string}
|
|
35795
|
+
* @memberof VenueKioskDto
|
|
35796
|
+
*/
|
|
35797
|
+
'prefix': string;
|
|
35798
|
+
/**
|
|
35799
|
+
* The device\'s Hardware ID, as it shows it
|
|
35800
|
+
* @type {string}
|
|
35801
|
+
* @memberof VenueKioskDto
|
|
35802
|
+
*/
|
|
35803
|
+
'hardwareId': string;
|
|
35804
|
+
/**
|
|
35805
|
+
*
|
|
35806
|
+
* @type {Status}
|
|
35807
|
+
* @memberof VenueKioskDto
|
|
35808
|
+
*/
|
|
35809
|
+
'status': Status;
|
|
35810
|
+
/**
|
|
35811
|
+
*
|
|
35812
|
+
* @type {VenueKioskDtoTerminal}
|
|
35813
|
+
* @memberof VenueKioskDto
|
|
35814
|
+
*/
|
|
35815
|
+
'terminal': VenueKioskDtoTerminal | null;
|
|
35816
|
+
/**
|
|
35817
|
+
* When the kiosk was first linked to the venue, ISO 8601
|
|
35818
|
+
* @type {string}
|
|
35819
|
+
* @memberof VenueKioskDto
|
|
35820
|
+
*/
|
|
35821
|
+
'createdAt': string;
|
|
35822
|
+
/**
|
|
35823
|
+
* When the kiosk last changed, ISO 8601
|
|
35824
|
+
* @type {string}
|
|
35825
|
+
* @memberof VenueKioskDto
|
|
35826
|
+
*/
|
|
35827
|
+
'updatedAt': string;
|
|
35828
|
+
}
|
|
35829
|
+
/**
|
|
35830
|
+
* The payment terminal linked to the kiosk; null when it has none
|
|
35831
|
+
* @export
|
|
35832
|
+
* @interface VenueKioskDtoTerminal
|
|
35833
|
+
*/
|
|
35834
|
+
export interface VenueKioskDtoTerminal {
|
|
35835
|
+
/**
|
|
35836
|
+
* The payment terminal\'s id
|
|
35837
|
+
* @type {string}
|
|
35838
|
+
* @memberof VenueKioskDtoTerminal
|
|
35839
|
+
*/
|
|
35840
|
+
'id': string;
|
|
35841
|
+
/**
|
|
35842
|
+
*
|
|
35843
|
+
* @type {PaymentProvider}
|
|
35844
|
+
* @memberof VenueKioskDtoTerminal
|
|
35845
|
+
*/
|
|
35846
|
+
'provider': PaymentProvider;
|
|
35847
|
+
/**
|
|
35848
|
+
* The terminal\'s label; null when it was given none
|
|
35849
|
+
* @type {string}
|
|
35850
|
+
* @memberof VenueKioskDtoTerminal
|
|
35851
|
+
*/
|
|
35852
|
+
'label': string | null;
|
|
35853
|
+
}
|
|
35854
|
+
/**
|
|
35855
|
+
*
|
|
35856
|
+
* @export
|
|
35857
|
+
* @interface VenueKiosksDto
|
|
35858
|
+
*/
|
|
35859
|
+
export interface VenueKiosksDto {
|
|
35860
|
+
/**
|
|
35861
|
+
* The venue\'s kiosks, active and inactive, oldest first
|
|
35862
|
+
* @type {Array<VenueKioskDto>}
|
|
35863
|
+
* @memberof VenueKiosksDto
|
|
35864
|
+
*/
|
|
35865
|
+
'kiosks': Array<VenueKioskDto>;
|
|
35866
|
+
}
|
|
35644
35867
|
/**
|
|
35645
35868
|
*
|
|
35646
35869
|
* @export
|
|
@@ -35660,6 +35883,56 @@ export interface VenueListEntryDto {
|
|
|
35660
35883
|
*/
|
|
35661
35884
|
'businessName': string;
|
|
35662
35885
|
}
|
|
35886
|
+
/**
|
|
35887
|
+
*
|
|
35888
|
+
* @export
|
|
35889
|
+
* @interface VenuePaymentTerminalDto
|
|
35890
|
+
*/
|
|
35891
|
+
export interface VenuePaymentTerminalDto {
|
|
35892
|
+
/**
|
|
35893
|
+
* The payment terminal\'s id, the one a kiosk is linked to
|
|
35894
|
+
* @type {string}
|
|
35895
|
+
* @memberof VenuePaymentTerminalDto
|
|
35896
|
+
*/
|
|
35897
|
+
'id': string;
|
|
35898
|
+
/**
|
|
35899
|
+
*
|
|
35900
|
+
* @type {PaymentProvider}
|
|
35901
|
+
* @memberof VenuePaymentTerminalDto
|
|
35902
|
+
*/
|
|
35903
|
+
'provider': PaymentProvider;
|
|
35904
|
+
/**
|
|
35905
|
+
* The terminal\'s label; null when it was given none
|
|
35906
|
+
* @type {string}
|
|
35907
|
+
* @memberof VenuePaymentTerminalDto
|
|
35908
|
+
*/
|
|
35909
|
+
'label': string | null;
|
|
35910
|
+
/**
|
|
35911
|
+
* The terminal\'s own id at its provider, as printed on the device
|
|
35912
|
+
* @type {string}
|
|
35913
|
+
* @memberof VenuePaymentTerminalDto
|
|
35914
|
+
*/
|
|
35915
|
+
'hardwareId': string;
|
|
35916
|
+
/**
|
|
35917
|
+
* The id of the station, a kiosk\'s or a till\'s, the terminal is linked to; null when it is free
|
|
35918
|
+
* @type {string}
|
|
35919
|
+
* @memberof VenuePaymentTerminalDto
|
|
35920
|
+
*/
|
|
35921
|
+
'stationId': string | null;
|
|
35922
|
+
}
|
|
35923
|
+
/**
|
|
35924
|
+
*
|
|
35925
|
+
* @export
|
|
35926
|
+
* @interface VenuePaymentTerminalsDto
|
|
35927
|
+
*/
|
|
35928
|
+
export interface VenuePaymentTerminalsDto {
|
|
35929
|
+
/**
|
|
35930
|
+
* The venue\'s payment terminals as stored, oldest first; a terminal is stored once a till has discovered it
|
|
35931
|
+
* @type {Array<VenuePaymentTerminalDto>}
|
|
35932
|
+
* @memberof VenuePaymentTerminalsDto
|
|
35933
|
+
*/
|
|
35934
|
+
'terminals': Array<VenuePaymentTerminalDto>;
|
|
35935
|
+
}
|
|
35663
35936
|
/**
|
|
35664
35937
|
*
|
|
35665
35938
|
* @export
|
|
@@ -35764,7 +36037,7 @@ export interface VenueProviderOutcomeDto {
|
|
|
35764
36037
|
*/
|
|
35765
36038
|
'rowsChanged': number;
|
|
35766
36039
|
/**
|
|
35767
|
-
* Whether the channel is on, as its row reads after the change: the first active row, else the
|
|
36040
|
+
* 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
|
|
35768
36041
|
* @type {boolean}
|
|
35769
36042
|
* @memberof VenueProviderOutcomeDto
|
|
35770
36043
|
*/
|
|
@@ -35782,6 +36055,50 @@ export interface VenueProviderOutcomeDto {
|
|
|
35782
36055
|
*/
|
|
35783
36056
|
'integrations': Array<IntegrationType>;
|
|
35784
36057
|
}
|
|
36058
|
+
/**
|
|
36059
|
+
*
|
|
36060
|
+
* @export
|
|
36061
|
+
* @interface VenueProviderStateDto
|
|
36062
|
+
*/
|
|
36063
|
+
export interface VenueProviderStateDto {
|
|
36064
|
+
/**
|
|
36065
|
+
*
|
|
36066
|
+
* @type {ProviderEnum}
|
|
36067
|
+
* @memberof VenueProviderStateDto
|
|
36068
|
+
*/
|
|
36069
|
+
'channel': ProviderEnum;
|
|
36070
|
+
/**
|
|
36071
|
+
* Whether the channel is on, as its row reads: the first active row, else the newest row, by createdAt and then id
|
|
36072
|
+
* @type {boolean}
|
|
36073
|
+
* @memberof VenueProviderStateDto
|
|
36074
|
+
*/
|
|
36075
|
+
'isActive': boolean;
|
|
36076
|
+
/**
|
|
36077
|
+
* Whether the channel\'s orders are accepted without the till, as the same row reads
|
|
36078
|
+
* @type {boolean}
|
|
36079
|
+
* @memberof VenueProviderStateDto
|
|
36080
|
+
*/
|
|
36081
|
+
'autoAccept': boolean;
|
|
36082
|
+
/**
|
|
36083
|
+
* The integrations the same row takes
|
|
36084
|
+
* @type {Array<IntegrationType>}
|
|
36085
|
+
* @memberof VenueProviderStateDto
|
|
36086
|
+
*/
|
|
36087
|
+
'integrations': Array<IntegrationType>;
|
|
36088
|
+
}
|
|
36089
|
+
/**
|
|
36090
|
+
*
|
|
36091
|
+
* @export
|
|
36092
|
+
* @interface VenueProvidersDto
|
|
36093
|
+
*/
|
|
36094
|
+
export interface VenueProvidersDto {
|
|
36095
|
+
/**
|
|
36096
|
+
* 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
|
|
36097
|
+
* @type {Array<VenueProviderStateDto>}
|
|
36098
|
+
* @memberof VenueProvidersDto
|
|
36099
|
+
*/
|
|
36100
|
+
'providers': Array<VenueProviderStateDto>;
|
|
36101
|
+
}
|
|
35785
36102
|
/**
|
|
35786
36103
|
*
|
|
35787
36104
|
* @export
|
|
@@ -50463,6 +50780,14 @@ export declare const ProviderApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
50463
50780
|
* @throws {RequiredError}
|
|
50464
50781
|
*/
|
|
50465
50782
|
getOnboardingStatus: (channel: ProviderEnum, businessId: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
50783
|
+
/**
|
|
50784
|
+
* 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.
|
|
50785
|
+
* @summary Read whether each of a venue\'s own channels is on and auto-accepting, and its integrations
|
|
50786
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
50787
|
+
* @param {*} [options] Override http request option.
|
|
50788
|
+
* @throws {RequiredError}
|
|
50789
|
+
*/
|
|
50790
|
+
getVenueProviders: (businessId: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
50466
50791
|
/**
|
|
50467
50792
|
* Asked once the owner has signed in to Uber Eats, with the session\'s state; ubereats-service\'s list is answered as it is.
|
|
50468
50793
|
* @summary The Uber Eats stores the signed-in owner can connect
|
|
@@ -50541,6 +50866,14 @@ export declare const ProviderApiFp: (configuration?: Configuration) => {
|
|
|
50541
50866
|
* @throws {RequiredError}
|
|
50542
50867
|
*/
|
|
50543
50868
|
getOnboardingStatus(channel: ProviderEnum, businessId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOnboardingStatus200Response>>;
|
|
50869
|
+
/**
|
|
50870
|
+
* 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.
|
|
50871
|
+
* @summary Read whether each of a venue\'s own channels is on and auto-accepting, and its integrations
|
|
50872
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
50873
|
+
* @param {*} [options] Override http request option.
|
|
50874
|
+
* @throws {RequiredError}
|
|
50875
|
+
*/
|
|
50876
|
+
getVenueProviders(businessId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueProvidersDto>>;
|
|
50544
50877
|
/**
|
|
50545
50878
|
* Asked once the owner has signed in to Uber Eats, with the session\'s state; ubereats-service\'s list is answered as it is.
|
|
50546
50879
|
* @summary The Uber Eats stores the signed-in owner can connect
|
|
@@ -50619,6 +50952,14 @@ export declare const ProviderApiFactory: (configuration?: Configuration, basePat
|
|
|
50619
50952
|
* @throws {RequiredError}
|
|
50620
50953
|
*/
|
|
50621
50954
|
getOnboardingStatus(channel: ProviderEnum, businessId: number, options?: any): AxiosPromise<GetOnboardingStatus200Response>;
|
|
50955
|
+
/**
|
|
50956
|
+
* 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.
|
|
50957
|
+
* @summary Read whether each of a venue\'s own channels is on and auto-accepting, and its integrations
|
|
50958
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
50959
|
+
* @param {*} [options] Override http request option.
|
|
50960
|
+
* @throws {RequiredError}
|
|
50961
|
+
*/
|
|
50962
|
+
getVenueProviders(businessId: number, options?: any): AxiosPromise<VenueProvidersDto>;
|
|
50622
50963
|
/**
|
|
50623
50964
|
* Asked once the owner has signed in to Uber Eats, with the session\'s state; ubereats-service\'s list is answered as it is.
|
|
50624
50965
|
* @summary The Uber Eats stores the signed-in owner can connect
|
|
@@ -50702,6 +51043,15 @@ export interface ProviderApiInterface {
|
|
|
50702
51043
|
* @memberof ProviderApiInterface
|
|
50703
51044
|
*/
|
|
50704
51045
|
getOnboardingStatus(channel: ProviderEnum, businessId: number, options?: AxiosRequestConfig): AxiosPromise<GetOnboardingStatus200Response>;
|
|
51046
|
+
/**
|
|
51047
|
+
* 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.
|
|
51048
|
+
* @summary Read whether each of a venue\'s own channels is on and auto-accepting, and its integrations
|
|
51049
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
51050
|
+
* @param {*} [options] Override http request option.
|
|
51051
|
+
* @throws {RequiredError}
|
|
51052
|
+
* @memberof ProviderApiInterface
|
|
51053
|
+
*/
|
|
51054
|
+
getVenueProviders(businessId: number, options?: AxiosRequestConfig): AxiosPromise<VenueProvidersDto>;
|
|
50705
51055
|
/**
|
|
50706
51056
|
* Asked once the owner has signed in to Uber Eats, with the session\'s state; ubereats-service\'s list is answered as it is.
|
|
50707
51057
|
* @summary The Uber Eats stores the signed-in owner can connect
|
|
@@ -50790,6 +51140,15 @@ export declare class ProviderApi extends BaseAPI implements ProviderApiInterface
|
|
|
50790
51140
|
* @memberof ProviderApi
|
|
50791
51141
|
*/
|
|
50792
51142
|
getOnboardingStatus(channel: ProviderEnum, businessId: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetOnboardingStatus200Response, any, {}>>;
|
|
51143
|
+
/**
|
|
51144
|
+
* 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.
|
|
51145
|
+
* @summary Read whether each of a venue\'s own channels is on and auto-accepting, and its integrations
|
|
51146
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
51147
|
+
* @param {*} [options] Override http request option.
|
|
51148
|
+
* @throws {RequiredError}
|
|
51149
|
+
* @memberof ProviderApi
|
|
51150
|
+
*/
|
|
51151
|
+
getVenueProviders(businessId: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VenueProvidersDto, any, {}>>;
|
|
50793
51152
|
/**
|
|
50794
51153
|
* Asked once the owner has signed in to Uber Eats, with the session\'s state; ubereats-service\'s list is answered as it is.
|
|
50795
51154
|
* @summary The Uber Eats stores the signed-in owner can connect
|
|
@@ -55498,6 +55857,321 @@ export declare class VendureSellerApi extends BaseAPI implements VendureSellerAp
|
|
|
55498
55857
|
*/
|
|
55499
55858
|
upsert(vendureSellerUpsertDto: VendureSellerUpsertDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VendureSellerSavedDto, any, {}>>;
|
|
55500
55859
|
}
|
|
55860
|
+
/**
|
|
55861
|
+
* VenueKiosksApi - axios parameter creator
|
|
55862
|
+
* @export
|
|
55863
|
+
*/
|
|
55864
|
+
export declare const VenueKiosksApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
55865
|
+
/**
|
|
55866
|
+
* 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.
|
|
55867
|
+
* @summary Rename a kiosk, change its prefix, or put it in or out of use
|
|
55868
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
55869
|
+
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
55870
|
+
* @param {ChangeKioskDto} changeKioskDto
|
|
55871
|
+
* @param {*} [options] Override http request option.
|
|
55872
|
+
* @throws {RequiredError}
|
|
55873
|
+
*/
|
|
55874
|
+
changeVenueKiosk: (businessId: number, stationId: string, changeKioskDto: ChangeKioskDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
55875
|
+
/**
|
|
55876
|
+
* 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.
|
|
55877
|
+
* @summary Link a kiosk to the venue by the Hardware ID it shows
|
|
55878
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
55879
|
+
* @param {ClaimKioskDto} claimKioskDto
|
|
55880
|
+
* @param {*} [options] Override http request option.
|
|
55881
|
+
* @throws {RequiredError}
|
|
55882
|
+
*/
|
|
55883
|
+
claimVenueKiosk: (businessId: number, claimKioskDto: ClaimKioskDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
55884
|
+
/**
|
|
55885
|
+
* 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.
|
|
55886
|
+
* @summary Link one of the venue\'s payment terminals to a kiosk, or unlink it
|
|
55887
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
55888
|
+
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
55889
|
+
* @param {LinkKioskTerminalDto} linkKioskTerminalDto
|
|
55890
|
+
* @param {*} [options] Override http request option.
|
|
55891
|
+
* @throws {RequiredError}
|
|
55892
|
+
*/
|
|
55893
|
+
linkVenueKioskTerminal: (businessId: number, stationId: string, linkKioskTerminalDto: LinkKioskTerminalDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
55894
|
+
/**
|
|
55895
|
+
* Every kiosk station of the venue, active or removed, oldest first, with its linked payment terminal. Read from the database every time.
|
|
55896
|
+
* @summary List the venue\'s kiosks
|
|
55897
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
55898
|
+
* @param {*} [options] Override http request option.
|
|
55899
|
+
* @throws {RequiredError}
|
|
55900
|
+
*/
|
|
55901
|
+
listVenueKiosks: (businessId: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
55902
|
+
/**
|
|
55903
|
+
* 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.
|
|
55904
|
+
* @summary List the venue\'s payment terminals, for linking one to a kiosk
|
|
55905
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
55906
|
+
* @param {*} [options] Override http request option.
|
|
55907
|
+
* @throws {RequiredError}
|
|
55908
|
+
*/
|
|
55909
|
+
listVenuePaymentTerminals: (businessId: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
55910
|
+
/**
|
|
55911
|
+
* 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.
|
|
55912
|
+
* @summary Remove a kiosk from use
|
|
55913
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
55914
|
+
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
55915
|
+
* @param {*} [options] Override http request option.
|
|
55916
|
+
* @throws {RequiredError}
|
|
55917
|
+
*/
|
|
55918
|
+
removeVenueKiosk: (businessId: number, stationId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
55919
|
+
};
|
|
55920
|
+
/**
|
|
55921
|
+
* VenueKiosksApi - functional programming interface
|
|
55922
|
+
* @export
|
|
55923
|
+
*/
|
|
55924
|
+
export declare const VenueKiosksApiFp: (configuration?: Configuration) => {
|
|
55925
|
+
/**
|
|
55926
|
+
* 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.
|
|
55927
|
+
* @summary Rename a kiosk, change its prefix, or put it in or out of use
|
|
55928
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
55929
|
+
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
55930
|
+
* @param {ChangeKioskDto} changeKioskDto
|
|
55931
|
+
* @param {*} [options] Override http request option.
|
|
55932
|
+
* @throws {RequiredError}
|
|
55933
|
+
*/
|
|
55934
|
+
changeVenueKiosk(businessId: number, stationId: string, changeKioskDto: ChangeKioskDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueKioskDto>>;
|
|
55935
|
+
/**
|
|
55936
|
+
* 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.
|
|
55937
|
+
* @summary Link a kiosk to the venue by the Hardware ID it shows
|
|
55938
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
55939
|
+
* @param {ClaimKioskDto} claimKioskDto
|
|
55940
|
+
* @param {*} [options] Override http request option.
|
|
55941
|
+
* @throws {RequiredError}
|
|
55942
|
+
*/
|
|
55943
|
+
claimVenueKiosk(businessId: number, claimKioskDto: ClaimKioskDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueKioskDto>>;
|
|
55944
|
+
/**
|
|
55945
|
+
* 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.
|
|
55946
|
+
* @summary Link one of the venue\'s payment terminals to a kiosk, or unlink it
|
|
55947
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
55948
|
+
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
55949
|
+
* @param {LinkKioskTerminalDto} linkKioskTerminalDto
|
|
55950
|
+
* @param {*} [options] Override http request option.
|
|
55951
|
+
* @throws {RequiredError}
|
|
55952
|
+
*/
|
|
55953
|
+
linkVenueKioskTerminal(businessId: number, stationId: string, linkKioskTerminalDto: LinkKioskTerminalDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueKioskDto>>;
|
|
55954
|
+
/**
|
|
55955
|
+
* Every kiosk station of the venue, active or removed, oldest first, with its linked payment terminal. Read from the database every time.
|
|
55956
|
+
* @summary List the venue\'s kiosks
|
|
55957
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
55958
|
+
* @param {*} [options] Override http request option.
|
|
55959
|
+
* @throws {RequiredError}
|
|
55960
|
+
*/
|
|
55961
|
+
listVenueKiosks(businessId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueKiosksDto>>;
|
|
55962
|
+
/**
|
|
55963
|
+
* 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.
|
|
55964
|
+
* @summary List the venue\'s payment terminals, for linking one to a kiosk
|
|
55965
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
55966
|
+
* @param {*} [options] Override http request option.
|
|
55967
|
+
* @throws {RequiredError}
|
|
55968
|
+
*/
|
|
55969
|
+
listVenuePaymentTerminals(businessId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenuePaymentTerminalsDto>>;
|
|
55970
|
+
/**
|
|
55971
|
+
* 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.
|
|
55972
|
+
* @summary Remove a kiosk from use
|
|
55973
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
55974
|
+
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
55975
|
+
* @param {*} [options] Override http request option.
|
|
55976
|
+
* @throws {RequiredError}
|
|
55977
|
+
*/
|
|
55978
|
+
removeVenueKiosk(businessId: number, stationId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueKioskDto>>;
|
|
55979
|
+
};
|
|
55980
|
+
/**
|
|
55981
|
+
* VenueKiosksApi - factory interface
|
|
55982
|
+
* @export
|
|
55983
|
+
*/
|
|
55984
|
+
export declare const VenueKiosksApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
55985
|
+
/**
|
|
55986
|
+
* 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.
|
|
55987
|
+
* @summary Rename a kiosk, change its prefix, or put it in or out of use
|
|
55988
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
55989
|
+
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
55990
|
+
* @param {ChangeKioskDto} changeKioskDto
|
|
55991
|
+
* @param {*} [options] Override http request option.
|
|
55992
|
+
* @throws {RequiredError}
|
|
55993
|
+
*/
|
|
55994
|
+
changeVenueKiosk(businessId: number, stationId: string, changeKioskDto: ChangeKioskDto, options?: any): AxiosPromise<VenueKioskDto>;
|
|
55995
|
+
/**
|
|
55996
|
+
* 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.
|
|
55997
|
+
* @summary Link a kiosk to the venue by the Hardware ID it shows
|
|
55998
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
55999
|
+
* @param {ClaimKioskDto} claimKioskDto
|
|
56000
|
+
* @param {*} [options] Override http request option.
|
|
56001
|
+
* @throws {RequiredError}
|
|
56002
|
+
*/
|
|
56003
|
+
claimVenueKiosk(businessId: number, claimKioskDto: ClaimKioskDto, options?: any): AxiosPromise<VenueKioskDto>;
|
|
56004
|
+
/**
|
|
56005
|
+
* 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.
|
|
56006
|
+
* @summary Link one of the venue\'s payment terminals to a kiosk, or unlink it
|
|
56007
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56008
|
+
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
56009
|
+
* @param {LinkKioskTerminalDto} linkKioskTerminalDto
|
|
56010
|
+
* @param {*} [options] Override http request option.
|
|
56011
|
+
* @throws {RequiredError}
|
|
56012
|
+
*/
|
|
56013
|
+
linkVenueKioskTerminal(businessId: number, stationId: string, linkKioskTerminalDto: LinkKioskTerminalDto, options?: any): AxiosPromise<VenueKioskDto>;
|
|
56014
|
+
/**
|
|
56015
|
+
* Every kiosk station of the venue, active or removed, oldest first, with its linked payment terminal. Read from the database every time.
|
|
56016
|
+
* @summary List the venue\'s kiosks
|
|
56017
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56018
|
+
* @param {*} [options] Override http request option.
|
|
56019
|
+
* @throws {RequiredError}
|
|
56020
|
+
*/
|
|
56021
|
+
listVenueKiosks(businessId: number, options?: any): AxiosPromise<VenueKiosksDto>;
|
|
56022
|
+
/**
|
|
56023
|
+
* 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.
|
|
56024
|
+
* @summary List the venue\'s payment terminals, for linking one to a kiosk
|
|
56025
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56026
|
+
* @param {*} [options] Override http request option.
|
|
56027
|
+
* @throws {RequiredError}
|
|
56028
|
+
*/
|
|
56029
|
+
listVenuePaymentTerminals(businessId: number, options?: any): AxiosPromise<VenuePaymentTerminalsDto>;
|
|
56030
|
+
/**
|
|
56031
|
+
* 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.
|
|
56032
|
+
* @summary Remove a kiosk from use
|
|
56033
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56034
|
+
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
56035
|
+
* @param {*} [options] Override http request option.
|
|
56036
|
+
* @throws {RequiredError}
|
|
56037
|
+
*/
|
|
56038
|
+
removeVenueKiosk(businessId: number, stationId: string, options?: any): AxiosPromise<VenueKioskDto>;
|
|
56039
|
+
};
|
|
56040
|
+
/**
|
|
56041
|
+
* VenueKiosksApi - interface
|
|
56042
|
+
* @export
|
|
56043
|
+
* @interface VenueKiosksApi
|
|
56044
|
+
*/
|
|
56045
|
+
export interface VenueKiosksApiInterface {
|
|
56046
|
+
/**
|
|
56047
|
+
* 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.
|
|
56048
|
+
* @summary Rename a kiosk, change its prefix, or put it in or out of use
|
|
56049
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56050
|
+
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
56051
|
+
* @param {ChangeKioskDto} changeKioskDto
|
|
56052
|
+
* @param {*} [options] Override http request option.
|
|
56053
|
+
* @throws {RequiredError}
|
|
56054
|
+
* @memberof VenueKiosksApiInterface
|
|
56055
|
+
*/
|
|
56056
|
+
changeVenueKiosk(businessId: number, stationId: string, changeKioskDto: ChangeKioskDto, options?: AxiosRequestConfig): AxiosPromise<VenueKioskDto>;
|
|
56057
|
+
/**
|
|
56058
|
+
* 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.
|
|
56059
|
+
* @summary Link a kiosk to the venue by the Hardware ID it shows
|
|
56060
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56061
|
+
* @param {ClaimKioskDto} claimKioskDto
|
|
56062
|
+
* @param {*} [options] Override http request option.
|
|
56063
|
+
* @throws {RequiredError}
|
|
56064
|
+
* @memberof VenueKiosksApiInterface
|
|
56065
|
+
*/
|
|
56066
|
+
claimVenueKiosk(businessId: number, claimKioskDto: ClaimKioskDto, options?: AxiosRequestConfig): AxiosPromise<VenueKioskDto>;
|
|
56067
|
+
/**
|
|
56068
|
+
* 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.
|
|
56069
|
+
* @summary Link one of the venue\'s payment terminals to a kiosk, or unlink it
|
|
56070
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56071
|
+
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
56072
|
+
* @param {LinkKioskTerminalDto} linkKioskTerminalDto
|
|
56073
|
+
* @param {*} [options] Override http request option.
|
|
56074
|
+
* @throws {RequiredError}
|
|
56075
|
+
* @memberof VenueKiosksApiInterface
|
|
56076
|
+
*/
|
|
56077
|
+
linkVenueKioskTerminal(businessId: number, stationId: string, linkKioskTerminalDto: LinkKioskTerminalDto, options?: AxiosRequestConfig): AxiosPromise<VenueKioskDto>;
|
|
56078
|
+
/**
|
|
56079
|
+
* Every kiosk station of the venue, active or removed, oldest first, with its linked payment terminal. Read from the database every time.
|
|
56080
|
+
* @summary List the venue\'s kiosks
|
|
56081
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56082
|
+
* @param {*} [options] Override http request option.
|
|
56083
|
+
* @throws {RequiredError}
|
|
56084
|
+
* @memberof VenueKiosksApiInterface
|
|
56085
|
+
*/
|
|
56086
|
+
listVenueKiosks(businessId: number, options?: AxiosRequestConfig): AxiosPromise<VenueKiosksDto>;
|
|
56087
|
+
/**
|
|
56088
|
+
* 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.
|
|
56089
|
+
* @summary List the venue\'s payment terminals, for linking one to a kiosk
|
|
56090
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56091
|
+
* @param {*} [options] Override http request option.
|
|
56092
|
+
* @throws {RequiredError}
|
|
56093
|
+
* @memberof VenueKiosksApiInterface
|
|
56094
|
+
*/
|
|
56095
|
+
listVenuePaymentTerminals(businessId: number, options?: AxiosRequestConfig): AxiosPromise<VenuePaymentTerminalsDto>;
|
|
56096
|
+
/**
|
|
56097
|
+
* 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.
|
|
56098
|
+
* @summary Remove a kiosk from use
|
|
56099
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56100
|
+
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
56101
|
+
* @param {*} [options] Override http request option.
|
|
56102
|
+
* @throws {RequiredError}
|
|
56103
|
+
* @memberof VenueKiosksApiInterface
|
|
56104
|
+
*/
|
|
56105
|
+
removeVenueKiosk(businessId: number, stationId: string, options?: AxiosRequestConfig): AxiosPromise<VenueKioskDto>;
|
|
56106
|
+
}
|
|
56107
|
+
/**
|
|
56108
|
+
* VenueKiosksApi - object-oriented interface
|
|
56109
|
+
* @export
|
|
56110
|
+
* @class VenueKiosksApi
|
|
56111
|
+
* @extends {BaseAPI}
|
|
56112
|
+
*/
|
|
56113
|
+
export declare class VenueKiosksApi extends BaseAPI implements VenueKiosksApiInterface {
|
|
56114
|
+
/**
|
|
56115
|
+
* 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.
|
|
56116
|
+
* @summary Rename a kiosk, change its prefix, or put it in or out of use
|
|
56117
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56118
|
+
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
56119
|
+
* @param {ChangeKioskDto} changeKioskDto
|
|
56120
|
+
* @param {*} [options] Override http request option.
|
|
56121
|
+
* @throws {RequiredError}
|
|
56122
|
+
* @memberof VenueKiosksApi
|
|
56123
|
+
*/
|
|
56124
|
+
changeVenueKiosk(businessId: number, stationId: string, changeKioskDto: ChangeKioskDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VenueKioskDto, any, {}>>;
|
|
56125
|
+
/**
|
|
56126
|
+
* 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.
|
|
56127
|
+
* @summary Link a kiosk to the venue by the Hardware ID it shows
|
|
56128
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56129
|
+
* @param {ClaimKioskDto} claimKioskDto
|
|
56130
|
+
* @param {*} [options] Override http request option.
|
|
56131
|
+
* @throws {RequiredError}
|
|
56132
|
+
* @memberof VenueKiosksApi
|
|
56133
|
+
*/
|
|
56134
|
+
claimVenueKiosk(businessId: number, claimKioskDto: ClaimKioskDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VenueKioskDto, any, {}>>;
|
|
56135
|
+
/**
|
|
56136
|
+
* 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.
|
|
56137
|
+
* @summary Link one of the venue\'s payment terminals to a kiosk, or unlink it
|
|
56138
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56139
|
+
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
56140
|
+
* @param {LinkKioskTerminalDto} linkKioskTerminalDto
|
|
56141
|
+
* @param {*} [options] Override http request option.
|
|
56142
|
+
* @throws {RequiredError}
|
|
56143
|
+
* @memberof VenueKiosksApi
|
|
56144
|
+
*/
|
|
56145
|
+
linkVenueKioskTerminal(businessId: number, stationId: string, linkKioskTerminalDto: LinkKioskTerminalDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VenueKioskDto, any, {}>>;
|
|
56146
|
+
/**
|
|
56147
|
+
* Every kiosk station of the venue, active or removed, oldest first, with its linked payment terminal. Read from the database every time.
|
|
56148
|
+
* @summary List the venue\'s kiosks
|
|
56149
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56150
|
+
* @param {*} [options] Override http request option.
|
|
56151
|
+
* @throws {RequiredError}
|
|
56152
|
+
* @memberof VenueKiosksApi
|
|
56153
|
+
*/
|
|
56154
|
+
listVenueKiosks(businessId: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VenueKiosksDto, any, {}>>;
|
|
56155
|
+
/**
|
|
56156
|
+
* 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.
|
|
56157
|
+
* @summary List the venue\'s payment terminals, for linking one to a kiosk
|
|
56158
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56159
|
+
* @param {*} [options] Override http request option.
|
|
56160
|
+
* @throws {RequiredError}
|
|
56161
|
+
* @memberof VenueKiosksApi
|
|
56162
|
+
*/
|
|
56163
|
+
listVenuePaymentTerminals(businessId: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VenuePaymentTerminalsDto, any, {}>>;
|
|
56164
|
+
/**
|
|
56165
|
+
* 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.
|
|
56166
|
+
* @summary Remove a kiosk from use
|
|
56167
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56168
|
+
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
56169
|
+
* @param {*} [options] Override http request option.
|
|
56170
|
+
* @throws {RequiredError}
|
|
56171
|
+
* @memberof VenueKiosksApi
|
|
56172
|
+
*/
|
|
56173
|
+
removeVenueKiosk(businessId: number, stationId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VenueKioskDto, any, {}>>;
|
|
56174
|
+
}
|
|
55501
56175
|
/**
|
|
55502
56176
|
* VivaApi - axios parameter creator
|
|
55503
56177
|
* @export
|