@munchi_oy/core 2.0.4 → 2.0.6
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 +1306 -185
- 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 +2103 -338
- package/package.json +1 -1
- package/src/version.ts +1 -1
package/dist/generated/api.d.ts
CHANGED
|
@@ -132,6 +132,68 @@ export declare const ActionsEnum: {
|
|
|
132
132
|
readonly CourseFire: "CourseFire";
|
|
133
133
|
};
|
|
134
134
|
export type ActionsEnum = typeof ActionsEnum[keyof typeof ActionsEnum];
|
|
135
|
+
/**
|
|
136
|
+
*
|
|
137
|
+
* @export
|
|
138
|
+
* @interface AddEmployeeDto
|
|
139
|
+
*/
|
|
140
|
+
export interface AddEmployeeDto {
|
|
141
|
+
/**
|
|
142
|
+
* The employee\'s phone, in international format. Null clears it.
|
|
143
|
+
* @type {object}
|
|
144
|
+
* @memberof AddEmployeeDto
|
|
145
|
+
*/
|
|
146
|
+
'phone'?: object | null;
|
|
147
|
+
/**
|
|
148
|
+
* A photo of the employee, shown on the till\'s PIN screen. Null clears it.
|
|
149
|
+
* @type {object}
|
|
150
|
+
* @memberof AddEmployeeDto
|
|
151
|
+
*/
|
|
152
|
+
'photoUrl'?: object | null;
|
|
153
|
+
/**
|
|
154
|
+
* The employee\'s name, as the till shows it
|
|
155
|
+
* @type {string}
|
|
156
|
+
* @memberof AddEmployeeDto
|
|
157
|
+
*/
|
|
158
|
+
'name': string;
|
|
159
|
+
/**
|
|
160
|
+
* The employee\'s 4-digit PIN, unique among every employee (active or inactive) and passcode of the merchant, because the till looks a PIN up across it. Never answered back.
|
|
161
|
+
* @type {string}
|
|
162
|
+
* @memberof AddEmployeeDto
|
|
163
|
+
*/
|
|
164
|
+
'pin': string;
|
|
165
|
+
/**
|
|
166
|
+
* The employee\'s e-mail, unique among the merchant\'s employees: the same person\'s dashboard login is invited with it (D145). Saved in lower case.
|
|
167
|
+
* @type {string}
|
|
168
|
+
* @memberof AddEmployeeDto
|
|
169
|
+
*/
|
|
170
|
+
'email': string;
|
|
171
|
+
/**
|
|
172
|
+
* The venues the employee works at, each with the employee\'s role there; at least one, each venue once. Every venue must be on the signed-in account and of the venue\'s merchant.
|
|
173
|
+
* @type {Array<EmployeeAssignmentDto>}
|
|
174
|
+
* @memberof AddEmployeeDto
|
|
175
|
+
*/
|
|
176
|
+
'assignments': Array<EmployeeAssignmentDto>;
|
|
177
|
+
}
|
|
178
|
+
/**
|
|
179
|
+
*
|
|
180
|
+
* @export
|
|
181
|
+
* @interface AddEmployeeRoleDto
|
|
182
|
+
*/
|
|
183
|
+
export interface AddEmployeeRoleDto {
|
|
184
|
+
/**
|
|
185
|
+
* The role\'s name, as the staff see it on the till; unique at the venue
|
|
186
|
+
* @type {string}
|
|
187
|
+
* @memberof AddEmployeeRoleDto
|
|
188
|
+
*/
|
|
189
|
+
'name': string;
|
|
190
|
+
/**
|
|
191
|
+
* The POS keys the role holds, from GET /api/v1/pos-permissions. A group\'s `::*` key holds every key of the group, those added later included. Keys a role does not list are not held.
|
|
192
|
+
* @type {Array<PosPermission>}
|
|
193
|
+
* @memberof AddEmployeeRoleDto
|
|
194
|
+
*/
|
|
195
|
+
'permissionKeys': Array<PosPermission>;
|
|
196
|
+
}
|
|
135
197
|
/**
|
|
136
198
|
*
|
|
137
199
|
* @export
|
|
@@ -2226,6 +2288,68 @@ export declare const CdsSessionRole: {
|
|
|
2226
2288
|
readonly Display: "display";
|
|
2227
2289
|
};
|
|
2228
2290
|
export type CdsSessionRole = typeof CdsSessionRole[keyof typeof CdsSessionRole];
|
|
2291
|
+
/**
|
|
2292
|
+
*
|
|
2293
|
+
* @export
|
|
2294
|
+
* @interface ChangeEmployeeDto
|
|
2295
|
+
*/
|
|
2296
|
+
export interface ChangeEmployeeDto {
|
|
2297
|
+
/**
|
|
2298
|
+
* The employee\'s phone, in international format. Null clears it.
|
|
2299
|
+
* @type {object}
|
|
2300
|
+
* @memberof ChangeEmployeeDto
|
|
2301
|
+
*/
|
|
2302
|
+
'phone'?: object | null;
|
|
2303
|
+
/**
|
|
2304
|
+
* A photo of the employee, shown on the till\'s PIN screen. Null clears it.
|
|
2305
|
+
* @type {object}
|
|
2306
|
+
* @memberof ChangeEmployeeDto
|
|
2307
|
+
*/
|
|
2308
|
+
'photoUrl'?: object | null;
|
|
2309
|
+
/**
|
|
2310
|
+
* The employee\'s new name. Absent: the name stays.
|
|
2311
|
+
* @type {string}
|
|
2312
|
+
* @memberof ChangeEmployeeDto
|
|
2313
|
+
*/
|
|
2314
|
+
'name'?: string;
|
|
2315
|
+
/**
|
|
2316
|
+
* A new PIN. The employee\'s 4-digit PIN, unique among every employee (active or inactive) and passcode of the merchant, because the till looks a PIN up across it. Never answered back. Absent: the PIN stays.
|
|
2317
|
+
* @type {string}
|
|
2318
|
+
* @memberof ChangeEmployeeDto
|
|
2319
|
+
*/
|
|
2320
|
+
'pin'?: string;
|
|
2321
|
+
/**
|
|
2322
|
+
* A new e-mail. The employee\'s e-mail, unique among the merchant\'s employees: the same person\'s dashboard login is invited with it (D145). Saved in lower case. Absent: the e-mail stays; it is never cleared.
|
|
2323
|
+
* @type {string}
|
|
2324
|
+
* @memberof ChangeEmployeeDto
|
|
2325
|
+
*/
|
|
2326
|
+
'email'?: string;
|
|
2327
|
+
/**
|
|
2328
|
+
*
|
|
2329
|
+
* @type {Status}
|
|
2330
|
+
* @memberof ChangeEmployeeDto
|
|
2331
|
+
*/
|
|
2332
|
+
'status'?: Status;
|
|
2333
|
+
}
|
|
2334
|
+
/**
|
|
2335
|
+
*
|
|
2336
|
+
* @export
|
|
2337
|
+
* @interface ChangeEmployeeRoleDto
|
|
2338
|
+
*/
|
|
2339
|
+
export interface ChangeEmployeeRoleDto {
|
|
2340
|
+
/**
|
|
2341
|
+
* The role\'s new name; unique at the venue. Absent: the name stays.
|
|
2342
|
+
* @type {string}
|
|
2343
|
+
* @memberof ChangeEmployeeRoleDto
|
|
2344
|
+
*/
|
|
2345
|
+
'name'?: string;
|
|
2346
|
+
/**
|
|
2347
|
+
* The POS keys the role holds, from GET /api/v1/pos-permissions. A group\'s `::*` key holds every key of the group, those added later included. Keys a role does not list are not held. Sent, they replace every key the role had. Absent: the keys stay.
|
|
2348
|
+
* @type {Array<PosPermission>}
|
|
2349
|
+
* @memberof ChangeEmployeeRoleDto
|
|
2350
|
+
*/
|
|
2351
|
+
'permissionKeys'?: Array<PosPermission>;
|
|
2352
|
+
}
|
|
2229
2353
|
/**
|
|
2230
2354
|
*
|
|
2231
2355
|
* @export
|
|
@@ -2369,6 +2493,7 @@ export declare const ChannelEnum: {
|
|
|
2369
2493
|
readonly WoltStorefront: "WoltStorefront";
|
|
2370
2494
|
readonly Storefront: "Storefront";
|
|
2371
2495
|
readonly MunchiPay: "MunchiPay";
|
|
2496
|
+
readonly ResQ: "ResQ";
|
|
2372
2497
|
};
|
|
2373
2498
|
export type ChannelEnum = typeof ChannelEnum[keyof typeof ChannelEnum];
|
|
2374
2499
|
/**
|
|
@@ -3018,6 +3143,31 @@ export interface ConfirmPreorderDto {
|
|
|
3018
3143
|
*/
|
|
3019
3144
|
'preparedIn': number;
|
|
3020
3145
|
}
|
|
3146
|
+
/**
|
|
3147
|
+
*
|
|
3148
|
+
* @export
|
|
3149
|
+
* @interface ConnectDeliveryPlatformDto
|
|
3150
|
+
*/
|
|
3151
|
+
export interface ConnectDeliveryPlatformDto {
|
|
3152
|
+
/**
|
|
3153
|
+
*
|
|
3154
|
+
* @type {DeliveryPlatformOpsConnect}
|
|
3155
|
+
* @memberof ConnectDeliveryPlatformDto
|
|
3156
|
+
*/
|
|
3157
|
+
'channel': DeliveryPlatformOpsConnect;
|
|
3158
|
+
/**
|
|
3159
|
+
* The store id the platform gave the venue, kept as the provider row\'s externalId: the platform\'s orders arrive under it. One store id belongs to one venue and one platform
|
|
3160
|
+
* @type {string}
|
|
3161
|
+
* @memberof ConnectDeliveryPlatformDto
|
|
3162
|
+
*/
|
|
3163
|
+
'externalId': string;
|
|
3164
|
+
/**
|
|
3165
|
+
* Whether the till accepts the platform\'s orders on its own. Absent: a new row starts without it, and a row already there keeps its own
|
|
3166
|
+
* @type {boolean}
|
|
3167
|
+
* @memberof ConnectDeliveryPlatformDto
|
|
3168
|
+
*/
|
|
3169
|
+
'autoAccept'?: boolean;
|
|
3170
|
+
}
|
|
3021
3171
|
/**
|
|
3022
3172
|
*
|
|
3023
3173
|
* @export
|
|
@@ -3031,6 +3181,49 @@ export interface ConnectTerminalDto {
|
|
|
3031
3181
|
*/
|
|
3032
3182
|
'terminalHardwareId': string;
|
|
3033
3183
|
}
|
|
3184
|
+
/**
|
|
3185
|
+
*
|
|
3186
|
+
* @export
|
|
3187
|
+
* @interface ConnectedDeliveryPlatformDto
|
|
3188
|
+
*/
|
|
3189
|
+
export interface ConnectedDeliveryPlatformDto {
|
|
3190
|
+
/**
|
|
3191
|
+
* The Munchi venue id (orderingBusinessId)
|
|
3192
|
+
* @type {number}
|
|
3193
|
+
* @memberof ConnectedDeliveryPlatformDto
|
|
3194
|
+
*/
|
|
3195
|
+
'venueId': number;
|
|
3196
|
+
/**
|
|
3197
|
+
*
|
|
3198
|
+
* @type {DeliveryPlatformOpsConnect}
|
|
3199
|
+
* @memberof ConnectedDeliveryPlatformDto
|
|
3200
|
+
*/
|
|
3201
|
+
'channel': DeliveryPlatformOpsConnect;
|
|
3202
|
+
/**
|
|
3203
|
+
* The platform\'s store id, the row\'s externalId
|
|
3204
|
+
* @type {string}
|
|
3205
|
+
* @memberof ConnectedDeliveryPlatformDto
|
|
3206
|
+
*/
|
|
3207
|
+
'externalId': string;
|
|
3208
|
+
/**
|
|
3209
|
+
* Whether the row is active; always true once connected
|
|
3210
|
+
* @type {boolean}
|
|
3211
|
+
* @memberof ConnectedDeliveryPlatformDto
|
|
3212
|
+
*/
|
|
3213
|
+
'isActive': boolean;
|
|
3214
|
+
/**
|
|
3215
|
+
* Whether the till accepts the platform\'s orders on its own
|
|
3216
|
+
* @type {boolean}
|
|
3217
|
+
* @memberof ConnectedDeliveryPlatformDto
|
|
3218
|
+
*/
|
|
3219
|
+
'autoAccept': boolean;
|
|
3220
|
+
/**
|
|
3221
|
+
*
|
|
3222
|
+
* @type {DeliveryPlatformConnection}
|
|
3223
|
+
* @memberof ConnectedDeliveryPlatformDto
|
|
3224
|
+
*/
|
|
3225
|
+
'connection': DeliveryPlatformConnection;
|
|
3226
|
+
}
|
|
3034
3227
|
/**
|
|
3035
3228
|
*
|
|
3036
3229
|
* @export
|
|
@@ -5235,6 +5428,27 @@ export declare const DeliveryIntentStatus: {
|
|
|
5235
5428
|
readonly Failed: "failed";
|
|
5236
5429
|
};
|
|
5237
5430
|
export type DeliveryIntentStatus = typeof DeliveryIntentStatus[keyof typeof DeliveryIntentStatus];
|
|
5431
|
+
/**
|
|
5432
|
+
*
|
|
5433
|
+
* @export
|
|
5434
|
+
* @enum {string}
|
|
5435
|
+
*/
|
|
5436
|
+
export declare const DeliveryPlatformConnection: {
|
|
5437
|
+
readonly Created: "created";
|
|
5438
|
+
readonly Reactivated: "reactivated";
|
|
5439
|
+
readonly AlreadyActive: "already_active";
|
|
5440
|
+
};
|
|
5441
|
+
export type DeliveryPlatformConnection = typeof DeliveryPlatformConnection[keyof typeof DeliveryPlatformConnection];
|
|
5442
|
+
/**
|
|
5443
|
+
*
|
|
5444
|
+
* @export
|
|
5445
|
+
* @enum {string}
|
|
5446
|
+
*/
|
|
5447
|
+
export declare const DeliveryPlatformOpsConnect: {
|
|
5448
|
+
readonly Foodora: "Foodora";
|
|
5449
|
+
readonly Bolt: "Bolt";
|
|
5450
|
+
};
|
|
5451
|
+
export type DeliveryPlatformOpsConnect = typeof DeliveryPlatformOpsConnect[keyof typeof DeliveryPlatformOpsConnect];
|
|
5238
5452
|
/**
|
|
5239
5453
|
*
|
|
5240
5454
|
* @export
|
|
@@ -5423,6 +5637,31 @@ export interface DiningTableResponseDto {
|
|
|
5423
5637
|
* @export
|
|
5424
5638
|
*/
|
|
5425
5639
|
export type DisconnectOnboarding200Response = DisconnectedUberEatsStoreDto | DisconnectedWoltVenueDto;
|
|
5640
|
+
/**
|
|
5641
|
+
*
|
|
5642
|
+
* @export
|
|
5643
|
+
* @interface DisconnectedDeliveryPlatformDto
|
|
5644
|
+
*/
|
|
5645
|
+
export interface DisconnectedDeliveryPlatformDto {
|
|
5646
|
+
/**
|
|
5647
|
+
* The Munchi venue id (orderingBusinessId)
|
|
5648
|
+
* @type {number}
|
|
5649
|
+
* @memberof DisconnectedDeliveryPlatformDto
|
|
5650
|
+
*/
|
|
5651
|
+
'venueId': number;
|
|
5652
|
+
/**
|
|
5653
|
+
*
|
|
5654
|
+
* @type {DeliveryPlatformOpsConnect}
|
|
5655
|
+
* @memberof DisconnectedDeliveryPlatformDto
|
|
5656
|
+
*/
|
|
5657
|
+
'channel': DeliveryPlatformOpsConnect;
|
|
5658
|
+
/**
|
|
5659
|
+
* The store ids of the rows made inactive: one, unless rows were written by hand under several. Kept, so a connect with the same store id reactivates its row
|
|
5660
|
+
* @type {Array<string>}
|
|
5661
|
+
* @memberof DisconnectedDeliveryPlatformDto
|
|
5662
|
+
*/
|
|
5663
|
+
'externalIds': Array<string>;
|
|
5664
|
+
}
|
|
5426
5665
|
/**
|
|
5427
5666
|
*
|
|
5428
5667
|
* @export
|
|
@@ -5818,6 +6057,25 @@ export interface DisplayInitResponseDto {
|
|
|
5818
6057
|
*/
|
|
5819
6058
|
'ablyTokenRequest': object;
|
|
5820
6059
|
}
|
|
6060
|
+
/**
|
|
6061
|
+
*
|
|
6062
|
+
* @export
|
|
6063
|
+
* @interface EmployeeAssignmentDto
|
|
6064
|
+
*/
|
|
6065
|
+
export interface EmployeeAssignmentDto {
|
|
6066
|
+
/**
|
|
6067
|
+
* A venue the employee works at: its orderingBusinessId
|
|
6068
|
+
* @type {number}
|
|
6069
|
+
* @memberof EmployeeAssignmentDto
|
|
6070
|
+
*/
|
|
6071
|
+
'businessId': number;
|
|
6072
|
+
/**
|
|
6073
|
+
* The employee\'s role at that venue: one of that venue\'s roles
|
|
6074
|
+
* @type {string}
|
|
6075
|
+
* @memberof EmployeeAssignmentDto
|
|
6076
|
+
*/
|
|
6077
|
+
'roleId': string;
|
|
6078
|
+
}
|
|
5821
6079
|
/**
|
|
5822
6080
|
*
|
|
5823
6081
|
* @export
|
|
@@ -5831,6 +6089,105 @@ export interface EmployeeEventProcessedDto {
|
|
|
5831
6089
|
*/
|
|
5832
6090
|
'message': string;
|
|
5833
6091
|
}
|
|
6092
|
+
/**
|
|
6093
|
+
*
|
|
6094
|
+
* @export
|
|
6095
|
+
* @interface EmployeePageResponseDto
|
|
6096
|
+
*/
|
|
6097
|
+
export interface EmployeePageResponseDto {
|
|
6098
|
+
/**
|
|
6099
|
+
* The page\'s employees, ordered by name
|
|
6100
|
+
* @type {Array<EmployeeResponseDto>}
|
|
6101
|
+
* @memberof EmployeePageResponseDto
|
|
6102
|
+
*/
|
|
6103
|
+
'employees': Array<EmployeeResponseDto>;
|
|
6104
|
+
/**
|
|
6105
|
+
* The cursor of the next page; null on the last page
|
|
6106
|
+
* @type {string}
|
|
6107
|
+
* @memberof EmployeePageResponseDto
|
|
6108
|
+
*/
|
|
6109
|
+
'nextCursor': string | null;
|
|
6110
|
+
}
|
|
6111
|
+
/**
|
|
6112
|
+
*
|
|
6113
|
+
* @export
|
|
6114
|
+
* @interface EmployeeResponseDto
|
|
6115
|
+
*/
|
|
6116
|
+
export interface EmployeeResponseDto {
|
|
6117
|
+
/**
|
|
6118
|
+
* The employee\'s id
|
|
6119
|
+
* @type {string}
|
|
6120
|
+
* @memberof EmployeeResponseDto
|
|
6121
|
+
*/
|
|
6122
|
+
'id': string;
|
|
6123
|
+
/**
|
|
6124
|
+
* The employee\'s name, as the till shows it
|
|
6125
|
+
* @type {string}
|
|
6126
|
+
* @memberof EmployeeResponseDto
|
|
6127
|
+
*/
|
|
6128
|
+
'name': string;
|
|
6129
|
+
/**
|
|
6130
|
+
*
|
|
6131
|
+
* @type {Status}
|
|
6132
|
+
* @memberof EmployeeResponseDto
|
|
6133
|
+
*/
|
|
6134
|
+
'status': Status;
|
|
6135
|
+
/**
|
|
6136
|
+
* The employee\'s e-mail, in lower case; null only for an employee added before e-mails were required (D145)
|
|
6137
|
+
* @type {string}
|
|
6138
|
+
* @memberof EmployeeResponseDto
|
|
6139
|
+
*/
|
|
6140
|
+
'email': string | null;
|
|
6141
|
+
/**
|
|
6142
|
+
* The employee\'s phone; null when none
|
|
6143
|
+
* @type {string}
|
|
6144
|
+
* @memberof EmployeeResponseDto
|
|
6145
|
+
*/
|
|
6146
|
+
'phone': string | null;
|
|
6147
|
+
/**
|
|
6148
|
+
* The employee\'s photo; null when none
|
|
6149
|
+
* @type {string}
|
|
6150
|
+
* @memberof EmployeeResponseDto
|
|
6151
|
+
*/
|
|
6152
|
+
'photoUrl': string | null;
|
|
6153
|
+
/**
|
|
6154
|
+
* Every venue of the merchant the employee works at, with their role there, ordered by venue. Empty for an employee added at this venue and not yet given a role.
|
|
6155
|
+
* @type {Array<EmployeeAssignmentDto>}
|
|
6156
|
+
* @memberof EmployeeResponseDto
|
|
6157
|
+
*/
|
|
6158
|
+
'assignments': Array<EmployeeAssignmentDto>;
|
|
6159
|
+
}
|
|
6160
|
+
/**
|
|
6161
|
+
*
|
|
6162
|
+
* @export
|
|
6163
|
+
* @interface EmployeeRoleResponseDto
|
|
6164
|
+
*/
|
|
6165
|
+
export interface EmployeeRoleResponseDto {
|
|
6166
|
+
/**
|
|
6167
|
+
* The role\'s id
|
|
6168
|
+
* @type {string}
|
|
6169
|
+
* @memberof EmployeeRoleResponseDto
|
|
6170
|
+
*/
|
|
6171
|
+
'id': string;
|
|
6172
|
+
/**
|
|
6173
|
+
* The role\'s name, as the staff see it on the till
|
|
6174
|
+
* @type {string}
|
|
6175
|
+
* @memberof EmployeeRoleResponseDto
|
|
6176
|
+
*/
|
|
6177
|
+
'name': string;
|
|
6178
|
+
/**
|
|
6179
|
+
* The POS keys the role holds. A key stored by an older back office that the POS no longer knows is left out.
|
|
6180
|
+
* @type {Array<PosPermission>}
|
|
6181
|
+
* @memberof EmployeeRoleResponseDto
|
|
6182
|
+
*/
|
|
6183
|
+
'permissionKeys': Array<PosPermission>;
|
|
6184
|
+
/**
|
|
6185
|
+
* How many employees hold the role at the venue; a role is removed only when none does
|
|
6186
|
+
* @type {number}
|
|
6187
|
+
* @memberof EmployeeRoleResponseDto
|
|
6188
|
+
*/
|
|
6189
|
+
'employeeCount': number;
|
|
6190
|
+
}
|
|
5834
6191
|
/**
|
|
5835
6192
|
*
|
|
5836
6193
|
* @export
|
|
@@ -16946,6 +17303,19 @@ export interface PaymentSessionAnalyticsResponseDtoResolvedRange {
|
|
|
16946
17303
|
*/
|
|
16947
17304
|
'end': string;
|
|
16948
17305
|
}
|
|
17306
|
+
/**
|
|
17307
|
+
*
|
|
17308
|
+
* @export
|
|
17309
|
+
* @interface PaymentSessionCurrencyDto
|
|
17310
|
+
*/
|
|
17311
|
+
export interface PaymentSessionCurrencyDto {
|
|
17312
|
+
/**
|
|
17313
|
+
* The ISO 4217 code of the currency the payment session was taken in, as stored on the session (`PaymentSession.currency`)
|
|
17314
|
+
* @type {string}
|
|
17315
|
+
* @memberof PaymentSessionCurrencyDto
|
|
17316
|
+
*/
|
|
17317
|
+
'currency': string;
|
|
17318
|
+
}
|
|
16949
17319
|
/**
|
|
16950
17320
|
*
|
|
16951
17321
|
* @export
|
|
@@ -21599,6 +21969,7 @@ export declare const ProviderEnum: {
|
|
|
21599
21969
|
readonly WoltStorefront: "WoltStorefront";
|
|
21600
21970
|
readonly Storefront: "Storefront";
|
|
21601
21971
|
readonly MunchiPay: "MunchiPay";
|
|
21972
|
+
readonly ResQ: "ResQ";
|
|
21602
21973
|
};
|
|
21603
21974
|
export type ProviderEnum = typeof ProviderEnum[keyof typeof ProviderEnum];
|
|
21604
21975
|
/**
|
|
@@ -24891,6 +25262,19 @@ export interface SendReportEmailDto {
|
|
|
24891
25262
|
*/
|
|
24892
25263
|
'language'?: ReportLanguage;
|
|
24893
25264
|
}
|
|
25265
|
+
/**
|
|
25266
|
+
*
|
|
25267
|
+
* @export
|
|
25268
|
+
* @interface SetEmployeeRoleDto
|
|
25269
|
+
*/
|
|
25270
|
+
export interface SetEmployeeRoleDto {
|
|
25271
|
+
/**
|
|
25272
|
+
* The employee\'s role at the venue: one of the venue\'s roles. Replaces the role they had there.
|
|
25273
|
+
* @type {string}
|
|
25274
|
+
* @memberof SetEmployeeRoleDto
|
|
25275
|
+
*/
|
|
25276
|
+
'roleId': string;
|
|
25277
|
+
}
|
|
24894
25278
|
/**
|
|
24895
25279
|
*
|
|
24896
25280
|
* @export
|
|
@@ -31020,6 +31404,19 @@ export interface VendureSellerUpsertDto {
|
|
|
31020
31404
|
*/
|
|
31021
31405
|
'schedule'?: Array<object>;
|
|
31022
31406
|
}
|
|
31407
|
+
/**
|
|
31408
|
+
*
|
|
31409
|
+
* @export
|
|
31410
|
+
* @interface VenueCurrencyDto
|
|
31411
|
+
*/
|
|
31412
|
+
export interface VenueCurrencyDto {
|
|
31413
|
+
/**
|
|
31414
|
+
*
|
|
31415
|
+
* @type {CurrencyCode}
|
|
31416
|
+
* @memberof VenueCurrencyDto
|
|
31417
|
+
*/
|
|
31418
|
+
'currency': CurrencyCode;
|
|
31419
|
+
}
|
|
31023
31420
|
/**
|
|
31024
31421
|
*
|
|
31025
31422
|
* @export
|
|
@@ -34433,6 +34830,14 @@ export declare const BusinessApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
34433
34830
|
* @throws {RequiredError}
|
|
34434
34831
|
*/
|
|
34435
34832
|
getSingleBusinessProviderStatus: (businessId: string, provider: ProviderEnum, externalId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
34833
|
+
/**
|
|
34834
|
+
* The venue\'s own currency (Business.currency), kept in the venue\'s config hash and cleared by every writer of it, so an amount can be named in it before it is sent. A signed-in ticket and a partner key reach only their own venues. Never the shared key (R27).
|
|
34835
|
+
* @summary Get the currency the venue sells in
|
|
34836
|
+
* @param {number} businessId The venue\'s business id (orderingBusinessId)
|
|
34837
|
+
* @param {*} [options] Override http request option.
|
|
34838
|
+
* @throws {RequiredError}
|
|
34839
|
+
*/
|
|
34840
|
+
getVenueCurrency: (businessId: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
34436
34841
|
/**
|
|
34437
34842
|
* OFFLINE closes the channel for duration minutes and schedules its reopening (a Cloud Task); ONLINE opens it and drops the task. The channel\'s own service is told, except the storefront, whose schedule is snoozed or restored instead. Opening MunchiOnline opens MunchiKiosk too.
|
|
34438
34843
|
* @summary Open or close one of the venue\'s sales channels
|
|
@@ -34580,6 +34985,14 @@ export declare const BusinessApiFp: (configuration?: Configuration) => {
|
|
|
34580
34985
|
* @throws {RequiredError}
|
|
34581
34986
|
*/
|
|
34582
34987
|
getSingleBusinessProviderStatus(businessId: string, provider: ProviderEnum, externalId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SingleProviderStatusResponseDto>>;
|
|
34988
|
+
/**
|
|
34989
|
+
* The venue\'s own currency (Business.currency), kept in the venue\'s config hash and cleared by every writer of it, so an amount can be named in it before it is sent. A signed-in ticket and a partner key reach only their own venues. Never the shared key (R27).
|
|
34990
|
+
* @summary Get the currency the venue sells in
|
|
34991
|
+
* @param {number} businessId The venue\'s business id (orderingBusinessId)
|
|
34992
|
+
* @param {*} [options] Override http request option.
|
|
34993
|
+
* @throws {RequiredError}
|
|
34994
|
+
*/
|
|
34995
|
+
getVenueCurrency(businessId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueCurrencyDto>>;
|
|
34583
34996
|
/**
|
|
34584
34997
|
* OFFLINE closes the channel for duration minutes and schedules its reopening (a Cloud Task); ONLINE opens it and drops the task. The channel\'s own service is told, except the storefront, whose schedule is snoozed or restored instead. Opening MunchiOnline opens MunchiKiosk too.
|
|
34585
34998
|
* @summary Open or close one of the venue\'s sales channels
|
|
@@ -34727,6 +35140,14 @@ export declare const BusinessApiFactory: (configuration?: Configuration, basePat
|
|
|
34727
35140
|
* @throws {RequiredError}
|
|
34728
35141
|
*/
|
|
34729
35142
|
getSingleBusinessProviderStatus(businessId: string, provider: ProviderEnum, externalId: string, options?: any): AxiosPromise<SingleProviderStatusResponseDto>;
|
|
35143
|
+
/**
|
|
35144
|
+
* The venue\'s own currency (Business.currency), kept in the venue\'s config hash and cleared by every writer of it, so an amount can be named in it before it is sent. A signed-in ticket and a partner key reach only their own venues. Never the shared key (R27).
|
|
35145
|
+
* @summary Get the currency the venue sells in
|
|
35146
|
+
* @param {number} businessId The venue\'s business id (orderingBusinessId)
|
|
35147
|
+
* @param {*} [options] Override http request option.
|
|
35148
|
+
* @throws {RequiredError}
|
|
35149
|
+
*/
|
|
35150
|
+
getVenueCurrency(businessId: number, options?: any): AxiosPromise<VenueCurrencyDto>;
|
|
34730
35151
|
/**
|
|
34731
35152
|
* OFFLINE closes the channel for duration minutes and schedules its reopening (a Cloud Task); ONLINE opens it and drops the task. The channel\'s own service is told, except the storefront, whose schedule is snoozed or restored instead. Opening MunchiOnline opens MunchiKiosk too.
|
|
34732
35153
|
* @summary Open or close one of the venue\'s sales channels
|
|
@@ -34889,6 +35310,15 @@ export interface BusinessApiInterface {
|
|
|
34889
35310
|
* @memberof BusinessApiInterface
|
|
34890
35311
|
*/
|
|
34891
35312
|
getSingleBusinessProviderStatus(businessId: string, provider: ProviderEnum, externalId: string, options?: AxiosRequestConfig): AxiosPromise<SingleProviderStatusResponseDto>;
|
|
35313
|
+
/**
|
|
35314
|
+
* The venue\'s own currency (Business.currency), kept in the venue\'s config hash and cleared by every writer of it, so an amount can be named in it before it is sent. A signed-in ticket and a partner key reach only their own venues. Never the shared key (R27).
|
|
35315
|
+
* @summary Get the currency the venue sells in
|
|
35316
|
+
* @param {number} businessId The venue\'s business id (orderingBusinessId)
|
|
35317
|
+
* @param {*} [options] Override http request option.
|
|
35318
|
+
* @throws {RequiredError}
|
|
35319
|
+
* @memberof BusinessApiInterface
|
|
35320
|
+
*/
|
|
35321
|
+
getVenueCurrency(businessId: number, options?: AxiosRequestConfig): AxiosPromise<VenueCurrencyDto>;
|
|
34892
35322
|
/**
|
|
34893
35323
|
* OFFLINE closes the channel for duration minutes and schedules its reopening (a Cloud Task); ONLINE opens it and drops the task. The channel\'s own service is told, except the storefront, whose schedule is snoozed or restored instead. Opening MunchiOnline opens MunchiKiosk too.
|
|
34894
35324
|
* @summary Open or close one of the venue\'s sales channels
|
|
@@ -35054,6 +35484,15 @@ export declare class BusinessApi extends BaseAPI implements BusinessApiInterface
|
|
|
35054
35484
|
* @memberof BusinessApi
|
|
35055
35485
|
*/
|
|
35056
35486
|
getSingleBusinessProviderStatus(businessId: string, provider: ProviderEnum, externalId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SingleProviderStatusResponseDto, any, {}>>;
|
|
35487
|
+
/**
|
|
35488
|
+
* The venue\'s own currency (Business.currency), kept in the venue\'s config hash and cleared by every writer of it, so an amount can be named in it before it is sent. A signed-in ticket and a partner key reach only their own venues. Never the shared key (R27).
|
|
35489
|
+
* @summary Get the currency the venue sells in
|
|
35490
|
+
* @param {number} businessId The venue\'s business id (orderingBusinessId)
|
|
35491
|
+
* @param {*} [options] Override http request option.
|
|
35492
|
+
* @throws {RequiredError}
|
|
35493
|
+
* @memberof BusinessApi
|
|
35494
|
+
*/
|
|
35495
|
+
getVenueCurrency(businessId: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VenueCurrencyDto, any, {}>>;
|
|
35057
35496
|
/**
|
|
35058
35497
|
* OFFLINE closes the channel for duration minutes and schedules its reopening (a Cloud Task); ONLINE opens it and drops the task. The channel\'s own service is told, except the storefront, whose schedule is snoozed or restored instead. Opening MunchiOnline opens MunchiKiosk too.
|
|
35059
35498
|
* @summary Open or close one of the venue\'s sales channels
|
|
@@ -35215,11 +35654,11 @@ export declare const CashManagementApiAxiosParamCreator: (configuration?: Config
|
|
|
35215
35654
|
* @param {string} businessId The venue\'s id (its orderingBusinessId), as text
|
|
35216
35655
|
* @param {string} sessionId The cash session\'s id
|
|
35217
35656
|
* @param {SendCashReportDto} sendCashReportDto
|
|
35218
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} [xAppX] The app sending the request, one of ProviderEnum. The route answers 400 without it and 401 for any other value.
|
|
35657
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} [xAppX] The app sending the request, one of ProviderEnum. The route answers 400 without it and 401 for any other value.
|
|
35219
35658
|
* @param {*} [options] Override http request option.
|
|
35220
35659
|
* @throws {RequiredError}
|
|
35221
35660
|
*/
|
|
35222
|
-
sendSessionReport: (businessId: string, sessionId: string, sendCashReportDto: SendCashReportDto, xAppX?: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay", options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
35661
|
+
sendSessionReport: (businessId: string, sessionId: string, sendCashReportDto: SendCashReportDto, xAppX?: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
35223
35662
|
};
|
|
35224
35663
|
/**
|
|
35225
35664
|
* CashManagementApi - functional programming interface
|
|
@@ -35281,11 +35720,11 @@ export declare const CashManagementApiFp: (configuration?: Configuration) => {
|
|
|
35281
35720
|
* @param {string} businessId The venue\'s id (its orderingBusinessId), as text
|
|
35282
35721
|
* @param {string} sessionId The cash session\'s id
|
|
35283
35722
|
* @param {SendCashReportDto} sendCashReportDto
|
|
35284
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} [xAppX] The app sending the request, one of ProviderEnum. The route answers 400 without it and 401 for any other value.
|
|
35723
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} [xAppX] The app sending the request, one of ProviderEnum. The route answers 400 without it and 401 for any other value.
|
|
35285
35724
|
* @param {*} [options] Override http request option.
|
|
35286
35725
|
* @throws {RequiredError}
|
|
35287
35726
|
*/
|
|
35288
|
-
sendSessionReport(businessId: string, sessionId: string, sendCashReportDto: SendCashReportDto, xAppX?: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay", options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CashReportSentDto>>;
|
|
35727
|
+
sendSessionReport(businessId: string, sessionId: string, sendCashReportDto: SendCashReportDto, xAppX?: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CashReportSentDto>>;
|
|
35289
35728
|
};
|
|
35290
35729
|
/**
|
|
35291
35730
|
* CashManagementApi - factory interface
|
|
@@ -35347,11 +35786,11 @@ export declare const CashManagementApiFactory: (configuration?: Configuration, b
|
|
|
35347
35786
|
* @param {string} businessId The venue\'s id (its orderingBusinessId), as text
|
|
35348
35787
|
* @param {string} sessionId The cash session\'s id
|
|
35349
35788
|
* @param {SendCashReportDto} sendCashReportDto
|
|
35350
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} [xAppX] The app sending the request, one of ProviderEnum. The route answers 400 without it and 401 for any other value.
|
|
35789
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} [xAppX] The app sending the request, one of ProviderEnum. The route answers 400 without it and 401 for any other value.
|
|
35351
35790
|
* @param {*} [options] Override http request option.
|
|
35352
35791
|
* @throws {RequiredError}
|
|
35353
35792
|
*/
|
|
35354
|
-
sendSessionReport(businessId: string, sessionId: string, sendCashReportDto: SendCashReportDto, xAppX?: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay", options?: any): AxiosPromise<CashReportSentDto>;
|
|
35793
|
+
sendSessionReport(businessId: string, sessionId: string, sendCashReportDto: SendCashReportDto, xAppX?: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", options?: any): AxiosPromise<CashReportSentDto>;
|
|
35355
35794
|
};
|
|
35356
35795
|
/**
|
|
35357
35796
|
* CashManagementApi - interface
|
|
@@ -35419,12 +35858,12 @@ export interface CashManagementApiInterface {
|
|
|
35419
35858
|
* @param {string} businessId The venue\'s id (its orderingBusinessId), as text
|
|
35420
35859
|
* @param {string} sessionId The cash session\'s id
|
|
35421
35860
|
* @param {SendCashReportDto} sendCashReportDto
|
|
35422
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} [xAppX] The app sending the request, one of ProviderEnum. The route answers 400 without it and 401 for any other value.
|
|
35861
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} [xAppX] The app sending the request, one of ProviderEnum. The route answers 400 without it and 401 for any other value.
|
|
35423
35862
|
* @param {*} [options] Override http request option.
|
|
35424
35863
|
* @throws {RequiredError}
|
|
35425
35864
|
* @memberof CashManagementApiInterface
|
|
35426
35865
|
*/
|
|
35427
|
-
sendSessionReport(businessId: string, sessionId: string, sendCashReportDto: SendCashReportDto, xAppX?: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', options?: AxiosRequestConfig): AxiosPromise<CashReportSentDto>;
|
|
35866
|
+
sendSessionReport(businessId: string, sessionId: string, sendCashReportDto: SendCashReportDto, xAppX?: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', options?: AxiosRequestConfig): AxiosPromise<CashReportSentDto>;
|
|
35428
35867
|
}
|
|
35429
35868
|
/**
|
|
35430
35869
|
* CashManagementApi - object-oriented interface
|
|
@@ -35493,12 +35932,12 @@ export declare class CashManagementApi extends BaseAPI implements CashManagement
|
|
|
35493
35932
|
* @param {string} businessId The venue\'s id (its orderingBusinessId), as text
|
|
35494
35933
|
* @param {string} sessionId The cash session\'s id
|
|
35495
35934
|
* @param {SendCashReportDto} sendCashReportDto
|
|
35496
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} [xAppX] The app sending the request, one of ProviderEnum. The route answers 400 without it and 401 for any other value.
|
|
35935
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} [xAppX] The app sending the request, one of ProviderEnum. The route answers 400 without it and 401 for any other value.
|
|
35497
35936
|
* @param {*} [options] Override http request option.
|
|
35498
35937
|
* @throws {RequiredError}
|
|
35499
35938
|
* @memberof CashManagementApi
|
|
35500
35939
|
*/
|
|
35501
|
-
sendSessionReport(businessId: string, sessionId: string, sendCashReportDto: SendCashReportDto, xAppX?: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CashReportSentDto, any, {}>>;
|
|
35940
|
+
sendSessionReport(businessId: string, sessionId: string, sendCashReportDto: SendCashReportDto, xAppX?: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CashReportSentDto, any, {}>>;
|
|
35502
35941
|
}
|
|
35503
35942
|
/**
|
|
35504
35943
|
* CashManagementV6Api - axios parameter creator
|
|
@@ -35878,21 +36317,21 @@ export declare const ConfigManagementApiAxiosParamCreator: (configuration?: Conf
|
|
|
35878
36317
|
* The till\'s Settings screen calls it. Creates the channel\'s config first if it has none. Turning it on also enables the MunchiGiftCard payment option.
|
|
35879
36318
|
* @summary Enable or disable first-party Munchi GiftCard integration
|
|
35880
36319
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
35881
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
36320
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
35882
36321
|
* @param {ConfigureMunchiGiftCardDto} configureMunchiGiftCardDto
|
|
35883
36322
|
* @param {*} [options] Override http request option.
|
|
35884
36323
|
* @throws {RequiredError}
|
|
35885
36324
|
*/
|
|
35886
|
-
configConfigureMunchiGiftCard: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay", configureMunchiGiftCardDto: ConfigureMunchiGiftCardDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
36325
|
+
configConfigureMunchiGiftCard: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", configureMunchiGiftCardDto: ConfigureMunchiGiftCardDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
35887
36326
|
/**
|
|
35888
36327
|
* The selected provider and each provider\'s settings. A secret key or client secret is answered null: it never leaves the server. The route does not check the venue itself; the global access check reads it from the path (R30).
|
|
35889
36328
|
* @summary Read a channel\'s card payment providers
|
|
35890
36329
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
35891
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
36330
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
35892
36331
|
* @param {*} [options] Override http request option.
|
|
35893
36332
|
* @throws {RequiredError}
|
|
35894
36333
|
*/
|
|
35895
|
-
configGetProviders: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay", options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
36334
|
+
configGetProviders: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
35896
36335
|
/**
|
|
35897
36336
|
* Clears the venue\'s cache entry of each key sent and tells the apps to fetch them again: every app of the venue, or one app channel when isGlobal is false.
|
|
35898
36337
|
* @summary Manual sync trigger
|
|
@@ -35907,22 +36346,22 @@ export declare const ConfigManagementApiAxiosParamCreator: (configuration?: Conf
|
|
|
35907
36346
|
* @summary Remove payment option
|
|
35908
36347
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
35909
36348
|
* @param {string} id The payment option\'s id
|
|
35910
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
36349
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
35911
36350
|
* @param {*} [options] Override http request option.
|
|
35912
36351
|
* @throws {RequiredError}
|
|
35913
36352
|
*/
|
|
35914
|
-
configRemovePaymentOption: (businessId: number, id: string, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay", options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
36353
|
+
configRemovePaymentOption: (businessId: number, id: string, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
35915
36354
|
/**
|
|
35916
36355
|
* 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.
|
|
35917
36356
|
* @summary Save a channel\'s Epassi credentials and answer the public key to send Epassi
|
|
35918
36357
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
35919
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
36358
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
35920
36359
|
* @param {string} xEpassiAccessKey The access key Epassi issued for this venue; Epassi issues a different one for test and production.
|
|
35921
36360
|
* @param {SaveEpassiCredentialsDto} saveEpassiCredentialsDto
|
|
35922
36361
|
* @param {*} [options] Override http request option.
|
|
35923
36362
|
* @throws {RequiredError}
|
|
35924
36363
|
*/
|
|
35925
|
-
configSaveEpassiCredentials: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay", xEpassiAccessKey: string, saveEpassiCredentialsDto: SaveEpassiCredentialsDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
36364
|
+
configSaveEpassiCredentials: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", xEpassiAccessKey: string, saveEpassiCredentialsDto: SaveEpassiCredentialsDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
35926
36365
|
/**
|
|
35927
36366
|
* A new venue is saved enabled, named `Business <businessId>`, in Europe/Helsinki unless the body says otherwise, and the license server is asked for its license. The fields below are written as sent; any other field is dropped and its name logged.
|
|
35928
36367
|
* @summary Create or update a venue
|
|
@@ -35936,22 +36375,22 @@ export declare const ConfigManagementApiAxiosParamCreator: (configuration?: Conf
|
|
|
35936
36375
|
* A new config is saved in Europe/Helsinki unless the body says otherwise. The fields below are written as sent; any other field is dropped and its name logged. A venue with no merchant switched to Team or PIN lock gets its own merchant, named after it, in the same transaction. The venue\'s cached config and POS session are cleared.
|
|
35937
36376
|
* @summary Create or update a channel\'s config
|
|
35938
36377
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
35939
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
36378
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
35940
36379
|
* @param {UpsertConfigDto} upsertConfigDto
|
|
35941
36380
|
* @param {*} [options] Override http request option.
|
|
35942
36381
|
* @throws {RequiredError}
|
|
35943
36382
|
*/
|
|
35944
|
-
configUpsertChannelConfig: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay", upsertConfigDto: UpsertConfigDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
36383
|
+
configUpsertChannelConfig: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertConfigDto: UpsertConfigDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
35945
36384
|
/**
|
|
35946
36385
|
* Creates the channel\'s config first if it has none. Links and credentials are merged over the stored ones; the GiftCard payment option is created after the last option, or switched with the integration.
|
|
35947
36386
|
* @summary Create or update a channel\'s third-party gift card integration
|
|
35948
36387
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
35949
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
36388
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
35950
36389
|
* @param {UpsertGiftCardDto} upsertGiftCardDto
|
|
35951
36390
|
* @param {*} [options] Override http request option.
|
|
35952
36391
|
* @throws {RequiredError}
|
|
35953
36392
|
*/
|
|
35954
|
-
configUpsertGiftCard: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay", upsertGiftCardDto: UpsertGiftCardDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
36393
|
+
configUpsertGiftCard: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertGiftCardDto: UpsertGiftCardDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
35955
36394
|
/**
|
|
35956
36395
|
* The secret is stored encrypted and never answered: secretKey is null in the answer. A new program needs name, apiBaseUrl and secretKey; apiBaseUrl must be https on the Munchi loyalty server\'s host. A signed-in ticket may write only a programme that serves no venue off its account; the programme and the venue\'s link are written together. The venue\'s cached config and loyalty settings are cleared.
|
|
35957
36396
|
* @summary Create or update a loyalty program and link it to a venue
|
|
@@ -35965,52 +36404,52 @@ export declare const ConfigManagementApiAxiosParamCreator: (configuration?: Conf
|
|
|
35965
36404
|
* Creates the channel\'s config first if it has none. Saved active unless isActive is sent. The cached Nets config and token are cleared.
|
|
35966
36405
|
* @summary Create or update a channel\'s Nets config
|
|
35967
36406
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
35968
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
36407
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
35969
36408
|
* @param {UpsertNetsDto} upsertNetsDto
|
|
35970
36409
|
* @param {*} [options] Override http request option.
|
|
35971
36410
|
* @throws {RequiredError}
|
|
35972
36411
|
*/
|
|
35973
|
-
configUpsertNets: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay", upsertNetsDto: UpsertNetsDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
36412
|
+
configUpsertNets: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertNetsDto: UpsertNetsDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
35974
36413
|
/**
|
|
35975
36414
|
* 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.
|
|
35976
36415
|
* @summary Create or update a channel\'s checkout payment options
|
|
35977
36416
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
35978
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
36417
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
35979
36418
|
* @param {UpsertPaymentOptionsDto} upsertPaymentOptionsDto
|
|
35980
36419
|
* @param {*} [options] Override http request option.
|
|
35981
36420
|
* @throws {RequiredError}
|
|
35982
36421
|
*/
|
|
35983
|
-
configUpsertPaymentOptions: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay", upsertPaymentOptionsDto: UpsertPaymentOptionsDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
36422
|
+
configUpsertPaymentOptions: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertPaymentOptionsDto: UpsertPaymentOptionsDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
35984
36423
|
/**
|
|
35985
36424
|
* Saves the chosen provider\'s own fields (Viva as the Viva route would, Nets and Stripe as their routes would; Worldline, which has no route of its own, the same way as Nets and Stripe), then selects it on the channel as the channel config route would, and answers the providers as read afterwards. The two saves are not one transaction.
|
|
35986
36425
|
* @summary Set active provider and upsert its credentials
|
|
35987
36426
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
35988
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
36427
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
35989
36428
|
* @param {UpsertProvidersDto} upsertProvidersDto
|
|
35990
36429
|
* @param {*} [options] Override http request option.
|
|
35991
36430
|
* @throws {RequiredError}
|
|
35992
36431
|
*/
|
|
35993
|
-
configUpsertProviders: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay", upsertProvidersDto: UpsertProvidersDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
36432
|
+
configUpsertProviders: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertProvidersDto: UpsertProvidersDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
35994
36433
|
/**
|
|
35995
36434
|
* Creates the channel\'s config first if it has none. Saved active unless isActive is sent. The cached Stripe config is cleared.
|
|
35996
36435
|
* @summary Create or update a channel\'s Stripe config
|
|
35997
36436
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
35998
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
36437
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
35999
36438
|
* @param {UpsertStripeDto} upsertStripeDto
|
|
36000
36439
|
* @param {*} [options] Override http request option.
|
|
36001
36440
|
* @throws {RequiredError}
|
|
36002
36441
|
*/
|
|
36003
|
-
configUpsertStripe: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay", upsertStripeDto: UpsertStripeDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
36442
|
+
configUpsertStripe: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertStripeDto: UpsertStripeDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
36004
36443
|
/**
|
|
36005
36444
|
* 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; a changed rate or additionalAmount is saved on the license server first.
|
|
36006
36445
|
* @summary Create or update a channel\'s Viva config
|
|
36007
36446
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
36008
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
36447
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
36009
36448
|
* @param {UpsertVivaDto} upsertVivaDto
|
|
36010
36449
|
* @param {*} [options] Override http request option.
|
|
36011
36450
|
* @throws {RequiredError}
|
|
36012
36451
|
*/
|
|
36013
|
-
configUpsertViva: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay", upsertVivaDto: UpsertVivaDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
36452
|
+
configUpsertViva: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertVivaDto: UpsertVivaDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
36014
36453
|
};
|
|
36015
36454
|
/**
|
|
36016
36455
|
* ConfigManagementApi - functional programming interface
|
|
@@ -36021,21 +36460,21 @@ export declare const ConfigManagementApiFp: (configuration?: Configuration) => {
|
|
|
36021
36460
|
* The till\'s Settings screen calls it. Creates the channel\'s config first if it has none. Turning it on also enables the MunchiGiftCard payment option.
|
|
36022
36461
|
* @summary Enable or disable first-party Munchi GiftCard integration
|
|
36023
36462
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
36024
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
36463
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
36025
36464
|
* @param {ConfigureMunchiGiftCardDto} configureMunchiGiftCardDto
|
|
36026
36465
|
* @param {*} [options] Override http request option.
|
|
36027
36466
|
* @throws {RequiredError}
|
|
36028
36467
|
*/
|
|
36029
|
-
configConfigureMunchiGiftCard(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay", configureMunchiGiftCardDto: ConfigureMunchiGiftCardDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfigManagementResponseDto>>;
|
|
36468
|
+
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>>;
|
|
36030
36469
|
/**
|
|
36031
36470
|
* The selected provider and each provider\'s settings. A secret key or client secret is answered null: it never leaves the server. The route does not check the venue itself; the global access check reads it from the path (R30).
|
|
36032
36471
|
* @summary Read a channel\'s card payment providers
|
|
36033
36472
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
36034
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
36473
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
36035
36474
|
* @param {*} [options] Override http request option.
|
|
36036
36475
|
* @throws {RequiredError}
|
|
36037
36476
|
*/
|
|
36038
|
-
configGetProviders(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay", options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProvidersConfigResponseDto>>;
|
|
36477
|
+
configGetProviders(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProvidersConfigResponseDto>>;
|
|
36039
36478
|
/**
|
|
36040
36479
|
* Clears the venue\'s cache entry of each key sent and tells the apps to fetch them again: every app of the venue, or one app channel when isGlobal is false.
|
|
36041
36480
|
* @summary Manual sync trigger
|
|
@@ -36050,22 +36489,22 @@ export declare const ConfigManagementApiFp: (configuration?: Configuration) => {
|
|
|
36050
36489
|
* @summary Remove payment option
|
|
36051
36490
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
36052
36491
|
* @param {string} id The payment option\'s id
|
|
36053
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
36492
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
36054
36493
|
* @param {*} [options] Override http request option.
|
|
36055
36494
|
* @throws {RequiredError}
|
|
36056
36495
|
*/
|
|
36057
|
-
configRemovePaymentOption(businessId: number, id: string, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay", options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfigManagementResponseDto>>;
|
|
36496
|
+
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>>;
|
|
36058
36497
|
/**
|
|
36059
36498
|
* 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.
|
|
36060
36499
|
* @summary Save a channel\'s Epassi credentials and answer the public key to send Epassi
|
|
36061
36500
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
36062
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
36501
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
36063
36502
|
* @param {string} xEpassiAccessKey The access key Epassi issued for this venue; Epassi issues a different one for test and production.
|
|
36064
36503
|
* @param {SaveEpassiCredentialsDto} saveEpassiCredentialsDto
|
|
36065
36504
|
* @param {*} [options] Override http request option.
|
|
36066
36505
|
* @throws {RequiredError}
|
|
36067
36506
|
*/
|
|
36068
|
-
configSaveEpassiCredentials(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay", xEpassiAccessKey: string, saveEpassiCredentialsDto: SaveEpassiCredentialsDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EpassiCredentialsSavedDto>>;
|
|
36507
|
+
configSaveEpassiCredentials(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", xEpassiAccessKey: string, saveEpassiCredentialsDto: SaveEpassiCredentialsDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EpassiCredentialsSavedDto>>;
|
|
36069
36508
|
/**
|
|
36070
36509
|
* A new venue is saved enabled, named `Business <businessId>`, in Europe/Helsinki unless the body says otherwise, and the license server is asked for its license. The fields below are written as sent; any other field is dropped and its name logged.
|
|
36071
36510
|
* @summary Create or update a venue
|
|
@@ -36079,22 +36518,22 @@ export declare const ConfigManagementApiFp: (configuration?: Configuration) => {
|
|
|
36079
36518
|
* A new config is saved in Europe/Helsinki unless the body says otherwise. The fields below are written as sent; any other field is dropped and its name logged. A venue with no merchant switched to Team or PIN lock gets its own merchant, named after it, in the same transaction. The venue\'s cached config and POS session are cleared.
|
|
36080
36519
|
* @summary Create or update a channel\'s config
|
|
36081
36520
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
36082
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
36521
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
36083
36522
|
* @param {UpsertConfigDto} upsertConfigDto
|
|
36084
36523
|
* @param {*} [options] Override http request option.
|
|
36085
36524
|
* @throws {RequiredError}
|
|
36086
36525
|
*/
|
|
36087
|
-
configUpsertChannelConfig(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay", upsertConfigDto: UpsertConfigDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfigManagementResponseDto>>;
|
|
36526
|
+
configUpsertChannelConfig(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertConfigDto: UpsertConfigDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfigManagementResponseDto>>;
|
|
36088
36527
|
/**
|
|
36089
36528
|
* Creates the channel\'s config first if it has none. Links and credentials are merged over the stored ones; the GiftCard payment option is created after the last option, or switched with the integration.
|
|
36090
36529
|
* @summary Create or update a channel\'s third-party gift card integration
|
|
36091
36530
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
36092
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
36531
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
36093
36532
|
* @param {UpsertGiftCardDto} upsertGiftCardDto
|
|
36094
36533
|
* @param {*} [options] Override http request option.
|
|
36095
36534
|
* @throws {RequiredError}
|
|
36096
36535
|
*/
|
|
36097
|
-
configUpsertGiftCard(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay", upsertGiftCardDto: UpsertGiftCardDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfigManagementResponseDto>>;
|
|
36536
|
+
configUpsertGiftCard(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertGiftCardDto: UpsertGiftCardDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfigManagementResponseDto>>;
|
|
36098
36537
|
/**
|
|
36099
36538
|
* The secret is stored encrypted and never answered: secretKey is null in the answer. A new program needs name, apiBaseUrl and secretKey; apiBaseUrl must be https on the Munchi loyalty server\'s host. A signed-in ticket may write only a programme that serves no venue off its account; the programme and the venue\'s link are written together. The venue\'s cached config and loyalty settings are cleared.
|
|
36100
36539
|
* @summary Create or update a loyalty program and link it to a venue
|
|
@@ -36108,52 +36547,52 @@ export declare const ConfigManagementApiFp: (configuration?: Configuration) => {
|
|
|
36108
36547
|
* Creates the channel\'s config first if it has none. Saved active unless isActive is sent. The cached Nets config and token are cleared.
|
|
36109
36548
|
* @summary Create or update a channel\'s Nets config
|
|
36110
36549
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
36111
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
36550
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
36112
36551
|
* @param {UpsertNetsDto} upsertNetsDto
|
|
36113
36552
|
* @param {*} [options] Override http request option.
|
|
36114
36553
|
* @throws {RequiredError}
|
|
36115
36554
|
*/
|
|
36116
|
-
configUpsertNets(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay", upsertNetsDto: UpsertNetsDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfigManagementResponseDto>>;
|
|
36555
|
+
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>>;
|
|
36117
36556
|
/**
|
|
36118
36557
|
* 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.
|
|
36119
36558
|
* @summary Create or update a channel\'s checkout payment options
|
|
36120
36559
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
36121
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
36560
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
36122
36561
|
* @param {UpsertPaymentOptionsDto} upsertPaymentOptionsDto
|
|
36123
36562
|
* @param {*} [options] Override http request option.
|
|
36124
36563
|
* @throws {RequiredError}
|
|
36125
36564
|
*/
|
|
36126
|
-
configUpsertPaymentOptions(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay", upsertPaymentOptionsDto: UpsertPaymentOptionsDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfigManagementResponseDto>>;
|
|
36565
|
+
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>>;
|
|
36127
36566
|
/**
|
|
36128
36567
|
* Saves the chosen provider\'s own fields (Viva as the Viva route would, Nets and Stripe as their routes would; Worldline, which has no route of its own, the same way as Nets and Stripe), then selects it on the channel as the channel config route would, and answers the providers as read afterwards. The two saves are not one transaction.
|
|
36129
36568
|
* @summary Set active provider and upsert its credentials
|
|
36130
36569
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
36131
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
36570
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
36132
36571
|
* @param {UpsertProvidersDto} upsertProvidersDto
|
|
36133
36572
|
* @param {*} [options] Override http request option.
|
|
36134
36573
|
* @throws {RequiredError}
|
|
36135
36574
|
*/
|
|
36136
|
-
configUpsertProviders(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay", upsertProvidersDto: UpsertProvidersDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProvidersConfigResponseDto>>;
|
|
36575
|
+
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>>;
|
|
36137
36576
|
/**
|
|
36138
36577
|
* Creates the channel\'s config first if it has none. Saved active unless isActive is sent. The cached Stripe config is cleared.
|
|
36139
36578
|
* @summary Create or update a channel\'s Stripe config
|
|
36140
36579
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
36141
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
36580
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
36142
36581
|
* @param {UpsertStripeDto} upsertStripeDto
|
|
36143
36582
|
* @param {*} [options] Override http request option.
|
|
36144
36583
|
* @throws {RequiredError}
|
|
36145
36584
|
*/
|
|
36146
|
-
configUpsertStripe(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay", upsertStripeDto: UpsertStripeDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfigManagementResponseDto>>;
|
|
36585
|
+
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>>;
|
|
36147
36586
|
/**
|
|
36148
36587
|
* 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; a changed rate or additionalAmount is saved on the license server first.
|
|
36149
36588
|
* @summary Create or update a channel\'s Viva config
|
|
36150
36589
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
36151
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
36590
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
36152
36591
|
* @param {UpsertVivaDto} upsertVivaDto
|
|
36153
36592
|
* @param {*} [options] Override http request option.
|
|
36154
36593
|
* @throws {RequiredError}
|
|
36155
36594
|
*/
|
|
36156
|
-
configUpsertViva(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay", upsertVivaDto: UpsertVivaDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfigManagementResponseDto>>;
|
|
36595
|
+
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>>;
|
|
36157
36596
|
};
|
|
36158
36597
|
/**
|
|
36159
36598
|
* ConfigManagementApi - factory interface
|
|
@@ -36164,21 +36603,21 @@ export declare const ConfigManagementApiFactory: (configuration?: Configuration,
|
|
|
36164
36603
|
* The till\'s Settings screen calls it. Creates the channel\'s config first if it has none. Turning it on also enables the MunchiGiftCard payment option.
|
|
36165
36604
|
* @summary Enable or disable first-party Munchi GiftCard integration
|
|
36166
36605
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
36167
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
36606
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
36168
36607
|
* @param {ConfigureMunchiGiftCardDto} configureMunchiGiftCardDto
|
|
36169
36608
|
* @param {*} [options] Override http request option.
|
|
36170
36609
|
* @throws {RequiredError}
|
|
36171
36610
|
*/
|
|
36172
|
-
configConfigureMunchiGiftCard(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay", configureMunchiGiftCardDto: ConfigureMunchiGiftCardDto, options?: any): AxiosPromise<ConfigManagementResponseDto>;
|
|
36611
|
+
configConfigureMunchiGiftCard(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", configureMunchiGiftCardDto: ConfigureMunchiGiftCardDto, options?: any): AxiosPromise<ConfigManagementResponseDto>;
|
|
36173
36612
|
/**
|
|
36174
36613
|
* The selected provider and each provider\'s settings. A secret key or client secret is answered null: it never leaves the server. The route does not check the venue itself; the global access check reads it from the path (R30).
|
|
36175
36614
|
* @summary Read a channel\'s card payment providers
|
|
36176
36615
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
36177
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
36616
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
36178
36617
|
* @param {*} [options] Override http request option.
|
|
36179
36618
|
* @throws {RequiredError}
|
|
36180
36619
|
*/
|
|
36181
|
-
configGetProviders(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay", options?: any): AxiosPromise<ProvidersConfigResponseDto>;
|
|
36620
|
+
configGetProviders(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", options?: any): AxiosPromise<ProvidersConfigResponseDto>;
|
|
36182
36621
|
/**
|
|
36183
36622
|
* Clears the venue\'s cache entry of each key sent and tells the apps to fetch them again: every app of the venue, or one app channel when isGlobal is false.
|
|
36184
36623
|
* @summary Manual sync trigger
|
|
@@ -36193,22 +36632,22 @@ export declare const ConfigManagementApiFactory: (configuration?: Configuration,
|
|
|
36193
36632
|
* @summary Remove payment option
|
|
36194
36633
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
36195
36634
|
* @param {string} id The payment option\'s id
|
|
36196
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
36635
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
36197
36636
|
* @param {*} [options] Override http request option.
|
|
36198
36637
|
* @throws {RequiredError}
|
|
36199
36638
|
*/
|
|
36200
|
-
configRemovePaymentOption(businessId: number, id: string, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay", options?: any): AxiosPromise<ConfigManagementResponseDto>;
|
|
36639
|
+
configRemovePaymentOption(businessId: number, id: string, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", options?: any): AxiosPromise<ConfigManagementResponseDto>;
|
|
36201
36640
|
/**
|
|
36202
36641
|
* 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.
|
|
36203
36642
|
* @summary Save a channel\'s Epassi credentials and answer the public key to send Epassi
|
|
36204
36643
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
36205
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
36644
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
36206
36645
|
* @param {string} xEpassiAccessKey The access key Epassi issued for this venue; Epassi issues a different one for test and production.
|
|
36207
36646
|
* @param {SaveEpassiCredentialsDto} saveEpassiCredentialsDto
|
|
36208
36647
|
* @param {*} [options] Override http request option.
|
|
36209
36648
|
* @throws {RequiredError}
|
|
36210
36649
|
*/
|
|
36211
|
-
configSaveEpassiCredentials(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay", xEpassiAccessKey: string, saveEpassiCredentialsDto: SaveEpassiCredentialsDto, options?: any): AxiosPromise<EpassiCredentialsSavedDto>;
|
|
36650
|
+
configSaveEpassiCredentials(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", xEpassiAccessKey: string, saveEpassiCredentialsDto: SaveEpassiCredentialsDto, options?: any): AxiosPromise<EpassiCredentialsSavedDto>;
|
|
36212
36651
|
/**
|
|
36213
36652
|
* A new venue is saved enabled, named `Business <businessId>`, in Europe/Helsinki unless the body says otherwise, and the license server is asked for its license. The fields below are written as sent; any other field is dropped and its name logged.
|
|
36214
36653
|
* @summary Create or update a venue
|
|
@@ -36222,22 +36661,22 @@ export declare const ConfigManagementApiFactory: (configuration?: Configuration,
|
|
|
36222
36661
|
* A new config is saved in Europe/Helsinki unless the body says otherwise. The fields below are written as sent; any other field is dropped and its name logged. A venue with no merchant switched to Team or PIN lock gets its own merchant, named after it, in the same transaction. The venue\'s cached config and POS session are cleared.
|
|
36223
36662
|
* @summary Create or update a channel\'s config
|
|
36224
36663
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
36225
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
36664
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
36226
36665
|
* @param {UpsertConfigDto} upsertConfigDto
|
|
36227
36666
|
* @param {*} [options] Override http request option.
|
|
36228
36667
|
* @throws {RequiredError}
|
|
36229
36668
|
*/
|
|
36230
|
-
configUpsertChannelConfig(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay", upsertConfigDto: UpsertConfigDto, options?: any): AxiosPromise<ConfigManagementResponseDto>;
|
|
36669
|
+
configUpsertChannelConfig(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertConfigDto: UpsertConfigDto, options?: any): AxiosPromise<ConfigManagementResponseDto>;
|
|
36231
36670
|
/**
|
|
36232
36671
|
* Creates the channel\'s config first if it has none. Links and credentials are merged over the stored ones; the GiftCard payment option is created after the last option, or switched with the integration.
|
|
36233
36672
|
* @summary Create or update a channel\'s third-party gift card integration
|
|
36234
36673
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
36235
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
36674
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
36236
36675
|
* @param {UpsertGiftCardDto} upsertGiftCardDto
|
|
36237
36676
|
* @param {*} [options] Override http request option.
|
|
36238
36677
|
* @throws {RequiredError}
|
|
36239
36678
|
*/
|
|
36240
|
-
configUpsertGiftCard(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay", upsertGiftCardDto: UpsertGiftCardDto, options?: any): AxiosPromise<ConfigManagementResponseDto>;
|
|
36679
|
+
configUpsertGiftCard(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertGiftCardDto: UpsertGiftCardDto, options?: any): AxiosPromise<ConfigManagementResponseDto>;
|
|
36241
36680
|
/**
|
|
36242
36681
|
* The secret is stored encrypted and never answered: secretKey is null in the answer. A new program needs name, apiBaseUrl and secretKey; apiBaseUrl must be https on the Munchi loyalty server\'s host. A signed-in ticket may write only a programme that serves no venue off its account; the programme and the venue\'s link are written together. The venue\'s cached config and loyalty settings are cleared.
|
|
36243
36682
|
* @summary Create or update a loyalty program and link it to a venue
|
|
@@ -36251,52 +36690,52 @@ export declare const ConfigManagementApiFactory: (configuration?: Configuration,
|
|
|
36251
36690
|
* Creates the channel\'s config first if it has none. Saved active unless isActive is sent. The cached Nets config and token are cleared.
|
|
36252
36691
|
* @summary Create or update a channel\'s Nets config
|
|
36253
36692
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
36254
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
36693
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
36255
36694
|
* @param {UpsertNetsDto} upsertNetsDto
|
|
36256
36695
|
* @param {*} [options] Override http request option.
|
|
36257
36696
|
* @throws {RequiredError}
|
|
36258
36697
|
*/
|
|
36259
|
-
configUpsertNets(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay", upsertNetsDto: UpsertNetsDto, options?: any): AxiosPromise<ConfigManagementResponseDto>;
|
|
36698
|
+
configUpsertNets(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertNetsDto: UpsertNetsDto, options?: any): AxiosPromise<ConfigManagementResponseDto>;
|
|
36260
36699
|
/**
|
|
36261
36700
|
* 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.
|
|
36262
36701
|
* @summary Create or update a channel\'s checkout payment options
|
|
36263
36702
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
36264
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
36703
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
36265
36704
|
* @param {UpsertPaymentOptionsDto} upsertPaymentOptionsDto
|
|
36266
36705
|
* @param {*} [options] Override http request option.
|
|
36267
36706
|
* @throws {RequiredError}
|
|
36268
36707
|
*/
|
|
36269
|
-
configUpsertPaymentOptions(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay", upsertPaymentOptionsDto: UpsertPaymentOptionsDto, options?: any): AxiosPromise<ConfigManagementResponseDto>;
|
|
36708
|
+
configUpsertPaymentOptions(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertPaymentOptionsDto: UpsertPaymentOptionsDto, options?: any): AxiosPromise<ConfigManagementResponseDto>;
|
|
36270
36709
|
/**
|
|
36271
36710
|
* Saves the chosen provider\'s own fields (Viva as the Viva route would, Nets and Stripe as their routes would; Worldline, which has no route of its own, the same way as Nets and Stripe), then selects it on the channel as the channel config route would, and answers the providers as read afterwards. The two saves are not one transaction.
|
|
36272
36711
|
* @summary Set active provider and upsert its credentials
|
|
36273
36712
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
36274
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
36713
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
36275
36714
|
* @param {UpsertProvidersDto} upsertProvidersDto
|
|
36276
36715
|
* @param {*} [options] Override http request option.
|
|
36277
36716
|
* @throws {RequiredError}
|
|
36278
36717
|
*/
|
|
36279
|
-
configUpsertProviders(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay", upsertProvidersDto: UpsertProvidersDto, options?: any): AxiosPromise<ProvidersConfigResponseDto>;
|
|
36718
|
+
configUpsertProviders(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertProvidersDto: UpsertProvidersDto, options?: any): AxiosPromise<ProvidersConfigResponseDto>;
|
|
36280
36719
|
/**
|
|
36281
36720
|
* Creates the channel\'s config first if it has none. Saved active unless isActive is sent. The cached Stripe config is cleared.
|
|
36282
36721
|
* @summary Create or update a channel\'s Stripe config
|
|
36283
36722
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
36284
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
36723
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
36285
36724
|
* @param {UpsertStripeDto} upsertStripeDto
|
|
36286
36725
|
* @param {*} [options] Override http request option.
|
|
36287
36726
|
* @throws {RequiredError}
|
|
36288
36727
|
*/
|
|
36289
|
-
configUpsertStripe(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay", upsertStripeDto: UpsertStripeDto, options?: any): AxiosPromise<ConfigManagementResponseDto>;
|
|
36728
|
+
configUpsertStripe(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertStripeDto: UpsertStripeDto, options?: any): AxiosPromise<ConfigManagementResponseDto>;
|
|
36290
36729
|
/**
|
|
36291
36730
|
* 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; a changed rate or additionalAmount is saved on the license server first.
|
|
36292
36731
|
* @summary Create or update a channel\'s Viva config
|
|
36293
36732
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
36294
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
36733
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
36295
36734
|
* @param {UpsertVivaDto} upsertVivaDto
|
|
36296
36735
|
* @param {*} [options] Override http request option.
|
|
36297
36736
|
* @throws {RequiredError}
|
|
36298
36737
|
*/
|
|
36299
|
-
configUpsertViva(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay", upsertVivaDto: UpsertVivaDto, options?: any): AxiosPromise<ConfigManagementResponseDto>;
|
|
36738
|
+
configUpsertViva(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertVivaDto: UpsertVivaDto, options?: any): AxiosPromise<ConfigManagementResponseDto>;
|
|
36300
36739
|
};
|
|
36301
36740
|
/**
|
|
36302
36741
|
* ConfigManagementApi - interface
|
|
@@ -36308,23 +36747,23 @@ export interface ConfigManagementApiInterface {
|
|
|
36308
36747
|
* The till\'s Settings screen calls it. Creates the channel\'s config first if it has none. Turning it on also enables the MunchiGiftCard payment option.
|
|
36309
36748
|
* @summary Enable or disable first-party Munchi GiftCard integration
|
|
36310
36749
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
36311
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
36750
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
36312
36751
|
* @param {ConfigureMunchiGiftCardDto} configureMunchiGiftCardDto
|
|
36313
36752
|
* @param {*} [options] Override http request option.
|
|
36314
36753
|
* @throws {RequiredError}
|
|
36315
36754
|
* @memberof ConfigManagementApiInterface
|
|
36316
36755
|
*/
|
|
36317
|
-
configConfigureMunchiGiftCard(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', configureMunchiGiftCardDto: ConfigureMunchiGiftCardDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
36756
|
+
configConfigureMunchiGiftCard(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', configureMunchiGiftCardDto: ConfigureMunchiGiftCardDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
36318
36757
|
/**
|
|
36319
36758
|
* The selected provider and each provider\'s settings. A secret key or client secret is answered null: it never leaves the server. The route does not check the venue itself; the global access check reads it from the path (R30).
|
|
36320
36759
|
* @summary Read a channel\'s card payment providers
|
|
36321
36760
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
36322
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
36761
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
36323
36762
|
* @param {*} [options] Override http request option.
|
|
36324
36763
|
* @throws {RequiredError}
|
|
36325
36764
|
* @memberof ConfigManagementApiInterface
|
|
36326
36765
|
*/
|
|
36327
|
-
configGetProviders(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', options?: AxiosRequestConfig): AxiosPromise<ProvidersConfigResponseDto>;
|
|
36766
|
+
configGetProviders(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', options?: AxiosRequestConfig): AxiosPromise<ProvidersConfigResponseDto>;
|
|
36328
36767
|
/**
|
|
36329
36768
|
* Clears the venue\'s cache entry of each key sent and tells the apps to fetch them again: every app of the venue, or one app channel when isGlobal is false.
|
|
36330
36769
|
* @summary Manual sync trigger
|
|
@@ -36340,24 +36779,24 @@ export interface ConfigManagementApiInterface {
|
|
|
36340
36779
|
* @summary Remove payment option
|
|
36341
36780
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
36342
36781
|
* @param {string} id The payment option\'s id
|
|
36343
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
36782
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
36344
36783
|
* @param {*} [options] Override http request option.
|
|
36345
36784
|
* @throws {RequiredError}
|
|
36346
36785
|
* @memberof ConfigManagementApiInterface
|
|
36347
36786
|
*/
|
|
36348
|
-
configRemovePaymentOption(businessId: number, id: string, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
36787
|
+
configRemovePaymentOption(businessId: number, id: string, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
36349
36788
|
/**
|
|
36350
36789
|
* 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.
|
|
36351
36790
|
* @summary Save a channel\'s Epassi credentials and answer the public key to send Epassi
|
|
36352
36791
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
36353
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
36792
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
36354
36793
|
* @param {string} xEpassiAccessKey The access key Epassi issued for this venue; Epassi issues a different one for test and production.
|
|
36355
36794
|
* @param {SaveEpassiCredentialsDto} saveEpassiCredentialsDto
|
|
36356
36795
|
* @param {*} [options] Override http request option.
|
|
36357
36796
|
* @throws {RequiredError}
|
|
36358
36797
|
* @memberof ConfigManagementApiInterface
|
|
36359
36798
|
*/
|
|
36360
|
-
configSaveEpassiCredentials(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', xEpassiAccessKey: string, saveEpassiCredentialsDto: SaveEpassiCredentialsDto, options?: AxiosRequestConfig): AxiosPromise<EpassiCredentialsSavedDto>;
|
|
36799
|
+
configSaveEpassiCredentials(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', xEpassiAccessKey: string, saveEpassiCredentialsDto: SaveEpassiCredentialsDto, options?: AxiosRequestConfig): AxiosPromise<EpassiCredentialsSavedDto>;
|
|
36361
36800
|
/**
|
|
36362
36801
|
* A new venue is saved enabled, named `Business <businessId>`, in Europe/Helsinki unless the body says otherwise, and the license server is asked for its license. The fields below are written as sent; any other field is dropped and its name logged.
|
|
36363
36802
|
* @summary Create or update a venue
|
|
@@ -36372,24 +36811,24 @@ export interface ConfigManagementApiInterface {
|
|
|
36372
36811
|
* A new config is saved in Europe/Helsinki unless the body says otherwise. The fields below are written as sent; any other field is dropped and its name logged. A venue with no merchant switched to Team or PIN lock gets its own merchant, named after it, in the same transaction. The venue\'s cached config and POS session are cleared.
|
|
36373
36812
|
* @summary Create or update a channel\'s config
|
|
36374
36813
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
36375
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
36814
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
36376
36815
|
* @param {UpsertConfigDto} upsertConfigDto
|
|
36377
36816
|
* @param {*} [options] Override http request option.
|
|
36378
36817
|
* @throws {RequiredError}
|
|
36379
36818
|
* @memberof ConfigManagementApiInterface
|
|
36380
36819
|
*/
|
|
36381
|
-
configUpsertChannelConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', upsertConfigDto: UpsertConfigDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
36820
|
+
configUpsertChannelConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertConfigDto: UpsertConfigDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
36382
36821
|
/**
|
|
36383
36822
|
* Creates the channel\'s config first if it has none. Links and credentials are merged over the stored ones; the GiftCard payment option is created after the last option, or switched with the integration.
|
|
36384
36823
|
* @summary Create or update a channel\'s third-party gift card integration
|
|
36385
36824
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
36386
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
36825
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
36387
36826
|
* @param {UpsertGiftCardDto} upsertGiftCardDto
|
|
36388
36827
|
* @param {*} [options] Override http request option.
|
|
36389
36828
|
* @throws {RequiredError}
|
|
36390
36829
|
* @memberof ConfigManagementApiInterface
|
|
36391
36830
|
*/
|
|
36392
|
-
configUpsertGiftCard(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', upsertGiftCardDto: UpsertGiftCardDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
36831
|
+
configUpsertGiftCard(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertGiftCardDto: UpsertGiftCardDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
36393
36832
|
/**
|
|
36394
36833
|
* The secret is stored encrypted and never answered: secretKey is null in the answer. A new program needs name, apiBaseUrl and secretKey; apiBaseUrl must be https on the Munchi loyalty server\'s host. A signed-in ticket may write only a programme that serves no venue off its account; the programme and the venue\'s link are written together. The venue\'s cached config and loyalty settings are cleared.
|
|
36395
36834
|
* @summary Create or update a loyalty program and link it to a venue
|
|
@@ -36404,57 +36843,57 @@ export interface ConfigManagementApiInterface {
|
|
|
36404
36843
|
* Creates the channel\'s config first if it has none. Saved active unless isActive is sent. The cached Nets config and token are cleared.
|
|
36405
36844
|
* @summary Create or update a channel\'s Nets config
|
|
36406
36845
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
36407
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
36846
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
36408
36847
|
* @param {UpsertNetsDto} upsertNetsDto
|
|
36409
36848
|
* @param {*} [options] Override http request option.
|
|
36410
36849
|
* @throws {RequiredError}
|
|
36411
36850
|
* @memberof ConfigManagementApiInterface
|
|
36412
36851
|
*/
|
|
36413
|
-
configUpsertNets(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', upsertNetsDto: UpsertNetsDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
36852
|
+
configUpsertNets(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertNetsDto: UpsertNetsDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
36414
36853
|
/**
|
|
36415
36854
|
* 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.
|
|
36416
36855
|
* @summary Create or update a channel\'s checkout payment options
|
|
36417
36856
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
36418
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
36857
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
36419
36858
|
* @param {UpsertPaymentOptionsDto} upsertPaymentOptionsDto
|
|
36420
36859
|
* @param {*} [options] Override http request option.
|
|
36421
36860
|
* @throws {RequiredError}
|
|
36422
36861
|
* @memberof ConfigManagementApiInterface
|
|
36423
36862
|
*/
|
|
36424
|
-
configUpsertPaymentOptions(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', upsertPaymentOptionsDto: UpsertPaymentOptionsDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
36863
|
+
configUpsertPaymentOptions(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertPaymentOptionsDto: UpsertPaymentOptionsDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
36425
36864
|
/**
|
|
36426
36865
|
* Saves the chosen provider\'s own fields (Viva as the Viva route would, Nets and Stripe as their routes would; Worldline, which has no route of its own, the same way as Nets and Stripe), then selects it on the channel as the channel config route would, and answers the providers as read afterwards. The two saves are not one transaction.
|
|
36427
36866
|
* @summary Set active provider and upsert its credentials
|
|
36428
36867
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
36429
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
36868
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
36430
36869
|
* @param {UpsertProvidersDto} upsertProvidersDto
|
|
36431
36870
|
* @param {*} [options] Override http request option.
|
|
36432
36871
|
* @throws {RequiredError}
|
|
36433
36872
|
* @memberof ConfigManagementApiInterface
|
|
36434
36873
|
*/
|
|
36435
|
-
configUpsertProviders(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', upsertProvidersDto: UpsertProvidersDto, options?: AxiosRequestConfig): AxiosPromise<ProvidersConfigResponseDto>;
|
|
36874
|
+
configUpsertProviders(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertProvidersDto: UpsertProvidersDto, options?: AxiosRequestConfig): AxiosPromise<ProvidersConfigResponseDto>;
|
|
36436
36875
|
/**
|
|
36437
36876
|
* Creates the channel\'s config first if it has none. Saved active unless isActive is sent. The cached Stripe config is cleared.
|
|
36438
36877
|
* @summary Create or update a channel\'s Stripe config
|
|
36439
36878
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
36440
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
36879
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
36441
36880
|
* @param {UpsertStripeDto} upsertStripeDto
|
|
36442
36881
|
* @param {*} [options] Override http request option.
|
|
36443
36882
|
* @throws {RequiredError}
|
|
36444
36883
|
* @memberof ConfigManagementApiInterface
|
|
36445
36884
|
*/
|
|
36446
|
-
configUpsertStripe(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', upsertStripeDto: UpsertStripeDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
36885
|
+
configUpsertStripe(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertStripeDto: UpsertStripeDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
36447
36886
|
/**
|
|
36448
36887
|
* 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; a changed rate or additionalAmount is saved on the license server first.
|
|
36449
36888
|
* @summary Create or update a channel\'s Viva config
|
|
36450
36889
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
36451
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
36890
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
36452
36891
|
* @param {UpsertVivaDto} upsertVivaDto
|
|
36453
36892
|
* @param {*} [options] Override http request option.
|
|
36454
36893
|
* @throws {RequiredError}
|
|
36455
36894
|
* @memberof ConfigManagementApiInterface
|
|
36456
36895
|
*/
|
|
36457
|
-
configUpsertViva(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', upsertVivaDto: UpsertVivaDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
36896
|
+
configUpsertViva(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertVivaDto: UpsertVivaDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
36458
36897
|
}
|
|
36459
36898
|
/**
|
|
36460
36899
|
* ConfigManagementApi - object-oriented interface
|
|
@@ -36467,23 +36906,23 @@ export declare class ConfigManagementApi extends BaseAPI implements ConfigManage
|
|
|
36467
36906
|
* The till\'s Settings screen calls it. Creates the channel\'s config first if it has none. Turning it on also enables the MunchiGiftCard payment option.
|
|
36468
36907
|
* @summary Enable or disable first-party Munchi GiftCard integration
|
|
36469
36908
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
36470
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
36909
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
36471
36910
|
* @param {ConfigureMunchiGiftCardDto} configureMunchiGiftCardDto
|
|
36472
36911
|
* @param {*} [options] Override http request option.
|
|
36473
36912
|
* @throws {RequiredError}
|
|
36474
36913
|
* @memberof ConfigManagementApi
|
|
36475
36914
|
*/
|
|
36476
|
-
configConfigureMunchiGiftCard(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', configureMunchiGiftCardDto: ConfigureMunchiGiftCardDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ConfigManagementResponseDto, any, {}>>;
|
|
36915
|
+
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, {}>>;
|
|
36477
36916
|
/**
|
|
36478
36917
|
* The selected provider and each provider\'s settings. A secret key or client secret is answered null: it never leaves the server. The route does not check the venue itself; the global access check reads it from the path (R30).
|
|
36479
36918
|
* @summary Read a channel\'s card payment providers
|
|
36480
36919
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
36481
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
36920
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
36482
36921
|
* @param {*} [options] Override http request option.
|
|
36483
36922
|
* @throws {RequiredError}
|
|
36484
36923
|
* @memberof ConfigManagementApi
|
|
36485
36924
|
*/
|
|
36486
|
-
configGetProviders(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ProvidersConfigResponseDto, any, {}>>;
|
|
36925
|
+
configGetProviders(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ProvidersConfigResponseDto, any, {}>>;
|
|
36487
36926
|
/**
|
|
36488
36927
|
* Clears the venue\'s cache entry of each key sent and tells the apps to fetch them again: every app of the venue, or one app channel when isGlobal is false.
|
|
36489
36928
|
* @summary Manual sync trigger
|
|
@@ -36499,24 +36938,24 @@ export declare class ConfigManagementApi extends BaseAPI implements ConfigManage
|
|
|
36499
36938
|
* @summary Remove payment option
|
|
36500
36939
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
36501
36940
|
* @param {string} id The payment option\'s id
|
|
36502
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
36941
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
36503
36942
|
* @param {*} [options] Override http request option.
|
|
36504
36943
|
* @throws {RequiredError}
|
|
36505
36944
|
* @memberof ConfigManagementApi
|
|
36506
36945
|
*/
|
|
36507
|
-
configRemovePaymentOption(businessId: number, id: string, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ConfigManagementResponseDto, any, {}>>;
|
|
36946
|
+
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, {}>>;
|
|
36508
36947
|
/**
|
|
36509
36948
|
* 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.
|
|
36510
36949
|
* @summary Save a channel\'s Epassi credentials and answer the public key to send Epassi
|
|
36511
36950
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
36512
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
36951
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
36513
36952
|
* @param {string} xEpassiAccessKey The access key Epassi issued for this venue; Epassi issues a different one for test and production.
|
|
36514
36953
|
* @param {SaveEpassiCredentialsDto} saveEpassiCredentialsDto
|
|
36515
36954
|
* @param {*} [options] Override http request option.
|
|
36516
36955
|
* @throws {RequiredError}
|
|
36517
36956
|
* @memberof ConfigManagementApi
|
|
36518
36957
|
*/
|
|
36519
|
-
configSaveEpassiCredentials(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', xEpassiAccessKey: string, saveEpassiCredentialsDto: SaveEpassiCredentialsDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EpassiCredentialsSavedDto, any, {}>>;
|
|
36958
|
+
configSaveEpassiCredentials(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', xEpassiAccessKey: string, saveEpassiCredentialsDto: SaveEpassiCredentialsDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EpassiCredentialsSavedDto, any, {}>>;
|
|
36520
36959
|
/**
|
|
36521
36960
|
* A new venue is saved enabled, named `Business <businessId>`, in Europe/Helsinki unless the body says otherwise, and the license server is asked for its license. The fields below are written as sent; any other field is dropped and its name logged.
|
|
36522
36961
|
* @summary Create or update a venue
|
|
@@ -36531,24 +36970,24 @@ export declare class ConfigManagementApi extends BaseAPI implements ConfigManage
|
|
|
36531
36970
|
* A new config is saved in Europe/Helsinki unless the body says otherwise. The fields below are written as sent; any other field is dropped and its name logged. A venue with no merchant switched to Team or PIN lock gets its own merchant, named after it, in the same transaction. The venue\'s cached config and POS session are cleared.
|
|
36532
36971
|
* @summary Create or update a channel\'s config
|
|
36533
36972
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
36534
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
36973
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
36535
36974
|
* @param {UpsertConfigDto} upsertConfigDto
|
|
36536
36975
|
* @param {*} [options] Override http request option.
|
|
36537
36976
|
* @throws {RequiredError}
|
|
36538
36977
|
* @memberof ConfigManagementApi
|
|
36539
36978
|
*/
|
|
36540
|
-
configUpsertChannelConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', upsertConfigDto: UpsertConfigDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ConfigManagementResponseDto, any, {}>>;
|
|
36979
|
+
configUpsertChannelConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertConfigDto: UpsertConfigDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ConfigManagementResponseDto, any, {}>>;
|
|
36541
36980
|
/**
|
|
36542
36981
|
* Creates the channel\'s config first if it has none. Links and credentials are merged over the stored ones; the GiftCard payment option is created after the last option, or switched with the integration.
|
|
36543
36982
|
* @summary Create or update a channel\'s third-party gift card integration
|
|
36544
36983
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
36545
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
36984
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
36546
36985
|
* @param {UpsertGiftCardDto} upsertGiftCardDto
|
|
36547
36986
|
* @param {*} [options] Override http request option.
|
|
36548
36987
|
* @throws {RequiredError}
|
|
36549
36988
|
* @memberof ConfigManagementApi
|
|
36550
36989
|
*/
|
|
36551
|
-
configUpsertGiftCard(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', upsertGiftCardDto: UpsertGiftCardDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ConfigManagementResponseDto, any, {}>>;
|
|
36990
|
+
configUpsertGiftCard(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertGiftCardDto: UpsertGiftCardDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ConfigManagementResponseDto, any, {}>>;
|
|
36552
36991
|
/**
|
|
36553
36992
|
* The secret is stored encrypted and never answered: secretKey is null in the answer. A new program needs name, apiBaseUrl and secretKey; apiBaseUrl must be https on the Munchi loyalty server\'s host. A signed-in ticket may write only a programme that serves no venue off its account; the programme and the venue\'s link are written together. The venue\'s cached config and loyalty settings are cleared.
|
|
36554
36993
|
* @summary Create or update a loyalty program and link it to a venue
|
|
@@ -36563,57 +37002,57 @@ export declare class ConfigManagementApi extends BaseAPI implements ConfigManage
|
|
|
36563
37002
|
* Creates the channel\'s config first if it has none. Saved active unless isActive is sent. The cached Nets config and token are cleared.
|
|
36564
37003
|
* @summary Create or update a channel\'s Nets config
|
|
36565
37004
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
36566
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
37005
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
36567
37006
|
* @param {UpsertNetsDto} upsertNetsDto
|
|
36568
37007
|
* @param {*} [options] Override http request option.
|
|
36569
37008
|
* @throws {RequiredError}
|
|
36570
37009
|
* @memberof ConfigManagementApi
|
|
36571
37010
|
*/
|
|
36572
|
-
configUpsertNets(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', upsertNetsDto: UpsertNetsDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ConfigManagementResponseDto, any, {}>>;
|
|
37011
|
+
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, {}>>;
|
|
36573
37012
|
/**
|
|
36574
37013
|
* 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.
|
|
36575
37014
|
* @summary Create or update a channel\'s checkout payment options
|
|
36576
37015
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
36577
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
37016
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
36578
37017
|
* @param {UpsertPaymentOptionsDto} upsertPaymentOptionsDto
|
|
36579
37018
|
* @param {*} [options] Override http request option.
|
|
36580
37019
|
* @throws {RequiredError}
|
|
36581
37020
|
* @memberof ConfigManagementApi
|
|
36582
37021
|
*/
|
|
36583
|
-
configUpsertPaymentOptions(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', upsertPaymentOptionsDto: UpsertPaymentOptionsDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ConfigManagementResponseDto, any, {}>>;
|
|
37022
|
+
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, {}>>;
|
|
36584
37023
|
/**
|
|
36585
37024
|
* Saves the chosen provider\'s own fields (Viva as the Viva route would, Nets and Stripe as their routes would; Worldline, which has no route of its own, the same way as Nets and Stripe), then selects it on the channel as the channel config route would, and answers the providers as read afterwards. The two saves are not one transaction.
|
|
36586
37025
|
* @summary Set active provider and upsert its credentials
|
|
36587
37026
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
36588
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
37027
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
36589
37028
|
* @param {UpsertProvidersDto} upsertProvidersDto
|
|
36590
37029
|
* @param {*} [options] Override http request option.
|
|
36591
37030
|
* @throws {RequiredError}
|
|
36592
37031
|
* @memberof ConfigManagementApi
|
|
36593
37032
|
*/
|
|
36594
|
-
configUpsertProviders(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', upsertProvidersDto: UpsertProvidersDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ProvidersConfigResponseDto, any, {}>>;
|
|
37033
|
+
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, {}>>;
|
|
36595
37034
|
/**
|
|
36596
37035
|
* Creates the channel\'s config first if it has none. Saved active unless isActive is sent. The cached Stripe config is cleared.
|
|
36597
37036
|
* @summary Create or update a channel\'s Stripe config
|
|
36598
37037
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
36599
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
37038
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
36600
37039
|
* @param {UpsertStripeDto} upsertStripeDto
|
|
36601
37040
|
* @param {*} [options] Override http request option.
|
|
36602
37041
|
* @throws {RequiredError}
|
|
36603
37042
|
* @memberof ConfigManagementApi
|
|
36604
37043
|
*/
|
|
36605
|
-
configUpsertStripe(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', upsertStripeDto: UpsertStripeDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ConfigManagementResponseDto, any, {}>>;
|
|
37044
|
+
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, {}>>;
|
|
36606
37045
|
/**
|
|
36607
37046
|
* 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; a changed rate or additionalAmount is saved on the license server first.
|
|
36608
37047
|
* @summary Create or update a channel\'s Viva config
|
|
36609
37048
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
36610
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
37049
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
36611
37050
|
* @param {UpsertVivaDto} upsertVivaDto
|
|
36612
37051
|
* @param {*} [options] Override http request option.
|
|
36613
37052
|
* @throws {RequiredError}
|
|
36614
37053
|
* @memberof ConfigManagementApi
|
|
36615
37054
|
*/
|
|
36616
|
-
configUpsertViva(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', upsertVivaDto: UpsertVivaDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ConfigManagementResponseDto, any, {}>>;
|
|
37055
|
+
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, {}>>;
|
|
36617
37056
|
}
|
|
36618
37057
|
/**
|
|
36619
37058
|
* CoursesApi - axios parameter creator
|
|
@@ -37055,6 +37494,552 @@ export declare class DisplayApi extends BaseAPI implements DisplayApiInterface {
|
|
|
37055
37494
|
*/
|
|
37056
37495
|
unpair(unpairDisplayBodyDto: UnpairDisplayBodyDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UnpairDisplayResponseDto, any, {}>>;
|
|
37057
37496
|
}
|
|
37497
|
+
/**
|
|
37498
|
+
* EmployeeRolesApi - axios parameter creator
|
|
37499
|
+
* @export
|
|
37500
|
+
*/
|
|
37501
|
+
export declare const EmployeeRolesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
37502
|
+
/**
|
|
37503
|
+
* A new role with the POS keys sent. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
37504
|
+
* @summary Add an employee role at the venue
|
|
37505
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37506
|
+
* @param {AddEmployeeRoleDto} addEmployeeRoleDto
|
|
37507
|
+
* @param {*} [options] Override http request option.
|
|
37508
|
+
* @throws {RequiredError}
|
|
37509
|
+
*/
|
|
37510
|
+
addEmployeeRole: (businessId: number, addEmployeeRoleDto: AddEmployeeRoleDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
37511
|
+
/**
|
|
37512
|
+
* Adds each starter role (Cashier, Waiter, Manager) whose name no role of the venue has, all together, so a venue never starts from an empty list. The restaurant changes them like any other role. Calling it again adds nothing new. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
37513
|
+
* @summary Add the starter employee roles at the venue
|
|
37514
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37515
|
+
* @param {*} [options] Override http request option.
|
|
37516
|
+
* @throws {RequiredError}
|
|
37517
|
+
*/
|
|
37518
|
+
addStarterEmployeeRoles: (businessId: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
37519
|
+
/**
|
|
37520
|
+
* Renames the role, replaces its POS keys, or both; a field not sent stays. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
37521
|
+
* @summary Change an employee role of the venue
|
|
37522
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37523
|
+
* @param {string} roleId The role\'s id, one of the venue\'s
|
|
37524
|
+
* @param {ChangeEmployeeRoleDto} changeEmployeeRoleDto
|
|
37525
|
+
* @param {*} [options] Override http request option.
|
|
37526
|
+
* @throws {RequiredError}
|
|
37527
|
+
*/
|
|
37528
|
+
changeEmployeeRole: (businessId: number, roleId: string, changeEmployeeRoleDto: ChangeEmployeeRoleDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
37529
|
+
/**
|
|
37530
|
+
* What each role lets the person at the till do, for the back office (D144). Read from the database every time, ordered by name; a venue keeps at most 100 roles.
|
|
37531
|
+
* @summary List the venue\'s employee roles
|
|
37532
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37533
|
+
* @param {*} [options] Override http request option.
|
|
37534
|
+
* @throws {RequiredError}
|
|
37535
|
+
*/
|
|
37536
|
+
listEmployeeRoles: (businessId: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
37537
|
+
/**
|
|
37538
|
+
* Only a role no employee holds is removed (D144); give its employees another role first. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
37539
|
+
* @summary Remove an employee role of the venue
|
|
37540
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37541
|
+
* @param {string} roleId The role\'s id, one of the venue\'s
|
|
37542
|
+
* @param {*} [options] Override http request option.
|
|
37543
|
+
* @throws {RequiredError}
|
|
37544
|
+
*/
|
|
37545
|
+
removeEmployeeRole: (businessId: number, roleId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
37546
|
+
};
|
|
37547
|
+
/**
|
|
37548
|
+
* EmployeeRolesApi - functional programming interface
|
|
37549
|
+
* @export
|
|
37550
|
+
*/
|
|
37551
|
+
export declare const EmployeeRolesApiFp: (configuration?: Configuration) => {
|
|
37552
|
+
/**
|
|
37553
|
+
* A new role with the POS keys sent. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
37554
|
+
* @summary Add an employee role at the venue
|
|
37555
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37556
|
+
* @param {AddEmployeeRoleDto} addEmployeeRoleDto
|
|
37557
|
+
* @param {*} [options] Override http request option.
|
|
37558
|
+
* @throws {RequiredError}
|
|
37559
|
+
*/
|
|
37560
|
+
addEmployeeRole(businessId: number, addEmployeeRoleDto: AddEmployeeRoleDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmployeeRoleResponseDto>>;
|
|
37561
|
+
/**
|
|
37562
|
+
* Adds each starter role (Cashier, Waiter, Manager) whose name no role of the venue has, all together, so a venue never starts from an empty list. The restaurant changes them like any other role. Calling it again adds nothing new. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
37563
|
+
* @summary Add the starter employee roles at the venue
|
|
37564
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37565
|
+
* @param {*} [options] Override http request option.
|
|
37566
|
+
* @throws {RequiredError}
|
|
37567
|
+
*/
|
|
37568
|
+
addStarterEmployeeRoles(businessId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<EmployeeRoleResponseDto>>>;
|
|
37569
|
+
/**
|
|
37570
|
+
* Renames the role, replaces its POS keys, or both; a field not sent stays. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
37571
|
+
* @summary Change an employee role of the venue
|
|
37572
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37573
|
+
* @param {string} roleId The role\'s id, one of the venue\'s
|
|
37574
|
+
* @param {ChangeEmployeeRoleDto} changeEmployeeRoleDto
|
|
37575
|
+
* @param {*} [options] Override http request option.
|
|
37576
|
+
* @throws {RequiredError}
|
|
37577
|
+
*/
|
|
37578
|
+
changeEmployeeRole(businessId: number, roleId: string, changeEmployeeRoleDto: ChangeEmployeeRoleDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmployeeRoleResponseDto>>;
|
|
37579
|
+
/**
|
|
37580
|
+
* What each role lets the person at the till do, for the back office (D144). Read from the database every time, ordered by name; a venue keeps at most 100 roles.
|
|
37581
|
+
* @summary List the venue\'s employee roles
|
|
37582
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37583
|
+
* @param {*} [options] Override http request option.
|
|
37584
|
+
* @throws {RequiredError}
|
|
37585
|
+
*/
|
|
37586
|
+
listEmployeeRoles(businessId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<EmployeeRoleResponseDto>>>;
|
|
37587
|
+
/**
|
|
37588
|
+
* Only a role no employee holds is removed (D144); give its employees another role first. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
37589
|
+
* @summary Remove an employee role of the venue
|
|
37590
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37591
|
+
* @param {string} roleId The role\'s id, one of the venue\'s
|
|
37592
|
+
* @param {*} [options] Override http request option.
|
|
37593
|
+
* @throws {RequiredError}
|
|
37594
|
+
*/
|
|
37595
|
+
removeEmployeeRole(businessId: number, roleId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
37596
|
+
};
|
|
37597
|
+
/**
|
|
37598
|
+
* EmployeeRolesApi - factory interface
|
|
37599
|
+
* @export
|
|
37600
|
+
*/
|
|
37601
|
+
export declare const EmployeeRolesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
37602
|
+
/**
|
|
37603
|
+
* A new role with the POS keys sent. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
37604
|
+
* @summary Add an employee role at the venue
|
|
37605
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37606
|
+
* @param {AddEmployeeRoleDto} addEmployeeRoleDto
|
|
37607
|
+
* @param {*} [options] Override http request option.
|
|
37608
|
+
* @throws {RequiredError}
|
|
37609
|
+
*/
|
|
37610
|
+
addEmployeeRole(businessId: number, addEmployeeRoleDto: AddEmployeeRoleDto, options?: any): AxiosPromise<EmployeeRoleResponseDto>;
|
|
37611
|
+
/**
|
|
37612
|
+
* Adds each starter role (Cashier, Waiter, Manager) whose name no role of the venue has, all together, so a venue never starts from an empty list. The restaurant changes them like any other role. Calling it again adds nothing new. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
37613
|
+
* @summary Add the starter employee roles at the venue
|
|
37614
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37615
|
+
* @param {*} [options] Override http request option.
|
|
37616
|
+
* @throws {RequiredError}
|
|
37617
|
+
*/
|
|
37618
|
+
addStarterEmployeeRoles(businessId: number, options?: any): AxiosPromise<Array<EmployeeRoleResponseDto>>;
|
|
37619
|
+
/**
|
|
37620
|
+
* Renames the role, replaces its POS keys, or both; a field not sent stays. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
37621
|
+
* @summary Change an employee role of the venue
|
|
37622
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37623
|
+
* @param {string} roleId The role\'s id, one of the venue\'s
|
|
37624
|
+
* @param {ChangeEmployeeRoleDto} changeEmployeeRoleDto
|
|
37625
|
+
* @param {*} [options] Override http request option.
|
|
37626
|
+
* @throws {RequiredError}
|
|
37627
|
+
*/
|
|
37628
|
+
changeEmployeeRole(businessId: number, roleId: string, changeEmployeeRoleDto: ChangeEmployeeRoleDto, options?: any): AxiosPromise<EmployeeRoleResponseDto>;
|
|
37629
|
+
/**
|
|
37630
|
+
* What each role lets the person at the till do, for the back office (D144). Read from the database every time, ordered by name; a venue keeps at most 100 roles.
|
|
37631
|
+
* @summary List the venue\'s employee roles
|
|
37632
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37633
|
+
* @param {*} [options] Override http request option.
|
|
37634
|
+
* @throws {RequiredError}
|
|
37635
|
+
*/
|
|
37636
|
+
listEmployeeRoles(businessId: number, options?: any): AxiosPromise<Array<EmployeeRoleResponseDto>>;
|
|
37637
|
+
/**
|
|
37638
|
+
* Only a role no employee holds is removed (D144); give its employees another role first. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
37639
|
+
* @summary Remove an employee role of the venue
|
|
37640
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37641
|
+
* @param {string} roleId The role\'s id, one of the venue\'s
|
|
37642
|
+
* @param {*} [options] Override http request option.
|
|
37643
|
+
* @throws {RequiredError}
|
|
37644
|
+
*/
|
|
37645
|
+
removeEmployeeRole(businessId: number, roleId: string, options?: any): AxiosPromise<void>;
|
|
37646
|
+
};
|
|
37647
|
+
/**
|
|
37648
|
+
* EmployeeRolesApi - interface
|
|
37649
|
+
* @export
|
|
37650
|
+
* @interface EmployeeRolesApi
|
|
37651
|
+
*/
|
|
37652
|
+
export interface EmployeeRolesApiInterface {
|
|
37653
|
+
/**
|
|
37654
|
+
* A new role with the POS keys sent. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
37655
|
+
* @summary Add an employee role at the venue
|
|
37656
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37657
|
+
* @param {AddEmployeeRoleDto} addEmployeeRoleDto
|
|
37658
|
+
* @param {*} [options] Override http request option.
|
|
37659
|
+
* @throws {RequiredError}
|
|
37660
|
+
* @memberof EmployeeRolesApiInterface
|
|
37661
|
+
*/
|
|
37662
|
+
addEmployeeRole(businessId: number, addEmployeeRoleDto: AddEmployeeRoleDto, options?: AxiosRequestConfig): AxiosPromise<EmployeeRoleResponseDto>;
|
|
37663
|
+
/**
|
|
37664
|
+
* Adds each starter role (Cashier, Waiter, Manager) whose name no role of the venue has, all together, so a venue never starts from an empty list. The restaurant changes them like any other role. Calling it again adds nothing new. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
37665
|
+
* @summary Add the starter employee roles at the venue
|
|
37666
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37667
|
+
* @param {*} [options] Override http request option.
|
|
37668
|
+
* @throws {RequiredError}
|
|
37669
|
+
* @memberof EmployeeRolesApiInterface
|
|
37670
|
+
*/
|
|
37671
|
+
addStarterEmployeeRoles(businessId: number, options?: AxiosRequestConfig): AxiosPromise<Array<EmployeeRoleResponseDto>>;
|
|
37672
|
+
/**
|
|
37673
|
+
* Renames the role, replaces its POS keys, or both; a field not sent stays. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
37674
|
+
* @summary Change an employee role of the venue
|
|
37675
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37676
|
+
* @param {string} roleId The role\'s id, one of the venue\'s
|
|
37677
|
+
* @param {ChangeEmployeeRoleDto} changeEmployeeRoleDto
|
|
37678
|
+
* @param {*} [options] Override http request option.
|
|
37679
|
+
* @throws {RequiredError}
|
|
37680
|
+
* @memberof EmployeeRolesApiInterface
|
|
37681
|
+
*/
|
|
37682
|
+
changeEmployeeRole(businessId: number, roleId: string, changeEmployeeRoleDto: ChangeEmployeeRoleDto, options?: AxiosRequestConfig): AxiosPromise<EmployeeRoleResponseDto>;
|
|
37683
|
+
/**
|
|
37684
|
+
* What each role lets the person at the till do, for the back office (D144). Read from the database every time, ordered by name; a venue keeps at most 100 roles.
|
|
37685
|
+
* @summary List the venue\'s employee roles
|
|
37686
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37687
|
+
* @param {*} [options] Override http request option.
|
|
37688
|
+
* @throws {RequiredError}
|
|
37689
|
+
* @memberof EmployeeRolesApiInterface
|
|
37690
|
+
*/
|
|
37691
|
+
listEmployeeRoles(businessId: number, options?: AxiosRequestConfig): AxiosPromise<Array<EmployeeRoleResponseDto>>;
|
|
37692
|
+
/**
|
|
37693
|
+
* Only a role no employee holds is removed (D144); give its employees another role first. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
37694
|
+
* @summary Remove an employee role of the venue
|
|
37695
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37696
|
+
* @param {string} roleId The role\'s id, one of the venue\'s
|
|
37697
|
+
* @param {*} [options] Override http request option.
|
|
37698
|
+
* @throws {RequiredError}
|
|
37699
|
+
* @memberof EmployeeRolesApiInterface
|
|
37700
|
+
*/
|
|
37701
|
+
removeEmployeeRole(businessId: number, roleId: string, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
37702
|
+
}
|
|
37703
|
+
/**
|
|
37704
|
+
* EmployeeRolesApi - object-oriented interface
|
|
37705
|
+
* @export
|
|
37706
|
+
* @class EmployeeRolesApi
|
|
37707
|
+
* @extends {BaseAPI}
|
|
37708
|
+
*/
|
|
37709
|
+
export declare class EmployeeRolesApi extends BaseAPI implements EmployeeRolesApiInterface {
|
|
37710
|
+
/**
|
|
37711
|
+
* A new role with the POS keys sent. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
37712
|
+
* @summary Add an employee role at the venue
|
|
37713
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37714
|
+
* @param {AddEmployeeRoleDto} addEmployeeRoleDto
|
|
37715
|
+
* @param {*} [options] Override http request option.
|
|
37716
|
+
* @throws {RequiredError}
|
|
37717
|
+
* @memberof EmployeeRolesApi
|
|
37718
|
+
*/
|
|
37719
|
+
addEmployeeRole(businessId: number, addEmployeeRoleDto: AddEmployeeRoleDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EmployeeRoleResponseDto, any, {}>>;
|
|
37720
|
+
/**
|
|
37721
|
+
* Adds each starter role (Cashier, Waiter, Manager) whose name no role of the venue has, all together, so a venue never starts from an empty list. The restaurant changes them like any other role. Calling it again adds nothing new. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
37722
|
+
* @summary Add the starter employee roles at the venue
|
|
37723
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37724
|
+
* @param {*} [options] Override http request option.
|
|
37725
|
+
* @throws {RequiredError}
|
|
37726
|
+
* @memberof EmployeeRolesApi
|
|
37727
|
+
*/
|
|
37728
|
+
addStarterEmployeeRoles(businessId: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EmployeeRoleResponseDto[], any, {}>>;
|
|
37729
|
+
/**
|
|
37730
|
+
* Renames the role, replaces its POS keys, or both; a field not sent stays. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
37731
|
+
* @summary Change an employee role of the venue
|
|
37732
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37733
|
+
* @param {string} roleId The role\'s id, one of the venue\'s
|
|
37734
|
+
* @param {ChangeEmployeeRoleDto} changeEmployeeRoleDto
|
|
37735
|
+
* @param {*} [options] Override http request option.
|
|
37736
|
+
* @throws {RequiredError}
|
|
37737
|
+
* @memberof EmployeeRolesApi
|
|
37738
|
+
*/
|
|
37739
|
+
changeEmployeeRole(businessId: number, roleId: string, changeEmployeeRoleDto: ChangeEmployeeRoleDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EmployeeRoleResponseDto, any, {}>>;
|
|
37740
|
+
/**
|
|
37741
|
+
* What each role lets the person at the till do, for the back office (D144). Read from the database every time, ordered by name; a venue keeps at most 100 roles.
|
|
37742
|
+
* @summary List the venue\'s employee roles
|
|
37743
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37744
|
+
* @param {*} [options] Override http request option.
|
|
37745
|
+
* @throws {RequiredError}
|
|
37746
|
+
* @memberof EmployeeRolesApi
|
|
37747
|
+
*/
|
|
37748
|
+
listEmployeeRoles(businessId: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EmployeeRoleResponseDto[], any, {}>>;
|
|
37749
|
+
/**
|
|
37750
|
+
* Only a role no employee holds is removed (D144); give its employees another role first. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
37751
|
+
* @summary Remove an employee role of the venue
|
|
37752
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37753
|
+
* @param {string} roleId The role\'s id, one of the venue\'s
|
|
37754
|
+
* @param {*} [options] Override http request option.
|
|
37755
|
+
* @throws {RequiredError}
|
|
37756
|
+
* @memberof EmployeeRolesApi
|
|
37757
|
+
*/
|
|
37758
|
+
removeEmployeeRole(businessId: number, roleId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
37759
|
+
}
|
|
37760
|
+
/**
|
|
37761
|
+
* EmployeesApi - axios parameter creator
|
|
37762
|
+
* @export
|
|
37763
|
+
*/
|
|
37764
|
+
export declare const EmployeesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
37765
|
+
/**
|
|
37766
|
+
* An employee of the venue\'s merchant, with their PIN and a role at each venue they work at; every venue must be on the signed-in account (D144 c). The PIN is stored as both servers store it and never answered back. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
37767
|
+
* @summary Add an employee at the venue
|
|
37768
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37769
|
+
* @param {AddEmployeeDto} addEmployeeDto
|
|
37770
|
+
* @param {*} [options] Override http request option.
|
|
37771
|
+
* @throws {RequiredError}
|
|
37772
|
+
*/
|
|
37773
|
+
addEmployee: (businessId: number, addEmployeeDto: AddEmployeeDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
37774
|
+
/**
|
|
37775
|
+
* Changes the fields sent: name, PIN, status, contact. These reach every venue the employee is listed at, so each must be on the signed-in account (D144 c). INACTIVE takes them off every till and keeps their shifts and PIN. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
37776
|
+
* @summary Change an employee
|
|
37777
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37778
|
+
* @param {string} employeeId The employee\'s id, one of the venue\'s merchant
|
|
37779
|
+
* @param {ChangeEmployeeDto} changeEmployeeDto
|
|
37780
|
+
* @param {*} [options] Override http request option.
|
|
37781
|
+
* @throws {RequiredError}
|
|
37782
|
+
*/
|
|
37783
|
+
changeEmployee: (businessId: number, employeeId: string, changeEmployeeDto: ChangeEmployeeDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
37784
|
+
/**
|
|
37785
|
+
* The employees who work at the venue, and those added there with no role yet, ordered by name, a page at a time (D144). No PIN is answered, in any form. Read from the database every time.
|
|
37786
|
+
* @summary List the venue\'s employees
|
|
37787
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37788
|
+
* @param {string} [cursor] The nextCursor of the page before; absent for the first page
|
|
37789
|
+
* @param {number} [limit] How many employees a page holds, 100 at most
|
|
37790
|
+
* @param {*} [options] Override http request option.
|
|
37791
|
+
* @throws {RequiredError}
|
|
37792
|
+
*/
|
|
37793
|
+
listEmployees: (businessId: number, cursor?: string, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
37794
|
+
/**
|
|
37795
|
+
* The employee stops working at this venue only; they, their shifts and their other venues are kept. To take them off every till, make them INACTIVE. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
37796
|
+
* @summary Remove an employee from the venue
|
|
37797
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37798
|
+
* @param {string} employeeId The employee\'s id, one of the venue\'s merchant
|
|
37799
|
+
* @param {*} [options] Override http request option.
|
|
37800
|
+
* @throws {RequiredError}
|
|
37801
|
+
*/
|
|
37802
|
+
removeEmployeeFromVenue: (businessId: number, employeeId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
37803
|
+
/**
|
|
37804
|
+
* The employee works at the venue with this role, replacing the role they had there. An employee of the merchant who does not work at the venue yet starts working there. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
37805
|
+
* @summary Set an employee\'s role at the venue
|
|
37806
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37807
|
+
* @param {string} employeeId The employee\'s id, one of the venue\'s merchant
|
|
37808
|
+
* @param {SetEmployeeRoleDto} setEmployeeRoleDto
|
|
37809
|
+
* @param {*} [options] Override http request option.
|
|
37810
|
+
* @throws {RequiredError}
|
|
37811
|
+
*/
|
|
37812
|
+
setEmployeeRole: (businessId: number, employeeId: string, setEmployeeRoleDto: SetEmployeeRoleDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
37813
|
+
};
|
|
37814
|
+
/**
|
|
37815
|
+
* EmployeesApi - functional programming interface
|
|
37816
|
+
* @export
|
|
37817
|
+
*/
|
|
37818
|
+
export declare const EmployeesApiFp: (configuration?: Configuration) => {
|
|
37819
|
+
/**
|
|
37820
|
+
* An employee of the venue\'s merchant, with their PIN and a role at each venue they work at; every venue must be on the signed-in account (D144 c). The PIN is stored as both servers store it and never answered back. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
37821
|
+
* @summary Add an employee at the venue
|
|
37822
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37823
|
+
* @param {AddEmployeeDto} addEmployeeDto
|
|
37824
|
+
* @param {*} [options] Override http request option.
|
|
37825
|
+
* @throws {RequiredError}
|
|
37826
|
+
*/
|
|
37827
|
+
addEmployee(businessId: number, addEmployeeDto: AddEmployeeDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmployeeResponseDto>>;
|
|
37828
|
+
/**
|
|
37829
|
+
* Changes the fields sent: name, PIN, status, contact. These reach every venue the employee is listed at, so each must be on the signed-in account (D144 c). INACTIVE takes them off every till and keeps their shifts and PIN. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
37830
|
+
* @summary Change an employee
|
|
37831
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37832
|
+
* @param {string} employeeId The employee\'s id, one of the venue\'s merchant
|
|
37833
|
+
* @param {ChangeEmployeeDto} changeEmployeeDto
|
|
37834
|
+
* @param {*} [options] Override http request option.
|
|
37835
|
+
* @throws {RequiredError}
|
|
37836
|
+
*/
|
|
37837
|
+
changeEmployee(businessId: number, employeeId: string, changeEmployeeDto: ChangeEmployeeDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmployeeResponseDto>>;
|
|
37838
|
+
/**
|
|
37839
|
+
* The employees who work at the venue, and those added there with no role yet, ordered by name, a page at a time (D144). No PIN is answered, in any form. Read from the database every time.
|
|
37840
|
+
* @summary List the venue\'s employees
|
|
37841
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37842
|
+
* @param {string} [cursor] The nextCursor of the page before; absent for the first page
|
|
37843
|
+
* @param {number} [limit] How many employees a page holds, 100 at most
|
|
37844
|
+
* @param {*} [options] Override http request option.
|
|
37845
|
+
* @throws {RequiredError}
|
|
37846
|
+
*/
|
|
37847
|
+
listEmployees(businessId: number, cursor?: string, limit?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmployeePageResponseDto>>;
|
|
37848
|
+
/**
|
|
37849
|
+
* The employee stops working at this venue only; they, their shifts and their other venues are kept. To take them off every till, make them INACTIVE. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
37850
|
+
* @summary Remove an employee from the venue
|
|
37851
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37852
|
+
* @param {string} employeeId The employee\'s id, one of the venue\'s merchant
|
|
37853
|
+
* @param {*} [options] Override http request option.
|
|
37854
|
+
* @throws {RequiredError}
|
|
37855
|
+
*/
|
|
37856
|
+
removeEmployeeFromVenue(businessId: number, employeeId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
37857
|
+
/**
|
|
37858
|
+
* The employee works at the venue with this role, replacing the role they had there. An employee of the merchant who does not work at the venue yet starts working there. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
37859
|
+
* @summary Set an employee\'s role at the venue
|
|
37860
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37861
|
+
* @param {string} employeeId The employee\'s id, one of the venue\'s merchant
|
|
37862
|
+
* @param {SetEmployeeRoleDto} setEmployeeRoleDto
|
|
37863
|
+
* @param {*} [options] Override http request option.
|
|
37864
|
+
* @throws {RequiredError}
|
|
37865
|
+
*/
|
|
37866
|
+
setEmployeeRole(businessId: number, employeeId: string, setEmployeeRoleDto: SetEmployeeRoleDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmployeeResponseDto>>;
|
|
37867
|
+
};
|
|
37868
|
+
/**
|
|
37869
|
+
* EmployeesApi - factory interface
|
|
37870
|
+
* @export
|
|
37871
|
+
*/
|
|
37872
|
+
export declare const EmployeesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
37873
|
+
/**
|
|
37874
|
+
* An employee of the venue\'s merchant, with their PIN and a role at each venue they work at; every venue must be on the signed-in account (D144 c). The PIN is stored as both servers store it and never answered back. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
37875
|
+
* @summary Add an employee at the venue
|
|
37876
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37877
|
+
* @param {AddEmployeeDto} addEmployeeDto
|
|
37878
|
+
* @param {*} [options] Override http request option.
|
|
37879
|
+
* @throws {RequiredError}
|
|
37880
|
+
*/
|
|
37881
|
+
addEmployee(businessId: number, addEmployeeDto: AddEmployeeDto, options?: any): AxiosPromise<EmployeeResponseDto>;
|
|
37882
|
+
/**
|
|
37883
|
+
* Changes the fields sent: name, PIN, status, contact. These reach every venue the employee is listed at, so each must be on the signed-in account (D144 c). INACTIVE takes them off every till and keeps their shifts and PIN. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
37884
|
+
* @summary Change an employee
|
|
37885
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37886
|
+
* @param {string} employeeId The employee\'s id, one of the venue\'s merchant
|
|
37887
|
+
* @param {ChangeEmployeeDto} changeEmployeeDto
|
|
37888
|
+
* @param {*} [options] Override http request option.
|
|
37889
|
+
* @throws {RequiredError}
|
|
37890
|
+
*/
|
|
37891
|
+
changeEmployee(businessId: number, employeeId: string, changeEmployeeDto: ChangeEmployeeDto, options?: any): AxiosPromise<EmployeeResponseDto>;
|
|
37892
|
+
/**
|
|
37893
|
+
* The employees who work at the venue, and those added there with no role yet, ordered by name, a page at a time (D144). No PIN is answered, in any form. Read from the database every time.
|
|
37894
|
+
* @summary List the venue\'s employees
|
|
37895
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37896
|
+
* @param {string} [cursor] The nextCursor of the page before; absent for the first page
|
|
37897
|
+
* @param {number} [limit] How many employees a page holds, 100 at most
|
|
37898
|
+
* @param {*} [options] Override http request option.
|
|
37899
|
+
* @throws {RequiredError}
|
|
37900
|
+
*/
|
|
37901
|
+
listEmployees(businessId: number, cursor?: string, limit?: number, options?: any): AxiosPromise<EmployeePageResponseDto>;
|
|
37902
|
+
/**
|
|
37903
|
+
* The employee stops working at this venue only; they, their shifts and their other venues are kept. To take them off every till, make them INACTIVE. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
37904
|
+
* @summary Remove an employee from the venue
|
|
37905
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37906
|
+
* @param {string} employeeId The employee\'s id, one of the venue\'s merchant
|
|
37907
|
+
* @param {*} [options] Override http request option.
|
|
37908
|
+
* @throws {RequiredError}
|
|
37909
|
+
*/
|
|
37910
|
+
removeEmployeeFromVenue(businessId: number, employeeId: string, options?: any): AxiosPromise<void>;
|
|
37911
|
+
/**
|
|
37912
|
+
* The employee works at the venue with this role, replacing the role they had there. An employee of the merchant who does not work at the venue yet starts working there. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
37913
|
+
* @summary Set an employee\'s role at the venue
|
|
37914
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37915
|
+
* @param {string} employeeId The employee\'s id, one of the venue\'s merchant
|
|
37916
|
+
* @param {SetEmployeeRoleDto} setEmployeeRoleDto
|
|
37917
|
+
* @param {*} [options] Override http request option.
|
|
37918
|
+
* @throws {RequiredError}
|
|
37919
|
+
*/
|
|
37920
|
+
setEmployeeRole(businessId: number, employeeId: string, setEmployeeRoleDto: SetEmployeeRoleDto, options?: any): AxiosPromise<EmployeeResponseDto>;
|
|
37921
|
+
};
|
|
37922
|
+
/**
|
|
37923
|
+
* EmployeesApi - interface
|
|
37924
|
+
* @export
|
|
37925
|
+
* @interface EmployeesApi
|
|
37926
|
+
*/
|
|
37927
|
+
export interface EmployeesApiInterface {
|
|
37928
|
+
/**
|
|
37929
|
+
* An employee of the venue\'s merchant, with their PIN and a role at each venue they work at; every venue must be on the signed-in account (D144 c). The PIN is stored as both servers store it and never answered back. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
37930
|
+
* @summary Add an employee at the venue
|
|
37931
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37932
|
+
* @param {AddEmployeeDto} addEmployeeDto
|
|
37933
|
+
* @param {*} [options] Override http request option.
|
|
37934
|
+
* @throws {RequiredError}
|
|
37935
|
+
* @memberof EmployeesApiInterface
|
|
37936
|
+
*/
|
|
37937
|
+
addEmployee(businessId: number, addEmployeeDto: AddEmployeeDto, options?: AxiosRequestConfig): AxiosPromise<EmployeeResponseDto>;
|
|
37938
|
+
/**
|
|
37939
|
+
* Changes the fields sent: name, PIN, status, contact. These reach every venue the employee is listed at, so each must be on the signed-in account (D144 c). INACTIVE takes them off every till and keeps their shifts and PIN. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
37940
|
+
* @summary Change an employee
|
|
37941
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37942
|
+
* @param {string} employeeId The employee\'s id, one of the venue\'s merchant
|
|
37943
|
+
* @param {ChangeEmployeeDto} changeEmployeeDto
|
|
37944
|
+
* @param {*} [options] Override http request option.
|
|
37945
|
+
* @throws {RequiredError}
|
|
37946
|
+
* @memberof EmployeesApiInterface
|
|
37947
|
+
*/
|
|
37948
|
+
changeEmployee(businessId: number, employeeId: string, changeEmployeeDto: ChangeEmployeeDto, options?: AxiosRequestConfig): AxiosPromise<EmployeeResponseDto>;
|
|
37949
|
+
/**
|
|
37950
|
+
* The employees who work at the venue, and those added there with no role yet, ordered by name, a page at a time (D144). No PIN is answered, in any form. Read from the database every time.
|
|
37951
|
+
* @summary List the venue\'s employees
|
|
37952
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37953
|
+
* @param {string} [cursor] The nextCursor of the page before; absent for the first page
|
|
37954
|
+
* @param {number} [limit] How many employees a page holds, 100 at most
|
|
37955
|
+
* @param {*} [options] Override http request option.
|
|
37956
|
+
* @throws {RequiredError}
|
|
37957
|
+
* @memberof EmployeesApiInterface
|
|
37958
|
+
*/
|
|
37959
|
+
listEmployees(businessId: number, cursor?: string, limit?: number, options?: AxiosRequestConfig): AxiosPromise<EmployeePageResponseDto>;
|
|
37960
|
+
/**
|
|
37961
|
+
* The employee stops working at this venue only; they, their shifts and their other venues are kept. To take them off every till, make them INACTIVE. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
37962
|
+
* @summary Remove an employee from the venue
|
|
37963
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37964
|
+
* @param {string} employeeId The employee\'s id, one of the venue\'s merchant
|
|
37965
|
+
* @param {*} [options] Override http request option.
|
|
37966
|
+
* @throws {RequiredError}
|
|
37967
|
+
* @memberof EmployeesApiInterface
|
|
37968
|
+
*/
|
|
37969
|
+
removeEmployeeFromVenue(businessId: number, employeeId: string, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
37970
|
+
/**
|
|
37971
|
+
* The employee works at the venue with this role, replacing the role they had there. An employee of the merchant who does not work at the venue yet starts working there. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
37972
|
+
* @summary Set an employee\'s role at the venue
|
|
37973
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37974
|
+
* @param {string} employeeId The employee\'s id, one of the venue\'s merchant
|
|
37975
|
+
* @param {SetEmployeeRoleDto} setEmployeeRoleDto
|
|
37976
|
+
* @param {*} [options] Override http request option.
|
|
37977
|
+
* @throws {RequiredError}
|
|
37978
|
+
* @memberof EmployeesApiInterface
|
|
37979
|
+
*/
|
|
37980
|
+
setEmployeeRole(businessId: number, employeeId: string, setEmployeeRoleDto: SetEmployeeRoleDto, options?: AxiosRequestConfig): AxiosPromise<EmployeeResponseDto>;
|
|
37981
|
+
}
|
|
37982
|
+
/**
|
|
37983
|
+
* EmployeesApi - object-oriented interface
|
|
37984
|
+
* @export
|
|
37985
|
+
* @class EmployeesApi
|
|
37986
|
+
* @extends {BaseAPI}
|
|
37987
|
+
*/
|
|
37988
|
+
export declare class EmployeesApi extends BaseAPI implements EmployeesApiInterface {
|
|
37989
|
+
/**
|
|
37990
|
+
* An employee of the venue\'s merchant, with their PIN and a role at each venue they work at; every venue must be on the signed-in account (D144 c). The PIN is stored as both servers store it and never answered back. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
37991
|
+
* @summary Add an employee at the venue
|
|
37992
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37993
|
+
* @param {AddEmployeeDto} addEmployeeDto
|
|
37994
|
+
* @param {*} [options] Override http request option.
|
|
37995
|
+
* @throws {RequiredError}
|
|
37996
|
+
* @memberof EmployeesApi
|
|
37997
|
+
*/
|
|
37998
|
+
addEmployee(businessId: number, addEmployeeDto: AddEmployeeDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EmployeeResponseDto, any, {}>>;
|
|
37999
|
+
/**
|
|
38000
|
+
* Changes the fields sent: name, PIN, status, contact. These reach every venue the employee is listed at, so each must be on the signed-in account (D144 c). INACTIVE takes them off every till and keeps their shifts and PIN. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
38001
|
+
* @summary Change an employee
|
|
38002
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
38003
|
+
* @param {string} employeeId The employee\'s id, one of the venue\'s merchant
|
|
38004
|
+
* @param {ChangeEmployeeDto} changeEmployeeDto
|
|
38005
|
+
* @param {*} [options] Override http request option.
|
|
38006
|
+
* @throws {RequiredError}
|
|
38007
|
+
* @memberof EmployeesApi
|
|
38008
|
+
*/
|
|
38009
|
+
changeEmployee(businessId: number, employeeId: string, changeEmployeeDto: ChangeEmployeeDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EmployeeResponseDto, any, {}>>;
|
|
38010
|
+
/**
|
|
38011
|
+
* The employees who work at the venue, and those added there with no role yet, ordered by name, a page at a time (D144). No PIN is answered, in any form. Read from the database every time.
|
|
38012
|
+
* @summary List the venue\'s employees
|
|
38013
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
38014
|
+
* @param {string} [cursor] The nextCursor of the page before; absent for the first page
|
|
38015
|
+
* @param {number} [limit] How many employees a page holds, 100 at most
|
|
38016
|
+
* @param {*} [options] Override http request option.
|
|
38017
|
+
* @throws {RequiredError}
|
|
38018
|
+
* @memberof EmployeesApi
|
|
38019
|
+
*/
|
|
38020
|
+
listEmployees(businessId: number, cursor?: string, limit?: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EmployeePageResponseDto, any, {}>>;
|
|
38021
|
+
/**
|
|
38022
|
+
* The employee stops working at this venue only; they, their shifts and their other venues are kept. To take them off every till, make them INACTIVE. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
38023
|
+
* @summary Remove an employee from the venue
|
|
38024
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
38025
|
+
* @param {string} employeeId The employee\'s id, one of the venue\'s merchant
|
|
38026
|
+
* @param {*} [options] Override http request option.
|
|
38027
|
+
* @throws {RequiredError}
|
|
38028
|
+
* @memberof EmployeesApi
|
|
38029
|
+
*/
|
|
38030
|
+
removeEmployeeFromVenue(businessId: number, employeeId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
38031
|
+
/**
|
|
38032
|
+
* The employee works at the venue with this role, replacing the role they had there. An employee of the merchant who does not work at the venue yet starts working there. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
38033
|
+
* @summary Set an employee\'s role at the venue
|
|
38034
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
38035
|
+
* @param {string} employeeId The employee\'s id, one of the venue\'s merchant
|
|
38036
|
+
* @param {SetEmployeeRoleDto} setEmployeeRoleDto
|
|
38037
|
+
* @param {*} [options] Override http request option.
|
|
38038
|
+
* @throws {RequiredError}
|
|
38039
|
+
* @memberof EmployeesApi
|
|
38040
|
+
*/
|
|
38041
|
+
setEmployeeRole(businessId: number, employeeId: string, setEmployeeRoleDto: SetEmployeeRoleDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EmployeeResponseDto, any, {}>>;
|
|
38042
|
+
}
|
|
37058
38043
|
/**
|
|
37059
38044
|
* FloorPlanApi - axios parameter creator
|
|
37060
38045
|
* @export
|
|
@@ -40376,6 +41361,15 @@ export declare class NotificationApi extends BaseAPI implements NotificationApiI
|
|
|
40376
41361
|
* @export
|
|
40377
41362
|
*/
|
|
40378
41363
|
export declare const OpsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
41364
|
+
/**
|
|
41365
|
+
* Adds the venue\'s active provider row of the platform under the store id (externalId), with supported integrations ORDERS and VENUE, or reactivates the row already there. Calling it again answers the same row; autoAccept, when sent, is applied each time. The venue\'s cached providers are cleared after the commit.
|
|
41366
|
+
* @summary Connect a venue to Foodora or Bolt with the platform\'s store id
|
|
41367
|
+
* @param {number} venueId The Munchi venue id
|
|
41368
|
+
* @param {ConnectDeliveryPlatformDto} connectDeliveryPlatformDto
|
|
41369
|
+
* @param {*} [options] Override http request option.
|
|
41370
|
+
* @throws {RequiredError}
|
|
41371
|
+
*/
|
|
41372
|
+
connectDeliveryPlatform: (venueId: number, connectDeliveryPlatformDto: ConnectDeliveryPlatformDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
40379
41373
|
/**
|
|
40380
41374
|
* The venue\'s stations and payment terminals, each with its id, name, type and status. Never a hardware id: a till signs in with that id alone. Kitchen screens and printers are not here.
|
|
40381
41375
|
* @summary A venue\'s tills, kiosks and payment terminals
|
|
@@ -40384,6 +41378,15 @@ export declare const OpsApiAxiosParamCreator: (configuration?: Configuration) =>
|
|
|
40384
41378
|
* @throws {RequiredError}
|
|
40385
41379
|
*/
|
|
40386
41380
|
devicesOfVenue: (venueId: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
41381
|
+
/**
|
|
41382
|
+
* Makes the venue\'s active rows of the platform inactive; they are kept, so connecting the same store id again brings the row back. The venue\'s cached providers are cleared after the commit. Uber Eats, Wolt and ResQ are disconnected through their onboarding (DELETE provider/onboarding/{channel}/{businessId}).
|
|
41383
|
+
* @summary Disconnect a venue from Foodora or Bolt
|
|
41384
|
+
* @param {number} venueId The Munchi venue id
|
|
41385
|
+
* @param {DeliveryPlatformOpsConnect} channel Foodora or Bolt
|
|
41386
|
+
* @param {*} [options] Override http request option.
|
|
41387
|
+
* @throws {RequiredError}
|
|
41388
|
+
*/
|
|
41389
|
+
disconnectDeliveryPlatform: (venueId: number, channel: DeliveryPlatformOpsConnect, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
40387
41390
|
/**
|
|
40388
41391
|
* Venues whose name holds the text, in any case, or whose venue id it is, by name. Answers who the venue is and where, never its contacts, owners or schedule.
|
|
40389
41392
|
* @summary Find venues by name or id, across every venue
|
|
@@ -40399,6 +41402,15 @@ export declare const OpsApiAxiosParamCreator: (configuration?: Configuration) =>
|
|
|
40399
41402
|
* @export
|
|
40400
41403
|
*/
|
|
40401
41404
|
export declare const OpsApiFp: (configuration?: Configuration) => {
|
|
41405
|
+
/**
|
|
41406
|
+
* Adds the venue\'s active provider row of the platform under the store id (externalId), with supported integrations ORDERS and VENUE, or reactivates the row already there. Calling it again answers the same row; autoAccept, when sent, is applied each time. The venue\'s cached providers are cleared after the commit.
|
|
41407
|
+
* @summary Connect a venue to Foodora or Bolt with the platform\'s store id
|
|
41408
|
+
* @param {number} venueId The Munchi venue id
|
|
41409
|
+
* @param {ConnectDeliveryPlatformDto} connectDeliveryPlatformDto
|
|
41410
|
+
* @param {*} [options] Override http request option.
|
|
41411
|
+
* @throws {RequiredError}
|
|
41412
|
+
*/
|
|
41413
|
+
connectDeliveryPlatform(venueId: number, connectDeliveryPlatformDto: ConnectDeliveryPlatformDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConnectedDeliveryPlatformDto>>;
|
|
40402
41414
|
/**
|
|
40403
41415
|
* The venue\'s stations and payment terminals, each with its id, name, type and status. Never a hardware id: a till signs in with that id alone. Kitchen screens and printers are not here.
|
|
40404
41416
|
* @summary A venue\'s tills, kiosks and payment terminals
|
|
@@ -40407,6 +41419,15 @@ export declare const OpsApiFp: (configuration?: Configuration) => {
|
|
|
40407
41419
|
* @throws {RequiredError}
|
|
40408
41420
|
*/
|
|
40409
41421
|
devicesOfVenue(venueId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueDevicesDto>>;
|
|
41422
|
+
/**
|
|
41423
|
+
* Makes the venue\'s active rows of the platform inactive; they are kept, so connecting the same store id again brings the row back. The venue\'s cached providers are cleared after the commit. Uber Eats, Wolt and ResQ are disconnected through their onboarding (DELETE provider/onboarding/{channel}/{businessId}).
|
|
41424
|
+
* @summary Disconnect a venue from Foodora or Bolt
|
|
41425
|
+
* @param {number} venueId The Munchi venue id
|
|
41426
|
+
* @param {DeliveryPlatformOpsConnect} channel Foodora or Bolt
|
|
41427
|
+
* @param {*} [options] Override http request option.
|
|
41428
|
+
* @throws {RequiredError}
|
|
41429
|
+
*/
|
|
41430
|
+
disconnectDeliveryPlatform(venueId: number, channel: DeliveryPlatformOpsConnect, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DisconnectedDeliveryPlatformDto>>;
|
|
40410
41431
|
/**
|
|
40411
41432
|
* Venues whose name holds the text, in any case, or whose venue id it is, by name. Answers who the venue is and where, never its contacts, owners or schedule.
|
|
40412
41433
|
* @summary Find venues by name or id, across every venue
|
|
@@ -40422,6 +41443,15 @@ export declare const OpsApiFp: (configuration?: Configuration) => {
|
|
|
40422
41443
|
* @export
|
|
40423
41444
|
*/
|
|
40424
41445
|
export declare const OpsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
41446
|
+
/**
|
|
41447
|
+
* Adds the venue\'s active provider row of the platform under the store id (externalId), with supported integrations ORDERS and VENUE, or reactivates the row already there. Calling it again answers the same row; autoAccept, when sent, is applied each time. The venue\'s cached providers are cleared after the commit.
|
|
41448
|
+
* @summary Connect a venue to Foodora or Bolt with the platform\'s store id
|
|
41449
|
+
* @param {number} venueId The Munchi venue id
|
|
41450
|
+
* @param {ConnectDeliveryPlatformDto} connectDeliveryPlatformDto
|
|
41451
|
+
* @param {*} [options] Override http request option.
|
|
41452
|
+
* @throws {RequiredError}
|
|
41453
|
+
*/
|
|
41454
|
+
connectDeliveryPlatform(venueId: number, connectDeliveryPlatformDto: ConnectDeliveryPlatformDto, options?: any): AxiosPromise<ConnectedDeliveryPlatformDto>;
|
|
40425
41455
|
/**
|
|
40426
41456
|
* The venue\'s stations and payment terminals, each with its id, name, type and status. Never a hardware id: a till signs in with that id alone. Kitchen screens and printers are not here.
|
|
40427
41457
|
* @summary A venue\'s tills, kiosks and payment terminals
|
|
@@ -40430,6 +41460,15 @@ export declare const OpsApiFactory: (configuration?: Configuration, basePath?: s
|
|
|
40430
41460
|
* @throws {RequiredError}
|
|
40431
41461
|
*/
|
|
40432
41462
|
devicesOfVenue(venueId: number, options?: any): AxiosPromise<VenueDevicesDto>;
|
|
41463
|
+
/**
|
|
41464
|
+
* Makes the venue\'s active rows of the platform inactive; they are kept, so connecting the same store id again brings the row back. The venue\'s cached providers are cleared after the commit. Uber Eats, Wolt and ResQ are disconnected through their onboarding (DELETE provider/onboarding/{channel}/{businessId}).
|
|
41465
|
+
* @summary Disconnect a venue from Foodora or Bolt
|
|
41466
|
+
* @param {number} venueId The Munchi venue id
|
|
41467
|
+
* @param {DeliveryPlatformOpsConnect} channel Foodora or Bolt
|
|
41468
|
+
* @param {*} [options] Override http request option.
|
|
41469
|
+
* @throws {RequiredError}
|
|
41470
|
+
*/
|
|
41471
|
+
disconnectDeliveryPlatform(venueId: number, channel: DeliveryPlatformOpsConnect, options?: any): AxiosPromise<DisconnectedDeliveryPlatformDto>;
|
|
40433
41472
|
/**
|
|
40434
41473
|
* Venues whose name holds the text, in any case, or whose venue id it is, by name. Answers who the venue is and where, never its contacts, owners or schedule.
|
|
40435
41474
|
* @summary Find venues by name or id, across every venue
|
|
@@ -40446,6 +41485,16 @@ export declare const OpsApiFactory: (configuration?: Configuration, basePath?: s
|
|
|
40446
41485
|
* @interface OpsApi
|
|
40447
41486
|
*/
|
|
40448
41487
|
export interface OpsApiInterface {
|
|
41488
|
+
/**
|
|
41489
|
+
* Adds the venue\'s active provider row of the platform under the store id (externalId), with supported integrations ORDERS and VENUE, or reactivates the row already there. Calling it again answers the same row; autoAccept, when sent, is applied each time. The venue\'s cached providers are cleared after the commit.
|
|
41490
|
+
* @summary Connect a venue to Foodora or Bolt with the platform\'s store id
|
|
41491
|
+
* @param {number} venueId The Munchi venue id
|
|
41492
|
+
* @param {ConnectDeliveryPlatformDto} connectDeliveryPlatformDto
|
|
41493
|
+
* @param {*} [options] Override http request option.
|
|
41494
|
+
* @throws {RequiredError}
|
|
41495
|
+
* @memberof OpsApiInterface
|
|
41496
|
+
*/
|
|
41497
|
+
connectDeliveryPlatform(venueId: number, connectDeliveryPlatformDto: ConnectDeliveryPlatformDto, options?: AxiosRequestConfig): AxiosPromise<ConnectedDeliveryPlatformDto>;
|
|
40449
41498
|
/**
|
|
40450
41499
|
* The venue\'s stations and payment terminals, each with its id, name, type and status. Never a hardware id: a till signs in with that id alone. Kitchen screens and printers are not here.
|
|
40451
41500
|
* @summary A venue\'s tills, kiosks and payment terminals
|
|
@@ -40455,6 +41504,16 @@ export interface OpsApiInterface {
|
|
|
40455
41504
|
* @memberof OpsApiInterface
|
|
40456
41505
|
*/
|
|
40457
41506
|
devicesOfVenue(venueId: number, options?: AxiosRequestConfig): AxiosPromise<VenueDevicesDto>;
|
|
41507
|
+
/**
|
|
41508
|
+
* Makes the venue\'s active rows of the platform inactive; they are kept, so connecting the same store id again brings the row back. The venue\'s cached providers are cleared after the commit. Uber Eats, Wolt and ResQ are disconnected through their onboarding (DELETE provider/onboarding/{channel}/{businessId}).
|
|
41509
|
+
* @summary Disconnect a venue from Foodora or Bolt
|
|
41510
|
+
* @param {number} venueId The Munchi venue id
|
|
41511
|
+
* @param {DeliveryPlatformOpsConnect} channel Foodora or Bolt
|
|
41512
|
+
* @param {*} [options] Override http request option.
|
|
41513
|
+
* @throws {RequiredError}
|
|
41514
|
+
* @memberof OpsApiInterface
|
|
41515
|
+
*/
|
|
41516
|
+
disconnectDeliveryPlatform(venueId: number, channel: DeliveryPlatformOpsConnect, options?: AxiosRequestConfig): AxiosPromise<DisconnectedDeliveryPlatformDto>;
|
|
40458
41517
|
/**
|
|
40459
41518
|
* Venues whose name holds the text, in any case, or whose venue id it is, by name. Answers who the venue is and where, never its contacts, owners or schedule.
|
|
40460
41519
|
* @summary Find venues by name or id, across every venue
|
|
@@ -40473,6 +41532,16 @@ export interface OpsApiInterface {
|
|
|
40473
41532
|
* @extends {BaseAPI}
|
|
40474
41533
|
*/
|
|
40475
41534
|
export declare class OpsApi extends BaseAPI implements OpsApiInterface {
|
|
41535
|
+
/**
|
|
41536
|
+
* Adds the venue\'s active provider row of the platform under the store id (externalId), with supported integrations ORDERS and VENUE, or reactivates the row already there. Calling it again answers the same row; autoAccept, when sent, is applied each time. The venue\'s cached providers are cleared after the commit.
|
|
41537
|
+
* @summary Connect a venue to Foodora or Bolt with the platform\'s store id
|
|
41538
|
+
* @param {number} venueId The Munchi venue id
|
|
41539
|
+
* @param {ConnectDeliveryPlatformDto} connectDeliveryPlatformDto
|
|
41540
|
+
* @param {*} [options] Override http request option.
|
|
41541
|
+
* @throws {RequiredError}
|
|
41542
|
+
* @memberof OpsApi
|
|
41543
|
+
*/
|
|
41544
|
+
connectDeliveryPlatform(venueId: number, connectDeliveryPlatformDto: ConnectDeliveryPlatformDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ConnectedDeliveryPlatformDto, any, {}>>;
|
|
40476
41545
|
/**
|
|
40477
41546
|
* The venue\'s stations and payment terminals, each with its id, name, type and status. Never a hardware id: a till signs in with that id alone. Kitchen screens and printers are not here.
|
|
40478
41547
|
* @summary A venue\'s tills, kiosks and payment terminals
|
|
@@ -40482,6 +41551,16 @@ export declare class OpsApi extends BaseAPI implements OpsApiInterface {
|
|
|
40482
41551
|
* @memberof OpsApi
|
|
40483
41552
|
*/
|
|
40484
41553
|
devicesOfVenue(venueId: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VenueDevicesDto, any, {}>>;
|
|
41554
|
+
/**
|
|
41555
|
+
* Makes the venue\'s active rows of the platform inactive; they are kept, so connecting the same store id again brings the row back. The venue\'s cached providers are cleared after the commit. Uber Eats, Wolt and ResQ are disconnected through their onboarding (DELETE provider/onboarding/{channel}/{businessId}).
|
|
41556
|
+
* @summary Disconnect a venue from Foodora or Bolt
|
|
41557
|
+
* @param {number} venueId The Munchi venue id
|
|
41558
|
+
* @param {DeliveryPlatformOpsConnect} channel Foodora or Bolt
|
|
41559
|
+
* @param {*} [options] Override http request option.
|
|
41560
|
+
* @throws {RequiredError}
|
|
41561
|
+
* @memberof OpsApi
|
|
41562
|
+
*/
|
|
41563
|
+
disconnectDeliveryPlatform(venueId: number, channel: DeliveryPlatformOpsConnect, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DisconnectedDeliveryPlatformDto, any, {}>>;
|
|
40485
41564
|
/**
|
|
40486
41565
|
* Venues whose name holds the text, in any case, or whose venue id it is, by name. Answers who the venue is and where, never its contacts, owners or schedule.
|
|
40487
41566
|
* @summary Find venues by name or id, across every venue
|
|
@@ -42866,6 +43945,14 @@ export declare const PaymentSessionApiAxiosParamCreator: (configuration?: Config
|
|
|
42866
43945
|
* @throws {RequiredError}
|
|
42867
43946
|
*/
|
|
42868
43947
|
getPaymentSessionAnalytics: (businessId: number, timeSpan: TimeSpan, start?: string, end?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
43948
|
+
/**
|
|
43949
|
+
* One read of the session\'s currency, by the sessionId a refund names, so a refund can be confirmed in its own currency before it is sent. A signed-in ticket reaches only a session of its own venues; a partner key reaches none, since the session, not the request, names the venue. Never the shared key (R27).
|
|
43950
|
+
* @summary Get the currency of a payment session by its sessionId
|
|
43951
|
+
* @param {string} sessionId The payment session\'s sessionId, the same value stored as the order paymentEvent referenceId
|
|
43952
|
+
* @param {*} [options] Override http request option.
|
|
43953
|
+
* @throws {RequiredError}
|
|
43954
|
+
*/
|
|
43955
|
+
getPaymentSessionCurrency: (sessionId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
42869
43956
|
/**
|
|
42870
43957
|
* Answers at once, before Epassi is asked: the session is reserved PROCESSING with the QR code (sent in the X-Epassi-Qr-Code header) kept encrypted on it, and a Cloud Task that runs at once sends the payment to Epassi. Epassi may hold that payment up to about 30 seconds while the customer approves it in the Epassi app. Follow the session on the Ably channel named in `ablyChannel` (event `payment:status-changed`) or with GET /payment-session/:clientToken: `awaitingApproval` true while Epassi waits for the customer, then SUCCESS, FAILED or CANCELLED. A sale with no definite answer 6 minutes after it started is failed, Epassi is asked to cancel it and staff are alerted. A paid session is written to the order by the server. Idempotent by the X-Idempotency-Key header: a repeat answers the session\'s current state. Answers FAILED with payment.aborted when the payment could not be queued; Epassi was then never asked. Accepts the shared service key as well as a signed-in ticket: a named R27 exception, because the kiosk calls with that key until the apps have credentials of their own.
|
|
42871
43958
|
* @summary Charge an Epassi QR code
|
|
@@ -43075,6 +44162,14 @@ export declare const PaymentSessionApiFp: (configuration?: Configuration) => {
|
|
|
43075
44162
|
* @throws {RequiredError}
|
|
43076
44163
|
*/
|
|
43077
44164
|
getPaymentSessionAnalytics(businessId: number, timeSpan: TimeSpan, start?: string, end?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentSessionAnalyticsResponseDto>>;
|
|
44165
|
+
/**
|
|
44166
|
+
* One read of the session\'s currency, by the sessionId a refund names, so a refund can be confirmed in its own currency before it is sent. A signed-in ticket reaches only a session of its own venues; a partner key reaches none, since the session, not the request, names the venue. Never the shared key (R27).
|
|
44167
|
+
* @summary Get the currency of a payment session by its sessionId
|
|
44168
|
+
* @param {string} sessionId The payment session\'s sessionId, the same value stored as the order paymentEvent referenceId
|
|
44169
|
+
* @param {*} [options] Override http request option.
|
|
44170
|
+
* @throws {RequiredError}
|
|
44171
|
+
*/
|
|
44172
|
+
getPaymentSessionCurrency(sessionId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentSessionCurrencyDto>>;
|
|
43078
44173
|
/**
|
|
43079
44174
|
* Answers at once, before Epassi is asked: the session is reserved PROCESSING with the QR code (sent in the X-Epassi-Qr-Code header) kept encrypted on it, and a Cloud Task that runs at once sends the payment to Epassi. Epassi may hold that payment up to about 30 seconds while the customer approves it in the Epassi app. Follow the session on the Ably channel named in `ablyChannel` (event `payment:status-changed`) or with GET /payment-session/:clientToken: `awaitingApproval` true while Epassi waits for the customer, then SUCCESS, FAILED or CANCELLED. A sale with no definite answer 6 minutes after it started is failed, Epassi is asked to cancel it and staff are alerted. A paid session is written to the order by the server. Idempotent by the X-Idempotency-Key header: a repeat answers the session\'s current state. Answers FAILED with payment.aborted when the payment could not be queued; Epassi was then never asked. Accepts the shared service key as well as a signed-in ticket: a named R27 exception, because the kiosk calls with that key until the apps have credentials of their own.
|
|
43080
44175
|
* @summary Charge an Epassi QR code
|
|
@@ -43284,6 +44379,14 @@ export declare const PaymentSessionApiFactory: (configuration?: Configuration, b
|
|
|
43284
44379
|
* @throws {RequiredError}
|
|
43285
44380
|
*/
|
|
43286
44381
|
getPaymentSessionAnalytics(businessId: number, timeSpan: TimeSpan, start?: string, end?: string, options?: any): AxiosPromise<PaymentSessionAnalyticsResponseDto>;
|
|
44382
|
+
/**
|
|
44383
|
+
* One read of the session\'s currency, by the sessionId a refund names, so a refund can be confirmed in its own currency before it is sent. A signed-in ticket reaches only a session of its own venues; a partner key reaches none, since the session, not the request, names the venue. Never the shared key (R27).
|
|
44384
|
+
* @summary Get the currency of a payment session by its sessionId
|
|
44385
|
+
* @param {string} sessionId The payment session\'s sessionId, the same value stored as the order paymentEvent referenceId
|
|
44386
|
+
* @param {*} [options] Override http request option.
|
|
44387
|
+
* @throws {RequiredError}
|
|
44388
|
+
*/
|
|
44389
|
+
getPaymentSessionCurrency(sessionId: string, options?: any): AxiosPromise<PaymentSessionCurrencyDto>;
|
|
43287
44390
|
/**
|
|
43288
44391
|
* Answers at once, before Epassi is asked: the session is reserved PROCESSING with the QR code (sent in the X-Epassi-Qr-Code header) kept encrypted on it, and a Cloud Task that runs at once sends the payment to Epassi. Epassi may hold that payment up to about 30 seconds while the customer approves it in the Epassi app. Follow the session on the Ably channel named in `ablyChannel` (event `payment:status-changed`) or with GET /payment-session/:clientToken: `awaitingApproval` true while Epassi waits for the customer, then SUCCESS, FAILED or CANCELLED. A sale with no definite answer 6 minutes after it started is failed, Epassi is asked to cancel it and staff are alerted. A paid session is written to the order by the server. Idempotent by the X-Idempotency-Key header: a repeat answers the session\'s current state. Answers FAILED with payment.aborted when the payment could not be queued; Epassi was then never asked. Accepts the shared service key as well as a signed-in ticket: a named R27 exception, because the kiosk calls with that key until the apps have credentials of their own.
|
|
43289
44392
|
* @summary Charge an Epassi QR code
|
|
@@ -43498,6 +44601,15 @@ export interface PaymentSessionApiInterface {
|
|
|
43498
44601
|
* @memberof PaymentSessionApiInterface
|
|
43499
44602
|
*/
|
|
43500
44603
|
getPaymentSessionAnalytics(businessId: number, timeSpan: TimeSpan, start?: string, end?: string, options?: AxiosRequestConfig): AxiosPromise<PaymentSessionAnalyticsResponseDto>;
|
|
44604
|
+
/**
|
|
44605
|
+
* One read of the session\'s currency, by the sessionId a refund names, so a refund can be confirmed in its own currency before it is sent. A signed-in ticket reaches only a session of its own venues; a partner key reaches none, since the session, not the request, names the venue. Never the shared key (R27).
|
|
44606
|
+
* @summary Get the currency of a payment session by its sessionId
|
|
44607
|
+
* @param {string} sessionId The payment session\'s sessionId, the same value stored as the order paymentEvent referenceId
|
|
44608
|
+
* @param {*} [options] Override http request option.
|
|
44609
|
+
* @throws {RequiredError}
|
|
44610
|
+
* @memberof PaymentSessionApiInterface
|
|
44611
|
+
*/
|
|
44612
|
+
getPaymentSessionCurrency(sessionId: string, options?: AxiosRequestConfig): AxiosPromise<PaymentSessionCurrencyDto>;
|
|
43501
44613
|
/**
|
|
43502
44614
|
* Answers at once, before Epassi is asked: the session is reserved PROCESSING with the QR code (sent in the X-Epassi-Qr-Code header) kept encrypted on it, and a Cloud Task that runs at once sends the payment to Epassi. Epassi may hold that payment up to about 30 seconds while the customer approves it in the Epassi app. Follow the session on the Ably channel named in `ablyChannel` (event `payment:status-changed`) or with GET /payment-session/:clientToken: `awaitingApproval` true while Epassi waits for the customer, then SUCCESS, FAILED or CANCELLED. A sale with no definite answer 6 minutes after it started is failed, Epassi is asked to cancel it and staff are alerted. A paid session is written to the order by the server. Idempotent by the X-Idempotency-Key header: a repeat answers the session\'s current state. Answers FAILED with payment.aborted when the payment could not be queued; Epassi was then never asked. Accepts the shared service key as well as a signed-in ticket: a named R27 exception, because the kiosk calls with that key until the apps have credentials of their own.
|
|
43503
44615
|
* @summary Charge an Epassi QR code
|
|
@@ -43733,6 +44845,15 @@ export declare class PaymentSessionApi extends BaseAPI implements PaymentSession
|
|
|
43733
44845
|
* @memberof PaymentSessionApi
|
|
43734
44846
|
*/
|
|
43735
44847
|
getPaymentSessionAnalytics(businessId: number, timeSpan: TimeSpan, start?: string, end?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PaymentSessionAnalyticsResponseDto, any, {}>>;
|
|
44848
|
+
/**
|
|
44849
|
+
* One read of the session\'s currency, by the sessionId a refund names, so a refund can be confirmed in its own currency before it is sent. A signed-in ticket reaches only a session of its own venues; a partner key reaches none, since the session, not the request, names the venue. Never the shared key (R27).
|
|
44850
|
+
* @summary Get the currency of a payment session by its sessionId
|
|
44851
|
+
* @param {string} sessionId The payment session\'s sessionId, the same value stored as the order paymentEvent referenceId
|
|
44852
|
+
* @param {*} [options] Override http request option.
|
|
44853
|
+
* @throws {RequiredError}
|
|
44854
|
+
* @memberof PaymentSessionApi
|
|
44855
|
+
*/
|
|
44856
|
+
getPaymentSessionCurrency(sessionId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PaymentSessionCurrencyDto, any, {}>>;
|
|
43736
44857
|
/**
|
|
43737
44858
|
* Answers at once, before Epassi is asked: the session is reserved PROCESSING with the QR code (sent in the X-Epassi-Qr-Code header) kept encrypted on it, and a Cloud Task that runs at once sends the payment to Epassi. Epassi may hold that payment up to about 30 seconds while the customer approves it in the Epassi app. Follow the session on the Ably channel named in `ablyChannel` (event `payment:status-changed`) or with GET /payment-session/:clientToken: `awaitingApproval` true while Epassi waits for the customer, then SUCCESS, FAILED or CANCELLED. A sale with no definite answer 6 minutes after it started is failed, Epassi is asked to cancel it and staff are alerted. A paid session is written to the order by the server. Idempotent by the X-Idempotency-Key header: a repeat answers the session\'s current state. Answers FAILED with payment.aborted when the payment could not be queued; Epassi was then never asked. Accepts the shared service key as well as a signed-in ticket: a named R27 exception, because the kiosk calls with that key until the apps have credentials of their own.
|
|
43738
44859
|
* @summary Charge an Epassi QR code
|
|
@@ -44309,18 +45430,18 @@ export declare class ProductApi extends BaseAPI implements ProductApiInterface {
|
|
|
44309
45430
|
*/
|
|
44310
45431
|
export declare const ProviderApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
44311
45432
|
/**
|
|
44312
|
-
* Asks the channel\'s service (ubereats-service for UberEats, wolt-service for Wolt and WoltStorefront) for a sign-in session and answers it as that service answered it. Nothing is written here.
|
|
44313
|
-
* @summary Start connecting a venue to Uber Eats or
|
|
44314
|
-
* @param {ProviderEnum} channel The channel to connect: UberEats, Wolt or
|
|
45433
|
+
* Asks the channel\'s service (ubereats-service for UberEats, wolt-service for Wolt and WoltStorefront, resq-service for ResQ) for a sign-in session and answers it as that service answered it. Nothing is written here.
|
|
45434
|
+
* @summary Start connecting a venue to Uber Eats, Wolt or ResQ
|
|
45435
|
+
* @param {ProviderEnum} channel The channel to connect: UberEats, Wolt, WoltStorefront or ResQ. Any other channel is answered 400
|
|
44315
45436
|
* @param {CreateOnboardingSessionDto} createOnboardingSessionDto
|
|
44316
45437
|
* @param {*} [options] Override http request option.
|
|
44317
45438
|
* @throws {RequiredError}
|
|
44318
45439
|
*/
|
|
44319
45440
|
createOnboardingSession: (channel: ProviderEnum, createOnboardingSessionDto: CreateOnboardingSessionDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
44320
45441
|
/**
|
|
44321
|
-
* The channel\'s service disconnects the venue, writes its provider row and announces the change; its answer is passed on as it is: Uber Eats\' disconnected store, or wolt-service
|
|
44322
|
-
* @summary Disconnect a venue from Uber Eats or
|
|
44323
|
-
* @param {ProviderEnum} channel The channel to connect: UberEats, Wolt or
|
|
45442
|
+
* The channel\'s service disconnects the venue, writes its provider row and announces the change; its answer is passed on as it is: Uber Eats\' disconnected store, or the message of wolt-service or resq-service.
|
|
45443
|
+
* @summary Disconnect a venue from Uber Eats, Wolt or ResQ
|
|
45444
|
+
* @param {ProviderEnum} channel The channel to connect: UberEats, Wolt, WoltStorefront or ResQ. Any other channel is answered 400
|
|
44324
45445
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
44325
45446
|
* @param {*} [options] Override http request option.
|
|
44326
45447
|
* @throws {RequiredError}
|
|
@@ -44335,9 +45456,9 @@ export declare const ProviderApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
44335
45456
|
*/
|
|
44336
45457
|
getMenuIntegrations: (businessId: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
44337
45458
|
/**
|
|
44338
|
-
* The channel\'s service answers, and its answer is passed on as it is: Uber Eats\' shape for UberEats, Wolt\'s for Wolt and
|
|
44339
|
-
* @summary Whether a venue is connected to Uber Eats or
|
|
44340
|
-
* @param {ProviderEnum} channel The channel to connect: UberEats, Wolt or
|
|
45459
|
+
* The channel\'s service answers, and its answer is passed on as it is: Uber Eats\' shape for UberEats, Wolt\'s for Wolt, WoltStorefront and ResQ. Not cached: the dashboard acts on it.
|
|
45460
|
+
* @summary Whether a venue is connected to Uber Eats, Wolt or ResQ
|
|
45461
|
+
* @param {ProviderEnum} channel The channel to connect: UberEats, Wolt, WoltStorefront or ResQ. Any other channel is answered 400
|
|
44341
45462
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
44342
45463
|
* @param {*} [options] Override http request option.
|
|
44343
45464
|
* @throws {RequiredError}
|
|
@@ -44378,18 +45499,18 @@ export declare const ProviderApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
44378
45499
|
*/
|
|
44379
45500
|
export declare const ProviderApiFp: (configuration?: Configuration) => {
|
|
44380
45501
|
/**
|
|
44381
|
-
* Asks the channel\'s service (ubereats-service for UberEats, wolt-service for Wolt and WoltStorefront) for a sign-in session and answers it as that service answered it. Nothing is written here.
|
|
44382
|
-
* @summary Start connecting a venue to Uber Eats or
|
|
44383
|
-
* @param {ProviderEnum} channel The channel to connect: UberEats, Wolt or
|
|
45502
|
+
* Asks the channel\'s service (ubereats-service for UberEats, wolt-service for Wolt and WoltStorefront, resq-service for ResQ) for a sign-in session and answers it as that service answered it. Nothing is written here.
|
|
45503
|
+
* @summary Start connecting a venue to Uber Eats, Wolt or ResQ
|
|
45504
|
+
* @param {ProviderEnum} channel The channel to connect: UberEats, Wolt, WoltStorefront or ResQ. Any other channel is answered 400
|
|
44384
45505
|
* @param {CreateOnboardingSessionDto} createOnboardingSessionDto
|
|
44385
45506
|
* @param {*} [options] Override http request option.
|
|
44386
45507
|
* @throws {RequiredError}
|
|
44387
45508
|
*/
|
|
44388
45509
|
createOnboardingSession(channel: ProviderEnum, createOnboardingSessionDto: CreateOnboardingSessionDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OnboardingSessionDto>>;
|
|
44389
45510
|
/**
|
|
44390
|
-
* The channel\'s service disconnects the venue, writes its provider row and announces the change; its answer is passed on as it is: Uber Eats\' disconnected store, or wolt-service
|
|
44391
|
-
* @summary Disconnect a venue from Uber Eats or
|
|
44392
|
-
* @param {ProviderEnum} channel The channel to connect: UberEats, Wolt or
|
|
45511
|
+
* The channel\'s service disconnects the venue, writes its provider row and announces the change; its answer is passed on as it is: Uber Eats\' disconnected store, or the message of wolt-service or resq-service.
|
|
45512
|
+
* @summary Disconnect a venue from Uber Eats, Wolt or ResQ
|
|
45513
|
+
* @param {ProviderEnum} channel The channel to connect: UberEats, Wolt, WoltStorefront or ResQ. Any other channel is answered 400
|
|
44393
45514
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
44394
45515
|
* @param {*} [options] Override http request option.
|
|
44395
45516
|
* @throws {RequiredError}
|
|
@@ -44404,9 +45525,9 @@ export declare const ProviderApiFp: (configuration?: Configuration) => {
|
|
|
44404
45525
|
*/
|
|
44405
45526
|
getMenuIntegrations(businessId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ProviderIntegrationDto>>>;
|
|
44406
45527
|
/**
|
|
44407
|
-
* The channel\'s service answers, and its answer is passed on as it is: Uber Eats\' shape for UberEats, Wolt\'s for Wolt and
|
|
44408
|
-
* @summary Whether a venue is connected to Uber Eats or
|
|
44409
|
-
* @param {ProviderEnum} channel The channel to connect: UberEats, Wolt or
|
|
45528
|
+
* The channel\'s service answers, and its answer is passed on as it is: Uber Eats\' shape for UberEats, Wolt\'s for Wolt, WoltStorefront and ResQ. Not cached: the dashboard acts on it.
|
|
45529
|
+
* @summary Whether a venue is connected to Uber Eats, Wolt or ResQ
|
|
45530
|
+
* @param {ProviderEnum} channel The channel to connect: UberEats, Wolt, WoltStorefront or ResQ. Any other channel is answered 400
|
|
44410
45531
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
44411
45532
|
* @param {*} [options] Override http request option.
|
|
44412
45533
|
* @throws {RequiredError}
|
|
@@ -44447,18 +45568,18 @@ export declare const ProviderApiFp: (configuration?: Configuration) => {
|
|
|
44447
45568
|
*/
|
|
44448
45569
|
export declare const ProviderApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
44449
45570
|
/**
|
|
44450
|
-
* Asks the channel\'s service (ubereats-service for UberEats, wolt-service for Wolt and WoltStorefront) for a sign-in session and answers it as that service answered it. Nothing is written here.
|
|
44451
|
-
* @summary Start connecting a venue to Uber Eats or
|
|
44452
|
-
* @param {ProviderEnum} channel The channel to connect: UberEats, Wolt or
|
|
45571
|
+
* Asks the channel\'s service (ubereats-service for UberEats, wolt-service for Wolt and WoltStorefront, resq-service for ResQ) for a sign-in session and answers it as that service answered it. Nothing is written here.
|
|
45572
|
+
* @summary Start connecting a venue to Uber Eats, Wolt or ResQ
|
|
45573
|
+
* @param {ProviderEnum} channel The channel to connect: UberEats, Wolt, WoltStorefront or ResQ. Any other channel is answered 400
|
|
44453
45574
|
* @param {CreateOnboardingSessionDto} createOnboardingSessionDto
|
|
44454
45575
|
* @param {*} [options] Override http request option.
|
|
44455
45576
|
* @throws {RequiredError}
|
|
44456
45577
|
*/
|
|
44457
45578
|
createOnboardingSession(channel: ProviderEnum, createOnboardingSessionDto: CreateOnboardingSessionDto, options?: any): AxiosPromise<OnboardingSessionDto>;
|
|
44458
45579
|
/**
|
|
44459
|
-
* The channel\'s service disconnects the venue, writes its provider row and announces the change; its answer is passed on as it is: Uber Eats\' disconnected store, or wolt-service
|
|
44460
|
-
* @summary Disconnect a venue from Uber Eats or
|
|
44461
|
-
* @param {ProviderEnum} channel The channel to connect: UberEats, Wolt or
|
|
45580
|
+
* The channel\'s service disconnects the venue, writes its provider row and announces the change; its answer is passed on as it is: Uber Eats\' disconnected store, or the message of wolt-service or resq-service.
|
|
45581
|
+
* @summary Disconnect a venue from Uber Eats, Wolt or ResQ
|
|
45582
|
+
* @param {ProviderEnum} channel The channel to connect: UberEats, Wolt, WoltStorefront or ResQ. Any other channel is answered 400
|
|
44462
45583
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
44463
45584
|
* @param {*} [options] Override http request option.
|
|
44464
45585
|
* @throws {RequiredError}
|
|
@@ -44473,9 +45594,9 @@ export declare const ProviderApiFactory: (configuration?: Configuration, basePat
|
|
|
44473
45594
|
*/
|
|
44474
45595
|
getMenuIntegrations(businessId: number, options?: any): AxiosPromise<Array<ProviderIntegrationDto>>;
|
|
44475
45596
|
/**
|
|
44476
|
-
* The channel\'s service answers, and its answer is passed on as it is: Uber Eats\' shape for UberEats, Wolt\'s for Wolt and
|
|
44477
|
-
* @summary Whether a venue is connected to Uber Eats or
|
|
44478
|
-
* @param {ProviderEnum} channel The channel to connect: UberEats, Wolt or
|
|
45597
|
+
* The channel\'s service answers, and its answer is passed on as it is: Uber Eats\' shape for UberEats, Wolt\'s for Wolt, WoltStorefront and ResQ. Not cached: the dashboard acts on it.
|
|
45598
|
+
* @summary Whether a venue is connected to Uber Eats, Wolt or ResQ
|
|
45599
|
+
* @param {ProviderEnum} channel The channel to connect: UberEats, Wolt, WoltStorefront or ResQ. Any other channel is answered 400
|
|
44479
45600
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
44480
45601
|
* @param {*} [options] Override http request option.
|
|
44481
45602
|
* @throws {RequiredError}
|
|
@@ -44517,9 +45638,9 @@ export declare const ProviderApiFactory: (configuration?: Configuration, basePat
|
|
|
44517
45638
|
*/
|
|
44518
45639
|
export interface ProviderApiInterface {
|
|
44519
45640
|
/**
|
|
44520
|
-
* Asks the channel\'s service (ubereats-service for UberEats, wolt-service for Wolt and WoltStorefront) for a sign-in session and answers it as that service answered it. Nothing is written here.
|
|
44521
|
-
* @summary Start connecting a venue to Uber Eats or
|
|
44522
|
-
* @param {ProviderEnum} channel The channel to connect: UberEats, Wolt or
|
|
45641
|
+
* Asks the channel\'s service (ubereats-service for UberEats, wolt-service for Wolt and WoltStorefront, resq-service for ResQ) for a sign-in session and answers it as that service answered it. Nothing is written here.
|
|
45642
|
+
* @summary Start connecting a venue to Uber Eats, Wolt or ResQ
|
|
45643
|
+
* @param {ProviderEnum} channel The channel to connect: UberEats, Wolt, WoltStorefront or ResQ. Any other channel is answered 400
|
|
44523
45644
|
* @param {CreateOnboardingSessionDto} createOnboardingSessionDto
|
|
44524
45645
|
* @param {*} [options] Override http request option.
|
|
44525
45646
|
* @throws {RequiredError}
|
|
@@ -44527,9 +45648,9 @@ export interface ProviderApiInterface {
|
|
|
44527
45648
|
*/
|
|
44528
45649
|
createOnboardingSession(channel: ProviderEnum, createOnboardingSessionDto: CreateOnboardingSessionDto, options?: AxiosRequestConfig): AxiosPromise<OnboardingSessionDto>;
|
|
44529
45650
|
/**
|
|
44530
|
-
* The channel\'s service disconnects the venue, writes its provider row and announces the change; its answer is passed on as it is: Uber Eats\' disconnected store, or wolt-service
|
|
44531
|
-
* @summary Disconnect a venue from Uber Eats or
|
|
44532
|
-
* @param {ProviderEnum} channel The channel to connect: UberEats, Wolt or
|
|
45651
|
+
* The channel\'s service disconnects the venue, writes its provider row and announces the change; its answer is passed on as it is: Uber Eats\' disconnected store, or the message of wolt-service or resq-service.
|
|
45652
|
+
* @summary Disconnect a venue from Uber Eats, Wolt or ResQ
|
|
45653
|
+
* @param {ProviderEnum} channel The channel to connect: UberEats, Wolt, WoltStorefront or ResQ. Any other channel is answered 400
|
|
44533
45654
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
44534
45655
|
* @param {*} [options] Override http request option.
|
|
44535
45656
|
* @throws {RequiredError}
|
|
@@ -44546,9 +45667,9 @@ export interface ProviderApiInterface {
|
|
|
44546
45667
|
*/
|
|
44547
45668
|
getMenuIntegrations(businessId: number, options?: AxiosRequestConfig): AxiosPromise<Array<ProviderIntegrationDto>>;
|
|
44548
45669
|
/**
|
|
44549
|
-
* The channel\'s service answers, and its answer is passed on as it is: Uber Eats\' shape for UberEats, Wolt\'s for Wolt and
|
|
44550
|
-
* @summary Whether a venue is connected to Uber Eats or
|
|
44551
|
-
* @param {ProviderEnum} channel The channel to connect: UberEats, Wolt or
|
|
45670
|
+
* The channel\'s service answers, and its answer is passed on as it is: Uber Eats\' shape for UberEats, Wolt\'s for Wolt, WoltStorefront and ResQ. Not cached: the dashboard acts on it.
|
|
45671
|
+
* @summary Whether a venue is connected to Uber Eats, Wolt or ResQ
|
|
45672
|
+
* @param {ProviderEnum} channel The channel to connect: UberEats, Wolt, WoltStorefront or ResQ. Any other channel is answered 400
|
|
44552
45673
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
44553
45674
|
* @param {*} [options] Override http request option.
|
|
44554
45675
|
* @throws {RequiredError}
|
|
@@ -44595,9 +45716,9 @@ export interface ProviderApiInterface {
|
|
|
44595
45716
|
*/
|
|
44596
45717
|
export declare class ProviderApi extends BaseAPI implements ProviderApiInterface {
|
|
44597
45718
|
/**
|
|
44598
|
-
* Asks the channel\'s service (ubereats-service for UberEats, wolt-service for Wolt and WoltStorefront) for a sign-in session and answers it as that service answered it. Nothing is written here.
|
|
44599
|
-
* @summary Start connecting a venue to Uber Eats or
|
|
44600
|
-
* @param {ProviderEnum} channel The channel to connect: UberEats, Wolt or
|
|
45719
|
+
* Asks the channel\'s service (ubereats-service for UberEats, wolt-service for Wolt and WoltStorefront, resq-service for ResQ) for a sign-in session and answers it as that service answered it. Nothing is written here.
|
|
45720
|
+
* @summary Start connecting a venue to Uber Eats, Wolt or ResQ
|
|
45721
|
+
* @param {ProviderEnum} channel The channel to connect: UberEats, Wolt, WoltStorefront or ResQ. Any other channel is answered 400
|
|
44601
45722
|
* @param {CreateOnboardingSessionDto} createOnboardingSessionDto
|
|
44602
45723
|
* @param {*} [options] Override http request option.
|
|
44603
45724
|
* @throws {RequiredError}
|
|
@@ -44605,9 +45726,9 @@ export declare class ProviderApi extends BaseAPI implements ProviderApiInterface
|
|
|
44605
45726
|
*/
|
|
44606
45727
|
createOnboardingSession(channel: ProviderEnum, createOnboardingSessionDto: CreateOnboardingSessionDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OnboardingSessionDto, any, {}>>;
|
|
44607
45728
|
/**
|
|
44608
|
-
* The channel\'s service disconnects the venue, writes its provider row and announces the change; its answer is passed on as it is: Uber Eats\' disconnected store, or wolt-service
|
|
44609
|
-
* @summary Disconnect a venue from Uber Eats or
|
|
44610
|
-
* @param {ProviderEnum} channel The channel to connect: UberEats, Wolt or
|
|
45729
|
+
* The channel\'s service disconnects the venue, writes its provider row and announces the change; its answer is passed on as it is: Uber Eats\' disconnected store, or the message of wolt-service or resq-service.
|
|
45730
|
+
* @summary Disconnect a venue from Uber Eats, Wolt or ResQ
|
|
45731
|
+
* @param {ProviderEnum} channel The channel to connect: UberEats, Wolt, WoltStorefront or ResQ. Any other channel is answered 400
|
|
44611
45732
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
44612
45733
|
* @param {*} [options] Override http request option.
|
|
44613
45734
|
* @throws {RequiredError}
|
|
@@ -44624,9 +45745,9 @@ export declare class ProviderApi extends BaseAPI implements ProviderApiInterface
|
|
|
44624
45745
|
*/
|
|
44625
45746
|
getMenuIntegrations(businessId: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ProviderIntegrationDto[], any, {}>>;
|
|
44626
45747
|
/**
|
|
44627
|
-
* The channel\'s service answers, and its answer is passed on as it is: Uber Eats\' shape for UberEats, Wolt\'s for Wolt and
|
|
44628
|
-
* @summary Whether a venue is connected to Uber Eats or
|
|
44629
|
-
* @param {ProviderEnum} channel The channel to connect: UberEats, Wolt or
|
|
45748
|
+
* The channel\'s service answers, and its answer is passed on as it is: Uber Eats\' shape for UberEats, Wolt\'s for Wolt, WoltStorefront and ResQ. Not cached: the dashboard acts on it.
|
|
45749
|
+
* @summary Whether a venue is connected to Uber Eats, Wolt or ResQ
|
|
45750
|
+
* @param {ProviderEnum} channel The channel to connect: UberEats, Wolt, WoltStorefront or ResQ. Any other channel is answered 400
|
|
44630
45751
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
44631
45752
|
* @param {*} [options] Override http request option.
|
|
44632
45753
|
* @throws {RequiredError}
|
|
@@ -44674,21 +45795,21 @@ export declare const ReceiptFooterApiAxiosParamCreator: (configuration?: Configu
|
|
|
44674
45795
|
* The footer the venue\'s tills on this channel print on the documents it applies to; the till reads it when it starts. Kept 30 days per venue and channel, the absence of a footer too, and invalidated for every channel of the venue when one of its footers is saved.
|
|
44675
45796
|
* @summary Get the receipt footer config for a business + channel
|
|
44676
45797
|
* @param {number} businessId The venue whose footer is read or written: its orderingBusinessId
|
|
44677
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose footer is read or written; each channel of a venue has its own footer
|
|
45798
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose footer is read or written; each channel of a venue has its own footer
|
|
44678
45799
|
* @param {*} [options] Override http request option.
|
|
44679
45800
|
* @throws {RequiredError}
|
|
44680
45801
|
*/
|
|
44681
|
-
receiptFooterGetConfig: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay", options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
45802
|
+
receiptFooterGetConfig: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
44682
45803
|
/**
|
|
44683
45804
|
* Saves the venue\'s footer for the channel, replacing both fields; it is created on the first save. Once saved, the venue\'s kept footers are invalidated, every channel at once, and the venue\'s tills on that channel are told over Ably to sync RECEIPT_FOOTER. If the invalidation fails, the save still answers 200, the tills are still told, and the failure is logged as an error: the tills then read the old footer until it expires (up to 30 days) or POST v1/config-management/business/:businessId/sync (configManualSync) with RECEIPT_FOOTER clears it.
|
|
44684
45805
|
* @summary Create or update the receipt footer config for a business + channel
|
|
44685
45806
|
* @param {number} businessId The venue whose footer is read or written: its orderingBusinessId
|
|
44686
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose footer is read or written; each channel of a venue has its own footer
|
|
45807
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose footer is read or written; each channel of a venue has its own footer
|
|
44687
45808
|
* @param {UpsertReceiptFooterDto} upsertReceiptFooterDto
|
|
44688
45809
|
* @param {*} [options] Override http request option.
|
|
44689
45810
|
* @throws {RequiredError}
|
|
44690
45811
|
*/
|
|
44691
|
-
receiptFooterUpsertConfig: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay", upsertReceiptFooterDto: UpsertReceiptFooterDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
45812
|
+
receiptFooterUpsertConfig: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertReceiptFooterDto: UpsertReceiptFooterDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
44692
45813
|
};
|
|
44693
45814
|
/**
|
|
44694
45815
|
* ReceiptFooterApi - functional programming interface
|
|
@@ -44699,21 +45820,21 @@ export declare const ReceiptFooterApiFp: (configuration?: Configuration) => {
|
|
|
44699
45820
|
* The footer the venue\'s tills on this channel print on the documents it applies to; the till reads it when it starts. Kept 30 days per venue and channel, the absence of a footer too, and invalidated for every channel of the venue when one of its footers is saved.
|
|
44700
45821
|
* @summary Get the receipt footer config for a business + channel
|
|
44701
45822
|
* @param {number} businessId The venue whose footer is read or written: its orderingBusinessId
|
|
44702
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose footer is read or written; each channel of a venue has its own footer
|
|
45823
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose footer is read or written; each channel of a venue has its own footer
|
|
44703
45824
|
* @param {*} [options] Override http request option.
|
|
44704
45825
|
* @throws {RequiredError}
|
|
44705
45826
|
*/
|
|
44706
|
-
receiptFooterGetConfig(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay", options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReceiptFooterConfigDto>>;
|
|
45827
|
+
receiptFooterGetConfig(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReceiptFooterConfigDto>>;
|
|
44707
45828
|
/**
|
|
44708
45829
|
* Saves the venue\'s footer for the channel, replacing both fields; it is created on the first save. Once saved, the venue\'s kept footers are invalidated, every channel at once, and the venue\'s tills on that channel are told over Ably to sync RECEIPT_FOOTER. If the invalidation fails, the save still answers 200, the tills are still told, and the failure is logged as an error: the tills then read the old footer until it expires (up to 30 days) or POST v1/config-management/business/:businessId/sync (configManualSync) with RECEIPT_FOOTER clears it.
|
|
44709
45830
|
* @summary Create or update the receipt footer config for a business + channel
|
|
44710
45831
|
* @param {number} businessId The venue whose footer is read or written: its orderingBusinessId
|
|
44711
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose footer is read or written; each channel of a venue has its own footer
|
|
45832
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose footer is read or written; each channel of a venue has its own footer
|
|
44712
45833
|
* @param {UpsertReceiptFooterDto} upsertReceiptFooterDto
|
|
44713
45834
|
* @param {*} [options] Override http request option.
|
|
44714
45835
|
* @throws {RequiredError}
|
|
44715
45836
|
*/
|
|
44716
|
-
receiptFooterUpsertConfig(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay", upsertReceiptFooterDto: UpsertReceiptFooterDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReceiptFooterConfigDto>>;
|
|
45837
|
+
receiptFooterUpsertConfig(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertReceiptFooterDto: UpsertReceiptFooterDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReceiptFooterConfigDto>>;
|
|
44717
45838
|
};
|
|
44718
45839
|
/**
|
|
44719
45840
|
* ReceiptFooterApi - factory interface
|
|
@@ -44724,21 +45845,21 @@ export declare const ReceiptFooterApiFactory: (configuration?: Configuration, ba
|
|
|
44724
45845
|
* The footer the venue\'s tills on this channel print on the documents it applies to; the till reads it when it starts. Kept 30 days per venue and channel, the absence of a footer too, and invalidated for every channel of the venue when one of its footers is saved.
|
|
44725
45846
|
* @summary Get the receipt footer config for a business + channel
|
|
44726
45847
|
* @param {number} businessId The venue whose footer is read or written: its orderingBusinessId
|
|
44727
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose footer is read or written; each channel of a venue has its own footer
|
|
45848
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose footer is read or written; each channel of a venue has its own footer
|
|
44728
45849
|
* @param {*} [options] Override http request option.
|
|
44729
45850
|
* @throws {RequiredError}
|
|
44730
45851
|
*/
|
|
44731
|
-
receiptFooterGetConfig(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay", options?: any): AxiosPromise<ReceiptFooterConfigDto>;
|
|
45852
|
+
receiptFooterGetConfig(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", options?: any): AxiosPromise<ReceiptFooterConfigDto>;
|
|
44732
45853
|
/**
|
|
44733
45854
|
* Saves the venue\'s footer for the channel, replacing both fields; it is created on the first save. Once saved, the venue\'s kept footers are invalidated, every channel at once, and the venue\'s tills on that channel are told over Ably to sync RECEIPT_FOOTER. If the invalidation fails, the save still answers 200, the tills are still told, and the failure is logged as an error: the tills then read the old footer until it expires (up to 30 days) or POST v1/config-management/business/:businessId/sync (configManualSync) with RECEIPT_FOOTER clears it.
|
|
44734
45855
|
* @summary Create or update the receipt footer config for a business + channel
|
|
44735
45856
|
* @param {number} businessId The venue whose footer is read or written: its orderingBusinessId
|
|
44736
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose footer is read or written; each channel of a venue has its own footer
|
|
45857
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose footer is read or written; each channel of a venue has its own footer
|
|
44737
45858
|
* @param {UpsertReceiptFooterDto} upsertReceiptFooterDto
|
|
44738
45859
|
* @param {*} [options] Override http request option.
|
|
44739
45860
|
* @throws {RequiredError}
|
|
44740
45861
|
*/
|
|
44741
|
-
receiptFooterUpsertConfig(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay", upsertReceiptFooterDto: UpsertReceiptFooterDto, options?: any): AxiosPromise<ReceiptFooterConfigDto>;
|
|
45862
|
+
receiptFooterUpsertConfig(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertReceiptFooterDto: UpsertReceiptFooterDto, options?: any): AxiosPromise<ReceiptFooterConfigDto>;
|
|
44742
45863
|
};
|
|
44743
45864
|
/**
|
|
44744
45865
|
* ReceiptFooterApi - interface
|
|
@@ -44750,23 +45871,23 @@ export interface ReceiptFooterApiInterface {
|
|
|
44750
45871
|
* The footer the venue\'s tills on this channel print on the documents it applies to; the till reads it when it starts. Kept 30 days per venue and channel, the absence of a footer too, and invalidated for every channel of the venue when one of its footers is saved.
|
|
44751
45872
|
* @summary Get the receipt footer config for a business + channel
|
|
44752
45873
|
* @param {number} businessId The venue whose footer is read or written: its orderingBusinessId
|
|
44753
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose footer is read or written; each channel of a venue has its own footer
|
|
45874
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose footer is read or written; each channel of a venue has its own footer
|
|
44754
45875
|
* @param {*} [options] Override http request option.
|
|
44755
45876
|
* @throws {RequiredError}
|
|
44756
45877
|
* @memberof ReceiptFooterApiInterface
|
|
44757
45878
|
*/
|
|
44758
|
-
receiptFooterGetConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', options?: AxiosRequestConfig): AxiosPromise<ReceiptFooterConfigDto>;
|
|
45879
|
+
receiptFooterGetConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', options?: AxiosRequestConfig): AxiosPromise<ReceiptFooterConfigDto>;
|
|
44759
45880
|
/**
|
|
44760
45881
|
* Saves the venue\'s footer for the channel, replacing both fields; it is created on the first save. Once saved, the venue\'s kept footers are invalidated, every channel at once, and the venue\'s tills on that channel are told over Ably to sync RECEIPT_FOOTER. If the invalidation fails, the save still answers 200, the tills are still told, and the failure is logged as an error: the tills then read the old footer until it expires (up to 30 days) or POST v1/config-management/business/:businessId/sync (configManualSync) with RECEIPT_FOOTER clears it.
|
|
44761
45882
|
* @summary Create or update the receipt footer config for a business + channel
|
|
44762
45883
|
* @param {number} businessId The venue whose footer is read or written: its orderingBusinessId
|
|
44763
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose footer is read or written; each channel of a venue has its own footer
|
|
45884
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose footer is read or written; each channel of a venue has its own footer
|
|
44764
45885
|
* @param {UpsertReceiptFooterDto} upsertReceiptFooterDto
|
|
44765
45886
|
* @param {*} [options] Override http request option.
|
|
44766
45887
|
* @throws {RequiredError}
|
|
44767
45888
|
* @memberof ReceiptFooterApiInterface
|
|
44768
45889
|
*/
|
|
44769
|
-
receiptFooterUpsertConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', upsertReceiptFooterDto: UpsertReceiptFooterDto, options?: AxiosRequestConfig): AxiosPromise<ReceiptFooterConfigDto>;
|
|
45890
|
+
receiptFooterUpsertConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertReceiptFooterDto: UpsertReceiptFooterDto, options?: AxiosRequestConfig): AxiosPromise<ReceiptFooterConfigDto>;
|
|
44770
45891
|
}
|
|
44771
45892
|
/**
|
|
44772
45893
|
* ReceiptFooterApi - object-oriented interface
|
|
@@ -44779,23 +45900,23 @@ export declare class ReceiptFooterApi extends BaseAPI implements ReceiptFooterAp
|
|
|
44779
45900
|
* The footer the venue\'s tills on this channel print on the documents it applies to; the till reads it when it starts. Kept 30 days per venue and channel, the absence of a footer too, and invalidated for every channel of the venue when one of its footers is saved.
|
|
44780
45901
|
* @summary Get the receipt footer config for a business + channel
|
|
44781
45902
|
* @param {number} businessId The venue whose footer is read or written: its orderingBusinessId
|
|
44782
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose footer is read or written; each channel of a venue has its own footer
|
|
45903
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose footer is read or written; each channel of a venue has its own footer
|
|
44783
45904
|
* @param {*} [options] Override http request option.
|
|
44784
45905
|
* @throws {RequiredError}
|
|
44785
45906
|
* @memberof ReceiptFooterApi
|
|
44786
45907
|
*/
|
|
44787
|
-
receiptFooterGetConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ReceiptFooterConfigDto, any, {}>>;
|
|
45908
|
+
receiptFooterGetConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ReceiptFooterConfigDto, any, {}>>;
|
|
44788
45909
|
/**
|
|
44789
45910
|
* Saves the venue\'s footer for the channel, replacing both fields; it is created on the first save. Once saved, the venue\'s kept footers are invalidated, every channel at once, and the venue\'s tills on that channel are told over Ably to sync RECEIPT_FOOTER. If the invalidation fails, the save still answers 200, the tills are still told, and the failure is logged as an error: the tills then read the old footer until it expires (up to 30 days) or POST v1/config-management/business/:businessId/sync (configManualSync) with RECEIPT_FOOTER clears it.
|
|
44790
45911
|
* @summary Create or update the receipt footer config for a business + channel
|
|
44791
45912
|
* @param {number} businessId The venue whose footer is read or written: its orderingBusinessId
|
|
44792
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose footer is read or written; each channel of a venue has its own footer
|
|
45913
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose footer is read or written; each channel of a venue has its own footer
|
|
44793
45914
|
* @param {UpsertReceiptFooterDto} upsertReceiptFooterDto
|
|
44794
45915
|
* @param {*} [options] Override http request option.
|
|
44795
45916
|
* @throws {RequiredError}
|
|
44796
45917
|
* @memberof ReceiptFooterApi
|
|
44797
45918
|
*/
|
|
44798
|
-
receiptFooterUpsertConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', upsertReceiptFooterDto: UpsertReceiptFooterDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ReceiptFooterConfigDto, any, {}>>;
|
|
45919
|
+
receiptFooterUpsertConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertReceiptFooterDto: UpsertReceiptFooterDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ReceiptFooterConfigDto, any, {}>>;
|
|
44799
45920
|
}
|
|
44800
45921
|
/**
|
|
44801
45922
|
* RefundsApi - axios parameter creator
|