@munchi_oy/core 2.16.0 → 2.18.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 +583 -68
- 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 +772 -71
- package/package.json +13 -15
- package/src/version.ts +1 -1
package/dist/generated/api.d.ts
CHANGED
|
@@ -3535,7 +3535,7 @@ export interface ConfigManagementResponseDto {
|
|
|
3535
3535
|
*/
|
|
3536
3536
|
'message'?: string;
|
|
3537
3537
|
/**
|
|
3538
|
-
* What was saved, as the database wrote it: the venue, the config, the provider\'s config without its secrets, the options, the integration (the third-party gift card\'s credentials without the password), { program, businessId } for loyalty (the program\'s secretKey answered null), { businessId, keys } for a sync, { id, removed } for a removed option.
|
|
3538
|
+
* What was saved, as the database wrote it: the venue, the config, the provider\'s config without its secrets but with hasSecretKey, hasClientSecret and hasPassword saying whether it holds them, the options, the integration (the third-party gift card\'s credentials without the password), { program, businessId } for loyalty (the program\'s secretKey answered null), { businessId, keys } for a sync, { id, removed } for a removed option.
|
|
3539
3539
|
* @type {object}
|
|
3540
3540
|
* @memberof ConfigManagementResponseDto
|
|
3541
3541
|
*/
|
|
@@ -4903,7 +4903,7 @@ export interface CreatePaymentTerminalDto {
|
|
|
4903
4903
|
*/
|
|
4904
4904
|
'provider': TerminalProvider;
|
|
4905
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
|
|
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); for nexi the Nexi terminal ID, t- and 10 digits, the number padded with zeros (t-0000103319; a Nexi simulator\'s is t-19 and 8 digits). The payment is sent to the provider with this id, so it must be the id the provider knows
|
|
4907
4907
|
* @type {string}
|
|
4908
4908
|
* @memberof CreatePaymentTerminalDto
|
|
4909
4909
|
*/
|
|
@@ -8854,6 +8854,12 @@ export interface GiftCardHistoryEventDto {
|
|
|
8854
8854
|
* @memberof GiftCardHistoryEventDto
|
|
8855
8855
|
*/
|
|
8856
8856
|
'orderId': string | null;
|
|
8857
|
+
/**
|
|
8858
|
+
* The number of that till order, as its receipt and the Orders screen show it; null when there is no order, or its number could not be read
|
|
8859
|
+
* @type {string}
|
|
8860
|
+
* @memberof GiftCardHistoryEventDto
|
|
8861
|
+
*/
|
|
8862
|
+
'orderNumber'?: string | null;
|
|
8857
8863
|
/**
|
|
8858
8864
|
* The address of an EMAILED, EMAIL_FAILED or EMAIL_CHANGED line; null for the others
|
|
8859
8865
|
* @type {string}
|
|
@@ -9130,6 +9136,12 @@ export interface GiftCardMovementDto {
|
|
|
9130
9136
|
* @memberof GiftCardMovementDto
|
|
9131
9137
|
*/
|
|
9132
9138
|
'orderId': string | null;
|
|
9139
|
+
/**
|
|
9140
|
+
* The number of that till order, as its receipt and the Orders screen show it; null when there is no order, or its number could not be read
|
|
9141
|
+
* @type {string}
|
|
9142
|
+
* @memberof GiftCardMovementDto
|
|
9143
|
+
*/
|
|
9144
|
+
'orderNumber'?: string | null;
|
|
9133
9145
|
/**
|
|
9134
9146
|
* True for a SOLD movement whose card is still NOT_YET_VALID: its POS order is not paid yet, and the report\'s sold leaves it out
|
|
9135
9147
|
* @type {boolean}
|
|
@@ -10125,6 +10137,68 @@ export interface InitiateNetsTerminalPaymentResponseDto {
|
|
|
10125
10137
|
*/
|
|
10126
10138
|
'connectCloudRequestId': string;
|
|
10127
10139
|
}
|
|
10140
|
+
/**
|
|
10141
|
+
*
|
|
10142
|
+
* @export
|
|
10143
|
+
* @interface InitiateNexiSessionDto
|
|
10144
|
+
*/
|
|
10145
|
+
export interface InitiateNexiSessionDto {
|
|
10146
|
+
/**
|
|
10147
|
+
*
|
|
10148
|
+
* @type {CreateManualSessionDtoDevice}
|
|
10149
|
+
* @memberof InitiateNexiSessionDto
|
|
10150
|
+
*/
|
|
10151
|
+
'device'?: CreateManualSessionDtoDevice | null;
|
|
10152
|
+
/**
|
|
10153
|
+
* The venue\'s orderingBusinessId. Must be the venue of the station calling.
|
|
10154
|
+
* @type {number}
|
|
10155
|
+
* @memberof InitiateNexiSessionDto
|
|
10156
|
+
*/
|
|
10157
|
+
'businessId': number;
|
|
10158
|
+
/**
|
|
10159
|
+
* The POS order this payment is for.
|
|
10160
|
+
* @type {string}
|
|
10161
|
+
* @memberof InitiateNexiSessionDto
|
|
10162
|
+
*/
|
|
10163
|
+
'orderId': string;
|
|
10164
|
+
/**
|
|
10165
|
+
* Amount to charge, in cents, without a tip: a tip the customer adds on the Nexi terminal is recorded from Nexi\'s answer. Must not exceed what the order still owes.
|
|
10166
|
+
* @type {number}
|
|
10167
|
+
* @memberof InitiateNexiSessionDto
|
|
10168
|
+
*/
|
|
10169
|
+
'amount': number;
|
|
10170
|
+
/**
|
|
10171
|
+
*
|
|
10172
|
+
* @type {InitiateNexiSessionDtoSplitContext}
|
|
10173
|
+
* @memberof InitiateNexiSessionDto
|
|
10174
|
+
*/
|
|
10175
|
+
'splitContext'?: InitiateNexiSessionDtoSplitContext;
|
|
10176
|
+
}
|
|
10177
|
+
/**
|
|
10178
|
+
* Split context. Omit for a full-cart payment, or send { mode, partId|seatId } for a split. Must match the order\'s checkoutModel.
|
|
10179
|
+
* @export
|
|
10180
|
+
* @interface InitiateNexiSessionDtoSplitContext
|
|
10181
|
+
*/
|
|
10182
|
+
export interface InitiateNexiSessionDtoSplitContext {
|
|
10183
|
+
/**
|
|
10184
|
+
*
|
|
10185
|
+
* @type {CheckoutModelEnum}
|
|
10186
|
+
* @memberof InitiateNexiSessionDtoSplitContext
|
|
10187
|
+
*/
|
|
10188
|
+
'mode': CheckoutModelEnum;
|
|
10189
|
+
/**
|
|
10190
|
+
* Equal-split part id. Required when mode=EQUAL_SPLIT; ignored otherwise.
|
|
10191
|
+
* @type {string}
|
|
10192
|
+
* @memberof InitiateNexiSessionDtoSplitContext
|
|
10193
|
+
*/
|
|
10194
|
+
'partId'?: string;
|
|
10195
|
+
/**
|
|
10196
|
+
* Item-split seat id. Required when mode=ITEM_SPLIT; ignored otherwise.
|
|
10197
|
+
* @type {string}
|
|
10198
|
+
* @memberof InitiateNexiSessionDtoSplitContext
|
|
10199
|
+
*/
|
|
10200
|
+
'seatId'?: string;
|
|
10201
|
+
}
|
|
10128
10202
|
/**
|
|
10129
10203
|
*
|
|
10130
10204
|
* @export
|
|
@@ -14854,6 +14928,18 @@ export interface NetsConfigResponseDto {
|
|
|
14854
14928
|
* @memberof NetsConfigResponseDto
|
|
14855
14929
|
*/
|
|
14856
14930
|
'clientSecret': string | null;
|
|
14931
|
+
/**
|
|
14932
|
+
* Whether a Nets secret key is stored, so a screen can show it as set without its value. False when none or an empty one is stored.
|
|
14933
|
+
* @type {boolean}
|
|
14934
|
+
* @memberof NetsConfigResponseDto
|
|
14935
|
+
*/
|
|
14936
|
+
'hasSecretKey': boolean;
|
|
14937
|
+
/**
|
|
14938
|
+
* Whether a Nets OAuth client secret is stored, so a screen can show it as set without its value. False when none or an empty one is stored.
|
|
14939
|
+
* @type {boolean}
|
|
14940
|
+
* @memberof NetsConfigResponseDto
|
|
14941
|
+
*/
|
|
14942
|
+
'hasClientSecret': boolean;
|
|
14857
14943
|
}
|
|
14858
14944
|
/**
|
|
14859
14945
|
*
|
|
@@ -15297,6 +15383,98 @@ export interface NewKdsStationDto {
|
|
|
15297
15383
|
*/
|
|
15298
15384
|
'categoryIds': Array<string>;
|
|
15299
15385
|
}
|
|
15386
|
+
/**
|
|
15387
|
+
*
|
|
15388
|
+
* @export
|
|
15389
|
+
* @interface NexiConfigResponseDto
|
|
15390
|
+
*/
|
|
15391
|
+
export interface NexiConfigResponseDto {
|
|
15392
|
+
/**
|
|
15393
|
+
* Whether the Nexi integration is active.
|
|
15394
|
+
* @type {boolean}
|
|
15395
|
+
* @memberof NexiConfigResponseDto
|
|
15396
|
+
*/
|
|
15397
|
+
'isActive': boolean;
|
|
15398
|
+
/**
|
|
15399
|
+
* Display name.
|
|
15400
|
+
* @type {string}
|
|
15401
|
+
* @memberof NexiConfigResponseDto
|
|
15402
|
+
*/
|
|
15403
|
+
'name': string | null;
|
|
15404
|
+
/**
|
|
15405
|
+
* Nexi POS API user name; null when none is stored.
|
|
15406
|
+
* @type {string}
|
|
15407
|
+
* @memberof NexiConfigResponseDto
|
|
15408
|
+
*/
|
|
15409
|
+
'username': string | null;
|
|
15410
|
+
/**
|
|
15411
|
+
* Always null: the stored Nexi password never leaves the server. A save that leaves it out keeps it; a save that sends one replaces it.
|
|
15412
|
+
* @type {string}
|
|
15413
|
+
* @memberof NexiConfigResponseDto
|
|
15414
|
+
*/
|
|
15415
|
+
'password': string | null;
|
|
15416
|
+
/**
|
|
15417
|
+
* Whether a Nexi password is stored, so a screen can show it as set without its value. False when none or an empty one is stored.
|
|
15418
|
+
* @type {boolean}
|
|
15419
|
+
* @memberof NexiConfigResponseDto
|
|
15420
|
+
*/
|
|
15421
|
+
'hasPassword': boolean;
|
|
15422
|
+
}
|
|
15423
|
+
/**
|
|
15424
|
+
*
|
|
15425
|
+
* @export
|
|
15426
|
+
* @enum {string}
|
|
15427
|
+
*/
|
|
15428
|
+
export declare const NexiPauseReason: {
|
|
15429
|
+
readonly NexiUnheard: "nexi unheard";
|
|
15430
|
+
readonly NexiPaused: "nexi paused";
|
|
15431
|
+
readonly ConfirmNotTaken: "confirm not taken";
|
|
15432
|
+
readonly OrderNotWritten: "order not written";
|
|
15433
|
+
};
|
|
15434
|
+
export type NexiPauseReason = typeof NexiPauseReason[keyof typeof NexiPauseReason];
|
|
15435
|
+
/**
|
|
15436
|
+
*
|
|
15437
|
+
* @export
|
|
15438
|
+
* @interface NexiWaitRoundDto
|
|
15439
|
+
*/
|
|
15440
|
+
export interface NexiWaitRoundDto {
|
|
15441
|
+
/**
|
|
15442
|
+
* The session\'s id, which Nexi knows as the sale\'s external_id.
|
|
15443
|
+
* @type {string}
|
|
15444
|
+
* @memberof NexiWaitRoundDto
|
|
15445
|
+
*/
|
|
15446
|
+
'sessionId': string;
|
|
15447
|
+
/**
|
|
15448
|
+
* This round\'s number, from 1. It names the Cloud Task, so one round is never queued twice.
|
|
15449
|
+
* @type {number}
|
|
15450
|
+
* @memberof NexiWaitRoundDto
|
|
15451
|
+
*/
|
|
15452
|
+
'round': number;
|
|
15453
|
+
/**
|
|
15454
|
+
* How many rounds in a row before this one were booked after a pause. The pause before the next round doubles with it, up to a minute.
|
|
15455
|
+
* @type {number}
|
|
15456
|
+
* @memberof NexiWaitRoundDto
|
|
15457
|
+
*/
|
|
15458
|
+
'pausedRounds': number;
|
|
15459
|
+
/**
|
|
15460
|
+
*
|
|
15461
|
+
* @type {NexiPauseReason}
|
|
15462
|
+
* @memberof NexiWaitRoundDto
|
|
15463
|
+
*/
|
|
15464
|
+
'pausedFor'?: NexiPauseReason;
|
|
15465
|
+
/**
|
|
15466
|
+
* When the pauses for `pausedFor` began, as an ISO 8601 time; absent when this round was booked at once.
|
|
15467
|
+
* @type {string}
|
|
15468
|
+
* @memberof NexiWaitRoundDto
|
|
15469
|
+
*/
|
|
15470
|
+
'pausedSince'?: string;
|
|
15471
|
+
/**
|
|
15472
|
+
* True once a person was alerted that the pauses for `pausedFor` outlasted their window; the server then keeps asking a minute apart and does not alert again. Absent before.
|
|
15473
|
+
* @type {boolean}
|
|
15474
|
+
* @memberof NexiWaitRoundDto
|
|
15475
|
+
*/
|
|
15476
|
+
'personTold'?: boolean;
|
|
15477
|
+
}
|
|
15300
15478
|
/**
|
|
15301
15479
|
*
|
|
15302
15480
|
* @export
|
|
@@ -19280,6 +19458,7 @@ export declare const PaymentProvider: {
|
|
|
19280
19458
|
readonly Nets: "nets";
|
|
19281
19459
|
readonly Worldline: "worldline";
|
|
19282
19460
|
readonly Epassi: "epassi";
|
|
19461
|
+
readonly Nexi: "nexi";
|
|
19283
19462
|
};
|
|
19284
19463
|
export type PaymentProvider = typeof PaymentProvider[keyof typeof PaymentProvider];
|
|
19285
19464
|
/**
|
|
@@ -19293,6 +19472,7 @@ export declare const PaymentProviderEnum: {
|
|
|
19293
19472
|
readonly Nets: "nets";
|
|
19294
19473
|
readonly Worldline: "worldline";
|
|
19295
19474
|
readonly Epassi: "epassi";
|
|
19475
|
+
readonly Nexi: "nexi";
|
|
19296
19476
|
};
|
|
19297
19477
|
export type PaymentProviderEnum = typeof PaymentProviderEnum[keyof typeof PaymentProviderEnum];
|
|
19298
19478
|
/**
|
|
@@ -24846,6 +25026,12 @@ export interface ProvidersConfigResponseDto {
|
|
|
24846
25026
|
* @memberof ProvidersConfigResponseDto
|
|
24847
25027
|
*/
|
|
24848
25028
|
'worldline': ProvidersConfigResponseDtoWorldline | null;
|
|
25029
|
+
/**
|
|
25030
|
+
*
|
|
25031
|
+
* @type {ProvidersConfigResponseDtoNexi}
|
|
25032
|
+
* @memberof ProvidersConfigResponseDto
|
|
25033
|
+
*/
|
|
25034
|
+
'nexi': ProvidersConfigResponseDtoNexi | null;
|
|
24849
25035
|
}
|
|
24850
25036
|
/**
|
|
24851
25037
|
* The channel\'s Nets settings; null when it has none.
|
|
@@ -24889,6 +25075,55 @@ export interface ProvidersConfigResponseDtoNets {
|
|
|
24889
25075
|
* @memberof ProvidersConfigResponseDtoNets
|
|
24890
25076
|
*/
|
|
24891
25077
|
'clientSecret': string | null;
|
|
25078
|
+
/**
|
|
25079
|
+
* Whether a Nets secret key is stored, so a screen can show it as set without its value. False when none or an empty one is stored.
|
|
25080
|
+
* @type {boolean}
|
|
25081
|
+
* @memberof ProvidersConfigResponseDtoNets
|
|
25082
|
+
*/
|
|
25083
|
+
'hasSecretKey': boolean;
|
|
25084
|
+
/**
|
|
25085
|
+
* Whether a Nets OAuth client secret is stored, so a screen can show it as set without its value. False when none or an empty one is stored.
|
|
25086
|
+
* @type {boolean}
|
|
25087
|
+
* @memberof ProvidersConfigResponseDtoNets
|
|
25088
|
+
*/
|
|
25089
|
+
'hasClientSecret': boolean;
|
|
25090
|
+
}
|
|
25091
|
+
/**
|
|
25092
|
+
* The channel\'s Nexi settings; null when it has none.
|
|
25093
|
+
* @export
|
|
25094
|
+
* @interface ProvidersConfigResponseDtoNexi
|
|
25095
|
+
*/
|
|
25096
|
+
export interface ProvidersConfigResponseDtoNexi {
|
|
25097
|
+
/**
|
|
25098
|
+
* Whether the Nexi integration is active.
|
|
25099
|
+
* @type {boolean}
|
|
25100
|
+
* @memberof ProvidersConfigResponseDtoNexi
|
|
25101
|
+
*/
|
|
25102
|
+
'isActive': boolean;
|
|
25103
|
+
/**
|
|
25104
|
+
* Display name.
|
|
25105
|
+
* @type {string}
|
|
25106
|
+
* @memberof ProvidersConfigResponseDtoNexi
|
|
25107
|
+
*/
|
|
25108
|
+
'name': string | null;
|
|
25109
|
+
/**
|
|
25110
|
+
* Nexi POS API user name; null when none is stored.
|
|
25111
|
+
* @type {string}
|
|
25112
|
+
* @memberof ProvidersConfigResponseDtoNexi
|
|
25113
|
+
*/
|
|
25114
|
+
'username': string | null;
|
|
25115
|
+
/**
|
|
25116
|
+
* Always null: the stored Nexi password never leaves the server. A save that leaves it out keeps it; a save that sends one replaces it.
|
|
25117
|
+
* @type {string}
|
|
25118
|
+
* @memberof ProvidersConfigResponseDtoNexi
|
|
25119
|
+
*/
|
|
25120
|
+
'password': string | null;
|
|
25121
|
+
/**
|
|
25122
|
+
* Whether a Nexi password is stored, so a screen can show it as set without its value. False when none or an empty one is stored.
|
|
25123
|
+
* @type {boolean}
|
|
25124
|
+
* @memberof ProvidersConfigResponseDtoNexi
|
|
25125
|
+
*/
|
|
25126
|
+
'hasPassword': boolean;
|
|
24892
25127
|
}
|
|
24893
25128
|
/**
|
|
24894
25129
|
* The channel\'s Stripe settings; null when it has none.
|
|
@@ -25000,6 +25235,12 @@ export interface ProvidersConfigResponseDtoWorldline {
|
|
|
25000
25235
|
* @memberof ProvidersConfigResponseDtoWorldline
|
|
25001
25236
|
*/
|
|
25002
25237
|
'publicKey': string | null;
|
|
25238
|
+
/**
|
|
25239
|
+
* Whether a Worldline secret key is stored, so a screen can show it as set without its value. False when none or an empty one is stored.
|
|
25240
|
+
* @type {boolean}
|
|
25241
|
+
* @memberof ProvidersConfigResponseDtoWorldline
|
|
25242
|
+
*/
|
|
25243
|
+
'hasSecretKey': boolean;
|
|
25003
25244
|
}
|
|
25004
25245
|
/**
|
|
25005
25246
|
*
|
|
@@ -33886,6 +34127,7 @@ export declare const TerminalProvider: {
|
|
|
33886
34127
|
readonly Viva: "viva";
|
|
33887
34128
|
readonly Nets: "nets";
|
|
33888
34129
|
readonly Worldline: "worldline";
|
|
34130
|
+
readonly Nexi: "nexi";
|
|
33889
34131
|
};
|
|
33890
34132
|
export type TerminalProvider = typeof TerminalProvider[keyof typeof TerminalProvider];
|
|
33891
34133
|
/**
|
|
@@ -37383,6 +37625,37 @@ export interface UpsertNetsDto {
|
|
|
37383
37625
|
*/
|
|
37384
37626
|
'clientSecret'?: string;
|
|
37385
37627
|
}
|
|
37628
|
+
/**
|
|
37629
|
+
*
|
|
37630
|
+
* @export
|
|
37631
|
+
* @interface UpsertNexiDto
|
|
37632
|
+
*/
|
|
37633
|
+
export interface UpsertNexiDto {
|
|
37634
|
+
/**
|
|
37635
|
+
* The name shown for the Nexi integration. Absent keeps the stored value.
|
|
37636
|
+
* @type {string}
|
|
37637
|
+
* @memberof UpsertNexiDto
|
|
37638
|
+
*/
|
|
37639
|
+
'name'?: string;
|
|
37640
|
+
/**
|
|
37641
|
+
* Whether the Nexi integration is active. Absent keeps the stored value; a new Nexi config is saved active.
|
|
37642
|
+
* @type {boolean}
|
|
37643
|
+
* @memberof UpsertNexiDto
|
|
37644
|
+
*/
|
|
37645
|
+
'isActive'?: boolean;
|
|
37646
|
+
/**
|
|
37647
|
+
* Nexi POS API user name, as Nexi issues it. Required to create the Nexi config: a new one without it is refused with 400. Absent keeps the stored value. An empty string or null is refused with 400.
|
|
37648
|
+
* @type {string}
|
|
37649
|
+
* @memberof UpsertNexiDto
|
|
37650
|
+
*/
|
|
37651
|
+
'username'?: string;
|
|
37652
|
+
/**
|
|
37653
|
+
* Nexi POS API password, as Nexi issues it; never answered. Required to create the Nexi config: a new one without it is refused with 400. Absent keeps the stored value. An empty string or null is refused with 400.
|
|
37654
|
+
* @type {string}
|
|
37655
|
+
* @memberof UpsertNexiDto
|
|
37656
|
+
*/
|
|
37657
|
+
'password'?: string;
|
|
37658
|
+
}
|
|
37386
37659
|
/**
|
|
37387
37660
|
*
|
|
37388
37661
|
* @export
|
|
@@ -37531,7 +37804,7 @@ export interface UpsertProvidersDto {
|
|
|
37531
37804
|
*/
|
|
37532
37805
|
'name'?: string;
|
|
37533
37806
|
/**
|
|
37534
|
-
* Whether the provider\'s integration is active. Absent keeps it for Viva and saves Nets, Stripe or
|
|
37807
|
+
* Whether the provider\'s integration is active. Absent keeps it for Viva and saves Nets, Stripe, Worldline or Nexi active.
|
|
37535
37808
|
* @type {boolean}
|
|
37536
37809
|
* @memberof UpsertProvidersDto
|
|
37537
37810
|
*/
|
|
@@ -37596,6 +37869,18 @@ export interface UpsertProvidersDto {
|
|
|
37596
37869
|
* @memberof UpsertProvidersDto
|
|
37597
37870
|
*/
|
|
37598
37871
|
'locationId'?: string;
|
|
37872
|
+
/**
|
|
37873
|
+
* Nexi POS API user name, as Nexi issues it. Required to create the Nexi config: a new one without it is refused with 400. Absent keeps the stored value. An empty string or null is refused with 400.
|
|
37874
|
+
* @type {string}
|
|
37875
|
+
* @memberof UpsertProvidersDto
|
|
37876
|
+
*/
|
|
37877
|
+
'username'?: string;
|
|
37878
|
+
/**
|
|
37879
|
+
* Nexi POS API password, as Nexi issues it; never answered. Required to create the Nexi config: a new one without it is refused with 400. Absent keeps the stored value. An empty string or null is refused with 400.
|
|
37880
|
+
* @type {string}
|
|
37881
|
+
* @memberof UpsertProvidersDto
|
|
37882
|
+
*/
|
|
37883
|
+
'password'?: string;
|
|
37599
37884
|
}
|
|
37600
37885
|
/**
|
|
37601
37886
|
*
|
|
@@ -37740,6 +38025,37 @@ export interface UpsertVivaDtoConfig {
|
|
|
37740
38025
|
*/
|
|
37741
38026
|
'additionalAmount'?: number;
|
|
37742
38027
|
}
|
|
38028
|
+
/**
|
|
38029
|
+
*
|
|
38030
|
+
* @export
|
|
38031
|
+
* @interface UpsertWorldlineDto
|
|
38032
|
+
*/
|
|
38033
|
+
export interface UpsertWorldlineDto {
|
|
38034
|
+
/**
|
|
38035
|
+
* The name shown for the Worldline integration. Absent keeps the stored value.
|
|
38036
|
+
* @type {string}
|
|
38037
|
+
* @memberof UpsertWorldlineDto
|
|
38038
|
+
*/
|
|
38039
|
+
'name'?: string;
|
|
38040
|
+
/**
|
|
38041
|
+
* Whether the Worldline integration is active. Absent keeps the stored value; a new Worldline config is saved active.
|
|
38042
|
+
* @type {boolean}
|
|
38043
|
+
* @memberof UpsertWorldlineDto
|
|
38044
|
+
*/
|
|
38045
|
+
'isActive'?: boolean;
|
|
38046
|
+
/**
|
|
38047
|
+
* The Worldline secret key. Absent keeps the stored value. An empty string or null is refused with 400.
|
|
38048
|
+
* @type {string}
|
|
38049
|
+
* @memberof UpsertWorldlineDto
|
|
38050
|
+
*/
|
|
38051
|
+
'secretKey'?: string;
|
|
38052
|
+
/**
|
|
38053
|
+
* The Worldline public key. Absent keeps the stored value. An empty string or null is refused with 400.
|
|
38054
|
+
* @type {string}
|
|
38055
|
+
* @memberof UpsertWorldlineDto
|
|
38056
|
+
*/
|
|
38057
|
+
'publicKey'?: string;
|
|
38058
|
+
}
|
|
37743
38059
|
/**
|
|
37744
38060
|
*
|
|
37745
38061
|
* @export
|
|
@@ -41130,6 +41446,12 @@ export interface WorldlineConfigResponseDto {
|
|
|
41130
41446
|
* @memberof WorldlineConfigResponseDto
|
|
41131
41447
|
*/
|
|
41132
41448
|
'publicKey': string | null;
|
|
41449
|
+
/**
|
|
41450
|
+
* Whether a Worldline secret key is stored, so a screen can show it as set without its value. False when none or an empty one is stored.
|
|
41451
|
+
* @type {boolean}
|
|
41452
|
+
* @memberof WorldlineConfigResponseDto
|
|
41453
|
+
*/
|
|
41454
|
+
'hasSecretKey': boolean;
|
|
41133
41455
|
}
|
|
41134
41456
|
/**
|
|
41135
41457
|
*
|
|
@@ -44084,7 +44406,7 @@ export declare const ConfigManagementApiAxiosParamCreator: (configuration?: Conf
|
|
|
44084
44406
|
*/
|
|
44085
44407
|
configConfigureMunchiGiftCard: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", configureMunchiGiftCardDto: ConfigureMunchiGiftCardDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
44086
44408
|
/**
|
|
44087
|
-
* The selected provider and each provider\'s settings. A secret key
|
|
44409
|
+
* 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).
|
|
44088
44410
|
* @summary Read a channel\'s card payment providers
|
|
44089
44411
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44090
44412
|
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
@@ -44112,8 +44434,8 @@ export declare const ConfigManagementApiAxiosParamCreator: (configuration?: Conf
|
|
|
44112
44434
|
*/
|
|
44113
44435
|
configRemovePaymentOption: (businessId: number, id: string, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
44114
44436
|
/**
|
|
44115
|
-
* 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.
|
|
44116
|
-
* @summary Save a channel\'s Epassi credentials and answer the public key to send Epassi
|
|
44437
|
+
* 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.
|
|
44438
|
+
* @summary Save a channel\'s Epassi credentials and answer the public key to send Epassi (Munchi admins only)
|
|
44117
44439
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44118
44440
|
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
44119
44441
|
* @param {string} xEpassiAccessKey The access key Epassi issued for this venue; Epassi issues a different one for test and production.
|
|
@@ -44161,8 +44483,8 @@ export declare const ConfigManagementApiAxiosParamCreator: (configuration?: Conf
|
|
|
44161
44483
|
*/
|
|
44162
44484
|
configUpsertLoyalty: (businessId: number, upsertLoyaltyDto: UpsertLoyaltyDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
44163
44485
|
/**
|
|
44164
|
-
* Creates the channel\'s config first if it has none. Saved active unless isActive is sent. The cached Nets config and token are cleared.
|
|
44165
|
-
* @summary Create or update a channel\'s Nets config
|
|
44486
|
+
* 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.
|
|
44487
|
+
* @summary Create or update a channel\'s Nets config (Munchi admins only)
|
|
44166
44488
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44167
44489
|
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
44168
44490
|
* @param {UpsertNetsDto} upsertNetsDto
|
|
@@ -44170,6 +44492,16 @@ export declare const ConfigManagementApiAxiosParamCreator: (configuration?: Conf
|
|
|
44170
44492
|
* @throws {RequiredError}
|
|
44171
44493
|
*/
|
|
44172
44494
|
configUpsertNets: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertNetsDto: UpsertNetsDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
44495
|
+
/**
|
|
44496
|
+
* 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.
|
|
44497
|
+
* @summary Create or update a channel\'s Nexi config (Munchi admins only)
|
|
44498
|
+
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44499
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
44500
|
+
* @param {UpsertNexiDto} upsertNexiDto
|
|
44501
|
+
* @param {*} [options] Override http request option.
|
|
44502
|
+
* @throws {RequiredError}
|
|
44503
|
+
*/
|
|
44504
|
+
configUpsertNexi: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertNexiDto: UpsertNexiDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
44173
44505
|
/**
|
|
44174
44506
|
* 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.
|
|
44175
44507
|
* @summary Create or update a channel\'s checkout payment options
|
|
@@ -44181,8 +44513,8 @@ export declare const ConfigManagementApiAxiosParamCreator: (configuration?: Conf
|
|
|
44181
44513
|
*/
|
|
44182
44514
|
configUpsertPaymentOptions: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertPaymentOptionsDto: UpsertPaymentOptionsDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
44183
44515
|
/**
|
|
44184
|
-
* Saves the chosen provider\'s own fields (Viva as the Viva route would, Nets and Stripe as their routes would; Worldline,
|
|
44185
|
-
* @summary Set active provider and upsert its credentials
|
|
44516
|
+
* 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.
|
|
44517
|
+
* @summary Set active provider and upsert its credentials (Munchi admins only)
|
|
44186
44518
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44187
44519
|
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
44188
44520
|
* @param {UpsertProvidersDto} upsertProvidersDto
|
|
@@ -44191,8 +44523,8 @@ export declare const ConfigManagementApiAxiosParamCreator: (configuration?: Conf
|
|
|
44191
44523
|
*/
|
|
44192
44524
|
configUpsertProviders: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertProvidersDto: UpsertProvidersDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
44193
44525
|
/**
|
|
44194
|
-
* Creates the channel\'s config first if it has none. Saved active unless isActive is sent. The cached Stripe config is cleared.
|
|
44195
|
-
* @summary Create or update a channel\'s Stripe config
|
|
44526
|
+
* 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.
|
|
44527
|
+
* @summary Create or update a channel\'s Stripe config (Munchi admins only)
|
|
44196
44528
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44197
44529
|
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
44198
44530
|
* @param {UpsertStripeDto} upsertStripeDto
|
|
@@ -44201,8 +44533,8 @@ export declare const ConfigManagementApiAxiosParamCreator: (configuration?: Conf
|
|
|
44201
44533
|
*/
|
|
44202
44534
|
configUpsertStripe: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertStripeDto: UpsertStripeDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
44203
44535
|
/**
|
|
44204
|
-
* 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.
|
|
44205
|
-
* @summary Create or update a channel\'s Viva config
|
|
44536
|
+
* 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.
|
|
44537
|
+
* @summary Create or update a channel\'s Viva config (Munchi admins only)
|
|
44206
44538
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44207
44539
|
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
44208
44540
|
* @param {UpsertVivaDto} upsertVivaDto
|
|
@@ -44210,6 +44542,16 @@ export declare const ConfigManagementApiAxiosParamCreator: (configuration?: Conf
|
|
|
44210
44542
|
* @throws {RequiredError}
|
|
44211
44543
|
*/
|
|
44212
44544
|
configUpsertViva: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertVivaDto: UpsertVivaDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
44545
|
+
/**
|
|
44546
|
+
* 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.
|
|
44547
|
+
* @summary Create or update a channel\'s Worldline config (Munchi admins only)
|
|
44548
|
+
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44549
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
44550
|
+
* @param {UpsertWorldlineDto} upsertWorldlineDto
|
|
44551
|
+
* @param {*} [options] Override http request option.
|
|
44552
|
+
* @throws {RequiredError}
|
|
44553
|
+
*/
|
|
44554
|
+
configUpsertWorldline: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertWorldlineDto: UpsertWorldlineDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
44213
44555
|
};
|
|
44214
44556
|
/**
|
|
44215
44557
|
* ConfigManagementApi - functional programming interface
|
|
@@ -44227,7 +44569,7 @@ export declare const ConfigManagementApiFp: (configuration?: Configuration) => {
|
|
|
44227
44569
|
*/
|
|
44228
44570
|
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>>;
|
|
44229
44571
|
/**
|
|
44230
|
-
* The selected provider and each provider\'s settings. A secret key
|
|
44572
|
+
* 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).
|
|
44231
44573
|
* @summary Read a channel\'s card payment providers
|
|
44232
44574
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44233
44575
|
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
@@ -44255,8 +44597,8 @@ export declare const ConfigManagementApiFp: (configuration?: Configuration) => {
|
|
|
44255
44597
|
*/
|
|
44256
44598
|
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>>;
|
|
44257
44599
|
/**
|
|
44258
|
-
* 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.
|
|
44259
|
-
* @summary Save a channel\'s Epassi credentials and answer the public key to send Epassi
|
|
44600
|
+
* 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.
|
|
44601
|
+
* @summary Save a channel\'s Epassi credentials and answer the public key to send Epassi (Munchi admins only)
|
|
44260
44602
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44261
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
|
|
44262
44604
|
* @param {string} xEpassiAccessKey The access key Epassi issued for this venue; Epassi issues a different one for test and production.
|
|
@@ -44304,8 +44646,8 @@ export declare const ConfigManagementApiFp: (configuration?: Configuration) => {
|
|
|
44304
44646
|
*/
|
|
44305
44647
|
configUpsertLoyalty(businessId: number, upsertLoyaltyDto: UpsertLoyaltyDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfigManagementResponseDto>>;
|
|
44306
44648
|
/**
|
|
44307
|
-
* Creates the channel\'s config first if it has none. Saved active unless isActive is sent. The cached Nets config and token are cleared.
|
|
44308
|
-
* @summary Create or update a channel\'s Nets config
|
|
44649
|
+
* 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.
|
|
44650
|
+
* @summary Create or update a channel\'s Nets config (Munchi admins only)
|
|
44309
44651
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44310
44652
|
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
44311
44653
|
* @param {UpsertNetsDto} upsertNetsDto
|
|
@@ -44313,6 +44655,16 @@ export declare const ConfigManagementApiFp: (configuration?: Configuration) => {
|
|
|
44313
44655
|
* @throws {RequiredError}
|
|
44314
44656
|
*/
|
|
44315
44657
|
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>>;
|
|
44658
|
+
/**
|
|
44659
|
+
* 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.
|
|
44660
|
+
* @summary Create or update a channel\'s Nexi config (Munchi admins only)
|
|
44661
|
+
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44662
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
44663
|
+
* @param {UpsertNexiDto} upsertNexiDto
|
|
44664
|
+
* @param {*} [options] Override http request option.
|
|
44665
|
+
* @throws {RequiredError}
|
|
44666
|
+
*/
|
|
44667
|
+
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>>;
|
|
44316
44668
|
/**
|
|
44317
44669
|
* 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.
|
|
44318
44670
|
* @summary Create or update a channel\'s checkout payment options
|
|
@@ -44324,8 +44676,8 @@ export declare const ConfigManagementApiFp: (configuration?: Configuration) => {
|
|
|
44324
44676
|
*/
|
|
44325
44677
|
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>>;
|
|
44326
44678
|
/**
|
|
44327
|
-
* Saves the chosen provider\'s own fields (Viva as the Viva route would, Nets and Stripe as their routes would; Worldline,
|
|
44328
|
-
* @summary Set active provider and upsert its credentials
|
|
44679
|
+
* 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.
|
|
44680
|
+
* @summary Set active provider and upsert its credentials (Munchi admins only)
|
|
44329
44681
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44330
44682
|
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
44331
44683
|
* @param {UpsertProvidersDto} upsertProvidersDto
|
|
@@ -44334,8 +44686,8 @@ export declare const ConfigManagementApiFp: (configuration?: Configuration) => {
|
|
|
44334
44686
|
*/
|
|
44335
44687
|
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>>;
|
|
44336
44688
|
/**
|
|
44337
|
-
* Creates the channel\'s config first if it has none. Saved active unless isActive is sent. The cached Stripe config is cleared.
|
|
44338
|
-
* @summary Create or update a channel\'s Stripe config
|
|
44689
|
+
* 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.
|
|
44690
|
+
* @summary Create or update a channel\'s Stripe config (Munchi admins only)
|
|
44339
44691
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44340
44692
|
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
44341
44693
|
* @param {UpsertStripeDto} upsertStripeDto
|
|
@@ -44344,8 +44696,8 @@ export declare const ConfigManagementApiFp: (configuration?: Configuration) => {
|
|
|
44344
44696
|
*/
|
|
44345
44697
|
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>>;
|
|
44346
44698
|
/**
|
|
44347
|
-
* 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.
|
|
44348
|
-
* @summary Create or update a channel\'s Viva config
|
|
44699
|
+
* 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.
|
|
44700
|
+
* @summary Create or update a channel\'s Viva config (Munchi admins only)
|
|
44349
44701
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44350
44702
|
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
44351
44703
|
* @param {UpsertVivaDto} upsertVivaDto
|
|
@@ -44353,6 +44705,16 @@ export declare const ConfigManagementApiFp: (configuration?: Configuration) => {
|
|
|
44353
44705
|
* @throws {RequiredError}
|
|
44354
44706
|
*/
|
|
44355
44707
|
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>>;
|
|
44708
|
+
/**
|
|
44709
|
+
* 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.
|
|
44710
|
+
* @summary Create or update a channel\'s Worldline config (Munchi admins only)
|
|
44711
|
+
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44712
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
44713
|
+
* @param {UpsertWorldlineDto} upsertWorldlineDto
|
|
44714
|
+
* @param {*} [options] Override http request option.
|
|
44715
|
+
* @throws {RequiredError}
|
|
44716
|
+
*/
|
|
44717
|
+
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>>;
|
|
44356
44718
|
};
|
|
44357
44719
|
/**
|
|
44358
44720
|
* ConfigManagementApi - factory interface
|
|
@@ -44370,7 +44732,7 @@ export declare const ConfigManagementApiFactory: (configuration?: Configuration,
|
|
|
44370
44732
|
*/
|
|
44371
44733
|
configConfigureMunchiGiftCard(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", configureMunchiGiftCardDto: ConfigureMunchiGiftCardDto, options?: any): AxiosPromise<ConfigManagementResponseDto>;
|
|
44372
44734
|
/**
|
|
44373
|
-
* The selected provider and each provider\'s settings. A secret key
|
|
44735
|
+
* 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).
|
|
44374
44736
|
* @summary Read a channel\'s card payment providers
|
|
44375
44737
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44376
44738
|
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
@@ -44398,8 +44760,8 @@ export declare const ConfigManagementApiFactory: (configuration?: Configuration,
|
|
|
44398
44760
|
*/
|
|
44399
44761
|
configRemovePaymentOption(businessId: number, id: string, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", options?: any): AxiosPromise<ConfigManagementResponseDto>;
|
|
44400
44762
|
/**
|
|
44401
|
-
* 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.
|
|
44402
|
-
* @summary Save a channel\'s Epassi credentials and answer the public key to send Epassi
|
|
44763
|
+
* 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.
|
|
44764
|
+
* @summary Save a channel\'s Epassi credentials and answer the public key to send Epassi (Munchi admins only)
|
|
44403
44765
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44404
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
|
|
44405
44767
|
* @param {string} xEpassiAccessKey The access key Epassi issued for this venue; Epassi issues a different one for test and production.
|
|
@@ -44447,8 +44809,8 @@ export declare const ConfigManagementApiFactory: (configuration?: Configuration,
|
|
|
44447
44809
|
*/
|
|
44448
44810
|
configUpsertLoyalty(businessId: number, upsertLoyaltyDto: UpsertLoyaltyDto, options?: any): AxiosPromise<ConfigManagementResponseDto>;
|
|
44449
44811
|
/**
|
|
44450
|
-
* Creates the channel\'s config first if it has none. Saved active unless isActive is sent. The cached Nets config and token are cleared.
|
|
44451
|
-
* @summary Create or update a channel\'s Nets config
|
|
44812
|
+
* 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.
|
|
44813
|
+
* @summary Create or update a channel\'s Nets config (Munchi admins only)
|
|
44452
44814
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44453
44815
|
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
44454
44816
|
* @param {UpsertNetsDto} upsertNetsDto
|
|
@@ -44456,6 +44818,16 @@ export declare const ConfigManagementApiFactory: (configuration?: Configuration,
|
|
|
44456
44818
|
* @throws {RequiredError}
|
|
44457
44819
|
*/
|
|
44458
44820
|
configUpsertNets(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertNetsDto: UpsertNetsDto, options?: any): AxiosPromise<ConfigManagementResponseDto>;
|
|
44821
|
+
/**
|
|
44822
|
+
* 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.
|
|
44823
|
+
* @summary Create or update a channel\'s Nexi config (Munchi admins only)
|
|
44824
|
+
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44825
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
44826
|
+
* @param {UpsertNexiDto} upsertNexiDto
|
|
44827
|
+
* @param {*} [options] Override http request option.
|
|
44828
|
+
* @throws {RequiredError}
|
|
44829
|
+
*/
|
|
44830
|
+
configUpsertNexi(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertNexiDto: UpsertNexiDto, options?: any): AxiosPromise<ConfigManagementResponseDto>;
|
|
44459
44831
|
/**
|
|
44460
44832
|
* 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.
|
|
44461
44833
|
* @summary Create or update a channel\'s checkout payment options
|
|
@@ -44467,8 +44839,8 @@ export declare const ConfigManagementApiFactory: (configuration?: Configuration,
|
|
|
44467
44839
|
*/
|
|
44468
44840
|
configUpsertPaymentOptions(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertPaymentOptionsDto: UpsertPaymentOptionsDto, options?: any): AxiosPromise<ConfigManagementResponseDto>;
|
|
44469
44841
|
/**
|
|
44470
|
-
* Saves the chosen provider\'s own fields (Viva as the Viva route would, Nets and Stripe as their routes would; Worldline,
|
|
44471
|
-
* @summary Set active provider and upsert its credentials
|
|
44842
|
+
* 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.
|
|
44843
|
+
* @summary Set active provider and upsert its credentials (Munchi admins only)
|
|
44472
44844
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44473
44845
|
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
44474
44846
|
* @param {UpsertProvidersDto} upsertProvidersDto
|
|
@@ -44477,8 +44849,8 @@ export declare const ConfigManagementApiFactory: (configuration?: Configuration,
|
|
|
44477
44849
|
*/
|
|
44478
44850
|
configUpsertProviders(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertProvidersDto: UpsertProvidersDto, options?: any): AxiosPromise<ProvidersConfigResponseDto>;
|
|
44479
44851
|
/**
|
|
44480
|
-
* Creates the channel\'s config first if it has none. Saved active unless isActive is sent. The cached Stripe config is cleared.
|
|
44481
|
-
* @summary Create or update a channel\'s Stripe config
|
|
44852
|
+
* 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.
|
|
44853
|
+
* @summary Create or update a channel\'s Stripe config (Munchi admins only)
|
|
44482
44854
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44483
44855
|
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
44484
44856
|
* @param {UpsertStripeDto} upsertStripeDto
|
|
@@ -44487,8 +44859,8 @@ export declare const ConfigManagementApiFactory: (configuration?: Configuration,
|
|
|
44487
44859
|
*/
|
|
44488
44860
|
configUpsertStripe(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertStripeDto: UpsertStripeDto, options?: any): AxiosPromise<ConfigManagementResponseDto>;
|
|
44489
44861
|
/**
|
|
44490
|
-
* 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.
|
|
44491
|
-
* @summary Create or update a channel\'s Viva config
|
|
44862
|
+
* 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.
|
|
44863
|
+
* @summary Create or update a channel\'s Viva config (Munchi admins only)
|
|
44492
44864
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44493
44865
|
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
44494
44866
|
* @param {UpsertVivaDto} upsertVivaDto
|
|
@@ -44496,6 +44868,16 @@ export declare const ConfigManagementApiFactory: (configuration?: Configuration,
|
|
|
44496
44868
|
* @throws {RequiredError}
|
|
44497
44869
|
*/
|
|
44498
44870
|
configUpsertViva(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertVivaDto: UpsertVivaDto, options?: any): AxiosPromise<ConfigManagementResponseDto>;
|
|
44871
|
+
/**
|
|
44872
|
+
* 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.
|
|
44873
|
+
* @summary Create or update a channel\'s Worldline config (Munchi admins only)
|
|
44874
|
+
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44875
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
44876
|
+
* @param {UpsertWorldlineDto} upsertWorldlineDto
|
|
44877
|
+
* @param {*} [options] Override http request option.
|
|
44878
|
+
* @throws {RequiredError}
|
|
44879
|
+
*/
|
|
44880
|
+
configUpsertWorldline(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertWorldlineDto: UpsertWorldlineDto, options?: any): AxiosPromise<ConfigManagementResponseDto>;
|
|
44499
44881
|
};
|
|
44500
44882
|
/**
|
|
44501
44883
|
* ConfigManagementApi - interface
|
|
@@ -44515,7 +44897,7 @@ export interface ConfigManagementApiInterface {
|
|
|
44515
44897
|
*/
|
|
44516
44898
|
configConfigureMunchiGiftCard(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', configureMunchiGiftCardDto: ConfigureMunchiGiftCardDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
44517
44899
|
/**
|
|
44518
|
-
* The selected provider and each provider\'s settings. A secret key
|
|
44900
|
+
* 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).
|
|
44519
44901
|
* @summary Read a channel\'s card payment providers
|
|
44520
44902
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44521
44903
|
* @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,8 +44928,8 @@ export interface ConfigManagementApiInterface {
|
|
|
44546
44928
|
*/
|
|
44547
44929
|
configRemovePaymentOption(businessId: number, id: string, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
44548
44930
|
/**
|
|
44549
|
-
* 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.
|
|
44550
|
-
* @summary Save a channel\'s Epassi credentials and answer the public key to send Epassi
|
|
44931
|
+
* 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.
|
|
44932
|
+
* @summary Save a channel\'s Epassi credentials and answer the public key to send Epassi (Munchi admins only)
|
|
44551
44933
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44552
44934
|
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
44553
44935
|
* @param {string} xEpassiAccessKey The access key Epassi issued for this venue; Epassi issues a different one for test and production.
|
|
@@ -44600,8 +44982,8 @@ export interface ConfigManagementApiInterface {
|
|
|
44600
44982
|
*/
|
|
44601
44983
|
configUpsertLoyalty(businessId: number, upsertLoyaltyDto: UpsertLoyaltyDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
44602
44984
|
/**
|
|
44603
|
-
* Creates the channel\'s config first if it has none. Saved active unless isActive is sent. The cached Nets config and token are cleared.
|
|
44604
|
-
* @summary Create or update a channel\'s Nets config
|
|
44985
|
+
* 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.
|
|
44986
|
+
* @summary Create or update a channel\'s Nets config (Munchi admins only)
|
|
44605
44987
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44606
44988
|
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
44607
44989
|
* @param {UpsertNetsDto} upsertNetsDto
|
|
@@ -44610,6 +44992,17 @@ export interface ConfigManagementApiInterface {
|
|
|
44610
44992
|
* @memberof ConfigManagementApiInterface
|
|
44611
44993
|
*/
|
|
44612
44994
|
configUpsertNets(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertNetsDto: UpsertNetsDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
44995
|
+
/**
|
|
44996
|
+
* 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.
|
|
44997
|
+
* @summary Create or update a channel\'s Nexi config (Munchi admins only)
|
|
44998
|
+
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44999
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45000
|
+
* @param {UpsertNexiDto} upsertNexiDto
|
|
45001
|
+
* @param {*} [options] Override http request option.
|
|
45002
|
+
* @throws {RequiredError}
|
|
45003
|
+
* @memberof ConfigManagementApiInterface
|
|
45004
|
+
*/
|
|
45005
|
+
configUpsertNexi(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertNexiDto: UpsertNexiDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
44613
45006
|
/**
|
|
44614
45007
|
* 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.
|
|
44615
45008
|
* @summary Create or update a channel\'s checkout payment options
|
|
@@ -44622,8 +45015,8 @@ export interface ConfigManagementApiInterface {
|
|
|
44622
45015
|
*/
|
|
44623
45016
|
configUpsertPaymentOptions(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertPaymentOptionsDto: UpsertPaymentOptionsDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
44624
45017
|
/**
|
|
44625
|
-
* Saves the chosen provider\'s own fields (Viva as the Viva route would, Nets and Stripe as their routes would; Worldline,
|
|
44626
|
-
* @summary Set active provider and upsert its credentials
|
|
45018
|
+
* 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.
|
|
45019
|
+
* @summary Set active provider and upsert its credentials (Munchi admins only)
|
|
44627
45020
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44628
45021
|
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
44629
45022
|
* @param {UpsertProvidersDto} upsertProvidersDto
|
|
@@ -44633,8 +45026,8 @@ export interface ConfigManagementApiInterface {
|
|
|
44633
45026
|
*/
|
|
44634
45027
|
configUpsertProviders(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertProvidersDto: UpsertProvidersDto, options?: AxiosRequestConfig): AxiosPromise<ProvidersConfigResponseDto>;
|
|
44635
45028
|
/**
|
|
44636
|
-
* Creates the channel\'s config first if it has none. Saved active unless isActive is sent. The cached Stripe config is cleared.
|
|
44637
|
-
* @summary Create or update a channel\'s Stripe config
|
|
45029
|
+
* 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.
|
|
45030
|
+
* @summary Create or update a channel\'s Stripe config (Munchi admins only)
|
|
44638
45031
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44639
45032
|
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
44640
45033
|
* @param {UpsertStripeDto} upsertStripeDto
|
|
@@ -44644,8 +45037,8 @@ export interface ConfigManagementApiInterface {
|
|
|
44644
45037
|
*/
|
|
44645
45038
|
configUpsertStripe(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertStripeDto: UpsertStripeDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
44646
45039
|
/**
|
|
44647
|
-
* 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.
|
|
44648
|
-
* @summary Create or update a channel\'s Viva config
|
|
45040
|
+
* 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.
|
|
45041
|
+
* @summary Create or update a channel\'s Viva config (Munchi admins only)
|
|
44649
45042
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44650
45043
|
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
44651
45044
|
* @param {UpsertVivaDto} upsertVivaDto
|
|
@@ -44654,6 +45047,17 @@ export interface ConfigManagementApiInterface {
|
|
|
44654
45047
|
* @memberof ConfigManagementApiInterface
|
|
44655
45048
|
*/
|
|
44656
45049
|
configUpsertViva(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertVivaDto: UpsertVivaDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
45050
|
+
/**
|
|
45051
|
+
* 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.
|
|
45052
|
+
* @summary Create or update a channel\'s Worldline config (Munchi admins only)
|
|
45053
|
+
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
45054
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45055
|
+
* @param {UpsertWorldlineDto} upsertWorldlineDto
|
|
45056
|
+
* @param {*} [options] Override http request option.
|
|
45057
|
+
* @throws {RequiredError}
|
|
45058
|
+
* @memberof ConfigManagementApiInterface
|
|
45059
|
+
*/
|
|
45060
|
+
configUpsertWorldline(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertWorldlineDto: UpsertWorldlineDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
44657
45061
|
}
|
|
44658
45062
|
/**
|
|
44659
45063
|
* ConfigManagementApi - object-oriented interface
|
|
@@ -44674,7 +45078,7 @@ export declare class ConfigManagementApi extends BaseAPI implements ConfigManage
|
|
|
44674
45078
|
*/
|
|
44675
45079
|
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, {}>>;
|
|
44676
45080
|
/**
|
|
44677
|
-
* The selected provider and each provider\'s settings. A secret key
|
|
45081
|
+
* 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).
|
|
44678
45082
|
* @summary Read a channel\'s card payment providers
|
|
44679
45083
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44680
45084
|
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
@@ -44705,8 +45109,8 @@ export declare class ConfigManagementApi extends BaseAPI implements ConfigManage
|
|
|
44705
45109
|
*/
|
|
44706
45110
|
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, {}>>;
|
|
44707
45111
|
/**
|
|
44708
|
-
* 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.
|
|
44709
|
-
* @summary Save a channel\'s Epassi credentials and answer the public key to send Epassi
|
|
45112
|
+
* 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.
|
|
45113
|
+
* @summary Save a channel\'s Epassi credentials and answer the public key to send Epassi (Munchi admins only)
|
|
44710
45114
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44711
45115
|
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
44712
45116
|
* @param {string} xEpassiAccessKey The access key Epassi issued for this venue; Epassi issues a different one for test and production.
|
|
@@ -44759,8 +45163,8 @@ export declare class ConfigManagementApi extends BaseAPI implements ConfigManage
|
|
|
44759
45163
|
*/
|
|
44760
45164
|
configUpsertLoyalty(businessId: number, upsertLoyaltyDto: UpsertLoyaltyDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ConfigManagementResponseDto, any, {}>>;
|
|
44761
45165
|
/**
|
|
44762
|
-
* Creates the channel\'s config first if it has none. Saved active unless isActive is sent. The cached Nets config and token are cleared.
|
|
44763
|
-
* @summary Create or update a channel\'s Nets config
|
|
45166
|
+
* 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.
|
|
45167
|
+
* @summary Create or update a channel\'s Nets config (Munchi admins only)
|
|
44764
45168
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44765
45169
|
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
44766
45170
|
* @param {UpsertNetsDto} upsertNetsDto
|
|
@@ -44769,6 +45173,17 @@ export declare class ConfigManagementApi extends BaseAPI implements ConfigManage
|
|
|
44769
45173
|
* @memberof ConfigManagementApi
|
|
44770
45174
|
*/
|
|
44771
45175
|
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, {}>>;
|
|
45176
|
+
/**
|
|
45177
|
+
* 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.
|
|
45178
|
+
* @summary Create or update a channel\'s Nexi config (Munchi admins only)
|
|
45179
|
+
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
45180
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45181
|
+
* @param {UpsertNexiDto} upsertNexiDto
|
|
45182
|
+
* @param {*} [options] Override http request option.
|
|
45183
|
+
* @throws {RequiredError}
|
|
45184
|
+
* @memberof ConfigManagementApi
|
|
45185
|
+
*/
|
|
45186
|
+
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, {}>>;
|
|
44772
45187
|
/**
|
|
44773
45188
|
* 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
45189
|
* @summary Create or update a channel\'s checkout payment options
|
|
@@ -44781,8 +45196,8 @@ export declare class ConfigManagementApi extends BaseAPI implements ConfigManage
|
|
|
44781
45196
|
*/
|
|
44782
45197
|
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, {}>>;
|
|
44783
45198
|
/**
|
|
44784
|
-
* Saves the chosen provider\'s own fields (Viva as the Viva route would, Nets and Stripe as their routes would; Worldline,
|
|
44785
|
-
* @summary Set active provider and upsert its credentials
|
|
45199
|
+
* 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.
|
|
45200
|
+
* @summary Set active provider and upsert its credentials (Munchi admins only)
|
|
44786
45201
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44787
45202
|
* @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
45203
|
* @param {UpsertProvidersDto} upsertProvidersDto
|
|
@@ -44792,8 +45207,8 @@ export declare class ConfigManagementApi extends BaseAPI implements ConfigManage
|
|
|
44792
45207
|
*/
|
|
44793
45208
|
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, {}>>;
|
|
44794
45209
|
/**
|
|
44795
|
-
* Creates the channel\'s config first if it has none. Saved active unless isActive is sent. The cached Stripe config is cleared.
|
|
44796
|
-
* @summary Create or update a channel\'s Stripe config
|
|
45210
|
+
* 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.
|
|
45211
|
+
* @summary Create or update a channel\'s Stripe config (Munchi admins only)
|
|
44797
45212
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44798
45213
|
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
44799
45214
|
* @param {UpsertStripeDto} upsertStripeDto
|
|
@@ -44803,8 +45218,8 @@ export declare class ConfigManagementApi extends BaseAPI implements ConfigManage
|
|
|
44803
45218
|
*/
|
|
44804
45219
|
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, {}>>;
|
|
44805
45220
|
/**
|
|
44806
|
-
* 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.
|
|
44807
|
-
* @summary Create or update a channel\'s Viva config
|
|
45221
|
+
* 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.
|
|
45222
|
+
* @summary Create or update a channel\'s Viva config (Munchi admins only)
|
|
44808
45223
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44809
45224
|
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
44810
45225
|
* @param {UpsertVivaDto} upsertVivaDto
|
|
@@ -44813,6 +45228,17 @@ export declare class ConfigManagementApi extends BaseAPI implements ConfigManage
|
|
|
44813
45228
|
* @memberof ConfigManagementApi
|
|
44814
45229
|
*/
|
|
44815
45230
|
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, {}>>;
|
|
45231
|
+
/**
|
|
45232
|
+
* 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.
|
|
45233
|
+
* @summary Create or update a channel\'s Worldline config (Munchi admins only)
|
|
45234
|
+
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
45235
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
45236
|
+
* @param {UpsertWorldlineDto} upsertWorldlineDto
|
|
45237
|
+
* @param {*} [options] Override http request option.
|
|
45238
|
+
* @throws {RequiredError}
|
|
45239
|
+
* @memberof ConfigManagementApi
|
|
45240
|
+
*/
|
|
45241
|
+
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, {}>>;
|
|
44816
45242
|
}
|
|
44817
45243
|
/**
|
|
44818
45244
|
* CouponsApi - axios parameter creator
|
|
@@ -53088,6 +53514,15 @@ export declare const PaymentSessionApiAxiosParamCreator: (configuration?: Config
|
|
|
53088
53514
|
* @throws {RequiredError}
|
|
53089
53515
|
*/
|
|
53090
53516
|
initiateNetsSession: (initiateNetsSessionDto: InitiateNetsSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
53517
|
+
/**
|
|
53518
|
+
* 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. A Nexi sale is refused by :clientToken/cancel; Nexi\'s own cancel comes with a later route. 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).
|
|
53519
|
+
* @summary Start a card payment on the station\'s Nexi terminal
|
|
53520
|
+
* @param {InitiateNexiSessionDto} initiateNexiSessionDto
|
|
53521
|
+
* @param {string} [xIdempotencyKey] A UUID the app makes for this payment. A repeated key answers the session it started, without charging again.
|
|
53522
|
+
* @param {*} [options] Override http request option.
|
|
53523
|
+
* @throws {RequiredError}
|
|
53524
|
+
*/
|
|
53525
|
+
initiateNexiSession: (initiateNexiSessionDto: InitiateNexiSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
53091
53526
|
/**
|
|
53092
53527
|
* Builds the Viva app-to-app launch params (same as the legacy viva/a2a/create-payment) and persists a PaymentSession keyed by the Viva clientTransactionId, so the webhook + reconciliation own the order mutation. Returns the launch params plus a clientToken to poll the session.
|
|
53093
53528
|
* @summary Initiate a Viva app-to-app payment session
|
|
@@ -53268,6 +53703,14 @@ export declare const PaymentSessionApiAxiosParamCreator: (configuration?: Config
|
|
|
53268
53703
|
* @throws {RequiredError}
|
|
53269
53704
|
*/
|
|
53270
53705
|
voidManualPayment: (voidManualSessionDto: VoidManualSessionDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
53706
|
+
/**
|
|
53707
|
+
* Called by a Cloud Task with the scheduler key, never by an app. Repeats a waiting sale\'s purchase at Nexi, which holds the question up to 25 seconds and answers the moment the customer finishes. Still at the terminal: the next round is booked at once; paused at Nexi: after a pause. Paid: Nexi\'s answer is kept, Nexi is confirmed, the sale is stored SUCCESS, written on the order, then announced. Not paid: the failure is confirmed at Nexi with its code, then recorded FAILED in the till\'s words and announced. A sale already stored paid is put on the order from what the session keeps: Nexi is not asked and no login is read. Nexi busy or unreachable: the next round follows Nexi\'s Retry-After up to a minute, or a pause that doubles up to a minute, each with jitter. After 5 minutes of pauses for one reason: an order write that keeps failing hands the charge to the till as its own order and alerts a person; a confirm Nexi keeps refusing (Nexi: confirm until the server takes it) and a Nexi that cannot be heard alert a person once and are asked on every minute, never given up. Answers 500 when the next round could not be booked, so Cloud Tasks runs this round again.
|
|
53708
|
+
* @summary Internal: ask Nexi about a sale once more (Cloud Task callback)
|
|
53709
|
+
* @param {NexiWaitRoundDto} nexiWaitRoundDto
|
|
53710
|
+
* @param {*} [options] Override http request option.
|
|
53711
|
+
* @throws {RequiredError}
|
|
53712
|
+
*/
|
|
53713
|
+
waitForNexiSession: (nexiWaitRoundDto: NexiWaitRoundDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
53271
53714
|
};
|
|
53272
53715
|
/**
|
|
53273
53716
|
* PaymentSessionApi - functional programming interface
|
|
@@ -53338,6 +53781,15 @@ export declare const PaymentSessionApiFp: (configuration?: Configuration) => {
|
|
|
53338
53781
|
* @throws {RequiredError}
|
|
53339
53782
|
*/
|
|
53340
53783
|
initiateNetsSession(initiateNetsSessionDto: InitiateNetsSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InitiateNetsSessionResponseDto>>;
|
|
53784
|
+
/**
|
|
53785
|
+
* 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. A Nexi sale is refused by :clientToken/cancel; Nexi\'s own cancel comes with a later route. 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).
|
|
53786
|
+
* @summary Start a card payment on the station\'s Nexi terminal
|
|
53787
|
+
* @param {InitiateNexiSessionDto} initiateNexiSessionDto
|
|
53788
|
+
* @param {string} [xIdempotencyKey] A UUID the app makes for this payment. A repeated key answers the session it started, without charging again.
|
|
53789
|
+
* @param {*} [options] Override http request option.
|
|
53790
|
+
* @throws {RequiredError}
|
|
53791
|
+
*/
|
|
53792
|
+
initiateNexiSession(initiateNexiSessionDto: InitiateNexiSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentSessionViewDto>>;
|
|
53341
53793
|
/**
|
|
53342
53794
|
* Builds the Viva app-to-app launch params (same as the legacy viva/a2a/create-payment) and persists a PaymentSession keyed by the Viva clientTransactionId, so the webhook + reconciliation own the order mutation. Returns the launch params plus a clientToken to poll the session.
|
|
53343
53795
|
* @summary Initiate a Viva app-to-app payment session
|
|
@@ -53518,6 +53970,14 @@ export declare const PaymentSessionApiFp: (configuration?: Configuration) => {
|
|
|
53518
53970
|
* @throws {RequiredError}
|
|
53519
53971
|
*/
|
|
53520
53972
|
voidManualPayment(voidManualSessionDto: VoidManualSessionDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RecordManualPaymentResultDto>>;
|
|
53973
|
+
/**
|
|
53974
|
+
* Called by a Cloud Task with the scheduler key, never by an app. Repeats a waiting sale\'s purchase at Nexi, which holds the question up to 25 seconds and answers the moment the customer finishes. Still at the terminal: the next round is booked at once; paused at Nexi: after a pause. Paid: Nexi\'s answer is kept, Nexi is confirmed, the sale is stored SUCCESS, written on the order, then announced. Not paid: the failure is confirmed at Nexi with its code, then recorded FAILED in the till\'s words and announced. A sale already stored paid is put on the order from what the session keeps: Nexi is not asked and no login is read. Nexi busy or unreachable: the next round follows Nexi\'s Retry-After up to a minute, or a pause that doubles up to a minute, each with jitter. After 5 minutes of pauses for one reason: an order write that keeps failing hands the charge to the till as its own order and alerts a person; a confirm Nexi keeps refusing (Nexi: confirm until the server takes it) and a Nexi that cannot be heard alert a person once and are asked on every minute, never given up. Answers 500 when the next round could not be booked, so Cloud Tasks runs this round again.
|
|
53975
|
+
* @summary Internal: ask Nexi about a sale once more (Cloud Task callback)
|
|
53976
|
+
* @param {NexiWaitRoundDto} nexiWaitRoundDto
|
|
53977
|
+
* @param {*} [options] Override http request option.
|
|
53978
|
+
* @throws {RequiredError}
|
|
53979
|
+
*/
|
|
53980
|
+
waitForNexiSession(nexiWaitRoundDto: NexiWaitRoundDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
53521
53981
|
};
|
|
53522
53982
|
/**
|
|
53523
53983
|
* PaymentSessionApi - factory interface
|
|
@@ -53588,6 +54048,15 @@ export declare const PaymentSessionApiFactory: (configuration?: Configuration, b
|
|
|
53588
54048
|
* @throws {RequiredError}
|
|
53589
54049
|
*/
|
|
53590
54050
|
initiateNetsSession(initiateNetsSessionDto: InitiateNetsSessionDto, xIdempotencyKey?: string, options?: any): AxiosPromise<InitiateNetsSessionResponseDto>;
|
|
54051
|
+
/**
|
|
54052
|
+
* 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. A Nexi sale is refused by :clientToken/cancel; Nexi\'s own cancel comes with a later route. 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).
|
|
54053
|
+
* @summary Start a card payment on the station\'s Nexi terminal
|
|
54054
|
+
* @param {InitiateNexiSessionDto} initiateNexiSessionDto
|
|
54055
|
+
* @param {string} [xIdempotencyKey] A UUID the app makes for this payment. A repeated key answers the session it started, without charging again.
|
|
54056
|
+
* @param {*} [options] Override http request option.
|
|
54057
|
+
* @throws {RequiredError}
|
|
54058
|
+
*/
|
|
54059
|
+
initiateNexiSession(initiateNexiSessionDto: InitiateNexiSessionDto, xIdempotencyKey?: string, options?: any): AxiosPromise<PaymentSessionViewDto>;
|
|
53591
54060
|
/**
|
|
53592
54061
|
* Builds the Viva app-to-app launch params (same as the legacy viva/a2a/create-payment) and persists a PaymentSession keyed by the Viva clientTransactionId, so the webhook + reconciliation own the order mutation. Returns the launch params plus a clientToken to poll the session.
|
|
53593
54062
|
* @summary Initiate a Viva app-to-app payment session
|
|
@@ -53768,6 +54237,14 @@ export declare const PaymentSessionApiFactory: (configuration?: Configuration, b
|
|
|
53768
54237
|
* @throws {RequiredError}
|
|
53769
54238
|
*/
|
|
53770
54239
|
voidManualPayment(voidManualSessionDto: VoidManualSessionDto, options?: any): AxiosPromise<RecordManualPaymentResultDto>;
|
|
54240
|
+
/**
|
|
54241
|
+
* Called by a Cloud Task with the scheduler key, never by an app. Repeats a waiting sale\'s purchase at Nexi, which holds the question up to 25 seconds and answers the moment the customer finishes. Still at the terminal: the next round is booked at once; paused at Nexi: after a pause. Paid: Nexi\'s answer is kept, Nexi is confirmed, the sale is stored SUCCESS, written on the order, then announced. Not paid: the failure is confirmed at Nexi with its code, then recorded FAILED in the till\'s words and announced. A sale already stored paid is put on the order from what the session keeps: Nexi is not asked and no login is read. Nexi busy or unreachable: the next round follows Nexi\'s Retry-After up to a minute, or a pause that doubles up to a minute, each with jitter. After 5 minutes of pauses for one reason: an order write that keeps failing hands the charge to the till as its own order and alerts a person; a confirm Nexi keeps refusing (Nexi: confirm until the server takes it) and a Nexi that cannot be heard alert a person once and are asked on every minute, never given up. Answers 500 when the next round could not be booked, so Cloud Tasks runs this round again.
|
|
54242
|
+
* @summary Internal: ask Nexi about a sale once more (Cloud Task callback)
|
|
54243
|
+
* @param {NexiWaitRoundDto} nexiWaitRoundDto
|
|
54244
|
+
* @param {*} [options] Override http request option.
|
|
54245
|
+
* @throws {RequiredError}
|
|
54246
|
+
*/
|
|
54247
|
+
waitForNexiSession(nexiWaitRoundDto: NexiWaitRoundDto, options?: any): AxiosPromise<void>;
|
|
53771
54248
|
};
|
|
53772
54249
|
/**
|
|
53773
54250
|
* PaymentSessionApi - interface
|
|
@@ -53846,6 +54323,16 @@ export interface PaymentSessionApiInterface {
|
|
|
53846
54323
|
* @memberof PaymentSessionApiInterface
|
|
53847
54324
|
*/
|
|
53848
54325
|
initiateNetsSession(initiateNetsSessionDto: InitiateNetsSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): AxiosPromise<InitiateNetsSessionResponseDto>;
|
|
54326
|
+
/**
|
|
54327
|
+
* 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. A Nexi sale is refused by :clientToken/cancel; Nexi\'s own cancel comes with a later route. 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).
|
|
54328
|
+
* @summary Start a card payment on the station\'s Nexi terminal
|
|
54329
|
+
* @param {InitiateNexiSessionDto} initiateNexiSessionDto
|
|
54330
|
+
* @param {string} [xIdempotencyKey] A UUID the app makes for this payment. A repeated key answers the session it started, without charging again.
|
|
54331
|
+
* @param {*} [options] Override http request option.
|
|
54332
|
+
* @throws {RequiredError}
|
|
54333
|
+
* @memberof PaymentSessionApiInterface
|
|
54334
|
+
*/
|
|
54335
|
+
initiateNexiSession(initiateNexiSessionDto: InitiateNexiSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): AxiosPromise<PaymentSessionViewDto>;
|
|
53849
54336
|
/**
|
|
53850
54337
|
* Builds the Viva app-to-app launch params (same as the legacy viva/a2a/create-payment) and persists a PaymentSession keyed by the Viva clientTransactionId, so the webhook + reconciliation own the order mutation. Returns the launch params plus a clientToken to poll the session.
|
|
53851
54338
|
* @summary Initiate a Viva app-to-app payment session
|
|
@@ -54048,6 +54535,15 @@ export interface PaymentSessionApiInterface {
|
|
|
54048
54535
|
* @memberof PaymentSessionApiInterface
|
|
54049
54536
|
*/
|
|
54050
54537
|
voidManualPayment(voidManualSessionDto: VoidManualSessionDto, options?: AxiosRequestConfig): AxiosPromise<RecordManualPaymentResultDto>;
|
|
54538
|
+
/**
|
|
54539
|
+
* Called by a Cloud Task with the scheduler key, never by an app. Repeats a waiting sale\'s purchase at Nexi, which holds the question up to 25 seconds and answers the moment the customer finishes. Still at the terminal: the next round is booked at once; paused at Nexi: after a pause. Paid: Nexi\'s answer is kept, Nexi is confirmed, the sale is stored SUCCESS, written on the order, then announced. Not paid: the failure is confirmed at Nexi with its code, then recorded FAILED in the till\'s words and announced. A sale already stored paid is put on the order from what the session keeps: Nexi is not asked and no login is read. Nexi busy or unreachable: the next round follows Nexi\'s Retry-After up to a minute, or a pause that doubles up to a minute, each with jitter. After 5 minutes of pauses for one reason: an order write that keeps failing hands the charge to the till as its own order and alerts a person; a confirm Nexi keeps refusing (Nexi: confirm until the server takes it) and a Nexi that cannot be heard alert a person once and are asked on every minute, never given up. Answers 500 when the next round could not be booked, so Cloud Tasks runs this round again.
|
|
54540
|
+
* @summary Internal: ask Nexi about a sale once more (Cloud Task callback)
|
|
54541
|
+
* @param {NexiWaitRoundDto} nexiWaitRoundDto
|
|
54542
|
+
* @param {*} [options] Override http request option.
|
|
54543
|
+
* @throws {RequiredError}
|
|
54544
|
+
* @memberof PaymentSessionApiInterface
|
|
54545
|
+
*/
|
|
54546
|
+
waitForNexiSession(nexiWaitRoundDto: NexiWaitRoundDto, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
54051
54547
|
}
|
|
54052
54548
|
/**
|
|
54053
54549
|
* PaymentSessionApi - object-oriented interface
|
|
@@ -54127,6 +54623,16 @@ export declare class PaymentSessionApi extends BaseAPI implements PaymentSession
|
|
|
54127
54623
|
* @memberof PaymentSessionApi
|
|
54128
54624
|
*/
|
|
54129
54625
|
initiateNetsSession(initiateNetsSessionDto: InitiateNetsSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<InitiateNetsSessionResponseDto, any, {}>>;
|
|
54626
|
+
/**
|
|
54627
|
+
* 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. A Nexi sale is refused by :clientToken/cancel; Nexi\'s own cancel comes with a later route. 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).
|
|
54628
|
+
* @summary Start a card payment on the station\'s Nexi terminal
|
|
54629
|
+
* @param {InitiateNexiSessionDto} initiateNexiSessionDto
|
|
54630
|
+
* @param {string} [xIdempotencyKey] A UUID the app makes for this payment. A repeated key answers the session it started, without charging again.
|
|
54631
|
+
* @param {*} [options] Override http request option.
|
|
54632
|
+
* @throws {RequiredError}
|
|
54633
|
+
* @memberof PaymentSessionApi
|
|
54634
|
+
*/
|
|
54635
|
+
initiateNexiSession(initiateNexiSessionDto: InitiateNexiSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PaymentSessionViewDto, any, {}>>;
|
|
54130
54636
|
/**
|
|
54131
54637
|
* Builds the Viva app-to-app launch params (same as the legacy viva/a2a/create-payment) and persists a PaymentSession keyed by the Viva clientTransactionId, so the webhook + reconciliation own the order mutation. Returns the launch params plus a clientToken to poll the session.
|
|
54132
54638
|
* @summary Initiate a Viva app-to-app payment session
|
|
@@ -54329,6 +54835,15 @@ export declare class PaymentSessionApi extends BaseAPI implements PaymentSession
|
|
|
54329
54835
|
* @memberof PaymentSessionApi
|
|
54330
54836
|
*/
|
|
54331
54837
|
voidManualPayment(voidManualSessionDto: VoidManualSessionDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RecordManualPaymentResultDto, any, {}>>;
|
|
54838
|
+
/**
|
|
54839
|
+
* Called by a Cloud Task with the scheduler key, never by an app. Repeats a waiting sale\'s purchase at Nexi, which holds the question up to 25 seconds and answers the moment the customer finishes. Still at the terminal: the next round is booked at once; paused at Nexi: after a pause. Paid: Nexi\'s answer is kept, Nexi is confirmed, the sale is stored SUCCESS, written on the order, then announced. Not paid: the failure is confirmed at Nexi with its code, then recorded FAILED in the till\'s words and announced. A sale already stored paid is put on the order from what the session keeps: Nexi is not asked and no login is read. Nexi busy or unreachable: the next round follows Nexi\'s Retry-After up to a minute, or a pause that doubles up to a minute, each with jitter. After 5 minutes of pauses for one reason: an order write that keeps failing hands the charge to the till as its own order and alerts a person; a confirm Nexi keeps refusing (Nexi: confirm until the server takes it) and a Nexi that cannot be heard alert a person once and are asked on every minute, never given up. Answers 500 when the next round could not be booked, so Cloud Tasks runs this round again.
|
|
54840
|
+
* @summary Internal: ask Nexi about a sale once more (Cloud Task callback)
|
|
54841
|
+
* @param {NexiWaitRoundDto} nexiWaitRoundDto
|
|
54842
|
+
* @param {*} [options] Override http request option.
|
|
54843
|
+
* @throws {RequiredError}
|
|
54844
|
+
* @memberof PaymentSessionApi
|
|
54845
|
+
*/
|
|
54846
|
+
waitForNexiSession(nexiWaitRoundDto: NexiWaitRoundDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
54332
54847
|
}
|
|
54333
54848
|
/**
|
|
54334
54849
|
* PrintersApi - axios parameter creator
|
|
@@ -60106,7 +60621,7 @@ export declare const TerminalApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
60106
60621
|
*/
|
|
60107
60622
|
disconnectTerminal: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
60108
60623
|
/**
|
|
60109
|
-
* The POS\'s terminal settings find the venue\'s terminals of one provider, with its ticket and its channel in x-app-x. The device names itself in X-Munchi-Hardware-Id; with X-Munchi-Business-Id (a whole number) the station is looked up in that venue, without it the newest station with this hardware id is used. The station is kept 30 minutes and forgotten when it is synced or deactivated. The provider\'s settings are those of the venue and channel the request names (businessId in the body, x-app-x). Viva is searched with the settings\' merchant and source code, and so are stripe and epassi, as before; Nets is signed in to with the settings\' client and lists its terminals. Every terminal found is stored for the venue as a viva or nets terminal, in one transaction, except Viva terminals another venue\'s station holds. Worldline
|
|
60624
|
+
* The POS\'s terminal settings find the venue\'s terminals of one provider, with its ticket and its channel in x-app-x. The device names itself in X-Munchi-Hardware-Id; with X-Munchi-Business-Id (a whole number) the station is looked up in that venue, without it the newest station with this hardware id is used. The station is kept 30 minutes and forgotten when it is synced or deactivated. The provider\'s settings are those of the venue and channel the request names (businessId in the body, x-app-x). Viva is searched with the settings\' merchant and source code, and so are stripe and epassi, as before; Nets is signed in to with the settings\' client and lists its terminals. Every terminal found is stored for the venue as a viva or nets terminal, in one transaction, except Viva terminals another venue\'s station holds. Worldline and Nexi ask no provider: their stored terminals are read. The answer holds the terminals that are free or connected to the calling till.
|
|
60110
60625
|
* @summary Discover available payment terminals
|
|
60111
60626
|
* @param {DiscoverTerminalDto} discoverTerminalDto The venue and the provider whose terminals to find
|
|
60112
60627
|
* @param {*} [options] Override http request option.
|
|
@@ -60135,7 +60650,7 @@ export declare const TerminalApiFp: (configuration?: Configuration) => {
|
|
|
60135
60650
|
*/
|
|
60136
60651
|
disconnectTerminal(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LinkedStationDto>>;
|
|
60137
60652
|
/**
|
|
60138
|
-
* The POS\'s terminal settings find the venue\'s terminals of one provider, with its ticket and its channel in x-app-x. The device names itself in X-Munchi-Hardware-Id; with X-Munchi-Business-Id (a whole number) the station is looked up in that venue, without it the newest station with this hardware id is used. The station is kept 30 minutes and forgotten when it is synced or deactivated. The provider\'s settings are those of the venue and channel the request names (businessId in the body, x-app-x). Viva is searched with the settings\' merchant and source code, and so are stripe and epassi, as before; Nets is signed in to with the settings\' client and lists its terminals. Every terminal found is stored for the venue as a viva or nets terminal, in one transaction, except Viva terminals another venue\'s station holds. Worldline
|
|
60653
|
+
* The POS\'s terminal settings find the venue\'s terminals of one provider, with its ticket and its channel in x-app-x. The device names itself in X-Munchi-Hardware-Id; with X-Munchi-Business-Id (a whole number) the station is looked up in that venue, without it the newest station with this hardware id is used. The station is kept 30 minutes and forgotten when it is synced or deactivated. The provider\'s settings are those of the venue and channel the request names (businessId in the body, x-app-x). Viva is searched with the settings\' merchant and source code, and so are stripe and epassi, as before; Nets is signed in to with the settings\' client and lists its terminals. Every terminal found is stored for the venue as a viva or nets terminal, in one transaction, except Viva terminals another venue\'s station holds. Worldline and Nexi ask no provider: their stored terminals are read. The answer holds the terminals that are free or connected to the calling till.
|
|
60139
60654
|
* @summary Discover available payment terminals
|
|
60140
60655
|
* @param {DiscoverTerminalDto} discoverTerminalDto The venue and the provider whose terminals to find
|
|
60141
60656
|
* @param {*} [options] Override http request option.
|
|
@@ -60164,7 +60679,7 @@ export declare const TerminalApiFactory: (configuration?: Configuration, basePat
|
|
|
60164
60679
|
*/
|
|
60165
60680
|
disconnectTerminal(options?: any): AxiosPromise<LinkedStationDto>;
|
|
60166
60681
|
/**
|
|
60167
|
-
* The POS\'s terminal settings find the venue\'s terminals of one provider, with its ticket and its channel in x-app-x. The device names itself in X-Munchi-Hardware-Id; with X-Munchi-Business-Id (a whole number) the station is looked up in that venue, without it the newest station with this hardware id is used. The station is kept 30 minutes and forgotten when it is synced or deactivated. The provider\'s settings are those of the venue and channel the request names (businessId in the body, x-app-x). Viva is searched with the settings\' merchant and source code, and so are stripe and epassi, as before; Nets is signed in to with the settings\' client and lists its terminals. Every terminal found is stored for the venue as a viva or nets terminal, in one transaction, except Viva terminals another venue\'s station holds. Worldline
|
|
60682
|
+
* The POS\'s terminal settings find the venue\'s terminals of one provider, with its ticket and its channel in x-app-x. The device names itself in X-Munchi-Hardware-Id; with X-Munchi-Business-Id (a whole number) the station is looked up in that venue, without it the newest station with this hardware id is used. The station is kept 30 minutes and forgotten when it is synced or deactivated. The provider\'s settings are those of the venue and channel the request names (businessId in the body, x-app-x). Viva is searched with the settings\' merchant and source code, and so are stripe and epassi, as before; Nets is signed in to with the settings\' client and lists its terminals. Every terminal found is stored for the venue as a viva or nets terminal, in one transaction, except Viva terminals another venue\'s station holds. Worldline and Nexi ask no provider: their stored terminals are read. The answer holds the terminals that are free or connected to the calling till.
|
|
60168
60683
|
* @summary Discover available payment terminals
|
|
60169
60684
|
* @param {DiscoverTerminalDto} discoverTerminalDto The venue and the provider whose terminals to find
|
|
60170
60685
|
* @param {*} [options] Override http request option.
|
|
@@ -60196,7 +60711,7 @@ export interface TerminalApiInterface {
|
|
|
60196
60711
|
*/
|
|
60197
60712
|
disconnectTerminal(options?: AxiosRequestConfig): AxiosPromise<LinkedStationDto>;
|
|
60198
60713
|
/**
|
|
60199
|
-
* The POS\'s terminal settings find the venue\'s terminals of one provider, with its ticket and its channel in x-app-x. The device names itself in X-Munchi-Hardware-Id; with X-Munchi-Business-Id (a whole number) the station is looked up in that venue, without it the newest station with this hardware id is used. The station is kept 30 minutes and forgotten when it is synced or deactivated. The provider\'s settings are those of the venue and channel the request names (businessId in the body, x-app-x). Viva is searched with the settings\' merchant and source code, and so are stripe and epassi, as before; Nets is signed in to with the settings\' client and lists its terminals. Every terminal found is stored for the venue as a viva or nets terminal, in one transaction, except Viva terminals another venue\'s station holds. Worldline
|
|
60714
|
+
* The POS\'s terminal settings find the venue\'s terminals of one provider, with its ticket and its channel in x-app-x. The device names itself in X-Munchi-Hardware-Id; with X-Munchi-Business-Id (a whole number) the station is looked up in that venue, without it the newest station with this hardware id is used. The station is kept 30 minutes and forgotten when it is synced or deactivated. The provider\'s settings are those of the venue and channel the request names (businessId in the body, x-app-x). Viva is searched with the settings\' merchant and source code, and so are stripe and epassi, as before; Nets is signed in to with the settings\' client and lists its terminals. Every terminal found is stored for the venue as a viva or nets terminal, in one transaction, except Viva terminals another venue\'s station holds. Worldline and Nexi ask no provider: their stored terminals are read. The answer holds the terminals that are free or connected to the calling till.
|
|
60200
60715
|
* @summary Discover available payment terminals
|
|
60201
60716
|
* @param {DiscoverTerminalDto} discoverTerminalDto The venue and the provider whose terminals to find
|
|
60202
60717
|
* @param {*} [options] Override http request option.
|
|
@@ -60230,7 +60745,7 @@ export declare class TerminalApi extends BaseAPI implements TerminalApiInterface
|
|
|
60230
60745
|
*/
|
|
60231
60746
|
disconnectTerminal(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<LinkedStationDto, any, {}>>;
|
|
60232
60747
|
/**
|
|
60233
|
-
* The POS\'s terminal settings find the venue\'s terminals of one provider, with its ticket and its channel in x-app-x. The device names itself in X-Munchi-Hardware-Id; with X-Munchi-Business-Id (a whole number) the station is looked up in that venue, without it the newest station with this hardware id is used. The station is kept 30 minutes and forgotten when it is synced or deactivated. The provider\'s settings are those of the venue and channel the request names (businessId in the body, x-app-x). Viva is searched with the settings\' merchant and source code, and so are stripe and epassi, as before; Nets is signed in to with the settings\' client and lists its terminals. Every terminal found is stored for the venue as a viva or nets terminal, in one transaction, except Viva terminals another venue\'s station holds. Worldline
|
|
60748
|
+
* The POS\'s terminal settings find the venue\'s terminals of one provider, with its ticket and its channel in x-app-x. The device names itself in X-Munchi-Hardware-Id; with X-Munchi-Business-Id (a whole number) the station is looked up in that venue, without it the newest station with this hardware id is used. The station is kept 30 minutes and forgotten when it is synced or deactivated. The provider\'s settings are those of the venue and channel the request names (businessId in the body, x-app-x). Viva is searched with the settings\' merchant and source code, and so are stripe and epassi, as before; Nets is signed in to with the settings\' client and lists its terminals. Every terminal found is stored for the venue as a viva or nets terminal, in one transaction, except Viva terminals another venue\'s station holds. Worldline and Nexi ask no provider: their stored terminals are read. The answer holds the terminals that are free or connected to the calling till.
|
|
60234
60749
|
* @summary Discover available payment terminals
|
|
60235
60750
|
* @param {DiscoverTerminalDto} discoverTerminalDto The venue and the provider whose terminals to find
|
|
60236
60751
|
* @param {*} [options] Override http request option.
|
|
@@ -60525,7 +61040,7 @@ export declare const VenueKiosksApiAxiosParamCreator: (configuration?: Configura
|
|
|
60525
61040
|
*/
|
|
60526
61041
|
claimVenueKiosk: (businessId: number, claimKioskDto: ClaimKioskDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
60527
61042
|
/**
|
|
60528
|
-
* 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.
|
|
61043
|
+
* 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, a Nexi terminal ID t- and 10 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, and a Nexi terminal another venue stores, since Nexi holds one unconfirmed sale per terminal. Viva and Nets terminals may be stored at several venues, as discover stores them.
|
|
60529
61044
|
* @summary Add a payment terminal to the venue (Munchi admins only)
|
|
60530
61045
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60531
61046
|
* @param {CreatePaymentTerminalDto} createPaymentTerminalDto
|
|
@@ -60613,7 +61128,7 @@ export declare const VenueKiosksApiFp: (configuration?: Configuration) => {
|
|
|
60613
61128
|
*/
|
|
60614
61129
|
claimVenueKiosk(businessId: number, claimKioskDto: ClaimKioskDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueKioskDto>>;
|
|
60615
61130
|
/**
|
|
60616
|
-
* 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.
|
|
61131
|
+
* 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, a Nexi terminal ID t- and 10 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, and a Nexi terminal another venue stores, since Nexi holds one unconfirmed sale per terminal. Viva and Nets terminals may be stored at several venues, as discover stores them.
|
|
60617
61132
|
* @summary Add a payment terminal to the venue (Munchi admins only)
|
|
60618
61133
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60619
61134
|
* @param {CreatePaymentTerminalDto} createPaymentTerminalDto
|
|
@@ -60701,7 +61216,7 @@ export declare const VenueKiosksApiFactory: (configuration?: Configuration, base
|
|
|
60701
61216
|
*/
|
|
60702
61217
|
claimVenueKiosk(businessId: number, claimKioskDto: ClaimKioskDto, options?: any): AxiosPromise<VenueKioskDto>;
|
|
60703
61218
|
/**
|
|
60704
|
-
* 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.
|
|
61219
|
+
* 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, a Nexi terminal ID t- and 10 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, and a Nexi terminal another venue stores, since Nexi holds one unconfirmed sale per terminal. Viva and Nets terminals may be stored at several venues, as discover stores them.
|
|
60705
61220
|
* @summary Add a payment terminal to the venue (Munchi admins only)
|
|
60706
61221
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60707
61222
|
* @param {CreatePaymentTerminalDto} createPaymentTerminalDto
|
|
@@ -60792,7 +61307,7 @@ export interface VenueKiosksApiInterface {
|
|
|
60792
61307
|
*/
|
|
60793
61308
|
claimVenueKiosk(businessId: number, claimKioskDto: ClaimKioskDto, options?: AxiosRequestConfig): AxiosPromise<VenueKioskDto>;
|
|
60794
61309
|
/**
|
|
60795
|
-
* 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.
|
|
61310
|
+
* 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, a Nexi terminal ID t- and 10 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, and a Nexi terminal another venue stores, since Nexi holds one unconfirmed sale per terminal. Viva and Nets terminals may be stored at several venues, as discover stores them.
|
|
60796
61311
|
* @summary Add a payment terminal to the venue (Munchi admins only)
|
|
60797
61312
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60798
61313
|
* @param {CreatePaymentTerminalDto} createPaymentTerminalDto
|
|
@@ -60891,7 +61406,7 @@ export declare class VenueKiosksApi extends BaseAPI implements VenueKiosksApiInt
|
|
|
60891
61406
|
*/
|
|
60892
61407
|
claimVenueKiosk(businessId: number, claimKioskDto: ClaimKioskDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VenueKioskDto, any, {}>>;
|
|
60893
61408
|
/**
|
|
60894
|
-
* 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.
|
|
61409
|
+
* 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, a Nexi terminal ID t- and 10 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, and a Nexi terminal another venue stores, since Nexi holds one unconfirmed sale per terminal. Viva and Nets terminals may be stored at several venues, as discover stores them.
|
|
60895
61410
|
* @summary Add a payment terminal to the venue (Munchi admins only)
|
|
60896
61411
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60897
61412
|
* @param {CreatePaymentTerminalDto} createPaymentTerminalDto
|