@munchi_oy/core 2.15.0 → 2.15.1
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 +215 -8
- 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 +354 -8
- package/package.json +13 -15
- package/src/version.ts +1 -1
package/dist/generated/api.d.ts
CHANGED
|
@@ -4596,6 +4596,18 @@ export interface CreateMunchiGiftCardDto {
|
|
|
4596
4596
|
* @memberof CreateMunchiGiftCardDto
|
|
4597
4597
|
*/
|
|
4598
4598
|
'purchaserEmail'?: string;
|
|
4599
|
+
/**
|
|
4600
|
+
* Whether the card is emailed to purchaserEmail once it is ACTIVE: at once for a card sold ACTIVE, when its order is paid for one sold PENDING. Absent: true. Without purchaserEmail nothing is sent.
|
|
4601
|
+
* @type {boolean}
|
|
4602
|
+
* @memberof CreateMunchiGiftCardDto
|
|
4603
|
+
*/
|
|
4604
|
+
'sendEmail'?: boolean;
|
|
4605
|
+
/**
|
|
4606
|
+
* The message shown in the card\'s email, 1 to 300 characters once the spaces around it are dropped: the buyer\'s own words. Absent or only spaces: none.
|
|
4607
|
+
* @type {string}
|
|
4608
|
+
* @memberof CreateMunchiGiftCardDto
|
|
4609
|
+
*/
|
|
4610
|
+
'message'?: string;
|
|
4599
4611
|
/**
|
|
4600
4612
|
* The country code of the buyer\'s phone, 1 to 8 characters as sent; spaces around it are dropped
|
|
4601
4613
|
* @type {string}
|
|
@@ -4878,6 +4890,31 @@ export interface CreatePaymentMethodDtoGiftCardCredentials {
|
|
|
4878
4890
|
*/
|
|
4879
4891
|
'uniquePosDeviceId'?: string;
|
|
4880
4892
|
}
|
|
4893
|
+
/**
|
|
4894
|
+
*
|
|
4895
|
+
* @export
|
|
4896
|
+
* @interface CreatePaymentTerminalDto
|
|
4897
|
+
*/
|
|
4898
|
+
export interface CreatePaymentTerminalDto {
|
|
4899
|
+
/**
|
|
4900
|
+
*
|
|
4901
|
+
* @type {TerminalProvider}
|
|
4902
|
+
* @memberof CreatePaymentTerminalDto
|
|
4903
|
+
*/
|
|
4904
|
+
'provider': TerminalProvider;
|
|
4905
|
+
/**
|
|
4906
|
+
* The provider\'s own id of the terminal, trimmed: for viva the terminal ID (TID) in Viva\'s portal, digits only (16010572); for nets the terminal ID (TID), digits only (72102200); for worldline the terminal\'s serial number, letters and digits (253SKD884468). The payment is sent to the provider with this id, so it must be the id the provider knows
|
|
4907
|
+
* @type {string}
|
|
4908
|
+
* @memberof CreatePaymentTerminalDto
|
|
4909
|
+
*/
|
|
4910
|
+
'hardwareId': string;
|
|
4911
|
+
/**
|
|
4912
|
+
* The terminal\'s name, as the venue\'s staff call it
|
|
4913
|
+
* @type {string}
|
|
4914
|
+
* @memberof CreatePaymentTerminalDto
|
|
4915
|
+
*/
|
|
4916
|
+
'label': string;
|
|
4917
|
+
}
|
|
4881
4918
|
/**
|
|
4882
4919
|
*
|
|
4883
4920
|
* @export
|
|
@@ -5197,7 +5234,7 @@ export interface CreateVenueGiftCardDto {
|
|
|
5197
5234
|
*/
|
|
5198
5235
|
'note'?: string;
|
|
5199
5236
|
/**
|
|
5200
|
-
* The message shown in the card\'s email, 1 to 300 characters: the buyer\'s or the store\'s own words. Absent: none.
|
|
5237
|
+
* The message shown in the card\'s email, 1 to 300 characters once the spaces around it are dropped: the buyer\'s or the store\'s own words. Absent or only spaces: none.
|
|
5201
5238
|
* @type {string}
|
|
5202
5239
|
* @memberof CreateVenueGiftCardDto
|
|
5203
5240
|
*/
|
|
@@ -26771,6 +26808,19 @@ export interface ReleasedLicenceHoldsDto {
|
|
|
26771
26808
|
*/
|
|
26772
26809
|
'nextAfterVenueId': number | null;
|
|
26773
26810
|
}
|
|
26811
|
+
/**
|
|
26812
|
+
*
|
|
26813
|
+
* @export
|
|
26814
|
+
* @interface RenamePaymentTerminalDto
|
|
26815
|
+
*/
|
|
26816
|
+
export interface RenamePaymentTerminalDto {
|
|
26817
|
+
/**
|
|
26818
|
+
* The terminal\'s new name; nothing else of the terminal changes
|
|
26819
|
+
* @type {string}
|
|
26820
|
+
* @memberof RenamePaymentTerminalDto
|
|
26821
|
+
*/
|
|
26822
|
+
'label': string;
|
|
26823
|
+
}
|
|
26774
26824
|
/**
|
|
26775
26825
|
*
|
|
26776
26826
|
* @export
|
|
@@ -33441,6 +33491,17 @@ export declare const TerminalConnectionType: {
|
|
|
33441
33491
|
readonly Network: "NETWORK";
|
|
33442
33492
|
};
|
|
33443
33493
|
export type TerminalConnectionType = typeof TerminalConnectionType[keyof typeof TerminalConnectionType];
|
|
33494
|
+
/**
|
|
33495
|
+
*
|
|
33496
|
+
* @export
|
|
33497
|
+
* @enum {string}
|
|
33498
|
+
*/
|
|
33499
|
+
export declare const TerminalProvider: {
|
|
33500
|
+
readonly Viva: "viva";
|
|
33501
|
+
readonly Nets: "nets";
|
|
33502
|
+
readonly Worldline: "worldline";
|
|
33503
|
+
};
|
|
33504
|
+
export type TerminalProvider = typeof TerminalProvider[keyof typeof TerminalProvider];
|
|
33444
33505
|
/**
|
|
33445
33506
|
*
|
|
33446
33507
|
* @export
|
|
@@ -36509,7 +36570,7 @@ export interface UpdateVenueGiftCardDto {
|
|
|
36509
36570
|
* @type {GiftCardLanguage}
|
|
36510
36571
|
* @memberof UpdateVenueGiftCardDto
|
|
36511
36572
|
*/
|
|
36512
|
-
'language'?: GiftCardLanguage;
|
|
36573
|
+
'language'?: GiftCardLanguage | null;
|
|
36513
36574
|
}
|
|
36514
36575
|
/**
|
|
36515
36576
|
*
|
|
@@ -38063,7 +38124,7 @@ export interface VenuePaymentTerminalDto {
|
|
|
38063
38124
|
*/
|
|
38064
38125
|
export interface VenuePaymentTerminalsDto {
|
|
38065
38126
|
/**
|
|
38066
|
-
* The venue\'s payment terminals as stored, oldest first; a terminal is stored once a till has discovered it
|
|
38127
|
+
* The venue\'s payment terminals as stored, oldest first; a terminal is stored once a till has discovered it at its provider, or once Munchi ops added it
|
|
38067
38128
|
* @type {Array<VenuePaymentTerminalDto>}
|
|
38068
38129
|
* @memberof VenuePaymentTerminalsDto
|
|
38069
38130
|
*/
|
|
@@ -59782,6 +59843,15 @@ export declare const VenueKiosksApiAxiosParamCreator: (configuration?: Configura
|
|
|
59782
59843
|
* @throws {RequiredError}
|
|
59783
59844
|
*/
|
|
59784
59845
|
claimVenueKiosk: (businessId: number, claimKioskDto: ClaimKioskDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
59846
|
+
/**
|
|
59847
|
+
* Munchi ops store a card terminal for the venue by the id its provider gives it, so a kiosk or till can take it. Only a Munchi admin\'s ticket or Munchi\'s own Clerk key may (D161); the venue\'s own logins are refused. hardwareId is checked against its provider\'s shape: Viva\'s and Nets\' terminal ID (TID) are digits, a Worldline terminal\'s serial number letters and digits. The provider is not asked: the terminal must already be registered on the venue\'s account at the provider, or its payments are refused there. The terminal is stored free, linked to no station. A terminal id the venue already stores, under any provider, is refused; so is a Worldline terminal another venue stores, since Worldline finds a terminal by its id alone. Viva and Nets terminals may be stored at several venues, as discover stores them.
|
|
59848
|
+
* @summary Add a payment terminal to the venue (Munchi admins only)
|
|
59849
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
59850
|
+
* @param {CreatePaymentTerminalDto} createPaymentTerminalDto
|
|
59851
|
+
* @param {*} [options] Override http request option.
|
|
59852
|
+
* @throws {RequiredError}
|
|
59853
|
+
*/
|
|
59854
|
+
createVenuePaymentTerminal: (businessId: number, createPaymentTerminalDto: CreatePaymentTerminalDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
59785
59855
|
/**
|
|
59786
59856
|
* paymentTerminalId names one of the venue\'s stored terminals, or null unlinks the kiosk\'s terminal. A terminal another kiosk or till holds is refused, never taken from it. The kiosk\'s kept station is forgotten, so the kiosk pays on the new terminal from its next request.
|
|
59787
59857
|
* @summary Link one of the venue\'s payment terminals to a kiosk, or unlink it
|
|
@@ -59801,7 +59871,7 @@ export declare const VenueKiosksApiAxiosParamCreator: (configuration?: Configura
|
|
|
59801
59871
|
*/
|
|
59802
59872
|
listVenueKiosks: (businessId: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
59803
59873
|
/**
|
|
59804
|
-
* The venue\'s stored terminals, oldest first, each with the station it is linked to. A terminal is stored once a till discovered it at its provider (POST /v1/terminal/discover); this route asks no provider.
|
|
59874
|
+
* The venue\'s stored terminals, oldest first, each with the station it is linked to. A terminal is stored once a till discovered it at its provider (POST /v1/terminal/discover), or once Munchi ops added it (POST payment-terminals); this route asks no provider.
|
|
59805
59875
|
* @summary List the venue\'s payment terminals, for linking one to a kiosk
|
|
59806
59876
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
59807
59877
|
* @param {*} [options] Override http request option.
|
|
@@ -59817,6 +59887,25 @@ export declare const VenueKiosksApiAxiosParamCreator: (configuration?: Configura
|
|
|
59817
59887
|
* @throws {RequiredError}
|
|
59818
59888
|
*/
|
|
59819
59889
|
removeVenueKiosk: (businessId: number, stationId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
59890
|
+
/**
|
|
59891
|
+
* The terminal\'s row is deleted; payments made on it keep its id in their own records. Only a Munchi admin\'s ticket or Munchi\'s own Clerk key may (D161). Refused while a kiosk or till holds the terminal, and while a payment, reversal or refund started on it in the last 24 hours is still waiting on the terminal. Both are read under a lock on the terminal, so a link made meanwhile is never undone silently. A Viva or Nets terminal still on the venue\'s provider account is stored again on a till\'s next discover.
|
|
59892
|
+
* @summary Remove a payment terminal from the venue (Munchi admins only)
|
|
59893
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
59894
|
+
* @param {string} paymentTerminalId The payment terminal\'s id, as the venue\'s terminal list answers it
|
|
59895
|
+
* @param {*} [options] Override http request option.
|
|
59896
|
+
* @throws {RequiredError}
|
|
59897
|
+
*/
|
|
59898
|
+
removeVenuePaymentTerminal: (businessId: number, paymentTerminalId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
59899
|
+
/**
|
|
59900
|
+
* Only the label changes; the provider and its terminal id stay, and a kiosk or till holding the terminal keeps paying on it and shows the new label from its next request. Only a Munchi admin\'s ticket or Munchi\'s own Clerk key may (D161). Two renames at once both write; the later one\'s label stays.
|
|
59901
|
+
* @summary Rename one of the venue\'s payment terminals (Munchi admins only)
|
|
59902
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
59903
|
+
* @param {string} paymentTerminalId The payment terminal\'s id, as the venue\'s terminal list answers it
|
|
59904
|
+
* @param {RenamePaymentTerminalDto} renamePaymentTerminalDto
|
|
59905
|
+
* @param {*} [options] Override http request option.
|
|
59906
|
+
* @throws {RequiredError}
|
|
59907
|
+
*/
|
|
59908
|
+
renameVenuePaymentTerminal: (businessId: number, paymentTerminalId: string, renamePaymentTerminalDto: RenamePaymentTerminalDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
59820
59909
|
};
|
|
59821
59910
|
/**
|
|
59822
59911
|
* VenueKiosksApi - functional programming interface
|
|
@@ -59842,6 +59931,15 @@ export declare const VenueKiosksApiFp: (configuration?: Configuration) => {
|
|
|
59842
59931
|
* @throws {RequiredError}
|
|
59843
59932
|
*/
|
|
59844
59933
|
claimVenueKiosk(businessId: number, claimKioskDto: ClaimKioskDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueKioskDto>>;
|
|
59934
|
+
/**
|
|
59935
|
+
* Munchi ops store a card terminal for the venue by the id its provider gives it, so a kiosk or till can take it. Only a Munchi admin\'s ticket or Munchi\'s own Clerk key may (D161); the venue\'s own logins are refused. hardwareId is checked against its provider\'s shape: Viva\'s and Nets\' terminal ID (TID) are digits, a Worldline terminal\'s serial number letters and digits. The provider is not asked: the terminal must already be registered on the venue\'s account at the provider, or its payments are refused there. The terminal is stored free, linked to no station. A terminal id the venue already stores, under any provider, is refused; so is a Worldline terminal another venue stores, since Worldline finds a terminal by its id alone. Viva and Nets terminals may be stored at several venues, as discover stores them.
|
|
59936
|
+
* @summary Add a payment terminal to the venue (Munchi admins only)
|
|
59937
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
59938
|
+
* @param {CreatePaymentTerminalDto} createPaymentTerminalDto
|
|
59939
|
+
* @param {*} [options] Override http request option.
|
|
59940
|
+
* @throws {RequiredError}
|
|
59941
|
+
*/
|
|
59942
|
+
createVenuePaymentTerminal(businessId: number, createPaymentTerminalDto: CreatePaymentTerminalDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenuePaymentTerminalDto>>;
|
|
59845
59943
|
/**
|
|
59846
59944
|
* paymentTerminalId names one of the venue\'s stored terminals, or null unlinks the kiosk\'s terminal. A terminal another kiosk or till holds is refused, never taken from it. The kiosk\'s kept station is forgotten, so the kiosk pays on the new terminal from its next request.
|
|
59847
59945
|
* @summary Link one of the venue\'s payment terminals to a kiosk, or unlink it
|
|
@@ -59861,7 +59959,7 @@ export declare const VenueKiosksApiFp: (configuration?: Configuration) => {
|
|
|
59861
59959
|
*/
|
|
59862
59960
|
listVenueKiosks(businessId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueKiosksDto>>;
|
|
59863
59961
|
/**
|
|
59864
|
-
* The venue\'s stored terminals, oldest first, each with the station it is linked to. A terminal is stored once a till discovered it at its provider (POST /v1/terminal/discover); this route asks no provider.
|
|
59962
|
+
* The venue\'s stored terminals, oldest first, each with the station it is linked to. A terminal is stored once a till discovered it at its provider (POST /v1/terminal/discover), or once Munchi ops added it (POST payment-terminals); this route asks no provider.
|
|
59865
59963
|
* @summary List the venue\'s payment terminals, for linking one to a kiosk
|
|
59866
59964
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
59867
59965
|
* @param {*} [options] Override http request option.
|
|
@@ -59877,6 +59975,25 @@ export declare const VenueKiosksApiFp: (configuration?: Configuration) => {
|
|
|
59877
59975
|
* @throws {RequiredError}
|
|
59878
59976
|
*/
|
|
59879
59977
|
removeVenueKiosk(businessId: number, stationId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueKioskDto>>;
|
|
59978
|
+
/**
|
|
59979
|
+
* The terminal\'s row is deleted; payments made on it keep its id in their own records. Only a Munchi admin\'s ticket or Munchi\'s own Clerk key may (D161). Refused while a kiosk or till holds the terminal, and while a payment, reversal or refund started on it in the last 24 hours is still waiting on the terminal. Both are read under a lock on the terminal, so a link made meanwhile is never undone silently. A Viva or Nets terminal still on the venue\'s provider account is stored again on a till\'s next discover.
|
|
59980
|
+
* @summary Remove a payment terminal from the venue (Munchi admins only)
|
|
59981
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
59982
|
+
* @param {string} paymentTerminalId The payment terminal\'s id, as the venue\'s terminal list answers it
|
|
59983
|
+
* @param {*} [options] Override http request option.
|
|
59984
|
+
* @throws {RequiredError}
|
|
59985
|
+
*/
|
|
59986
|
+
removeVenuePaymentTerminal(businessId: number, paymentTerminalId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenuePaymentTerminalDto>>;
|
|
59987
|
+
/**
|
|
59988
|
+
* Only the label changes; the provider and its terminal id stay, and a kiosk or till holding the terminal keeps paying on it and shows the new label from its next request. Only a Munchi admin\'s ticket or Munchi\'s own Clerk key may (D161). Two renames at once both write; the later one\'s label stays.
|
|
59989
|
+
* @summary Rename one of the venue\'s payment terminals (Munchi admins only)
|
|
59990
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
59991
|
+
* @param {string} paymentTerminalId The payment terminal\'s id, as the venue\'s terminal list answers it
|
|
59992
|
+
* @param {RenamePaymentTerminalDto} renamePaymentTerminalDto
|
|
59993
|
+
* @param {*} [options] Override http request option.
|
|
59994
|
+
* @throws {RequiredError}
|
|
59995
|
+
*/
|
|
59996
|
+
renameVenuePaymentTerminal(businessId: number, paymentTerminalId: string, renamePaymentTerminalDto: RenamePaymentTerminalDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenuePaymentTerminalDto>>;
|
|
59880
59997
|
};
|
|
59881
59998
|
/**
|
|
59882
59999
|
* VenueKiosksApi - factory interface
|
|
@@ -59902,6 +60019,15 @@ export declare const VenueKiosksApiFactory: (configuration?: Configuration, base
|
|
|
59902
60019
|
* @throws {RequiredError}
|
|
59903
60020
|
*/
|
|
59904
60021
|
claimVenueKiosk(businessId: number, claimKioskDto: ClaimKioskDto, options?: any): AxiosPromise<VenueKioskDto>;
|
|
60022
|
+
/**
|
|
60023
|
+
* Munchi ops store a card terminal for the venue by the id its provider gives it, so a kiosk or till can take it. Only a Munchi admin\'s ticket or Munchi\'s own Clerk key may (D161); the venue\'s own logins are refused. hardwareId is checked against its provider\'s shape: Viva\'s and Nets\' terminal ID (TID) are digits, a Worldline terminal\'s serial number letters and digits. The provider is not asked: the terminal must already be registered on the venue\'s account at the provider, or its payments are refused there. The terminal is stored free, linked to no station. A terminal id the venue already stores, under any provider, is refused; so is a Worldline terminal another venue stores, since Worldline finds a terminal by its id alone. Viva and Nets terminals may be stored at several venues, as discover stores them.
|
|
60024
|
+
* @summary Add a payment terminal to the venue (Munchi admins only)
|
|
60025
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60026
|
+
* @param {CreatePaymentTerminalDto} createPaymentTerminalDto
|
|
60027
|
+
* @param {*} [options] Override http request option.
|
|
60028
|
+
* @throws {RequiredError}
|
|
60029
|
+
*/
|
|
60030
|
+
createVenuePaymentTerminal(businessId: number, createPaymentTerminalDto: CreatePaymentTerminalDto, options?: any): AxiosPromise<VenuePaymentTerminalDto>;
|
|
59905
60031
|
/**
|
|
59906
60032
|
* paymentTerminalId names one of the venue\'s stored terminals, or null unlinks the kiosk\'s terminal. A terminal another kiosk or till holds is refused, never taken from it. The kiosk\'s kept station is forgotten, so the kiosk pays on the new terminal from its next request.
|
|
59907
60033
|
* @summary Link one of the venue\'s payment terminals to a kiosk, or unlink it
|
|
@@ -59921,7 +60047,7 @@ export declare const VenueKiosksApiFactory: (configuration?: Configuration, base
|
|
|
59921
60047
|
*/
|
|
59922
60048
|
listVenueKiosks(businessId: number, options?: any): AxiosPromise<VenueKiosksDto>;
|
|
59923
60049
|
/**
|
|
59924
|
-
* The venue\'s stored terminals, oldest first, each with the station it is linked to. A terminal is stored once a till discovered it at its provider (POST /v1/terminal/discover); this route asks no provider.
|
|
60050
|
+
* The venue\'s stored terminals, oldest first, each with the station it is linked to. A terminal is stored once a till discovered it at its provider (POST /v1/terminal/discover), or once Munchi ops added it (POST payment-terminals); this route asks no provider.
|
|
59925
60051
|
* @summary List the venue\'s payment terminals, for linking one to a kiosk
|
|
59926
60052
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
59927
60053
|
* @param {*} [options] Override http request option.
|
|
@@ -59937,6 +60063,25 @@ export declare const VenueKiosksApiFactory: (configuration?: Configuration, base
|
|
|
59937
60063
|
* @throws {RequiredError}
|
|
59938
60064
|
*/
|
|
59939
60065
|
removeVenueKiosk(businessId: number, stationId: string, options?: any): AxiosPromise<VenueKioskDto>;
|
|
60066
|
+
/**
|
|
60067
|
+
* The terminal\'s row is deleted; payments made on it keep its id in their own records. Only a Munchi admin\'s ticket or Munchi\'s own Clerk key may (D161). Refused while a kiosk or till holds the terminal, and while a payment, reversal or refund started on it in the last 24 hours is still waiting on the terminal. Both are read under a lock on the terminal, so a link made meanwhile is never undone silently. A Viva or Nets terminal still on the venue\'s provider account is stored again on a till\'s next discover.
|
|
60068
|
+
* @summary Remove a payment terminal from the venue (Munchi admins only)
|
|
60069
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60070
|
+
* @param {string} paymentTerminalId The payment terminal\'s id, as the venue\'s terminal list answers it
|
|
60071
|
+
* @param {*} [options] Override http request option.
|
|
60072
|
+
* @throws {RequiredError}
|
|
60073
|
+
*/
|
|
60074
|
+
removeVenuePaymentTerminal(businessId: number, paymentTerminalId: string, options?: any): AxiosPromise<VenuePaymentTerminalDto>;
|
|
60075
|
+
/**
|
|
60076
|
+
* Only the label changes; the provider and its terminal id stay, and a kiosk or till holding the terminal keeps paying on it and shows the new label from its next request. Only a Munchi admin\'s ticket or Munchi\'s own Clerk key may (D161). Two renames at once both write; the later one\'s label stays.
|
|
60077
|
+
* @summary Rename one of the venue\'s payment terminals (Munchi admins only)
|
|
60078
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60079
|
+
* @param {string} paymentTerminalId The payment terminal\'s id, as the venue\'s terminal list answers it
|
|
60080
|
+
* @param {RenamePaymentTerminalDto} renamePaymentTerminalDto
|
|
60081
|
+
* @param {*} [options] Override http request option.
|
|
60082
|
+
* @throws {RequiredError}
|
|
60083
|
+
*/
|
|
60084
|
+
renameVenuePaymentTerminal(businessId: number, paymentTerminalId: string, renamePaymentTerminalDto: RenamePaymentTerminalDto, options?: any): AxiosPromise<VenuePaymentTerminalDto>;
|
|
59940
60085
|
};
|
|
59941
60086
|
/**
|
|
59942
60087
|
* VenueKiosksApi - interface
|
|
@@ -59965,6 +60110,16 @@ export interface VenueKiosksApiInterface {
|
|
|
59965
60110
|
* @memberof VenueKiosksApiInterface
|
|
59966
60111
|
*/
|
|
59967
60112
|
claimVenueKiosk(businessId: number, claimKioskDto: ClaimKioskDto, options?: AxiosRequestConfig): AxiosPromise<VenueKioskDto>;
|
|
60113
|
+
/**
|
|
60114
|
+
* Munchi ops store a card terminal for the venue by the id its provider gives it, so a kiosk or till can take it. Only a Munchi admin\'s ticket or Munchi\'s own Clerk key may (D161); the venue\'s own logins are refused. hardwareId is checked against its provider\'s shape: Viva\'s and Nets\' terminal ID (TID) are digits, a Worldline terminal\'s serial number letters and digits. The provider is not asked: the terminal must already be registered on the venue\'s account at the provider, or its payments are refused there. The terminal is stored free, linked to no station. A terminal id the venue already stores, under any provider, is refused; so is a Worldline terminal another venue stores, since Worldline finds a terminal by its id alone. Viva and Nets terminals may be stored at several venues, as discover stores them.
|
|
60115
|
+
* @summary Add a payment terminal to the venue (Munchi admins only)
|
|
60116
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60117
|
+
* @param {CreatePaymentTerminalDto} createPaymentTerminalDto
|
|
60118
|
+
* @param {*} [options] Override http request option.
|
|
60119
|
+
* @throws {RequiredError}
|
|
60120
|
+
* @memberof VenueKiosksApiInterface
|
|
60121
|
+
*/
|
|
60122
|
+
createVenuePaymentTerminal(businessId: number, createPaymentTerminalDto: CreatePaymentTerminalDto, options?: AxiosRequestConfig): AxiosPromise<VenuePaymentTerminalDto>;
|
|
59968
60123
|
/**
|
|
59969
60124
|
* paymentTerminalId names one of the venue\'s stored terminals, or null unlinks the kiosk\'s terminal. A terminal another kiosk or till holds is refused, never taken from it. The kiosk\'s kept station is forgotten, so the kiosk pays on the new terminal from its next request.
|
|
59970
60125
|
* @summary Link one of the venue\'s payment terminals to a kiosk, or unlink it
|
|
@@ -59986,7 +60141,7 @@ export interface VenueKiosksApiInterface {
|
|
|
59986
60141
|
*/
|
|
59987
60142
|
listVenueKiosks(businessId: number, options?: AxiosRequestConfig): AxiosPromise<VenueKiosksDto>;
|
|
59988
60143
|
/**
|
|
59989
|
-
* The venue\'s stored terminals, oldest first, each with the station it is linked to. A terminal is stored once a till discovered it at its provider (POST /v1/terminal/discover); this route asks no provider.
|
|
60144
|
+
* The venue\'s stored terminals, oldest first, each with the station it is linked to. A terminal is stored once a till discovered it at its provider (POST /v1/terminal/discover), or once Munchi ops added it (POST payment-terminals); this route asks no provider.
|
|
59990
60145
|
* @summary List the venue\'s payment terminals, for linking one to a kiosk
|
|
59991
60146
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
59992
60147
|
* @param {*} [options] Override http request option.
|
|
@@ -60004,6 +60159,27 @@ export interface VenueKiosksApiInterface {
|
|
|
60004
60159
|
* @memberof VenueKiosksApiInterface
|
|
60005
60160
|
*/
|
|
60006
60161
|
removeVenueKiosk(businessId: number, stationId: string, options?: AxiosRequestConfig): AxiosPromise<VenueKioskDto>;
|
|
60162
|
+
/**
|
|
60163
|
+
* The terminal\'s row is deleted; payments made on it keep its id in their own records. Only a Munchi admin\'s ticket or Munchi\'s own Clerk key may (D161). Refused while a kiosk or till holds the terminal, and while a payment, reversal or refund started on it in the last 24 hours is still waiting on the terminal. Both are read under a lock on the terminal, so a link made meanwhile is never undone silently. A Viva or Nets terminal still on the venue\'s provider account is stored again on a till\'s next discover.
|
|
60164
|
+
* @summary Remove a payment terminal from the venue (Munchi admins only)
|
|
60165
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60166
|
+
* @param {string} paymentTerminalId The payment terminal\'s id, as the venue\'s terminal list answers it
|
|
60167
|
+
* @param {*} [options] Override http request option.
|
|
60168
|
+
* @throws {RequiredError}
|
|
60169
|
+
* @memberof VenueKiosksApiInterface
|
|
60170
|
+
*/
|
|
60171
|
+
removeVenuePaymentTerminal(businessId: number, paymentTerminalId: string, options?: AxiosRequestConfig): AxiosPromise<VenuePaymentTerminalDto>;
|
|
60172
|
+
/**
|
|
60173
|
+
* Only the label changes; the provider and its terminal id stay, and a kiosk or till holding the terminal keeps paying on it and shows the new label from its next request. Only a Munchi admin\'s ticket or Munchi\'s own Clerk key may (D161). Two renames at once both write; the later one\'s label stays.
|
|
60174
|
+
* @summary Rename one of the venue\'s payment terminals (Munchi admins only)
|
|
60175
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60176
|
+
* @param {string} paymentTerminalId The payment terminal\'s id, as the venue\'s terminal list answers it
|
|
60177
|
+
* @param {RenamePaymentTerminalDto} renamePaymentTerminalDto
|
|
60178
|
+
* @param {*} [options] Override http request option.
|
|
60179
|
+
* @throws {RequiredError}
|
|
60180
|
+
* @memberof VenueKiosksApiInterface
|
|
60181
|
+
*/
|
|
60182
|
+
renameVenuePaymentTerminal(businessId: number, paymentTerminalId: string, renamePaymentTerminalDto: RenamePaymentTerminalDto, options?: AxiosRequestConfig): AxiosPromise<VenuePaymentTerminalDto>;
|
|
60007
60183
|
}
|
|
60008
60184
|
/**
|
|
60009
60185
|
* VenueKiosksApi - object-oriented interface
|
|
@@ -60033,6 +60209,16 @@ export declare class VenueKiosksApi extends BaseAPI implements VenueKiosksApiInt
|
|
|
60033
60209
|
* @memberof VenueKiosksApi
|
|
60034
60210
|
*/
|
|
60035
60211
|
claimVenueKiosk(businessId: number, claimKioskDto: ClaimKioskDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VenueKioskDto, any, {}>>;
|
|
60212
|
+
/**
|
|
60213
|
+
* Munchi ops store a card terminal for the venue by the id its provider gives it, so a kiosk or till can take it. Only a Munchi admin\'s ticket or Munchi\'s own Clerk key may (D161); the venue\'s own logins are refused. hardwareId is checked against its provider\'s shape: Viva\'s and Nets\' terminal ID (TID) are digits, a Worldline terminal\'s serial number letters and digits. The provider is not asked: the terminal must already be registered on the venue\'s account at the provider, or its payments are refused there. The terminal is stored free, linked to no station. A terminal id the venue already stores, under any provider, is refused; so is a Worldline terminal another venue stores, since Worldline finds a terminal by its id alone. Viva and Nets terminals may be stored at several venues, as discover stores them.
|
|
60214
|
+
* @summary Add a payment terminal to the venue (Munchi admins only)
|
|
60215
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60216
|
+
* @param {CreatePaymentTerminalDto} createPaymentTerminalDto
|
|
60217
|
+
* @param {*} [options] Override http request option.
|
|
60218
|
+
* @throws {RequiredError}
|
|
60219
|
+
* @memberof VenueKiosksApi
|
|
60220
|
+
*/
|
|
60221
|
+
createVenuePaymentTerminal(businessId: number, createPaymentTerminalDto: CreatePaymentTerminalDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VenuePaymentTerminalDto, any, {}>>;
|
|
60036
60222
|
/**
|
|
60037
60223
|
* paymentTerminalId names one of the venue\'s stored terminals, or null unlinks the kiosk\'s terminal. A terminal another kiosk or till holds is refused, never taken from it. The kiosk\'s kept station is forgotten, so the kiosk pays on the new terminal from its next request.
|
|
60038
60224
|
* @summary Link one of the venue\'s payment terminals to a kiosk, or unlink it
|
|
@@ -60054,7 +60240,7 @@ export declare class VenueKiosksApi extends BaseAPI implements VenueKiosksApiInt
|
|
|
60054
60240
|
*/
|
|
60055
60241
|
listVenueKiosks(businessId: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VenueKiosksDto, any, {}>>;
|
|
60056
60242
|
/**
|
|
60057
|
-
* The venue\'s stored terminals, oldest first, each with the station it is linked to. A terminal is stored once a till discovered it at its provider (POST /v1/terminal/discover); this route asks no provider.
|
|
60243
|
+
* The venue\'s stored terminals, oldest first, each with the station it is linked to. A terminal is stored once a till discovered it at its provider (POST /v1/terminal/discover), or once Munchi ops added it (POST payment-terminals); this route asks no provider.
|
|
60058
60244
|
* @summary List the venue\'s payment terminals, for linking one to a kiosk
|
|
60059
60245
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60060
60246
|
* @param {*} [options] Override http request option.
|
|
@@ -60072,6 +60258,27 @@ export declare class VenueKiosksApi extends BaseAPI implements VenueKiosksApiInt
|
|
|
60072
60258
|
* @memberof VenueKiosksApi
|
|
60073
60259
|
*/
|
|
60074
60260
|
removeVenueKiosk(businessId: number, stationId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VenueKioskDto, any, {}>>;
|
|
60261
|
+
/**
|
|
60262
|
+
* The terminal\'s row is deleted; payments made on it keep its id in their own records. Only a Munchi admin\'s ticket or Munchi\'s own Clerk key may (D161). Refused while a kiosk or till holds the terminal, and while a payment, reversal or refund started on it in the last 24 hours is still waiting on the terminal. Both are read under a lock on the terminal, so a link made meanwhile is never undone silently. A Viva or Nets terminal still on the venue\'s provider account is stored again on a till\'s next discover.
|
|
60263
|
+
* @summary Remove a payment terminal from the venue (Munchi admins only)
|
|
60264
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60265
|
+
* @param {string} paymentTerminalId The payment terminal\'s id, as the venue\'s terminal list answers it
|
|
60266
|
+
* @param {*} [options] Override http request option.
|
|
60267
|
+
* @throws {RequiredError}
|
|
60268
|
+
* @memberof VenueKiosksApi
|
|
60269
|
+
*/
|
|
60270
|
+
removeVenuePaymentTerminal(businessId: number, paymentTerminalId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VenuePaymentTerminalDto, any, {}>>;
|
|
60271
|
+
/**
|
|
60272
|
+
* Only the label changes; the provider and its terminal id stay, and a kiosk or till holding the terminal keeps paying on it and shows the new label from its next request. Only a Munchi admin\'s ticket or Munchi\'s own Clerk key may (D161). Two renames at once both write; the later one\'s label stays.
|
|
60273
|
+
* @summary Rename one of the venue\'s payment terminals (Munchi admins only)
|
|
60274
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60275
|
+
* @param {string} paymentTerminalId The payment terminal\'s id, as the venue\'s terminal list answers it
|
|
60276
|
+
* @param {RenamePaymentTerminalDto} renamePaymentTerminalDto
|
|
60277
|
+
* @param {*} [options] Override http request option.
|
|
60278
|
+
* @throws {RequiredError}
|
|
60279
|
+
* @memberof VenueKiosksApi
|
|
60280
|
+
*/
|
|
60281
|
+
renameVenuePaymentTerminal(businessId: number, paymentTerminalId: string, renamePaymentTerminalDto: RenamePaymentTerminalDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VenuePaymentTerminalDto, any, {}>>;
|
|
60075
60282
|
}
|
|
60076
60283
|
/**
|
|
60077
60284
|
* VivaApi - axios parameter creator
|