@munchi_oy/core 2.4.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 +659 -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 +981 -9
- package/package.json +1 -1
- package/src/version.ts +1 -1
package/dist/generated/api.d.ts
CHANGED
|
@@ -2572,6 +2572,31 @@ export interface ChangeEmployeeRoleDto {
|
|
|
2572
2572
|
*/
|
|
2573
2573
|
'permissionKeys'?: Array<PosPermission>;
|
|
2574
2574
|
}
|
|
2575
|
+
/**
|
|
2576
|
+
*
|
|
2577
|
+
* @export
|
|
2578
|
+
* @interface ChangeKioskDto
|
|
2579
|
+
*/
|
|
2580
|
+
export interface ChangeKioskDto {
|
|
2581
|
+
/**
|
|
2582
|
+
* The kiosk\'s new name; left out, it keeps its name
|
|
2583
|
+
* @type {string}
|
|
2584
|
+
* @memberof ChangeKioskDto
|
|
2585
|
+
*/
|
|
2586
|
+
'name'?: string;
|
|
2587
|
+
/**
|
|
2588
|
+
* What the kiosk\'s order numbers start with, an empty text for none; left out, it keeps its prefix
|
|
2589
|
+
* @type {string}
|
|
2590
|
+
* @memberof ChangeKioskDto
|
|
2591
|
+
*/
|
|
2592
|
+
'prefix'?: string;
|
|
2593
|
+
/**
|
|
2594
|
+
*
|
|
2595
|
+
* @type {Status}
|
|
2596
|
+
* @memberof ChangeKioskDto
|
|
2597
|
+
*/
|
|
2598
|
+
'status'?: Status;
|
|
2599
|
+
}
|
|
2575
2600
|
/**
|
|
2576
2601
|
*
|
|
2577
2602
|
* @export
|
|
@@ -3025,6 +3050,31 @@ export declare const CheckoutModelEnum: {
|
|
|
3025
3050
|
readonly Full: "FULL";
|
|
3026
3051
|
};
|
|
3027
3052
|
export type CheckoutModelEnum = typeof CheckoutModelEnum[keyof typeof CheckoutModelEnum];
|
|
3053
|
+
/**
|
|
3054
|
+
*
|
|
3055
|
+
* @export
|
|
3056
|
+
* @interface ClaimKioskDto
|
|
3057
|
+
*/
|
|
3058
|
+
export interface ClaimKioskDto {
|
|
3059
|
+
/**
|
|
3060
|
+
* The Hardware ID the kiosk shows on its Getting started screen, exactly as shown; it is the id the device sends in X-Munchi-Hardware-Id
|
|
3061
|
+
* @type {string}
|
|
3062
|
+
* @memberof ClaimKioskDto
|
|
3063
|
+
*/
|
|
3064
|
+
'hardwareId': string;
|
|
3065
|
+
/**
|
|
3066
|
+
* The kiosk\'s name, as the venue\'s staff call it
|
|
3067
|
+
* @type {string}
|
|
3068
|
+
* @memberof ClaimKioskDto
|
|
3069
|
+
*/
|
|
3070
|
+
'name': string;
|
|
3071
|
+
/**
|
|
3072
|
+
* What the kiosk\'s order numbers start with. Left out, a new kiosk has none and a kiosk the venue had keeps its own
|
|
3073
|
+
* @type {string}
|
|
3074
|
+
* @memberof ClaimKioskDto
|
|
3075
|
+
*/
|
|
3076
|
+
'prefix'?: string;
|
|
3077
|
+
}
|
|
3028
3078
|
/**
|
|
3029
3079
|
*
|
|
3030
3080
|
* @export
|
|
@@ -11026,6 +11076,31 @@ export interface KioskStatusDto {
|
|
|
11026
11076
|
*/
|
|
11027
11077
|
'payment_event': PaymentEventType;
|
|
11028
11078
|
}
|
|
11079
|
+
/**
|
|
11080
|
+
*
|
|
11081
|
+
* @export
|
|
11082
|
+
* @interface KioskTerminalDto
|
|
11083
|
+
*/
|
|
11084
|
+
export interface KioskTerminalDto {
|
|
11085
|
+
/**
|
|
11086
|
+
* The payment terminal\'s id
|
|
11087
|
+
* @type {string}
|
|
11088
|
+
* @memberof KioskTerminalDto
|
|
11089
|
+
*/
|
|
11090
|
+
'id': string;
|
|
11091
|
+
/**
|
|
11092
|
+
*
|
|
11093
|
+
* @type {PaymentProvider}
|
|
11094
|
+
* @memberof KioskTerminalDto
|
|
11095
|
+
*/
|
|
11096
|
+
'provider': PaymentProvider;
|
|
11097
|
+
/**
|
|
11098
|
+
* The terminal\'s label; null when it was given none
|
|
11099
|
+
* @type {string}
|
|
11100
|
+
* @memberof KioskTerminalDto
|
|
11101
|
+
*/
|
|
11102
|
+
'label': string | null;
|
|
11103
|
+
}
|
|
11029
11104
|
/**
|
|
11030
11105
|
*
|
|
11031
11106
|
* @export
|
|
@@ -11152,6 +11227,19 @@ export interface LapseResponseDto {
|
|
|
11152
11227
|
*/
|
|
11153
11228
|
'businessDayScheduleId': string;
|
|
11154
11229
|
}
|
|
11230
|
+
/**
|
|
11231
|
+
*
|
|
11232
|
+
* @export
|
|
11233
|
+
* @interface LinkKioskTerminalDto
|
|
11234
|
+
*/
|
|
11235
|
+
export interface LinkKioskTerminalDto {
|
|
11236
|
+
/**
|
|
11237
|
+
* The id of one of the venue\'s payment terminals, as the venue\'s terminal list answers it, or null to unlink the kiosk\'s terminal
|
|
11238
|
+
* @type {string}
|
|
11239
|
+
* @memberof LinkKioskTerminalDto
|
|
11240
|
+
*/
|
|
11241
|
+
'paymentTerminalId': string | null;
|
|
11242
|
+
}
|
|
11155
11243
|
/**
|
|
11156
11244
|
*
|
|
11157
11245
|
* @export
|
|
@@ -14328,7 +14416,7 @@ export interface OrderHistoryPosResponseDtoV2Pagination {
|
|
|
14328
14416
|
*/
|
|
14329
14417
|
export interface OrderHistoryPosResponseDtoV2Summary {
|
|
14330
14418
|
/**
|
|
14331
|
-
* How many orders of the period count: online, every order
|
|
14419
|
+
* How many orders of the period count: online, every order neither rejected nor fully refunded; POS, every order not fully refunded (with a payment filter, only those with a matching payment). 0 when the person on the till may not see it.
|
|
14332
14420
|
* @type {number}
|
|
14333
14421
|
* @memberof OrderHistoryPosResponseDtoV2Summary
|
|
14334
14422
|
*/
|
|
@@ -14340,7 +14428,7 @@ export interface OrderHistoryPosResponseDtoV2Summary {
|
|
|
14340
14428
|
*/
|
|
14341
14429
|
'rejectedOrders': number;
|
|
14342
14430
|
/**
|
|
14343
|
-
* The period\'s sales in euros (not cents): online, the net total of the orders
|
|
14431
|
+
* The period\'s sales in euros (not cents): online, the net total of the orders neither rejected nor fully refunded, less their completed refunds; POS, the payments less successful refunds. 0 when the person on the till may not see it.
|
|
14344
14432
|
* @type {number}
|
|
14345
14433
|
* @memberof OrderHistoryPosResponseDtoV2Summary
|
|
14346
14434
|
*/
|
|
@@ -14398,7 +14486,7 @@ export interface OrderHistoryResponseDto {
|
|
|
14398
14486
|
*/
|
|
14399
14487
|
export interface OrderHistoryResponseDtoSummary {
|
|
14400
14488
|
/**
|
|
14401
|
-
* How many orders of the period count: online, every order
|
|
14489
|
+
* How many orders of the period count: online, every order neither rejected nor fully refunded; POS, every order not fully refunded (with a payment filter, only those with a matching payment). 0 when the person on the till may not see it.
|
|
14402
14490
|
* @type {number}
|
|
14403
14491
|
* @memberof OrderHistoryResponseDtoSummary
|
|
14404
14492
|
*/
|
|
@@ -14410,7 +14498,7 @@ export interface OrderHistoryResponseDtoSummary {
|
|
|
14410
14498
|
*/
|
|
14411
14499
|
'rejectedOrders': number;
|
|
14412
14500
|
/**
|
|
14413
|
-
* The period\'s sales in euros (not cents): online, the net total of the orders
|
|
14501
|
+
* The period\'s sales in euros (not cents): online, the net total of the orders neither rejected nor fully refunded, less their completed refunds; POS, the payments less successful refunds. 0 when the person on the till may not see it.
|
|
14414
14502
|
* @type {number}
|
|
14415
14503
|
* @memberof OrderHistoryResponseDtoSummary
|
|
14416
14504
|
*/
|
|
@@ -15408,7 +15496,7 @@ export interface OrderStatusResponseDtoOrder {
|
|
|
15408
15496
|
*/
|
|
15409
15497
|
export interface OrderSummaryDto {
|
|
15410
15498
|
/**
|
|
15411
|
-
* How many orders of the period count: online, every order
|
|
15499
|
+
* How many orders of the period count: online, every order neither rejected nor fully refunded; POS, every order not fully refunded (with a payment filter, only those with a matching payment). 0 when the person on the till may not see it.
|
|
15412
15500
|
* @type {number}
|
|
15413
15501
|
* @memberof OrderSummaryDto
|
|
15414
15502
|
*/
|
|
@@ -15420,7 +15508,7 @@ export interface OrderSummaryDto {
|
|
|
15420
15508
|
*/
|
|
15421
15509
|
'rejectedOrders': number;
|
|
15422
15510
|
/**
|
|
15423
|
-
* The period\'s sales in euros (not cents): online, the net total of the orders
|
|
15511
|
+
* The period\'s sales in euros (not cents): online, the net total of the orders neither rejected nor fully refunded, less their completed refunds; POS, the payments less successful refunds. 0 when the person on the till may not see it.
|
|
15424
15512
|
* @type {number}
|
|
15425
15513
|
* @memberof OrderSummaryDto
|
|
15426
15514
|
*/
|
|
@@ -21159,7 +21247,7 @@ export interface PosOrderSuboptionDto {
|
|
|
21159
21247
|
*/
|
|
21160
21248
|
export interface PosOrderSummaryDto {
|
|
21161
21249
|
/**
|
|
21162
|
-
* How many orders of the period count: online, every order
|
|
21250
|
+
* How many orders of the period count: online, every order neither rejected nor fully refunded; POS, every order not fully refunded (with a payment filter, only those with a matching payment). 0 when the person on the till may not see it.
|
|
21163
21251
|
* @type {number}
|
|
21164
21252
|
* @memberof PosOrderSummaryDto
|
|
21165
21253
|
*/
|
|
@@ -21171,7 +21259,7 @@ export interface PosOrderSummaryDto {
|
|
|
21171
21259
|
*/
|
|
21172
21260
|
'rejectedOrders': number;
|
|
21173
21261
|
/**
|
|
21174
|
-
* The period\'s sales in euros (not cents): online, the net total of the orders
|
|
21262
|
+
* The period\'s sales in euros (not cents): online, the net total of the orders neither rejected nor fully refunded, less their completed refunds; POS, the payments less successful refunds. 0 when the person on the till may not see it.
|
|
21175
21263
|
* @type {number}
|
|
21176
21264
|
* @memberof PosOrderSummaryDto
|
|
21177
21265
|
*/
|
|
@@ -28538,6 +28626,12 @@ export interface SalesReportStaffMemberDto {
|
|
|
28538
28626
|
* @memberof SalesReportStaffMemberDto
|
|
28539
28627
|
*/
|
|
28540
28628
|
'staffId': string;
|
|
28629
|
+
/**
|
|
28630
|
+
* The staff member\'s name; null for the orders that name nobody, or a person who left the venue
|
|
28631
|
+
* @type {string}
|
|
28632
|
+
* @memberof SalesReportStaffMemberDto
|
|
28633
|
+
*/
|
|
28634
|
+
'staffName': string | null;
|
|
28541
28635
|
/**
|
|
28542
28636
|
* Orders not refunded, or refunded in part (the POS app\'s totalOrders)
|
|
28543
28637
|
* @type {number}
|
|
@@ -34727,6 +34821,18 @@ export interface UpsertConfigDto {
|
|
|
34727
34821
|
* @memberof UpsertConfigDto
|
|
34728
34822
|
*/
|
|
34729
34823
|
'productDetailLayout'?: ProductDetailLayout;
|
|
34824
|
+
/**
|
|
34825
|
+
*
|
|
34826
|
+
* @type {KioskLayout}
|
|
34827
|
+
* @memberof UpsertConfigDto
|
|
34828
|
+
*/
|
|
34829
|
+
'layout'?: KioskLayout;
|
|
34830
|
+
/**
|
|
34831
|
+
*
|
|
34832
|
+
* @type {UpsellMode}
|
|
34833
|
+
* @memberof UpsertConfigDto
|
|
34834
|
+
*/
|
|
34835
|
+
'upsellMode'?: UpsellMode;
|
|
34730
34836
|
/**
|
|
34731
34837
|
* Whether the kiosk prints the receipt without asking. Absent keeps the stored value.
|
|
34732
34838
|
* @type {boolean}
|
|
@@ -35641,6 +35747,99 @@ export interface VenueFoundDto {
|
|
|
35641
35747
|
*/
|
|
35642
35748
|
'chainId': string | null;
|
|
35643
35749
|
}
|
|
35750
|
+
/**
|
|
35751
|
+
*
|
|
35752
|
+
* @export
|
|
35753
|
+
* @interface VenueKioskDto
|
|
35754
|
+
*/
|
|
35755
|
+
export interface VenueKioskDto {
|
|
35756
|
+
/**
|
|
35757
|
+
* The kiosk\'s station id
|
|
35758
|
+
* @type {string}
|
|
35759
|
+
* @memberof VenueKioskDto
|
|
35760
|
+
*/
|
|
35761
|
+
'id': string;
|
|
35762
|
+
/**
|
|
35763
|
+
* The kiosk\'s name
|
|
35764
|
+
* @type {string}
|
|
35765
|
+
* @memberof VenueKioskDto
|
|
35766
|
+
*/
|
|
35767
|
+
'name': string;
|
|
35768
|
+
/**
|
|
35769
|
+
* What the kiosk\'s order numbers start with; empty for none
|
|
35770
|
+
* @type {string}
|
|
35771
|
+
* @memberof VenueKioskDto
|
|
35772
|
+
*/
|
|
35773
|
+
'prefix': string;
|
|
35774
|
+
/**
|
|
35775
|
+
* The device\'s Hardware ID, as it shows it
|
|
35776
|
+
* @type {string}
|
|
35777
|
+
* @memberof VenueKioskDto
|
|
35778
|
+
*/
|
|
35779
|
+
'hardwareId': string;
|
|
35780
|
+
/**
|
|
35781
|
+
*
|
|
35782
|
+
* @type {Status}
|
|
35783
|
+
* @memberof VenueKioskDto
|
|
35784
|
+
*/
|
|
35785
|
+
'status': Status;
|
|
35786
|
+
/**
|
|
35787
|
+
*
|
|
35788
|
+
* @type {VenueKioskDtoTerminal}
|
|
35789
|
+
* @memberof VenueKioskDto
|
|
35790
|
+
*/
|
|
35791
|
+
'terminal': VenueKioskDtoTerminal | null;
|
|
35792
|
+
/**
|
|
35793
|
+
* When the kiosk was first linked to the venue, ISO 8601
|
|
35794
|
+
* @type {string}
|
|
35795
|
+
* @memberof VenueKioskDto
|
|
35796
|
+
*/
|
|
35797
|
+
'createdAt': string;
|
|
35798
|
+
/**
|
|
35799
|
+
* When the kiosk last changed, ISO 8601
|
|
35800
|
+
* @type {string}
|
|
35801
|
+
* @memberof VenueKioskDto
|
|
35802
|
+
*/
|
|
35803
|
+
'updatedAt': string;
|
|
35804
|
+
}
|
|
35805
|
+
/**
|
|
35806
|
+
* The payment terminal linked to the kiosk; null when it has none
|
|
35807
|
+
* @export
|
|
35808
|
+
* @interface VenueKioskDtoTerminal
|
|
35809
|
+
*/
|
|
35810
|
+
export interface VenueKioskDtoTerminal {
|
|
35811
|
+
/**
|
|
35812
|
+
* The payment terminal\'s id
|
|
35813
|
+
* @type {string}
|
|
35814
|
+
* @memberof VenueKioskDtoTerminal
|
|
35815
|
+
*/
|
|
35816
|
+
'id': string;
|
|
35817
|
+
/**
|
|
35818
|
+
*
|
|
35819
|
+
* @type {PaymentProvider}
|
|
35820
|
+
* @memberof VenueKioskDtoTerminal
|
|
35821
|
+
*/
|
|
35822
|
+
'provider': PaymentProvider;
|
|
35823
|
+
/**
|
|
35824
|
+
* The terminal\'s label; null when it was given none
|
|
35825
|
+
* @type {string}
|
|
35826
|
+
* @memberof VenueKioskDtoTerminal
|
|
35827
|
+
*/
|
|
35828
|
+
'label': string | null;
|
|
35829
|
+
}
|
|
35830
|
+
/**
|
|
35831
|
+
*
|
|
35832
|
+
* @export
|
|
35833
|
+
* @interface VenueKiosksDto
|
|
35834
|
+
*/
|
|
35835
|
+
export interface VenueKiosksDto {
|
|
35836
|
+
/**
|
|
35837
|
+
* The venue\'s kiosks, active and inactive, oldest first
|
|
35838
|
+
* @type {Array<VenueKioskDto>}
|
|
35839
|
+
* @memberof VenueKiosksDto
|
|
35840
|
+
*/
|
|
35841
|
+
'kiosks': Array<VenueKioskDto>;
|
|
35842
|
+
}
|
|
35644
35843
|
/**
|
|
35645
35844
|
*
|
|
35646
35845
|
* @export
|
|
@@ -35660,6 +35859,56 @@ export interface VenueListEntryDto {
|
|
|
35660
35859
|
*/
|
|
35661
35860
|
'businessName': string;
|
|
35662
35861
|
}
|
|
35862
|
+
/**
|
|
35863
|
+
*
|
|
35864
|
+
* @export
|
|
35865
|
+
* @interface VenuePaymentTerminalDto
|
|
35866
|
+
*/
|
|
35867
|
+
export interface VenuePaymentTerminalDto {
|
|
35868
|
+
/**
|
|
35869
|
+
* The payment terminal\'s id, the one a kiosk is linked to
|
|
35870
|
+
* @type {string}
|
|
35871
|
+
* @memberof VenuePaymentTerminalDto
|
|
35872
|
+
*/
|
|
35873
|
+
'id': string;
|
|
35874
|
+
/**
|
|
35875
|
+
*
|
|
35876
|
+
* @type {PaymentProvider}
|
|
35877
|
+
* @memberof VenuePaymentTerminalDto
|
|
35878
|
+
*/
|
|
35879
|
+
'provider': PaymentProvider;
|
|
35880
|
+
/**
|
|
35881
|
+
* The terminal\'s label; null when it was given none
|
|
35882
|
+
* @type {string}
|
|
35883
|
+
* @memberof VenuePaymentTerminalDto
|
|
35884
|
+
*/
|
|
35885
|
+
'label': string | null;
|
|
35886
|
+
/**
|
|
35887
|
+
* The terminal\'s own id at its provider, as printed on the device
|
|
35888
|
+
* @type {string}
|
|
35889
|
+
* @memberof VenuePaymentTerminalDto
|
|
35890
|
+
*/
|
|
35891
|
+
'hardwareId': string;
|
|
35892
|
+
/**
|
|
35893
|
+
* The id of the station, a kiosk\'s or a till\'s, the terminal is linked to; null when it is free
|
|
35894
|
+
* @type {string}
|
|
35895
|
+
* @memberof VenuePaymentTerminalDto
|
|
35896
|
+
*/
|
|
35897
|
+
'stationId': string | null;
|
|
35898
|
+
}
|
|
35899
|
+
/**
|
|
35900
|
+
*
|
|
35901
|
+
* @export
|
|
35902
|
+
* @interface VenuePaymentTerminalsDto
|
|
35903
|
+
*/
|
|
35904
|
+
export interface VenuePaymentTerminalsDto {
|
|
35905
|
+
/**
|
|
35906
|
+
* The venue\'s payment terminals as stored, oldest first; a terminal is stored once a till has discovered it
|
|
35907
|
+
* @type {Array<VenuePaymentTerminalDto>}
|
|
35908
|
+
* @memberof VenuePaymentTerminalsDto
|
|
35909
|
+
*/
|
|
35910
|
+
'terminals': Array<VenuePaymentTerminalDto>;
|
|
35911
|
+
}
|
|
35663
35912
|
/**
|
|
35664
35913
|
*
|
|
35665
35914
|
* @export
|
|
@@ -35764,7 +36013,7 @@ export interface VenueProviderOutcomeDto {
|
|
|
35764
36013
|
*/
|
|
35765
36014
|
'rowsChanged': number;
|
|
35766
36015
|
/**
|
|
35767
|
-
* Whether the channel is on, as its row reads after the change: the first active row, else the
|
|
36016
|
+
* Whether the channel is on, as its row reads after the change: the first active row, else the newest row, by createdAt and then id
|
|
35768
36017
|
* @type {boolean}
|
|
35769
36018
|
* @memberof VenueProviderOutcomeDto
|
|
35770
36019
|
*/
|
|
@@ -35782,6 +36031,50 @@ export interface VenueProviderOutcomeDto {
|
|
|
35782
36031
|
*/
|
|
35783
36032
|
'integrations': Array<IntegrationType>;
|
|
35784
36033
|
}
|
|
36034
|
+
/**
|
|
36035
|
+
*
|
|
36036
|
+
* @export
|
|
36037
|
+
* @interface VenueProviderStateDto
|
|
36038
|
+
*/
|
|
36039
|
+
export interface VenueProviderStateDto {
|
|
36040
|
+
/**
|
|
36041
|
+
*
|
|
36042
|
+
* @type {ProviderEnum}
|
|
36043
|
+
* @memberof VenueProviderStateDto
|
|
36044
|
+
*/
|
|
36045
|
+
'channel': ProviderEnum;
|
|
36046
|
+
/**
|
|
36047
|
+
* Whether the channel is on, as its row reads: the first active row, else the newest row, by createdAt and then id
|
|
36048
|
+
* @type {boolean}
|
|
36049
|
+
* @memberof VenueProviderStateDto
|
|
36050
|
+
*/
|
|
36051
|
+
'isActive': boolean;
|
|
36052
|
+
/**
|
|
36053
|
+
* Whether the channel\'s orders are accepted without the till, as the same row reads
|
|
36054
|
+
* @type {boolean}
|
|
36055
|
+
* @memberof VenueProviderStateDto
|
|
36056
|
+
*/
|
|
36057
|
+
'autoAccept': boolean;
|
|
36058
|
+
/**
|
|
36059
|
+
* The integrations the same row takes
|
|
36060
|
+
* @type {Array<IntegrationType>}
|
|
36061
|
+
* @memberof VenueProviderStateDto
|
|
36062
|
+
*/
|
|
36063
|
+
'integrations': Array<IntegrationType>;
|
|
36064
|
+
}
|
|
36065
|
+
/**
|
|
36066
|
+
*
|
|
36067
|
+
* @export
|
|
36068
|
+
* @interface VenueProvidersDto
|
|
36069
|
+
*/
|
|
36070
|
+
export interface VenueProvidersDto {
|
|
36071
|
+
/**
|
|
36072
|
+
* One entry per own channel (those PUT adds a row for when the venue has none) the venue has rows on, active or not, by channel name. Empty when it has none
|
|
36073
|
+
* @type {Array<VenueProviderStateDto>}
|
|
36074
|
+
* @memberof VenueProvidersDto
|
|
36075
|
+
*/
|
|
36076
|
+
'providers': Array<VenueProviderStateDto>;
|
|
36077
|
+
}
|
|
35785
36078
|
/**
|
|
35786
36079
|
*
|
|
35787
36080
|
* @export
|
|
@@ -50463,6 +50756,14 @@ export declare const ProviderApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
50463
50756
|
* @throws {RequiredError}
|
|
50464
50757
|
*/
|
|
50465
50758
|
getOnboardingStatus: (channel: ProviderEnum, businessId: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
50759
|
+
/**
|
|
50760
|
+
* One entry per own channel the venue has rows on, active or not, by channel name: the channels this path\'s PUT adds a row for when the venue has none. A channel with several rows reads from the row PUT on this path answers with: the first active row, else the newest, by createdAt and then id. Nothing is changed.
|
|
50761
|
+
* @summary Read whether each of a venue\'s own channels is on and auto-accepting, and its integrations
|
|
50762
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
50763
|
+
* @param {*} [options] Override http request option.
|
|
50764
|
+
* @throws {RequiredError}
|
|
50765
|
+
*/
|
|
50766
|
+
getVenueProviders: (businessId: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
50466
50767
|
/**
|
|
50467
50768
|
* Asked once the owner has signed in to Uber Eats, with the session\'s state; ubereats-service\'s list is answered as it is.
|
|
50468
50769
|
* @summary The Uber Eats stores the signed-in owner can connect
|
|
@@ -50541,6 +50842,14 @@ export declare const ProviderApiFp: (configuration?: Configuration) => {
|
|
|
50541
50842
|
* @throws {RequiredError}
|
|
50542
50843
|
*/
|
|
50543
50844
|
getOnboardingStatus(channel: ProviderEnum, businessId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOnboardingStatus200Response>>;
|
|
50845
|
+
/**
|
|
50846
|
+
* One entry per own channel the venue has rows on, active or not, by channel name: the channels this path\'s PUT adds a row for when the venue has none. A channel with several rows reads from the row PUT on this path answers with: the first active row, else the newest, by createdAt and then id. Nothing is changed.
|
|
50847
|
+
* @summary Read whether each of a venue\'s own channels is on and auto-accepting, and its integrations
|
|
50848
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
50849
|
+
* @param {*} [options] Override http request option.
|
|
50850
|
+
* @throws {RequiredError}
|
|
50851
|
+
*/
|
|
50852
|
+
getVenueProviders(businessId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueProvidersDto>>;
|
|
50544
50853
|
/**
|
|
50545
50854
|
* Asked once the owner has signed in to Uber Eats, with the session\'s state; ubereats-service\'s list is answered as it is.
|
|
50546
50855
|
* @summary The Uber Eats stores the signed-in owner can connect
|
|
@@ -50619,6 +50928,14 @@ export declare const ProviderApiFactory: (configuration?: Configuration, basePat
|
|
|
50619
50928
|
* @throws {RequiredError}
|
|
50620
50929
|
*/
|
|
50621
50930
|
getOnboardingStatus(channel: ProviderEnum, businessId: number, options?: any): AxiosPromise<GetOnboardingStatus200Response>;
|
|
50931
|
+
/**
|
|
50932
|
+
* One entry per own channel the venue has rows on, active or not, by channel name: the channels this path\'s PUT adds a row for when the venue has none. A channel with several rows reads from the row PUT on this path answers with: the first active row, else the newest, by createdAt and then id. Nothing is changed.
|
|
50933
|
+
* @summary Read whether each of a venue\'s own channels is on and auto-accepting, and its integrations
|
|
50934
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
50935
|
+
* @param {*} [options] Override http request option.
|
|
50936
|
+
* @throws {RequiredError}
|
|
50937
|
+
*/
|
|
50938
|
+
getVenueProviders(businessId: number, options?: any): AxiosPromise<VenueProvidersDto>;
|
|
50622
50939
|
/**
|
|
50623
50940
|
* Asked once the owner has signed in to Uber Eats, with the session\'s state; ubereats-service\'s list is answered as it is.
|
|
50624
50941
|
* @summary The Uber Eats stores the signed-in owner can connect
|
|
@@ -50702,6 +51019,15 @@ export interface ProviderApiInterface {
|
|
|
50702
51019
|
* @memberof ProviderApiInterface
|
|
50703
51020
|
*/
|
|
50704
51021
|
getOnboardingStatus(channel: ProviderEnum, businessId: number, options?: AxiosRequestConfig): AxiosPromise<GetOnboardingStatus200Response>;
|
|
51022
|
+
/**
|
|
51023
|
+
* One entry per own channel the venue has rows on, active or not, by channel name: the channels this path\'s PUT adds a row for when the venue has none. A channel with several rows reads from the row PUT on this path answers with: the first active row, else the newest, by createdAt and then id. Nothing is changed.
|
|
51024
|
+
* @summary Read whether each of a venue\'s own channels is on and auto-accepting, and its integrations
|
|
51025
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
51026
|
+
* @param {*} [options] Override http request option.
|
|
51027
|
+
* @throws {RequiredError}
|
|
51028
|
+
* @memberof ProviderApiInterface
|
|
51029
|
+
*/
|
|
51030
|
+
getVenueProviders(businessId: number, options?: AxiosRequestConfig): AxiosPromise<VenueProvidersDto>;
|
|
50705
51031
|
/**
|
|
50706
51032
|
* Asked once the owner has signed in to Uber Eats, with the session\'s state; ubereats-service\'s list is answered as it is.
|
|
50707
51033
|
* @summary The Uber Eats stores the signed-in owner can connect
|
|
@@ -50790,6 +51116,15 @@ export declare class ProviderApi extends BaseAPI implements ProviderApiInterface
|
|
|
50790
51116
|
* @memberof ProviderApi
|
|
50791
51117
|
*/
|
|
50792
51118
|
getOnboardingStatus(channel: ProviderEnum, businessId: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetOnboardingStatus200Response, any, {}>>;
|
|
51119
|
+
/**
|
|
51120
|
+
* One entry per own channel the venue has rows on, active or not, by channel name: the channels this path\'s PUT adds a row for when the venue has none. A channel with several rows reads from the row PUT on this path answers with: the first active row, else the newest, by createdAt and then id. Nothing is changed.
|
|
51121
|
+
* @summary Read whether each of a venue\'s own channels is on and auto-accepting, and its integrations
|
|
51122
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
51123
|
+
* @param {*} [options] Override http request option.
|
|
51124
|
+
* @throws {RequiredError}
|
|
51125
|
+
* @memberof ProviderApi
|
|
51126
|
+
*/
|
|
51127
|
+
getVenueProviders(businessId: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VenueProvidersDto, any, {}>>;
|
|
50793
51128
|
/**
|
|
50794
51129
|
* Asked once the owner has signed in to Uber Eats, with the session\'s state; ubereats-service\'s list is answered as it is.
|
|
50795
51130
|
* @summary The Uber Eats stores the signed-in owner can connect
|
|
@@ -55498,6 +55833,321 @@ export declare class VendureSellerApi extends BaseAPI implements VendureSellerAp
|
|
|
55498
55833
|
*/
|
|
55499
55834
|
upsert(vendureSellerUpsertDto: VendureSellerUpsertDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VendureSellerSavedDto, any, {}>>;
|
|
55500
55835
|
}
|
|
55836
|
+
/**
|
|
55837
|
+
* VenueKiosksApi - axios parameter creator
|
|
55838
|
+
* @export
|
|
55839
|
+
*/
|
|
55840
|
+
export declare const VenueKiosksApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
55841
|
+
/**
|
|
55842
|
+
* Only the fields sent change. status ACTIVE on a removed kiosk puts it back in use, asks the licence exactly as a claim does, and makes it the station the device resolves to. Every other change keeps the kiosk\'s updatedAt, so it never takes the device from a venue it moved to (the device resolves to its station with the newest updatedAt), and changes only a kiosk in use: one removed meanwhile answers 409. status INACTIVE takes the kiosk out of use and unlinks its terminal; on a kiosk already removed it answers the kiosk unchanged. Any other change of a removed kiosk is refused. The kiosk\'s kept station is forgotten, so the device sees the change on its next request.
|
|
55843
|
+
* @summary Rename a kiosk, change its prefix, or put it in or out of use
|
|
55844
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
55845
|
+
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
55846
|
+
* @param {ChangeKioskDto} changeKioskDto
|
|
55847
|
+
* @param {*} [options] Override http request option.
|
|
55848
|
+
* @throws {RequiredError}
|
|
55849
|
+
*/
|
|
55850
|
+
changeVenueKiosk: (businessId: number, stationId: string, changeKioskDto: ChangeKioskDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
55851
|
+
/**
|
|
55852
|
+
* The kiosk shows its Hardware ID on its Getting started screen until it is linked; the id is trimmed and written in the case the device sends it (an iOS vendor id upper case, an Android id lower case). A device that is one of the venue\'s tills, in use or not, or active at another venue, is refused first, before the licence is asked. A kiosk already in use here is only renamed, with no licence check. Otherwise the licence is read from the license server and must have the kiosk add-on; then, under a lock on the venue\'s kiosks and then one on the device, the device\'s other uses are checked again and the venue\'s active kiosks with this one must fit the licence\'s kiosk limit. The venue\'s station of the device becomes an active kiosk (type KIOSK), created when the venue has none (device KIOSK_STAND, prefix empty unless sent), with the name sent, and becomes the station the device resolves to; the kiosk then continues on its next check. A kiosk the venue already had, inactive, counts like a new one. Nothing is claimed unchecked: when the licence cannot be read, the claim is refused.
|
|
55853
|
+
* @summary Link a kiosk to the venue by the Hardware ID it shows
|
|
55854
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
55855
|
+
* @param {ClaimKioskDto} claimKioskDto
|
|
55856
|
+
* @param {*} [options] Override http request option.
|
|
55857
|
+
* @throws {RequiredError}
|
|
55858
|
+
*/
|
|
55859
|
+
claimVenueKiosk: (businessId: number, claimKioskDto: ClaimKioskDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
55860
|
+
/**
|
|
55861
|
+
* paymentTerminalId names one of the venue\'s stored terminals, or null unlinks the kiosk\'s terminal. A terminal another kiosk or till holds is refused, never taken from it. The kiosk\'s kept station is forgotten, so the kiosk pays on the new terminal from its next request.
|
|
55862
|
+
* @summary Link one of the venue\'s payment terminals to a kiosk, or unlink it
|
|
55863
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
55864
|
+
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
55865
|
+
* @param {LinkKioskTerminalDto} linkKioskTerminalDto
|
|
55866
|
+
* @param {*} [options] Override http request option.
|
|
55867
|
+
* @throws {RequiredError}
|
|
55868
|
+
*/
|
|
55869
|
+
linkVenueKioskTerminal: (businessId: number, stationId: string, linkKioskTerminalDto: LinkKioskTerminalDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
55870
|
+
/**
|
|
55871
|
+
* Every kiosk station of the venue, active or removed, oldest first, with its linked payment terminal. Read from the database every time.
|
|
55872
|
+
* @summary List the venue\'s kiosks
|
|
55873
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
55874
|
+
* @param {*} [options] Override http request option.
|
|
55875
|
+
* @throws {RequiredError}
|
|
55876
|
+
*/
|
|
55877
|
+
listVenueKiosks: (businessId: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
55878
|
+
/**
|
|
55879
|
+
* The venue\'s stored terminals, oldest first, each with the station it is linked to. A terminal is stored once a till discovered it at its provider (POST /v1/terminal/discover); this route asks no provider.
|
|
55880
|
+
* @summary List the venue\'s payment terminals, for linking one to a kiosk
|
|
55881
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
55882
|
+
* @param {*} [options] Override http request option.
|
|
55883
|
+
* @throws {RequiredError}
|
|
55884
|
+
*/
|
|
55885
|
+
listVenuePaymentTerminals: (businessId: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
55886
|
+
/**
|
|
55887
|
+
* The kiosk is set INACTIVE and its terminal unlinked; its row stays, so its orders keep their station and it can be claimed again. It no longer counts against the licence, and the kiosk shows its Getting started screen on its next check. Nothing is deleted. A kiosk already removed is answered as it is, unchanged.
|
|
55888
|
+
* @summary Remove a kiosk from use
|
|
55889
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
55890
|
+
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
55891
|
+
* @param {*} [options] Override http request option.
|
|
55892
|
+
* @throws {RequiredError}
|
|
55893
|
+
*/
|
|
55894
|
+
removeVenueKiosk: (businessId: number, stationId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
55895
|
+
};
|
|
55896
|
+
/**
|
|
55897
|
+
* VenueKiosksApi - functional programming interface
|
|
55898
|
+
* @export
|
|
55899
|
+
*/
|
|
55900
|
+
export declare const VenueKiosksApiFp: (configuration?: Configuration) => {
|
|
55901
|
+
/**
|
|
55902
|
+
* Only the fields sent change. status ACTIVE on a removed kiosk puts it back in use, asks the licence exactly as a claim does, and makes it the station the device resolves to. Every other change keeps the kiosk\'s updatedAt, so it never takes the device from a venue it moved to (the device resolves to its station with the newest updatedAt), and changes only a kiosk in use: one removed meanwhile answers 409. status INACTIVE takes the kiosk out of use and unlinks its terminal; on a kiosk already removed it answers the kiosk unchanged. Any other change of a removed kiosk is refused. The kiosk\'s kept station is forgotten, so the device sees the change on its next request.
|
|
55903
|
+
* @summary Rename a kiosk, change its prefix, or put it in or out of use
|
|
55904
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
55905
|
+
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
55906
|
+
* @param {ChangeKioskDto} changeKioskDto
|
|
55907
|
+
* @param {*} [options] Override http request option.
|
|
55908
|
+
* @throws {RequiredError}
|
|
55909
|
+
*/
|
|
55910
|
+
changeVenueKiosk(businessId: number, stationId: string, changeKioskDto: ChangeKioskDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueKioskDto>>;
|
|
55911
|
+
/**
|
|
55912
|
+
* The kiosk shows its Hardware ID on its Getting started screen until it is linked; the id is trimmed and written in the case the device sends it (an iOS vendor id upper case, an Android id lower case). A device that is one of the venue\'s tills, in use or not, or active at another venue, is refused first, before the licence is asked. A kiosk already in use here is only renamed, with no licence check. Otherwise the licence is read from the license server and must have the kiosk add-on; then, under a lock on the venue\'s kiosks and then one on the device, the device\'s other uses are checked again and the venue\'s active kiosks with this one must fit the licence\'s kiosk limit. The venue\'s station of the device becomes an active kiosk (type KIOSK), created when the venue has none (device KIOSK_STAND, prefix empty unless sent), with the name sent, and becomes the station the device resolves to; the kiosk then continues on its next check. A kiosk the venue already had, inactive, counts like a new one. Nothing is claimed unchecked: when the licence cannot be read, the claim is refused.
|
|
55913
|
+
* @summary Link a kiosk to the venue by the Hardware ID it shows
|
|
55914
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
55915
|
+
* @param {ClaimKioskDto} claimKioskDto
|
|
55916
|
+
* @param {*} [options] Override http request option.
|
|
55917
|
+
* @throws {RequiredError}
|
|
55918
|
+
*/
|
|
55919
|
+
claimVenueKiosk(businessId: number, claimKioskDto: ClaimKioskDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueKioskDto>>;
|
|
55920
|
+
/**
|
|
55921
|
+
* paymentTerminalId names one of the venue\'s stored terminals, or null unlinks the kiosk\'s terminal. A terminal another kiosk or till holds is refused, never taken from it. The kiosk\'s kept station is forgotten, so the kiosk pays on the new terminal from its next request.
|
|
55922
|
+
* @summary Link one of the venue\'s payment terminals to a kiosk, or unlink it
|
|
55923
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
55924
|
+
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
55925
|
+
* @param {LinkKioskTerminalDto} linkKioskTerminalDto
|
|
55926
|
+
* @param {*} [options] Override http request option.
|
|
55927
|
+
* @throws {RequiredError}
|
|
55928
|
+
*/
|
|
55929
|
+
linkVenueKioskTerminal(businessId: number, stationId: string, linkKioskTerminalDto: LinkKioskTerminalDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueKioskDto>>;
|
|
55930
|
+
/**
|
|
55931
|
+
* Every kiosk station of the venue, active or removed, oldest first, with its linked payment terminal. Read from the database every time.
|
|
55932
|
+
* @summary List the venue\'s kiosks
|
|
55933
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
55934
|
+
* @param {*} [options] Override http request option.
|
|
55935
|
+
* @throws {RequiredError}
|
|
55936
|
+
*/
|
|
55937
|
+
listVenueKiosks(businessId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueKiosksDto>>;
|
|
55938
|
+
/**
|
|
55939
|
+
* The venue\'s stored terminals, oldest first, each with the station it is linked to. A terminal is stored once a till discovered it at its provider (POST /v1/terminal/discover); this route asks no provider.
|
|
55940
|
+
* @summary List the venue\'s payment terminals, for linking one to a kiosk
|
|
55941
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
55942
|
+
* @param {*} [options] Override http request option.
|
|
55943
|
+
* @throws {RequiredError}
|
|
55944
|
+
*/
|
|
55945
|
+
listVenuePaymentTerminals(businessId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenuePaymentTerminalsDto>>;
|
|
55946
|
+
/**
|
|
55947
|
+
* The kiosk is set INACTIVE and its terminal unlinked; its row stays, so its orders keep their station and it can be claimed again. It no longer counts against the licence, and the kiosk shows its Getting started screen on its next check. Nothing is deleted. A kiosk already removed is answered as it is, unchanged.
|
|
55948
|
+
* @summary Remove a kiosk from use
|
|
55949
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
55950
|
+
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
55951
|
+
* @param {*} [options] Override http request option.
|
|
55952
|
+
* @throws {RequiredError}
|
|
55953
|
+
*/
|
|
55954
|
+
removeVenueKiosk(businessId: number, stationId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueKioskDto>>;
|
|
55955
|
+
};
|
|
55956
|
+
/**
|
|
55957
|
+
* VenueKiosksApi - factory interface
|
|
55958
|
+
* @export
|
|
55959
|
+
*/
|
|
55960
|
+
export declare const VenueKiosksApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
55961
|
+
/**
|
|
55962
|
+
* Only the fields sent change. status ACTIVE on a removed kiosk puts it back in use, asks the licence exactly as a claim does, and makes it the station the device resolves to. Every other change keeps the kiosk\'s updatedAt, so it never takes the device from a venue it moved to (the device resolves to its station with the newest updatedAt), and changes only a kiosk in use: one removed meanwhile answers 409. status INACTIVE takes the kiosk out of use and unlinks its terminal; on a kiosk already removed it answers the kiosk unchanged. Any other change of a removed kiosk is refused. The kiosk\'s kept station is forgotten, so the device sees the change on its next request.
|
|
55963
|
+
* @summary Rename a kiosk, change its prefix, or put it in or out of use
|
|
55964
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
55965
|
+
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
55966
|
+
* @param {ChangeKioskDto} changeKioskDto
|
|
55967
|
+
* @param {*} [options] Override http request option.
|
|
55968
|
+
* @throws {RequiredError}
|
|
55969
|
+
*/
|
|
55970
|
+
changeVenueKiosk(businessId: number, stationId: string, changeKioskDto: ChangeKioskDto, options?: any): AxiosPromise<VenueKioskDto>;
|
|
55971
|
+
/**
|
|
55972
|
+
* The kiosk shows its Hardware ID on its Getting started screen until it is linked; the id is trimmed and written in the case the device sends it (an iOS vendor id upper case, an Android id lower case). A device that is one of the venue\'s tills, in use or not, or active at another venue, is refused first, before the licence is asked. A kiosk already in use here is only renamed, with no licence check. Otherwise the licence is read from the license server and must have the kiosk add-on; then, under a lock on the venue\'s kiosks and then one on the device, the device\'s other uses are checked again and the venue\'s active kiosks with this one must fit the licence\'s kiosk limit. The venue\'s station of the device becomes an active kiosk (type KIOSK), created when the venue has none (device KIOSK_STAND, prefix empty unless sent), with the name sent, and becomes the station the device resolves to; the kiosk then continues on its next check. A kiosk the venue already had, inactive, counts like a new one. Nothing is claimed unchecked: when the licence cannot be read, the claim is refused.
|
|
55973
|
+
* @summary Link a kiosk to the venue by the Hardware ID it shows
|
|
55974
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
55975
|
+
* @param {ClaimKioskDto} claimKioskDto
|
|
55976
|
+
* @param {*} [options] Override http request option.
|
|
55977
|
+
* @throws {RequiredError}
|
|
55978
|
+
*/
|
|
55979
|
+
claimVenueKiosk(businessId: number, claimKioskDto: ClaimKioskDto, options?: any): AxiosPromise<VenueKioskDto>;
|
|
55980
|
+
/**
|
|
55981
|
+
* paymentTerminalId names one of the venue\'s stored terminals, or null unlinks the kiosk\'s terminal. A terminal another kiosk or till holds is refused, never taken from it. The kiosk\'s kept station is forgotten, so the kiosk pays on the new terminal from its next request.
|
|
55982
|
+
* @summary Link one of the venue\'s payment terminals to a kiosk, or unlink it
|
|
55983
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
55984
|
+
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
55985
|
+
* @param {LinkKioskTerminalDto} linkKioskTerminalDto
|
|
55986
|
+
* @param {*} [options] Override http request option.
|
|
55987
|
+
* @throws {RequiredError}
|
|
55988
|
+
*/
|
|
55989
|
+
linkVenueKioskTerminal(businessId: number, stationId: string, linkKioskTerminalDto: LinkKioskTerminalDto, options?: any): AxiosPromise<VenueKioskDto>;
|
|
55990
|
+
/**
|
|
55991
|
+
* Every kiosk station of the venue, active or removed, oldest first, with its linked payment terminal. Read from the database every time.
|
|
55992
|
+
* @summary List the venue\'s kiosks
|
|
55993
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
55994
|
+
* @param {*} [options] Override http request option.
|
|
55995
|
+
* @throws {RequiredError}
|
|
55996
|
+
*/
|
|
55997
|
+
listVenueKiosks(businessId: number, options?: any): AxiosPromise<VenueKiosksDto>;
|
|
55998
|
+
/**
|
|
55999
|
+
* The venue\'s stored terminals, oldest first, each with the station it is linked to. A terminal is stored once a till discovered it at its provider (POST /v1/terminal/discover); this route asks no provider.
|
|
56000
|
+
* @summary List the venue\'s payment terminals, for linking one to a kiosk
|
|
56001
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56002
|
+
* @param {*} [options] Override http request option.
|
|
56003
|
+
* @throws {RequiredError}
|
|
56004
|
+
*/
|
|
56005
|
+
listVenuePaymentTerminals(businessId: number, options?: any): AxiosPromise<VenuePaymentTerminalsDto>;
|
|
56006
|
+
/**
|
|
56007
|
+
* The kiosk is set INACTIVE and its terminal unlinked; its row stays, so its orders keep their station and it can be claimed again. It no longer counts against the licence, and the kiosk shows its Getting started screen on its next check. Nothing is deleted. A kiosk already removed is answered as it is, unchanged.
|
|
56008
|
+
* @summary Remove a kiosk from use
|
|
56009
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56010
|
+
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
56011
|
+
* @param {*} [options] Override http request option.
|
|
56012
|
+
* @throws {RequiredError}
|
|
56013
|
+
*/
|
|
56014
|
+
removeVenueKiosk(businessId: number, stationId: string, options?: any): AxiosPromise<VenueKioskDto>;
|
|
56015
|
+
};
|
|
56016
|
+
/**
|
|
56017
|
+
* VenueKiosksApi - interface
|
|
56018
|
+
* @export
|
|
56019
|
+
* @interface VenueKiosksApi
|
|
56020
|
+
*/
|
|
56021
|
+
export interface VenueKiosksApiInterface {
|
|
56022
|
+
/**
|
|
56023
|
+
* Only the fields sent change. status ACTIVE on a removed kiosk puts it back in use, asks the licence exactly as a claim does, and makes it the station the device resolves to. Every other change keeps the kiosk\'s updatedAt, so it never takes the device from a venue it moved to (the device resolves to its station with the newest updatedAt), and changes only a kiosk in use: one removed meanwhile answers 409. status INACTIVE takes the kiosk out of use and unlinks its terminal; on a kiosk already removed it answers the kiosk unchanged. Any other change of a removed kiosk is refused. The kiosk\'s kept station is forgotten, so the device sees the change on its next request.
|
|
56024
|
+
* @summary Rename a kiosk, change its prefix, or put it in or out of use
|
|
56025
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56026
|
+
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
56027
|
+
* @param {ChangeKioskDto} changeKioskDto
|
|
56028
|
+
* @param {*} [options] Override http request option.
|
|
56029
|
+
* @throws {RequiredError}
|
|
56030
|
+
* @memberof VenueKiosksApiInterface
|
|
56031
|
+
*/
|
|
56032
|
+
changeVenueKiosk(businessId: number, stationId: string, changeKioskDto: ChangeKioskDto, options?: AxiosRequestConfig): AxiosPromise<VenueKioskDto>;
|
|
56033
|
+
/**
|
|
56034
|
+
* The kiosk shows its Hardware ID on its Getting started screen until it is linked; the id is trimmed and written in the case the device sends it (an iOS vendor id upper case, an Android id lower case). A device that is one of the venue\'s tills, in use or not, or active at another venue, is refused first, before the licence is asked. A kiosk already in use here is only renamed, with no licence check. Otherwise the licence is read from the license server and must have the kiosk add-on; then, under a lock on the venue\'s kiosks and then one on the device, the device\'s other uses are checked again and the venue\'s active kiosks with this one must fit the licence\'s kiosk limit. The venue\'s station of the device becomes an active kiosk (type KIOSK), created when the venue has none (device KIOSK_STAND, prefix empty unless sent), with the name sent, and becomes the station the device resolves to; the kiosk then continues on its next check. A kiosk the venue already had, inactive, counts like a new one. Nothing is claimed unchecked: when the licence cannot be read, the claim is refused.
|
|
56035
|
+
* @summary Link a kiosk to the venue by the Hardware ID it shows
|
|
56036
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56037
|
+
* @param {ClaimKioskDto} claimKioskDto
|
|
56038
|
+
* @param {*} [options] Override http request option.
|
|
56039
|
+
* @throws {RequiredError}
|
|
56040
|
+
* @memberof VenueKiosksApiInterface
|
|
56041
|
+
*/
|
|
56042
|
+
claimVenueKiosk(businessId: number, claimKioskDto: ClaimKioskDto, options?: AxiosRequestConfig): AxiosPromise<VenueKioskDto>;
|
|
56043
|
+
/**
|
|
56044
|
+
* paymentTerminalId names one of the venue\'s stored terminals, or null unlinks the kiosk\'s terminal. A terminal another kiosk or till holds is refused, never taken from it. The kiosk\'s kept station is forgotten, so the kiosk pays on the new terminal from its next request.
|
|
56045
|
+
* @summary Link one of the venue\'s payment terminals to a kiosk, or unlink it
|
|
56046
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56047
|
+
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
56048
|
+
* @param {LinkKioskTerminalDto} linkKioskTerminalDto
|
|
56049
|
+
* @param {*} [options] Override http request option.
|
|
56050
|
+
* @throws {RequiredError}
|
|
56051
|
+
* @memberof VenueKiosksApiInterface
|
|
56052
|
+
*/
|
|
56053
|
+
linkVenueKioskTerminal(businessId: number, stationId: string, linkKioskTerminalDto: LinkKioskTerminalDto, options?: AxiosRequestConfig): AxiosPromise<VenueKioskDto>;
|
|
56054
|
+
/**
|
|
56055
|
+
* Every kiosk station of the venue, active or removed, oldest first, with its linked payment terminal. Read from the database every time.
|
|
56056
|
+
* @summary List the venue\'s kiosks
|
|
56057
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56058
|
+
* @param {*} [options] Override http request option.
|
|
56059
|
+
* @throws {RequiredError}
|
|
56060
|
+
* @memberof VenueKiosksApiInterface
|
|
56061
|
+
*/
|
|
56062
|
+
listVenueKiosks(businessId: number, options?: AxiosRequestConfig): AxiosPromise<VenueKiosksDto>;
|
|
56063
|
+
/**
|
|
56064
|
+
* The venue\'s stored terminals, oldest first, each with the station it is linked to. A terminal is stored once a till discovered it at its provider (POST /v1/terminal/discover); this route asks no provider.
|
|
56065
|
+
* @summary List the venue\'s payment terminals, for linking one to a kiosk
|
|
56066
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56067
|
+
* @param {*} [options] Override http request option.
|
|
56068
|
+
* @throws {RequiredError}
|
|
56069
|
+
* @memberof VenueKiosksApiInterface
|
|
56070
|
+
*/
|
|
56071
|
+
listVenuePaymentTerminals(businessId: number, options?: AxiosRequestConfig): AxiosPromise<VenuePaymentTerminalsDto>;
|
|
56072
|
+
/**
|
|
56073
|
+
* The kiosk is set INACTIVE and its terminal unlinked; its row stays, so its orders keep their station and it can be claimed again. It no longer counts against the licence, and the kiosk shows its Getting started screen on its next check. Nothing is deleted. A kiosk already removed is answered as it is, unchanged.
|
|
56074
|
+
* @summary Remove a kiosk from use
|
|
56075
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56076
|
+
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
56077
|
+
* @param {*} [options] Override http request option.
|
|
56078
|
+
* @throws {RequiredError}
|
|
56079
|
+
* @memberof VenueKiosksApiInterface
|
|
56080
|
+
*/
|
|
56081
|
+
removeVenueKiosk(businessId: number, stationId: string, options?: AxiosRequestConfig): AxiosPromise<VenueKioskDto>;
|
|
56082
|
+
}
|
|
56083
|
+
/**
|
|
56084
|
+
* VenueKiosksApi - object-oriented interface
|
|
56085
|
+
* @export
|
|
56086
|
+
* @class VenueKiosksApi
|
|
56087
|
+
* @extends {BaseAPI}
|
|
56088
|
+
*/
|
|
56089
|
+
export declare class VenueKiosksApi extends BaseAPI implements VenueKiosksApiInterface {
|
|
56090
|
+
/**
|
|
56091
|
+
* Only the fields sent change. status ACTIVE on a removed kiosk puts it back in use, asks the licence exactly as a claim does, and makes it the station the device resolves to. Every other change keeps the kiosk\'s updatedAt, so it never takes the device from a venue it moved to (the device resolves to its station with the newest updatedAt), and changes only a kiosk in use: one removed meanwhile answers 409. status INACTIVE takes the kiosk out of use and unlinks its terminal; on a kiosk already removed it answers the kiosk unchanged. Any other change of a removed kiosk is refused. The kiosk\'s kept station is forgotten, so the device sees the change on its next request.
|
|
56092
|
+
* @summary Rename a kiosk, change its prefix, or put it in or out of use
|
|
56093
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56094
|
+
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
56095
|
+
* @param {ChangeKioskDto} changeKioskDto
|
|
56096
|
+
* @param {*} [options] Override http request option.
|
|
56097
|
+
* @throws {RequiredError}
|
|
56098
|
+
* @memberof VenueKiosksApi
|
|
56099
|
+
*/
|
|
56100
|
+
changeVenueKiosk(businessId: number, stationId: string, changeKioskDto: ChangeKioskDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VenueKioskDto, any, {}>>;
|
|
56101
|
+
/**
|
|
56102
|
+
* The kiosk shows its Hardware ID on its Getting started screen until it is linked; the id is trimmed and written in the case the device sends it (an iOS vendor id upper case, an Android id lower case). A device that is one of the venue\'s tills, in use or not, or active at another venue, is refused first, before the licence is asked. A kiosk already in use here is only renamed, with no licence check. Otherwise the licence is read from the license server and must have the kiosk add-on; then, under a lock on the venue\'s kiosks and then one on the device, the device\'s other uses are checked again and the venue\'s active kiosks with this one must fit the licence\'s kiosk limit. The venue\'s station of the device becomes an active kiosk (type KIOSK), created when the venue has none (device KIOSK_STAND, prefix empty unless sent), with the name sent, and becomes the station the device resolves to; the kiosk then continues on its next check. A kiosk the venue already had, inactive, counts like a new one. Nothing is claimed unchecked: when the licence cannot be read, the claim is refused.
|
|
56103
|
+
* @summary Link a kiosk to the venue by the Hardware ID it shows
|
|
56104
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56105
|
+
* @param {ClaimKioskDto} claimKioskDto
|
|
56106
|
+
* @param {*} [options] Override http request option.
|
|
56107
|
+
* @throws {RequiredError}
|
|
56108
|
+
* @memberof VenueKiosksApi
|
|
56109
|
+
*/
|
|
56110
|
+
claimVenueKiosk(businessId: number, claimKioskDto: ClaimKioskDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VenueKioskDto, any, {}>>;
|
|
56111
|
+
/**
|
|
56112
|
+
* paymentTerminalId names one of the venue\'s stored terminals, or null unlinks the kiosk\'s terminal. A terminal another kiosk or till holds is refused, never taken from it. The kiosk\'s kept station is forgotten, so the kiosk pays on the new terminal from its next request.
|
|
56113
|
+
* @summary Link one of the venue\'s payment terminals to a kiosk, or unlink it
|
|
56114
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56115
|
+
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
56116
|
+
* @param {LinkKioskTerminalDto} linkKioskTerminalDto
|
|
56117
|
+
* @param {*} [options] Override http request option.
|
|
56118
|
+
* @throws {RequiredError}
|
|
56119
|
+
* @memberof VenueKiosksApi
|
|
56120
|
+
*/
|
|
56121
|
+
linkVenueKioskTerminal(businessId: number, stationId: string, linkKioskTerminalDto: LinkKioskTerminalDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VenueKioskDto, any, {}>>;
|
|
56122
|
+
/**
|
|
56123
|
+
* Every kiosk station of the venue, active or removed, oldest first, with its linked payment terminal. Read from the database every time.
|
|
56124
|
+
* @summary List the venue\'s kiosks
|
|
56125
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56126
|
+
* @param {*} [options] Override http request option.
|
|
56127
|
+
* @throws {RequiredError}
|
|
56128
|
+
* @memberof VenueKiosksApi
|
|
56129
|
+
*/
|
|
56130
|
+
listVenueKiosks(businessId: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VenueKiosksDto, any, {}>>;
|
|
56131
|
+
/**
|
|
56132
|
+
* The venue\'s stored terminals, oldest first, each with the station it is linked to. A terminal is stored once a till discovered it at its provider (POST /v1/terminal/discover); this route asks no provider.
|
|
56133
|
+
* @summary List the venue\'s payment terminals, for linking one to a kiosk
|
|
56134
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56135
|
+
* @param {*} [options] Override http request option.
|
|
56136
|
+
* @throws {RequiredError}
|
|
56137
|
+
* @memberof VenueKiosksApi
|
|
56138
|
+
*/
|
|
56139
|
+
listVenuePaymentTerminals(businessId: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VenuePaymentTerminalsDto, any, {}>>;
|
|
56140
|
+
/**
|
|
56141
|
+
* The kiosk is set INACTIVE and its terminal unlinked; its row stays, so its orders keep their station and it can be claimed again. It no longer counts against the licence, and the kiosk shows its Getting started screen on its next check. Nothing is deleted. A kiosk already removed is answered as it is, unchanged.
|
|
56142
|
+
* @summary Remove a kiosk from use
|
|
56143
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56144
|
+
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
56145
|
+
* @param {*} [options] Override http request option.
|
|
56146
|
+
* @throws {RequiredError}
|
|
56147
|
+
* @memberof VenueKiosksApi
|
|
56148
|
+
*/
|
|
56149
|
+
removeVenueKiosk(businessId: number, stationId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VenueKioskDto, any, {}>>;
|
|
56150
|
+
}
|
|
55501
56151
|
/**
|
|
55502
56152
|
* VivaApi - axios parameter creator
|
|
55503
56153
|
* @export
|