@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/generated/api.ts
CHANGED
|
@@ -2669,6 +2669,33 @@ export interface ChangeEmployeeRoleDto {
|
|
|
2669
2669
|
*/
|
|
2670
2670
|
'permissionKeys'?: Array<PosPermission>;
|
|
2671
2671
|
}
|
|
2672
|
+
/**
|
|
2673
|
+
*
|
|
2674
|
+
* @export
|
|
2675
|
+
* @interface ChangeKioskDto
|
|
2676
|
+
*/
|
|
2677
|
+
export interface ChangeKioskDto {
|
|
2678
|
+
/**
|
|
2679
|
+
* The kiosk\'s new name; left out, it keeps its name
|
|
2680
|
+
* @type {string}
|
|
2681
|
+
* @memberof ChangeKioskDto
|
|
2682
|
+
*/
|
|
2683
|
+
'name'?: string;
|
|
2684
|
+
/**
|
|
2685
|
+
* What the kiosk\'s order numbers start with, an empty text for none; left out, it keeps its prefix
|
|
2686
|
+
* @type {string}
|
|
2687
|
+
* @memberof ChangeKioskDto
|
|
2688
|
+
*/
|
|
2689
|
+
'prefix'?: string;
|
|
2690
|
+
/**
|
|
2691
|
+
*
|
|
2692
|
+
* @type {Status}
|
|
2693
|
+
* @memberof ChangeKioskDto
|
|
2694
|
+
*/
|
|
2695
|
+
'status'?: Status;
|
|
2696
|
+
}
|
|
2697
|
+
|
|
2698
|
+
|
|
2672
2699
|
/**
|
|
2673
2700
|
*
|
|
2674
2701
|
* @export
|
|
@@ -3145,6 +3172,31 @@ export const CheckoutModelEnum = {
|
|
|
3145
3172
|
export type CheckoutModelEnum = typeof CheckoutModelEnum[keyof typeof CheckoutModelEnum];
|
|
3146
3173
|
|
|
3147
3174
|
|
|
3175
|
+
/**
|
|
3176
|
+
*
|
|
3177
|
+
* @export
|
|
3178
|
+
* @interface ClaimKioskDto
|
|
3179
|
+
*/
|
|
3180
|
+
export interface ClaimKioskDto {
|
|
3181
|
+
/**
|
|
3182
|
+
* The Hardware ID the kiosk shows on its Getting started screen, exactly as shown; it is the id the device sends in X-Munchi-Hardware-Id
|
|
3183
|
+
* @type {string}
|
|
3184
|
+
* @memberof ClaimKioskDto
|
|
3185
|
+
*/
|
|
3186
|
+
'hardwareId': string;
|
|
3187
|
+
/**
|
|
3188
|
+
* The kiosk\'s name, as the venue\'s staff call it
|
|
3189
|
+
* @type {string}
|
|
3190
|
+
* @memberof ClaimKioskDto
|
|
3191
|
+
*/
|
|
3192
|
+
'name': string;
|
|
3193
|
+
/**
|
|
3194
|
+
* What the kiosk\'s order numbers start with. Left out, a new kiosk has none and a kiosk the venue had keeps its own
|
|
3195
|
+
* @type {string}
|
|
3196
|
+
* @memberof ClaimKioskDto
|
|
3197
|
+
*/
|
|
3198
|
+
'prefix'?: string;
|
|
3199
|
+
}
|
|
3148
3200
|
/**
|
|
3149
3201
|
*
|
|
3150
3202
|
* @export
|
|
@@ -5121,6 +5173,12 @@ export interface CreateSavedReportDto {
|
|
|
5121
5173
|
* @memberof CreateSavedReportDto
|
|
5122
5174
|
*/
|
|
5123
5175
|
'filters': SavedReportDtoFilters;
|
|
5176
|
+
/**
|
|
5177
|
+
*
|
|
5178
|
+
* @type {ReadyMadeReport}
|
|
5179
|
+
* @memberof CreateSavedReportDto
|
|
5180
|
+
*/
|
|
5181
|
+
'readyMadeReport'?: ReadyMadeReport | null;
|
|
5124
5182
|
/**
|
|
5125
5183
|
*
|
|
5126
5184
|
* @type {SavedReportVisibility}
|
|
@@ -11403,6 +11461,33 @@ export interface KioskStatusDto {
|
|
|
11403
11461
|
}
|
|
11404
11462
|
|
|
11405
11463
|
|
|
11464
|
+
/**
|
|
11465
|
+
*
|
|
11466
|
+
* @export
|
|
11467
|
+
* @interface KioskTerminalDto
|
|
11468
|
+
*/
|
|
11469
|
+
export interface KioskTerminalDto {
|
|
11470
|
+
/**
|
|
11471
|
+
* The payment terminal\'s id
|
|
11472
|
+
* @type {string}
|
|
11473
|
+
* @memberof KioskTerminalDto
|
|
11474
|
+
*/
|
|
11475
|
+
'id': string;
|
|
11476
|
+
/**
|
|
11477
|
+
*
|
|
11478
|
+
* @type {PaymentProvider}
|
|
11479
|
+
* @memberof KioskTerminalDto
|
|
11480
|
+
*/
|
|
11481
|
+
'provider': PaymentProvider;
|
|
11482
|
+
/**
|
|
11483
|
+
* The terminal\'s label; null when it was given none
|
|
11484
|
+
* @type {string}
|
|
11485
|
+
* @memberof KioskTerminalDto
|
|
11486
|
+
*/
|
|
11487
|
+
'label': string | null;
|
|
11488
|
+
}
|
|
11489
|
+
|
|
11490
|
+
|
|
11406
11491
|
/**
|
|
11407
11492
|
*
|
|
11408
11493
|
* @export
|
|
@@ -11537,6 +11622,19 @@ export interface LapseResponseDto {
|
|
|
11537
11622
|
*/
|
|
11538
11623
|
'businessDayScheduleId': string;
|
|
11539
11624
|
}
|
|
11625
|
+
/**
|
|
11626
|
+
*
|
|
11627
|
+
* @export
|
|
11628
|
+
* @interface LinkKioskTerminalDto
|
|
11629
|
+
*/
|
|
11630
|
+
export interface LinkKioskTerminalDto {
|
|
11631
|
+
/**
|
|
11632
|
+
* 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
|
|
11633
|
+
* @type {string}
|
|
11634
|
+
* @memberof LinkKioskTerminalDto
|
|
11635
|
+
*/
|
|
11636
|
+
'paymentTerminalId': string | null;
|
|
11637
|
+
}
|
|
11540
11638
|
/**
|
|
11541
11639
|
*
|
|
11542
11640
|
* @export
|
|
@@ -14805,7 +14903,7 @@ export interface OrderHistoryPosResponseDtoV2Pagination {
|
|
|
14805
14903
|
*/
|
|
14806
14904
|
export interface OrderHistoryPosResponseDtoV2Summary {
|
|
14807
14905
|
/**
|
|
14808
|
-
* How many orders of the period count: online, every order
|
|
14906
|
+
* How many orders of the period count: online, every order neither rejected nor fully refunded; POS, every order not fully refunded (with a payment filter, only those with a matching payment). 0 when the person on the till may not see it.
|
|
14809
14907
|
* @type {number}
|
|
14810
14908
|
* @memberof OrderHistoryPosResponseDtoV2Summary
|
|
14811
14909
|
*/
|
|
@@ -14817,7 +14915,7 @@ export interface OrderHistoryPosResponseDtoV2Summary {
|
|
|
14817
14915
|
*/
|
|
14818
14916
|
'rejectedOrders': number;
|
|
14819
14917
|
/**
|
|
14820
|
-
* The period\'s sales in euros (not cents): online, the net total of the orders
|
|
14918
|
+
* The period\'s sales in euros (not cents): online, the net total of the orders neither rejected nor fully refunded, less their completed refunds; POS, the payments less successful refunds. 0 when the person on the till may not see it.
|
|
14821
14919
|
* @type {number}
|
|
14822
14920
|
* @memberof OrderHistoryPosResponseDtoV2Summary
|
|
14823
14921
|
*/
|
|
@@ -14873,7 +14971,7 @@ export interface OrderHistoryResponseDto {
|
|
|
14873
14971
|
*/
|
|
14874
14972
|
export interface OrderHistoryResponseDtoSummary {
|
|
14875
14973
|
/**
|
|
14876
|
-
* How many orders of the period count: online, every order
|
|
14974
|
+
* How many orders of the period count: online, every order neither rejected nor fully refunded; POS, every order not fully refunded (with a payment filter, only those with a matching payment). 0 when the person on the till may not see it.
|
|
14877
14975
|
* @type {number}
|
|
14878
14976
|
* @memberof OrderHistoryResponseDtoSummary
|
|
14879
14977
|
*/
|
|
@@ -14885,7 +14983,7 @@ export interface OrderHistoryResponseDtoSummary {
|
|
|
14885
14983
|
*/
|
|
14886
14984
|
'rejectedOrders': number;
|
|
14887
14985
|
/**
|
|
14888
|
-
* The period\'s sales in euros (not cents): online, the net total of the orders
|
|
14986
|
+
* The period\'s sales in euros (not cents): online, the net total of the orders neither rejected nor fully refunded, less their completed refunds; POS, the payments less successful refunds. 0 when the person on the till may not see it.
|
|
14889
14987
|
* @type {number}
|
|
14890
14988
|
* @memberof OrderHistoryResponseDtoSummary
|
|
14891
14989
|
*/
|
|
@@ -15911,7 +16009,7 @@ export interface OrderStatusResponseDtoOrder {
|
|
|
15911
16009
|
*/
|
|
15912
16010
|
export interface OrderSummaryDto {
|
|
15913
16011
|
/**
|
|
15914
|
-
* How many orders of the period count: online, every order
|
|
16012
|
+
* How many orders of the period count: online, every order neither rejected nor fully refunded; POS, every order not fully refunded (with a payment filter, only those with a matching payment). 0 when the person on the till may not see it.
|
|
15915
16013
|
* @type {number}
|
|
15916
16014
|
* @memberof OrderSummaryDto
|
|
15917
16015
|
*/
|
|
@@ -15923,7 +16021,7 @@ export interface OrderSummaryDto {
|
|
|
15923
16021
|
*/
|
|
15924
16022
|
'rejectedOrders': number;
|
|
15925
16023
|
/**
|
|
15926
|
-
* The period\'s sales in euros (not cents): online, the net total of the orders
|
|
16024
|
+
* The period\'s sales in euros (not cents): online, the net total of the orders neither rejected nor fully refunded, less their completed refunds; POS, the payments less successful refunds. 0 when the person on the till may not see it.
|
|
15927
16025
|
* @type {number}
|
|
15928
16026
|
* @memberof OrderSummaryDto
|
|
15929
16027
|
*/
|
|
@@ -21802,7 +21900,7 @@ export interface PosOrderSuboptionDto {
|
|
|
21802
21900
|
*/
|
|
21803
21901
|
export interface PosOrderSummaryDto {
|
|
21804
21902
|
/**
|
|
21805
|
-
* How many orders of the period count: online, every order
|
|
21903
|
+
* How many orders of the period count: online, every order neither rejected nor fully refunded; POS, every order not fully refunded (with a payment filter, only those with a matching payment). 0 when the person on the till may not see it.
|
|
21806
21904
|
* @type {number}
|
|
21807
21905
|
* @memberof PosOrderSummaryDto
|
|
21808
21906
|
*/
|
|
@@ -21814,7 +21912,7 @@ export interface PosOrderSummaryDto {
|
|
|
21814
21912
|
*/
|
|
21815
21913
|
'rejectedOrders': number;
|
|
21816
21914
|
/**
|
|
21817
|
-
* The period\'s sales in euros (not cents): online, the net total of the orders
|
|
21915
|
+
* The period\'s sales in euros (not cents): online, the net total of the orders neither rejected nor fully refunded, less their completed refunds; POS, the payments less successful refunds. 0 when the person on the till may not see it.
|
|
21818
21916
|
* @type {number}
|
|
21819
21917
|
* @memberof PosOrderSummaryDto
|
|
21820
21918
|
*/
|
|
@@ -24850,6 +24948,12 @@ export interface PublicSavedReportDto {
|
|
|
24850
24948
|
* @memberof PublicSavedReportDto
|
|
24851
24949
|
*/
|
|
24852
24950
|
'filters': SavedReportDtoFilters;
|
|
24951
|
+
/**
|
|
24952
|
+
*
|
|
24953
|
+
* @type {ReadyMadeReport}
|
|
24954
|
+
* @memberof PublicSavedReportDto
|
|
24955
|
+
*/
|
|
24956
|
+
'readyMadeReport'?: ReadyMadeReport | null;
|
|
24853
24957
|
/**
|
|
24854
24958
|
* The store whose data the report reads, by orderingBusinessId; null for an organisation\'s
|
|
24855
24959
|
* @type {number}
|
|
@@ -29407,6 +29511,12 @@ export interface SalesReportStaffMemberDto {
|
|
|
29407
29511
|
* @memberof SalesReportStaffMemberDto
|
|
29408
29512
|
*/
|
|
29409
29513
|
'staffId': string;
|
|
29514
|
+
/**
|
|
29515
|
+
* The staff member\'s name; null for the orders that name nobody, or a person who left the venue
|
|
29516
|
+
* @type {string}
|
|
29517
|
+
* @memberof SalesReportStaffMemberDto
|
|
29518
|
+
*/
|
|
29519
|
+
'staffName': string | null;
|
|
29410
29520
|
/**
|
|
29411
29521
|
* Orders not refunded, or refunded in part (the POS app\'s totalOrders)
|
|
29412
29522
|
* @type {number}
|
|
@@ -29807,6 +29917,12 @@ export interface SavedReportDto {
|
|
|
29807
29917
|
* @memberof SavedReportDto
|
|
29808
29918
|
*/
|
|
29809
29919
|
'filters': SavedReportDtoFilters;
|
|
29920
|
+
/**
|
|
29921
|
+
*
|
|
29922
|
+
* @type {ReadyMadeReport}
|
|
29923
|
+
* @memberof SavedReportDto
|
|
29924
|
+
*/
|
|
29925
|
+
'readyMadeReport'?: ReadyMadeReport | null;
|
|
29810
29926
|
/**
|
|
29811
29927
|
* The report\'s id
|
|
29812
29928
|
* @type {string}
|
|
@@ -35481,6 +35597,12 @@ export interface UpdateSavedReportDto {
|
|
|
35481
35597
|
* @memberof UpdateSavedReportDto
|
|
35482
35598
|
*/
|
|
35483
35599
|
'filters': SavedReportDtoFilters;
|
|
35600
|
+
/**
|
|
35601
|
+
*
|
|
35602
|
+
* @type {ReadyMadeReport}
|
|
35603
|
+
* @memberof UpdateSavedReportDto
|
|
35604
|
+
*/
|
|
35605
|
+
'readyMadeReport'?: ReadyMadeReport | null;
|
|
35484
35606
|
/**
|
|
35485
35607
|
* The version the report was read at; answered 409 when someone saved it since
|
|
35486
35608
|
* @type {number}
|
|
@@ -35765,6 +35887,18 @@ export interface UpsertConfigDto {
|
|
|
35765
35887
|
* @memberof UpsertConfigDto
|
|
35766
35888
|
*/
|
|
35767
35889
|
'productDetailLayout'?: ProductDetailLayout;
|
|
35890
|
+
/**
|
|
35891
|
+
*
|
|
35892
|
+
* @type {KioskLayout}
|
|
35893
|
+
* @memberof UpsertConfigDto
|
|
35894
|
+
*/
|
|
35895
|
+
'layout'?: KioskLayout;
|
|
35896
|
+
/**
|
|
35897
|
+
*
|
|
35898
|
+
* @type {UpsellMode}
|
|
35899
|
+
* @memberof UpsertConfigDto
|
|
35900
|
+
*/
|
|
35901
|
+
'upsellMode'?: UpsellMode;
|
|
35768
35902
|
/**
|
|
35769
35903
|
* Whether the kiosk prints the receipt without asking. Absent keeps the stored value.
|
|
35770
35904
|
* @type {boolean}
|
|
@@ -36695,6 +36829,103 @@ export interface VenueFoundDto {
|
|
|
36695
36829
|
*/
|
|
36696
36830
|
'chainId': string | null;
|
|
36697
36831
|
}
|
|
36832
|
+
/**
|
|
36833
|
+
*
|
|
36834
|
+
* @export
|
|
36835
|
+
* @interface VenueKioskDto
|
|
36836
|
+
*/
|
|
36837
|
+
export interface VenueKioskDto {
|
|
36838
|
+
/**
|
|
36839
|
+
* The kiosk\'s station id
|
|
36840
|
+
* @type {string}
|
|
36841
|
+
* @memberof VenueKioskDto
|
|
36842
|
+
*/
|
|
36843
|
+
'id': string;
|
|
36844
|
+
/**
|
|
36845
|
+
* The kiosk\'s name
|
|
36846
|
+
* @type {string}
|
|
36847
|
+
* @memberof VenueKioskDto
|
|
36848
|
+
*/
|
|
36849
|
+
'name': string;
|
|
36850
|
+
/**
|
|
36851
|
+
* What the kiosk\'s order numbers start with; empty for none
|
|
36852
|
+
* @type {string}
|
|
36853
|
+
* @memberof VenueKioskDto
|
|
36854
|
+
*/
|
|
36855
|
+
'prefix': string;
|
|
36856
|
+
/**
|
|
36857
|
+
* The device\'s Hardware ID, as it shows it
|
|
36858
|
+
* @type {string}
|
|
36859
|
+
* @memberof VenueKioskDto
|
|
36860
|
+
*/
|
|
36861
|
+
'hardwareId': string;
|
|
36862
|
+
/**
|
|
36863
|
+
*
|
|
36864
|
+
* @type {Status}
|
|
36865
|
+
* @memberof VenueKioskDto
|
|
36866
|
+
*/
|
|
36867
|
+
'status': Status;
|
|
36868
|
+
/**
|
|
36869
|
+
*
|
|
36870
|
+
* @type {VenueKioskDtoTerminal}
|
|
36871
|
+
* @memberof VenueKioskDto
|
|
36872
|
+
*/
|
|
36873
|
+
'terminal': VenueKioskDtoTerminal | null;
|
|
36874
|
+
/**
|
|
36875
|
+
* When the kiosk was first linked to the venue, ISO 8601
|
|
36876
|
+
* @type {string}
|
|
36877
|
+
* @memberof VenueKioskDto
|
|
36878
|
+
*/
|
|
36879
|
+
'createdAt': string;
|
|
36880
|
+
/**
|
|
36881
|
+
* When the kiosk last changed, ISO 8601
|
|
36882
|
+
* @type {string}
|
|
36883
|
+
* @memberof VenueKioskDto
|
|
36884
|
+
*/
|
|
36885
|
+
'updatedAt': string;
|
|
36886
|
+
}
|
|
36887
|
+
|
|
36888
|
+
|
|
36889
|
+
/**
|
|
36890
|
+
* The payment terminal linked to the kiosk; null when it has none
|
|
36891
|
+
* @export
|
|
36892
|
+
* @interface VenueKioskDtoTerminal
|
|
36893
|
+
*/
|
|
36894
|
+
export interface VenueKioskDtoTerminal {
|
|
36895
|
+
/**
|
|
36896
|
+
* The payment terminal\'s id
|
|
36897
|
+
* @type {string}
|
|
36898
|
+
* @memberof VenueKioskDtoTerminal
|
|
36899
|
+
*/
|
|
36900
|
+
'id': string;
|
|
36901
|
+
/**
|
|
36902
|
+
*
|
|
36903
|
+
* @type {PaymentProvider}
|
|
36904
|
+
* @memberof VenueKioskDtoTerminal
|
|
36905
|
+
*/
|
|
36906
|
+
'provider': PaymentProvider;
|
|
36907
|
+
/**
|
|
36908
|
+
* The terminal\'s label; null when it was given none
|
|
36909
|
+
* @type {string}
|
|
36910
|
+
* @memberof VenueKioskDtoTerminal
|
|
36911
|
+
*/
|
|
36912
|
+
'label': string | null;
|
|
36913
|
+
}
|
|
36914
|
+
|
|
36915
|
+
|
|
36916
|
+
/**
|
|
36917
|
+
*
|
|
36918
|
+
* @export
|
|
36919
|
+
* @interface VenueKiosksDto
|
|
36920
|
+
*/
|
|
36921
|
+
export interface VenueKiosksDto {
|
|
36922
|
+
/**
|
|
36923
|
+
* The venue\'s kiosks, active and inactive, oldest first
|
|
36924
|
+
* @type {Array<VenueKioskDto>}
|
|
36925
|
+
* @memberof VenueKiosksDto
|
|
36926
|
+
*/
|
|
36927
|
+
'kiosks': Array<VenueKioskDto>;
|
|
36928
|
+
}
|
|
36698
36929
|
/**
|
|
36699
36930
|
*
|
|
36700
36931
|
* @export
|
|
@@ -36714,6 +36945,58 @@ export interface VenueListEntryDto {
|
|
|
36714
36945
|
*/
|
|
36715
36946
|
'businessName': string;
|
|
36716
36947
|
}
|
|
36948
|
+
/**
|
|
36949
|
+
*
|
|
36950
|
+
* @export
|
|
36951
|
+
* @interface VenuePaymentTerminalDto
|
|
36952
|
+
*/
|
|
36953
|
+
export interface VenuePaymentTerminalDto {
|
|
36954
|
+
/**
|
|
36955
|
+
* The payment terminal\'s id, the one a kiosk is linked to
|
|
36956
|
+
* @type {string}
|
|
36957
|
+
* @memberof VenuePaymentTerminalDto
|
|
36958
|
+
*/
|
|
36959
|
+
'id': string;
|
|
36960
|
+
/**
|
|
36961
|
+
*
|
|
36962
|
+
* @type {PaymentProvider}
|
|
36963
|
+
* @memberof VenuePaymentTerminalDto
|
|
36964
|
+
*/
|
|
36965
|
+
'provider': PaymentProvider;
|
|
36966
|
+
/**
|
|
36967
|
+
* The terminal\'s label; null when it was given none
|
|
36968
|
+
* @type {string}
|
|
36969
|
+
* @memberof VenuePaymentTerminalDto
|
|
36970
|
+
*/
|
|
36971
|
+
'label': string | null;
|
|
36972
|
+
/**
|
|
36973
|
+
* The terminal\'s own id at its provider, as printed on the device
|
|
36974
|
+
* @type {string}
|
|
36975
|
+
* @memberof VenuePaymentTerminalDto
|
|
36976
|
+
*/
|
|
36977
|
+
'hardwareId': string;
|
|
36978
|
+
/**
|
|
36979
|
+
* The id of the station, a kiosk\'s or a till\'s, the terminal is linked to; null when it is free
|
|
36980
|
+
* @type {string}
|
|
36981
|
+
* @memberof VenuePaymentTerminalDto
|
|
36982
|
+
*/
|
|
36983
|
+
'stationId': string | null;
|
|
36984
|
+
}
|
|
36985
|
+
|
|
36986
|
+
|
|
36987
|
+
/**
|
|
36988
|
+
*
|
|
36989
|
+
* @export
|
|
36990
|
+
* @interface VenuePaymentTerminalsDto
|
|
36991
|
+
*/
|
|
36992
|
+
export interface VenuePaymentTerminalsDto {
|
|
36993
|
+
/**
|
|
36994
|
+
* The venue\'s payment terminals as stored, oldest first; a terminal is stored once a till has discovered it
|
|
36995
|
+
* @type {Array<VenuePaymentTerminalDto>}
|
|
36996
|
+
* @memberof VenuePaymentTerminalsDto
|
|
36997
|
+
*/
|
|
36998
|
+
'terminals': Array<VenuePaymentTerminalDto>;
|
|
36999
|
+
}
|
|
36717
37000
|
/**
|
|
36718
37001
|
*
|
|
36719
37002
|
* @export
|
|
@@ -36824,7 +37107,7 @@ export interface VenueProviderOutcomeDto {
|
|
|
36824
37107
|
*/
|
|
36825
37108
|
'rowsChanged': number;
|
|
36826
37109
|
/**
|
|
36827
|
-
* Whether the channel is on, as its row reads after the change: the first active row, else the
|
|
37110
|
+
* 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
|
|
36828
37111
|
* @type {boolean}
|
|
36829
37112
|
* @memberof VenueProviderOutcomeDto
|
|
36830
37113
|
*/
|
|
@@ -36844,6 +37127,52 @@ export interface VenueProviderOutcomeDto {
|
|
|
36844
37127
|
}
|
|
36845
37128
|
|
|
36846
37129
|
|
|
37130
|
+
/**
|
|
37131
|
+
*
|
|
37132
|
+
* @export
|
|
37133
|
+
* @interface VenueProviderStateDto
|
|
37134
|
+
*/
|
|
37135
|
+
export interface VenueProviderStateDto {
|
|
37136
|
+
/**
|
|
37137
|
+
*
|
|
37138
|
+
* @type {ProviderEnum}
|
|
37139
|
+
* @memberof VenueProviderStateDto
|
|
37140
|
+
*/
|
|
37141
|
+
'channel': ProviderEnum;
|
|
37142
|
+
/**
|
|
37143
|
+
* Whether the channel is on, as its row reads: the first active row, else the newest row, by createdAt and then id
|
|
37144
|
+
* @type {boolean}
|
|
37145
|
+
* @memberof VenueProviderStateDto
|
|
37146
|
+
*/
|
|
37147
|
+
'isActive': boolean;
|
|
37148
|
+
/**
|
|
37149
|
+
* Whether the channel\'s orders are accepted without the till, as the same row reads
|
|
37150
|
+
* @type {boolean}
|
|
37151
|
+
* @memberof VenueProviderStateDto
|
|
37152
|
+
*/
|
|
37153
|
+
'autoAccept': boolean;
|
|
37154
|
+
/**
|
|
37155
|
+
* The integrations the same row takes
|
|
37156
|
+
* @type {Array<IntegrationType>}
|
|
37157
|
+
* @memberof VenueProviderStateDto
|
|
37158
|
+
*/
|
|
37159
|
+
'integrations': Array<IntegrationType>;
|
|
37160
|
+
}
|
|
37161
|
+
|
|
37162
|
+
|
|
37163
|
+
/**
|
|
37164
|
+
*
|
|
37165
|
+
* @export
|
|
37166
|
+
* @interface VenueProvidersDto
|
|
37167
|
+
*/
|
|
37168
|
+
export interface VenueProvidersDto {
|
|
37169
|
+
/**
|
|
37170
|
+
* 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
|
|
37171
|
+
* @type {Array<VenueProviderStateDto>}
|
|
37172
|
+
* @memberof VenueProvidersDto
|
|
37173
|
+
*/
|
|
37174
|
+
'providers': Array<VenueProviderStateDto>;
|
|
37175
|
+
}
|
|
36847
37176
|
/**
|
|
36848
37177
|
*
|
|
36849
37178
|
* @export
|
|
@@ -61622,6 +61951,44 @@ export const ProviderApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
61622
61951
|
|
|
61623
61952
|
|
|
61624
61953
|
|
|
61954
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
61955
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
61956
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
61957
|
+
|
|
61958
|
+
return {
|
|
61959
|
+
url: toPathString(localVarUrlObj),
|
|
61960
|
+
options: localVarRequestOptions,
|
|
61961
|
+
};
|
|
61962
|
+
},
|
|
61963
|
+
/**
|
|
61964
|
+
* 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.
|
|
61965
|
+
* @summary Read whether each of a venue\'s own channels is on and auto-accepting, and its integrations
|
|
61966
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
61967
|
+
* @param {*} [options] Override http request option.
|
|
61968
|
+
* @throws {RequiredError}
|
|
61969
|
+
*/
|
|
61970
|
+
getVenueProviders: async (businessId: number, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
61971
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
61972
|
+
assertParamExists('getVenueProviders', 'businessId', businessId)
|
|
61973
|
+
const localVarPath = `/api/v2/venues/{businessId}/providers`
|
|
61974
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)));
|
|
61975
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
61976
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
61977
|
+
let baseOptions;
|
|
61978
|
+
if (configuration) {
|
|
61979
|
+
baseOptions = configuration.baseOptions;
|
|
61980
|
+
}
|
|
61981
|
+
|
|
61982
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
61983
|
+
const localVarHeaderParameter = {} as any;
|
|
61984
|
+
const localVarQueryParameter = {} as any;
|
|
61985
|
+
|
|
61986
|
+
// authentication JWT-auth required
|
|
61987
|
+
// http bearer authentication required
|
|
61988
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
61989
|
+
|
|
61990
|
+
|
|
61991
|
+
|
|
61625
61992
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
61626
61993
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
61627
61994
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -61854,6 +62221,17 @@ export const ProviderApiFp = function(configuration?: Configuration) {
|
|
|
61854
62221
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getOnboardingStatus(channel, businessId, options);
|
|
61855
62222
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
61856
62223
|
},
|
|
62224
|
+
/**
|
|
62225
|
+
* 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.
|
|
62226
|
+
* @summary Read whether each of a venue\'s own channels is on and auto-accepting, and its integrations
|
|
62227
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
62228
|
+
* @param {*} [options] Override http request option.
|
|
62229
|
+
* @throws {RequiredError}
|
|
62230
|
+
*/
|
|
62231
|
+
async getVenueProviders(businessId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueProvidersDto>> {
|
|
62232
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getVenueProviders(businessId, options);
|
|
62233
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
62234
|
+
},
|
|
61857
62235
|
/**
|
|
61858
62236
|
* Asked once the owner has signed in to Uber Eats, with the session\'s state; ubereats-service\'s list is answered as it is.
|
|
61859
62237
|
* @summary The Uber Eats stores the signed-in owner can connect
|
|
@@ -61956,6 +62334,16 @@ export const ProviderApiFactory = function (configuration?: Configuration, baseP
|
|
|
61956
62334
|
getOnboardingStatus(channel: ProviderEnum, businessId: number, options?: any): AxiosPromise<GetOnboardingStatus200Response> {
|
|
61957
62335
|
return localVarFp.getOnboardingStatus(channel, businessId, options).then((request) => request(axios, basePath));
|
|
61958
62336
|
},
|
|
62337
|
+
/**
|
|
62338
|
+
* 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.
|
|
62339
|
+
* @summary Read whether each of a venue\'s own channels is on and auto-accepting, and its integrations
|
|
62340
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
62341
|
+
* @param {*} [options] Override http request option.
|
|
62342
|
+
* @throws {RequiredError}
|
|
62343
|
+
*/
|
|
62344
|
+
getVenueProviders(businessId: number, options?: any): AxiosPromise<VenueProvidersDto> {
|
|
62345
|
+
return localVarFp.getVenueProviders(businessId, options).then((request) => request(axios, basePath));
|
|
62346
|
+
},
|
|
61959
62347
|
/**
|
|
61960
62348
|
* Asked once the owner has signed in to Uber Eats, with the session\'s state; ubereats-service\'s list is answered as it is.
|
|
61961
62349
|
* @summary The Uber Eats stores the signed-in owner can connect
|
|
@@ -62053,6 +62441,16 @@ export interface ProviderApiInterface {
|
|
|
62053
62441
|
*/
|
|
62054
62442
|
getOnboardingStatus(channel: ProviderEnum, businessId: number, options?: AxiosRequestConfig): AxiosPromise<GetOnboardingStatus200Response>;
|
|
62055
62443
|
|
|
62444
|
+
/**
|
|
62445
|
+
* 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.
|
|
62446
|
+
* @summary Read whether each of a venue\'s own channels is on and auto-accepting, and its integrations
|
|
62447
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
62448
|
+
* @param {*} [options] Override http request option.
|
|
62449
|
+
* @throws {RequiredError}
|
|
62450
|
+
* @memberof ProviderApiInterface
|
|
62451
|
+
*/
|
|
62452
|
+
getVenueProviders(businessId: number, options?: AxiosRequestConfig): AxiosPromise<VenueProvidersDto>;
|
|
62453
|
+
|
|
62056
62454
|
/**
|
|
62057
62455
|
* Asked once the owner has signed in to Uber Eats, with the session\'s state; ubereats-service\'s list is answered as it is.
|
|
62058
62456
|
* @summary The Uber Eats stores the signed-in owner can connect
|
|
@@ -62158,6 +62556,18 @@ export class ProviderApi extends BaseAPI implements ProviderApiInterface {
|
|
|
62158
62556
|
return ProviderApiFp(this.configuration).getOnboardingStatus(channel, businessId, options).then((request) => request(this.axios, this.basePath));
|
|
62159
62557
|
}
|
|
62160
62558
|
|
|
62559
|
+
/**
|
|
62560
|
+
* 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.
|
|
62561
|
+
* @summary Read whether each of a venue\'s own channels is on and auto-accepting, and its integrations
|
|
62562
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
62563
|
+
* @param {*} [options] Override http request option.
|
|
62564
|
+
* @throws {RequiredError}
|
|
62565
|
+
* @memberof ProviderApi
|
|
62566
|
+
*/
|
|
62567
|
+
public getVenueProviders(businessId: number, options?: AxiosRequestConfig) {
|
|
62568
|
+
return ProviderApiFp(this.configuration).getVenueProviders(businessId, options).then((request) => request(this.axios, this.basePath));
|
|
62569
|
+
}
|
|
62570
|
+
|
|
62161
62571
|
/**
|
|
62162
62572
|
* Asked once the owner has signed in to Uber Eats, with the session\'s state; ubereats-service\'s list is answered as it is.
|
|
62163
62573
|
* @summary The Uber Eats stores the signed-in owner can connect
|
|
@@ -70876,6 +71286,592 @@ export class VendureSellerApi extends BaseAPI implements VendureSellerApiInterfa
|
|
|
70876
71286
|
}
|
|
70877
71287
|
|
|
70878
71288
|
|
|
71289
|
+
/**
|
|
71290
|
+
* VenueKiosksApi - axios parameter creator
|
|
71291
|
+
* @export
|
|
71292
|
+
*/
|
|
71293
|
+
export const VenueKiosksApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
71294
|
+
return {
|
|
71295
|
+
/**
|
|
71296
|
+
* 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.
|
|
71297
|
+
* @summary Rename a kiosk, change its prefix, or put it in or out of use
|
|
71298
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71299
|
+
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
71300
|
+
* @param {ChangeKioskDto} changeKioskDto
|
|
71301
|
+
* @param {*} [options] Override http request option.
|
|
71302
|
+
* @throws {RequiredError}
|
|
71303
|
+
*/
|
|
71304
|
+
changeVenueKiosk: async (businessId: number, stationId: string, changeKioskDto: ChangeKioskDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
71305
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
71306
|
+
assertParamExists('changeVenueKiosk', 'businessId', businessId)
|
|
71307
|
+
// verify required parameter 'stationId' is not null or undefined
|
|
71308
|
+
assertParamExists('changeVenueKiosk', 'stationId', stationId)
|
|
71309
|
+
// verify required parameter 'changeKioskDto' is not null or undefined
|
|
71310
|
+
assertParamExists('changeVenueKiosk', 'changeKioskDto', changeKioskDto)
|
|
71311
|
+
const localVarPath = `/api/v2/venues/{businessId}/kiosks/{stationId}`
|
|
71312
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)))
|
|
71313
|
+
.replace(`{${"stationId"}}`, encodeURIComponent(String(stationId)));
|
|
71314
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
71315
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
71316
|
+
let baseOptions;
|
|
71317
|
+
if (configuration) {
|
|
71318
|
+
baseOptions = configuration.baseOptions;
|
|
71319
|
+
}
|
|
71320
|
+
|
|
71321
|
+
const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
|
|
71322
|
+
const localVarHeaderParameter = {} as any;
|
|
71323
|
+
const localVarQueryParameter = {} as any;
|
|
71324
|
+
|
|
71325
|
+
// authentication JWT-auth required
|
|
71326
|
+
// http bearer authentication required
|
|
71327
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
71328
|
+
|
|
71329
|
+
|
|
71330
|
+
|
|
71331
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
71332
|
+
|
|
71333
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
71334
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
71335
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
71336
|
+
localVarRequestOptions.data = serializeDataIfNeeded(changeKioskDto, localVarRequestOptions, configuration)
|
|
71337
|
+
|
|
71338
|
+
return {
|
|
71339
|
+
url: toPathString(localVarUrlObj),
|
|
71340
|
+
options: localVarRequestOptions,
|
|
71341
|
+
};
|
|
71342
|
+
},
|
|
71343
|
+
/**
|
|
71344
|
+
* 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.
|
|
71345
|
+
* @summary Link a kiosk to the venue by the Hardware ID it shows
|
|
71346
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71347
|
+
* @param {ClaimKioskDto} claimKioskDto
|
|
71348
|
+
* @param {*} [options] Override http request option.
|
|
71349
|
+
* @throws {RequiredError}
|
|
71350
|
+
*/
|
|
71351
|
+
claimVenueKiosk: async (businessId: number, claimKioskDto: ClaimKioskDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
71352
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
71353
|
+
assertParamExists('claimVenueKiosk', 'businessId', businessId)
|
|
71354
|
+
// verify required parameter 'claimKioskDto' is not null or undefined
|
|
71355
|
+
assertParamExists('claimVenueKiosk', 'claimKioskDto', claimKioskDto)
|
|
71356
|
+
const localVarPath = `/api/v2/venues/{businessId}/kiosks`
|
|
71357
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)));
|
|
71358
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
71359
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
71360
|
+
let baseOptions;
|
|
71361
|
+
if (configuration) {
|
|
71362
|
+
baseOptions = configuration.baseOptions;
|
|
71363
|
+
}
|
|
71364
|
+
|
|
71365
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
71366
|
+
const localVarHeaderParameter = {} as any;
|
|
71367
|
+
const localVarQueryParameter = {} as any;
|
|
71368
|
+
|
|
71369
|
+
// authentication JWT-auth required
|
|
71370
|
+
// http bearer authentication required
|
|
71371
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
71372
|
+
|
|
71373
|
+
|
|
71374
|
+
|
|
71375
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
71376
|
+
|
|
71377
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
71378
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
71379
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
71380
|
+
localVarRequestOptions.data = serializeDataIfNeeded(claimKioskDto, localVarRequestOptions, configuration)
|
|
71381
|
+
|
|
71382
|
+
return {
|
|
71383
|
+
url: toPathString(localVarUrlObj),
|
|
71384
|
+
options: localVarRequestOptions,
|
|
71385
|
+
};
|
|
71386
|
+
},
|
|
71387
|
+
/**
|
|
71388
|
+
* 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.
|
|
71389
|
+
* @summary Link one of the venue\'s payment terminals to a kiosk, or unlink it
|
|
71390
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71391
|
+
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
71392
|
+
* @param {LinkKioskTerminalDto} linkKioskTerminalDto
|
|
71393
|
+
* @param {*} [options] Override http request option.
|
|
71394
|
+
* @throws {RequiredError}
|
|
71395
|
+
*/
|
|
71396
|
+
linkVenueKioskTerminal: async (businessId: number, stationId: string, linkKioskTerminalDto: LinkKioskTerminalDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
71397
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
71398
|
+
assertParamExists('linkVenueKioskTerminal', 'businessId', businessId)
|
|
71399
|
+
// verify required parameter 'stationId' is not null or undefined
|
|
71400
|
+
assertParamExists('linkVenueKioskTerminal', 'stationId', stationId)
|
|
71401
|
+
// verify required parameter 'linkKioskTerminalDto' is not null or undefined
|
|
71402
|
+
assertParamExists('linkVenueKioskTerminal', 'linkKioskTerminalDto', linkKioskTerminalDto)
|
|
71403
|
+
const localVarPath = `/api/v2/venues/{businessId}/kiosks/{stationId}/terminal`
|
|
71404
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)))
|
|
71405
|
+
.replace(`{${"stationId"}}`, encodeURIComponent(String(stationId)));
|
|
71406
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
71407
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
71408
|
+
let baseOptions;
|
|
71409
|
+
if (configuration) {
|
|
71410
|
+
baseOptions = configuration.baseOptions;
|
|
71411
|
+
}
|
|
71412
|
+
|
|
71413
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
|
|
71414
|
+
const localVarHeaderParameter = {} as any;
|
|
71415
|
+
const localVarQueryParameter = {} as any;
|
|
71416
|
+
|
|
71417
|
+
// authentication JWT-auth required
|
|
71418
|
+
// http bearer authentication required
|
|
71419
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
71420
|
+
|
|
71421
|
+
|
|
71422
|
+
|
|
71423
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
71424
|
+
|
|
71425
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
71426
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
71427
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
71428
|
+
localVarRequestOptions.data = serializeDataIfNeeded(linkKioskTerminalDto, localVarRequestOptions, configuration)
|
|
71429
|
+
|
|
71430
|
+
return {
|
|
71431
|
+
url: toPathString(localVarUrlObj),
|
|
71432
|
+
options: localVarRequestOptions,
|
|
71433
|
+
};
|
|
71434
|
+
},
|
|
71435
|
+
/**
|
|
71436
|
+
* Every kiosk station of the venue, active or removed, oldest first, with its linked payment terminal. Read from the database every time.
|
|
71437
|
+
* @summary List the venue\'s kiosks
|
|
71438
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71439
|
+
* @param {*} [options] Override http request option.
|
|
71440
|
+
* @throws {RequiredError}
|
|
71441
|
+
*/
|
|
71442
|
+
listVenueKiosks: async (businessId: number, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
71443
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
71444
|
+
assertParamExists('listVenueKiosks', 'businessId', businessId)
|
|
71445
|
+
const localVarPath = `/api/v2/venues/{businessId}/kiosks`
|
|
71446
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)));
|
|
71447
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
71448
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
71449
|
+
let baseOptions;
|
|
71450
|
+
if (configuration) {
|
|
71451
|
+
baseOptions = configuration.baseOptions;
|
|
71452
|
+
}
|
|
71453
|
+
|
|
71454
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
71455
|
+
const localVarHeaderParameter = {} as any;
|
|
71456
|
+
const localVarQueryParameter = {} as any;
|
|
71457
|
+
|
|
71458
|
+
// authentication JWT-auth required
|
|
71459
|
+
// http bearer authentication required
|
|
71460
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
71461
|
+
|
|
71462
|
+
|
|
71463
|
+
|
|
71464
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
71465
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
71466
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
71467
|
+
|
|
71468
|
+
return {
|
|
71469
|
+
url: toPathString(localVarUrlObj),
|
|
71470
|
+
options: localVarRequestOptions,
|
|
71471
|
+
};
|
|
71472
|
+
},
|
|
71473
|
+
/**
|
|
71474
|
+
* 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.
|
|
71475
|
+
* @summary List the venue\'s payment terminals, for linking one to a kiosk
|
|
71476
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71477
|
+
* @param {*} [options] Override http request option.
|
|
71478
|
+
* @throws {RequiredError}
|
|
71479
|
+
*/
|
|
71480
|
+
listVenuePaymentTerminals: async (businessId: number, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
71481
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
71482
|
+
assertParamExists('listVenuePaymentTerminals', 'businessId', businessId)
|
|
71483
|
+
const localVarPath = `/api/v2/venues/{businessId}/payment-terminals`
|
|
71484
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)));
|
|
71485
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
71486
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
71487
|
+
let baseOptions;
|
|
71488
|
+
if (configuration) {
|
|
71489
|
+
baseOptions = configuration.baseOptions;
|
|
71490
|
+
}
|
|
71491
|
+
|
|
71492
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
71493
|
+
const localVarHeaderParameter = {} as any;
|
|
71494
|
+
const localVarQueryParameter = {} as any;
|
|
71495
|
+
|
|
71496
|
+
// authentication JWT-auth required
|
|
71497
|
+
// http bearer authentication required
|
|
71498
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
71499
|
+
|
|
71500
|
+
|
|
71501
|
+
|
|
71502
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
71503
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
71504
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
71505
|
+
|
|
71506
|
+
return {
|
|
71507
|
+
url: toPathString(localVarUrlObj),
|
|
71508
|
+
options: localVarRequestOptions,
|
|
71509
|
+
};
|
|
71510
|
+
},
|
|
71511
|
+
/**
|
|
71512
|
+
* 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.
|
|
71513
|
+
* @summary Remove a kiosk from use
|
|
71514
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71515
|
+
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
71516
|
+
* @param {*} [options] Override http request option.
|
|
71517
|
+
* @throws {RequiredError}
|
|
71518
|
+
*/
|
|
71519
|
+
removeVenueKiosk: async (businessId: number, stationId: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
71520
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
71521
|
+
assertParamExists('removeVenueKiosk', 'businessId', businessId)
|
|
71522
|
+
// verify required parameter 'stationId' is not null or undefined
|
|
71523
|
+
assertParamExists('removeVenueKiosk', 'stationId', stationId)
|
|
71524
|
+
const localVarPath = `/api/v2/venues/{businessId}/kiosks/{stationId}`
|
|
71525
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)))
|
|
71526
|
+
.replace(`{${"stationId"}}`, encodeURIComponent(String(stationId)));
|
|
71527
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
71528
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
71529
|
+
let baseOptions;
|
|
71530
|
+
if (configuration) {
|
|
71531
|
+
baseOptions = configuration.baseOptions;
|
|
71532
|
+
}
|
|
71533
|
+
|
|
71534
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
|
|
71535
|
+
const localVarHeaderParameter = {} as any;
|
|
71536
|
+
const localVarQueryParameter = {} as any;
|
|
71537
|
+
|
|
71538
|
+
// authentication JWT-auth required
|
|
71539
|
+
// http bearer authentication required
|
|
71540
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
71541
|
+
|
|
71542
|
+
|
|
71543
|
+
|
|
71544
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
71545
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
71546
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
71547
|
+
|
|
71548
|
+
return {
|
|
71549
|
+
url: toPathString(localVarUrlObj),
|
|
71550
|
+
options: localVarRequestOptions,
|
|
71551
|
+
};
|
|
71552
|
+
},
|
|
71553
|
+
}
|
|
71554
|
+
};
|
|
71555
|
+
|
|
71556
|
+
/**
|
|
71557
|
+
* VenueKiosksApi - functional programming interface
|
|
71558
|
+
* @export
|
|
71559
|
+
*/
|
|
71560
|
+
export const VenueKiosksApiFp = function(configuration?: Configuration) {
|
|
71561
|
+
const localVarAxiosParamCreator = VenueKiosksApiAxiosParamCreator(configuration)
|
|
71562
|
+
return {
|
|
71563
|
+
/**
|
|
71564
|
+
* 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.
|
|
71565
|
+
* @summary Rename a kiosk, change its prefix, or put it in or out of use
|
|
71566
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71567
|
+
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
71568
|
+
* @param {ChangeKioskDto} changeKioskDto
|
|
71569
|
+
* @param {*} [options] Override http request option.
|
|
71570
|
+
* @throws {RequiredError}
|
|
71571
|
+
*/
|
|
71572
|
+
async changeVenueKiosk(businessId: number, stationId: string, changeKioskDto: ChangeKioskDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueKioskDto>> {
|
|
71573
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.changeVenueKiosk(businessId, stationId, changeKioskDto, options);
|
|
71574
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
71575
|
+
},
|
|
71576
|
+
/**
|
|
71577
|
+
* 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.
|
|
71578
|
+
* @summary Link a kiosk to the venue by the Hardware ID it shows
|
|
71579
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71580
|
+
* @param {ClaimKioskDto} claimKioskDto
|
|
71581
|
+
* @param {*} [options] Override http request option.
|
|
71582
|
+
* @throws {RequiredError}
|
|
71583
|
+
*/
|
|
71584
|
+
async claimVenueKiosk(businessId: number, claimKioskDto: ClaimKioskDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueKioskDto>> {
|
|
71585
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.claimVenueKiosk(businessId, claimKioskDto, options);
|
|
71586
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
71587
|
+
},
|
|
71588
|
+
/**
|
|
71589
|
+
* 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.
|
|
71590
|
+
* @summary Link one of the venue\'s payment terminals to a kiosk, or unlink it
|
|
71591
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71592
|
+
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
71593
|
+
* @param {LinkKioskTerminalDto} linkKioskTerminalDto
|
|
71594
|
+
* @param {*} [options] Override http request option.
|
|
71595
|
+
* @throws {RequiredError}
|
|
71596
|
+
*/
|
|
71597
|
+
async linkVenueKioskTerminal(businessId: number, stationId: string, linkKioskTerminalDto: LinkKioskTerminalDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueKioskDto>> {
|
|
71598
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.linkVenueKioskTerminal(businessId, stationId, linkKioskTerminalDto, options);
|
|
71599
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
71600
|
+
},
|
|
71601
|
+
/**
|
|
71602
|
+
* Every kiosk station of the venue, active or removed, oldest first, with its linked payment terminal. Read from the database every time.
|
|
71603
|
+
* @summary List the venue\'s kiosks
|
|
71604
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71605
|
+
* @param {*} [options] Override http request option.
|
|
71606
|
+
* @throws {RequiredError}
|
|
71607
|
+
*/
|
|
71608
|
+
async listVenueKiosks(businessId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueKiosksDto>> {
|
|
71609
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listVenueKiosks(businessId, options);
|
|
71610
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
71611
|
+
},
|
|
71612
|
+
/**
|
|
71613
|
+
* 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.
|
|
71614
|
+
* @summary List the venue\'s payment terminals, for linking one to a kiosk
|
|
71615
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71616
|
+
* @param {*} [options] Override http request option.
|
|
71617
|
+
* @throws {RequiredError}
|
|
71618
|
+
*/
|
|
71619
|
+
async listVenuePaymentTerminals(businessId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenuePaymentTerminalsDto>> {
|
|
71620
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listVenuePaymentTerminals(businessId, options);
|
|
71621
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
71622
|
+
},
|
|
71623
|
+
/**
|
|
71624
|
+
* 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.
|
|
71625
|
+
* @summary Remove a kiosk from use
|
|
71626
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71627
|
+
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
71628
|
+
* @param {*} [options] Override http request option.
|
|
71629
|
+
* @throws {RequiredError}
|
|
71630
|
+
*/
|
|
71631
|
+
async removeVenueKiosk(businessId: number, stationId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueKioskDto>> {
|
|
71632
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.removeVenueKiosk(businessId, stationId, options);
|
|
71633
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
71634
|
+
},
|
|
71635
|
+
}
|
|
71636
|
+
};
|
|
71637
|
+
|
|
71638
|
+
/**
|
|
71639
|
+
* VenueKiosksApi - factory interface
|
|
71640
|
+
* @export
|
|
71641
|
+
*/
|
|
71642
|
+
export const VenueKiosksApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
71643
|
+
const localVarFp = VenueKiosksApiFp(configuration)
|
|
71644
|
+
return {
|
|
71645
|
+
/**
|
|
71646
|
+
* 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.
|
|
71647
|
+
* @summary Rename a kiosk, change its prefix, or put it in or out of use
|
|
71648
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71649
|
+
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
71650
|
+
* @param {ChangeKioskDto} changeKioskDto
|
|
71651
|
+
* @param {*} [options] Override http request option.
|
|
71652
|
+
* @throws {RequiredError}
|
|
71653
|
+
*/
|
|
71654
|
+
changeVenueKiosk(businessId: number, stationId: string, changeKioskDto: ChangeKioskDto, options?: any): AxiosPromise<VenueKioskDto> {
|
|
71655
|
+
return localVarFp.changeVenueKiosk(businessId, stationId, changeKioskDto, options).then((request) => request(axios, basePath));
|
|
71656
|
+
},
|
|
71657
|
+
/**
|
|
71658
|
+
* 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.
|
|
71659
|
+
* @summary Link a kiosk to the venue by the Hardware ID it shows
|
|
71660
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71661
|
+
* @param {ClaimKioskDto} claimKioskDto
|
|
71662
|
+
* @param {*} [options] Override http request option.
|
|
71663
|
+
* @throws {RequiredError}
|
|
71664
|
+
*/
|
|
71665
|
+
claimVenueKiosk(businessId: number, claimKioskDto: ClaimKioskDto, options?: any): AxiosPromise<VenueKioskDto> {
|
|
71666
|
+
return localVarFp.claimVenueKiosk(businessId, claimKioskDto, options).then((request) => request(axios, basePath));
|
|
71667
|
+
},
|
|
71668
|
+
/**
|
|
71669
|
+
* 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.
|
|
71670
|
+
* @summary Link one of the venue\'s payment terminals to a kiosk, or unlink it
|
|
71671
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71672
|
+
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
71673
|
+
* @param {LinkKioskTerminalDto} linkKioskTerminalDto
|
|
71674
|
+
* @param {*} [options] Override http request option.
|
|
71675
|
+
* @throws {RequiredError}
|
|
71676
|
+
*/
|
|
71677
|
+
linkVenueKioskTerminal(businessId: number, stationId: string, linkKioskTerminalDto: LinkKioskTerminalDto, options?: any): AxiosPromise<VenueKioskDto> {
|
|
71678
|
+
return localVarFp.linkVenueKioskTerminal(businessId, stationId, linkKioskTerminalDto, options).then((request) => request(axios, basePath));
|
|
71679
|
+
},
|
|
71680
|
+
/**
|
|
71681
|
+
* Every kiosk station of the venue, active or removed, oldest first, with its linked payment terminal. Read from the database every time.
|
|
71682
|
+
* @summary List the venue\'s kiosks
|
|
71683
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71684
|
+
* @param {*} [options] Override http request option.
|
|
71685
|
+
* @throws {RequiredError}
|
|
71686
|
+
*/
|
|
71687
|
+
listVenueKiosks(businessId: number, options?: any): AxiosPromise<VenueKiosksDto> {
|
|
71688
|
+
return localVarFp.listVenueKiosks(businessId, options).then((request) => request(axios, basePath));
|
|
71689
|
+
},
|
|
71690
|
+
/**
|
|
71691
|
+
* 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.
|
|
71692
|
+
* @summary List the venue\'s payment terminals, for linking one to a kiosk
|
|
71693
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71694
|
+
* @param {*} [options] Override http request option.
|
|
71695
|
+
* @throws {RequiredError}
|
|
71696
|
+
*/
|
|
71697
|
+
listVenuePaymentTerminals(businessId: number, options?: any): AxiosPromise<VenuePaymentTerminalsDto> {
|
|
71698
|
+
return localVarFp.listVenuePaymentTerminals(businessId, options).then((request) => request(axios, basePath));
|
|
71699
|
+
},
|
|
71700
|
+
/**
|
|
71701
|
+
* 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.
|
|
71702
|
+
* @summary Remove a kiosk from use
|
|
71703
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71704
|
+
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
71705
|
+
* @param {*} [options] Override http request option.
|
|
71706
|
+
* @throws {RequiredError}
|
|
71707
|
+
*/
|
|
71708
|
+
removeVenueKiosk(businessId: number, stationId: string, options?: any): AxiosPromise<VenueKioskDto> {
|
|
71709
|
+
return localVarFp.removeVenueKiosk(businessId, stationId, options).then((request) => request(axios, basePath));
|
|
71710
|
+
},
|
|
71711
|
+
};
|
|
71712
|
+
};
|
|
71713
|
+
|
|
71714
|
+
/**
|
|
71715
|
+
* VenueKiosksApi - interface
|
|
71716
|
+
* @export
|
|
71717
|
+
* @interface VenueKiosksApi
|
|
71718
|
+
*/
|
|
71719
|
+
export interface VenueKiosksApiInterface {
|
|
71720
|
+
/**
|
|
71721
|
+
* 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.
|
|
71722
|
+
* @summary Rename a kiosk, change its prefix, or put it in or out of use
|
|
71723
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71724
|
+
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
71725
|
+
* @param {ChangeKioskDto} changeKioskDto
|
|
71726
|
+
* @param {*} [options] Override http request option.
|
|
71727
|
+
* @throws {RequiredError}
|
|
71728
|
+
* @memberof VenueKiosksApiInterface
|
|
71729
|
+
*/
|
|
71730
|
+
changeVenueKiosk(businessId: number, stationId: string, changeKioskDto: ChangeKioskDto, options?: AxiosRequestConfig): AxiosPromise<VenueKioskDto>;
|
|
71731
|
+
|
|
71732
|
+
/**
|
|
71733
|
+
* 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.
|
|
71734
|
+
* @summary Link a kiosk to the venue by the Hardware ID it shows
|
|
71735
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71736
|
+
* @param {ClaimKioskDto} claimKioskDto
|
|
71737
|
+
* @param {*} [options] Override http request option.
|
|
71738
|
+
* @throws {RequiredError}
|
|
71739
|
+
* @memberof VenueKiosksApiInterface
|
|
71740
|
+
*/
|
|
71741
|
+
claimVenueKiosk(businessId: number, claimKioskDto: ClaimKioskDto, options?: AxiosRequestConfig): AxiosPromise<VenueKioskDto>;
|
|
71742
|
+
|
|
71743
|
+
/**
|
|
71744
|
+
* 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.
|
|
71745
|
+
* @summary Link one of the venue\'s payment terminals to a kiosk, or unlink it
|
|
71746
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71747
|
+
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
71748
|
+
* @param {LinkKioskTerminalDto} linkKioskTerminalDto
|
|
71749
|
+
* @param {*} [options] Override http request option.
|
|
71750
|
+
* @throws {RequiredError}
|
|
71751
|
+
* @memberof VenueKiosksApiInterface
|
|
71752
|
+
*/
|
|
71753
|
+
linkVenueKioskTerminal(businessId: number, stationId: string, linkKioskTerminalDto: LinkKioskTerminalDto, options?: AxiosRequestConfig): AxiosPromise<VenueKioskDto>;
|
|
71754
|
+
|
|
71755
|
+
/**
|
|
71756
|
+
* Every kiosk station of the venue, active or removed, oldest first, with its linked payment terminal. Read from the database every time.
|
|
71757
|
+
* @summary List the venue\'s kiosks
|
|
71758
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71759
|
+
* @param {*} [options] Override http request option.
|
|
71760
|
+
* @throws {RequiredError}
|
|
71761
|
+
* @memberof VenueKiosksApiInterface
|
|
71762
|
+
*/
|
|
71763
|
+
listVenueKiosks(businessId: number, options?: AxiosRequestConfig): AxiosPromise<VenueKiosksDto>;
|
|
71764
|
+
|
|
71765
|
+
/**
|
|
71766
|
+
* 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.
|
|
71767
|
+
* @summary List the venue\'s payment terminals, for linking one to a kiosk
|
|
71768
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71769
|
+
* @param {*} [options] Override http request option.
|
|
71770
|
+
* @throws {RequiredError}
|
|
71771
|
+
* @memberof VenueKiosksApiInterface
|
|
71772
|
+
*/
|
|
71773
|
+
listVenuePaymentTerminals(businessId: number, options?: AxiosRequestConfig): AxiosPromise<VenuePaymentTerminalsDto>;
|
|
71774
|
+
|
|
71775
|
+
/**
|
|
71776
|
+
* 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.
|
|
71777
|
+
* @summary Remove a kiosk from use
|
|
71778
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71779
|
+
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
71780
|
+
* @param {*} [options] Override http request option.
|
|
71781
|
+
* @throws {RequiredError}
|
|
71782
|
+
* @memberof VenueKiosksApiInterface
|
|
71783
|
+
*/
|
|
71784
|
+
removeVenueKiosk(businessId: number, stationId: string, options?: AxiosRequestConfig): AxiosPromise<VenueKioskDto>;
|
|
71785
|
+
|
|
71786
|
+
}
|
|
71787
|
+
|
|
71788
|
+
/**
|
|
71789
|
+
* VenueKiosksApi - object-oriented interface
|
|
71790
|
+
* @export
|
|
71791
|
+
* @class VenueKiosksApi
|
|
71792
|
+
* @extends {BaseAPI}
|
|
71793
|
+
*/
|
|
71794
|
+
export class VenueKiosksApi extends BaseAPI implements VenueKiosksApiInterface {
|
|
71795
|
+
/**
|
|
71796
|
+
* 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.
|
|
71797
|
+
* @summary Rename a kiosk, change its prefix, or put it in or out of use
|
|
71798
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71799
|
+
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
71800
|
+
* @param {ChangeKioskDto} changeKioskDto
|
|
71801
|
+
* @param {*} [options] Override http request option.
|
|
71802
|
+
* @throws {RequiredError}
|
|
71803
|
+
* @memberof VenueKiosksApi
|
|
71804
|
+
*/
|
|
71805
|
+
public changeVenueKiosk(businessId: number, stationId: string, changeKioskDto: ChangeKioskDto, options?: AxiosRequestConfig) {
|
|
71806
|
+
return VenueKiosksApiFp(this.configuration).changeVenueKiosk(businessId, stationId, changeKioskDto, options).then((request) => request(this.axios, this.basePath));
|
|
71807
|
+
}
|
|
71808
|
+
|
|
71809
|
+
/**
|
|
71810
|
+
* 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.
|
|
71811
|
+
* @summary Link a kiosk to the venue by the Hardware ID it shows
|
|
71812
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71813
|
+
* @param {ClaimKioskDto} claimKioskDto
|
|
71814
|
+
* @param {*} [options] Override http request option.
|
|
71815
|
+
* @throws {RequiredError}
|
|
71816
|
+
* @memberof VenueKiosksApi
|
|
71817
|
+
*/
|
|
71818
|
+
public claimVenueKiosk(businessId: number, claimKioskDto: ClaimKioskDto, options?: AxiosRequestConfig) {
|
|
71819
|
+
return VenueKiosksApiFp(this.configuration).claimVenueKiosk(businessId, claimKioskDto, options).then((request) => request(this.axios, this.basePath));
|
|
71820
|
+
}
|
|
71821
|
+
|
|
71822
|
+
/**
|
|
71823
|
+
* 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.
|
|
71824
|
+
* @summary Link one of the venue\'s payment terminals to a kiosk, or unlink it
|
|
71825
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71826
|
+
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
71827
|
+
* @param {LinkKioskTerminalDto} linkKioskTerminalDto
|
|
71828
|
+
* @param {*} [options] Override http request option.
|
|
71829
|
+
* @throws {RequiredError}
|
|
71830
|
+
* @memberof VenueKiosksApi
|
|
71831
|
+
*/
|
|
71832
|
+
public linkVenueKioskTerminal(businessId: number, stationId: string, linkKioskTerminalDto: LinkKioskTerminalDto, options?: AxiosRequestConfig) {
|
|
71833
|
+
return VenueKiosksApiFp(this.configuration).linkVenueKioskTerminal(businessId, stationId, linkKioskTerminalDto, options).then((request) => request(this.axios, this.basePath));
|
|
71834
|
+
}
|
|
71835
|
+
|
|
71836
|
+
/**
|
|
71837
|
+
* Every kiosk station of the venue, active or removed, oldest first, with its linked payment terminal. Read from the database every time.
|
|
71838
|
+
* @summary List the venue\'s kiosks
|
|
71839
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71840
|
+
* @param {*} [options] Override http request option.
|
|
71841
|
+
* @throws {RequiredError}
|
|
71842
|
+
* @memberof VenueKiosksApi
|
|
71843
|
+
*/
|
|
71844
|
+
public listVenueKiosks(businessId: number, options?: AxiosRequestConfig) {
|
|
71845
|
+
return VenueKiosksApiFp(this.configuration).listVenueKiosks(businessId, options).then((request) => request(this.axios, this.basePath));
|
|
71846
|
+
}
|
|
71847
|
+
|
|
71848
|
+
/**
|
|
71849
|
+
* 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.
|
|
71850
|
+
* @summary List the venue\'s payment terminals, for linking one to a kiosk
|
|
71851
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71852
|
+
* @param {*} [options] Override http request option.
|
|
71853
|
+
* @throws {RequiredError}
|
|
71854
|
+
* @memberof VenueKiosksApi
|
|
71855
|
+
*/
|
|
71856
|
+
public listVenuePaymentTerminals(businessId: number, options?: AxiosRequestConfig) {
|
|
71857
|
+
return VenueKiosksApiFp(this.configuration).listVenuePaymentTerminals(businessId, options).then((request) => request(this.axios, this.basePath));
|
|
71858
|
+
}
|
|
71859
|
+
|
|
71860
|
+
/**
|
|
71861
|
+
* 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.
|
|
71862
|
+
* @summary Remove a kiosk from use
|
|
71863
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71864
|
+
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
71865
|
+
* @param {*} [options] Override http request option.
|
|
71866
|
+
* @throws {RequiredError}
|
|
71867
|
+
* @memberof VenueKiosksApi
|
|
71868
|
+
*/
|
|
71869
|
+
public removeVenueKiosk(businessId: number, stationId: string, options?: AxiosRequestConfig) {
|
|
71870
|
+
return VenueKiosksApiFp(this.configuration).removeVenueKiosk(businessId, stationId, options).then((request) => request(this.axios, this.basePath));
|
|
71871
|
+
}
|
|
71872
|
+
}
|
|
71873
|
+
|
|
71874
|
+
|
|
70879
71875
|
/**
|
|
70880
71876
|
* VivaApi - axios parameter creator
|
|
70881
71877
|
* @export
|