@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/dist/generated/api.d.ts
CHANGED
|
@@ -2874,6 +2874,7 @@ export declare const ChannelEnum: {
|
|
|
2874
2874
|
readonly Storefront: "Storefront";
|
|
2875
2875
|
readonly MunchiPay: "MunchiPay";
|
|
2876
2876
|
readonly ResQ: "ResQ";
|
|
2877
|
+
readonly Partner: "Partner";
|
|
2877
2878
|
};
|
|
2878
2879
|
export type ChannelEnum = typeof ChannelEnum[keyof typeof ChannelEnum];
|
|
2879
2880
|
/**
|
|
@@ -24928,6 +24929,7 @@ export declare const ProviderEnum: {
|
|
|
24928
24929
|
readonly Storefront: "Storefront";
|
|
24929
24930
|
readonly MunchiPay: "MunchiPay";
|
|
24930
24931
|
readonly ResQ: "ResQ";
|
|
24932
|
+
readonly Partner: "Partner";
|
|
24931
24933
|
};
|
|
24932
24934
|
export type ProviderEnum = typeof ProviderEnum[keyof typeof ProviderEnum];
|
|
24933
24935
|
/**
|
|
@@ -28642,7 +28644,7 @@ export interface ReverseSessionDto {
|
|
|
28642
28644
|
*/
|
|
28643
28645
|
'sessionId': string;
|
|
28644
28646
|
/**
|
|
28645
|
-
* 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.
|
|
28647
|
+
* 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.
|
|
28646
28648
|
* @type {number}
|
|
28647
28649
|
* @memberof ReverseSessionDto
|
|
28648
28650
|
*/
|
|
@@ -43840,11 +43842,11 @@ export declare const CashManagementApiAxiosParamCreator: (configuration?: Config
|
|
|
43840
43842
|
* @param {string} businessId The venue\'s id (its orderingBusinessId), as text
|
|
43841
43843
|
* @param {string} sessionId The cash session\'s id
|
|
43842
43844
|
* @param {SendCashReportDto} sendCashReportDto
|
|
43843
|
-
* @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.
|
|
43845
|
+
* @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.
|
|
43844
43846
|
* @param {*} [options] Override http request option.
|
|
43845
43847
|
* @throws {RequiredError}
|
|
43846
43848
|
*/
|
|
43847
|
-
sendSessionReport: (businessId: string, sessionId: string, sendCashReportDto: SendCashReportDto, xAppX?: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
43849
|
+
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<RequestArgs>;
|
|
43848
43850
|
};
|
|
43849
43851
|
/**
|
|
43850
43852
|
* CashManagementApi - functional programming interface
|
|
@@ -43906,11 +43908,11 @@ export declare const CashManagementApiFp: (configuration?: Configuration) => {
|
|
|
43906
43908
|
* @param {string} businessId The venue\'s id (its orderingBusinessId), as text
|
|
43907
43909
|
* @param {string} sessionId The cash session\'s id
|
|
43908
43910
|
* @param {SendCashReportDto} sendCashReportDto
|
|
43909
|
-
* @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.
|
|
43911
|
+
* @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.
|
|
43910
43912
|
* @param {*} [options] Override http request option.
|
|
43911
43913
|
* @throws {RequiredError}
|
|
43912
43914
|
*/
|
|
43913
|
-
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>>;
|
|
43915
|
+
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>>;
|
|
43914
43916
|
};
|
|
43915
43917
|
/**
|
|
43916
43918
|
* CashManagementApi - factory interface
|
|
@@ -43972,11 +43974,11 @@ export declare const CashManagementApiFactory: (configuration?: Configuration, b
|
|
|
43972
43974
|
* @param {string} businessId The venue\'s id (its orderingBusinessId), as text
|
|
43973
43975
|
* @param {string} sessionId The cash session\'s id
|
|
43974
43976
|
* @param {SendCashReportDto} sendCashReportDto
|
|
43975
|
-
* @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.
|
|
43977
|
+
* @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.
|
|
43976
43978
|
* @param {*} [options] Override http request option.
|
|
43977
43979
|
* @throws {RequiredError}
|
|
43978
43980
|
*/
|
|
43979
|
-
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>;
|
|
43981
|
+
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>;
|
|
43980
43982
|
};
|
|
43981
43983
|
/**
|
|
43982
43984
|
* CashManagementApi - interface
|
|
@@ -44044,12 +44046,12 @@ export interface CashManagementApiInterface {
|
|
|
44044
44046
|
* @param {string} businessId The venue\'s id (its orderingBusinessId), as text
|
|
44045
44047
|
* @param {string} sessionId The cash session\'s id
|
|
44046
44048
|
* @param {SendCashReportDto} sendCashReportDto
|
|
44047
|
-
* @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.
|
|
44049
|
+
* @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.
|
|
44048
44050
|
* @param {*} [options] Override http request option.
|
|
44049
44051
|
* @throws {RequiredError}
|
|
44050
44052
|
* @memberof CashManagementApiInterface
|
|
44051
44053
|
*/
|
|
44052
|
-
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>;
|
|
44054
|
+
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>;
|
|
44053
44055
|
}
|
|
44054
44056
|
/**
|
|
44055
44057
|
* CashManagementApi - object-oriented interface
|
|
@@ -44118,12 +44120,12 @@ export declare class CashManagementApi extends BaseAPI implements CashManagement
|
|
|
44118
44120
|
* @param {string} businessId The venue\'s id (its orderingBusinessId), as text
|
|
44119
44121
|
* @param {string} sessionId The cash session\'s id
|
|
44120
44122
|
* @param {SendCashReportDto} sendCashReportDto
|
|
44121
|
-
* @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.
|
|
44123
|
+
* @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.
|
|
44122
44124
|
* @param {*} [options] Override http request option.
|
|
44123
44125
|
* @throws {RequiredError}
|
|
44124
44126
|
* @memberof CashManagementApi
|
|
44125
44127
|
*/
|
|
44126
|
-
sendSessionReport(businessId: string, sessionId: string, sendCashReportDto: SendCashReportDto, xAppX?: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CashReportSentDto, any, {}>>;
|
|
44128
|
+
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<import("axios").AxiosResponse<CashReportSentDto, any, {}>>;
|
|
44127
44129
|
}
|
|
44128
44130
|
/**
|
|
44129
44131
|
* CashManagementV6Api - axios parameter creator
|
|
@@ -44503,21 +44505,21 @@ export declare const ConfigManagementApiAxiosParamCreator: (configuration?: Conf
|
|
|
44503
44505
|
* 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.
|
|
44504
44506
|
* @summary Enable or disable first-party Munchi GiftCard integration
|
|
44505
44507
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44506
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
44508
|
+
* @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
|
|
44507
44509
|
* @param {ConfigureMunchiGiftCardDto} configureMunchiGiftCardDto
|
|
44508
44510
|
* @param {*} [options] Override http request option.
|
|
44509
44511
|
* @throws {RequiredError}
|
|
44510
44512
|
*/
|
|
44511
|
-
configConfigureMunchiGiftCard: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", configureMunchiGiftCardDto: ConfigureMunchiGiftCardDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
44513
|
+
configConfigureMunchiGiftCard: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ" | "Partner", configureMunchiGiftCardDto: ConfigureMunchiGiftCardDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
44512
44514
|
/**
|
|
44513
44515
|
* 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).
|
|
44514
44516
|
* @summary Read a channel\'s card payment providers
|
|
44515
44517
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44516
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
44518
|
+
* @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
|
|
44517
44519
|
* @param {*} [options] Override http request option.
|
|
44518
44520
|
* @throws {RequiredError}
|
|
44519
44521
|
*/
|
|
44520
|
-
configGetProviders: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
44522
|
+
configGetProviders: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ" | "Partner", options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
44521
44523
|
/**
|
|
44522
44524
|
* 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.
|
|
44523
44525
|
* @summary Manual sync trigger
|
|
@@ -44532,22 +44534,22 @@ export declare const ConfigManagementApiAxiosParamCreator: (configuration?: Conf
|
|
|
44532
44534
|
* @summary Remove payment option
|
|
44533
44535
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44534
44536
|
* @param {string} id The payment option\'s id
|
|
44535
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
44537
|
+
* @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
|
|
44536
44538
|
* @param {*} [options] Override http request option.
|
|
44537
44539
|
* @throws {RequiredError}
|
|
44538
44540
|
*/
|
|
44539
|
-
configRemovePaymentOption: (businessId: number, id: string, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
44541
|
+
configRemovePaymentOption: (businessId: number, id: string, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ" | "Partner", options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
44540
44542
|
/**
|
|
44541
44543
|
* 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.
|
|
44542
44544
|
* @summary Save a channel\'s Epassi credentials and answer the public key to send Epassi (Munchi admins only)
|
|
44543
44545
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44544
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
44546
|
+
* @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
|
|
44545
44547
|
* @param {string} xEpassiAccessKey The access key Epassi issued for this venue; Epassi issues a different one for test and production.
|
|
44546
44548
|
* @param {SaveEpassiCredentialsDto} saveEpassiCredentialsDto
|
|
44547
44549
|
* @param {*} [options] Override http request option.
|
|
44548
44550
|
* @throws {RequiredError}
|
|
44549
44551
|
*/
|
|
44550
|
-
configSaveEpassiCredentials: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", xEpassiAccessKey: string, saveEpassiCredentialsDto: SaveEpassiCredentialsDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
44552
|
+
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<RequestArgs>;
|
|
44551
44553
|
/**
|
|
44552
44554
|
* 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.
|
|
44553
44555
|
* @summary Create or update a venue
|
|
@@ -44561,22 +44563,22 @@ export declare const ConfigManagementApiAxiosParamCreator: (configuration?: Conf
|
|
|
44561
44563
|
* 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.
|
|
44562
44564
|
* @summary Create or update a channel\'s config
|
|
44563
44565
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44564
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
44566
|
+
* @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
|
|
44565
44567
|
* @param {UpsertConfigDto} upsertConfigDto
|
|
44566
44568
|
* @param {*} [options] Override http request option.
|
|
44567
44569
|
* @throws {RequiredError}
|
|
44568
44570
|
*/
|
|
44569
|
-
configUpsertChannelConfig: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertConfigDto: UpsertConfigDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
44571
|
+
configUpsertChannelConfig: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ" | "Partner", upsertConfigDto: UpsertConfigDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
44570
44572
|
/**
|
|
44571
44573
|
* 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.
|
|
44572
44574
|
* @summary Create or update a channel\'s third-party gift card integration
|
|
44573
44575
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44574
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
44576
|
+
* @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
|
|
44575
44577
|
* @param {UpsertGiftCardDto} upsertGiftCardDto
|
|
44576
44578
|
* @param {*} [options] Override http request option.
|
|
44577
44579
|
* @throws {RequiredError}
|
|
44578
44580
|
*/
|
|
44579
|
-
configUpsertGiftCard: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertGiftCardDto: UpsertGiftCardDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
44581
|
+
configUpsertGiftCard: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ" | "Partner", upsertGiftCardDto: UpsertGiftCardDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
44580
44582
|
/**
|
|
44581
44583
|
* 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.
|
|
44582
44584
|
* @summary Create or update a loyalty program and link it to a venue
|
|
@@ -44590,72 +44592,72 @@ export declare const ConfigManagementApiAxiosParamCreator: (configuration?: Conf
|
|
|
44590
44592
|
* 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.
|
|
44591
44593
|
* @summary Create or update a channel\'s Nets config (Munchi admins only)
|
|
44592
44594
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44593
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
44595
|
+
* @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
|
|
44594
44596
|
* @param {UpsertNetsDto} upsertNetsDto
|
|
44595
44597
|
* @param {*} [options] Override http request option.
|
|
44596
44598
|
* @throws {RequiredError}
|
|
44597
44599
|
*/
|
|
44598
|
-
configUpsertNets: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertNetsDto: UpsertNetsDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
44600
|
+
configUpsertNets: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ" | "Partner", upsertNetsDto: UpsertNetsDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
44599
44601
|
/**
|
|
44600
44602
|
* 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.
|
|
44601
44603
|
* @summary Create or update a channel\'s Nexi config (Munchi admins only)
|
|
44602
44604
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44603
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
44605
|
+
* @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
|
|
44604
44606
|
* @param {UpsertNexiDto} upsertNexiDto
|
|
44605
44607
|
* @param {*} [options] Override http request option.
|
|
44606
44608
|
* @throws {RequiredError}
|
|
44607
44609
|
*/
|
|
44608
|
-
configUpsertNexi: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertNexiDto: UpsertNexiDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
44610
|
+
configUpsertNexi: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ" | "Partner", upsertNexiDto: UpsertNexiDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
44609
44611
|
/**
|
|
44610
44612
|
* 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.
|
|
44611
44613
|
* @summary Create or update a channel\'s checkout payment options
|
|
44612
44614
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44613
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
44615
|
+
* @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
|
|
44614
44616
|
* @param {UpsertPaymentOptionsDto} upsertPaymentOptionsDto
|
|
44615
44617
|
* @param {*} [options] Override http request option.
|
|
44616
44618
|
* @throws {RequiredError}
|
|
44617
44619
|
*/
|
|
44618
|
-
configUpsertPaymentOptions: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertPaymentOptionsDto: UpsertPaymentOptionsDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
44620
|
+
configUpsertPaymentOptions: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ" | "Partner", upsertPaymentOptionsDto: UpsertPaymentOptionsDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
44619
44621
|
/**
|
|
44620
44622
|
* 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.
|
|
44621
44623
|
* @summary Set active provider and upsert its credentials (Munchi admins only)
|
|
44622
44624
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44623
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
44625
|
+
* @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
|
|
44624
44626
|
* @param {UpsertProvidersDto} upsertProvidersDto
|
|
44625
44627
|
* @param {*} [options] Override http request option.
|
|
44626
44628
|
* @throws {RequiredError}
|
|
44627
44629
|
*/
|
|
44628
|
-
configUpsertProviders: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertProvidersDto: UpsertProvidersDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
44630
|
+
configUpsertProviders: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ" | "Partner", upsertProvidersDto: UpsertProvidersDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
44629
44631
|
/**
|
|
44630
44632
|
* 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.
|
|
44631
44633
|
* @summary Create or update a channel\'s Stripe config (Munchi admins only)
|
|
44632
44634
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44633
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
44635
|
+
* @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
|
|
44634
44636
|
* @param {UpsertStripeDto} upsertStripeDto
|
|
44635
44637
|
* @param {*} [options] Override http request option.
|
|
44636
44638
|
* @throws {RequiredError}
|
|
44637
44639
|
*/
|
|
44638
|
-
configUpsertStripe: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertStripeDto: UpsertStripeDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
44640
|
+
configUpsertStripe: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ" | "Partner", upsertStripeDto: UpsertStripeDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
44639
44641
|
/**
|
|
44640
44642
|
* 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.
|
|
44641
44643
|
* @summary Create or update a channel\'s Viva config (Munchi admins only)
|
|
44642
44644
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44643
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
44645
|
+
* @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
|
|
44644
44646
|
* @param {UpsertVivaDto} upsertVivaDto
|
|
44645
44647
|
* @param {*} [options] Override http request option.
|
|
44646
44648
|
* @throws {RequiredError}
|
|
44647
44649
|
*/
|
|
44648
|
-
configUpsertViva: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertVivaDto: UpsertVivaDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
44650
|
+
configUpsertViva: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ" | "Partner", upsertVivaDto: UpsertVivaDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
44649
44651
|
/**
|
|
44650
44652
|
* 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.
|
|
44651
44653
|
* @summary Create or update a channel\'s Worldline config (Munchi admins only)
|
|
44652
44654
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44653
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
44655
|
+
* @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
|
|
44654
44656
|
* @param {UpsertWorldlineDto} upsertWorldlineDto
|
|
44655
44657
|
* @param {*} [options] Override http request option.
|
|
44656
44658
|
* @throws {RequiredError}
|
|
44657
44659
|
*/
|
|
44658
|
-
configUpsertWorldline: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertWorldlineDto: UpsertWorldlineDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
44660
|
+
configUpsertWorldline: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ" | "Partner", upsertWorldlineDto: UpsertWorldlineDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
44659
44661
|
};
|
|
44660
44662
|
/**
|
|
44661
44663
|
* ConfigManagementApi - functional programming interface
|
|
@@ -44666,21 +44668,21 @@ export declare const ConfigManagementApiFp: (configuration?: Configuration) => {
|
|
|
44666
44668
|
* 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.
|
|
44667
44669
|
* @summary Enable or disable first-party Munchi GiftCard integration
|
|
44668
44670
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44669
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
44671
|
+
* @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
|
|
44670
44672
|
* @param {ConfigureMunchiGiftCardDto} configureMunchiGiftCardDto
|
|
44671
44673
|
* @param {*} [options] Override http request option.
|
|
44672
44674
|
* @throws {RequiredError}
|
|
44673
44675
|
*/
|
|
44674
|
-
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>>;
|
|
44676
|
+
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>>;
|
|
44675
44677
|
/**
|
|
44676
44678
|
* 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).
|
|
44677
44679
|
* @summary Read a channel\'s card payment providers
|
|
44678
44680
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44679
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
44681
|
+
* @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
|
|
44680
44682
|
* @param {*} [options] Override http request option.
|
|
44681
44683
|
* @throws {RequiredError}
|
|
44682
44684
|
*/
|
|
44683
|
-
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>>;
|
|
44685
|
+
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>>;
|
|
44684
44686
|
/**
|
|
44685
44687
|
* 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.
|
|
44686
44688
|
* @summary Manual sync trigger
|
|
@@ -44695,22 +44697,22 @@ export declare const ConfigManagementApiFp: (configuration?: Configuration) => {
|
|
|
44695
44697
|
* @summary Remove payment option
|
|
44696
44698
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44697
44699
|
* @param {string} id The payment option\'s id
|
|
44698
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
44700
|
+
* @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
|
|
44699
44701
|
* @param {*} [options] Override http request option.
|
|
44700
44702
|
* @throws {RequiredError}
|
|
44701
44703
|
*/
|
|
44702
|
-
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>>;
|
|
44704
|
+
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>>;
|
|
44703
44705
|
/**
|
|
44704
44706
|
* 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.
|
|
44705
44707
|
* @summary Save a channel\'s Epassi credentials and answer the public key to send Epassi (Munchi admins only)
|
|
44706
44708
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44707
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
44709
|
+
* @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
|
|
44708
44710
|
* @param {string} xEpassiAccessKey The access key Epassi issued for this venue; Epassi issues a different one for test and production.
|
|
44709
44711
|
* @param {SaveEpassiCredentialsDto} saveEpassiCredentialsDto
|
|
44710
44712
|
* @param {*} [options] Override http request option.
|
|
44711
44713
|
* @throws {RequiredError}
|
|
44712
44714
|
*/
|
|
44713
|
-
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>>;
|
|
44715
|
+
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>>;
|
|
44714
44716
|
/**
|
|
44715
44717
|
* 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.
|
|
44716
44718
|
* @summary Create or update a venue
|
|
@@ -44724,22 +44726,22 @@ export declare const ConfigManagementApiFp: (configuration?: Configuration) => {
|
|
|
44724
44726
|
* 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.
|
|
44725
44727
|
* @summary Create or update a channel\'s config
|
|
44726
44728
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44727
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
44729
|
+
* @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
|
|
44728
44730
|
* @param {UpsertConfigDto} upsertConfigDto
|
|
44729
44731
|
* @param {*} [options] Override http request option.
|
|
44730
44732
|
* @throws {RequiredError}
|
|
44731
44733
|
*/
|
|
44732
|
-
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>>;
|
|
44734
|
+
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>>;
|
|
44733
44735
|
/**
|
|
44734
44736
|
* 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.
|
|
44735
44737
|
* @summary Create or update a channel\'s third-party gift card integration
|
|
44736
44738
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44737
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
44739
|
+
* @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
|
|
44738
44740
|
* @param {UpsertGiftCardDto} upsertGiftCardDto
|
|
44739
44741
|
* @param {*} [options] Override http request option.
|
|
44740
44742
|
* @throws {RequiredError}
|
|
44741
44743
|
*/
|
|
44742
|
-
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>>;
|
|
44744
|
+
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>>;
|
|
44743
44745
|
/**
|
|
44744
44746
|
* 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.
|
|
44745
44747
|
* @summary Create or update a loyalty program and link it to a venue
|
|
@@ -44753,72 +44755,72 @@ export declare const ConfigManagementApiFp: (configuration?: Configuration) => {
|
|
|
44753
44755
|
* 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.
|
|
44754
44756
|
* @summary Create or update a channel\'s Nets config (Munchi admins only)
|
|
44755
44757
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44756
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
44758
|
+
* @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
|
|
44757
44759
|
* @param {UpsertNetsDto} upsertNetsDto
|
|
44758
44760
|
* @param {*} [options] Override http request option.
|
|
44759
44761
|
* @throws {RequiredError}
|
|
44760
44762
|
*/
|
|
44761
|
-
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>>;
|
|
44763
|
+
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>>;
|
|
44762
44764
|
/**
|
|
44763
44765
|
* 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.
|
|
44764
44766
|
* @summary Create or update a channel\'s Nexi config (Munchi admins only)
|
|
44765
44767
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44766
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
44768
|
+
* @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
|
|
44767
44769
|
* @param {UpsertNexiDto} upsertNexiDto
|
|
44768
44770
|
* @param {*} [options] Override http request option.
|
|
44769
44771
|
* @throws {RequiredError}
|
|
44770
44772
|
*/
|
|
44771
|
-
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>>;
|
|
44773
|
+
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>>;
|
|
44772
44774
|
/**
|
|
44773
44775
|
* 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.
|
|
44774
44776
|
* @summary Create or update a channel\'s checkout payment options
|
|
44775
44777
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44776
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
44778
|
+
* @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
|
|
44777
44779
|
* @param {UpsertPaymentOptionsDto} upsertPaymentOptionsDto
|
|
44778
44780
|
* @param {*} [options] Override http request option.
|
|
44779
44781
|
* @throws {RequiredError}
|
|
44780
44782
|
*/
|
|
44781
|
-
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>>;
|
|
44783
|
+
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>>;
|
|
44782
44784
|
/**
|
|
44783
44785
|
* 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.
|
|
44784
44786
|
* @summary Set active provider and upsert its credentials (Munchi admins only)
|
|
44785
44787
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44786
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
44788
|
+
* @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
|
|
44787
44789
|
* @param {UpsertProvidersDto} upsertProvidersDto
|
|
44788
44790
|
* @param {*} [options] Override http request option.
|
|
44789
44791
|
* @throws {RequiredError}
|
|
44790
44792
|
*/
|
|
44791
|
-
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>>;
|
|
44793
|
+
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>>;
|
|
44792
44794
|
/**
|
|
44793
44795
|
* 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.
|
|
44794
44796
|
* @summary Create or update a channel\'s Stripe config (Munchi admins only)
|
|
44795
44797
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44796
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
44798
|
+
* @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
|
|
44797
44799
|
* @param {UpsertStripeDto} upsertStripeDto
|
|
44798
44800
|
* @param {*} [options] Override http request option.
|
|
44799
44801
|
* @throws {RequiredError}
|
|
44800
44802
|
*/
|
|
44801
|
-
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>>;
|
|
44803
|
+
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>>;
|
|
44802
44804
|
/**
|
|
44803
44805
|
* 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.
|
|
44804
44806
|
* @summary Create or update a channel\'s Viva config (Munchi admins only)
|
|
44805
44807
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44806
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
44808
|
+
* @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
|
|
44807
44809
|
* @param {UpsertVivaDto} upsertVivaDto
|
|
44808
44810
|
* @param {*} [options] Override http request option.
|
|
44809
44811
|
* @throws {RequiredError}
|
|
44810
44812
|
*/
|
|
44811
|
-
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>>;
|
|
44813
|
+
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>>;
|
|
44812
44814
|
/**
|
|
44813
44815
|
* 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.
|
|
44814
44816
|
* @summary Create or update a channel\'s Worldline config (Munchi admins only)
|
|
44815
44817
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44816
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
44818
|
+
* @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
|
|
44817
44819
|
* @param {UpsertWorldlineDto} upsertWorldlineDto
|
|
44818
44820
|
* @param {*} [options] Override http request option.
|
|
44819
44821
|
* @throws {RequiredError}
|
|
44820
44822
|
*/
|
|
44821
|
-
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>>;
|
|
44823
|
+
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>>;
|
|
44822
44824
|
};
|
|
44823
44825
|
/**
|
|
44824
44826
|
* ConfigManagementApi - factory interface
|
|
@@ -44829,21 +44831,21 @@ export declare const ConfigManagementApiFactory: (configuration?: Configuration,
|
|
|
44829
44831
|
* 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.
|
|
44830
44832
|
* @summary Enable or disable first-party Munchi GiftCard integration
|
|
44831
44833
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44832
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
44834
|
+
* @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
|
|
44833
44835
|
* @param {ConfigureMunchiGiftCardDto} configureMunchiGiftCardDto
|
|
44834
44836
|
* @param {*} [options] Override http request option.
|
|
44835
44837
|
* @throws {RequiredError}
|
|
44836
44838
|
*/
|
|
44837
|
-
configConfigureMunchiGiftCard(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", configureMunchiGiftCardDto: ConfigureMunchiGiftCardDto, options?: any): AxiosPromise<ConfigManagementResponseDto>;
|
|
44839
|
+
configConfigureMunchiGiftCard(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ" | "Partner", configureMunchiGiftCardDto: ConfigureMunchiGiftCardDto, options?: any): AxiosPromise<ConfigManagementResponseDto>;
|
|
44838
44840
|
/**
|
|
44839
44841
|
* 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).
|
|
44840
44842
|
* @summary Read a channel\'s card payment providers
|
|
44841
44843
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44842
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
44844
|
+
* @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
|
|
44843
44845
|
* @param {*} [options] Override http request option.
|
|
44844
44846
|
* @throws {RequiredError}
|
|
44845
44847
|
*/
|
|
44846
|
-
configGetProviders(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", options?: any): AxiosPromise<ProvidersConfigResponseDto>;
|
|
44848
|
+
configGetProviders(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ" | "Partner", options?: any): AxiosPromise<ProvidersConfigResponseDto>;
|
|
44847
44849
|
/**
|
|
44848
44850
|
* 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.
|
|
44849
44851
|
* @summary Manual sync trigger
|
|
@@ -44858,22 +44860,22 @@ export declare const ConfigManagementApiFactory: (configuration?: Configuration,
|
|
|
44858
44860
|
* @summary Remove payment option
|
|
44859
44861
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44860
44862
|
* @param {string} id The payment option\'s id
|
|
44861
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
44863
|
+
* @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
|
|
44862
44864
|
* @param {*} [options] Override http request option.
|
|
44863
44865
|
* @throws {RequiredError}
|
|
44864
44866
|
*/
|
|
44865
|
-
configRemovePaymentOption(businessId: number, id: string, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", options?: any): AxiosPromise<ConfigManagementResponseDto>;
|
|
44867
|
+
configRemovePaymentOption(businessId: number, id: string, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ" | "Partner", options?: any): AxiosPromise<ConfigManagementResponseDto>;
|
|
44866
44868
|
/**
|
|
44867
44869
|
* 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.
|
|
44868
44870
|
* @summary Save a channel\'s Epassi credentials and answer the public key to send Epassi (Munchi admins only)
|
|
44869
44871
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44870
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
44872
|
+
* @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
|
|
44871
44873
|
* @param {string} xEpassiAccessKey The access key Epassi issued for this venue; Epassi issues a different one for test and production.
|
|
44872
44874
|
* @param {SaveEpassiCredentialsDto} saveEpassiCredentialsDto
|
|
44873
44875
|
* @param {*} [options] Override http request option.
|
|
44874
44876
|
* @throws {RequiredError}
|
|
44875
44877
|
*/
|
|
44876
|
-
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>;
|
|
44878
|
+
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>;
|
|
44877
44879
|
/**
|
|
44878
44880
|
* 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.
|
|
44879
44881
|
* @summary Create or update a venue
|
|
@@ -44887,22 +44889,22 @@ export declare const ConfigManagementApiFactory: (configuration?: Configuration,
|
|
|
44887
44889
|
* 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.
|
|
44888
44890
|
* @summary Create or update a channel\'s config
|
|
44889
44891
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44890
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
44892
|
+
* @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
|
|
44891
44893
|
* @param {UpsertConfigDto} upsertConfigDto
|
|
44892
44894
|
* @param {*} [options] Override http request option.
|
|
44893
44895
|
* @throws {RequiredError}
|
|
44894
44896
|
*/
|
|
44895
|
-
configUpsertChannelConfig(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertConfigDto: UpsertConfigDto, options?: any): AxiosPromise<ConfigManagementResponseDto>;
|
|
44897
|
+
configUpsertChannelConfig(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ" | "Partner", upsertConfigDto: UpsertConfigDto, options?: any): AxiosPromise<ConfigManagementResponseDto>;
|
|
44896
44898
|
/**
|
|
44897
44899
|
* 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.
|
|
44898
44900
|
* @summary Create or update a channel\'s third-party gift card integration
|
|
44899
44901
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44900
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
44902
|
+
* @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
|
|
44901
44903
|
* @param {UpsertGiftCardDto} upsertGiftCardDto
|
|
44902
44904
|
* @param {*} [options] Override http request option.
|
|
44903
44905
|
* @throws {RequiredError}
|
|
44904
44906
|
*/
|
|
44905
|
-
configUpsertGiftCard(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertGiftCardDto: UpsertGiftCardDto, options?: any): AxiosPromise<ConfigManagementResponseDto>;
|
|
44907
|
+
configUpsertGiftCard(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ" | "Partner", upsertGiftCardDto: UpsertGiftCardDto, options?: any): AxiosPromise<ConfigManagementResponseDto>;
|
|
44906
44908
|
/**
|
|
44907
44909
|
* 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.
|
|
44908
44910
|
* @summary Create or update a loyalty program and link it to a venue
|
|
@@ -44916,72 +44918,72 @@ export declare const ConfigManagementApiFactory: (configuration?: Configuration,
|
|
|
44916
44918
|
* 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.
|
|
44917
44919
|
* @summary Create or update a channel\'s Nets config (Munchi admins only)
|
|
44918
44920
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44919
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
44921
|
+
* @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
|
|
44920
44922
|
* @param {UpsertNetsDto} upsertNetsDto
|
|
44921
44923
|
* @param {*} [options] Override http request option.
|
|
44922
44924
|
* @throws {RequiredError}
|
|
44923
44925
|
*/
|
|
44924
|
-
configUpsertNets(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertNetsDto: UpsertNetsDto, options?: any): AxiosPromise<ConfigManagementResponseDto>;
|
|
44926
|
+
configUpsertNets(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ" | "Partner", upsertNetsDto: UpsertNetsDto, options?: any): AxiosPromise<ConfigManagementResponseDto>;
|
|
44925
44927
|
/**
|
|
44926
44928
|
* 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.
|
|
44927
44929
|
* @summary Create or update a channel\'s Nexi config (Munchi admins only)
|
|
44928
44930
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44929
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
44931
|
+
* @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
|
|
44930
44932
|
* @param {UpsertNexiDto} upsertNexiDto
|
|
44931
44933
|
* @param {*} [options] Override http request option.
|
|
44932
44934
|
* @throws {RequiredError}
|
|
44933
44935
|
*/
|
|
44934
|
-
configUpsertNexi(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertNexiDto: UpsertNexiDto, options?: any): AxiosPromise<ConfigManagementResponseDto>;
|
|
44936
|
+
configUpsertNexi(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ" | "Partner", upsertNexiDto: UpsertNexiDto, options?: any): AxiosPromise<ConfigManagementResponseDto>;
|
|
44935
44937
|
/**
|
|
44936
44938
|
* 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.
|
|
44937
44939
|
* @summary Create or update a channel\'s checkout payment options
|
|
44938
44940
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44939
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
44941
|
+
* @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
|
|
44940
44942
|
* @param {UpsertPaymentOptionsDto} upsertPaymentOptionsDto
|
|
44941
44943
|
* @param {*} [options] Override http request option.
|
|
44942
44944
|
* @throws {RequiredError}
|
|
44943
44945
|
*/
|
|
44944
|
-
configUpsertPaymentOptions(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertPaymentOptionsDto: UpsertPaymentOptionsDto, options?: any): AxiosPromise<ConfigManagementResponseDto>;
|
|
44946
|
+
configUpsertPaymentOptions(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ" | "Partner", upsertPaymentOptionsDto: UpsertPaymentOptionsDto, options?: any): AxiosPromise<ConfigManagementResponseDto>;
|
|
44945
44947
|
/**
|
|
44946
44948
|
* 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.
|
|
44947
44949
|
* @summary Set active provider and upsert its credentials (Munchi admins only)
|
|
44948
44950
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44949
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
44951
|
+
* @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
|
|
44950
44952
|
* @param {UpsertProvidersDto} upsertProvidersDto
|
|
44951
44953
|
* @param {*} [options] Override http request option.
|
|
44952
44954
|
* @throws {RequiredError}
|
|
44953
44955
|
*/
|
|
44954
|
-
configUpsertProviders(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertProvidersDto: UpsertProvidersDto, options?: any): AxiosPromise<ProvidersConfigResponseDto>;
|
|
44956
|
+
configUpsertProviders(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ" | "Partner", upsertProvidersDto: UpsertProvidersDto, options?: any): AxiosPromise<ProvidersConfigResponseDto>;
|
|
44955
44957
|
/**
|
|
44956
44958
|
* 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.
|
|
44957
44959
|
* @summary Create or update a channel\'s Stripe config (Munchi admins only)
|
|
44958
44960
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44959
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
44961
|
+
* @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
|
|
44960
44962
|
* @param {UpsertStripeDto} upsertStripeDto
|
|
44961
44963
|
* @param {*} [options] Override http request option.
|
|
44962
44964
|
* @throws {RequiredError}
|
|
44963
44965
|
*/
|
|
44964
|
-
configUpsertStripe(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertStripeDto: UpsertStripeDto, options?: any): AxiosPromise<ConfigManagementResponseDto>;
|
|
44966
|
+
configUpsertStripe(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ" | "Partner", upsertStripeDto: UpsertStripeDto, options?: any): AxiosPromise<ConfigManagementResponseDto>;
|
|
44965
44967
|
/**
|
|
44966
44968
|
* 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.
|
|
44967
44969
|
* @summary Create or update a channel\'s Viva config (Munchi admins only)
|
|
44968
44970
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44969
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
44971
|
+
* @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
|
|
44970
44972
|
* @param {UpsertVivaDto} upsertVivaDto
|
|
44971
44973
|
* @param {*} [options] Override http request option.
|
|
44972
44974
|
* @throws {RequiredError}
|
|
44973
44975
|
*/
|
|
44974
|
-
configUpsertViva(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertVivaDto: UpsertVivaDto, options?: any): AxiosPromise<ConfigManagementResponseDto>;
|
|
44976
|
+
configUpsertViva(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ" | "Partner", upsertVivaDto: UpsertVivaDto, options?: any): AxiosPromise<ConfigManagementResponseDto>;
|
|
44975
44977
|
/**
|
|
44976
44978
|
* 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.
|
|
44977
44979
|
* @summary Create or update a channel\'s Worldline config (Munchi admins only)
|
|
44978
44980
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44979
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
44981
|
+
* @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
|
|
44980
44982
|
* @param {UpsertWorldlineDto} upsertWorldlineDto
|
|
44981
44983
|
* @param {*} [options] Override http request option.
|
|
44982
44984
|
* @throws {RequiredError}
|
|
44983
44985
|
*/
|
|
44984
|
-
configUpsertWorldline(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertWorldlineDto: UpsertWorldlineDto, options?: any): AxiosPromise<ConfigManagementResponseDto>;
|
|
44986
|
+
configUpsertWorldline(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ" | "Partner", upsertWorldlineDto: UpsertWorldlineDto, options?: any): AxiosPromise<ConfigManagementResponseDto>;
|
|
44985
44987
|
};
|
|
44986
44988
|
/**
|
|
44987
44989
|
* ConfigManagementApi - interface
|
|
@@ -44993,23 +44995,23 @@ export interface ConfigManagementApiInterface {
|
|
|
44993
44995
|
* 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.
|
|
44994
44996
|
* @summary Enable or disable first-party Munchi GiftCard integration
|
|
44995
44997
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44996
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
44998
|
+
* @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
|
|
44997
44999
|
* @param {ConfigureMunchiGiftCardDto} configureMunchiGiftCardDto
|
|
44998
45000
|
* @param {*} [options] Override http request option.
|
|
44999
45001
|
* @throws {RequiredError}
|
|
45000
45002
|
* @memberof ConfigManagementApiInterface
|
|
45001
45003
|
*/
|
|
45002
|
-
configConfigureMunchiGiftCard(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', configureMunchiGiftCardDto: ConfigureMunchiGiftCardDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
45004
|
+
configConfigureMunchiGiftCard(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', configureMunchiGiftCardDto: ConfigureMunchiGiftCardDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
45003
45005
|
/**
|
|
45004
45006
|
* 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).
|
|
45005
45007
|
* @summary Read a channel\'s card payment providers
|
|
45006
45008
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
45007
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45009
|
+
* @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
|
|
45008
45010
|
* @param {*} [options] Override http request option.
|
|
45009
45011
|
* @throws {RequiredError}
|
|
45010
45012
|
* @memberof ConfigManagementApiInterface
|
|
45011
45013
|
*/
|
|
45012
|
-
configGetProviders(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', options?: AxiosRequestConfig): AxiosPromise<ProvidersConfigResponseDto>;
|
|
45014
|
+
configGetProviders(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', options?: AxiosRequestConfig): AxiosPromise<ProvidersConfigResponseDto>;
|
|
45013
45015
|
/**
|
|
45014
45016
|
* 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.
|
|
45015
45017
|
* @summary Manual sync trigger
|
|
@@ -45025,24 +45027,24 @@ export interface ConfigManagementApiInterface {
|
|
|
45025
45027
|
* @summary Remove payment option
|
|
45026
45028
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
45027
45029
|
* @param {string} id The payment option\'s id
|
|
45028
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45030
|
+
* @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
|
|
45029
45031
|
* @param {*} [options] Override http request option.
|
|
45030
45032
|
* @throws {RequiredError}
|
|
45031
45033
|
* @memberof ConfigManagementApiInterface
|
|
45032
45034
|
*/
|
|
45033
|
-
configRemovePaymentOption(businessId: number, id: string, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
45035
|
+
configRemovePaymentOption(businessId: number, id: string, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
45034
45036
|
/**
|
|
45035
45037
|
* 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.
|
|
45036
45038
|
* @summary Save a channel\'s Epassi credentials and answer the public key to send Epassi (Munchi admins only)
|
|
45037
45039
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
45038
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45040
|
+
* @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
|
|
45039
45041
|
* @param {string} xEpassiAccessKey The access key Epassi issued for this venue; Epassi issues a different one for test and production.
|
|
45040
45042
|
* @param {SaveEpassiCredentialsDto} saveEpassiCredentialsDto
|
|
45041
45043
|
* @param {*} [options] Override http request option.
|
|
45042
45044
|
* @throws {RequiredError}
|
|
45043
45045
|
* @memberof ConfigManagementApiInterface
|
|
45044
45046
|
*/
|
|
45045
|
-
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>;
|
|
45047
|
+
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>;
|
|
45046
45048
|
/**
|
|
45047
45049
|
* 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.
|
|
45048
45050
|
* @summary Create or update a venue
|
|
@@ -45057,24 +45059,24 @@ export interface ConfigManagementApiInterface {
|
|
|
45057
45059
|
* 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.
|
|
45058
45060
|
* @summary Create or update a channel\'s config
|
|
45059
45061
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
45060
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45062
|
+
* @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
|
|
45061
45063
|
* @param {UpsertConfigDto} upsertConfigDto
|
|
45062
45064
|
* @param {*} [options] Override http request option.
|
|
45063
45065
|
* @throws {RequiredError}
|
|
45064
45066
|
* @memberof ConfigManagementApiInterface
|
|
45065
45067
|
*/
|
|
45066
|
-
configUpsertChannelConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertConfigDto: UpsertConfigDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
45068
|
+
configUpsertChannelConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertConfigDto: UpsertConfigDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
45067
45069
|
/**
|
|
45068
45070
|
* 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.
|
|
45069
45071
|
* @summary Create or update a channel\'s third-party gift card integration
|
|
45070
45072
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
45071
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45073
|
+
* @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
|
|
45072
45074
|
* @param {UpsertGiftCardDto} upsertGiftCardDto
|
|
45073
45075
|
* @param {*} [options] Override http request option.
|
|
45074
45076
|
* @throws {RequiredError}
|
|
45075
45077
|
* @memberof ConfigManagementApiInterface
|
|
45076
45078
|
*/
|
|
45077
|
-
configUpsertGiftCard(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertGiftCardDto: UpsertGiftCardDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
45079
|
+
configUpsertGiftCard(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertGiftCardDto: UpsertGiftCardDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
45078
45080
|
/**
|
|
45079
45081
|
* 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.
|
|
45080
45082
|
* @summary Create or update a loyalty program and link it to a venue
|
|
@@ -45089,79 +45091,79 @@ export interface ConfigManagementApiInterface {
|
|
|
45089
45091
|
* 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.
|
|
45090
45092
|
* @summary Create or update a channel\'s Nets config (Munchi admins only)
|
|
45091
45093
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
45092
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45094
|
+
* @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
|
|
45093
45095
|
* @param {UpsertNetsDto} upsertNetsDto
|
|
45094
45096
|
* @param {*} [options] Override http request option.
|
|
45095
45097
|
* @throws {RequiredError}
|
|
45096
45098
|
* @memberof ConfigManagementApiInterface
|
|
45097
45099
|
*/
|
|
45098
|
-
configUpsertNets(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertNetsDto: UpsertNetsDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
45100
|
+
configUpsertNets(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertNetsDto: UpsertNetsDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
45099
45101
|
/**
|
|
45100
45102
|
* 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.
|
|
45101
45103
|
* @summary Create or update a channel\'s Nexi config (Munchi admins only)
|
|
45102
45104
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
45103
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45105
|
+
* @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
|
|
45104
45106
|
* @param {UpsertNexiDto} upsertNexiDto
|
|
45105
45107
|
* @param {*} [options] Override http request option.
|
|
45106
45108
|
* @throws {RequiredError}
|
|
45107
45109
|
* @memberof ConfigManagementApiInterface
|
|
45108
45110
|
*/
|
|
45109
|
-
configUpsertNexi(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertNexiDto: UpsertNexiDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
45111
|
+
configUpsertNexi(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertNexiDto: UpsertNexiDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
45110
45112
|
/**
|
|
45111
45113
|
* 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.
|
|
45112
45114
|
* @summary Create or update a channel\'s checkout payment options
|
|
45113
45115
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
45114
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45116
|
+
* @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
|
|
45115
45117
|
* @param {UpsertPaymentOptionsDto} upsertPaymentOptionsDto
|
|
45116
45118
|
* @param {*} [options] Override http request option.
|
|
45117
45119
|
* @throws {RequiredError}
|
|
45118
45120
|
* @memberof ConfigManagementApiInterface
|
|
45119
45121
|
*/
|
|
45120
|
-
configUpsertPaymentOptions(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertPaymentOptionsDto: UpsertPaymentOptionsDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
45122
|
+
configUpsertPaymentOptions(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertPaymentOptionsDto: UpsertPaymentOptionsDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
45121
45123
|
/**
|
|
45122
45124
|
* 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.
|
|
45123
45125
|
* @summary Set active provider and upsert its credentials (Munchi admins only)
|
|
45124
45126
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
45125
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45127
|
+
* @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
|
|
45126
45128
|
* @param {UpsertProvidersDto} upsertProvidersDto
|
|
45127
45129
|
* @param {*} [options] Override http request option.
|
|
45128
45130
|
* @throws {RequiredError}
|
|
45129
45131
|
* @memberof ConfigManagementApiInterface
|
|
45130
45132
|
*/
|
|
45131
|
-
configUpsertProviders(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertProvidersDto: UpsertProvidersDto, options?: AxiosRequestConfig): AxiosPromise<ProvidersConfigResponseDto>;
|
|
45133
|
+
configUpsertProviders(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertProvidersDto: UpsertProvidersDto, options?: AxiosRequestConfig): AxiosPromise<ProvidersConfigResponseDto>;
|
|
45132
45134
|
/**
|
|
45133
45135
|
* 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.
|
|
45134
45136
|
* @summary Create or update a channel\'s Stripe config (Munchi admins only)
|
|
45135
45137
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
45136
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45138
|
+
* @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
|
|
45137
45139
|
* @param {UpsertStripeDto} upsertStripeDto
|
|
45138
45140
|
* @param {*} [options] Override http request option.
|
|
45139
45141
|
* @throws {RequiredError}
|
|
45140
45142
|
* @memberof ConfigManagementApiInterface
|
|
45141
45143
|
*/
|
|
45142
|
-
configUpsertStripe(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertStripeDto: UpsertStripeDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
45144
|
+
configUpsertStripe(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertStripeDto: UpsertStripeDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
45143
45145
|
/**
|
|
45144
45146
|
* 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.
|
|
45145
45147
|
* @summary Create or update a channel\'s Viva config (Munchi admins only)
|
|
45146
45148
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
45147
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45149
|
+
* @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
|
|
45148
45150
|
* @param {UpsertVivaDto} upsertVivaDto
|
|
45149
45151
|
* @param {*} [options] Override http request option.
|
|
45150
45152
|
* @throws {RequiredError}
|
|
45151
45153
|
* @memberof ConfigManagementApiInterface
|
|
45152
45154
|
*/
|
|
45153
|
-
configUpsertViva(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertVivaDto: UpsertVivaDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
45155
|
+
configUpsertViva(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertVivaDto: UpsertVivaDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
45154
45156
|
/**
|
|
45155
45157
|
* 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.
|
|
45156
45158
|
* @summary Create or update a channel\'s Worldline config (Munchi admins only)
|
|
45157
45159
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
45158
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45160
|
+
* @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
|
|
45159
45161
|
* @param {UpsertWorldlineDto} upsertWorldlineDto
|
|
45160
45162
|
* @param {*} [options] Override http request option.
|
|
45161
45163
|
* @throws {RequiredError}
|
|
45162
45164
|
* @memberof ConfigManagementApiInterface
|
|
45163
45165
|
*/
|
|
45164
|
-
configUpsertWorldline(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertWorldlineDto: UpsertWorldlineDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
45166
|
+
configUpsertWorldline(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertWorldlineDto: UpsertWorldlineDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
45165
45167
|
}
|
|
45166
45168
|
/**
|
|
45167
45169
|
* ConfigManagementApi - object-oriented interface
|
|
@@ -45174,23 +45176,23 @@ export declare class ConfigManagementApi extends BaseAPI implements ConfigManage
|
|
|
45174
45176
|
* 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.
|
|
45175
45177
|
* @summary Enable or disable first-party Munchi GiftCard integration
|
|
45176
45178
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
45177
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45179
|
+
* @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
|
|
45178
45180
|
* @param {ConfigureMunchiGiftCardDto} configureMunchiGiftCardDto
|
|
45179
45181
|
* @param {*} [options] Override http request option.
|
|
45180
45182
|
* @throws {RequiredError}
|
|
45181
45183
|
* @memberof ConfigManagementApi
|
|
45182
45184
|
*/
|
|
45183
|
-
configConfigureMunchiGiftCard(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', configureMunchiGiftCardDto: ConfigureMunchiGiftCardDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ConfigManagementResponseDto, any, {}>>;
|
|
45185
|
+
configConfigureMunchiGiftCard(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', configureMunchiGiftCardDto: ConfigureMunchiGiftCardDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ConfigManagementResponseDto, any, {}>>;
|
|
45184
45186
|
/**
|
|
45185
45187
|
* 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).
|
|
45186
45188
|
* @summary Read a channel\'s card payment providers
|
|
45187
45189
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
45188
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45190
|
+
* @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
|
|
45189
45191
|
* @param {*} [options] Override http request option.
|
|
45190
45192
|
* @throws {RequiredError}
|
|
45191
45193
|
* @memberof ConfigManagementApi
|
|
45192
45194
|
*/
|
|
45193
|
-
configGetProviders(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ProvidersConfigResponseDto, any, {}>>;
|
|
45195
|
+
configGetProviders(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ProvidersConfigResponseDto, any, {}>>;
|
|
45194
45196
|
/**
|
|
45195
45197
|
* 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.
|
|
45196
45198
|
* @summary Manual sync trigger
|
|
@@ -45206,24 +45208,24 @@ export declare class ConfigManagementApi extends BaseAPI implements ConfigManage
|
|
|
45206
45208
|
* @summary Remove payment option
|
|
45207
45209
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
45208
45210
|
* @param {string} id The payment option\'s id
|
|
45209
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45211
|
+
* @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
|
|
45210
45212
|
* @param {*} [options] Override http request option.
|
|
45211
45213
|
* @throws {RequiredError}
|
|
45212
45214
|
* @memberof ConfigManagementApi
|
|
45213
45215
|
*/
|
|
45214
|
-
configRemovePaymentOption(businessId: number, id: string, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ConfigManagementResponseDto, any, {}>>;
|
|
45216
|
+
configRemovePaymentOption(businessId: number, id: string, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ConfigManagementResponseDto, any, {}>>;
|
|
45215
45217
|
/**
|
|
45216
45218
|
* 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.
|
|
45217
45219
|
* @summary Save a channel\'s Epassi credentials and answer the public key to send Epassi (Munchi admins only)
|
|
45218
45220
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
45219
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45221
|
+
* @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
|
|
45220
45222
|
* @param {string} xEpassiAccessKey The access key Epassi issued for this venue; Epassi issues a different one for test and production.
|
|
45221
45223
|
* @param {SaveEpassiCredentialsDto} saveEpassiCredentialsDto
|
|
45222
45224
|
* @param {*} [options] Override http request option.
|
|
45223
45225
|
* @throws {RequiredError}
|
|
45224
45226
|
* @memberof ConfigManagementApi
|
|
45225
45227
|
*/
|
|
45226
|
-
configSaveEpassiCredentials(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', xEpassiAccessKey: string, saveEpassiCredentialsDto: SaveEpassiCredentialsDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EpassiCredentialsSavedDto, any, {}>>;
|
|
45228
|
+
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<import("axios").AxiosResponse<EpassiCredentialsSavedDto, any, {}>>;
|
|
45227
45229
|
/**
|
|
45228
45230
|
* 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.
|
|
45229
45231
|
* @summary Create or update a venue
|
|
@@ -45238,24 +45240,24 @@ export declare class ConfigManagementApi extends BaseAPI implements ConfigManage
|
|
|
45238
45240
|
* 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.
|
|
45239
45241
|
* @summary Create or update a channel\'s config
|
|
45240
45242
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
45241
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45243
|
+
* @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
|
|
45242
45244
|
* @param {UpsertConfigDto} upsertConfigDto
|
|
45243
45245
|
* @param {*} [options] Override http request option.
|
|
45244
45246
|
* @throws {RequiredError}
|
|
45245
45247
|
* @memberof ConfigManagementApi
|
|
45246
45248
|
*/
|
|
45247
|
-
configUpsertChannelConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertConfigDto: UpsertConfigDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ConfigManagementResponseDto, any, {}>>;
|
|
45249
|
+
configUpsertChannelConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertConfigDto: UpsertConfigDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ConfigManagementResponseDto, any, {}>>;
|
|
45248
45250
|
/**
|
|
45249
45251
|
* 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.
|
|
45250
45252
|
* @summary Create or update a channel\'s third-party gift card integration
|
|
45251
45253
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
45252
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45254
|
+
* @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
|
|
45253
45255
|
* @param {UpsertGiftCardDto} upsertGiftCardDto
|
|
45254
45256
|
* @param {*} [options] Override http request option.
|
|
45255
45257
|
* @throws {RequiredError}
|
|
45256
45258
|
* @memberof ConfigManagementApi
|
|
45257
45259
|
*/
|
|
45258
|
-
configUpsertGiftCard(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertGiftCardDto: UpsertGiftCardDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ConfigManagementResponseDto, any, {}>>;
|
|
45260
|
+
configUpsertGiftCard(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertGiftCardDto: UpsertGiftCardDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ConfigManagementResponseDto, any, {}>>;
|
|
45259
45261
|
/**
|
|
45260
45262
|
* 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.
|
|
45261
45263
|
* @summary Create or update a loyalty program and link it to a venue
|
|
@@ -45270,79 +45272,79 @@ export declare class ConfigManagementApi extends BaseAPI implements ConfigManage
|
|
|
45270
45272
|
* 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.
|
|
45271
45273
|
* @summary Create or update a channel\'s Nets config (Munchi admins only)
|
|
45272
45274
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
45273
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45275
|
+
* @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
|
|
45274
45276
|
* @param {UpsertNetsDto} upsertNetsDto
|
|
45275
45277
|
* @param {*} [options] Override http request option.
|
|
45276
45278
|
* @throws {RequiredError}
|
|
45277
45279
|
* @memberof ConfigManagementApi
|
|
45278
45280
|
*/
|
|
45279
|
-
configUpsertNets(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertNetsDto: UpsertNetsDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ConfigManagementResponseDto, any, {}>>;
|
|
45281
|
+
configUpsertNets(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertNetsDto: UpsertNetsDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ConfigManagementResponseDto, any, {}>>;
|
|
45280
45282
|
/**
|
|
45281
45283
|
* 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.
|
|
45282
45284
|
* @summary Create or update a channel\'s Nexi config (Munchi admins only)
|
|
45283
45285
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
45284
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45286
|
+
* @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
|
|
45285
45287
|
* @param {UpsertNexiDto} upsertNexiDto
|
|
45286
45288
|
* @param {*} [options] Override http request option.
|
|
45287
45289
|
* @throws {RequiredError}
|
|
45288
45290
|
* @memberof ConfigManagementApi
|
|
45289
45291
|
*/
|
|
45290
|
-
configUpsertNexi(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertNexiDto: UpsertNexiDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ConfigManagementResponseDto, any, {}>>;
|
|
45292
|
+
configUpsertNexi(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertNexiDto: UpsertNexiDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ConfigManagementResponseDto, any, {}>>;
|
|
45291
45293
|
/**
|
|
45292
45294
|
* 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.
|
|
45293
45295
|
* @summary Create or update a channel\'s checkout payment options
|
|
45294
45296
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
45295
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45297
|
+
* @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
|
|
45296
45298
|
* @param {UpsertPaymentOptionsDto} upsertPaymentOptionsDto
|
|
45297
45299
|
* @param {*} [options] Override http request option.
|
|
45298
45300
|
* @throws {RequiredError}
|
|
45299
45301
|
* @memberof ConfigManagementApi
|
|
45300
45302
|
*/
|
|
45301
|
-
configUpsertPaymentOptions(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertPaymentOptionsDto: UpsertPaymentOptionsDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ConfigManagementResponseDto, any, {}>>;
|
|
45303
|
+
configUpsertPaymentOptions(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertPaymentOptionsDto: UpsertPaymentOptionsDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ConfigManagementResponseDto, any, {}>>;
|
|
45302
45304
|
/**
|
|
45303
45305
|
* 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.
|
|
45304
45306
|
* @summary Set active provider and upsert its credentials (Munchi admins only)
|
|
45305
45307
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
45306
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45308
|
+
* @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
|
|
45307
45309
|
* @param {UpsertProvidersDto} upsertProvidersDto
|
|
45308
45310
|
* @param {*} [options] Override http request option.
|
|
45309
45311
|
* @throws {RequiredError}
|
|
45310
45312
|
* @memberof ConfigManagementApi
|
|
45311
45313
|
*/
|
|
45312
|
-
configUpsertProviders(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertProvidersDto: UpsertProvidersDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ProvidersConfigResponseDto, any, {}>>;
|
|
45314
|
+
configUpsertProviders(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertProvidersDto: UpsertProvidersDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ProvidersConfigResponseDto, any, {}>>;
|
|
45313
45315
|
/**
|
|
45314
45316
|
* 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.
|
|
45315
45317
|
* @summary Create or update a channel\'s Stripe config (Munchi admins only)
|
|
45316
45318
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
45317
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45319
|
+
* @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
|
|
45318
45320
|
* @param {UpsertStripeDto} upsertStripeDto
|
|
45319
45321
|
* @param {*} [options] Override http request option.
|
|
45320
45322
|
* @throws {RequiredError}
|
|
45321
45323
|
* @memberof ConfigManagementApi
|
|
45322
45324
|
*/
|
|
45323
|
-
configUpsertStripe(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertStripeDto: UpsertStripeDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ConfigManagementResponseDto, any, {}>>;
|
|
45325
|
+
configUpsertStripe(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertStripeDto: UpsertStripeDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ConfigManagementResponseDto, any, {}>>;
|
|
45324
45326
|
/**
|
|
45325
45327
|
* 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.
|
|
45326
45328
|
* @summary Create or update a channel\'s Viva config (Munchi admins only)
|
|
45327
45329
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
45328
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45330
|
+
* @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
|
|
45329
45331
|
* @param {UpsertVivaDto} upsertVivaDto
|
|
45330
45332
|
* @param {*} [options] Override http request option.
|
|
45331
45333
|
* @throws {RequiredError}
|
|
45332
45334
|
* @memberof ConfigManagementApi
|
|
45333
45335
|
*/
|
|
45334
|
-
configUpsertViva(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertVivaDto: UpsertVivaDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ConfigManagementResponseDto, any, {}>>;
|
|
45336
|
+
configUpsertViva(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertVivaDto: UpsertVivaDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ConfigManagementResponseDto, any, {}>>;
|
|
45335
45337
|
/**
|
|
45336
45338
|
* 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.
|
|
45337
45339
|
* @summary Create or update a channel\'s Worldline config (Munchi admins only)
|
|
45338
45340
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
45339
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45341
|
+
* @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
|
|
45340
45342
|
* @param {UpsertWorldlineDto} upsertWorldlineDto
|
|
45341
45343
|
* @param {*} [options] Override http request option.
|
|
45342
45344
|
* @throws {RequiredError}
|
|
45343
45345
|
* @memberof ConfigManagementApi
|
|
45344
45346
|
*/
|
|
45345
|
-
configUpsertWorldline(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertWorldlineDto: UpsertWorldlineDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ConfigManagementResponseDto, any, {}>>;
|
|
45347
|
+
configUpsertWorldline(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertWorldlineDto: UpsertWorldlineDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ConfigManagementResponseDto, any, {}>>;
|
|
45346
45348
|
}
|
|
45347
45349
|
/**
|
|
45348
45350
|
* CouponsApi - axios parameter creator
|
|
@@ -53555,7 +53557,7 @@ export declare class PaymentMethodsApi extends BaseAPI implements PaymentMethods
|
|
|
53555
53557
|
*/
|
|
53556
53558
|
export declare const PaymentSessionApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
53557
53559
|
/**
|
|
53558
|
-
* 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.
|
|
53560
|
+
* 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.
|
|
53559
53561
|
* @summary Cancel an in-flight card payment session (Viva or Nets)
|
|
53560
53562
|
* @param {string} clientToken The token the initiate answered for the session.
|
|
53561
53563
|
* @param {*} [options] Override http request option.
|
|
@@ -53619,7 +53621,7 @@ export declare const PaymentSessionApiAxiosParamCreator: (configuration?: Config
|
|
|
53619
53621
|
*/
|
|
53620
53622
|
initiateNetsSession: (initiateNetsSessionDto: InitiateNetsSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
53621
53623
|
/**
|
|
53622
|
-
* 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.
|
|
53624
|
+
* 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).
|
|
53623
53625
|
* @summary Start a card payment on the station\'s Nexi terminal
|
|
53624
53626
|
* @param {InitiateNexiSessionDto} initiateNexiSessionDto
|
|
53625
53627
|
* @param {string} [xIdempotencyKey] A UUID the app makes for this payment. A repeated key answers the session it started, without charging again.
|
|
@@ -53735,6 +53737,15 @@ export declare const PaymentSessionApiAxiosParamCreator: (configuration?: Config
|
|
|
53735
53737
|
* @throws {RequiredError}
|
|
53736
53738
|
*/
|
|
53737
53739
|
refundNetsSession: (reverseSessionDto: ReverseSessionDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
53740
|
+
/**
|
|
53741
|
+
* 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.
|
|
53742
|
+
* @summary Refund a paid Nexi sale, customer not present, with no card
|
|
53743
|
+
* @param {ReverseSessionDto} reverseSessionDto
|
|
53744
|
+
* @param {string} [xIdempotencyKey] A UUID the app makes for this refund. A repeated key answers the refund it started, without refunding again.
|
|
53745
|
+
* @param {*} [options] Override http request option.
|
|
53746
|
+
* @throws {RequiredError}
|
|
53747
|
+
*/
|
|
53748
|
+
refundNexiSession: (reverseSessionDto: ReverseSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
53738
53749
|
/**
|
|
53739
53750
|
* 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.
|
|
53740
53751
|
* @summary Refund a settled Viva payment session (gateway only)
|
|
@@ -53775,6 +53786,14 @@ export declare const PaymentSessionApiAxiosParamCreator: (configuration?: Config
|
|
|
53775
53786
|
* @throws {RequiredError}
|
|
53776
53787
|
*/
|
|
53777
53788
|
revertNetsSession: (reverseSessionDto: ReverseSessionDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
53789
|
+
/**
|
|
53790
|
+
* 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.
|
|
53791
|
+
* @summary Revert a paid Nexi sale: give back what is left and write the reversal onto the order
|
|
53792
|
+
* @param {ReverseSessionDto} reverseSessionDto
|
|
53793
|
+
* @param {*} [options] Override http request option.
|
|
53794
|
+
* @throws {RequiredError}
|
|
53795
|
+
*/
|
|
53796
|
+
revertNexiSession: (reverseSessionDto: ReverseSessionDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
53778
53797
|
/**
|
|
53779
53798
|
* 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.
|
|
53780
53799
|
* @summary Revert (fully reverse) a settled Viva payment session
|
|
@@ -53822,7 +53841,7 @@ export declare const PaymentSessionApiAxiosParamCreator: (configuration?: Config
|
|
|
53822
53841
|
*/
|
|
53823
53842
|
export declare const PaymentSessionApiFp: (configuration?: Configuration) => {
|
|
53824
53843
|
/**
|
|
53825
|
-
* 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.
|
|
53844
|
+
* 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.
|
|
53826
53845
|
* @summary Cancel an in-flight card payment session (Viva or Nets)
|
|
53827
53846
|
* @param {string} clientToken The token the initiate answered for the session.
|
|
53828
53847
|
* @param {*} [options] Override http request option.
|
|
@@ -53886,7 +53905,7 @@ export declare const PaymentSessionApiFp: (configuration?: Configuration) => {
|
|
|
53886
53905
|
*/
|
|
53887
53906
|
initiateNetsSession(initiateNetsSessionDto: InitiateNetsSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InitiateNetsSessionResponseDto>>;
|
|
53888
53907
|
/**
|
|
53889
|
-
* 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.
|
|
53908
|
+
* 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).
|
|
53890
53909
|
* @summary Start a card payment on the station\'s Nexi terminal
|
|
53891
53910
|
* @param {InitiateNexiSessionDto} initiateNexiSessionDto
|
|
53892
53911
|
* @param {string} [xIdempotencyKey] A UUID the app makes for this payment. A repeated key answers the session it started, without charging again.
|
|
@@ -54002,6 +54021,15 @@ export declare const PaymentSessionApiFp: (configuration?: Configuration) => {
|
|
|
54002
54021
|
* @throws {RequiredError}
|
|
54003
54022
|
*/
|
|
54004
54023
|
refundNetsSession(reverseSessionDto: ReverseSessionDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentSessionViewDto>>;
|
|
54024
|
+
/**
|
|
54025
|
+
* 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.
|
|
54026
|
+
* @summary Refund a paid Nexi sale, customer not present, with no card
|
|
54027
|
+
* @param {ReverseSessionDto} reverseSessionDto
|
|
54028
|
+
* @param {string} [xIdempotencyKey] A UUID the app makes for this refund. A repeated key answers the refund it started, without refunding again.
|
|
54029
|
+
* @param {*} [options] Override http request option.
|
|
54030
|
+
* @throws {RequiredError}
|
|
54031
|
+
*/
|
|
54032
|
+
refundNexiSession(reverseSessionDto: ReverseSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentSessionViewDto>>;
|
|
54005
54033
|
/**
|
|
54006
54034
|
* 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.
|
|
54007
54035
|
* @summary Refund a settled Viva payment session (gateway only)
|
|
@@ -54042,6 +54070,14 @@ export declare const PaymentSessionApiFp: (configuration?: Configuration) => {
|
|
|
54042
54070
|
* @throws {RequiredError}
|
|
54043
54071
|
*/
|
|
54044
54072
|
revertNetsSession(reverseSessionDto: ReverseSessionDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NetsRevertResponseDto>>;
|
|
54073
|
+
/**
|
|
54074
|
+
* 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.
|
|
54075
|
+
* @summary Revert a paid Nexi sale: give back what is left and write the reversal onto the order
|
|
54076
|
+
* @param {ReverseSessionDto} reverseSessionDto
|
|
54077
|
+
* @param {*} [options] Override http request option.
|
|
54078
|
+
* @throws {RequiredError}
|
|
54079
|
+
*/
|
|
54080
|
+
revertNexiSession(reverseSessionDto: ReverseSessionDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentSessionViewDto>>;
|
|
54045
54081
|
/**
|
|
54046
54082
|
* 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.
|
|
54047
54083
|
* @summary Revert (fully reverse) a settled Viva payment session
|
|
@@ -54089,7 +54125,7 @@ export declare const PaymentSessionApiFp: (configuration?: Configuration) => {
|
|
|
54089
54125
|
*/
|
|
54090
54126
|
export declare const PaymentSessionApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
54091
54127
|
/**
|
|
54092
|
-
* 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.
|
|
54128
|
+
* 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.
|
|
54093
54129
|
* @summary Cancel an in-flight card payment session (Viva or Nets)
|
|
54094
54130
|
* @param {string} clientToken The token the initiate answered for the session.
|
|
54095
54131
|
* @param {*} [options] Override http request option.
|
|
@@ -54153,7 +54189,7 @@ export declare const PaymentSessionApiFactory: (configuration?: Configuration, b
|
|
|
54153
54189
|
*/
|
|
54154
54190
|
initiateNetsSession(initiateNetsSessionDto: InitiateNetsSessionDto, xIdempotencyKey?: string, options?: any): AxiosPromise<InitiateNetsSessionResponseDto>;
|
|
54155
54191
|
/**
|
|
54156
|
-
* 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.
|
|
54192
|
+
* 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).
|
|
54157
54193
|
* @summary Start a card payment on the station\'s Nexi terminal
|
|
54158
54194
|
* @param {InitiateNexiSessionDto} initiateNexiSessionDto
|
|
54159
54195
|
* @param {string} [xIdempotencyKey] A UUID the app makes for this payment. A repeated key answers the session it started, without charging again.
|
|
@@ -54269,6 +54305,15 @@ export declare const PaymentSessionApiFactory: (configuration?: Configuration, b
|
|
|
54269
54305
|
* @throws {RequiredError}
|
|
54270
54306
|
*/
|
|
54271
54307
|
refundNetsSession(reverseSessionDto: ReverseSessionDto, options?: any): AxiosPromise<PaymentSessionViewDto>;
|
|
54308
|
+
/**
|
|
54309
|
+
* 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.
|
|
54310
|
+
* @summary Refund a paid Nexi sale, customer not present, with no card
|
|
54311
|
+
* @param {ReverseSessionDto} reverseSessionDto
|
|
54312
|
+
* @param {string} [xIdempotencyKey] A UUID the app makes for this refund. A repeated key answers the refund it started, without refunding again.
|
|
54313
|
+
* @param {*} [options] Override http request option.
|
|
54314
|
+
* @throws {RequiredError}
|
|
54315
|
+
*/
|
|
54316
|
+
refundNexiSession(reverseSessionDto: ReverseSessionDto, xIdempotencyKey?: string, options?: any): AxiosPromise<PaymentSessionViewDto>;
|
|
54272
54317
|
/**
|
|
54273
54318
|
* 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.
|
|
54274
54319
|
* @summary Refund a settled Viva payment session (gateway only)
|
|
@@ -54309,6 +54354,14 @@ export declare const PaymentSessionApiFactory: (configuration?: Configuration, b
|
|
|
54309
54354
|
* @throws {RequiredError}
|
|
54310
54355
|
*/
|
|
54311
54356
|
revertNetsSession(reverseSessionDto: ReverseSessionDto, options?: any): AxiosPromise<NetsRevertResponseDto>;
|
|
54357
|
+
/**
|
|
54358
|
+
* 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.
|
|
54359
|
+
* @summary Revert a paid Nexi sale: give back what is left and write the reversal onto the order
|
|
54360
|
+
* @param {ReverseSessionDto} reverseSessionDto
|
|
54361
|
+
* @param {*} [options] Override http request option.
|
|
54362
|
+
* @throws {RequiredError}
|
|
54363
|
+
*/
|
|
54364
|
+
revertNexiSession(reverseSessionDto: ReverseSessionDto, options?: any): AxiosPromise<PaymentSessionViewDto>;
|
|
54312
54365
|
/**
|
|
54313
54366
|
* 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.
|
|
54314
54367
|
* @summary Revert (fully reverse) a settled Viva payment session
|
|
@@ -54357,7 +54410,7 @@ export declare const PaymentSessionApiFactory: (configuration?: Configuration, b
|
|
|
54357
54410
|
*/
|
|
54358
54411
|
export interface PaymentSessionApiInterface {
|
|
54359
54412
|
/**
|
|
54360
|
-
* 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.
|
|
54413
|
+
* 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.
|
|
54361
54414
|
* @summary Cancel an in-flight card payment session (Viva or Nets)
|
|
54362
54415
|
* @param {string} clientToken The token the initiate answered for the session.
|
|
54363
54416
|
* @param {*} [options] Override http request option.
|
|
@@ -54428,7 +54481,7 @@ export interface PaymentSessionApiInterface {
|
|
|
54428
54481
|
*/
|
|
54429
54482
|
initiateNetsSession(initiateNetsSessionDto: InitiateNetsSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): AxiosPromise<InitiateNetsSessionResponseDto>;
|
|
54430
54483
|
/**
|
|
54431
|
-
* 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.
|
|
54484
|
+
* 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).
|
|
54432
54485
|
* @summary Start a card payment on the station\'s Nexi terminal
|
|
54433
54486
|
* @param {InitiateNexiSessionDto} initiateNexiSessionDto
|
|
54434
54487
|
* @param {string} [xIdempotencyKey] A UUID the app makes for this payment. A repeated key answers the session it started, without charging again.
|
|
@@ -54558,6 +54611,16 @@ export interface PaymentSessionApiInterface {
|
|
|
54558
54611
|
* @memberof PaymentSessionApiInterface
|
|
54559
54612
|
*/
|
|
54560
54613
|
refundNetsSession(reverseSessionDto: ReverseSessionDto, options?: AxiosRequestConfig): AxiosPromise<PaymentSessionViewDto>;
|
|
54614
|
+
/**
|
|
54615
|
+
* 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.
|
|
54616
|
+
* @summary Refund a paid Nexi sale, customer not present, with no card
|
|
54617
|
+
* @param {ReverseSessionDto} reverseSessionDto
|
|
54618
|
+
* @param {string} [xIdempotencyKey] A UUID the app makes for this refund. A repeated key answers the refund it started, without refunding again.
|
|
54619
|
+
* @param {*} [options] Override http request option.
|
|
54620
|
+
* @throws {RequiredError}
|
|
54621
|
+
* @memberof PaymentSessionApiInterface
|
|
54622
|
+
*/
|
|
54623
|
+
refundNexiSession(reverseSessionDto: ReverseSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): AxiosPromise<PaymentSessionViewDto>;
|
|
54561
54624
|
/**
|
|
54562
54625
|
* 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.
|
|
54563
54626
|
* @summary Refund a settled Viva payment session (gateway only)
|
|
@@ -54603,6 +54666,15 @@ export interface PaymentSessionApiInterface {
|
|
|
54603
54666
|
* @memberof PaymentSessionApiInterface
|
|
54604
54667
|
*/
|
|
54605
54668
|
revertNetsSession(reverseSessionDto: ReverseSessionDto, options?: AxiosRequestConfig): AxiosPromise<NetsRevertResponseDto>;
|
|
54669
|
+
/**
|
|
54670
|
+
* 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.
|
|
54671
|
+
* @summary Revert a paid Nexi sale: give back what is left and write the reversal onto the order
|
|
54672
|
+
* @param {ReverseSessionDto} reverseSessionDto
|
|
54673
|
+
* @param {*} [options] Override http request option.
|
|
54674
|
+
* @throws {RequiredError}
|
|
54675
|
+
* @memberof PaymentSessionApiInterface
|
|
54676
|
+
*/
|
|
54677
|
+
revertNexiSession(reverseSessionDto: ReverseSessionDto, options?: AxiosRequestConfig): AxiosPromise<PaymentSessionViewDto>;
|
|
54606
54678
|
/**
|
|
54607
54679
|
* 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.
|
|
54608
54680
|
* @summary Revert (fully reverse) a settled Viva payment session
|
|
@@ -54657,7 +54729,7 @@ export interface PaymentSessionApiInterface {
|
|
|
54657
54729
|
*/
|
|
54658
54730
|
export declare class PaymentSessionApi extends BaseAPI implements PaymentSessionApiInterface {
|
|
54659
54731
|
/**
|
|
54660
|
-
* 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.
|
|
54732
|
+
* 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.
|
|
54661
54733
|
* @summary Cancel an in-flight card payment session (Viva or Nets)
|
|
54662
54734
|
* @param {string} clientToken The token the initiate answered for the session.
|
|
54663
54735
|
* @param {*} [options] Override http request option.
|
|
@@ -54728,7 +54800,7 @@ export declare class PaymentSessionApi extends BaseAPI implements PaymentSession
|
|
|
54728
54800
|
*/
|
|
54729
54801
|
initiateNetsSession(initiateNetsSessionDto: InitiateNetsSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<InitiateNetsSessionResponseDto, any, {}>>;
|
|
54730
54802
|
/**
|
|
54731
|
-
* 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.
|
|
54803
|
+
* 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).
|
|
54732
54804
|
* @summary Start a card payment on the station\'s Nexi terminal
|
|
54733
54805
|
* @param {InitiateNexiSessionDto} initiateNexiSessionDto
|
|
54734
54806
|
* @param {string} [xIdempotencyKey] A UUID the app makes for this payment. A repeated key answers the session it started, without charging again.
|
|
@@ -54858,6 +54930,16 @@ export declare class PaymentSessionApi extends BaseAPI implements PaymentSession
|
|
|
54858
54930
|
* @memberof PaymentSessionApi
|
|
54859
54931
|
*/
|
|
54860
54932
|
refundNetsSession(reverseSessionDto: ReverseSessionDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PaymentSessionViewDto, any, {}>>;
|
|
54933
|
+
/**
|
|
54934
|
+
* 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.
|
|
54935
|
+
* @summary Refund a paid Nexi sale, customer not present, with no card
|
|
54936
|
+
* @param {ReverseSessionDto} reverseSessionDto
|
|
54937
|
+
* @param {string} [xIdempotencyKey] A UUID the app makes for this refund. A repeated key answers the refund it started, without refunding again.
|
|
54938
|
+
* @param {*} [options] Override http request option.
|
|
54939
|
+
* @throws {RequiredError}
|
|
54940
|
+
* @memberof PaymentSessionApi
|
|
54941
|
+
*/
|
|
54942
|
+
refundNexiSession(reverseSessionDto: ReverseSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PaymentSessionViewDto, any, {}>>;
|
|
54861
54943
|
/**
|
|
54862
54944
|
* 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.
|
|
54863
54945
|
* @summary Refund a settled Viva payment session (gateway only)
|
|
@@ -54903,6 +54985,15 @@ export declare class PaymentSessionApi extends BaseAPI implements PaymentSession
|
|
|
54903
54985
|
* @memberof PaymentSessionApi
|
|
54904
54986
|
*/
|
|
54905
54987
|
revertNetsSession(reverseSessionDto: ReverseSessionDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<NetsRevertResponseDto, any, {}>>;
|
|
54988
|
+
/**
|
|
54989
|
+
* 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.
|
|
54990
|
+
* @summary Revert a paid Nexi sale: give back what is left and write the reversal onto the order
|
|
54991
|
+
* @param {ReverseSessionDto} reverseSessionDto
|
|
54992
|
+
* @param {*} [options] Override http request option.
|
|
54993
|
+
* @throws {RequiredError}
|
|
54994
|
+
* @memberof PaymentSessionApi
|
|
54995
|
+
*/
|
|
54996
|
+
revertNexiSession(reverseSessionDto: ReverseSessionDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PaymentSessionViewDto, any, {}>>;
|
|
54906
54997
|
/**
|
|
54907
54998
|
* 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.
|
|
54908
54999
|
* @summary Revert (fully reverse) a settled Viva payment session
|
|
@@ -56003,21 +56094,21 @@ export declare const ReceiptFooterApiAxiosParamCreator: (configuration?: Configu
|
|
|
56003
56094
|
* 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.
|
|
56004
56095
|
* @summary Get the receipt footer config for a business + channel
|
|
56005
56096
|
* @param {number} businessId The venue whose footer is read or written: its orderingBusinessId
|
|
56006
|
-
* @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
|
|
56097
|
+
* @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
|
|
56007
56098
|
* @param {*} [options] Override http request option.
|
|
56008
56099
|
* @throws {RequiredError}
|
|
56009
56100
|
*/
|
|
56010
|
-
receiptFooterGetConfig: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
56101
|
+
receiptFooterGetConfig: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ" | "Partner", options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
56011
56102
|
/**
|
|
56012
56103
|
* 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.
|
|
56013
56104
|
* @summary Create or update the receipt footer config for a business + channel
|
|
56014
56105
|
* @param {number} businessId The venue whose footer is read or written: its orderingBusinessId
|
|
56015
|
-
* @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
|
|
56106
|
+
* @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
|
|
56016
56107
|
* @param {UpsertReceiptFooterDto} upsertReceiptFooterDto
|
|
56017
56108
|
* @param {*} [options] Override http request option.
|
|
56018
56109
|
* @throws {RequiredError}
|
|
56019
56110
|
*/
|
|
56020
|
-
receiptFooterUpsertConfig: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertReceiptFooterDto: UpsertReceiptFooterDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
56111
|
+
receiptFooterUpsertConfig: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ" | "Partner", upsertReceiptFooterDto: UpsertReceiptFooterDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
56021
56112
|
};
|
|
56022
56113
|
/**
|
|
56023
56114
|
* ReceiptFooterApi - functional programming interface
|
|
@@ -56028,21 +56119,21 @@ export declare const ReceiptFooterApiFp: (configuration?: Configuration) => {
|
|
|
56028
56119
|
* 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.
|
|
56029
56120
|
* @summary Get the receipt footer config for a business + channel
|
|
56030
56121
|
* @param {number} businessId The venue whose footer is read or written: its orderingBusinessId
|
|
56031
|
-
* @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
|
|
56122
|
+
* @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
|
|
56032
56123
|
* @param {*} [options] Override http request option.
|
|
56033
56124
|
* @throws {RequiredError}
|
|
56034
56125
|
*/
|
|
56035
|
-
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>>;
|
|
56126
|
+
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>>;
|
|
56036
56127
|
/**
|
|
56037
56128
|
* 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.
|
|
56038
56129
|
* @summary Create or update the receipt footer config for a business + channel
|
|
56039
56130
|
* @param {number} businessId The venue whose footer is read or written: its orderingBusinessId
|
|
56040
|
-
* @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
|
|
56131
|
+
* @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
|
|
56041
56132
|
* @param {UpsertReceiptFooterDto} upsertReceiptFooterDto
|
|
56042
56133
|
* @param {*} [options] Override http request option.
|
|
56043
56134
|
* @throws {RequiredError}
|
|
56044
56135
|
*/
|
|
56045
|
-
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>>;
|
|
56136
|
+
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>>;
|
|
56046
56137
|
};
|
|
56047
56138
|
/**
|
|
56048
56139
|
* ReceiptFooterApi - factory interface
|
|
@@ -56053,21 +56144,21 @@ export declare const ReceiptFooterApiFactory: (configuration?: Configuration, ba
|
|
|
56053
56144
|
* 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.
|
|
56054
56145
|
* @summary Get the receipt footer config for a business + channel
|
|
56055
56146
|
* @param {number} businessId The venue whose footer is read or written: its orderingBusinessId
|
|
56056
|
-
* @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
|
|
56147
|
+
* @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
|
|
56057
56148
|
* @param {*} [options] Override http request option.
|
|
56058
56149
|
* @throws {RequiredError}
|
|
56059
56150
|
*/
|
|
56060
|
-
receiptFooterGetConfig(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", options?: any): AxiosPromise<ReceiptFooterConfigDto>;
|
|
56151
|
+
receiptFooterGetConfig(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ" | "Partner", options?: any): AxiosPromise<ReceiptFooterConfigDto>;
|
|
56061
56152
|
/**
|
|
56062
56153
|
* 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.
|
|
56063
56154
|
* @summary Create or update the receipt footer config for a business + channel
|
|
56064
56155
|
* @param {number} businessId The venue whose footer is read or written: its orderingBusinessId
|
|
56065
|
-
* @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
|
|
56156
|
+
* @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
|
|
56066
56157
|
* @param {UpsertReceiptFooterDto} upsertReceiptFooterDto
|
|
56067
56158
|
* @param {*} [options] Override http request option.
|
|
56068
56159
|
* @throws {RequiredError}
|
|
56069
56160
|
*/
|
|
56070
|
-
receiptFooterUpsertConfig(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertReceiptFooterDto: UpsertReceiptFooterDto, options?: any): AxiosPromise<ReceiptFooterConfigDto>;
|
|
56161
|
+
receiptFooterUpsertConfig(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ" | "Partner", upsertReceiptFooterDto: UpsertReceiptFooterDto, options?: any): AxiosPromise<ReceiptFooterConfigDto>;
|
|
56071
56162
|
};
|
|
56072
56163
|
/**
|
|
56073
56164
|
* ReceiptFooterApi - interface
|
|
@@ -56079,23 +56170,23 @@ export interface ReceiptFooterApiInterface {
|
|
|
56079
56170
|
* 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.
|
|
56080
56171
|
* @summary Get the receipt footer config for a business + channel
|
|
56081
56172
|
* @param {number} businessId The venue whose footer is read or written: its orderingBusinessId
|
|
56082
|
-
* @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
|
|
56173
|
+
* @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
|
|
56083
56174
|
* @param {*} [options] Override http request option.
|
|
56084
56175
|
* @throws {RequiredError}
|
|
56085
56176
|
* @memberof ReceiptFooterApiInterface
|
|
56086
56177
|
*/
|
|
56087
|
-
receiptFooterGetConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', options?: AxiosRequestConfig): AxiosPromise<ReceiptFooterConfigDto>;
|
|
56178
|
+
receiptFooterGetConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', options?: AxiosRequestConfig): AxiosPromise<ReceiptFooterConfigDto>;
|
|
56088
56179
|
/**
|
|
56089
56180
|
* 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.
|
|
56090
56181
|
* @summary Create or update the receipt footer config for a business + channel
|
|
56091
56182
|
* @param {number} businessId The venue whose footer is read or written: its orderingBusinessId
|
|
56092
|
-
* @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
|
|
56183
|
+
* @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
|
|
56093
56184
|
* @param {UpsertReceiptFooterDto} upsertReceiptFooterDto
|
|
56094
56185
|
* @param {*} [options] Override http request option.
|
|
56095
56186
|
* @throws {RequiredError}
|
|
56096
56187
|
* @memberof ReceiptFooterApiInterface
|
|
56097
56188
|
*/
|
|
56098
|
-
receiptFooterUpsertConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertReceiptFooterDto: UpsertReceiptFooterDto, options?: AxiosRequestConfig): AxiosPromise<ReceiptFooterConfigDto>;
|
|
56189
|
+
receiptFooterUpsertConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertReceiptFooterDto: UpsertReceiptFooterDto, options?: AxiosRequestConfig): AxiosPromise<ReceiptFooterConfigDto>;
|
|
56099
56190
|
}
|
|
56100
56191
|
/**
|
|
56101
56192
|
* ReceiptFooterApi - object-oriented interface
|
|
@@ -56108,23 +56199,23 @@ export declare class ReceiptFooterApi extends BaseAPI implements ReceiptFooterAp
|
|
|
56108
56199
|
* 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.
|
|
56109
56200
|
* @summary Get the receipt footer config for a business + channel
|
|
56110
56201
|
* @param {number} businessId The venue whose footer is read or written: its orderingBusinessId
|
|
56111
|
-
* @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
|
|
56202
|
+
* @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
|
|
56112
56203
|
* @param {*} [options] Override http request option.
|
|
56113
56204
|
* @throws {RequiredError}
|
|
56114
56205
|
* @memberof ReceiptFooterApi
|
|
56115
56206
|
*/
|
|
56116
|
-
receiptFooterGetConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ReceiptFooterConfigDto, any, {}>>;
|
|
56207
|
+
receiptFooterGetConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ReceiptFooterConfigDto, any, {}>>;
|
|
56117
56208
|
/**
|
|
56118
56209
|
* 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.
|
|
56119
56210
|
* @summary Create or update the receipt footer config for a business + channel
|
|
56120
56211
|
* @param {number} businessId The venue whose footer is read or written: its orderingBusinessId
|
|
56121
|
-
* @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
|
|
56212
|
+
* @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
|
|
56122
56213
|
* @param {UpsertReceiptFooterDto} upsertReceiptFooterDto
|
|
56123
56214
|
* @param {*} [options] Override http request option.
|
|
56124
56215
|
* @throws {RequiredError}
|
|
56125
56216
|
* @memberof ReceiptFooterApi
|
|
56126
56217
|
*/
|
|
56127
|
-
receiptFooterUpsertConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertReceiptFooterDto: UpsertReceiptFooterDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ReceiptFooterConfigDto, any, {}>>;
|
|
56218
|
+
receiptFooterUpsertConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ' | 'Partner', upsertReceiptFooterDto: UpsertReceiptFooterDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ReceiptFooterConfigDto, any, {}>>;
|
|
56128
56219
|
}
|
|
56129
56220
|
/**
|
|
56130
56221
|
* RefundsApi - axios parameter creator
|