@munchi_oy/core 2.20.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 +262 -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 +342 -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];
|
|
@@ -25723,7 +25724,8 @@ export const ProviderEnum = {
|
|
|
25723
25724
|
WoltStorefront: 'WoltStorefront',
|
|
25724
25725
|
Storefront: 'Storefront',
|
|
25725
25726
|
MunchiPay: 'MunchiPay',
|
|
25726
|
-
ResQ: 'ResQ'
|
|
25727
|
+
ResQ: 'ResQ',
|
|
25728
|
+
Partner: 'Partner'
|
|
25727
25729
|
} as const;
|
|
25728
25730
|
|
|
25729
25731
|
export type ProviderEnum = typeof ProviderEnum[keyof typeof ProviderEnum];
|
|
@@ -29575,7 +29577,7 @@ export interface ReverseSessionDto {
|
|
|
29575
29577
|
*/
|
|
29576
29578
|
'sessionId': string;
|
|
29577
29579
|
/**
|
|
29578
|
-
* 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.
|
|
29579
29581
|
* @type {number}
|
|
29580
29582
|
* @memberof ReverseSessionDto
|
|
29581
29583
|
*/
|
|
@@ -46480,11 +46482,11 @@ export const CashManagementApiAxiosParamCreator = function (configuration?: Conf
|
|
|
46480
46482
|
* @param {string} businessId The venue\'s id (its orderingBusinessId), as text
|
|
46481
46483
|
* @param {string} sessionId The cash session\'s id
|
|
46482
46484
|
* @param {SendCashReportDto} sendCashReportDto
|
|
46483
|
-
* @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.
|
|
46484
46486
|
* @param {*} [options] Override http request option.
|
|
46485
46487
|
* @throws {RequiredError}
|
|
46486
46488
|
*/
|
|
46487
|
-
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> => {
|
|
46488
46490
|
// verify required parameter 'businessId' is not null or undefined
|
|
46489
46491
|
assertParamExists('sendSessionReport', 'businessId', businessId)
|
|
46490
46492
|
// verify required parameter 'sessionId' is not null or undefined
|
|
@@ -46607,11 +46609,11 @@ export const CashManagementApiFp = function(configuration?: Configuration) {
|
|
|
46607
46609
|
* @param {string} businessId The venue\'s id (its orderingBusinessId), as text
|
|
46608
46610
|
* @param {string} sessionId The cash session\'s id
|
|
46609
46611
|
* @param {SendCashReportDto} sendCashReportDto
|
|
46610
|
-
* @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.
|
|
46611
46613
|
* @param {*} [options] Override http request option.
|
|
46612
46614
|
* @throws {RequiredError}
|
|
46613
46615
|
*/
|
|
46614
|
-
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>> {
|
|
46615
46617
|
const localVarAxiosArgs = await localVarAxiosParamCreator.sendSessionReport(businessId, sessionId, sendCashReportDto, xAppX, options);
|
|
46616
46618
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
46617
46619
|
},
|
|
@@ -46690,11 +46692,11 @@ export const CashManagementApiFactory = function (configuration?: Configuration,
|
|
|
46690
46692
|
* @param {string} businessId The venue\'s id (its orderingBusinessId), as text
|
|
46691
46693
|
* @param {string} sessionId The cash session\'s id
|
|
46692
46694
|
* @param {SendCashReportDto} sendCashReportDto
|
|
46693
|
-
* @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.
|
|
46694
46696
|
* @param {*} [options] Override http request option.
|
|
46695
46697
|
* @throws {RequiredError}
|
|
46696
46698
|
*/
|
|
46697
|
-
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> {
|
|
46698
46700
|
return localVarFp.sendSessionReport(businessId, sessionId, sendCashReportDto, xAppX, options).then((request) => request(axios, basePath));
|
|
46699
46701
|
},
|
|
46700
46702
|
};
|
|
@@ -46771,12 +46773,12 @@ export interface CashManagementApiInterface {
|
|
|
46771
46773
|
* @param {string} businessId The venue\'s id (its orderingBusinessId), as text
|
|
46772
46774
|
* @param {string} sessionId The cash session\'s id
|
|
46773
46775
|
* @param {SendCashReportDto} sendCashReportDto
|
|
46774
|
-
* @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.
|
|
46775
46777
|
* @param {*} [options] Override http request option.
|
|
46776
46778
|
* @throws {RequiredError}
|
|
46777
46779
|
* @memberof CashManagementApiInterface
|
|
46778
46780
|
*/
|
|
46779
|
-
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>;
|
|
46780
46782
|
|
|
46781
46783
|
}
|
|
46782
46784
|
|
|
@@ -46862,12 +46864,12 @@ export class CashManagementApi extends BaseAPI implements CashManagementApiInter
|
|
|
46862
46864
|
* @param {string} businessId The venue\'s id (its orderingBusinessId), as text
|
|
46863
46865
|
* @param {string} sessionId The cash session\'s id
|
|
46864
46866
|
* @param {SendCashReportDto} sendCashReportDto
|
|
46865
|
-
* @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.
|
|
46866
46868
|
* @param {*} [options] Override http request option.
|
|
46867
46869
|
* @throws {RequiredError}
|
|
46868
46870
|
* @memberof CashManagementApi
|
|
46869
46871
|
*/
|
|
46870
|
-
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) {
|
|
46871
46873
|
return CashManagementApiFp(this.configuration).sendSessionReport(businessId, sessionId, sendCashReportDto, xAppX, options).then((request) => request(this.axios, this.basePath));
|
|
46872
46874
|
}
|
|
46873
46875
|
}
|
|
@@ -47529,12 +47531,12 @@ export const ConfigManagementApiAxiosParamCreator = function (configuration?: Co
|
|
|
47529
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.
|
|
47530
47532
|
* @summary Enable or disable first-party Munchi GiftCard integration
|
|
47531
47533
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
47532
|
-
* @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
|
|
47533
47535
|
* @param {ConfigureMunchiGiftCardDto} configureMunchiGiftCardDto
|
|
47534
47536
|
* @param {*} [options] Override http request option.
|
|
47535
47537
|
* @throws {RequiredError}
|
|
47536
47538
|
*/
|
|
47537
|
-
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> => {
|
|
47538
47540
|
// verify required parameter 'businessId' is not null or undefined
|
|
47539
47541
|
assertParamExists('configConfigureMunchiGiftCard', 'businessId', businessId)
|
|
47540
47542
|
// verify required parameter 'xAppX' is not null or undefined
|
|
@@ -47580,11 +47582,11 @@ export const ConfigManagementApiAxiosParamCreator = function (configuration?: Co
|
|
|
47580
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).
|
|
47581
47583
|
* @summary Read a channel\'s card payment providers
|
|
47582
47584
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
47583
|
-
* @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
|
|
47584
47586
|
* @param {*} [options] Override http request option.
|
|
47585
47587
|
* @throws {RequiredError}
|
|
47586
47588
|
*/
|
|
47587
|
-
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> => {
|
|
47588
47590
|
// verify required parameter 'businessId' is not null or undefined
|
|
47589
47591
|
assertParamExists('configGetProviders', 'businessId', businessId)
|
|
47590
47592
|
// verify required parameter 'xAppX' is not null or undefined
|
|
@@ -47670,11 +47672,11 @@ export const ConfigManagementApiAxiosParamCreator = function (configuration?: Co
|
|
|
47670
47672
|
* @summary Remove payment option
|
|
47671
47673
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
47672
47674
|
* @param {string} id The payment option\'s id
|
|
47673
|
-
* @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
|
|
47674
47676
|
* @param {*} [options] Override http request option.
|
|
47675
47677
|
* @throws {RequiredError}
|
|
47676
47678
|
*/
|
|
47677
|
-
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> => {
|
|
47678
47680
|
// verify required parameter 'businessId' is not null or undefined
|
|
47679
47681
|
assertParamExists('configRemovePaymentOption', 'businessId', businessId)
|
|
47680
47682
|
// verify required parameter 'id' is not null or undefined
|
|
@@ -47718,13 +47720,13 @@ export const ConfigManagementApiAxiosParamCreator = function (configuration?: Co
|
|
|
47718
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.
|
|
47719
47721
|
* @summary Save a channel\'s Epassi credentials and answer the public key to send Epassi (Munchi admins only)
|
|
47720
47722
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
47721
|
-
* @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
|
|
47722
47724
|
* @param {string} xEpassiAccessKey The access key Epassi issued for this venue; Epassi issues a different one for test and production.
|
|
47723
47725
|
* @param {SaveEpassiCredentialsDto} saveEpassiCredentialsDto
|
|
47724
47726
|
* @param {*} [options] Override http request option.
|
|
47725
47727
|
* @throws {RequiredError}
|
|
47726
47728
|
*/
|
|
47727
|
-
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> => {
|
|
47728
47730
|
// verify required parameter 'businessId' is not null or undefined
|
|
47729
47731
|
assertParamExists('configSaveEpassiCredentials', 'businessId', businessId)
|
|
47730
47732
|
// verify required parameter 'xAppX' is not null or undefined
|
|
@@ -47820,12 +47822,12 @@ export const ConfigManagementApiAxiosParamCreator = function (configuration?: Co
|
|
|
47820
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.
|
|
47821
47823
|
* @summary Create or update a channel\'s config
|
|
47822
47824
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
47823
|
-
* @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
|
|
47824
47826
|
* @param {UpsertConfigDto} upsertConfigDto
|
|
47825
47827
|
* @param {*} [options] Override http request option.
|
|
47826
47828
|
* @throws {RequiredError}
|
|
47827
47829
|
*/
|
|
47828
|
-
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> => {
|
|
47829
47831
|
// verify required parameter 'businessId' is not null or undefined
|
|
47830
47832
|
assertParamExists('configUpsertChannelConfig', 'businessId', businessId)
|
|
47831
47833
|
// verify required parameter 'xAppX' is not null or undefined
|
|
@@ -47871,12 +47873,12 @@ export const ConfigManagementApiAxiosParamCreator = function (configuration?: Co
|
|
|
47871
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.
|
|
47872
47874
|
* @summary Create or update a channel\'s third-party gift card integration
|
|
47873
47875
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
47874
|
-
* @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
|
|
47875
47877
|
* @param {UpsertGiftCardDto} upsertGiftCardDto
|
|
47876
47878
|
* @param {*} [options] Override http request option.
|
|
47877
47879
|
* @throws {RequiredError}
|
|
47878
47880
|
*/
|
|
47879
|
-
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> => {
|
|
47880
47882
|
// verify required parameter 'businessId' is not null or undefined
|
|
47881
47883
|
assertParamExists('configUpsertGiftCard', 'businessId', businessId)
|
|
47882
47884
|
// verify required parameter 'xAppX' is not null or undefined
|
|
@@ -47966,12 +47968,12 @@ export const ConfigManagementApiAxiosParamCreator = function (configuration?: Co
|
|
|
47966
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.
|
|
47967
47969
|
* @summary Create or update a channel\'s Nets config (Munchi admins only)
|
|
47968
47970
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
47969
|
-
* @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
|
|
47970
47972
|
* @param {UpsertNetsDto} upsertNetsDto
|
|
47971
47973
|
* @param {*} [options] Override http request option.
|
|
47972
47974
|
* @throws {RequiredError}
|
|
47973
47975
|
*/
|
|
47974
|
-
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> => {
|
|
47975
47977
|
// verify required parameter 'businessId' is not null or undefined
|
|
47976
47978
|
assertParamExists('configUpsertNets', 'businessId', businessId)
|
|
47977
47979
|
// verify required parameter 'xAppX' is not null or undefined
|
|
@@ -48017,12 +48019,12 @@ export const ConfigManagementApiAxiosParamCreator = function (configuration?: Co
|
|
|
48017
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.
|
|
48018
48020
|
* @summary Create or update a channel\'s Nexi config (Munchi admins only)
|
|
48019
48021
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48020
|
-
* @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
|
|
48021
48023
|
* @param {UpsertNexiDto} upsertNexiDto
|
|
48022
48024
|
* @param {*} [options] Override http request option.
|
|
48023
48025
|
* @throws {RequiredError}
|
|
48024
48026
|
*/
|
|
48025
|
-
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> => {
|
|
48026
48028
|
// verify required parameter 'businessId' is not null or undefined
|
|
48027
48029
|
assertParamExists('configUpsertNexi', 'businessId', businessId)
|
|
48028
48030
|
// verify required parameter 'xAppX' is not null or undefined
|
|
@@ -48068,12 +48070,12 @@ export const ConfigManagementApiAxiosParamCreator = function (configuration?: Co
|
|
|
48068
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.
|
|
48069
48071
|
* @summary Create or update a channel\'s checkout payment options
|
|
48070
48072
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48071
|
-
* @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
|
|
48072
48074
|
* @param {UpsertPaymentOptionsDto} upsertPaymentOptionsDto
|
|
48073
48075
|
* @param {*} [options] Override http request option.
|
|
48074
48076
|
* @throws {RequiredError}
|
|
48075
48077
|
*/
|
|
48076
|
-
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> => {
|
|
48077
48079
|
// verify required parameter 'businessId' is not null or undefined
|
|
48078
48080
|
assertParamExists('configUpsertPaymentOptions', 'businessId', businessId)
|
|
48079
48081
|
// verify required parameter 'xAppX' is not null or undefined
|
|
@@ -48119,12 +48121,12 @@ export const ConfigManagementApiAxiosParamCreator = function (configuration?: Co
|
|
|
48119
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.
|
|
48120
48122
|
* @summary Set active provider and upsert its credentials (Munchi admins only)
|
|
48121
48123
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48122
|
-
* @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
|
|
48123
48125
|
* @param {UpsertProvidersDto} upsertProvidersDto
|
|
48124
48126
|
* @param {*} [options] Override http request option.
|
|
48125
48127
|
* @throws {RequiredError}
|
|
48126
48128
|
*/
|
|
48127
|
-
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> => {
|
|
48128
48130
|
// verify required parameter 'businessId' is not null or undefined
|
|
48129
48131
|
assertParamExists('configUpsertProviders', 'businessId', businessId)
|
|
48130
48132
|
// verify required parameter 'xAppX' is not null or undefined
|
|
@@ -48170,12 +48172,12 @@ export const ConfigManagementApiAxiosParamCreator = function (configuration?: Co
|
|
|
48170
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.
|
|
48171
48173
|
* @summary Create or update a channel\'s Stripe config (Munchi admins only)
|
|
48172
48174
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48173
|
-
* @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
|
|
48174
48176
|
* @param {UpsertStripeDto} upsertStripeDto
|
|
48175
48177
|
* @param {*} [options] Override http request option.
|
|
48176
48178
|
* @throws {RequiredError}
|
|
48177
48179
|
*/
|
|
48178
|
-
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> => {
|
|
48179
48181
|
// verify required parameter 'businessId' is not null or undefined
|
|
48180
48182
|
assertParamExists('configUpsertStripe', 'businessId', businessId)
|
|
48181
48183
|
// verify required parameter 'xAppX' is not null or undefined
|
|
@@ -48221,12 +48223,12 @@ export const ConfigManagementApiAxiosParamCreator = function (configuration?: Co
|
|
|
48221
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.
|
|
48222
48224
|
* @summary Create or update a channel\'s Viva config (Munchi admins only)
|
|
48223
48225
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48224
|
-
* @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
|
|
48225
48227
|
* @param {UpsertVivaDto} upsertVivaDto
|
|
48226
48228
|
* @param {*} [options] Override http request option.
|
|
48227
48229
|
* @throws {RequiredError}
|
|
48228
48230
|
*/
|
|
48229
|
-
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> => {
|
|
48230
48232
|
// verify required parameter 'businessId' is not null or undefined
|
|
48231
48233
|
assertParamExists('configUpsertViva', 'businessId', businessId)
|
|
48232
48234
|
// verify required parameter 'xAppX' is not null or undefined
|
|
@@ -48272,12 +48274,12 @@ export const ConfigManagementApiAxiosParamCreator = function (configuration?: Co
|
|
|
48272
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.
|
|
48273
48275
|
* @summary Create or update a channel\'s Worldline config (Munchi admins only)
|
|
48274
48276
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48275
|
-
* @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
|
|
48276
48278
|
* @param {UpsertWorldlineDto} upsertWorldlineDto
|
|
48277
48279
|
* @param {*} [options] Override http request option.
|
|
48278
48280
|
* @throws {RequiredError}
|
|
48279
48281
|
*/
|
|
48280
|
-
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> => {
|
|
48281
48283
|
// verify required parameter 'businessId' is not null or undefined
|
|
48282
48284
|
assertParamExists('configUpsertWorldline', 'businessId', businessId)
|
|
48283
48285
|
// verify required parameter 'xAppX' is not null or undefined
|
|
@@ -48333,12 +48335,12 @@ export const ConfigManagementApiFp = function(configuration?: Configuration) {
|
|
|
48333
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.
|
|
48334
48336
|
* @summary Enable or disable first-party Munchi GiftCard integration
|
|
48335
48337
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48336
|
-
* @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
|
|
48337
48339
|
* @param {ConfigureMunchiGiftCardDto} configureMunchiGiftCardDto
|
|
48338
48340
|
* @param {*} [options] Override http request option.
|
|
48339
48341
|
* @throws {RequiredError}
|
|
48340
48342
|
*/
|
|
48341
|
-
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>> {
|
|
48342
48344
|
const localVarAxiosArgs = await localVarAxiosParamCreator.configConfigureMunchiGiftCard(businessId, xAppX, configureMunchiGiftCardDto, options);
|
|
48343
48345
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
48344
48346
|
},
|
|
@@ -48346,11 +48348,11 @@ export const ConfigManagementApiFp = function(configuration?: Configuration) {
|
|
|
48346
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).
|
|
48347
48349
|
* @summary Read a channel\'s card payment providers
|
|
48348
48350
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48349
|
-
* @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
|
|
48350
48352
|
* @param {*} [options] Override http request option.
|
|
48351
48353
|
* @throws {RequiredError}
|
|
48352
48354
|
*/
|
|
48353
|
-
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>> {
|
|
48354
48356
|
const localVarAxiosArgs = await localVarAxiosParamCreator.configGetProviders(businessId, xAppX, options);
|
|
48355
48357
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
48356
48358
|
},
|
|
@@ -48371,11 +48373,11 @@ export const ConfigManagementApiFp = function(configuration?: Configuration) {
|
|
|
48371
48373
|
* @summary Remove payment option
|
|
48372
48374
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48373
48375
|
* @param {string} id The payment option\'s id
|
|
48374
|
-
* @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
|
|
48375
48377
|
* @param {*} [options] Override http request option.
|
|
48376
48378
|
* @throws {RequiredError}
|
|
48377
48379
|
*/
|
|
48378
|
-
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>> {
|
|
48379
48381
|
const localVarAxiosArgs = await localVarAxiosParamCreator.configRemovePaymentOption(businessId, id, xAppX, options);
|
|
48380
48382
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
48381
48383
|
},
|
|
@@ -48383,13 +48385,13 @@ export const ConfigManagementApiFp = function(configuration?: Configuration) {
|
|
|
48383
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.
|
|
48384
48386
|
* @summary Save a channel\'s Epassi credentials and answer the public key to send Epassi (Munchi admins only)
|
|
48385
48387
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48386
|
-
* @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
|
|
48387
48389
|
* @param {string} xEpassiAccessKey The access key Epassi issued for this venue; Epassi issues a different one for test and production.
|
|
48388
48390
|
* @param {SaveEpassiCredentialsDto} saveEpassiCredentialsDto
|
|
48389
48391
|
* @param {*} [options] Override http request option.
|
|
48390
48392
|
* @throws {RequiredError}
|
|
48391
48393
|
*/
|
|
48392
|
-
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>> {
|
|
48393
48395
|
const localVarAxiosArgs = await localVarAxiosParamCreator.configSaveEpassiCredentials(businessId, xAppX, xEpassiAccessKey, saveEpassiCredentialsDto, options);
|
|
48394
48396
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
48395
48397
|
},
|
|
@@ -48409,12 +48411,12 @@ export const ConfigManagementApiFp = function(configuration?: Configuration) {
|
|
|
48409
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.
|
|
48410
48412
|
* @summary Create or update a channel\'s config
|
|
48411
48413
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48412
|
-
* @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
|
|
48413
48415
|
* @param {UpsertConfigDto} upsertConfigDto
|
|
48414
48416
|
* @param {*} [options] Override http request option.
|
|
48415
48417
|
* @throws {RequiredError}
|
|
48416
48418
|
*/
|
|
48417
|
-
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>> {
|
|
48418
48420
|
const localVarAxiosArgs = await localVarAxiosParamCreator.configUpsertChannelConfig(businessId, xAppX, upsertConfigDto, options);
|
|
48419
48421
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
48420
48422
|
},
|
|
@@ -48422,12 +48424,12 @@ export const ConfigManagementApiFp = function(configuration?: Configuration) {
|
|
|
48422
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.
|
|
48423
48425
|
* @summary Create or update a channel\'s third-party gift card integration
|
|
48424
48426
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48425
|
-
* @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
|
|
48426
48428
|
* @param {UpsertGiftCardDto} upsertGiftCardDto
|
|
48427
48429
|
* @param {*} [options] Override http request option.
|
|
48428
48430
|
* @throws {RequiredError}
|
|
48429
48431
|
*/
|
|
48430
|
-
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>> {
|
|
48431
48433
|
const localVarAxiosArgs = await localVarAxiosParamCreator.configUpsertGiftCard(businessId, xAppX, upsertGiftCardDto, options);
|
|
48432
48434
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
48433
48435
|
},
|
|
@@ -48447,12 +48449,12 @@ export const ConfigManagementApiFp = function(configuration?: Configuration) {
|
|
|
48447
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.
|
|
48448
48450
|
* @summary Create or update a channel\'s Nets config (Munchi admins only)
|
|
48449
48451
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48450
|
-
* @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
|
|
48451
48453
|
* @param {UpsertNetsDto} upsertNetsDto
|
|
48452
48454
|
* @param {*} [options] Override http request option.
|
|
48453
48455
|
* @throws {RequiredError}
|
|
48454
48456
|
*/
|
|
48455
|
-
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>> {
|
|
48456
48458
|
const localVarAxiosArgs = await localVarAxiosParamCreator.configUpsertNets(businessId, xAppX, upsertNetsDto, options);
|
|
48457
48459
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
48458
48460
|
},
|
|
@@ -48460,12 +48462,12 @@ export const ConfigManagementApiFp = function(configuration?: Configuration) {
|
|
|
48460
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.
|
|
48461
48463
|
* @summary Create or update a channel\'s Nexi config (Munchi admins only)
|
|
48462
48464
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48463
|
-
* @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
|
|
48464
48466
|
* @param {UpsertNexiDto} upsertNexiDto
|
|
48465
48467
|
* @param {*} [options] Override http request option.
|
|
48466
48468
|
* @throws {RequiredError}
|
|
48467
48469
|
*/
|
|
48468
|
-
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>> {
|
|
48469
48471
|
const localVarAxiosArgs = await localVarAxiosParamCreator.configUpsertNexi(businessId, xAppX, upsertNexiDto, options);
|
|
48470
48472
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
48471
48473
|
},
|
|
@@ -48473,12 +48475,12 @@ export const ConfigManagementApiFp = function(configuration?: Configuration) {
|
|
|
48473
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.
|
|
48474
48476
|
* @summary Create or update a channel\'s checkout payment options
|
|
48475
48477
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48476
|
-
* @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
|
|
48477
48479
|
* @param {UpsertPaymentOptionsDto} upsertPaymentOptionsDto
|
|
48478
48480
|
* @param {*} [options] Override http request option.
|
|
48479
48481
|
* @throws {RequiredError}
|
|
48480
48482
|
*/
|
|
48481
|
-
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>> {
|
|
48482
48484
|
const localVarAxiosArgs = await localVarAxiosParamCreator.configUpsertPaymentOptions(businessId, xAppX, upsertPaymentOptionsDto, options);
|
|
48483
48485
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
48484
48486
|
},
|
|
@@ -48486,12 +48488,12 @@ export const ConfigManagementApiFp = function(configuration?: Configuration) {
|
|
|
48486
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.
|
|
48487
48489
|
* @summary Set active provider and upsert its credentials (Munchi admins only)
|
|
48488
48490
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48489
|
-
* @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
|
|
48490
48492
|
* @param {UpsertProvidersDto} upsertProvidersDto
|
|
48491
48493
|
* @param {*} [options] Override http request option.
|
|
48492
48494
|
* @throws {RequiredError}
|
|
48493
48495
|
*/
|
|
48494
|
-
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>> {
|
|
48495
48497
|
const localVarAxiosArgs = await localVarAxiosParamCreator.configUpsertProviders(businessId, xAppX, upsertProvidersDto, options);
|
|
48496
48498
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
48497
48499
|
},
|
|
@@ -48499,12 +48501,12 @@ export const ConfigManagementApiFp = function(configuration?: Configuration) {
|
|
|
48499
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.
|
|
48500
48502
|
* @summary Create or update a channel\'s Stripe config (Munchi admins only)
|
|
48501
48503
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48502
|
-
* @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
|
|
48503
48505
|
* @param {UpsertStripeDto} upsertStripeDto
|
|
48504
48506
|
* @param {*} [options] Override http request option.
|
|
48505
48507
|
* @throws {RequiredError}
|
|
48506
48508
|
*/
|
|
48507
|
-
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>> {
|
|
48508
48510
|
const localVarAxiosArgs = await localVarAxiosParamCreator.configUpsertStripe(businessId, xAppX, upsertStripeDto, options);
|
|
48509
48511
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
48510
48512
|
},
|
|
@@ -48512,12 +48514,12 @@ export const ConfigManagementApiFp = function(configuration?: Configuration) {
|
|
|
48512
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.
|
|
48513
48515
|
* @summary Create or update a channel\'s Viva config (Munchi admins only)
|
|
48514
48516
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48515
|
-
* @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
|
|
48516
48518
|
* @param {UpsertVivaDto} upsertVivaDto
|
|
48517
48519
|
* @param {*} [options] Override http request option.
|
|
48518
48520
|
* @throws {RequiredError}
|
|
48519
48521
|
*/
|
|
48520
|
-
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>> {
|
|
48521
48523
|
const localVarAxiosArgs = await localVarAxiosParamCreator.configUpsertViva(businessId, xAppX, upsertVivaDto, options);
|
|
48522
48524
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
48523
48525
|
},
|
|
@@ -48525,12 +48527,12 @@ export const ConfigManagementApiFp = function(configuration?: Configuration) {
|
|
|
48525
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.
|
|
48526
48528
|
* @summary Create or update a channel\'s Worldline config (Munchi admins only)
|
|
48527
48529
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48528
|
-
* @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
|
|
48529
48531
|
* @param {UpsertWorldlineDto} upsertWorldlineDto
|
|
48530
48532
|
* @param {*} [options] Override http request option.
|
|
48531
48533
|
* @throws {RequiredError}
|
|
48532
48534
|
*/
|
|
48533
|
-
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>> {
|
|
48534
48536
|
const localVarAxiosArgs = await localVarAxiosParamCreator.configUpsertWorldline(businessId, xAppX, upsertWorldlineDto, options);
|
|
48535
48537
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
48536
48538
|
},
|
|
@@ -48548,23 +48550,23 @@ export const ConfigManagementApiFactory = function (configuration?: Configuratio
|
|
|
48548
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.
|
|
48549
48551
|
* @summary Enable or disable first-party Munchi GiftCard integration
|
|
48550
48552
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48551
|
-
* @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
|
|
48552
48554
|
* @param {ConfigureMunchiGiftCardDto} configureMunchiGiftCardDto
|
|
48553
48555
|
* @param {*} [options] Override http request option.
|
|
48554
48556
|
* @throws {RequiredError}
|
|
48555
48557
|
*/
|
|
48556
|
-
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> {
|
|
48557
48559
|
return localVarFp.configConfigureMunchiGiftCard(businessId, xAppX, configureMunchiGiftCardDto, options).then((request) => request(axios, basePath));
|
|
48558
48560
|
},
|
|
48559
48561
|
/**
|
|
48560
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).
|
|
48561
48563
|
* @summary Read a channel\'s card payment providers
|
|
48562
48564
|
* @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
|
|
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
|
|
48564
48566
|
* @param {*} [options] Override http request option.
|
|
48565
48567
|
* @throws {RequiredError}
|
|
48566
48568
|
*/
|
|
48567
|
-
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> {
|
|
48568
48570
|
return localVarFp.configGetProviders(businessId, xAppX, options).then((request) => request(axios, basePath));
|
|
48569
48571
|
},
|
|
48570
48572
|
/**
|
|
@@ -48583,24 +48585,24 @@ export const ConfigManagementApiFactory = function (configuration?: Configuratio
|
|
|
48583
48585
|
* @summary Remove payment option
|
|
48584
48586
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48585
48587
|
* @param {string} id The payment option\'s id
|
|
48586
|
-
* @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
|
|
48587
48589
|
* @param {*} [options] Override http request option.
|
|
48588
48590
|
* @throws {RequiredError}
|
|
48589
48591
|
*/
|
|
48590
|
-
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> {
|
|
48591
48593
|
return localVarFp.configRemovePaymentOption(businessId, id, xAppX, options).then((request) => request(axios, basePath));
|
|
48592
48594
|
},
|
|
48593
48595
|
/**
|
|
48594
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.
|
|
48595
48597
|
* @summary Save a channel\'s Epassi credentials and answer the public key to send Epassi (Munchi admins only)
|
|
48596
48598
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48597
|
-
* @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
|
|
48598
48600
|
* @param {string} xEpassiAccessKey The access key Epassi issued for this venue; Epassi issues a different one for test and production.
|
|
48599
48601
|
* @param {SaveEpassiCredentialsDto} saveEpassiCredentialsDto
|
|
48600
48602
|
* @param {*} [options] Override http request option.
|
|
48601
48603
|
* @throws {RequiredError}
|
|
48602
48604
|
*/
|
|
48603
|
-
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> {
|
|
48604
48606
|
return localVarFp.configSaveEpassiCredentials(businessId, xAppX, xEpassiAccessKey, saveEpassiCredentialsDto, options).then((request) => request(axios, basePath));
|
|
48605
48607
|
},
|
|
48606
48608
|
/**
|
|
@@ -48618,24 +48620,24 @@ export const ConfigManagementApiFactory = function (configuration?: Configuratio
|
|
|
48618
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.
|
|
48619
48621
|
* @summary Create or update a channel\'s config
|
|
48620
48622
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48621
|
-
* @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
|
|
48622
48624
|
* @param {UpsertConfigDto} upsertConfigDto
|
|
48623
48625
|
* @param {*} [options] Override http request option.
|
|
48624
48626
|
* @throws {RequiredError}
|
|
48625
48627
|
*/
|
|
48626
|
-
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> {
|
|
48627
48629
|
return localVarFp.configUpsertChannelConfig(businessId, xAppX, upsertConfigDto, options).then((request) => request(axios, basePath));
|
|
48628
48630
|
},
|
|
48629
48631
|
/**
|
|
48630
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.
|
|
48631
48633
|
* @summary Create or update a channel\'s third-party gift card integration
|
|
48632
48634
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48633
|
-
* @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
|
|
48634
48636
|
* @param {UpsertGiftCardDto} upsertGiftCardDto
|
|
48635
48637
|
* @param {*} [options] Override http request option.
|
|
48636
48638
|
* @throws {RequiredError}
|
|
48637
48639
|
*/
|
|
48638
|
-
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> {
|
|
48639
48641
|
return localVarFp.configUpsertGiftCard(businessId, xAppX, upsertGiftCardDto, options).then((request) => request(axios, basePath));
|
|
48640
48642
|
},
|
|
48641
48643
|
/**
|
|
@@ -48653,84 +48655,84 @@ export const ConfigManagementApiFactory = function (configuration?: Configuratio
|
|
|
48653
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.
|
|
48654
48656
|
* @summary Create or update a channel\'s Nets config (Munchi admins only)
|
|
48655
48657
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48656
|
-
* @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
|
|
48657
48659
|
* @param {UpsertNetsDto} upsertNetsDto
|
|
48658
48660
|
* @param {*} [options] Override http request option.
|
|
48659
48661
|
* @throws {RequiredError}
|
|
48660
48662
|
*/
|
|
48661
|
-
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> {
|
|
48662
48664
|
return localVarFp.configUpsertNets(businessId, xAppX, upsertNetsDto, options).then((request) => request(axios, basePath));
|
|
48663
48665
|
},
|
|
48664
48666
|
/**
|
|
48665
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.
|
|
48666
48668
|
* @summary Create or update a channel\'s Nexi config (Munchi admins only)
|
|
48667
48669
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48668
|
-
* @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
|
|
48669
48671
|
* @param {UpsertNexiDto} upsertNexiDto
|
|
48670
48672
|
* @param {*} [options] Override http request option.
|
|
48671
48673
|
* @throws {RequiredError}
|
|
48672
48674
|
*/
|
|
48673
|
-
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> {
|
|
48674
48676
|
return localVarFp.configUpsertNexi(businessId, xAppX, upsertNexiDto, options).then((request) => request(axios, basePath));
|
|
48675
48677
|
},
|
|
48676
48678
|
/**
|
|
48677
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.
|
|
48678
48680
|
* @summary Create or update a channel\'s checkout payment options
|
|
48679
48681
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48680
|
-
* @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
|
|
48681
48683
|
* @param {UpsertPaymentOptionsDto} upsertPaymentOptionsDto
|
|
48682
48684
|
* @param {*} [options] Override http request option.
|
|
48683
48685
|
* @throws {RequiredError}
|
|
48684
48686
|
*/
|
|
48685
|
-
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> {
|
|
48686
48688
|
return localVarFp.configUpsertPaymentOptions(businessId, xAppX, upsertPaymentOptionsDto, options).then((request) => request(axios, basePath));
|
|
48687
48689
|
},
|
|
48688
48690
|
/**
|
|
48689
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.
|
|
48690
48692
|
* @summary Set active provider and upsert its credentials (Munchi admins only)
|
|
48691
48693
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48692
|
-
* @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
|
|
48693
48695
|
* @param {UpsertProvidersDto} upsertProvidersDto
|
|
48694
48696
|
* @param {*} [options] Override http request option.
|
|
48695
48697
|
* @throws {RequiredError}
|
|
48696
48698
|
*/
|
|
48697
|
-
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> {
|
|
48698
48700
|
return localVarFp.configUpsertProviders(businessId, xAppX, upsertProvidersDto, options).then((request) => request(axios, basePath));
|
|
48699
48701
|
},
|
|
48700
48702
|
/**
|
|
48701
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.
|
|
48702
48704
|
* @summary Create or update a channel\'s Stripe config (Munchi admins only)
|
|
48703
48705
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48704
|
-
* @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
|
|
48705
48707
|
* @param {UpsertStripeDto} upsertStripeDto
|
|
48706
48708
|
* @param {*} [options] Override http request option.
|
|
48707
48709
|
* @throws {RequiredError}
|
|
48708
48710
|
*/
|
|
48709
|
-
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> {
|
|
48710
48712
|
return localVarFp.configUpsertStripe(businessId, xAppX, upsertStripeDto, options).then((request) => request(axios, basePath));
|
|
48711
48713
|
},
|
|
48712
48714
|
/**
|
|
48713
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.
|
|
48714
48716
|
* @summary Create or update a channel\'s Viva config (Munchi admins only)
|
|
48715
48717
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48716
|
-
* @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
|
|
48717
48719
|
* @param {UpsertVivaDto} upsertVivaDto
|
|
48718
48720
|
* @param {*} [options] Override http request option.
|
|
48719
48721
|
* @throws {RequiredError}
|
|
48720
48722
|
*/
|
|
48721
|
-
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> {
|
|
48722
48724
|
return localVarFp.configUpsertViva(businessId, xAppX, upsertVivaDto, options).then((request) => request(axios, basePath));
|
|
48723
48725
|
},
|
|
48724
48726
|
/**
|
|
48725
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.
|
|
48726
48728
|
* @summary Create or update a channel\'s Worldline config (Munchi admins only)
|
|
48727
48729
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48728
|
-
* @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
|
|
48729
48731
|
* @param {UpsertWorldlineDto} upsertWorldlineDto
|
|
48730
48732
|
* @param {*} [options] Override http request option.
|
|
48731
48733
|
* @throws {RequiredError}
|
|
48732
48734
|
*/
|
|
48733
|
-
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> {
|
|
48734
48736
|
return localVarFp.configUpsertWorldline(businessId, xAppX, upsertWorldlineDto, options).then((request) => request(axios, basePath));
|
|
48735
48737
|
},
|
|
48736
48738
|
};
|
|
@@ -48746,24 +48748,24 @@ export interface ConfigManagementApiInterface {
|
|
|
48746
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.
|
|
48747
48749
|
* @summary Enable or disable first-party Munchi GiftCard integration
|
|
48748
48750
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48749
|
-
* @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
|
|
48750
48752
|
* @param {ConfigureMunchiGiftCardDto} configureMunchiGiftCardDto
|
|
48751
48753
|
* @param {*} [options] Override http request option.
|
|
48752
48754
|
* @throws {RequiredError}
|
|
48753
48755
|
* @memberof ConfigManagementApiInterface
|
|
48754
48756
|
*/
|
|
48755
|
-
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>;
|
|
48756
48758
|
|
|
48757
48759
|
/**
|
|
48758
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).
|
|
48759
48761
|
* @summary Read a channel\'s card payment providers
|
|
48760
48762
|
* @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
|
|
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
|
|
48762
48764
|
* @param {*} [options] Override http request option.
|
|
48763
48765
|
* @throws {RequiredError}
|
|
48764
48766
|
* @memberof ConfigManagementApiInterface
|
|
48765
48767
|
*/
|
|
48766
|
-
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>;
|
|
48767
48769
|
|
|
48768
48770
|
/**
|
|
48769
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.
|
|
@@ -48781,25 +48783,25 @@ export interface ConfigManagementApiInterface {
|
|
|
48781
48783
|
* @summary Remove payment option
|
|
48782
48784
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48783
48785
|
* @param {string} id The payment option\'s id
|
|
48784
|
-
* @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
|
|
48785
48787
|
* @param {*} [options] Override http request option.
|
|
48786
48788
|
* @throws {RequiredError}
|
|
48787
48789
|
* @memberof ConfigManagementApiInterface
|
|
48788
48790
|
*/
|
|
48789
|
-
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>;
|
|
48790
48792
|
|
|
48791
48793
|
/**
|
|
48792
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.
|
|
48793
48795
|
* @summary Save a channel\'s Epassi credentials and answer the public key to send Epassi (Munchi admins only)
|
|
48794
48796
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48795
|
-
* @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
|
|
48796
48798
|
* @param {string} xEpassiAccessKey The access key Epassi issued for this venue; Epassi issues a different one for test and production.
|
|
48797
48799
|
* @param {SaveEpassiCredentialsDto} saveEpassiCredentialsDto
|
|
48798
48800
|
* @param {*} [options] Override http request option.
|
|
48799
48801
|
* @throws {RequiredError}
|
|
48800
48802
|
* @memberof ConfigManagementApiInterface
|
|
48801
48803
|
*/
|
|
48802
|
-
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>;
|
|
48803
48805
|
|
|
48804
48806
|
/**
|
|
48805
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.
|
|
@@ -48816,25 +48818,25 @@ export interface ConfigManagementApiInterface {
|
|
|
48816
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.
|
|
48817
48819
|
* @summary Create or update a channel\'s config
|
|
48818
48820
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48819
|
-
* @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
|
|
48820
48822
|
* @param {UpsertConfigDto} upsertConfigDto
|
|
48821
48823
|
* @param {*} [options] Override http request option.
|
|
48822
48824
|
* @throws {RequiredError}
|
|
48823
48825
|
* @memberof ConfigManagementApiInterface
|
|
48824
48826
|
*/
|
|
48825
|
-
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>;
|
|
48826
48828
|
|
|
48827
48829
|
/**
|
|
48828
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.
|
|
48829
48831
|
* @summary Create or update a channel\'s third-party gift card integration
|
|
48830
48832
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48831
|
-
* @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
|
|
48832
48834
|
* @param {UpsertGiftCardDto} upsertGiftCardDto
|
|
48833
48835
|
* @param {*} [options] Override http request option.
|
|
48834
48836
|
* @throws {RequiredError}
|
|
48835
48837
|
* @memberof ConfigManagementApiInterface
|
|
48836
48838
|
*/
|
|
48837
|
-
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>;
|
|
48838
48840
|
|
|
48839
48841
|
/**
|
|
48840
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.
|
|
@@ -48851,85 +48853,85 @@ export interface ConfigManagementApiInterface {
|
|
|
48851
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.
|
|
48852
48854
|
* @summary Create or update a channel\'s Nets config (Munchi admins only)
|
|
48853
48855
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48854
|
-
* @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
|
|
48855
48857
|
* @param {UpsertNetsDto} upsertNetsDto
|
|
48856
48858
|
* @param {*} [options] Override http request option.
|
|
48857
48859
|
* @throws {RequiredError}
|
|
48858
48860
|
* @memberof ConfigManagementApiInterface
|
|
48859
48861
|
*/
|
|
48860
|
-
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>;
|
|
48861
48863
|
|
|
48862
48864
|
/**
|
|
48863
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.
|
|
48864
48866
|
* @summary Create or update a channel\'s Nexi config (Munchi admins only)
|
|
48865
48867
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48866
|
-
* @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
|
|
48867
48869
|
* @param {UpsertNexiDto} upsertNexiDto
|
|
48868
48870
|
* @param {*} [options] Override http request option.
|
|
48869
48871
|
* @throws {RequiredError}
|
|
48870
48872
|
* @memberof ConfigManagementApiInterface
|
|
48871
48873
|
*/
|
|
48872
|
-
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>;
|
|
48873
48875
|
|
|
48874
48876
|
/**
|
|
48875
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.
|
|
48876
48878
|
* @summary Create or update a channel\'s checkout payment options
|
|
48877
48879
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48878
|
-
* @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
|
|
48879
48881
|
* @param {UpsertPaymentOptionsDto} upsertPaymentOptionsDto
|
|
48880
48882
|
* @param {*} [options] Override http request option.
|
|
48881
48883
|
* @throws {RequiredError}
|
|
48882
48884
|
* @memberof ConfigManagementApiInterface
|
|
48883
48885
|
*/
|
|
48884
|
-
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>;
|
|
48885
48887
|
|
|
48886
48888
|
/**
|
|
48887
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.
|
|
48888
48890
|
* @summary Set active provider and upsert its credentials (Munchi admins only)
|
|
48889
48891
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48890
|
-
* @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
|
|
48891
48893
|
* @param {UpsertProvidersDto} upsertProvidersDto
|
|
48892
48894
|
* @param {*} [options] Override http request option.
|
|
48893
48895
|
* @throws {RequiredError}
|
|
48894
48896
|
* @memberof ConfigManagementApiInterface
|
|
48895
48897
|
*/
|
|
48896
|
-
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>;
|
|
48897
48899
|
|
|
48898
48900
|
/**
|
|
48899
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.
|
|
48900
48902
|
* @summary Create or update a channel\'s Stripe config (Munchi admins only)
|
|
48901
48903
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48902
|
-
* @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
|
|
48903
48905
|
* @param {UpsertStripeDto} upsertStripeDto
|
|
48904
48906
|
* @param {*} [options] Override http request option.
|
|
48905
48907
|
* @throws {RequiredError}
|
|
48906
48908
|
* @memberof ConfigManagementApiInterface
|
|
48907
48909
|
*/
|
|
48908
|
-
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>;
|
|
48909
48911
|
|
|
48910
48912
|
/**
|
|
48911
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.
|
|
48912
48914
|
* @summary Create or update a channel\'s Viva config (Munchi admins only)
|
|
48913
48915
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48914
|
-
* @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
|
|
48915
48917
|
* @param {UpsertVivaDto} upsertVivaDto
|
|
48916
48918
|
* @param {*} [options] Override http request option.
|
|
48917
48919
|
* @throws {RequiredError}
|
|
48918
48920
|
* @memberof ConfigManagementApiInterface
|
|
48919
48921
|
*/
|
|
48920
|
-
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>;
|
|
48921
48923
|
|
|
48922
48924
|
/**
|
|
48923
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.
|
|
48924
48926
|
* @summary Create or update a channel\'s Worldline config (Munchi admins only)
|
|
48925
48927
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48926
|
-
* @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
|
|
48927
48929
|
* @param {UpsertWorldlineDto} upsertWorldlineDto
|
|
48928
48930
|
* @param {*} [options] Override http request option.
|
|
48929
48931
|
* @throws {RequiredError}
|
|
48930
48932
|
* @memberof ConfigManagementApiInterface
|
|
48931
48933
|
*/
|
|
48932
|
-
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>;
|
|
48933
48935
|
|
|
48934
48936
|
}
|
|
48935
48937
|
|
|
@@ -48944,13 +48946,13 @@ export class ConfigManagementApi extends BaseAPI implements ConfigManagementApiI
|
|
|
48944
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.
|
|
48945
48947
|
* @summary Enable or disable first-party Munchi GiftCard integration
|
|
48946
48948
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48947
|
-
* @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
|
|
48948
48950
|
* @param {ConfigureMunchiGiftCardDto} configureMunchiGiftCardDto
|
|
48949
48951
|
* @param {*} [options] Override http request option.
|
|
48950
48952
|
* @throws {RequiredError}
|
|
48951
48953
|
* @memberof ConfigManagementApi
|
|
48952
48954
|
*/
|
|
48953
|
-
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) {
|
|
48954
48956
|
return ConfigManagementApiFp(this.configuration).configConfigureMunchiGiftCard(businessId, xAppX, configureMunchiGiftCardDto, options).then((request) => request(this.axios, this.basePath));
|
|
48955
48957
|
}
|
|
48956
48958
|
|
|
@@ -48958,12 +48960,12 @@ export class ConfigManagementApi extends BaseAPI implements ConfigManagementApiI
|
|
|
48958
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).
|
|
48959
48961
|
* @summary Read a channel\'s card payment providers
|
|
48960
48962
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48961
|
-
* @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
|
|
48962
48964
|
* @param {*} [options] Override http request option.
|
|
48963
48965
|
* @throws {RequiredError}
|
|
48964
48966
|
* @memberof ConfigManagementApi
|
|
48965
48967
|
*/
|
|
48966
|
-
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) {
|
|
48967
48969
|
return ConfigManagementApiFp(this.configuration).configGetProviders(businessId, xAppX, options).then((request) => request(this.axios, this.basePath));
|
|
48968
48970
|
}
|
|
48969
48971
|
|
|
@@ -48985,12 +48987,12 @@ export class ConfigManagementApi extends BaseAPI implements ConfigManagementApiI
|
|
|
48985
48987
|
* @summary Remove payment option
|
|
48986
48988
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
48987
48989
|
* @param {string} id The payment option\'s id
|
|
48988
|
-
* @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
|
|
48989
48991
|
* @param {*} [options] Override http request option.
|
|
48990
48992
|
* @throws {RequiredError}
|
|
48991
48993
|
* @memberof ConfigManagementApi
|
|
48992
48994
|
*/
|
|
48993
|
-
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) {
|
|
48994
48996
|
return ConfigManagementApiFp(this.configuration).configRemovePaymentOption(businessId, id, xAppX, options).then((request) => request(this.axios, this.basePath));
|
|
48995
48997
|
}
|
|
48996
48998
|
|
|
@@ -48998,14 +49000,14 @@ export class ConfigManagementApi extends BaseAPI implements ConfigManagementApiI
|
|
|
48998
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.
|
|
48999
49001
|
* @summary Save a channel\'s Epassi credentials and answer the public key to send Epassi (Munchi admins only)
|
|
49000
49002
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
49001
|
-
* @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
|
|
49002
49004
|
* @param {string} xEpassiAccessKey The access key Epassi issued for this venue; Epassi issues a different one for test and production.
|
|
49003
49005
|
* @param {SaveEpassiCredentialsDto} saveEpassiCredentialsDto
|
|
49004
49006
|
* @param {*} [options] Override http request option.
|
|
49005
49007
|
* @throws {RequiredError}
|
|
49006
49008
|
* @memberof ConfigManagementApi
|
|
49007
49009
|
*/
|
|
49008
|
-
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) {
|
|
49009
49011
|
return ConfigManagementApiFp(this.configuration).configSaveEpassiCredentials(businessId, xAppX, xEpassiAccessKey, saveEpassiCredentialsDto, options).then((request) => request(this.axios, this.basePath));
|
|
49010
49012
|
}
|
|
49011
49013
|
|
|
@@ -49026,13 +49028,13 @@ export class ConfigManagementApi extends BaseAPI implements ConfigManagementApiI
|
|
|
49026
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.
|
|
49027
49029
|
* @summary Create or update a channel\'s config
|
|
49028
49030
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
49029
|
-
* @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
|
|
49030
49032
|
* @param {UpsertConfigDto} upsertConfigDto
|
|
49031
49033
|
* @param {*} [options] Override http request option.
|
|
49032
49034
|
* @throws {RequiredError}
|
|
49033
49035
|
* @memberof ConfigManagementApi
|
|
49034
49036
|
*/
|
|
49035
|
-
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) {
|
|
49036
49038
|
return ConfigManagementApiFp(this.configuration).configUpsertChannelConfig(businessId, xAppX, upsertConfigDto, options).then((request) => request(this.axios, this.basePath));
|
|
49037
49039
|
}
|
|
49038
49040
|
|
|
@@ -49040,13 +49042,13 @@ export class ConfigManagementApi extends BaseAPI implements ConfigManagementApiI
|
|
|
49040
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.
|
|
49041
49043
|
* @summary Create or update a channel\'s third-party gift card integration
|
|
49042
49044
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
49043
|
-
* @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
|
|
49044
49046
|
* @param {UpsertGiftCardDto} upsertGiftCardDto
|
|
49045
49047
|
* @param {*} [options] Override http request option.
|
|
49046
49048
|
* @throws {RequiredError}
|
|
49047
49049
|
* @memberof ConfigManagementApi
|
|
49048
49050
|
*/
|
|
49049
|
-
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) {
|
|
49050
49052
|
return ConfigManagementApiFp(this.configuration).configUpsertGiftCard(businessId, xAppX, upsertGiftCardDto, options).then((request) => request(this.axios, this.basePath));
|
|
49051
49053
|
}
|
|
49052
49054
|
|
|
@@ -49067,13 +49069,13 @@ export class ConfigManagementApi extends BaseAPI implements ConfigManagementApiI
|
|
|
49067
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.
|
|
49068
49070
|
* @summary Create or update a channel\'s Nets config (Munchi admins only)
|
|
49069
49071
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
49070
|
-
* @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
|
|
49071
49073
|
* @param {UpsertNetsDto} upsertNetsDto
|
|
49072
49074
|
* @param {*} [options] Override http request option.
|
|
49073
49075
|
* @throws {RequiredError}
|
|
49074
49076
|
* @memberof ConfigManagementApi
|
|
49075
49077
|
*/
|
|
49076
|
-
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) {
|
|
49077
49079
|
return ConfigManagementApiFp(this.configuration).configUpsertNets(businessId, xAppX, upsertNetsDto, options).then((request) => request(this.axios, this.basePath));
|
|
49078
49080
|
}
|
|
49079
49081
|
|
|
@@ -49081,13 +49083,13 @@ export class ConfigManagementApi extends BaseAPI implements ConfigManagementApiI
|
|
|
49081
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.
|
|
49082
49084
|
* @summary Create or update a channel\'s Nexi config (Munchi admins only)
|
|
49083
49085
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
49084
|
-
* @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
|
|
49085
49087
|
* @param {UpsertNexiDto} upsertNexiDto
|
|
49086
49088
|
* @param {*} [options] Override http request option.
|
|
49087
49089
|
* @throws {RequiredError}
|
|
49088
49090
|
* @memberof ConfigManagementApi
|
|
49089
49091
|
*/
|
|
49090
|
-
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) {
|
|
49091
49093
|
return ConfigManagementApiFp(this.configuration).configUpsertNexi(businessId, xAppX, upsertNexiDto, options).then((request) => request(this.axios, this.basePath));
|
|
49092
49094
|
}
|
|
49093
49095
|
|
|
@@ -49095,13 +49097,13 @@ export class ConfigManagementApi extends BaseAPI implements ConfigManagementApiI
|
|
|
49095
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.
|
|
49096
49098
|
* @summary Create or update a channel\'s checkout payment options
|
|
49097
49099
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
49098
|
-
* @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
|
|
49099
49101
|
* @param {UpsertPaymentOptionsDto} upsertPaymentOptionsDto
|
|
49100
49102
|
* @param {*} [options] Override http request option.
|
|
49101
49103
|
* @throws {RequiredError}
|
|
49102
49104
|
* @memberof ConfigManagementApi
|
|
49103
49105
|
*/
|
|
49104
|
-
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) {
|
|
49105
49107
|
return ConfigManagementApiFp(this.configuration).configUpsertPaymentOptions(businessId, xAppX, upsertPaymentOptionsDto, options).then((request) => request(this.axios, this.basePath));
|
|
49106
49108
|
}
|
|
49107
49109
|
|
|
@@ -49109,13 +49111,13 @@ export class ConfigManagementApi extends BaseAPI implements ConfigManagementApiI
|
|
|
49109
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.
|
|
49110
49112
|
* @summary Set active provider and upsert its credentials (Munchi admins only)
|
|
49111
49113
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
49112
|
-
* @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
|
|
49113
49115
|
* @param {UpsertProvidersDto} upsertProvidersDto
|
|
49114
49116
|
* @param {*} [options] Override http request option.
|
|
49115
49117
|
* @throws {RequiredError}
|
|
49116
49118
|
* @memberof ConfigManagementApi
|
|
49117
49119
|
*/
|
|
49118
|
-
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) {
|
|
49119
49121
|
return ConfigManagementApiFp(this.configuration).configUpsertProviders(businessId, xAppX, upsertProvidersDto, options).then((request) => request(this.axios, this.basePath));
|
|
49120
49122
|
}
|
|
49121
49123
|
|
|
@@ -49123,13 +49125,13 @@ export class ConfigManagementApi extends BaseAPI implements ConfigManagementApiI
|
|
|
49123
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.
|
|
49124
49126
|
* @summary Create or update a channel\'s Stripe config (Munchi admins only)
|
|
49125
49127
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
49126
|
-
* @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
|
|
49127
49129
|
* @param {UpsertStripeDto} upsertStripeDto
|
|
49128
49130
|
* @param {*} [options] Override http request option.
|
|
49129
49131
|
* @throws {RequiredError}
|
|
49130
49132
|
* @memberof ConfigManagementApi
|
|
49131
49133
|
*/
|
|
49132
|
-
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) {
|
|
49133
49135
|
return ConfigManagementApiFp(this.configuration).configUpsertStripe(businessId, xAppX, upsertStripeDto, options).then((request) => request(this.axios, this.basePath));
|
|
49134
49136
|
}
|
|
49135
49137
|
|
|
@@ -49137,13 +49139,13 @@ export class ConfigManagementApi extends BaseAPI implements ConfigManagementApiI
|
|
|
49137
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.
|
|
49138
49140
|
* @summary Create or update a channel\'s Viva config (Munchi admins only)
|
|
49139
49141
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
49140
|
-
* @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
|
|
49141
49143
|
* @param {UpsertVivaDto} upsertVivaDto
|
|
49142
49144
|
* @param {*} [options] Override http request option.
|
|
49143
49145
|
* @throws {RequiredError}
|
|
49144
49146
|
* @memberof ConfigManagementApi
|
|
49145
49147
|
*/
|
|
49146
|
-
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) {
|
|
49147
49149
|
return ConfigManagementApiFp(this.configuration).configUpsertViva(businessId, xAppX, upsertVivaDto, options).then((request) => request(this.axios, this.basePath));
|
|
49148
49150
|
}
|
|
49149
49151
|
|
|
@@ -49151,13 +49153,13 @@ export class ConfigManagementApi extends BaseAPI implements ConfigManagementApiI
|
|
|
49151
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.
|
|
49152
49154
|
* @summary Create or update a channel\'s Worldline config (Munchi admins only)
|
|
49153
49155
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
49154
|
-
* @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
|
|
49155
49157
|
* @param {UpsertWorldlineDto} upsertWorldlineDto
|
|
49156
49158
|
* @param {*} [options] Override http request option.
|
|
49157
49159
|
* @throws {RequiredError}
|
|
49158
49160
|
* @memberof ConfigManagementApi
|
|
49159
49161
|
*/
|
|
49160
|
-
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) {
|
|
49161
49163
|
return ConfigManagementApiFp(this.configuration).configUpsertWorldline(businessId, xAppX, upsertWorldlineDto, options).then((request) => request(this.axios, this.basePath));
|
|
49162
49164
|
}
|
|
49163
49165
|
}
|
|
@@ -64337,7 +64339,7 @@ export class PaymentMethodsApi extends BaseAPI implements PaymentMethodsApiInter
|
|
|
64337
64339
|
export const PaymentSessionApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
64338
64340
|
return {
|
|
64339
64341
|
/**
|
|
64340
|
-
* 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.
|
|
64341
64343
|
* @summary Cancel an in-flight card payment session (Viva or Nets)
|
|
64342
64344
|
* @param {string} clientToken The token the initiate answered for the session.
|
|
64343
64345
|
* @param {*} [options] Override http request option.
|
|
@@ -64624,7 +64626,7 @@ export const PaymentSessionApiAxiosParamCreator = function (configuration?: Conf
|
|
|
64624
64626
|
};
|
|
64625
64627
|
},
|
|
64626
64628
|
/**
|
|
64627
|
-
* 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).
|
|
64628
64630
|
* @summary Start a card payment on the station\'s Nexi terminal
|
|
64629
64631
|
* @param {InitiateNexiSessionDto} initiateNexiSessionDto
|
|
64630
64632
|
* @param {string} [xIdempotencyKey] A UUID the app makes for this payment. A repeated key answers the session it started, without charging again.
|
|
@@ -65138,6 +65140,47 @@ export const PaymentSessionApiAxiosParamCreator = function (configuration?: Conf
|
|
|
65138
65140
|
|
|
65139
65141
|
|
|
65140
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
|
+
|
|
65141
65184
|
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
65142
65185
|
|
|
65143
65186
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -65318,6 +65361,42 @@ export const PaymentSessionApiAxiosParamCreator = function (configuration?: Conf
|
|
|
65318
65361
|
|
|
65319
65362
|
|
|
65320
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
|
+
|
|
65321
65400
|
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
65322
65401
|
|
|
65323
65402
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -65521,7 +65600,7 @@ export const PaymentSessionApiFp = function(configuration?: Configuration) {
|
|
|
65521
65600
|
const localVarAxiosParamCreator = PaymentSessionApiAxiosParamCreator(configuration)
|
|
65522
65601
|
return {
|
|
65523
65602
|
/**
|
|
65524
|
-
* 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.
|
|
65525
65604
|
* @summary Cancel an in-flight card payment session (Viva or Nets)
|
|
65526
65605
|
* @param {string} clientToken The token the initiate answered for the session.
|
|
65527
65606
|
* @param {*} [options] Override http request option.
|
|
@@ -65606,7 +65685,7 @@ export const PaymentSessionApiFp = function(configuration?: Configuration) {
|
|
|
65606
65685
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
65607
65686
|
},
|
|
65608
65687
|
/**
|
|
65609
|
-
* 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).
|
|
65610
65689
|
* @summary Start a card payment on the station\'s Nexi terminal
|
|
65611
65690
|
* @param {InitiateNexiSessionDto} initiateNexiSessionDto
|
|
65612
65691
|
* @param {string} [xIdempotencyKey] A UUID the app makes for this payment. A repeated key answers the session it started, without charging again.
|
|
@@ -65764,6 +65843,18 @@ export const PaymentSessionApiFp = function(configuration?: Configuration) {
|
|
|
65764
65843
|
const localVarAxiosArgs = await localVarAxiosParamCreator.refundNetsSession(reverseSessionDto, options);
|
|
65765
65844
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
65766
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
|
+
},
|
|
65767
65858
|
/**
|
|
65768
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.
|
|
65769
65860
|
* @summary Refund a settled Viva payment session (gateway only)
|
|
@@ -65819,6 +65910,17 @@ export const PaymentSessionApiFp = function(configuration?: Configuration) {
|
|
|
65819
65910
|
const localVarAxiosArgs = await localVarAxiosParamCreator.revertNetsSession(reverseSessionDto, options);
|
|
65820
65911
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
65821
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
|
+
},
|
|
65822
65924
|
/**
|
|
65823
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.
|
|
65824
65926
|
* @summary Revert (fully reverse) a settled Viva payment session
|
|
@@ -65885,7 +65987,7 @@ export const PaymentSessionApiFactory = function (configuration?: Configuration,
|
|
|
65885
65987
|
const localVarFp = PaymentSessionApiFp(configuration)
|
|
65886
65988
|
return {
|
|
65887
65989
|
/**
|
|
65888
|
-
* 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.
|
|
65889
65991
|
* @summary Cancel an in-flight card payment session (Viva or Nets)
|
|
65890
65992
|
* @param {string} clientToken The token the initiate answered for the session.
|
|
65891
65993
|
* @param {*} [options] Override http request option.
|
|
@@ -65963,7 +66065,7 @@ export const PaymentSessionApiFactory = function (configuration?: Configuration,
|
|
|
65963
66065
|
return localVarFp.initiateNetsSession(initiateNetsSessionDto, xIdempotencyKey, options).then((request) => request(axios, basePath));
|
|
65964
66066
|
},
|
|
65965
66067
|
/**
|
|
65966
|
-
* 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).
|
|
65967
66069
|
* @summary Start a card payment on the station\'s Nexi terminal
|
|
65968
66070
|
* @param {InitiateNexiSessionDto} initiateNexiSessionDto
|
|
65969
66071
|
* @param {string} [xIdempotencyKey] A UUID the app makes for this payment. A repeated key answers the session it started, without charging again.
|
|
@@ -66107,6 +66209,17 @@ export const PaymentSessionApiFactory = function (configuration?: Configuration,
|
|
|
66107
66209
|
refundNetsSession(reverseSessionDto: ReverseSessionDto, options?: any): AxiosPromise<PaymentSessionViewDto> {
|
|
66108
66210
|
return localVarFp.refundNetsSession(reverseSessionDto, options).then((request) => request(axios, basePath));
|
|
66109
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
|
+
},
|
|
66110
66223
|
/**
|
|
66111
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.
|
|
66112
66225
|
* @summary Refund a settled Viva payment session (gateway only)
|
|
@@ -66157,6 +66270,16 @@ export const PaymentSessionApiFactory = function (configuration?: Configuration,
|
|
|
66157
66270
|
revertNetsSession(reverseSessionDto: ReverseSessionDto, options?: any): AxiosPromise<NetsRevertResponseDto> {
|
|
66158
66271
|
return localVarFp.revertNetsSession(reverseSessionDto, options).then((request) => request(axios, basePath));
|
|
66159
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
|
+
},
|
|
66160
66283
|
/**
|
|
66161
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.
|
|
66162
66285
|
* @summary Revert (fully reverse) a settled Viva payment session
|
|
@@ -66217,7 +66340,7 @@ export const PaymentSessionApiFactory = function (configuration?: Configuration,
|
|
|
66217
66340
|
*/
|
|
66218
66341
|
export interface PaymentSessionApiInterface {
|
|
66219
66342
|
/**
|
|
66220
|
-
* 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.
|
|
66221
66344
|
* @summary Cancel an in-flight card payment session (Viva or Nets)
|
|
66222
66345
|
* @param {string} clientToken The token the initiate answered for the session.
|
|
66223
66346
|
* @param {*} [options] Override http request option.
|
|
@@ -66295,7 +66418,7 @@ export interface PaymentSessionApiInterface {
|
|
|
66295
66418
|
initiateNetsSession(initiateNetsSessionDto: InitiateNetsSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): AxiosPromise<InitiateNetsSessionResponseDto>;
|
|
66296
66419
|
|
|
66297
66420
|
/**
|
|
66298
|
-
* 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).
|
|
66299
66422
|
* @summary Start a card payment on the station\'s Nexi terminal
|
|
66300
66423
|
* @param {InitiateNexiSessionDto} initiateNexiSessionDto
|
|
66301
66424
|
* @param {string} [xIdempotencyKey] A UUID the app makes for this payment. A repeated key answers the session it started, without charging again.
|
|
@@ -66439,6 +66562,17 @@ export interface PaymentSessionApiInterface {
|
|
|
66439
66562
|
*/
|
|
66440
66563
|
refundNetsSession(reverseSessionDto: ReverseSessionDto, options?: AxiosRequestConfig): AxiosPromise<PaymentSessionViewDto>;
|
|
66441
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
|
+
|
|
66442
66576
|
/**
|
|
66443
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.
|
|
66444
66578
|
* @summary Refund a settled Viva payment session (gateway only)
|
|
@@ -66489,6 +66623,16 @@ export interface PaymentSessionApiInterface {
|
|
|
66489
66623
|
*/
|
|
66490
66624
|
revertNetsSession(reverseSessionDto: ReverseSessionDto, options?: AxiosRequestConfig): AxiosPromise<NetsRevertResponseDto>;
|
|
66491
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
|
+
|
|
66492
66636
|
/**
|
|
66493
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.
|
|
66494
66638
|
* @summary Revert (fully reverse) a settled Viva payment session
|
|
@@ -66549,7 +66693,7 @@ export interface PaymentSessionApiInterface {
|
|
|
66549
66693
|
*/
|
|
66550
66694
|
export class PaymentSessionApi extends BaseAPI implements PaymentSessionApiInterface {
|
|
66551
66695
|
/**
|
|
66552
|
-
* 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.
|
|
66553
66697
|
* @summary Cancel an in-flight card payment session (Viva or Nets)
|
|
66554
66698
|
* @param {string} clientToken The token the initiate answered for the session.
|
|
66555
66699
|
* @param {*} [options] Override http request option.
|
|
@@ -66641,7 +66785,7 @@ export class PaymentSessionApi extends BaseAPI implements PaymentSessionApiInter
|
|
|
66641
66785
|
}
|
|
66642
66786
|
|
|
66643
66787
|
/**
|
|
66644
|
-
* 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).
|
|
66645
66789
|
* @summary Start a card payment on the station\'s Nexi terminal
|
|
66646
66790
|
* @param {InitiateNexiSessionDto} initiateNexiSessionDto
|
|
66647
66791
|
* @param {string} [xIdempotencyKey] A UUID the app makes for this payment. A repeated key answers the session it started, without charging again.
|
|
@@ -66813,6 +66957,19 @@ export class PaymentSessionApi extends BaseAPI implements PaymentSessionApiInter
|
|
|
66813
66957
|
return PaymentSessionApiFp(this.configuration).refundNetsSession(reverseSessionDto, options).then((request) => request(this.axios, this.basePath));
|
|
66814
66958
|
}
|
|
66815
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
|
+
|
|
66816
66973
|
/**
|
|
66817
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.
|
|
66818
66975
|
* @summary Refund a settled Viva payment session (gateway only)
|
|
@@ -66873,6 +67030,18 @@ export class PaymentSessionApi extends BaseAPI implements PaymentSessionApiInter
|
|
|
66873
67030
|
return PaymentSessionApiFp(this.configuration).revertNetsSession(reverseSessionDto, options).then((request) => request(this.axios, this.basePath));
|
|
66874
67031
|
}
|
|
66875
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
|
+
|
|
66876
67045
|
/**
|
|
66877
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.
|
|
66878
67047
|
* @summary Revert (fully reverse) a settled Viva payment session
|
|
@@ -68815,11 +68984,11 @@ export const ReceiptFooterApiAxiosParamCreator = function (configuration?: Confi
|
|
|
68815
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.
|
|
68816
68985
|
* @summary Get the receipt footer config for a business + channel
|
|
68817
68986
|
* @param {number} businessId The venue whose footer is read or written: its orderingBusinessId
|
|
68818
|
-
* @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
|
|
68819
68988
|
* @param {*} [options] Override http request option.
|
|
68820
68989
|
* @throws {RequiredError}
|
|
68821
68990
|
*/
|
|
68822
|
-
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> => {
|
|
68823
68992
|
// verify required parameter 'businessId' is not null or undefined
|
|
68824
68993
|
assertParamExists('receiptFooterGetConfig', 'businessId', businessId)
|
|
68825
68994
|
// verify required parameter 'xAppX' is not null or undefined
|
|
@@ -68860,12 +69029,12 @@ export const ReceiptFooterApiAxiosParamCreator = function (configuration?: Confi
|
|
|
68860
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.
|
|
68861
69030
|
* @summary Create or update the receipt footer config for a business + channel
|
|
68862
69031
|
* @param {number} businessId The venue whose footer is read or written: its orderingBusinessId
|
|
68863
|
-
* @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
|
|
68864
69033
|
* @param {UpsertReceiptFooterDto} upsertReceiptFooterDto
|
|
68865
69034
|
* @param {*} [options] Override http request option.
|
|
68866
69035
|
* @throws {RequiredError}
|
|
68867
69036
|
*/
|
|
68868
|
-
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> => {
|
|
68869
69038
|
// verify required parameter 'businessId' is not null or undefined
|
|
68870
69039
|
assertParamExists('receiptFooterUpsertConfig', 'businessId', businessId)
|
|
68871
69040
|
// verify required parameter 'xAppX' is not null or undefined
|
|
@@ -68921,11 +69090,11 @@ export const ReceiptFooterApiFp = function(configuration?: Configuration) {
|
|
|
68921
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.
|
|
68922
69091
|
* @summary Get the receipt footer config for a business + channel
|
|
68923
69092
|
* @param {number} businessId The venue whose footer is read or written: its orderingBusinessId
|
|
68924
|
-
* @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
|
|
68925
69094
|
* @param {*} [options] Override http request option.
|
|
68926
69095
|
* @throws {RequiredError}
|
|
68927
69096
|
*/
|
|
68928
|
-
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>> {
|
|
68929
69098
|
const localVarAxiosArgs = await localVarAxiosParamCreator.receiptFooterGetConfig(businessId, xAppX, options);
|
|
68930
69099
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
68931
69100
|
},
|
|
@@ -68933,12 +69102,12 @@ export const ReceiptFooterApiFp = function(configuration?: Configuration) {
|
|
|
68933
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.
|
|
68934
69103
|
* @summary Create or update the receipt footer config for a business + channel
|
|
68935
69104
|
* @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
|
|
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
|
|
68937
69106
|
* @param {UpsertReceiptFooterDto} upsertReceiptFooterDto
|
|
68938
69107
|
* @param {*} [options] Override http request option.
|
|
68939
69108
|
* @throws {RequiredError}
|
|
68940
69109
|
*/
|
|
68941
|
-
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>> {
|
|
68942
69111
|
const localVarAxiosArgs = await localVarAxiosParamCreator.receiptFooterUpsertConfig(businessId, xAppX, upsertReceiptFooterDto, options);
|
|
68943
69112
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
68944
69113
|
},
|
|
@@ -68956,23 +69125,23 @@ export const ReceiptFooterApiFactory = function (configuration?: Configuration,
|
|
|
68956
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.
|
|
68957
69126
|
* @summary Get the receipt footer config for a business + channel
|
|
68958
69127
|
* @param {number} businessId The venue whose footer is read or written: its orderingBusinessId
|
|
68959
|
-
* @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
|
|
68960
69129
|
* @param {*} [options] Override http request option.
|
|
68961
69130
|
* @throws {RequiredError}
|
|
68962
69131
|
*/
|
|
68963
|
-
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> {
|
|
68964
69133
|
return localVarFp.receiptFooterGetConfig(businessId, xAppX, options).then((request) => request(axios, basePath));
|
|
68965
69134
|
},
|
|
68966
69135
|
/**
|
|
68967
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.
|
|
68968
69137
|
* @summary Create or update the receipt footer config for a business + channel
|
|
68969
69138
|
* @param {number} businessId The venue whose footer is read or written: its orderingBusinessId
|
|
68970
|
-
* @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
|
|
68971
69140
|
* @param {UpsertReceiptFooterDto} upsertReceiptFooterDto
|
|
68972
69141
|
* @param {*} [options] Override http request option.
|
|
68973
69142
|
* @throws {RequiredError}
|
|
68974
69143
|
*/
|
|
68975
|
-
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> {
|
|
68976
69145
|
return localVarFp.receiptFooterUpsertConfig(businessId, xAppX, upsertReceiptFooterDto, options).then((request) => request(axios, basePath));
|
|
68977
69146
|
},
|
|
68978
69147
|
};
|
|
@@ -68988,24 +69157,24 @@ export interface ReceiptFooterApiInterface {
|
|
|
68988
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.
|
|
68989
69158
|
* @summary Get the receipt footer config for a business + channel
|
|
68990
69159
|
* @param {number} businessId The venue whose footer is read or written: its orderingBusinessId
|
|
68991
|
-
* @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
|
|
68992
69161
|
* @param {*} [options] Override http request option.
|
|
68993
69162
|
* @throws {RequiredError}
|
|
68994
69163
|
* @memberof ReceiptFooterApiInterface
|
|
68995
69164
|
*/
|
|
68996
|
-
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>;
|
|
68997
69166
|
|
|
68998
69167
|
/**
|
|
68999
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.
|
|
69000
69169
|
* @summary Create or update the receipt footer config for a business + channel
|
|
69001
69170
|
* @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
|
|
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
|
|
69003
69172
|
* @param {UpsertReceiptFooterDto} upsertReceiptFooterDto
|
|
69004
69173
|
* @param {*} [options] Override http request option.
|
|
69005
69174
|
* @throws {RequiredError}
|
|
69006
69175
|
* @memberof ReceiptFooterApiInterface
|
|
69007
69176
|
*/
|
|
69008
|
-
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>;
|
|
69009
69178
|
|
|
69010
69179
|
}
|
|
69011
69180
|
|
|
@@ -69020,12 +69189,12 @@ export class ReceiptFooterApi extends BaseAPI implements ReceiptFooterApiInterfa
|
|
|
69020
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.
|
|
69021
69190
|
* @summary Get the receipt footer config for a business + channel
|
|
69022
69191
|
* @param {number} businessId The venue whose footer is read or written: its orderingBusinessId
|
|
69023
|
-
* @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
|
|
69024
69193
|
* @param {*} [options] Override http request option.
|
|
69025
69194
|
* @throws {RequiredError}
|
|
69026
69195
|
* @memberof ReceiptFooterApi
|
|
69027
69196
|
*/
|
|
69028
|
-
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) {
|
|
69029
69198
|
return ReceiptFooterApiFp(this.configuration).receiptFooterGetConfig(businessId, xAppX, options).then((request) => request(this.axios, this.basePath));
|
|
69030
69199
|
}
|
|
69031
69200
|
|
|
@@ -69033,13 +69202,13 @@ export class ReceiptFooterApi extends BaseAPI implements ReceiptFooterApiInterfa
|
|
|
69033
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.
|
|
69034
69203
|
* @summary Create or update the receipt footer config for a business + channel
|
|
69035
69204
|
* @param {number} businessId The venue whose footer is read or written: its orderingBusinessId
|
|
69036
|
-
* @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
|
|
69037
69206
|
* @param {UpsertReceiptFooterDto} upsertReceiptFooterDto
|
|
69038
69207
|
* @param {*} [options] Override http request option.
|
|
69039
69208
|
* @throws {RequiredError}
|
|
69040
69209
|
* @memberof ReceiptFooterApi
|
|
69041
69210
|
*/
|
|
69042
|
-
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) {
|
|
69043
69212
|
return ReceiptFooterApiFp(this.configuration).receiptFooterUpsertConfig(businessId, xAppX, upsertReceiptFooterDto, options).then((request) => request(this.axios, this.basePath));
|
|
69044
69213
|
}
|
|
69045
69214
|
}
|