@munchi_oy/core 2.19.0 → 2.21.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 +292 -171
- 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 +376 -173
- package/package.json +13 -15
- package/src/version.ts +1 -1
package/generated/api.ts
CHANGED
|
@@ -2975,7 +2975,8 @@ export const ChannelEnum = {
|
|
|
2975
2975
|
WoltStorefront: 'WoltStorefront',
|
|
2976
2976
|
Storefront: 'Storefront',
|
|
2977
2977
|
MunchiPay: 'MunchiPay',
|
|
2978
|
-
ResQ: 'ResQ'
|
|
2978
|
+
ResQ: 'ResQ',
|
|
2979
|
+
Partner: 'Partner'
|
|
2979
2980
|
} as const;
|
|
2980
2981
|
|
|
2981
2982
|
export type ChannelEnum = typeof ChannelEnum[keyof typeof ChannelEnum];
|
|
@@ -9066,6 +9067,28 @@ export interface GiftCardCredentialsViewDto {
|
|
|
9066
9067
|
*/
|
|
9067
9068
|
'uniquePosDeviceId': string | null;
|
|
9068
9069
|
}
|
|
9070
|
+
/**
|
|
9071
|
+
*
|
|
9072
|
+
* @export
|
|
9073
|
+
* @enum {string}
|
|
9074
|
+
*/
|
|
9075
|
+
|
|
9076
|
+
export const GiftCardDesign = {
|
|
9077
|
+
Photo: 'photo',
|
|
9078
|
+
Birthday: 'birthday',
|
|
9079
|
+
Thanks: 'thanks',
|
|
9080
|
+
Love: 'love',
|
|
9081
|
+
Congrats: 'congrats',
|
|
9082
|
+
Baby: 'baby',
|
|
9083
|
+
Food: 'food',
|
|
9084
|
+
Celebration: 'celebration',
|
|
9085
|
+
Holidays: 'holidays',
|
|
9086
|
+
JustBecause: 'justBecause'
|
|
9087
|
+
} as const;
|
|
9088
|
+
|
|
9089
|
+
export type GiftCardDesign = typeof GiftCardDesign[keyof typeof GiftCardDesign];
|
|
9090
|
+
|
|
9091
|
+
|
|
9069
9092
|
/**
|
|
9070
9093
|
*
|
|
9071
9094
|
* @export
|
|
@@ -25701,7 +25724,8 @@ export const ProviderEnum = {
|
|
|
25701
25724
|
WoltStorefront: 'WoltStorefront',
|
|
25702
25725
|
Storefront: 'Storefront',
|
|
25703
25726
|
MunchiPay: 'MunchiPay',
|
|
25704
|
-
ResQ: 'ResQ'
|
|
25727
|
+
ResQ: 'ResQ',
|
|
25728
|
+
Partner: 'Partner'
|
|
25705
25729
|
} as const;
|
|
25706
25730
|
|
|
25707
25731
|
export type ProviderEnum = typeof ProviderEnum[keyof typeof ProviderEnum];
|
|
@@ -29553,7 +29577,7 @@ export interface ReverseSessionDto {
|
|
|
29553
29577
|
*/
|
|
29554
29578
|
'sessionId': string;
|
|
29555
29579
|
/**
|
|
29556
|
-
* Amount to refund in cents for a partial / item refund. Must be > 0 and <= the session\'s paid amount. Omit to refund the full session amount.
|
|
29580
|
+
* Amount to refund in cents for a partial / item refund. Must be > 0 and <= the session\'s paid amount. Omit to refund the full session amount; on nexi/refund, omitting it refunds what is left of the sale, and nexi/revert ignores it.
|
|
29557
29581
|
* @type {number}
|
|
29558
29582
|
* @memberof ReverseSessionDto
|
|
29559
29583
|
*/
|
|
@@ -32427,6 +32451,12 @@ export interface SellGiftCardOnlineDto {
|
|
|
32427
32451
|
* @memberof SellGiftCardOnlineDto
|
|
32428
32452
|
*/
|
|
32429
32453
|
'paymentProvider'?: PaymentProvider;
|
|
32454
|
+
/**
|
|
32455
|
+
*
|
|
32456
|
+
* @type {GiftCardDesign}
|
|
32457
|
+
* @memberof SellGiftCardOnlineDto
|
|
32458
|
+
*/
|
|
32459
|
+
'design'?: GiftCardDesign;
|
|
32430
32460
|
}
|
|
32431
32461
|
|
|
32432
32462
|
|
|
@@ -39774,6 +39804,12 @@ export interface VenueGiftCardDetailDto {
|
|
|
39774
39804
|
* @memberof VenueGiftCardDetailDto
|
|
39775
39805
|
*/
|
|
39776
39806
|
'language': GiftCardLanguage | null;
|
|
39807
|
+
/**
|
|
39808
|
+
*
|
|
39809
|
+
* @type {GiftCardDesign}
|
|
39810
|
+
* @memberof VenueGiftCardDetailDto
|
|
39811
|
+
*/
|
|
39812
|
+
'design': GiftCardDesign | null;
|
|
39777
39813
|
/**
|
|
39778
39814
|
* When the card\'s email is set to go, ISO 8601: a day the dashboard or the online buyer chose; null for at once
|
|
39779
39815
|
* @type {string}
|
|
@@ -46446,11 +46482,11 @@ export const CashManagementApiAxiosParamCreator = function (configuration?: Conf
|
|
|
46446
46482
|
* @param {string} businessId The venue\'s id (its orderingBusinessId), as text
|
|
46447
46483
|
* @param {string} sessionId The cash session\'s id
|
|
46448
46484
|
* @param {SendCashReportDto} sendCashReportDto
|
|
46449
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} [xAppX] The app sending the request, one of ProviderEnum. The route answers 400 without it and 401 for any other value.
|
|
46485
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} [xAppX] The app sending the request, one of ProviderEnum. The route answers 400 without it and 401 for any other value.
|
|
46450
46486
|
* @param {*} [options] Override http request option.
|
|
46451
46487
|
* @throws {RequiredError}
|
|
46452
46488
|
*/
|
|
46453
|
-
sendSessionReport: async (businessId: string, sessionId: string, sendCashReportDto: SendCashReportDto, xAppX?: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
46489
|
+
sendSessionReport: async (businessId: string, sessionId: string, sendCashReportDto: SendCashReportDto, xAppX?: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
46454
46490
|
// verify required parameter 'businessId' is not null or undefined
|
|
46455
46491
|
assertParamExists('sendSessionReport', 'businessId', businessId)
|
|
46456
46492
|
// verify required parameter 'sessionId' is not null or undefined
|
|
@@ -46573,11 +46609,11 @@ export const CashManagementApiFp = function(configuration?: Configuration) {
|
|
|
46573
46609
|
* @param {string} businessId The venue\'s id (its orderingBusinessId), as text
|
|
46574
46610
|
* @param {string} sessionId The cash session\'s id
|
|
46575
46611
|
* @param {SendCashReportDto} sendCashReportDto
|
|
46576
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} [xAppX] The app sending the request, one of ProviderEnum. The route answers 400 without it and 401 for any other value.
|
|
46612
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} [xAppX] The app sending the request, one of ProviderEnum. The route answers 400 without it and 401 for any other value.
|
|
46577
46613
|
* @param {*} [options] Override http request option.
|
|
46578
46614
|
* @throws {RequiredError}
|
|
46579
46615
|
*/
|
|
46580
|
-
async sendSessionReport(businessId: string, sessionId: string, sendCashReportDto: SendCashReportDto, xAppX?: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CashReportSentDto>> {
|
|
46616
|
+
async sendSessionReport(businessId: string, sessionId: string, sendCashReportDto: SendCashReportDto, xAppX?: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CashReportSentDto>> {
|
|
46581
46617
|
const localVarAxiosArgs = await localVarAxiosParamCreator.sendSessionReport(businessId, sessionId, sendCashReportDto, xAppX, options);
|
|
46582
46618
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
46583
46619
|
},
|
|
@@ -46656,11 +46692,11 @@ export const CashManagementApiFactory = function (configuration?: Configuration,
|
|
|
46656
46692
|
* @param {string} businessId The venue\'s id (its orderingBusinessId), as text
|
|
46657
46693
|
* @param {string} sessionId The cash session\'s id
|
|
46658
46694
|
* @param {SendCashReportDto} sendCashReportDto
|
|
46659
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} [xAppX] The app sending the request, one of ProviderEnum. The route answers 400 without it and 401 for any other value.
|
|
46695
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} [xAppX] The app sending the request, one of ProviderEnum. The route answers 400 without it and 401 for any other value.
|
|
46660
46696
|
* @param {*} [options] Override http request option.
|
|
46661
46697
|
* @throws {RequiredError}
|
|
46662
46698
|
*/
|
|
46663
|
-
sendSessionReport(businessId: string, sessionId: string, sendCashReportDto: SendCashReportDto, xAppX?: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', options?: any): AxiosPromise<CashReportSentDto> {
|
|
46699
|
+
sendSessionReport(businessId: string, sessionId: string, sendCashReportDto: SendCashReportDto, xAppX?: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', options?: any): AxiosPromise<CashReportSentDto> {
|
|
46664
46700
|
return localVarFp.sendSessionReport(businessId, sessionId, sendCashReportDto, xAppX, options).then((request) => request(axios, basePath));
|
|
46665
46701
|
},
|
|
46666
46702
|
};
|
|
@@ -46737,12 +46773,12 @@ export interface CashManagementApiInterface {
|
|
|
46737
46773
|
* @param {string} businessId The venue\'s id (its orderingBusinessId), as text
|
|
46738
46774
|
* @param {string} sessionId The cash session\'s id
|
|
46739
46775
|
* @param {SendCashReportDto} sendCashReportDto
|
|
46740
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} [xAppX] The app sending the request, one of ProviderEnum. The route answers 400 without it and 401 for any other value.
|
|
46776
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} [xAppX] The app sending the request, one of ProviderEnum. The route answers 400 without it and 401 for any other value.
|
|
46741
46777
|
* @param {*} [options] Override http request option.
|
|
46742
46778
|
* @throws {RequiredError}
|
|
46743
46779
|
* @memberof CashManagementApiInterface
|
|
46744
46780
|
*/
|
|
46745
|
-
sendSessionReport(businessId: string, sessionId: string, sendCashReportDto: SendCashReportDto, xAppX?: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', options?: AxiosRequestConfig): AxiosPromise<CashReportSentDto>;
|
|
46781
|
+
sendSessionReport(businessId: string, sessionId: string, sendCashReportDto: SendCashReportDto, xAppX?: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', options?: AxiosRequestConfig): AxiosPromise<CashReportSentDto>;
|
|
46746
46782
|
|
|
46747
46783
|
}
|
|
46748
46784
|
|
|
@@ -46828,12 +46864,12 @@ export class CashManagementApi extends BaseAPI implements CashManagementApiInter
|
|
|
46828
46864
|
* @param {string} businessId The venue\'s id (its orderingBusinessId), as text
|
|
46829
46865
|
* @param {string} sessionId The cash session\'s id
|
|
46830
46866
|
* @param {SendCashReportDto} sendCashReportDto
|
|
46831
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} [xAppX] The app sending the request, one of ProviderEnum. The route answers 400 without it and 401 for any other value.
|
|
46867
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} [xAppX] The app sending the request, one of ProviderEnum. The route answers 400 without it and 401 for any other value.
|
|
46832
46868
|
* @param {*} [options] Override http request option.
|
|
46833
46869
|
* @throws {RequiredError}
|
|
46834
46870
|
* @memberof CashManagementApi
|
|
46835
46871
|
*/
|
|
46836
|
-
public sendSessionReport(businessId: string, sessionId: string, sendCashReportDto: SendCashReportDto, xAppX?: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', options?: AxiosRequestConfig) {
|
|
46872
|
+
public sendSessionReport(businessId: string, sessionId: string, sendCashReportDto: SendCashReportDto, xAppX?: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', options?: AxiosRequestConfig) {
|
|
46837
46873
|
return CashManagementApiFp(this.configuration).sendSessionReport(businessId, sessionId, sendCashReportDto, xAppX, options).then((request) => request(this.axios, this.basePath));
|
|
46838
46874
|
}
|
|
46839
46875
|
}
|
|
@@ -47495,12 +47531,12 @@ export const ConfigManagementApiAxiosParamCreator = function (configuration?: Co
|
|
|
47495
47531
|
* The till\'s Settings screen calls it. Creates the channel\'s config first if it has none. Turning it on also enables the MunchiGiftCard payment option.
|
|
47496
47532
|
* @summary Enable or disable first-party Munchi GiftCard integration
|
|
47497
47533
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
47498
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
47534
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
47499
47535
|
* @param {ConfigureMunchiGiftCardDto} configureMunchiGiftCardDto
|
|
47500
47536
|
* @param {*} [options] Override http request option.
|
|
47501
47537
|
* @throws {RequiredError}
|
|
47502
47538
|
*/
|
|
47503
|
-
configConfigureMunchiGiftCard: async (businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', configureMunchiGiftCardDto: ConfigureMunchiGiftCardDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
47539
|
+
configConfigureMunchiGiftCard: async (businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', configureMunchiGiftCardDto: ConfigureMunchiGiftCardDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
47504
47540
|
// verify required parameter 'businessId' is not null or undefined
|
|
47505
47541
|
assertParamExists('configConfigureMunchiGiftCard', 'businessId', businessId)
|
|
47506
47542
|
// verify required parameter 'xAppX' is not null or undefined
|
|
@@ -47546,11 +47582,11 @@ export const ConfigManagementApiAxiosParamCreator = function (configuration?: Co
|
|
|
47546
47582
|
* The selected provider and each provider\'s settings. A secret key, client secret or password is answered null: it never leaves the server. Nets and Worldline answer hasSecretKey, Nets hasClientSecret, and Nexi hasPassword, saying whether one is stored; Nexi\'s username is answered, as Nets\' clientId is. The route does not check the venue itself; the global access check reads it from the path (R30).
|
|
47547
47583
|
* @summary Read a channel\'s card payment providers
|
|
47548
47584
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
47549
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
47585
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
47550
47586
|
* @param {*} [options] Override http request option.
|
|
47551
47587
|
* @throws {RequiredError}
|
|
47552
47588
|
*/
|
|
47553
|
-
configGetProviders: async (businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
47589
|
+
configGetProviders: async (businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
47554
47590
|
// verify required parameter 'businessId' is not null or undefined
|
|
47555
47591
|
assertParamExists('configGetProviders', 'businessId', businessId)
|
|
47556
47592
|
// verify required parameter 'xAppX' is not null or undefined
|
|
@@ -47636,11 +47672,11 @@ export const ConfigManagementApiAxiosParamCreator = function (configuration?: Co
|
|
|
47636
47672
|
* @summary Remove payment option
|
|
47637
47673
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
47638
47674
|
* @param {string} id The payment option\'s id
|
|
47639
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
47675
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
47640
47676
|
* @param {*} [options] Override http request option.
|
|
47641
47677
|
* @throws {RequiredError}
|
|
47642
47678
|
*/
|
|
47643
|
-
configRemovePaymentOption: async (businessId: number, id: string, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
47679
|
+
configRemovePaymentOption: async (businessId: number, id: string, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
47644
47680
|
// verify required parameter 'businessId' is not null or undefined
|
|
47645
47681
|
assertParamExists('configRemovePaymentOption', 'businessId', businessId)
|
|
47646
47682
|
// verify required parameter 'id' is not null or undefined
|
|
@@ -47684,13 +47720,13 @@ export const ConfigManagementApiAxiosParamCreator = function (configuration?: Co
|
|
|
47684
47720
|
* Only a Munchi admin\'s ticket or Munchi\'s own key may (D163); a venue\'s own login is refused before anything is read or saved. Creates the channel\'s config first if it has none. Saves the access key (from the X-Epassi-Access-Key header, so the request body logger never records it) and the POS name Epassi issued, and turns Epassi payments on for the channel. On the channel\'s first save the server makes a 2048-bit RSA key pair and keeps the private key encrypted; later saves keep it. The answer carries the public key, which the venue sends Epassi, and never the access key or the private key. The apps are told to fetch the config again.
|
|
47685
47721
|
* @summary Save a channel\'s Epassi credentials and answer the public key to send Epassi (Munchi admins only)
|
|
47686
47722
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
47687
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
47723
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
47688
47724
|
* @param {string} xEpassiAccessKey The access key Epassi issued for this venue; Epassi issues a different one for test and production.
|
|
47689
47725
|
* @param {SaveEpassiCredentialsDto} saveEpassiCredentialsDto
|
|
47690
47726
|
* @param {*} [options] Override http request option.
|
|
47691
47727
|
* @throws {RequiredError}
|
|
47692
47728
|
*/
|
|
47693
|
-
configSaveEpassiCredentials: async (businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', xEpassiAccessKey: string, saveEpassiCredentialsDto: SaveEpassiCredentialsDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
47729
|
+
configSaveEpassiCredentials: async (businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', xEpassiAccessKey: string, saveEpassiCredentialsDto: SaveEpassiCredentialsDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
47694
47730
|
// verify required parameter 'businessId' is not null or undefined
|
|
47695
47731
|
assertParamExists('configSaveEpassiCredentials', 'businessId', businessId)
|
|
47696
47732
|
// verify required parameter 'xAppX' is not null or undefined
|
|
@@ -47786,12 +47822,12 @@ export const ConfigManagementApiAxiosParamCreator = function (configuration?: Co
|
|
|
47786
47822
|
* A new config is saved in Europe/Helsinki unless the body says otherwise. The fields below are written as sent; any other field is dropped and its name logged. A venue with no merchant switched to Team or PIN lock gets its own merchant, named after it, in the same transaction. The venue\'s cached config and POS session are cleared.
|
|
47787
47823
|
* @summary Create or update a channel\'s config
|
|
47788
47824
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
47789
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
47825
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
47790
47826
|
* @param {UpsertConfigDto} upsertConfigDto
|
|
47791
47827
|
* @param {*} [options] Override http request option.
|
|
47792
47828
|
* @throws {RequiredError}
|
|
47793
47829
|
*/
|
|
47794
|
-
configUpsertChannelConfig: async (businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertConfigDto: UpsertConfigDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
47830
|
+
configUpsertChannelConfig: async (businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertConfigDto: UpsertConfigDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
47795
47831
|
// verify required parameter 'businessId' is not null or undefined
|
|
47796
47832
|
assertParamExists('configUpsertChannelConfig', 'businessId', businessId)
|
|
47797
47833
|
// verify required parameter 'xAppX' is not null or undefined
|
|
@@ -47837,12 +47873,12 @@ export const ConfigManagementApiAxiosParamCreator = function (configuration?: Co
|
|
|
47837
47873
|
* Creates the channel\'s config first if it has none. Links and credentials are merged over the stored ones; the GiftCard payment option is created after the last option, or switched with the integration.
|
|
47838
47874
|
* @summary Create or update a channel\'s third-party gift card integration
|
|
47839
47875
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
47840
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
47876
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
47841
47877
|
* @param {UpsertGiftCardDto} upsertGiftCardDto
|
|
47842
47878
|
* @param {*} [options] Override http request option.
|
|
47843
47879
|
* @throws {RequiredError}
|
|
47844
47880
|
*/
|
|
47845
|
-
configUpsertGiftCard: async (businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertGiftCardDto: UpsertGiftCardDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
47881
|
+
configUpsertGiftCard: async (businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertGiftCardDto: UpsertGiftCardDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
47846
47882
|
// verify required parameter 'businessId' is not null or undefined
|
|
47847
47883
|
assertParamExists('configUpsertGiftCard', 'businessId', businessId)
|
|
47848
47884
|
// verify required parameter 'xAppX' is not null or undefined
|
|
@@ -47932,12 +47968,12 @@ export const ConfigManagementApiAxiosParamCreator = function (configuration?: Co
|
|
|
47932
47968
|
* Only a Munchi admin\'s ticket or Munchi\'s own key may (D163); a venue\'s own login is refused before anything is read or saved. Creates the channel\'s config first if it has none. Saved active unless isActive is sent. The cached Nets config and token are cleared.
|
|
47933
47969
|
* @summary Create or update a channel\'s Nets config (Munchi admins only)
|
|
47934
47970
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
47935
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
47971
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
47936
47972
|
* @param {UpsertNetsDto} upsertNetsDto
|
|
47937
47973
|
* @param {*} [options] Override http request option.
|
|
47938
47974
|
* @throws {RequiredError}
|
|
47939
47975
|
*/
|
|
47940
|
-
configUpsertNets: async (businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertNetsDto: UpsertNetsDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
47976
|
+
configUpsertNets: async (businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertNetsDto: UpsertNetsDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
47941
47977
|
// verify required parameter 'businessId' is not null or undefined
|
|
47942
47978
|
assertParamExists('configUpsertNets', 'businessId', businessId)
|
|
47943
47979
|
// verify required parameter 'xAppX' is not null or undefined
|
|
@@ -47983,12 +48019,12 @@ export const ConfigManagementApiAxiosParamCreator = function (configuration?: Co
|
|
|
47983
48019
|
* Only a Munchi admin\'s ticket or Munchi\'s own key may (D163); a venue\'s own login is refused before anything is read or saved. Saves the Nexi POS API login (username and password, basic auth) without selecting Nexi on the channel, as the Worldline route does; POST …/providers selects it. A new Nexi config needs its username and password and is refused with 400 without them, before anything is saved, the channel\'s config included; otherwise the channel\'s config is created first if it has none. A new Nexi config is saved active unless isActive is sent; an update without isActive keeps the stored value. A field left out keeps the stored one; an empty or null username or password is refused with 400. The answer never carries the password: hasPassword says whether one is stored.
|
|
47984
48020
|
* @summary Create or update a channel\'s Nexi config (Munchi admins only)
|
|
47985
48021
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
47986
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
48022
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
47987
48023
|
* @param {UpsertNexiDto} upsertNexiDto
|
|
47988
48024
|
* @param {*} [options] Override http request option.
|
|
47989
48025
|
* @throws {RequiredError}
|
|
47990
48026
|
*/
|
|
47991
|
-
configUpsertNexi: async (businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertNexiDto: UpsertNexiDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
48027
|
+
configUpsertNexi: async (businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertNexiDto: UpsertNexiDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
47992
48028
|
// verify required parameter 'businessId' is not null or undefined
|
|
47993
48029
|
assertParamExists('configUpsertNexi', 'businessId', businessId)
|
|
47994
48030
|
// verify required parameter 'xAppX' is not null or undefined
|
|
@@ -48034,12 +48070,12 @@ export const ConfigManagementApiAxiosParamCreator = function (configuration?: Co
|
|
|
48034
48070
|
* Creates the channel\'s config first if it has none. Each option sent is created or updated by its method; the others are left as they are.
|
|
48035
48071
|
* @summary Create or update a channel\'s checkout payment options
|
|
48036
48072
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48037
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
48073
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
48038
48074
|
* @param {UpsertPaymentOptionsDto} upsertPaymentOptionsDto
|
|
48039
48075
|
* @param {*} [options] Override http request option.
|
|
48040
48076
|
* @throws {RequiredError}
|
|
48041
48077
|
*/
|
|
48042
|
-
configUpsertPaymentOptions: async (businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertPaymentOptionsDto: UpsertPaymentOptionsDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
48078
|
+
configUpsertPaymentOptions: async (businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertPaymentOptionsDto: UpsertPaymentOptionsDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
48043
48079
|
// verify required parameter 'businessId' is not null or undefined
|
|
48044
48080
|
assertParamExists('configUpsertPaymentOptions', 'businessId', businessId)
|
|
48045
48081
|
// verify required parameter 'xAppX' is not null or undefined
|
|
@@ -48085,12 +48121,12 @@ export const ConfigManagementApiAxiosParamCreator = function (configuration?: Co
|
|
|
48085
48121
|
* Only a Munchi admin\'s ticket or Munchi\'s own key may (D163); a venue\'s own login is refused before anything is read or saved. Saves the chosen provider\'s own fields (Viva as the Viva route would, Nets and Stripe as their routes would; Worldline and Nexi as Nets and Stripe, so an absent isActive saves them active here, unlike on their own routes), then selects it on the channel as the channel config route would, and answers the providers as read afterwards. The provider\'s settings and the selection are saved in one transaction: both or neither. A new Viva config without a rate is refused, as on the Viva route, when the venue has no licence or the license server cannot be read. A new Nexi config needs its username and password, the Nexi POS API login its payments start with, and is refused with 400 without them, before anything is saved; a stored one keeps them when they are left out; an empty or null one is refused with 400.
|
|
48086
48122
|
* @summary Set active provider and upsert its credentials (Munchi admins only)
|
|
48087
48123
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48088
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
48124
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
48089
48125
|
* @param {UpsertProvidersDto} upsertProvidersDto
|
|
48090
48126
|
* @param {*} [options] Override http request option.
|
|
48091
48127
|
* @throws {RequiredError}
|
|
48092
48128
|
*/
|
|
48093
|
-
configUpsertProviders: async (businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertProvidersDto: UpsertProvidersDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
48129
|
+
configUpsertProviders: async (businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertProvidersDto: UpsertProvidersDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
48094
48130
|
// verify required parameter 'businessId' is not null or undefined
|
|
48095
48131
|
assertParamExists('configUpsertProviders', 'businessId', businessId)
|
|
48096
48132
|
// verify required parameter 'xAppX' is not null or undefined
|
|
@@ -48136,12 +48172,12 @@ export const ConfigManagementApiAxiosParamCreator = function (configuration?: Co
|
|
|
48136
48172
|
* Only a Munchi admin\'s ticket or Munchi\'s own key may (D163); a venue\'s own login is refused before anything is read or saved. Creates the channel\'s config first if it has none. Saved active unless isActive is sent. The cached Stripe config is cleared.
|
|
48137
48173
|
* @summary Create or update a channel\'s Stripe config (Munchi admins only)
|
|
48138
48174
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48139
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
48175
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
48140
48176
|
* @param {UpsertStripeDto} upsertStripeDto
|
|
48141
48177
|
* @param {*} [options] Override http request option.
|
|
48142
48178
|
* @throws {RequiredError}
|
|
48143
48179
|
*/
|
|
48144
|
-
configUpsertStripe: async (businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertStripeDto: UpsertStripeDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
48180
|
+
configUpsertStripe: async (businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertStripeDto: UpsertStripeDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
48145
48181
|
// verify required parameter 'businessId' is not null or undefined
|
|
48146
48182
|
assertParamExists('configUpsertStripe', 'businessId', businessId)
|
|
48147
48183
|
// verify required parameter 'xAppX' is not null or undefined
|
|
@@ -48187,12 +48223,12 @@ export const ConfigManagementApiAxiosParamCreator = function (configuration?: Co
|
|
|
48187
48223
|
* Only a Munchi admin\'s ticket or Munchi\'s own key may (D163); a venue\'s own login is refused before anything is read or saved. Creates the channel\'s config first if it has none. A new Viva config needs a merchantId and takes the license server\'s ISV when no rate is sent, and is refused when the venue has no licence or the license server cannot be read; a changed rate or additionalAmount is saved on the license server first.
|
|
48188
48224
|
* @summary Create or update a channel\'s Viva config (Munchi admins only)
|
|
48189
48225
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48190
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
48226
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
48191
48227
|
* @param {UpsertVivaDto} upsertVivaDto
|
|
48192
48228
|
* @param {*} [options] Override http request option.
|
|
48193
48229
|
* @throws {RequiredError}
|
|
48194
48230
|
*/
|
|
48195
|
-
configUpsertViva: async (businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertVivaDto: UpsertVivaDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
48231
|
+
configUpsertViva: async (businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertVivaDto: UpsertVivaDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
48196
48232
|
// verify required parameter 'businessId' is not null or undefined
|
|
48197
48233
|
assertParamExists('configUpsertViva', 'businessId', businessId)
|
|
48198
48234
|
// verify required parameter 'xAppX' is not null or undefined
|
|
@@ -48238,12 +48274,12 @@ export const ConfigManagementApiAxiosParamCreator = function (configuration?: Co
|
|
|
48238
48274
|
* Only a Munchi admin\'s ticket or Munchi\'s own key may (D163); a venue\'s own login is refused before anything is read or saved. Saves Worldline\'s keys without selecting Worldline on the channel, as the Nets route does. Creates the channel\'s config first if it has none. A new Worldline config is saved active unless isActive is sent; an update without isActive keeps the stored value. A key left out keeps the stored one; an empty or null key is refused with 400. worldline-microservice keeps a terminal\'s credentials for up to its cache time, so a changed key reaches the terminal\'s next payment after that.
|
|
48239
48275
|
* @summary Create or update a channel\'s Worldline config (Munchi admins only)
|
|
48240
48276
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48241
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
48277
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
48242
48278
|
* @param {UpsertWorldlineDto} upsertWorldlineDto
|
|
48243
48279
|
* @param {*} [options] Override http request option.
|
|
48244
48280
|
* @throws {RequiredError}
|
|
48245
48281
|
*/
|
|
48246
|
-
configUpsertWorldline: async (businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertWorldlineDto: UpsertWorldlineDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
48282
|
+
configUpsertWorldline: async (businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertWorldlineDto: UpsertWorldlineDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
48247
48283
|
// verify required parameter 'businessId' is not null or undefined
|
|
48248
48284
|
assertParamExists('configUpsertWorldline', 'businessId', businessId)
|
|
48249
48285
|
// verify required parameter 'xAppX' is not null or undefined
|
|
@@ -48299,12 +48335,12 @@ export const ConfigManagementApiFp = function(configuration?: Configuration) {
|
|
|
48299
48335
|
* The till\'s Settings screen calls it. Creates the channel\'s config first if it has none. Turning it on also enables the MunchiGiftCard payment option.
|
|
48300
48336
|
* @summary Enable or disable first-party Munchi GiftCard integration
|
|
48301
48337
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48302
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
48338
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
48303
48339
|
* @param {ConfigureMunchiGiftCardDto} configureMunchiGiftCardDto
|
|
48304
48340
|
* @param {*} [options] Override http request option.
|
|
48305
48341
|
* @throws {RequiredError}
|
|
48306
48342
|
*/
|
|
48307
|
-
async configConfigureMunchiGiftCard(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', configureMunchiGiftCardDto: ConfigureMunchiGiftCardDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfigManagementResponseDto>> {
|
|
48343
|
+
async configConfigureMunchiGiftCard(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', configureMunchiGiftCardDto: ConfigureMunchiGiftCardDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfigManagementResponseDto>> {
|
|
48308
48344
|
const localVarAxiosArgs = await localVarAxiosParamCreator.configConfigureMunchiGiftCard(businessId, xAppX, configureMunchiGiftCardDto, options);
|
|
48309
48345
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
48310
48346
|
},
|
|
@@ -48312,11 +48348,11 @@ export const ConfigManagementApiFp = function(configuration?: Configuration) {
|
|
|
48312
48348
|
* The selected provider and each provider\'s settings. A secret key, client secret or password is answered null: it never leaves the server. Nets and Worldline answer hasSecretKey, Nets hasClientSecret, and Nexi hasPassword, saying whether one is stored; Nexi\'s username is answered, as Nets\' clientId is. The route does not check the venue itself; the global access check reads it from the path (R30).
|
|
48313
48349
|
* @summary Read a channel\'s card payment providers
|
|
48314
48350
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48315
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
48351
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
48316
48352
|
* @param {*} [options] Override http request option.
|
|
48317
48353
|
* @throws {RequiredError}
|
|
48318
48354
|
*/
|
|
48319
|
-
async configGetProviders(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProvidersConfigResponseDto>> {
|
|
48355
|
+
async configGetProviders(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProvidersConfigResponseDto>> {
|
|
48320
48356
|
const localVarAxiosArgs = await localVarAxiosParamCreator.configGetProviders(businessId, xAppX, options);
|
|
48321
48357
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
48322
48358
|
},
|
|
@@ -48337,11 +48373,11 @@ export const ConfigManagementApiFp = function(configuration?: Configuration) {
|
|
|
48337
48373
|
* @summary Remove payment option
|
|
48338
48374
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48339
48375
|
* @param {string} id The payment option\'s id
|
|
48340
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
48376
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
48341
48377
|
* @param {*} [options] Override http request option.
|
|
48342
48378
|
* @throws {RequiredError}
|
|
48343
48379
|
*/
|
|
48344
|
-
async configRemovePaymentOption(businessId: number, id: string, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfigManagementResponseDto>> {
|
|
48380
|
+
async configRemovePaymentOption(businessId: number, id: string, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfigManagementResponseDto>> {
|
|
48345
48381
|
const localVarAxiosArgs = await localVarAxiosParamCreator.configRemovePaymentOption(businessId, id, xAppX, options);
|
|
48346
48382
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
48347
48383
|
},
|
|
@@ -48349,13 +48385,13 @@ export const ConfigManagementApiFp = function(configuration?: Configuration) {
|
|
|
48349
48385
|
* Only a Munchi admin\'s ticket or Munchi\'s own key may (D163); a venue\'s own login is refused before anything is read or saved. Creates the channel\'s config first if it has none. Saves the access key (from the X-Epassi-Access-Key header, so the request body logger never records it) and the POS name Epassi issued, and turns Epassi payments on for the channel. On the channel\'s first save the server makes a 2048-bit RSA key pair and keeps the private key encrypted; later saves keep it. The answer carries the public key, which the venue sends Epassi, and never the access key or the private key. The apps are told to fetch the config again.
|
|
48350
48386
|
* @summary Save a channel\'s Epassi credentials and answer the public key to send Epassi (Munchi admins only)
|
|
48351
48387
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48352
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
48388
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
48353
48389
|
* @param {string} xEpassiAccessKey The access key Epassi issued for this venue; Epassi issues a different one for test and production.
|
|
48354
48390
|
* @param {SaveEpassiCredentialsDto} saveEpassiCredentialsDto
|
|
48355
48391
|
* @param {*} [options] Override http request option.
|
|
48356
48392
|
* @throws {RequiredError}
|
|
48357
48393
|
*/
|
|
48358
|
-
async configSaveEpassiCredentials(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', xEpassiAccessKey: string, saveEpassiCredentialsDto: SaveEpassiCredentialsDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EpassiCredentialsSavedDto>> {
|
|
48394
|
+
async configSaveEpassiCredentials(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', xEpassiAccessKey: string, saveEpassiCredentialsDto: SaveEpassiCredentialsDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EpassiCredentialsSavedDto>> {
|
|
48359
48395
|
const localVarAxiosArgs = await localVarAxiosParamCreator.configSaveEpassiCredentials(businessId, xAppX, xEpassiAccessKey, saveEpassiCredentialsDto, options);
|
|
48360
48396
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
48361
48397
|
},
|
|
@@ -48375,12 +48411,12 @@ export const ConfigManagementApiFp = function(configuration?: Configuration) {
|
|
|
48375
48411
|
* A new config is saved in Europe/Helsinki unless the body says otherwise. The fields below are written as sent; any other field is dropped and its name logged. A venue with no merchant switched to Team or PIN lock gets its own merchant, named after it, in the same transaction. The venue\'s cached config and POS session are cleared.
|
|
48376
48412
|
* @summary Create or update a channel\'s config
|
|
48377
48413
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48378
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
48414
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
48379
48415
|
* @param {UpsertConfigDto} upsertConfigDto
|
|
48380
48416
|
* @param {*} [options] Override http request option.
|
|
48381
48417
|
* @throws {RequiredError}
|
|
48382
48418
|
*/
|
|
48383
|
-
async configUpsertChannelConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertConfigDto: UpsertConfigDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfigManagementResponseDto>> {
|
|
48419
|
+
async configUpsertChannelConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertConfigDto: UpsertConfigDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfigManagementResponseDto>> {
|
|
48384
48420
|
const localVarAxiosArgs = await localVarAxiosParamCreator.configUpsertChannelConfig(businessId, xAppX, upsertConfigDto, options);
|
|
48385
48421
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
48386
48422
|
},
|
|
@@ -48388,12 +48424,12 @@ export const ConfigManagementApiFp = function(configuration?: Configuration) {
|
|
|
48388
48424
|
* Creates the channel\'s config first if it has none. Links and credentials are merged over the stored ones; the GiftCard payment option is created after the last option, or switched with the integration.
|
|
48389
48425
|
* @summary Create or update a channel\'s third-party gift card integration
|
|
48390
48426
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48391
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
48427
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
48392
48428
|
* @param {UpsertGiftCardDto} upsertGiftCardDto
|
|
48393
48429
|
* @param {*} [options] Override http request option.
|
|
48394
48430
|
* @throws {RequiredError}
|
|
48395
48431
|
*/
|
|
48396
|
-
async configUpsertGiftCard(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertGiftCardDto: UpsertGiftCardDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfigManagementResponseDto>> {
|
|
48432
|
+
async configUpsertGiftCard(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertGiftCardDto: UpsertGiftCardDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfigManagementResponseDto>> {
|
|
48397
48433
|
const localVarAxiosArgs = await localVarAxiosParamCreator.configUpsertGiftCard(businessId, xAppX, upsertGiftCardDto, options);
|
|
48398
48434
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
48399
48435
|
},
|
|
@@ -48413,12 +48449,12 @@ export const ConfigManagementApiFp = function(configuration?: Configuration) {
|
|
|
48413
48449
|
* Only a Munchi admin\'s ticket or Munchi\'s own key may (D163); a venue\'s own login is refused before anything is read or saved. Creates the channel\'s config first if it has none. Saved active unless isActive is sent. The cached Nets config and token are cleared.
|
|
48414
48450
|
* @summary Create or update a channel\'s Nets config (Munchi admins only)
|
|
48415
48451
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48416
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
48452
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
48417
48453
|
* @param {UpsertNetsDto} upsertNetsDto
|
|
48418
48454
|
* @param {*} [options] Override http request option.
|
|
48419
48455
|
* @throws {RequiredError}
|
|
48420
48456
|
*/
|
|
48421
|
-
async configUpsertNets(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertNetsDto: UpsertNetsDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfigManagementResponseDto>> {
|
|
48457
|
+
async configUpsertNets(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertNetsDto: UpsertNetsDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfigManagementResponseDto>> {
|
|
48422
48458
|
const localVarAxiosArgs = await localVarAxiosParamCreator.configUpsertNets(businessId, xAppX, upsertNetsDto, options);
|
|
48423
48459
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
48424
48460
|
},
|
|
@@ -48426,12 +48462,12 @@ export const ConfigManagementApiFp = function(configuration?: Configuration) {
|
|
|
48426
48462
|
* Only a Munchi admin\'s ticket or Munchi\'s own key may (D163); a venue\'s own login is refused before anything is read or saved. Saves the Nexi POS API login (username and password, basic auth) without selecting Nexi on the channel, as the Worldline route does; POST …/providers selects it. A new Nexi config needs its username and password and is refused with 400 without them, before anything is saved, the channel\'s config included; otherwise the channel\'s config is created first if it has none. A new Nexi config is saved active unless isActive is sent; an update without isActive keeps the stored value. A field left out keeps the stored one; an empty or null username or password is refused with 400. The answer never carries the password: hasPassword says whether one is stored.
|
|
48427
48463
|
* @summary Create or update a channel\'s Nexi config (Munchi admins only)
|
|
48428
48464
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48429
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
48465
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
48430
48466
|
* @param {UpsertNexiDto} upsertNexiDto
|
|
48431
48467
|
* @param {*} [options] Override http request option.
|
|
48432
48468
|
* @throws {RequiredError}
|
|
48433
48469
|
*/
|
|
48434
|
-
async configUpsertNexi(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertNexiDto: UpsertNexiDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfigManagementResponseDto>> {
|
|
48470
|
+
async configUpsertNexi(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertNexiDto: UpsertNexiDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfigManagementResponseDto>> {
|
|
48435
48471
|
const localVarAxiosArgs = await localVarAxiosParamCreator.configUpsertNexi(businessId, xAppX, upsertNexiDto, options);
|
|
48436
48472
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
48437
48473
|
},
|
|
@@ -48439,12 +48475,12 @@ export const ConfigManagementApiFp = function(configuration?: Configuration) {
|
|
|
48439
48475
|
* Creates the channel\'s config first if it has none. Each option sent is created or updated by its method; the others are left as they are.
|
|
48440
48476
|
* @summary Create or update a channel\'s checkout payment options
|
|
48441
48477
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48442
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
48478
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
48443
48479
|
* @param {UpsertPaymentOptionsDto} upsertPaymentOptionsDto
|
|
48444
48480
|
* @param {*} [options] Override http request option.
|
|
48445
48481
|
* @throws {RequiredError}
|
|
48446
48482
|
*/
|
|
48447
|
-
async configUpsertPaymentOptions(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertPaymentOptionsDto: UpsertPaymentOptionsDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfigManagementResponseDto>> {
|
|
48483
|
+
async configUpsertPaymentOptions(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertPaymentOptionsDto: UpsertPaymentOptionsDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfigManagementResponseDto>> {
|
|
48448
48484
|
const localVarAxiosArgs = await localVarAxiosParamCreator.configUpsertPaymentOptions(businessId, xAppX, upsertPaymentOptionsDto, options);
|
|
48449
48485
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
48450
48486
|
},
|
|
@@ -48452,12 +48488,12 @@ export const ConfigManagementApiFp = function(configuration?: Configuration) {
|
|
|
48452
48488
|
* Only a Munchi admin\'s ticket or Munchi\'s own key may (D163); a venue\'s own login is refused before anything is read or saved. Saves the chosen provider\'s own fields (Viva as the Viva route would, Nets and Stripe as their routes would; Worldline and Nexi as Nets and Stripe, so an absent isActive saves them active here, unlike on their own routes), then selects it on the channel as the channel config route would, and answers the providers as read afterwards. The provider\'s settings and the selection are saved in one transaction: both or neither. A new Viva config without a rate is refused, as on the Viva route, when the venue has no licence or the license server cannot be read. A new Nexi config needs its username and password, the Nexi POS API login its payments start with, and is refused with 400 without them, before anything is saved; a stored one keeps them when they are left out; an empty or null one is refused with 400.
|
|
48453
48489
|
* @summary Set active provider and upsert its credentials (Munchi admins only)
|
|
48454
48490
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48455
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
48491
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
48456
48492
|
* @param {UpsertProvidersDto} upsertProvidersDto
|
|
48457
48493
|
* @param {*} [options] Override http request option.
|
|
48458
48494
|
* @throws {RequiredError}
|
|
48459
48495
|
*/
|
|
48460
|
-
async configUpsertProviders(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertProvidersDto: UpsertProvidersDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProvidersConfigResponseDto>> {
|
|
48496
|
+
async configUpsertProviders(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertProvidersDto: UpsertProvidersDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProvidersConfigResponseDto>> {
|
|
48461
48497
|
const localVarAxiosArgs = await localVarAxiosParamCreator.configUpsertProviders(businessId, xAppX, upsertProvidersDto, options);
|
|
48462
48498
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
48463
48499
|
},
|
|
@@ -48465,12 +48501,12 @@ export const ConfigManagementApiFp = function(configuration?: Configuration) {
|
|
|
48465
48501
|
* Only a Munchi admin\'s ticket or Munchi\'s own key may (D163); a venue\'s own login is refused before anything is read or saved. Creates the channel\'s config first if it has none. Saved active unless isActive is sent. The cached Stripe config is cleared.
|
|
48466
48502
|
* @summary Create or update a channel\'s Stripe config (Munchi admins only)
|
|
48467
48503
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48468
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
48504
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
48469
48505
|
* @param {UpsertStripeDto} upsertStripeDto
|
|
48470
48506
|
* @param {*} [options] Override http request option.
|
|
48471
48507
|
* @throws {RequiredError}
|
|
48472
48508
|
*/
|
|
48473
|
-
async configUpsertStripe(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertStripeDto: UpsertStripeDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfigManagementResponseDto>> {
|
|
48509
|
+
async configUpsertStripe(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertStripeDto: UpsertStripeDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfigManagementResponseDto>> {
|
|
48474
48510
|
const localVarAxiosArgs = await localVarAxiosParamCreator.configUpsertStripe(businessId, xAppX, upsertStripeDto, options);
|
|
48475
48511
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
48476
48512
|
},
|
|
@@ -48478,12 +48514,12 @@ export const ConfigManagementApiFp = function(configuration?: Configuration) {
|
|
|
48478
48514
|
* Only a Munchi admin\'s ticket or Munchi\'s own key may (D163); a venue\'s own login is refused before anything is read or saved. Creates the channel\'s config first if it has none. A new Viva config needs a merchantId and takes the license server\'s ISV when no rate is sent, and is refused when the venue has no licence or the license server cannot be read; a changed rate or additionalAmount is saved on the license server first.
|
|
48479
48515
|
* @summary Create or update a channel\'s Viva config (Munchi admins only)
|
|
48480
48516
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48481
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
48517
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
48482
48518
|
* @param {UpsertVivaDto} upsertVivaDto
|
|
48483
48519
|
* @param {*} [options] Override http request option.
|
|
48484
48520
|
* @throws {RequiredError}
|
|
48485
48521
|
*/
|
|
48486
|
-
async configUpsertViva(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertVivaDto: UpsertVivaDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfigManagementResponseDto>> {
|
|
48522
|
+
async configUpsertViva(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertVivaDto: UpsertVivaDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfigManagementResponseDto>> {
|
|
48487
48523
|
const localVarAxiosArgs = await localVarAxiosParamCreator.configUpsertViva(businessId, xAppX, upsertVivaDto, options);
|
|
48488
48524
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
48489
48525
|
},
|
|
@@ -48491,12 +48527,12 @@ export const ConfigManagementApiFp = function(configuration?: Configuration) {
|
|
|
48491
48527
|
* Only a Munchi admin\'s ticket or Munchi\'s own key may (D163); a venue\'s own login is refused before anything is read or saved. Saves Worldline\'s keys without selecting Worldline on the channel, as the Nets route does. Creates the channel\'s config first if it has none. A new Worldline config is saved active unless isActive is sent; an update without isActive keeps the stored value. A key left out keeps the stored one; an empty or null key is refused with 400. worldline-microservice keeps a terminal\'s credentials for up to its cache time, so a changed key reaches the terminal\'s next payment after that.
|
|
48492
48528
|
* @summary Create or update a channel\'s Worldline config (Munchi admins only)
|
|
48493
48529
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48494
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
48530
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
48495
48531
|
* @param {UpsertWorldlineDto} upsertWorldlineDto
|
|
48496
48532
|
* @param {*} [options] Override http request option.
|
|
48497
48533
|
* @throws {RequiredError}
|
|
48498
48534
|
*/
|
|
48499
|
-
async configUpsertWorldline(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertWorldlineDto: UpsertWorldlineDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfigManagementResponseDto>> {
|
|
48535
|
+
async configUpsertWorldline(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertWorldlineDto: UpsertWorldlineDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfigManagementResponseDto>> {
|
|
48500
48536
|
const localVarAxiosArgs = await localVarAxiosParamCreator.configUpsertWorldline(businessId, xAppX, upsertWorldlineDto, options);
|
|
48501
48537
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
48502
48538
|
},
|
|
@@ -48514,23 +48550,23 @@ export const ConfigManagementApiFactory = function (configuration?: Configuratio
|
|
|
48514
48550
|
* The till\'s Settings screen calls it. Creates the channel\'s config first if it has none. Turning it on also enables the MunchiGiftCard payment option.
|
|
48515
48551
|
* @summary Enable or disable first-party Munchi GiftCard integration
|
|
48516
48552
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48517
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
48553
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
48518
48554
|
* @param {ConfigureMunchiGiftCardDto} configureMunchiGiftCardDto
|
|
48519
48555
|
* @param {*} [options] Override http request option.
|
|
48520
48556
|
* @throws {RequiredError}
|
|
48521
48557
|
*/
|
|
48522
|
-
configConfigureMunchiGiftCard(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', configureMunchiGiftCardDto: ConfigureMunchiGiftCardDto, options?: any): AxiosPromise<ConfigManagementResponseDto> {
|
|
48558
|
+
configConfigureMunchiGiftCard(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', configureMunchiGiftCardDto: ConfigureMunchiGiftCardDto, options?: any): AxiosPromise<ConfigManagementResponseDto> {
|
|
48523
48559
|
return localVarFp.configConfigureMunchiGiftCard(businessId, xAppX, configureMunchiGiftCardDto, options).then((request) => request(axios, basePath));
|
|
48524
48560
|
},
|
|
48525
48561
|
/**
|
|
48526
48562
|
* The selected provider and each provider\'s settings. A secret key, client secret or password is answered null: it never leaves the server. Nets and Worldline answer hasSecretKey, Nets hasClientSecret, and Nexi hasPassword, saying whether one is stored; Nexi\'s username is answered, as Nets\' clientId is. The route does not check the venue itself; the global access check reads it from the path (R30).
|
|
48527
48563
|
* @summary Read a channel\'s card payment providers
|
|
48528
48564
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48529
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
48565
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
48530
48566
|
* @param {*} [options] Override http request option.
|
|
48531
48567
|
* @throws {RequiredError}
|
|
48532
48568
|
*/
|
|
48533
|
-
configGetProviders(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', options?: any): AxiosPromise<ProvidersConfigResponseDto> {
|
|
48569
|
+
configGetProviders(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', options?: any): AxiosPromise<ProvidersConfigResponseDto> {
|
|
48534
48570
|
return localVarFp.configGetProviders(businessId, xAppX, options).then((request) => request(axios, basePath));
|
|
48535
48571
|
},
|
|
48536
48572
|
/**
|
|
@@ -48549,24 +48585,24 @@ export const ConfigManagementApiFactory = function (configuration?: Configuratio
|
|
|
48549
48585
|
* @summary Remove payment option
|
|
48550
48586
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48551
48587
|
* @param {string} id The payment option\'s id
|
|
48552
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
48588
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
48553
48589
|
* @param {*} [options] Override http request option.
|
|
48554
48590
|
* @throws {RequiredError}
|
|
48555
48591
|
*/
|
|
48556
|
-
configRemovePaymentOption(businessId: number, id: string, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', options?: any): AxiosPromise<ConfigManagementResponseDto> {
|
|
48592
|
+
configRemovePaymentOption(businessId: number, id: string, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', options?: any): AxiosPromise<ConfigManagementResponseDto> {
|
|
48557
48593
|
return localVarFp.configRemovePaymentOption(businessId, id, xAppX, options).then((request) => request(axios, basePath));
|
|
48558
48594
|
},
|
|
48559
48595
|
/**
|
|
48560
48596
|
* Only a Munchi admin\'s ticket or Munchi\'s own key may (D163); a venue\'s own login is refused before anything is read or saved. Creates the channel\'s config first if it has none. Saves the access key (from the X-Epassi-Access-Key header, so the request body logger never records it) and the POS name Epassi issued, and turns Epassi payments on for the channel. On the channel\'s first save the server makes a 2048-bit RSA key pair and keeps the private key encrypted; later saves keep it. The answer carries the public key, which the venue sends Epassi, and never the access key or the private key. The apps are told to fetch the config again.
|
|
48561
48597
|
* @summary Save a channel\'s Epassi credentials and answer the public key to send Epassi (Munchi admins only)
|
|
48562
48598
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48563
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
48599
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
48564
48600
|
* @param {string} xEpassiAccessKey The access key Epassi issued for this venue; Epassi issues a different one for test and production.
|
|
48565
48601
|
* @param {SaveEpassiCredentialsDto} saveEpassiCredentialsDto
|
|
48566
48602
|
* @param {*} [options] Override http request option.
|
|
48567
48603
|
* @throws {RequiredError}
|
|
48568
48604
|
*/
|
|
48569
|
-
configSaveEpassiCredentials(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', xEpassiAccessKey: string, saveEpassiCredentialsDto: SaveEpassiCredentialsDto, options?: any): AxiosPromise<EpassiCredentialsSavedDto> {
|
|
48605
|
+
configSaveEpassiCredentials(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', xEpassiAccessKey: string, saveEpassiCredentialsDto: SaveEpassiCredentialsDto, options?: any): AxiosPromise<EpassiCredentialsSavedDto> {
|
|
48570
48606
|
return localVarFp.configSaveEpassiCredentials(businessId, xAppX, xEpassiAccessKey, saveEpassiCredentialsDto, options).then((request) => request(axios, basePath));
|
|
48571
48607
|
},
|
|
48572
48608
|
/**
|
|
@@ -48584,24 +48620,24 @@ export const ConfigManagementApiFactory = function (configuration?: Configuratio
|
|
|
48584
48620
|
* A new config is saved in Europe/Helsinki unless the body says otherwise. The fields below are written as sent; any other field is dropped and its name logged. A venue with no merchant switched to Team or PIN lock gets its own merchant, named after it, in the same transaction. The venue\'s cached config and POS session are cleared.
|
|
48585
48621
|
* @summary Create or update a channel\'s config
|
|
48586
48622
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48587
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
48623
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
48588
48624
|
* @param {UpsertConfigDto} upsertConfigDto
|
|
48589
48625
|
* @param {*} [options] Override http request option.
|
|
48590
48626
|
* @throws {RequiredError}
|
|
48591
48627
|
*/
|
|
48592
|
-
configUpsertChannelConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertConfigDto: UpsertConfigDto, options?: any): AxiosPromise<ConfigManagementResponseDto> {
|
|
48628
|
+
configUpsertChannelConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertConfigDto: UpsertConfigDto, options?: any): AxiosPromise<ConfigManagementResponseDto> {
|
|
48593
48629
|
return localVarFp.configUpsertChannelConfig(businessId, xAppX, upsertConfigDto, options).then((request) => request(axios, basePath));
|
|
48594
48630
|
},
|
|
48595
48631
|
/**
|
|
48596
48632
|
* Creates the channel\'s config first if it has none. Links and credentials are merged over the stored ones; the GiftCard payment option is created after the last option, or switched with the integration.
|
|
48597
48633
|
* @summary Create or update a channel\'s third-party gift card integration
|
|
48598
48634
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48599
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
48635
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
48600
48636
|
* @param {UpsertGiftCardDto} upsertGiftCardDto
|
|
48601
48637
|
* @param {*} [options] Override http request option.
|
|
48602
48638
|
* @throws {RequiredError}
|
|
48603
48639
|
*/
|
|
48604
|
-
configUpsertGiftCard(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertGiftCardDto: UpsertGiftCardDto, options?: any): AxiosPromise<ConfigManagementResponseDto> {
|
|
48640
|
+
configUpsertGiftCard(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertGiftCardDto: UpsertGiftCardDto, options?: any): AxiosPromise<ConfigManagementResponseDto> {
|
|
48605
48641
|
return localVarFp.configUpsertGiftCard(businessId, xAppX, upsertGiftCardDto, options).then((request) => request(axios, basePath));
|
|
48606
48642
|
},
|
|
48607
48643
|
/**
|
|
@@ -48619,84 +48655,84 @@ export const ConfigManagementApiFactory = function (configuration?: Configuratio
|
|
|
48619
48655
|
* Only a Munchi admin\'s ticket or Munchi\'s own key may (D163); a venue\'s own login is refused before anything is read or saved. Creates the channel\'s config first if it has none. Saved active unless isActive is sent. The cached Nets config and token are cleared.
|
|
48620
48656
|
* @summary Create or update a channel\'s Nets config (Munchi admins only)
|
|
48621
48657
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48622
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
48658
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
48623
48659
|
* @param {UpsertNetsDto} upsertNetsDto
|
|
48624
48660
|
* @param {*} [options] Override http request option.
|
|
48625
48661
|
* @throws {RequiredError}
|
|
48626
48662
|
*/
|
|
48627
|
-
configUpsertNets(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertNetsDto: UpsertNetsDto, options?: any): AxiosPromise<ConfigManagementResponseDto> {
|
|
48663
|
+
configUpsertNets(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertNetsDto: UpsertNetsDto, options?: any): AxiosPromise<ConfigManagementResponseDto> {
|
|
48628
48664
|
return localVarFp.configUpsertNets(businessId, xAppX, upsertNetsDto, options).then((request) => request(axios, basePath));
|
|
48629
48665
|
},
|
|
48630
48666
|
/**
|
|
48631
48667
|
* Only a Munchi admin\'s ticket or Munchi\'s own key may (D163); a venue\'s own login is refused before anything is read or saved. Saves the Nexi POS API login (username and password, basic auth) without selecting Nexi on the channel, as the Worldline route does; POST …/providers selects it. A new Nexi config needs its username and password and is refused with 400 without them, before anything is saved, the channel\'s config included; otherwise the channel\'s config is created first if it has none. A new Nexi config is saved active unless isActive is sent; an update without isActive keeps the stored value. A field left out keeps the stored one; an empty or null username or password is refused with 400. The answer never carries the password: hasPassword says whether one is stored.
|
|
48632
48668
|
* @summary Create or update a channel\'s Nexi config (Munchi admins only)
|
|
48633
48669
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48634
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
48670
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
48635
48671
|
* @param {UpsertNexiDto} upsertNexiDto
|
|
48636
48672
|
* @param {*} [options] Override http request option.
|
|
48637
48673
|
* @throws {RequiredError}
|
|
48638
48674
|
*/
|
|
48639
|
-
configUpsertNexi(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertNexiDto: UpsertNexiDto, options?: any): AxiosPromise<ConfigManagementResponseDto> {
|
|
48675
|
+
configUpsertNexi(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertNexiDto: UpsertNexiDto, options?: any): AxiosPromise<ConfigManagementResponseDto> {
|
|
48640
48676
|
return localVarFp.configUpsertNexi(businessId, xAppX, upsertNexiDto, options).then((request) => request(axios, basePath));
|
|
48641
48677
|
},
|
|
48642
48678
|
/**
|
|
48643
48679
|
* Creates the channel\'s config first if it has none. Each option sent is created or updated by its method; the others are left as they are.
|
|
48644
48680
|
* @summary Create or update a channel\'s checkout payment options
|
|
48645
48681
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48646
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
48682
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
48647
48683
|
* @param {UpsertPaymentOptionsDto} upsertPaymentOptionsDto
|
|
48648
48684
|
* @param {*} [options] Override http request option.
|
|
48649
48685
|
* @throws {RequiredError}
|
|
48650
48686
|
*/
|
|
48651
|
-
configUpsertPaymentOptions(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertPaymentOptionsDto: UpsertPaymentOptionsDto, options?: any): AxiosPromise<ConfigManagementResponseDto> {
|
|
48687
|
+
configUpsertPaymentOptions(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertPaymentOptionsDto: UpsertPaymentOptionsDto, options?: any): AxiosPromise<ConfigManagementResponseDto> {
|
|
48652
48688
|
return localVarFp.configUpsertPaymentOptions(businessId, xAppX, upsertPaymentOptionsDto, options).then((request) => request(axios, basePath));
|
|
48653
48689
|
},
|
|
48654
48690
|
/**
|
|
48655
48691
|
* Only a Munchi admin\'s ticket or Munchi\'s own key may (D163); a venue\'s own login is refused before anything is read or saved. Saves the chosen provider\'s own fields (Viva as the Viva route would, Nets and Stripe as their routes would; Worldline and Nexi as Nets and Stripe, so an absent isActive saves them active here, unlike on their own routes), then selects it on the channel as the channel config route would, and answers the providers as read afterwards. The provider\'s settings and the selection are saved in one transaction: both or neither. A new Viva config without a rate is refused, as on the Viva route, when the venue has no licence or the license server cannot be read. A new Nexi config needs its username and password, the Nexi POS API login its payments start with, and is refused with 400 without them, before anything is saved; a stored one keeps them when they are left out; an empty or null one is refused with 400.
|
|
48656
48692
|
* @summary Set active provider and upsert its credentials (Munchi admins only)
|
|
48657
48693
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48658
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
48694
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
48659
48695
|
* @param {UpsertProvidersDto} upsertProvidersDto
|
|
48660
48696
|
* @param {*} [options] Override http request option.
|
|
48661
48697
|
* @throws {RequiredError}
|
|
48662
48698
|
*/
|
|
48663
|
-
configUpsertProviders(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertProvidersDto: UpsertProvidersDto, options?: any): AxiosPromise<ProvidersConfigResponseDto> {
|
|
48699
|
+
configUpsertProviders(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertProvidersDto: UpsertProvidersDto, options?: any): AxiosPromise<ProvidersConfigResponseDto> {
|
|
48664
48700
|
return localVarFp.configUpsertProviders(businessId, xAppX, upsertProvidersDto, options).then((request) => request(axios, basePath));
|
|
48665
48701
|
},
|
|
48666
48702
|
/**
|
|
48667
48703
|
* Only a Munchi admin\'s ticket or Munchi\'s own key may (D163); a venue\'s own login is refused before anything is read or saved. Creates the channel\'s config first if it has none. Saved active unless isActive is sent. The cached Stripe config is cleared.
|
|
48668
48704
|
* @summary Create or update a channel\'s Stripe config (Munchi admins only)
|
|
48669
48705
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48670
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
48706
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
48671
48707
|
* @param {UpsertStripeDto} upsertStripeDto
|
|
48672
48708
|
* @param {*} [options] Override http request option.
|
|
48673
48709
|
* @throws {RequiredError}
|
|
48674
48710
|
*/
|
|
48675
|
-
configUpsertStripe(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertStripeDto: UpsertStripeDto, options?: any): AxiosPromise<ConfigManagementResponseDto> {
|
|
48711
|
+
configUpsertStripe(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertStripeDto: UpsertStripeDto, options?: any): AxiosPromise<ConfigManagementResponseDto> {
|
|
48676
48712
|
return localVarFp.configUpsertStripe(businessId, xAppX, upsertStripeDto, options).then((request) => request(axios, basePath));
|
|
48677
48713
|
},
|
|
48678
48714
|
/**
|
|
48679
48715
|
* Only a Munchi admin\'s ticket or Munchi\'s own key may (D163); a venue\'s own login is refused before anything is read or saved. Creates the channel\'s config first if it has none. A new Viva config needs a merchantId and takes the license server\'s ISV when no rate is sent, and is refused when the venue has no licence or the license server cannot be read; a changed rate or additionalAmount is saved on the license server first.
|
|
48680
48716
|
* @summary Create or update a channel\'s Viva config (Munchi admins only)
|
|
48681
48717
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48682
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
48718
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
48683
48719
|
* @param {UpsertVivaDto} upsertVivaDto
|
|
48684
48720
|
* @param {*} [options] Override http request option.
|
|
48685
48721
|
* @throws {RequiredError}
|
|
48686
48722
|
*/
|
|
48687
|
-
configUpsertViva(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertVivaDto: UpsertVivaDto, options?: any): AxiosPromise<ConfigManagementResponseDto> {
|
|
48723
|
+
configUpsertViva(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertVivaDto: UpsertVivaDto, options?: any): AxiosPromise<ConfigManagementResponseDto> {
|
|
48688
48724
|
return localVarFp.configUpsertViva(businessId, xAppX, upsertVivaDto, options).then((request) => request(axios, basePath));
|
|
48689
48725
|
},
|
|
48690
48726
|
/**
|
|
48691
48727
|
* Only a Munchi admin\'s ticket or Munchi\'s own key may (D163); a venue\'s own login is refused before anything is read or saved. Saves Worldline\'s keys without selecting Worldline on the channel, as the Nets route does. Creates the channel\'s config first if it has none. A new Worldline config is saved active unless isActive is sent; an update without isActive keeps the stored value. A key left out keeps the stored one; an empty or null key is refused with 400. worldline-microservice keeps a terminal\'s credentials for up to its cache time, so a changed key reaches the terminal\'s next payment after that.
|
|
48692
48728
|
* @summary Create or update a channel\'s Worldline config (Munchi admins only)
|
|
48693
48729
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48694
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
48730
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
48695
48731
|
* @param {UpsertWorldlineDto} upsertWorldlineDto
|
|
48696
48732
|
* @param {*} [options] Override http request option.
|
|
48697
48733
|
* @throws {RequiredError}
|
|
48698
48734
|
*/
|
|
48699
|
-
configUpsertWorldline(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertWorldlineDto: UpsertWorldlineDto, options?: any): AxiosPromise<ConfigManagementResponseDto> {
|
|
48735
|
+
configUpsertWorldline(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertWorldlineDto: UpsertWorldlineDto, options?: any): AxiosPromise<ConfigManagementResponseDto> {
|
|
48700
48736
|
return localVarFp.configUpsertWorldline(businessId, xAppX, upsertWorldlineDto, options).then((request) => request(axios, basePath));
|
|
48701
48737
|
},
|
|
48702
48738
|
};
|
|
@@ -48712,24 +48748,24 @@ export interface ConfigManagementApiInterface {
|
|
|
48712
48748
|
* The till\'s Settings screen calls it. Creates the channel\'s config first if it has none. Turning it on also enables the MunchiGiftCard payment option.
|
|
48713
48749
|
* @summary Enable or disable first-party Munchi GiftCard integration
|
|
48714
48750
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48715
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
48751
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
48716
48752
|
* @param {ConfigureMunchiGiftCardDto} configureMunchiGiftCardDto
|
|
48717
48753
|
* @param {*} [options] Override http request option.
|
|
48718
48754
|
* @throws {RequiredError}
|
|
48719
48755
|
* @memberof ConfigManagementApiInterface
|
|
48720
48756
|
*/
|
|
48721
|
-
configConfigureMunchiGiftCard(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', configureMunchiGiftCardDto: ConfigureMunchiGiftCardDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
48757
|
+
configConfigureMunchiGiftCard(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', configureMunchiGiftCardDto: ConfigureMunchiGiftCardDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
48722
48758
|
|
|
48723
48759
|
/**
|
|
48724
48760
|
* The selected provider and each provider\'s settings. A secret key, client secret or password is answered null: it never leaves the server. Nets and Worldline answer hasSecretKey, Nets hasClientSecret, and Nexi hasPassword, saying whether one is stored; Nexi\'s username is answered, as Nets\' clientId is. The route does not check the venue itself; the global access check reads it from the path (R30).
|
|
48725
48761
|
* @summary Read a channel\'s card payment providers
|
|
48726
48762
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48727
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
48763
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
48728
48764
|
* @param {*} [options] Override http request option.
|
|
48729
48765
|
* @throws {RequiredError}
|
|
48730
48766
|
* @memberof ConfigManagementApiInterface
|
|
48731
48767
|
*/
|
|
48732
|
-
configGetProviders(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', options?: AxiosRequestConfig): AxiosPromise<ProvidersConfigResponseDto>;
|
|
48768
|
+
configGetProviders(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', options?: AxiosRequestConfig): AxiosPromise<ProvidersConfigResponseDto>;
|
|
48733
48769
|
|
|
48734
48770
|
/**
|
|
48735
48771
|
* Clears the venue\'s cache entry of each key sent and tells the apps to fetch them again: every app of the venue, or one app channel when isGlobal is false.
|
|
@@ -48747,25 +48783,25 @@ export interface ConfigManagementApiInterface {
|
|
|
48747
48783
|
* @summary Remove payment option
|
|
48748
48784
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48749
48785
|
* @param {string} id The payment option\'s id
|
|
48750
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
48786
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
48751
48787
|
* @param {*} [options] Override http request option.
|
|
48752
48788
|
* @throws {RequiredError}
|
|
48753
48789
|
* @memberof ConfigManagementApiInterface
|
|
48754
48790
|
*/
|
|
48755
|
-
configRemovePaymentOption(businessId: number, id: string, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
48791
|
+
configRemovePaymentOption(businessId: number, id: string, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
48756
48792
|
|
|
48757
48793
|
/**
|
|
48758
48794
|
* Only a Munchi admin\'s ticket or Munchi\'s own key may (D163); a venue\'s own login is refused before anything is read or saved. Creates the channel\'s config first if it has none. Saves the access key (from the X-Epassi-Access-Key header, so the request body logger never records it) and the POS name Epassi issued, and turns Epassi payments on for the channel. On the channel\'s first save the server makes a 2048-bit RSA key pair and keeps the private key encrypted; later saves keep it. The answer carries the public key, which the venue sends Epassi, and never the access key or the private key. The apps are told to fetch the config again.
|
|
48759
48795
|
* @summary Save a channel\'s Epassi credentials and answer the public key to send Epassi (Munchi admins only)
|
|
48760
48796
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48761
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
48797
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
48762
48798
|
* @param {string} xEpassiAccessKey The access key Epassi issued for this venue; Epassi issues a different one for test and production.
|
|
48763
48799
|
* @param {SaveEpassiCredentialsDto} saveEpassiCredentialsDto
|
|
48764
48800
|
* @param {*} [options] Override http request option.
|
|
48765
48801
|
* @throws {RequiredError}
|
|
48766
48802
|
* @memberof ConfigManagementApiInterface
|
|
48767
48803
|
*/
|
|
48768
|
-
configSaveEpassiCredentials(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', xEpassiAccessKey: string, saveEpassiCredentialsDto: SaveEpassiCredentialsDto, options?: AxiosRequestConfig): AxiosPromise<EpassiCredentialsSavedDto>;
|
|
48804
|
+
configSaveEpassiCredentials(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', xEpassiAccessKey: string, saveEpassiCredentialsDto: SaveEpassiCredentialsDto, options?: AxiosRequestConfig): AxiosPromise<EpassiCredentialsSavedDto>;
|
|
48769
48805
|
|
|
48770
48806
|
/**
|
|
48771
48807
|
* A new venue is saved enabled, named `Business <businessId>`, in Europe/Helsinki unless the body says otherwise, and the license server is asked for its license on every save, which leaves a venue it has a license for as it is: a venue whose license was missed when it was created gets it here. The fields below are written as sent; any other field is dropped and its name logged.
|
|
@@ -48782,25 +48818,25 @@ export interface ConfigManagementApiInterface {
|
|
|
48782
48818
|
* A new config is saved in Europe/Helsinki unless the body says otherwise. The fields below are written as sent; any other field is dropped and its name logged. A venue with no merchant switched to Team or PIN lock gets its own merchant, named after it, in the same transaction. The venue\'s cached config and POS session are cleared.
|
|
48783
48819
|
* @summary Create or update a channel\'s config
|
|
48784
48820
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48785
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
48821
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
48786
48822
|
* @param {UpsertConfigDto} upsertConfigDto
|
|
48787
48823
|
* @param {*} [options] Override http request option.
|
|
48788
48824
|
* @throws {RequiredError}
|
|
48789
48825
|
* @memberof ConfigManagementApiInterface
|
|
48790
48826
|
*/
|
|
48791
|
-
configUpsertChannelConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertConfigDto: UpsertConfigDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
48827
|
+
configUpsertChannelConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertConfigDto: UpsertConfigDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
48792
48828
|
|
|
48793
48829
|
/**
|
|
48794
48830
|
* Creates the channel\'s config first if it has none. Links and credentials are merged over the stored ones; the GiftCard payment option is created after the last option, or switched with the integration.
|
|
48795
48831
|
* @summary Create or update a channel\'s third-party gift card integration
|
|
48796
48832
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48797
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
48833
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
48798
48834
|
* @param {UpsertGiftCardDto} upsertGiftCardDto
|
|
48799
48835
|
* @param {*} [options] Override http request option.
|
|
48800
48836
|
* @throws {RequiredError}
|
|
48801
48837
|
* @memberof ConfigManagementApiInterface
|
|
48802
48838
|
*/
|
|
48803
|
-
configUpsertGiftCard(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertGiftCardDto: UpsertGiftCardDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
48839
|
+
configUpsertGiftCard(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertGiftCardDto: UpsertGiftCardDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
48804
48840
|
|
|
48805
48841
|
/**
|
|
48806
48842
|
* The secret is stored encrypted and never answered: secretKey is null in the answer. A new program needs name, apiBaseUrl and secretKey; apiBaseUrl must be https on the Munchi loyalty server\'s host. A signed-in ticket may write only a programme that serves no venue off its account; the programme and the venue\'s link are written together. The venue\'s cached config and loyalty settings are cleared.
|
|
@@ -48817,85 +48853,85 @@ export interface ConfigManagementApiInterface {
|
|
|
48817
48853
|
* Only a Munchi admin\'s ticket or Munchi\'s own key may (D163); a venue\'s own login is refused before anything is read or saved. Creates the channel\'s config first if it has none. Saved active unless isActive is sent. The cached Nets config and token are cleared.
|
|
48818
48854
|
* @summary Create or update a channel\'s Nets config (Munchi admins only)
|
|
48819
48855
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48820
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
48856
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
48821
48857
|
* @param {UpsertNetsDto} upsertNetsDto
|
|
48822
48858
|
* @param {*} [options] Override http request option.
|
|
48823
48859
|
* @throws {RequiredError}
|
|
48824
48860
|
* @memberof ConfigManagementApiInterface
|
|
48825
48861
|
*/
|
|
48826
|
-
configUpsertNets(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertNetsDto: UpsertNetsDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
48862
|
+
configUpsertNets(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertNetsDto: UpsertNetsDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
48827
48863
|
|
|
48828
48864
|
/**
|
|
48829
48865
|
* Only a Munchi admin\'s ticket or Munchi\'s own key may (D163); a venue\'s own login is refused before anything is read or saved. Saves the Nexi POS API login (username and password, basic auth) without selecting Nexi on the channel, as the Worldline route does; POST …/providers selects it. A new Nexi config needs its username and password and is refused with 400 without them, before anything is saved, the channel\'s config included; otherwise the channel\'s config is created first if it has none. A new Nexi config is saved active unless isActive is sent; an update without isActive keeps the stored value. A field left out keeps the stored one; an empty or null username or password is refused with 400. The answer never carries the password: hasPassword says whether one is stored.
|
|
48830
48866
|
* @summary Create or update a channel\'s Nexi config (Munchi admins only)
|
|
48831
48867
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48832
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
48868
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
48833
48869
|
* @param {UpsertNexiDto} upsertNexiDto
|
|
48834
48870
|
* @param {*} [options] Override http request option.
|
|
48835
48871
|
* @throws {RequiredError}
|
|
48836
48872
|
* @memberof ConfigManagementApiInterface
|
|
48837
48873
|
*/
|
|
48838
|
-
configUpsertNexi(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertNexiDto: UpsertNexiDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
48874
|
+
configUpsertNexi(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertNexiDto: UpsertNexiDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
48839
48875
|
|
|
48840
48876
|
/**
|
|
48841
48877
|
* Creates the channel\'s config first if it has none. Each option sent is created or updated by its method; the others are left as they are.
|
|
48842
48878
|
* @summary Create or update a channel\'s checkout payment options
|
|
48843
48879
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48844
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
48880
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
48845
48881
|
* @param {UpsertPaymentOptionsDto} upsertPaymentOptionsDto
|
|
48846
48882
|
* @param {*} [options] Override http request option.
|
|
48847
48883
|
* @throws {RequiredError}
|
|
48848
48884
|
* @memberof ConfigManagementApiInterface
|
|
48849
48885
|
*/
|
|
48850
|
-
configUpsertPaymentOptions(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertPaymentOptionsDto: UpsertPaymentOptionsDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
48886
|
+
configUpsertPaymentOptions(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertPaymentOptionsDto: UpsertPaymentOptionsDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
48851
48887
|
|
|
48852
48888
|
/**
|
|
48853
48889
|
* Only a Munchi admin\'s ticket or Munchi\'s own key may (D163); a venue\'s own login is refused before anything is read or saved. Saves the chosen provider\'s own fields (Viva as the Viva route would, Nets and Stripe as their routes would; Worldline and Nexi as Nets and Stripe, so an absent isActive saves them active here, unlike on their own routes), then selects it on the channel as the channel config route would, and answers the providers as read afterwards. The provider\'s settings and the selection are saved in one transaction: both or neither. A new Viva config without a rate is refused, as on the Viva route, when the venue has no licence or the license server cannot be read. A new Nexi config needs its username and password, the Nexi POS API login its payments start with, and is refused with 400 without them, before anything is saved; a stored one keeps them when they are left out; an empty or null one is refused with 400.
|
|
48854
48890
|
* @summary Set active provider and upsert its credentials (Munchi admins only)
|
|
48855
48891
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48856
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
48892
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
48857
48893
|
* @param {UpsertProvidersDto} upsertProvidersDto
|
|
48858
48894
|
* @param {*} [options] Override http request option.
|
|
48859
48895
|
* @throws {RequiredError}
|
|
48860
48896
|
* @memberof ConfigManagementApiInterface
|
|
48861
48897
|
*/
|
|
48862
|
-
configUpsertProviders(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertProvidersDto: UpsertProvidersDto, options?: AxiosRequestConfig): AxiosPromise<ProvidersConfigResponseDto>;
|
|
48898
|
+
configUpsertProviders(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertProvidersDto: UpsertProvidersDto, options?: AxiosRequestConfig): AxiosPromise<ProvidersConfigResponseDto>;
|
|
48863
48899
|
|
|
48864
48900
|
/**
|
|
48865
48901
|
* Only a Munchi admin\'s ticket or Munchi\'s own key may (D163); a venue\'s own login is refused before anything is read or saved. Creates the channel\'s config first if it has none. Saved active unless isActive is sent. The cached Stripe config is cleared.
|
|
48866
48902
|
* @summary Create or update a channel\'s Stripe config (Munchi admins only)
|
|
48867
48903
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48868
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
48904
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
48869
48905
|
* @param {UpsertStripeDto} upsertStripeDto
|
|
48870
48906
|
* @param {*} [options] Override http request option.
|
|
48871
48907
|
* @throws {RequiredError}
|
|
48872
48908
|
* @memberof ConfigManagementApiInterface
|
|
48873
48909
|
*/
|
|
48874
|
-
configUpsertStripe(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertStripeDto: UpsertStripeDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
48910
|
+
configUpsertStripe(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertStripeDto: UpsertStripeDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
48875
48911
|
|
|
48876
48912
|
/**
|
|
48877
48913
|
* Only a Munchi admin\'s ticket or Munchi\'s own key may (D163); a venue\'s own login is refused before anything is read or saved. Creates the channel\'s config first if it has none. A new Viva config needs a merchantId and takes the license server\'s ISV when no rate is sent, and is refused when the venue has no licence or the license server cannot be read; a changed rate or additionalAmount is saved on the license server first.
|
|
48878
48914
|
* @summary Create or update a channel\'s Viva config (Munchi admins only)
|
|
48879
48915
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48880
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
48916
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
48881
48917
|
* @param {UpsertVivaDto} upsertVivaDto
|
|
48882
48918
|
* @param {*} [options] Override http request option.
|
|
48883
48919
|
* @throws {RequiredError}
|
|
48884
48920
|
* @memberof ConfigManagementApiInterface
|
|
48885
48921
|
*/
|
|
48886
|
-
configUpsertViva(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertVivaDto: UpsertVivaDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
48922
|
+
configUpsertViva(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertVivaDto: UpsertVivaDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
48887
48923
|
|
|
48888
48924
|
/**
|
|
48889
48925
|
* Only a Munchi admin\'s ticket or Munchi\'s own key may (D163); a venue\'s own login is refused before anything is read or saved. Saves Worldline\'s keys without selecting Worldline on the channel, as the Nets route does. Creates the channel\'s config first if it has none. A new Worldline config is saved active unless isActive is sent; an update without isActive keeps the stored value. A key left out keeps the stored one; an empty or null key is refused with 400. worldline-microservice keeps a terminal\'s credentials for up to its cache time, so a changed key reaches the terminal\'s next payment after that.
|
|
48890
48926
|
* @summary Create or update a channel\'s Worldline config (Munchi admins only)
|
|
48891
48927
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48892
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
48928
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
48893
48929
|
* @param {UpsertWorldlineDto} upsertWorldlineDto
|
|
48894
48930
|
* @param {*} [options] Override http request option.
|
|
48895
48931
|
* @throws {RequiredError}
|
|
48896
48932
|
* @memberof ConfigManagementApiInterface
|
|
48897
48933
|
*/
|
|
48898
|
-
configUpsertWorldline(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertWorldlineDto: UpsertWorldlineDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
48934
|
+
configUpsertWorldline(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertWorldlineDto: UpsertWorldlineDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
48899
48935
|
|
|
48900
48936
|
}
|
|
48901
48937
|
|
|
@@ -48910,13 +48946,13 @@ export class ConfigManagementApi extends BaseAPI implements ConfigManagementApiI
|
|
|
48910
48946
|
* The till\'s Settings screen calls it. Creates the channel\'s config first if it has none. Turning it on also enables the MunchiGiftCard payment option.
|
|
48911
48947
|
* @summary Enable or disable first-party Munchi GiftCard integration
|
|
48912
48948
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48913
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
48949
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
48914
48950
|
* @param {ConfigureMunchiGiftCardDto} configureMunchiGiftCardDto
|
|
48915
48951
|
* @param {*} [options] Override http request option.
|
|
48916
48952
|
* @throws {RequiredError}
|
|
48917
48953
|
* @memberof ConfigManagementApi
|
|
48918
48954
|
*/
|
|
48919
|
-
public configConfigureMunchiGiftCard(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', configureMunchiGiftCardDto: ConfigureMunchiGiftCardDto, options?: AxiosRequestConfig) {
|
|
48955
|
+
public configConfigureMunchiGiftCard(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', configureMunchiGiftCardDto: ConfigureMunchiGiftCardDto, options?: AxiosRequestConfig) {
|
|
48920
48956
|
return ConfigManagementApiFp(this.configuration).configConfigureMunchiGiftCard(businessId, xAppX, configureMunchiGiftCardDto, options).then((request) => request(this.axios, this.basePath));
|
|
48921
48957
|
}
|
|
48922
48958
|
|
|
@@ -48924,12 +48960,12 @@ export class ConfigManagementApi extends BaseAPI implements ConfigManagementApiI
|
|
|
48924
48960
|
* The selected provider and each provider\'s settings. A secret key, client secret or password is answered null: it never leaves the server. Nets and Worldline answer hasSecretKey, Nets hasClientSecret, and Nexi hasPassword, saying whether one is stored; Nexi\'s username is answered, as Nets\' clientId is. The route does not check the venue itself; the global access check reads it from the path (R30).
|
|
48925
48961
|
* @summary Read a channel\'s card payment providers
|
|
48926
48962
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48927
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
48963
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
48928
48964
|
* @param {*} [options] Override http request option.
|
|
48929
48965
|
* @throws {RequiredError}
|
|
48930
48966
|
* @memberof ConfigManagementApi
|
|
48931
48967
|
*/
|
|
48932
|
-
public configGetProviders(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', options?: AxiosRequestConfig) {
|
|
48968
|
+
public configGetProviders(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', options?: AxiosRequestConfig) {
|
|
48933
48969
|
return ConfigManagementApiFp(this.configuration).configGetProviders(businessId, xAppX, options).then((request) => request(this.axios, this.basePath));
|
|
48934
48970
|
}
|
|
48935
48971
|
|
|
@@ -48951,12 +48987,12 @@ export class ConfigManagementApi extends BaseAPI implements ConfigManagementApiI
|
|
|
48951
48987
|
* @summary Remove payment option
|
|
48952
48988
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48953
48989
|
* @param {string} id The payment option\'s id
|
|
48954
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
48990
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
48955
48991
|
* @param {*} [options] Override http request option.
|
|
48956
48992
|
* @throws {RequiredError}
|
|
48957
48993
|
* @memberof ConfigManagementApi
|
|
48958
48994
|
*/
|
|
48959
|
-
public configRemovePaymentOption(businessId: number, id: string, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', options?: AxiosRequestConfig) {
|
|
48995
|
+
public configRemovePaymentOption(businessId: number, id: string, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', options?: AxiosRequestConfig) {
|
|
48960
48996
|
return ConfigManagementApiFp(this.configuration).configRemovePaymentOption(businessId, id, xAppX, options).then((request) => request(this.axios, this.basePath));
|
|
48961
48997
|
}
|
|
48962
48998
|
|
|
@@ -48964,14 +49000,14 @@ export class ConfigManagementApi extends BaseAPI implements ConfigManagementApiI
|
|
|
48964
49000
|
* Only a Munchi admin\'s ticket or Munchi\'s own key may (D163); a venue\'s own login is refused before anything is read or saved. Creates the channel\'s config first if it has none. Saves the access key (from the X-Epassi-Access-Key header, so the request body logger never records it) and the POS name Epassi issued, and turns Epassi payments on for the channel. On the channel\'s first save the server makes a 2048-bit RSA key pair and keeps the private key encrypted; later saves keep it. The answer carries the public key, which the venue sends Epassi, and never the access key or the private key. The apps are told to fetch the config again.
|
|
48965
49001
|
* @summary Save a channel\'s Epassi credentials and answer the public key to send Epassi (Munchi admins only)
|
|
48966
49002
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48967
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
49003
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
48968
49004
|
* @param {string} xEpassiAccessKey The access key Epassi issued for this venue; Epassi issues a different one for test and production.
|
|
48969
49005
|
* @param {SaveEpassiCredentialsDto} saveEpassiCredentialsDto
|
|
48970
49006
|
* @param {*} [options] Override http request option.
|
|
48971
49007
|
* @throws {RequiredError}
|
|
48972
49008
|
* @memberof ConfigManagementApi
|
|
48973
49009
|
*/
|
|
48974
|
-
public configSaveEpassiCredentials(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', xEpassiAccessKey: string, saveEpassiCredentialsDto: SaveEpassiCredentialsDto, options?: AxiosRequestConfig) {
|
|
49010
|
+
public configSaveEpassiCredentials(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', xEpassiAccessKey: string, saveEpassiCredentialsDto: SaveEpassiCredentialsDto, options?: AxiosRequestConfig) {
|
|
48975
49011
|
return ConfigManagementApiFp(this.configuration).configSaveEpassiCredentials(businessId, xAppX, xEpassiAccessKey, saveEpassiCredentialsDto, options).then((request) => request(this.axios, this.basePath));
|
|
48976
49012
|
}
|
|
48977
49013
|
|
|
@@ -48992,13 +49028,13 @@ export class ConfigManagementApi extends BaseAPI implements ConfigManagementApiI
|
|
|
48992
49028
|
* A new config is saved in Europe/Helsinki unless the body says otherwise. The fields below are written as sent; any other field is dropped and its name logged. A venue with no merchant switched to Team or PIN lock gets its own merchant, named after it, in the same transaction. The venue\'s cached config and POS session are cleared.
|
|
48993
49029
|
* @summary Create or update a channel\'s config
|
|
48994
49030
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48995
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
49031
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
48996
49032
|
* @param {UpsertConfigDto} upsertConfigDto
|
|
48997
49033
|
* @param {*} [options] Override http request option.
|
|
48998
49034
|
* @throws {RequiredError}
|
|
48999
49035
|
* @memberof ConfigManagementApi
|
|
49000
49036
|
*/
|
|
49001
|
-
public configUpsertChannelConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertConfigDto: UpsertConfigDto, options?: AxiosRequestConfig) {
|
|
49037
|
+
public configUpsertChannelConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertConfigDto: UpsertConfigDto, options?: AxiosRequestConfig) {
|
|
49002
49038
|
return ConfigManagementApiFp(this.configuration).configUpsertChannelConfig(businessId, xAppX, upsertConfigDto, options).then((request) => request(this.axios, this.basePath));
|
|
49003
49039
|
}
|
|
49004
49040
|
|
|
@@ -49006,13 +49042,13 @@ export class ConfigManagementApi extends BaseAPI implements ConfigManagementApiI
|
|
|
49006
49042
|
* Creates the channel\'s config first if it has none. Links and credentials are merged over the stored ones; the GiftCard payment option is created after the last option, or switched with the integration.
|
|
49007
49043
|
* @summary Create or update a channel\'s third-party gift card integration
|
|
49008
49044
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
49009
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
49045
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
49010
49046
|
* @param {UpsertGiftCardDto} upsertGiftCardDto
|
|
49011
49047
|
* @param {*} [options] Override http request option.
|
|
49012
49048
|
* @throws {RequiredError}
|
|
49013
49049
|
* @memberof ConfigManagementApi
|
|
49014
49050
|
*/
|
|
49015
|
-
public configUpsertGiftCard(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertGiftCardDto: UpsertGiftCardDto, options?: AxiosRequestConfig) {
|
|
49051
|
+
public configUpsertGiftCard(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertGiftCardDto: UpsertGiftCardDto, options?: AxiosRequestConfig) {
|
|
49016
49052
|
return ConfigManagementApiFp(this.configuration).configUpsertGiftCard(businessId, xAppX, upsertGiftCardDto, options).then((request) => request(this.axios, this.basePath));
|
|
49017
49053
|
}
|
|
49018
49054
|
|
|
@@ -49033,13 +49069,13 @@ export class ConfigManagementApi extends BaseAPI implements ConfigManagementApiI
|
|
|
49033
49069
|
* Only a Munchi admin\'s ticket or Munchi\'s own key may (D163); a venue\'s own login is refused before anything is read or saved. Creates the channel\'s config first if it has none. Saved active unless isActive is sent. The cached Nets config and token are cleared.
|
|
49034
49070
|
* @summary Create or update a channel\'s Nets config (Munchi admins only)
|
|
49035
49071
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
49036
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
49072
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
49037
49073
|
* @param {UpsertNetsDto} upsertNetsDto
|
|
49038
49074
|
* @param {*} [options] Override http request option.
|
|
49039
49075
|
* @throws {RequiredError}
|
|
49040
49076
|
* @memberof ConfigManagementApi
|
|
49041
49077
|
*/
|
|
49042
|
-
public configUpsertNets(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertNetsDto: UpsertNetsDto, options?: AxiosRequestConfig) {
|
|
49078
|
+
public configUpsertNets(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertNetsDto: UpsertNetsDto, options?: AxiosRequestConfig) {
|
|
49043
49079
|
return ConfigManagementApiFp(this.configuration).configUpsertNets(businessId, xAppX, upsertNetsDto, options).then((request) => request(this.axios, this.basePath));
|
|
49044
49080
|
}
|
|
49045
49081
|
|
|
@@ -49047,13 +49083,13 @@ export class ConfigManagementApi extends BaseAPI implements ConfigManagementApiI
|
|
|
49047
49083
|
* Only a Munchi admin\'s ticket or Munchi\'s own key may (D163); a venue\'s own login is refused before anything is read or saved. Saves the Nexi POS API login (username and password, basic auth) without selecting Nexi on the channel, as the Worldline route does; POST …/providers selects it. A new Nexi config needs its username and password and is refused with 400 without them, before anything is saved, the channel\'s config included; otherwise the channel\'s config is created first if it has none. A new Nexi config is saved active unless isActive is sent; an update without isActive keeps the stored value. A field left out keeps the stored one; an empty or null username or password is refused with 400. The answer never carries the password: hasPassword says whether one is stored.
|
|
49048
49084
|
* @summary Create or update a channel\'s Nexi config (Munchi admins only)
|
|
49049
49085
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
49050
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
49086
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
49051
49087
|
* @param {UpsertNexiDto} upsertNexiDto
|
|
49052
49088
|
* @param {*} [options] Override http request option.
|
|
49053
49089
|
* @throws {RequiredError}
|
|
49054
49090
|
* @memberof ConfigManagementApi
|
|
49055
49091
|
*/
|
|
49056
|
-
public configUpsertNexi(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertNexiDto: UpsertNexiDto, options?: AxiosRequestConfig) {
|
|
49092
|
+
public configUpsertNexi(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertNexiDto: UpsertNexiDto, options?: AxiosRequestConfig) {
|
|
49057
49093
|
return ConfigManagementApiFp(this.configuration).configUpsertNexi(businessId, xAppX, upsertNexiDto, options).then((request) => request(this.axios, this.basePath));
|
|
49058
49094
|
}
|
|
49059
49095
|
|
|
@@ -49061,13 +49097,13 @@ export class ConfigManagementApi extends BaseAPI implements ConfigManagementApiI
|
|
|
49061
49097
|
* Creates the channel\'s config first if it has none. Each option sent is created or updated by its method; the others are left as they are.
|
|
49062
49098
|
* @summary Create or update a channel\'s checkout payment options
|
|
49063
49099
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
49064
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
49100
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
49065
49101
|
* @param {UpsertPaymentOptionsDto} upsertPaymentOptionsDto
|
|
49066
49102
|
* @param {*} [options] Override http request option.
|
|
49067
49103
|
* @throws {RequiredError}
|
|
49068
49104
|
* @memberof ConfigManagementApi
|
|
49069
49105
|
*/
|
|
49070
|
-
public configUpsertPaymentOptions(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertPaymentOptionsDto: UpsertPaymentOptionsDto, options?: AxiosRequestConfig) {
|
|
49106
|
+
public configUpsertPaymentOptions(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertPaymentOptionsDto: UpsertPaymentOptionsDto, options?: AxiosRequestConfig) {
|
|
49071
49107
|
return ConfigManagementApiFp(this.configuration).configUpsertPaymentOptions(businessId, xAppX, upsertPaymentOptionsDto, options).then((request) => request(this.axios, this.basePath));
|
|
49072
49108
|
}
|
|
49073
49109
|
|
|
@@ -49075,13 +49111,13 @@ export class ConfigManagementApi extends BaseAPI implements ConfigManagementApiI
|
|
|
49075
49111
|
* Only a Munchi admin\'s ticket or Munchi\'s own key may (D163); a venue\'s own login is refused before anything is read or saved. Saves the chosen provider\'s own fields (Viva as the Viva route would, Nets and Stripe as their routes would; Worldline and Nexi as Nets and Stripe, so an absent isActive saves them active here, unlike on their own routes), then selects it on the channel as the channel config route would, and answers the providers as read afterwards. The provider\'s settings and the selection are saved in one transaction: both or neither. A new Viva config without a rate is refused, as on the Viva route, when the venue has no licence or the license server cannot be read. A new Nexi config needs its username and password, the Nexi POS API login its payments start with, and is refused with 400 without them, before anything is saved; a stored one keeps them when they are left out; an empty or null one is refused with 400.
|
|
49076
49112
|
* @summary Set active provider and upsert its credentials (Munchi admins only)
|
|
49077
49113
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
49078
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
49114
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
49079
49115
|
* @param {UpsertProvidersDto} upsertProvidersDto
|
|
49080
49116
|
* @param {*} [options] Override http request option.
|
|
49081
49117
|
* @throws {RequiredError}
|
|
49082
49118
|
* @memberof ConfigManagementApi
|
|
49083
49119
|
*/
|
|
49084
|
-
public configUpsertProviders(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertProvidersDto: UpsertProvidersDto, options?: AxiosRequestConfig) {
|
|
49120
|
+
public configUpsertProviders(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertProvidersDto: UpsertProvidersDto, options?: AxiosRequestConfig) {
|
|
49085
49121
|
return ConfigManagementApiFp(this.configuration).configUpsertProviders(businessId, xAppX, upsertProvidersDto, options).then((request) => request(this.axios, this.basePath));
|
|
49086
49122
|
}
|
|
49087
49123
|
|
|
@@ -49089,13 +49125,13 @@ export class ConfigManagementApi extends BaseAPI implements ConfigManagementApiI
|
|
|
49089
49125
|
* Only a Munchi admin\'s ticket or Munchi\'s own key may (D163); a venue\'s own login is refused before anything is read or saved. Creates the channel\'s config first if it has none. Saved active unless isActive is sent. The cached Stripe config is cleared.
|
|
49090
49126
|
* @summary Create or update a channel\'s Stripe config (Munchi admins only)
|
|
49091
49127
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
49092
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
49128
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
49093
49129
|
* @param {UpsertStripeDto} upsertStripeDto
|
|
49094
49130
|
* @param {*} [options] Override http request option.
|
|
49095
49131
|
* @throws {RequiredError}
|
|
49096
49132
|
* @memberof ConfigManagementApi
|
|
49097
49133
|
*/
|
|
49098
|
-
public configUpsertStripe(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertStripeDto: UpsertStripeDto, options?: AxiosRequestConfig) {
|
|
49134
|
+
public configUpsertStripe(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertStripeDto: UpsertStripeDto, options?: AxiosRequestConfig) {
|
|
49099
49135
|
return ConfigManagementApiFp(this.configuration).configUpsertStripe(businessId, xAppX, upsertStripeDto, options).then((request) => request(this.axios, this.basePath));
|
|
49100
49136
|
}
|
|
49101
49137
|
|
|
@@ -49103,13 +49139,13 @@ export class ConfigManagementApi extends BaseAPI implements ConfigManagementApiI
|
|
|
49103
49139
|
* Only a Munchi admin\'s ticket or Munchi\'s own key may (D163); a venue\'s own login is refused before anything is read or saved. Creates the channel\'s config first if it has none. A new Viva config needs a merchantId and takes the license server\'s ISV when no rate is sent, and is refused when the venue has no licence or the license server cannot be read; a changed rate or additionalAmount is saved on the license server first.
|
|
49104
49140
|
* @summary Create or update a channel\'s Viva config (Munchi admins only)
|
|
49105
49141
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
49106
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
49142
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
49107
49143
|
* @param {UpsertVivaDto} upsertVivaDto
|
|
49108
49144
|
* @param {*} [options] Override http request option.
|
|
49109
49145
|
* @throws {RequiredError}
|
|
49110
49146
|
* @memberof ConfigManagementApi
|
|
49111
49147
|
*/
|
|
49112
|
-
public configUpsertViva(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertVivaDto: UpsertVivaDto, options?: AxiosRequestConfig) {
|
|
49148
|
+
public configUpsertViva(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertVivaDto: UpsertVivaDto, options?: AxiosRequestConfig) {
|
|
49113
49149
|
return ConfigManagementApiFp(this.configuration).configUpsertViva(businessId, xAppX, upsertVivaDto, options).then((request) => request(this.axios, this.basePath));
|
|
49114
49150
|
}
|
|
49115
49151
|
|
|
@@ -49117,13 +49153,13 @@ export class ConfigManagementApi extends BaseAPI implements ConfigManagementApiI
|
|
|
49117
49153
|
* Only a Munchi admin\'s ticket or Munchi\'s own key may (D163); a venue\'s own login is refused before anything is read or saved. Saves Worldline\'s keys without selecting Worldline on the channel, as the Nets route does. Creates the channel\'s config first if it has none. A new Worldline config is saved active unless isActive is sent; an update without isActive keeps the stored value. A key left out keeps the stored one; an empty or null key is refused with 400. worldline-microservice keeps a terminal\'s credentials for up to its cache time, so a changed key reaches the terminal\'s next payment after that.
|
|
49118
49154
|
* @summary Create or update a channel\'s Worldline config (Munchi admins only)
|
|
49119
49155
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
49120
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
49156
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose config is read or written
|
|
49121
49157
|
* @param {UpsertWorldlineDto} upsertWorldlineDto
|
|
49122
49158
|
* @param {*} [options] Override http request option.
|
|
49123
49159
|
* @throws {RequiredError}
|
|
49124
49160
|
* @memberof ConfigManagementApi
|
|
49125
49161
|
*/
|
|
49126
|
-
public configUpsertWorldline(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertWorldlineDto: UpsertWorldlineDto, options?: AxiosRequestConfig) {
|
|
49162
|
+
public configUpsertWorldline(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertWorldlineDto: UpsertWorldlineDto, options?: AxiosRequestConfig) {
|
|
49127
49163
|
return ConfigManagementApiFp(this.configuration).configUpsertWorldline(businessId, xAppX, upsertWorldlineDto, options).then((request) => request(this.axios, this.basePath));
|
|
49128
49164
|
}
|
|
49129
49165
|
}
|
|
@@ -64303,7 +64339,7 @@ export class PaymentMethodsApi extends BaseAPI implements PaymentMethodsApiInter
|
|
|
64303
64339
|
export const PaymentSessionApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
64304
64340
|
return {
|
|
64305
64341
|
/**
|
|
64306
|
-
* Arms cancelRequestedAt + aborts at the gateway (Viva session abort / Nets terminal cancelAction, dispatched on the session\'s provider). Does not flip status — the webhook/sweep resolves the real outcome; a late success parks at VOID_PENDING with a dev alert. Card sessions only.
|
|
64342
|
+
* Arms cancelRequestedAt + aborts at the gateway (Viva session abort / Nets terminal cancelAction, dispatched on the session\'s provider). Does not flip status — the webhook/sweep resolves the real outcome; a late success parks at VOID_PENDING with a dev alert. Card sessions only. A Nexi sale is cancelled as Nexi documents it: confirmed as failed (ABORTED) at Nexi, from any unfinished state; its outcome is still Nexi\'s, read by the wait rounds, which send the cancel again until Nexi takes it. A Nexi sale whose paid answer the server already claimed is not cancelled: it ends paid.
|
|
64307
64343
|
* @summary Cancel an in-flight card payment session (Viva or Nets)
|
|
64308
64344
|
* @param {string} clientToken The token the initiate answered for the session.
|
|
64309
64345
|
* @param {*} [options] Override http request option.
|
|
@@ -64590,7 +64626,7 @@ export const PaymentSessionApiAxiosParamCreator = function (configuration?: Conf
|
|
|
64590
64626
|
};
|
|
64591
64627
|
},
|
|
64592
64628
|
/**
|
|
64593
|
-
* Saves the session first, its sessionId being the sale\'s external_id at Nexi, then asks Nexi to start the sale and answer at once. The customer then taps on the terminal; Cloud Tasks ask Nexi until the sale ends. When Nexi answers paid, in this order: Nexi\'s answer is kept on the session (the status unchanged), Nexi is confirmed (which takes the money), the session is stored SUCCESS, the payment is written on the order (reconciliation, which announces the settled order on the venue\'s channel), and only then SUCCESS is announced on the session\'s channel. So nothing tells the till \'paid\' before the money is taken. If the order cannot take the payment, it is asked again for up to 5 minutes, then the charge goes to the till as its own order and a person is alerted. Follow the session on the Ably channel nexi.<channel>.requests.<sessionId> (event payment:status-changed) or with GET /payment-session/:clientToken, which shows SUCCESS from the moment Nexi took the money. A tip or surcharge typed on the terminal is recorded from Nexi\'s answer.
|
|
64629
|
+
* Saves the session first, its sessionId being the sale\'s external_id at Nexi, then asks Nexi to start the sale and answer at once. The customer then taps on the terminal; Cloud Tasks ask Nexi until the sale ends. When Nexi answers paid, in this order: Nexi\'s answer is kept on the session (the status unchanged), Nexi is confirmed (which takes the money), the session is stored SUCCESS, the payment is written on the order (reconciliation, which announces the settled order on the venue\'s channel), and only then SUCCESS is announced on the session\'s channel. So nothing tells the till \'paid\' before the money is taken. If the order cannot take the payment, it is asked again for up to 5 minutes, then the charge goes to the till as its own order and a person is alerted. Follow the session on the Ably channel nexi.<channel>.requests.<sessionId> (event payment:status-changed) or with GET /payment-session/:clientToken, which shows SUCCESS from the moment Nexi took the money. A tip or surcharge typed on the terminal is recorded from Nexi\'s answer. POST /payment-session/:clientToken/cancel cancels it as Nexi documents it, a confirm as failed; the outcome is still Nexi\'s answer, so a sale Nexi was already confirmed paid for ends paid. Idempotent by the X-Idempotency-Key header within the venue: a repeat answers the session it started without asking Nexi again. A signed-in ticket only: the service key is not accepted (R27).
|
|
64594
64630
|
* @summary Start a card payment on the station\'s Nexi terminal
|
|
64595
64631
|
* @param {InitiateNexiSessionDto} initiateNexiSessionDto
|
|
64596
64632
|
* @param {string} [xIdempotencyKey] A UUID the app makes for this payment. A repeated key answers the session it started, without charging again.
|
|
@@ -65104,6 +65140,47 @@ export const PaymentSessionApiAxiosParamCreator = function (configuration?: Conf
|
|
|
65104
65140
|
|
|
65105
65141
|
|
|
65106
65142
|
|
|
65143
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
65144
|
+
|
|
65145
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
65146
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
65147
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
65148
|
+
localVarRequestOptions.data = serializeDataIfNeeded(reverseSessionDto, localVarRequestOptions, configuration)
|
|
65149
|
+
|
|
65150
|
+
return {
|
|
65151
|
+
url: toPathString(localVarUrlObj),
|
|
65152
|
+
options: localVarRequestOptions,
|
|
65153
|
+
};
|
|
65154
|
+
},
|
|
65155
|
+
/**
|
|
65156
|
+
* Stores a refund session for the amount asked (what is left of the sale when none is), within what is left of the sale, then asks Nexi for a customer-not-present refund of the sale on the sale\'s own terminal: the customer needs no card and the terminal shows nothing. Nexi\'s answer decides: Nexi made it → our confirm, then REFUNDED; Nexi ended it unpaid → FAILED and refused; Nexi still processing → the session waits and Cloud Tasks follow it until Nexi answers. Does NOT write a reversal onto the order: the refund plan records it, as for Viva and Nets. Idempotent by the X-Idempotency-Key header within the venue: a repeat answers the refund it started, as it stands, without asking Nexi again. A signed-in ticket only. Every refusal answers the shared error body: `name` is a stable code the till maps to its own words, `detail` the waiter\'s words when it has none.
|
|
65157
|
+
* @summary Refund a paid Nexi sale, customer not present, with no card
|
|
65158
|
+
* @param {ReverseSessionDto} reverseSessionDto
|
|
65159
|
+
* @param {string} [xIdempotencyKey] A UUID the app makes for this refund. A repeated key answers the refund it started, without refunding again.
|
|
65160
|
+
* @param {*} [options] Override http request option.
|
|
65161
|
+
* @throws {RequiredError}
|
|
65162
|
+
*/
|
|
65163
|
+
refundNexiSession: async (reverseSessionDto: ReverseSessionDto, xIdempotencyKey?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
65164
|
+
// verify required parameter 'reverseSessionDto' is not null or undefined
|
|
65165
|
+
assertParamExists('refundNexiSession', 'reverseSessionDto', reverseSessionDto)
|
|
65166
|
+
const localVarPath = `/api/v1/payment-session/nexi/refund`;
|
|
65167
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
65168
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
65169
|
+
let baseOptions;
|
|
65170
|
+
if (configuration) {
|
|
65171
|
+
baseOptions = configuration.baseOptions;
|
|
65172
|
+
}
|
|
65173
|
+
|
|
65174
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
65175
|
+
const localVarHeaderParameter = {} as any;
|
|
65176
|
+
const localVarQueryParameter = {} as any;
|
|
65177
|
+
|
|
65178
|
+
if (xIdempotencyKey != null) {
|
|
65179
|
+
localVarHeaderParameter['X-Idempotency-Key'] = String(xIdempotencyKey);
|
|
65180
|
+
}
|
|
65181
|
+
|
|
65182
|
+
|
|
65183
|
+
|
|
65107
65184
|
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
65108
65185
|
|
|
65109
65186
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -65284,6 +65361,42 @@ export const PaymentSessionApiAxiosParamCreator = function (configuration?: Conf
|
|
|
65284
65361
|
|
|
65285
65362
|
|
|
65286
65363
|
|
|
65364
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
65365
|
+
|
|
65366
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
65367
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
65368
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
65369
|
+
localVarRequestOptions.data = serializeDataIfNeeded(reverseSessionDto, localVarRequestOptions, configuration)
|
|
65370
|
+
|
|
65371
|
+
return {
|
|
65372
|
+
url: toPathString(localVarUrlObj),
|
|
65373
|
+
options: localVarRequestOptions,
|
|
65374
|
+
};
|
|
65375
|
+
},
|
|
65376
|
+
/**
|
|
65377
|
+
* Reads the sale at Nexi and picks the way itself, so the till decides nothing by time: within Nexi\'s hour after the sale (CONFIRMED) and with nothing refunded yet, the sale is confirmed as failed again and everything goes back; once Nexi committed it (COMMITTED, after the hour or after a refund), a customer-not-present refund gives back what is left. A confirm Nexi refuses because the hour ended in between is read again and refunded instead. A sale Nexi already holds unpaid while our record calls it paid is recorded as given back. A confirm Nexi does not answer is never recorded as failed: the revert is kept, counted against the sale, and Cloud Task rounds settle it from Nexi\'s record of the sale: given back once Nexi holds it unpaid; the confirm as failed sent again while Nexi holds it confirmed paid; a refund of what is left once Nexi committed it paid. No card either way. Once Nexi gave the money back, the session is REFUNDING and reconciliation writes the reversal onto the order, then REFUNDED. `amount` is ignored: a revert gives back what is left. A signed-in ticket only. Every refusal answers the shared error body: `name` is a stable code the till maps to its own words, `detail` the waiter\'s words when it has none.
|
|
65378
|
+
* @summary Revert a paid Nexi sale: give back what is left and write the reversal onto the order
|
|
65379
|
+
* @param {ReverseSessionDto} reverseSessionDto
|
|
65380
|
+
* @param {*} [options] Override http request option.
|
|
65381
|
+
* @throws {RequiredError}
|
|
65382
|
+
*/
|
|
65383
|
+
revertNexiSession: async (reverseSessionDto: ReverseSessionDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
65384
|
+
// verify required parameter 'reverseSessionDto' is not null or undefined
|
|
65385
|
+
assertParamExists('revertNexiSession', 'reverseSessionDto', reverseSessionDto)
|
|
65386
|
+
const localVarPath = `/api/v1/payment-session/nexi/revert`;
|
|
65387
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
65388
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
65389
|
+
let baseOptions;
|
|
65390
|
+
if (configuration) {
|
|
65391
|
+
baseOptions = configuration.baseOptions;
|
|
65392
|
+
}
|
|
65393
|
+
|
|
65394
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
65395
|
+
const localVarHeaderParameter = {} as any;
|
|
65396
|
+
const localVarQueryParameter = {} as any;
|
|
65397
|
+
|
|
65398
|
+
|
|
65399
|
+
|
|
65287
65400
|
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
65288
65401
|
|
|
65289
65402
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -65487,7 +65600,7 @@ export const PaymentSessionApiFp = function(configuration?: Configuration) {
|
|
|
65487
65600
|
const localVarAxiosParamCreator = PaymentSessionApiAxiosParamCreator(configuration)
|
|
65488
65601
|
return {
|
|
65489
65602
|
/**
|
|
65490
|
-
* Arms cancelRequestedAt + aborts at the gateway (Viva session abort / Nets terminal cancelAction, dispatched on the session\'s provider). Does not flip status — the webhook/sweep resolves the real outcome; a late success parks at VOID_PENDING with a dev alert. Card sessions only.
|
|
65603
|
+
* Arms cancelRequestedAt + aborts at the gateway (Viva session abort / Nets terminal cancelAction, dispatched on the session\'s provider). Does not flip status — the webhook/sweep resolves the real outcome; a late success parks at VOID_PENDING with a dev alert. Card sessions only. A Nexi sale is cancelled as Nexi documents it: confirmed as failed (ABORTED) at Nexi, from any unfinished state; its outcome is still Nexi\'s, read by the wait rounds, which send the cancel again until Nexi takes it. A Nexi sale whose paid answer the server already claimed is not cancelled: it ends paid.
|
|
65491
65604
|
* @summary Cancel an in-flight card payment session (Viva or Nets)
|
|
65492
65605
|
* @param {string} clientToken The token the initiate answered for the session.
|
|
65493
65606
|
* @param {*} [options] Override http request option.
|
|
@@ -65572,7 +65685,7 @@ export const PaymentSessionApiFp = function(configuration?: Configuration) {
|
|
|
65572
65685
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
65573
65686
|
},
|
|
65574
65687
|
/**
|
|
65575
|
-
* Saves the session first, its sessionId being the sale\'s external_id at Nexi, then asks Nexi to start the sale and answer at once. The customer then taps on the terminal; Cloud Tasks ask Nexi until the sale ends. When Nexi answers paid, in this order: Nexi\'s answer is kept on the session (the status unchanged), Nexi is confirmed (which takes the money), the session is stored SUCCESS, the payment is written on the order (reconciliation, which announces the settled order on the venue\'s channel), and only then SUCCESS is announced on the session\'s channel. So nothing tells the till \'paid\' before the money is taken. If the order cannot take the payment, it is asked again for up to 5 minutes, then the charge goes to the till as its own order and a person is alerted. Follow the session on the Ably channel nexi.<channel>.requests.<sessionId> (event payment:status-changed) or with GET /payment-session/:clientToken, which shows SUCCESS from the moment Nexi took the money. A tip or surcharge typed on the terminal is recorded from Nexi\'s answer.
|
|
65688
|
+
* Saves the session first, its sessionId being the sale\'s external_id at Nexi, then asks Nexi to start the sale and answer at once. The customer then taps on the terminal; Cloud Tasks ask Nexi until the sale ends. When Nexi answers paid, in this order: Nexi\'s answer is kept on the session (the status unchanged), Nexi is confirmed (which takes the money), the session is stored SUCCESS, the payment is written on the order (reconciliation, which announces the settled order on the venue\'s channel), and only then SUCCESS is announced on the session\'s channel. So nothing tells the till \'paid\' before the money is taken. If the order cannot take the payment, it is asked again for up to 5 minutes, then the charge goes to the till as its own order and a person is alerted. Follow the session on the Ably channel nexi.<channel>.requests.<sessionId> (event payment:status-changed) or with GET /payment-session/:clientToken, which shows SUCCESS from the moment Nexi took the money. A tip or surcharge typed on the terminal is recorded from Nexi\'s answer. POST /payment-session/:clientToken/cancel cancels it as Nexi documents it, a confirm as failed; the outcome is still Nexi\'s answer, so a sale Nexi was already confirmed paid for ends paid. Idempotent by the X-Idempotency-Key header within the venue: a repeat answers the session it started without asking Nexi again. A signed-in ticket only: the service key is not accepted (R27).
|
|
65576
65689
|
* @summary Start a card payment on the station\'s Nexi terminal
|
|
65577
65690
|
* @param {InitiateNexiSessionDto} initiateNexiSessionDto
|
|
65578
65691
|
* @param {string} [xIdempotencyKey] A UUID the app makes for this payment. A repeated key answers the session it started, without charging again.
|
|
@@ -65730,6 +65843,18 @@ export const PaymentSessionApiFp = function(configuration?: Configuration) {
|
|
|
65730
65843
|
const localVarAxiosArgs = await localVarAxiosParamCreator.refundNetsSession(reverseSessionDto, options);
|
|
65731
65844
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
65732
65845
|
},
|
|
65846
|
+
/**
|
|
65847
|
+
* Stores a refund session for the amount asked (what is left of the sale when none is), within what is left of the sale, then asks Nexi for a customer-not-present refund of the sale on the sale\'s own terminal: the customer needs no card and the terminal shows nothing. Nexi\'s answer decides: Nexi made it → our confirm, then REFUNDED; Nexi ended it unpaid → FAILED and refused; Nexi still processing → the session waits and Cloud Tasks follow it until Nexi answers. Does NOT write a reversal onto the order: the refund plan records it, as for Viva and Nets. Idempotent by the X-Idempotency-Key header within the venue: a repeat answers the refund it started, as it stands, without asking Nexi again. A signed-in ticket only. Every refusal answers the shared error body: `name` is a stable code the till maps to its own words, `detail` the waiter\'s words when it has none.
|
|
65848
|
+
* @summary Refund a paid Nexi sale, customer not present, with no card
|
|
65849
|
+
* @param {ReverseSessionDto} reverseSessionDto
|
|
65850
|
+
* @param {string} [xIdempotencyKey] A UUID the app makes for this refund. A repeated key answers the refund it started, without refunding again.
|
|
65851
|
+
* @param {*} [options] Override http request option.
|
|
65852
|
+
* @throws {RequiredError}
|
|
65853
|
+
*/
|
|
65854
|
+
async refundNexiSession(reverseSessionDto: ReverseSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentSessionViewDto>> {
|
|
65855
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.refundNexiSession(reverseSessionDto, xIdempotencyKey, options);
|
|
65856
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
65857
|
+
},
|
|
65733
65858
|
/**
|
|
65734
65859
|
* Refunds a Viva card payment at the gateway by its sessionId, optionally a partial `amount` (item / cluster refund). Validates the remaining refundable balance and supports multiple partial refunds. Does NOT write a reversal paymentEvent to the order — order-side accounting is handled by the refund plan. For a full reversal that writes the order paymentEvent, use /revert.
|
|
65735
65860
|
* @summary Refund a settled Viva payment session (gateway only)
|
|
@@ -65785,6 +65910,17 @@ export const PaymentSessionApiFp = function(configuration?: Configuration) {
|
|
|
65785
65910
|
const localVarAxiosArgs = await localVarAxiosParamCreator.revertNetsSession(reverseSessionDto, options);
|
|
65786
65911
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
65787
65912
|
},
|
|
65913
|
+
/**
|
|
65914
|
+
* Reads the sale at Nexi and picks the way itself, so the till decides nothing by time: within Nexi\'s hour after the sale (CONFIRMED) and with nothing refunded yet, the sale is confirmed as failed again and everything goes back; once Nexi committed it (COMMITTED, after the hour or after a refund), a customer-not-present refund gives back what is left. A confirm Nexi refuses because the hour ended in between is read again and refunded instead. A sale Nexi already holds unpaid while our record calls it paid is recorded as given back. A confirm Nexi does not answer is never recorded as failed: the revert is kept, counted against the sale, and Cloud Task rounds settle it from Nexi\'s record of the sale: given back once Nexi holds it unpaid; the confirm as failed sent again while Nexi holds it confirmed paid; a refund of what is left once Nexi committed it paid. No card either way. Once Nexi gave the money back, the session is REFUNDING and reconciliation writes the reversal onto the order, then REFUNDED. `amount` is ignored: a revert gives back what is left. A signed-in ticket only. Every refusal answers the shared error body: `name` is a stable code the till maps to its own words, `detail` the waiter\'s words when it has none.
|
|
65915
|
+
* @summary Revert a paid Nexi sale: give back what is left and write the reversal onto the order
|
|
65916
|
+
* @param {ReverseSessionDto} reverseSessionDto
|
|
65917
|
+
* @param {*} [options] Override http request option.
|
|
65918
|
+
* @throws {RequiredError}
|
|
65919
|
+
*/
|
|
65920
|
+
async revertNexiSession(reverseSessionDto: ReverseSessionDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentSessionViewDto>> {
|
|
65921
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.revertNexiSession(reverseSessionDto, options);
|
|
65922
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
65923
|
+
},
|
|
65788
65924
|
/**
|
|
65789
65925
|
* Fully reverses a completed Viva card payment (SUCCESS / CLOSED) by its sessionId: refunds the full amount at the gateway AND writes a reversal paymentEvent to the order via the settlement engine. Idempotent: re-calling a reverted session is a no-op.
|
|
65790
65926
|
* @summary Revert (fully reverse) a settled Viva payment session
|
|
@@ -65851,7 +65987,7 @@ export const PaymentSessionApiFactory = function (configuration?: Configuration,
|
|
|
65851
65987
|
const localVarFp = PaymentSessionApiFp(configuration)
|
|
65852
65988
|
return {
|
|
65853
65989
|
/**
|
|
65854
|
-
* Arms cancelRequestedAt + aborts at the gateway (Viva session abort / Nets terminal cancelAction, dispatched on the session\'s provider). Does not flip status — the webhook/sweep resolves the real outcome; a late success parks at VOID_PENDING with a dev alert. Card sessions only.
|
|
65990
|
+
* Arms cancelRequestedAt + aborts at the gateway (Viva session abort / Nets terminal cancelAction, dispatched on the session\'s provider). Does not flip status — the webhook/sweep resolves the real outcome; a late success parks at VOID_PENDING with a dev alert. Card sessions only. A Nexi sale is cancelled as Nexi documents it: confirmed as failed (ABORTED) at Nexi, from any unfinished state; its outcome is still Nexi\'s, read by the wait rounds, which send the cancel again until Nexi takes it. A Nexi sale whose paid answer the server already claimed is not cancelled: it ends paid.
|
|
65855
65991
|
* @summary Cancel an in-flight card payment session (Viva or Nets)
|
|
65856
65992
|
* @param {string} clientToken The token the initiate answered for the session.
|
|
65857
65993
|
* @param {*} [options] Override http request option.
|
|
@@ -65929,7 +66065,7 @@ export const PaymentSessionApiFactory = function (configuration?: Configuration,
|
|
|
65929
66065
|
return localVarFp.initiateNetsSession(initiateNetsSessionDto, xIdempotencyKey, options).then((request) => request(axios, basePath));
|
|
65930
66066
|
},
|
|
65931
66067
|
/**
|
|
65932
|
-
* Saves the session first, its sessionId being the sale\'s external_id at Nexi, then asks Nexi to start the sale and answer at once. The customer then taps on the terminal; Cloud Tasks ask Nexi until the sale ends. When Nexi answers paid, in this order: Nexi\'s answer is kept on the session (the status unchanged), Nexi is confirmed (which takes the money), the session is stored SUCCESS, the payment is written on the order (reconciliation, which announces the settled order on the venue\'s channel), and only then SUCCESS is announced on the session\'s channel. So nothing tells the till \'paid\' before the money is taken. If the order cannot take the payment, it is asked again for up to 5 minutes, then the charge goes to the till as its own order and a person is alerted. Follow the session on the Ably channel nexi.<channel>.requests.<sessionId> (event payment:status-changed) or with GET /payment-session/:clientToken, which shows SUCCESS from the moment Nexi took the money. A tip or surcharge typed on the terminal is recorded from Nexi\'s answer.
|
|
66068
|
+
* Saves the session first, its sessionId being the sale\'s external_id at Nexi, then asks Nexi to start the sale and answer at once. The customer then taps on the terminal; Cloud Tasks ask Nexi until the sale ends. When Nexi answers paid, in this order: Nexi\'s answer is kept on the session (the status unchanged), Nexi is confirmed (which takes the money), the session is stored SUCCESS, the payment is written on the order (reconciliation, which announces the settled order on the venue\'s channel), and only then SUCCESS is announced on the session\'s channel. So nothing tells the till \'paid\' before the money is taken. If the order cannot take the payment, it is asked again for up to 5 minutes, then the charge goes to the till as its own order and a person is alerted. Follow the session on the Ably channel nexi.<channel>.requests.<sessionId> (event payment:status-changed) or with GET /payment-session/:clientToken, which shows SUCCESS from the moment Nexi took the money. A tip or surcharge typed on the terminal is recorded from Nexi\'s answer. POST /payment-session/:clientToken/cancel cancels it as Nexi documents it, a confirm as failed; the outcome is still Nexi\'s answer, so a sale Nexi was already confirmed paid for ends paid. Idempotent by the X-Idempotency-Key header within the venue: a repeat answers the session it started without asking Nexi again. A signed-in ticket only: the service key is not accepted (R27).
|
|
65933
66069
|
* @summary Start a card payment on the station\'s Nexi terminal
|
|
65934
66070
|
* @param {InitiateNexiSessionDto} initiateNexiSessionDto
|
|
65935
66071
|
* @param {string} [xIdempotencyKey] A UUID the app makes for this payment. A repeated key answers the session it started, without charging again.
|
|
@@ -66073,6 +66209,17 @@ export const PaymentSessionApiFactory = function (configuration?: Configuration,
|
|
|
66073
66209
|
refundNetsSession(reverseSessionDto: ReverseSessionDto, options?: any): AxiosPromise<PaymentSessionViewDto> {
|
|
66074
66210
|
return localVarFp.refundNetsSession(reverseSessionDto, options).then((request) => request(axios, basePath));
|
|
66075
66211
|
},
|
|
66212
|
+
/**
|
|
66213
|
+
* Stores a refund session for the amount asked (what is left of the sale when none is), within what is left of the sale, then asks Nexi for a customer-not-present refund of the sale on the sale\'s own terminal: the customer needs no card and the terminal shows nothing. Nexi\'s answer decides: Nexi made it → our confirm, then REFUNDED; Nexi ended it unpaid → FAILED and refused; Nexi still processing → the session waits and Cloud Tasks follow it until Nexi answers. Does NOT write a reversal onto the order: the refund plan records it, as for Viva and Nets. Idempotent by the X-Idempotency-Key header within the venue: a repeat answers the refund it started, as it stands, without asking Nexi again. A signed-in ticket only. Every refusal answers the shared error body: `name` is a stable code the till maps to its own words, `detail` the waiter\'s words when it has none.
|
|
66214
|
+
* @summary Refund a paid Nexi sale, customer not present, with no card
|
|
66215
|
+
* @param {ReverseSessionDto} reverseSessionDto
|
|
66216
|
+
* @param {string} [xIdempotencyKey] A UUID the app makes for this refund. A repeated key answers the refund it started, without refunding again.
|
|
66217
|
+
* @param {*} [options] Override http request option.
|
|
66218
|
+
* @throws {RequiredError}
|
|
66219
|
+
*/
|
|
66220
|
+
refundNexiSession(reverseSessionDto: ReverseSessionDto, xIdempotencyKey?: string, options?: any): AxiosPromise<PaymentSessionViewDto> {
|
|
66221
|
+
return localVarFp.refundNexiSession(reverseSessionDto, xIdempotencyKey, options).then((request) => request(axios, basePath));
|
|
66222
|
+
},
|
|
66076
66223
|
/**
|
|
66077
66224
|
* Refunds a Viva card payment at the gateway by its sessionId, optionally a partial `amount` (item / cluster refund). Validates the remaining refundable balance and supports multiple partial refunds. Does NOT write a reversal paymentEvent to the order — order-side accounting is handled by the refund plan. For a full reversal that writes the order paymentEvent, use /revert.
|
|
66078
66225
|
* @summary Refund a settled Viva payment session (gateway only)
|
|
@@ -66123,6 +66270,16 @@ export const PaymentSessionApiFactory = function (configuration?: Configuration,
|
|
|
66123
66270
|
revertNetsSession(reverseSessionDto: ReverseSessionDto, options?: any): AxiosPromise<NetsRevertResponseDto> {
|
|
66124
66271
|
return localVarFp.revertNetsSession(reverseSessionDto, options).then((request) => request(axios, basePath));
|
|
66125
66272
|
},
|
|
66273
|
+
/**
|
|
66274
|
+
* Reads the sale at Nexi and picks the way itself, so the till decides nothing by time: within Nexi\'s hour after the sale (CONFIRMED) and with nothing refunded yet, the sale is confirmed as failed again and everything goes back; once Nexi committed it (COMMITTED, after the hour or after a refund), a customer-not-present refund gives back what is left. A confirm Nexi refuses because the hour ended in between is read again and refunded instead. A sale Nexi already holds unpaid while our record calls it paid is recorded as given back. A confirm Nexi does not answer is never recorded as failed: the revert is kept, counted against the sale, and Cloud Task rounds settle it from Nexi\'s record of the sale: given back once Nexi holds it unpaid; the confirm as failed sent again while Nexi holds it confirmed paid; a refund of what is left once Nexi committed it paid. No card either way. Once Nexi gave the money back, the session is REFUNDING and reconciliation writes the reversal onto the order, then REFUNDED. `amount` is ignored: a revert gives back what is left. A signed-in ticket only. Every refusal answers the shared error body: `name` is a stable code the till maps to its own words, `detail` the waiter\'s words when it has none.
|
|
66275
|
+
* @summary Revert a paid Nexi sale: give back what is left and write the reversal onto the order
|
|
66276
|
+
* @param {ReverseSessionDto} reverseSessionDto
|
|
66277
|
+
* @param {*} [options] Override http request option.
|
|
66278
|
+
* @throws {RequiredError}
|
|
66279
|
+
*/
|
|
66280
|
+
revertNexiSession(reverseSessionDto: ReverseSessionDto, options?: any): AxiosPromise<PaymentSessionViewDto> {
|
|
66281
|
+
return localVarFp.revertNexiSession(reverseSessionDto, options).then((request) => request(axios, basePath));
|
|
66282
|
+
},
|
|
66126
66283
|
/**
|
|
66127
66284
|
* Fully reverses a completed Viva card payment (SUCCESS / CLOSED) by its sessionId: refunds the full amount at the gateway AND writes a reversal paymentEvent to the order via the settlement engine. Idempotent: re-calling a reverted session is a no-op.
|
|
66128
66285
|
* @summary Revert (fully reverse) a settled Viva payment session
|
|
@@ -66183,7 +66340,7 @@ export const PaymentSessionApiFactory = function (configuration?: Configuration,
|
|
|
66183
66340
|
*/
|
|
66184
66341
|
export interface PaymentSessionApiInterface {
|
|
66185
66342
|
/**
|
|
66186
|
-
* Arms cancelRequestedAt + aborts at the gateway (Viva session abort / Nets terminal cancelAction, dispatched on the session\'s provider). Does not flip status — the webhook/sweep resolves the real outcome; a late success parks at VOID_PENDING with a dev alert. Card sessions only.
|
|
66343
|
+
* Arms cancelRequestedAt + aborts at the gateway (Viva session abort / Nets terminal cancelAction, dispatched on the session\'s provider). Does not flip status — the webhook/sweep resolves the real outcome; a late success parks at VOID_PENDING with a dev alert. Card sessions only. A Nexi sale is cancelled as Nexi documents it: confirmed as failed (ABORTED) at Nexi, from any unfinished state; its outcome is still Nexi\'s, read by the wait rounds, which send the cancel again until Nexi takes it. A Nexi sale whose paid answer the server already claimed is not cancelled: it ends paid.
|
|
66187
66344
|
* @summary Cancel an in-flight card payment session (Viva or Nets)
|
|
66188
66345
|
* @param {string} clientToken The token the initiate answered for the session.
|
|
66189
66346
|
* @param {*} [options] Override http request option.
|
|
@@ -66261,7 +66418,7 @@ export interface PaymentSessionApiInterface {
|
|
|
66261
66418
|
initiateNetsSession(initiateNetsSessionDto: InitiateNetsSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): AxiosPromise<InitiateNetsSessionResponseDto>;
|
|
66262
66419
|
|
|
66263
66420
|
/**
|
|
66264
|
-
* Saves the session first, its sessionId being the sale\'s external_id at Nexi, then asks Nexi to start the sale and answer at once. The customer then taps on the terminal; Cloud Tasks ask Nexi until the sale ends. When Nexi answers paid, in this order: Nexi\'s answer is kept on the session (the status unchanged), Nexi is confirmed (which takes the money), the session is stored SUCCESS, the payment is written on the order (reconciliation, which announces the settled order on the venue\'s channel), and only then SUCCESS is announced on the session\'s channel. So nothing tells the till \'paid\' before the money is taken. If the order cannot take the payment, it is asked again for up to 5 minutes, then the charge goes to the till as its own order and a person is alerted. Follow the session on the Ably channel nexi.<channel>.requests.<sessionId> (event payment:status-changed) or with GET /payment-session/:clientToken, which shows SUCCESS from the moment Nexi took the money. A tip or surcharge typed on the terminal is recorded from Nexi\'s answer.
|
|
66421
|
+
* Saves the session first, its sessionId being the sale\'s external_id at Nexi, then asks Nexi to start the sale and answer at once. The customer then taps on the terminal; Cloud Tasks ask Nexi until the sale ends. When Nexi answers paid, in this order: Nexi\'s answer is kept on the session (the status unchanged), Nexi is confirmed (which takes the money), the session is stored SUCCESS, the payment is written on the order (reconciliation, which announces the settled order on the venue\'s channel), and only then SUCCESS is announced on the session\'s channel. So nothing tells the till \'paid\' before the money is taken. If the order cannot take the payment, it is asked again for up to 5 minutes, then the charge goes to the till as its own order and a person is alerted. Follow the session on the Ably channel nexi.<channel>.requests.<sessionId> (event payment:status-changed) or with GET /payment-session/:clientToken, which shows SUCCESS from the moment Nexi took the money. A tip or surcharge typed on the terminal is recorded from Nexi\'s answer. POST /payment-session/:clientToken/cancel cancels it as Nexi documents it, a confirm as failed; the outcome is still Nexi\'s answer, so a sale Nexi was already confirmed paid for ends paid. Idempotent by the X-Idempotency-Key header within the venue: a repeat answers the session it started without asking Nexi again. A signed-in ticket only: the service key is not accepted (R27).
|
|
66265
66422
|
* @summary Start a card payment on the station\'s Nexi terminal
|
|
66266
66423
|
* @param {InitiateNexiSessionDto} initiateNexiSessionDto
|
|
66267
66424
|
* @param {string} [xIdempotencyKey] A UUID the app makes for this payment. A repeated key answers the session it started, without charging again.
|
|
@@ -66405,6 +66562,17 @@ export interface PaymentSessionApiInterface {
|
|
|
66405
66562
|
*/
|
|
66406
66563
|
refundNetsSession(reverseSessionDto: ReverseSessionDto, options?: AxiosRequestConfig): AxiosPromise<PaymentSessionViewDto>;
|
|
66407
66564
|
|
|
66565
|
+
/**
|
|
66566
|
+
* Stores a refund session for the amount asked (what is left of the sale when none is), within what is left of the sale, then asks Nexi for a customer-not-present refund of the sale on the sale\'s own terminal: the customer needs no card and the terminal shows nothing. Nexi\'s answer decides: Nexi made it → our confirm, then REFUNDED; Nexi ended it unpaid → FAILED and refused; Nexi still processing → the session waits and Cloud Tasks follow it until Nexi answers. Does NOT write a reversal onto the order: the refund plan records it, as for Viva and Nets. Idempotent by the X-Idempotency-Key header within the venue: a repeat answers the refund it started, as it stands, without asking Nexi again. A signed-in ticket only. Every refusal answers the shared error body: `name` is a stable code the till maps to its own words, `detail` the waiter\'s words when it has none.
|
|
66567
|
+
* @summary Refund a paid Nexi sale, customer not present, with no card
|
|
66568
|
+
* @param {ReverseSessionDto} reverseSessionDto
|
|
66569
|
+
* @param {string} [xIdempotencyKey] A UUID the app makes for this refund. A repeated key answers the refund it started, without refunding again.
|
|
66570
|
+
* @param {*} [options] Override http request option.
|
|
66571
|
+
* @throws {RequiredError}
|
|
66572
|
+
* @memberof PaymentSessionApiInterface
|
|
66573
|
+
*/
|
|
66574
|
+
refundNexiSession(reverseSessionDto: ReverseSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): AxiosPromise<PaymentSessionViewDto>;
|
|
66575
|
+
|
|
66408
66576
|
/**
|
|
66409
66577
|
* Refunds a Viva card payment at the gateway by its sessionId, optionally a partial `amount` (item / cluster refund). Validates the remaining refundable balance and supports multiple partial refunds. Does NOT write a reversal paymentEvent to the order — order-side accounting is handled by the refund plan. For a full reversal that writes the order paymentEvent, use /revert.
|
|
66410
66578
|
* @summary Refund a settled Viva payment session (gateway only)
|
|
@@ -66455,6 +66623,16 @@ export interface PaymentSessionApiInterface {
|
|
|
66455
66623
|
*/
|
|
66456
66624
|
revertNetsSession(reverseSessionDto: ReverseSessionDto, options?: AxiosRequestConfig): AxiosPromise<NetsRevertResponseDto>;
|
|
66457
66625
|
|
|
66626
|
+
/**
|
|
66627
|
+
* Reads the sale at Nexi and picks the way itself, so the till decides nothing by time: within Nexi\'s hour after the sale (CONFIRMED) and with nothing refunded yet, the sale is confirmed as failed again and everything goes back; once Nexi committed it (COMMITTED, after the hour or after a refund), a customer-not-present refund gives back what is left. A confirm Nexi refuses because the hour ended in between is read again and refunded instead. A sale Nexi already holds unpaid while our record calls it paid is recorded as given back. A confirm Nexi does not answer is never recorded as failed: the revert is kept, counted against the sale, and Cloud Task rounds settle it from Nexi\'s record of the sale: given back once Nexi holds it unpaid; the confirm as failed sent again while Nexi holds it confirmed paid; a refund of what is left once Nexi committed it paid. No card either way. Once Nexi gave the money back, the session is REFUNDING and reconciliation writes the reversal onto the order, then REFUNDED. `amount` is ignored: a revert gives back what is left. A signed-in ticket only. Every refusal answers the shared error body: `name` is a stable code the till maps to its own words, `detail` the waiter\'s words when it has none.
|
|
66628
|
+
* @summary Revert a paid Nexi sale: give back what is left and write the reversal onto the order
|
|
66629
|
+
* @param {ReverseSessionDto} reverseSessionDto
|
|
66630
|
+
* @param {*} [options] Override http request option.
|
|
66631
|
+
* @throws {RequiredError}
|
|
66632
|
+
* @memberof PaymentSessionApiInterface
|
|
66633
|
+
*/
|
|
66634
|
+
revertNexiSession(reverseSessionDto: ReverseSessionDto, options?: AxiosRequestConfig): AxiosPromise<PaymentSessionViewDto>;
|
|
66635
|
+
|
|
66458
66636
|
/**
|
|
66459
66637
|
* Fully reverses a completed Viva card payment (SUCCESS / CLOSED) by its sessionId: refunds the full amount at the gateway AND writes a reversal paymentEvent to the order via the settlement engine. Idempotent: re-calling a reverted session is a no-op.
|
|
66460
66638
|
* @summary Revert (fully reverse) a settled Viva payment session
|
|
@@ -66515,7 +66693,7 @@ export interface PaymentSessionApiInterface {
|
|
|
66515
66693
|
*/
|
|
66516
66694
|
export class PaymentSessionApi extends BaseAPI implements PaymentSessionApiInterface {
|
|
66517
66695
|
/**
|
|
66518
|
-
* Arms cancelRequestedAt + aborts at the gateway (Viva session abort / Nets terminal cancelAction, dispatched on the session\'s provider). Does not flip status — the webhook/sweep resolves the real outcome; a late success parks at VOID_PENDING with a dev alert. Card sessions only.
|
|
66696
|
+
* Arms cancelRequestedAt + aborts at the gateway (Viva session abort / Nets terminal cancelAction, dispatched on the session\'s provider). Does not flip status — the webhook/sweep resolves the real outcome; a late success parks at VOID_PENDING with a dev alert. Card sessions only. A Nexi sale is cancelled as Nexi documents it: confirmed as failed (ABORTED) at Nexi, from any unfinished state; its outcome is still Nexi\'s, read by the wait rounds, which send the cancel again until Nexi takes it. A Nexi sale whose paid answer the server already claimed is not cancelled: it ends paid.
|
|
66519
66697
|
* @summary Cancel an in-flight card payment session (Viva or Nets)
|
|
66520
66698
|
* @param {string} clientToken The token the initiate answered for the session.
|
|
66521
66699
|
* @param {*} [options] Override http request option.
|
|
@@ -66607,7 +66785,7 @@ export class PaymentSessionApi extends BaseAPI implements PaymentSessionApiInter
|
|
|
66607
66785
|
}
|
|
66608
66786
|
|
|
66609
66787
|
/**
|
|
66610
|
-
* Saves the session first, its sessionId being the sale\'s external_id at Nexi, then asks Nexi to start the sale and answer at once. The customer then taps on the terminal; Cloud Tasks ask Nexi until the sale ends. When Nexi answers paid, in this order: Nexi\'s answer is kept on the session (the status unchanged), Nexi is confirmed (which takes the money), the session is stored SUCCESS, the payment is written on the order (reconciliation, which announces the settled order on the venue\'s channel), and only then SUCCESS is announced on the session\'s channel. So nothing tells the till \'paid\' before the money is taken. If the order cannot take the payment, it is asked again for up to 5 minutes, then the charge goes to the till as its own order and a person is alerted. Follow the session on the Ably channel nexi.<channel>.requests.<sessionId> (event payment:status-changed) or with GET /payment-session/:clientToken, which shows SUCCESS from the moment Nexi took the money. A tip or surcharge typed on the terminal is recorded from Nexi\'s answer.
|
|
66788
|
+
* Saves the session first, its sessionId being the sale\'s external_id at Nexi, then asks Nexi to start the sale and answer at once. The customer then taps on the terminal; Cloud Tasks ask Nexi until the sale ends. When Nexi answers paid, in this order: Nexi\'s answer is kept on the session (the status unchanged), Nexi is confirmed (which takes the money), the session is stored SUCCESS, the payment is written on the order (reconciliation, which announces the settled order on the venue\'s channel), and only then SUCCESS is announced on the session\'s channel. So nothing tells the till \'paid\' before the money is taken. If the order cannot take the payment, it is asked again for up to 5 minutes, then the charge goes to the till as its own order and a person is alerted. Follow the session on the Ably channel nexi.<channel>.requests.<sessionId> (event payment:status-changed) or with GET /payment-session/:clientToken, which shows SUCCESS from the moment Nexi took the money. A tip or surcharge typed on the terminal is recorded from Nexi\'s answer. POST /payment-session/:clientToken/cancel cancels it as Nexi documents it, a confirm as failed; the outcome is still Nexi\'s answer, so a sale Nexi was already confirmed paid for ends paid. Idempotent by the X-Idempotency-Key header within the venue: a repeat answers the session it started without asking Nexi again. A signed-in ticket only: the service key is not accepted (R27).
|
|
66611
66789
|
* @summary Start a card payment on the station\'s Nexi terminal
|
|
66612
66790
|
* @param {InitiateNexiSessionDto} initiateNexiSessionDto
|
|
66613
66791
|
* @param {string} [xIdempotencyKey] A UUID the app makes for this payment. A repeated key answers the session it started, without charging again.
|
|
@@ -66779,6 +66957,19 @@ export class PaymentSessionApi extends BaseAPI implements PaymentSessionApiInter
|
|
|
66779
66957
|
return PaymentSessionApiFp(this.configuration).refundNetsSession(reverseSessionDto, options).then((request) => request(this.axios, this.basePath));
|
|
66780
66958
|
}
|
|
66781
66959
|
|
|
66960
|
+
/**
|
|
66961
|
+
* Stores a refund session for the amount asked (what is left of the sale when none is), within what is left of the sale, then asks Nexi for a customer-not-present refund of the sale on the sale\'s own terminal: the customer needs no card and the terminal shows nothing. Nexi\'s answer decides: Nexi made it → our confirm, then REFUNDED; Nexi ended it unpaid → FAILED and refused; Nexi still processing → the session waits and Cloud Tasks follow it until Nexi answers. Does NOT write a reversal onto the order: the refund plan records it, as for Viva and Nets. Idempotent by the X-Idempotency-Key header within the venue: a repeat answers the refund it started, as it stands, without asking Nexi again. A signed-in ticket only. Every refusal answers the shared error body: `name` is a stable code the till maps to its own words, `detail` the waiter\'s words when it has none.
|
|
66962
|
+
* @summary Refund a paid Nexi sale, customer not present, with no card
|
|
66963
|
+
* @param {ReverseSessionDto} reverseSessionDto
|
|
66964
|
+
* @param {string} [xIdempotencyKey] A UUID the app makes for this refund. A repeated key answers the refund it started, without refunding again.
|
|
66965
|
+
* @param {*} [options] Override http request option.
|
|
66966
|
+
* @throws {RequiredError}
|
|
66967
|
+
* @memberof PaymentSessionApi
|
|
66968
|
+
*/
|
|
66969
|
+
public refundNexiSession(reverseSessionDto: ReverseSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig) {
|
|
66970
|
+
return PaymentSessionApiFp(this.configuration).refundNexiSession(reverseSessionDto, xIdempotencyKey, options).then((request) => request(this.axios, this.basePath));
|
|
66971
|
+
}
|
|
66972
|
+
|
|
66782
66973
|
/**
|
|
66783
66974
|
* Refunds a Viva card payment at the gateway by its sessionId, optionally a partial `amount` (item / cluster refund). Validates the remaining refundable balance and supports multiple partial refunds. Does NOT write a reversal paymentEvent to the order — order-side accounting is handled by the refund plan. For a full reversal that writes the order paymentEvent, use /revert.
|
|
66784
66975
|
* @summary Refund a settled Viva payment session (gateway only)
|
|
@@ -66839,6 +67030,18 @@ export class PaymentSessionApi extends BaseAPI implements PaymentSessionApiInter
|
|
|
66839
67030
|
return PaymentSessionApiFp(this.configuration).revertNetsSession(reverseSessionDto, options).then((request) => request(this.axios, this.basePath));
|
|
66840
67031
|
}
|
|
66841
67032
|
|
|
67033
|
+
/**
|
|
67034
|
+
* Reads the sale at Nexi and picks the way itself, so the till decides nothing by time: within Nexi\'s hour after the sale (CONFIRMED) and with nothing refunded yet, the sale is confirmed as failed again and everything goes back; once Nexi committed it (COMMITTED, after the hour or after a refund), a customer-not-present refund gives back what is left. A confirm Nexi refuses because the hour ended in between is read again and refunded instead. A sale Nexi already holds unpaid while our record calls it paid is recorded as given back. A confirm Nexi does not answer is never recorded as failed: the revert is kept, counted against the sale, and Cloud Task rounds settle it from Nexi\'s record of the sale: given back once Nexi holds it unpaid; the confirm as failed sent again while Nexi holds it confirmed paid; a refund of what is left once Nexi committed it paid. No card either way. Once Nexi gave the money back, the session is REFUNDING and reconciliation writes the reversal onto the order, then REFUNDED. `amount` is ignored: a revert gives back what is left. A signed-in ticket only. Every refusal answers the shared error body: `name` is a stable code the till maps to its own words, `detail` the waiter\'s words when it has none.
|
|
67035
|
+
* @summary Revert a paid Nexi sale: give back what is left and write the reversal onto the order
|
|
67036
|
+
* @param {ReverseSessionDto} reverseSessionDto
|
|
67037
|
+
* @param {*} [options] Override http request option.
|
|
67038
|
+
* @throws {RequiredError}
|
|
67039
|
+
* @memberof PaymentSessionApi
|
|
67040
|
+
*/
|
|
67041
|
+
public revertNexiSession(reverseSessionDto: ReverseSessionDto, options?: AxiosRequestConfig) {
|
|
67042
|
+
return PaymentSessionApiFp(this.configuration).revertNexiSession(reverseSessionDto, options).then((request) => request(this.axios, this.basePath));
|
|
67043
|
+
}
|
|
67044
|
+
|
|
66842
67045
|
/**
|
|
66843
67046
|
* Fully reverses a completed Viva card payment (SUCCESS / CLOSED) by its sessionId: refunds the full amount at the gateway AND writes a reversal paymentEvent to the order via the settlement engine. Idempotent: re-calling a reverted session is a no-op.
|
|
66844
67047
|
* @summary Revert (fully reverse) a settled Viva payment session
|
|
@@ -68781,11 +68984,11 @@ export const ReceiptFooterApiAxiosParamCreator = function (configuration?: Confi
|
|
|
68781
68984
|
* The footer the venue\'s tills on this channel print on the documents it applies to; the till reads it when it starts. Kept 30 days per venue and channel, the absence of a footer too, and invalidated for every channel of the venue when one of its footers is saved.
|
|
68782
68985
|
* @summary Get the receipt footer config for a business + channel
|
|
68783
68986
|
* @param {number} businessId The venue whose footer is read or written: its orderingBusinessId
|
|
68784
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose footer is read or written; each channel of a venue has its own footer
|
|
68987
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose footer is read or written; each channel of a venue has its own footer
|
|
68785
68988
|
* @param {*} [options] Override http request option.
|
|
68786
68989
|
* @throws {RequiredError}
|
|
68787
68990
|
*/
|
|
68788
|
-
receiptFooterGetConfig: async (businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
68991
|
+
receiptFooterGetConfig: async (businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
68789
68992
|
// verify required parameter 'businessId' is not null or undefined
|
|
68790
68993
|
assertParamExists('receiptFooterGetConfig', 'businessId', businessId)
|
|
68791
68994
|
// verify required parameter 'xAppX' is not null or undefined
|
|
@@ -68826,12 +69029,12 @@ export const ReceiptFooterApiAxiosParamCreator = function (configuration?: Confi
|
|
|
68826
69029
|
* Saves the venue\'s footer for the channel, replacing both fields; it is created on the first save. Once saved, the venue\'s kept footers are invalidated, every channel at once, and the venue\'s tills on that channel are told over Ably to sync RECEIPT_FOOTER. If the invalidation fails, the save still answers 200, the tills are still told, and the failure is logged as an error: the tills then read the old footer until it expires (up to 30 days) or POST v1/config-management/business/:businessId/sync (configManualSync) with RECEIPT_FOOTER clears it.
|
|
68827
69030
|
* @summary Create or update the receipt footer config for a business + channel
|
|
68828
69031
|
* @param {number} businessId The venue whose footer is read or written: its orderingBusinessId
|
|
68829
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose footer is read or written; each channel of a venue has its own footer
|
|
69032
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose footer is read or written; each channel of a venue has its own footer
|
|
68830
69033
|
* @param {UpsertReceiptFooterDto} upsertReceiptFooterDto
|
|
68831
69034
|
* @param {*} [options] Override http request option.
|
|
68832
69035
|
* @throws {RequiredError}
|
|
68833
69036
|
*/
|
|
68834
|
-
receiptFooterUpsertConfig: async (businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertReceiptFooterDto: UpsertReceiptFooterDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
69037
|
+
receiptFooterUpsertConfig: async (businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertReceiptFooterDto: UpsertReceiptFooterDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
68835
69038
|
// verify required parameter 'businessId' is not null or undefined
|
|
68836
69039
|
assertParamExists('receiptFooterUpsertConfig', 'businessId', businessId)
|
|
68837
69040
|
// verify required parameter 'xAppX' is not null or undefined
|
|
@@ -68887,11 +69090,11 @@ export const ReceiptFooterApiFp = function(configuration?: Configuration) {
|
|
|
68887
69090
|
* The footer the venue\'s tills on this channel print on the documents it applies to; the till reads it when it starts. Kept 30 days per venue and channel, the absence of a footer too, and invalidated for every channel of the venue when one of its footers is saved.
|
|
68888
69091
|
* @summary Get the receipt footer config for a business + channel
|
|
68889
69092
|
* @param {number} businessId The venue whose footer is read or written: its orderingBusinessId
|
|
68890
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose footer is read or written; each channel of a venue has its own footer
|
|
69093
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose footer is read or written; each channel of a venue has its own footer
|
|
68891
69094
|
* @param {*} [options] Override http request option.
|
|
68892
69095
|
* @throws {RequiredError}
|
|
68893
69096
|
*/
|
|
68894
|
-
async receiptFooterGetConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReceiptFooterConfigDto>> {
|
|
69097
|
+
async receiptFooterGetConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReceiptFooterConfigDto>> {
|
|
68895
69098
|
const localVarAxiosArgs = await localVarAxiosParamCreator.receiptFooterGetConfig(businessId, xAppX, options);
|
|
68896
69099
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
68897
69100
|
},
|
|
@@ -68899,12 +69102,12 @@ export const ReceiptFooterApiFp = function(configuration?: Configuration) {
|
|
|
68899
69102
|
* Saves the venue\'s footer for the channel, replacing both fields; it is created on the first save. Once saved, the venue\'s kept footers are invalidated, every channel at once, and the venue\'s tills on that channel are told over Ably to sync RECEIPT_FOOTER. If the invalidation fails, the save still answers 200, the tills are still told, and the failure is logged as an error: the tills then read the old footer until it expires (up to 30 days) or POST v1/config-management/business/:businessId/sync (configManualSync) with RECEIPT_FOOTER clears it.
|
|
68900
69103
|
* @summary Create or update the receipt footer config for a business + channel
|
|
68901
69104
|
* @param {number} businessId The venue whose footer is read or written: its orderingBusinessId
|
|
68902
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose footer is read or written; each channel of a venue has its own footer
|
|
69105
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose footer is read or written; each channel of a venue has its own footer
|
|
68903
69106
|
* @param {UpsertReceiptFooterDto} upsertReceiptFooterDto
|
|
68904
69107
|
* @param {*} [options] Override http request option.
|
|
68905
69108
|
* @throws {RequiredError}
|
|
68906
69109
|
*/
|
|
68907
|
-
async receiptFooterUpsertConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertReceiptFooterDto: UpsertReceiptFooterDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReceiptFooterConfigDto>> {
|
|
69110
|
+
async receiptFooterUpsertConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertReceiptFooterDto: UpsertReceiptFooterDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReceiptFooterConfigDto>> {
|
|
68908
69111
|
const localVarAxiosArgs = await localVarAxiosParamCreator.receiptFooterUpsertConfig(businessId, xAppX, upsertReceiptFooterDto, options);
|
|
68909
69112
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
68910
69113
|
},
|
|
@@ -68922,23 +69125,23 @@ export const ReceiptFooterApiFactory = function (configuration?: Configuration,
|
|
|
68922
69125
|
* The footer the venue\'s tills on this channel print on the documents it applies to; the till reads it when it starts. Kept 30 days per venue and channel, the absence of a footer too, and invalidated for every channel of the venue when one of its footers is saved.
|
|
68923
69126
|
* @summary Get the receipt footer config for a business + channel
|
|
68924
69127
|
* @param {number} businessId The venue whose footer is read or written: its orderingBusinessId
|
|
68925
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose footer is read or written; each channel of a venue has its own footer
|
|
69128
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose footer is read or written; each channel of a venue has its own footer
|
|
68926
69129
|
* @param {*} [options] Override http request option.
|
|
68927
69130
|
* @throws {RequiredError}
|
|
68928
69131
|
*/
|
|
68929
|
-
receiptFooterGetConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', options?: any): AxiosPromise<ReceiptFooterConfigDto> {
|
|
69132
|
+
receiptFooterGetConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', options?: any): AxiosPromise<ReceiptFooterConfigDto> {
|
|
68930
69133
|
return localVarFp.receiptFooterGetConfig(businessId, xAppX, options).then((request) => request(axios, basePath));
|
|
68931
69134
|
},
|
|
68932
69135
|
/**
|
|
68933
69136
|
* Saves the venue\'s footer for the channel, replacing both fields; it is created on the first save. Once saved, the venue\'s kept footers are invalidated, every channel at once, and the venue\'s tills on that channel are told over Ably to sync RECEIPT_FOOTER. If the invalidation fails, the save still answers 200, the tills are still told, and the failure is logged as an error: the tills then read the old footer until it expires (up to 30 days) or POST v1/config-management/business/:businessId/sync (configManualSync) with RECEIPT_FOOTER clears it.
|
|
68934
69137
|
* @summary Create or update the receipt footer config for a business + channel
|
|
68935
69138
|
* @param {number} businessId The venue whose footer is read or written: its orderingBusinessId
|
|
68936
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose footer is read or written; each channel of a venue has its own footer
|
|
69139
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose footer is read or written; each channel of a venue has its own footer
|
|
68937
69140
|
* @param {UpsertReceiptFooterDto} upsertReceiptFooterDto
|
|
68938
69141
|
* @param {*} [options] Override http request option.
|
|
68939
69142
|
* @throws {RequiredError}
|
|
68940
69143
|
*/
|
|
68941
|
-
receiptFooterUpsertConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertReceiptFooterDto: UpsertReceiptFooterDto, options?: any): AxiosPromise<ReceiptFooterConfigDto> {
|
|
69144
|
+
receiptFooterUpsertConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertReceiptFooterDto: UpsertReceiptFooterDto, options?: any): AxiosPromise<ReceiptFooterConfigDto> {
|
|
68942
69145
|
return localVarFp.receiptFooterUpsertConfig(businessId, xAppX, upsertReceiptFooterDto, options).then((request) => request(axios, basePath));
|
|
68943
69146
|
},
|
|
68944
69147
|
};
|
|
@@ -68954,24 +69157,24 @@ export interface ReceiptFooterApiInterface {
|
|
|
68954
69157
|
* The footer the venue\'s tills on this channel print on the documents it applies to; the till reads it when it starts. Kept 30 days per venue and channel, the absence of a footer too, and invalidated for every channel of the venue when one of its footers is saved.
|
|
68955
69158
|
* @summary Get the receipt footer config for a business + channel
|
|
68956
69159
|
* @param {number} businessId The venue whose footer is read or written: its orderingBusinessId
|
|
68957
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose footer is read or written; each channel of a venue has its own footer
|
|
69160
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose footer is read or written; each channel of a venue has its own footer
|
|
68958
69161
|
* @param {*} [options] Override http request option.
|
|
68959
69162
|
* @throws {RequiredError}
|
|
68960
69163
|
* @memberof ReceiptFooterApiInterface
|
|
68961
69164
|
*/
|
|
68962
|
-
receiptFooterGetConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', options?: AxiosRequestConfig): AxiosPromise<ReceiptFooterConfigDto>;
|
|
69165
|
+
receiptFooterGetConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', options?: AxiosRequestConfig): AxiosPromise<ReceiptFooterConfigDto>;
|
|
68963
69166
|
|
|
68964
69167
|
/**
|
|
68965
69168
|
* Saves the venue\'s footer for the channel, replacing both fields; it is created on the first save. Once saved, the venue\'s kept footers are invalidated, every channel at once, and the venue\'s tills on that channel are told over Ably to sync RECEIPT_FOOTER. If the invalidation fails, the save still answers 200, the tills are still told, and the failure is logged as an error: the tills then read the old footer until it expires (up to 30 days) or POST v1/config-management/business/:businessId/sync (configManualSync) with RECEIPT_FOOTER clears it.
|
|
68966
69169
|
* @summary Create or update the receipt footer config for a business + channel
|
|
68967
69170
|
* @param {number} businessId The venue whose footer is read or written: its orderingBusinessId
|
|
68968
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose footer is read or written; each channel of a venue has its own footer
|
|
69171
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose footer is read or written; each channel of a venue has its own footer
|
|
68969
69172
|
* @param {UpsertReceiptFooterDto} upsertReceiptFooterDto
|
|
68970
69173
|
* @param {*} [options] Override http request option.
|
|
68971
69174
|
* @throws {RequiredError}
|
|
68972
69175
|
* @memberof ReceiptFooterApiInterface
|
|
68973
69176
|
*/
|
|
68974
|
-
receiptFooterUpsertConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertReceiptFooterDto: UpsertReceiptFooterDto, options?: AxiosRequestConfig): AxiosPromise<ReceiptFooterConfigDto>;
|
|
69177
|
+
receiptFooterUpsertConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertReceiptFooterDto: UpsertReceiptFooterDto, options?: AxiosRequestConfig): AxiosPromise<ReceiptFooterConfigDto>;
|
|
68975
69178
|
|
|
68976
69179
|
}
|
|
68977
69180
|
|
|
@@ -68986,12 +69189,12 @@ export class ReceiptFooterApi extends BaseAPI implements ReceiptFooterApiInterfa
|
|
|
68986
69189
|
* The footer the venue\'s tills on this channel print on the documents it applies to; the till reads it when it starts. Kept 30 days per venue and channel, the absence of a footer too, and invalidated for every channel of the venue when one of its footers is saved.
|
|
68987
69190
|
* @summary Get the receipt footer config for a business + channel
|
|
68988
69191
|
* @param {number} businessId The venue whose footer is read or written: its orderingBusinessId
|
|
68989
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose footer is read or written; each channel of a venue has its own footer
|
|
69192
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose footer is read or written; each channel of a venue has its own footer
|
|
68990
69193
|
* @param {*} [options] Override http request option.
|
|
68991
69194
|
* @throws {RequiredError}
|
|
68992
69195
|
* @memberof ReceiptFooterApi
|
|
68993
69196
|
*/
|
|
68994
|
-
public receiptFooterGetConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', options?: AxiosRequestConfig) {
|
|
69197
|
+
public receiptFooterGetConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', options?: AxiosRequestConfig) {
|
|
68995
69198
|
return ReceiptFooterApiFp(this.configuration).receiptFooterGetConfig(businessId, xAppX, options).then((request) => request(this.axios, this.basePath));
|
|
68996
69199
|
}
|
|
68997
69200
|
|
|
@@ -68999,13 +69202,13 @@ export class ReceiptFooterApi extends BaseAPI implements ReceiptFooterApiInterfa
|
|
|
68999
69202
|
* Saves the venue\'s footer for the channel, replacing both fields; it is created on the first save. Once saved, the venue\'s kept footers are invalidated, every channel at once, and the venue\'s tills on that channel are told over Ably to sync RECEIPT_FOOTER. If the invalidation fails, the save still answers 200, the tills are still told, and the failure is logged as an error: the tills then read the old footer until it expires (up to 30 days) or POST v1/config-management/business/:businessId/sync (configManualSync) with RECEIPT_FOOTER clears it.
|
|
69000
69203
|
* @summary Create or update the receipt footer config for a business + channel
|
|
69001
69204
|
* @param {number} businessId The venue whose footer is read or written: its orderingBusinessId
|
|
69002
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose footer is read or written; each channel of a venue has its own footer
|
|
69205
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner'} xAppX The app channel whose footer is read or written; each channel of a venue has its own footer
|
|
69003
69206
|
* @param {UpsertReceiptFooterDto} upsertReceiptFooterDto
|
|
69004
69207
|
* @param {*} [options] Override http request option.
|
|
69005
69208
|
* @throws {RequiredError}
|
|
69006
69209
|
* @memberof ReceiptFooterApi
|
|
69007
69210
|
*/
|
|
69008
|
-
public receiptFooterUpsertConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertReceiptFooterDto: UpsertReceiptFooterDto, options?: AxiosRequestConfig) {
|
|
69211
|
+
public receiptFooterUpsertConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertReceiptFooterDto: UpsertReceiptFooterDto, options?: AxiosRequestConfig) {
|
|
69009
69212
|
return ReceiptFooterApiFp(this.configuration).receiptFooterUpsertConfig(businessId, xAppX, upsertReceiptFooterDto, options).then((request) => request(this.axios, this.basePath));
|
|
69010
69213
|
}
|
|
69011
69214
|
}
|