@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/generated/api.ts
CHANGED
|
@@ -154,6 +154,68 @@ export const ActionsEnum = {
|
|
|
154
154
|
export type ActionsEnum = typeof ActionsEnum[keyof typeof ActionsEnum];
|
|
155
155
|
|
|
156
156
|
|
|
157
|
+
/**
|
|
158
|
+
*
|
|
159
|
+
* @export
|
|
160
|
+
* @interface AddEmployeeDto
|
|
161
|
+
*/
|
|
162
|
+
export interface AddEmployeeDto {
|
|
163
|
+
/**
|
|
164
|
+
* The employee\'s phone, in international format. Null clears it.
|
|
165
|
+
* @type {object}
|
|
166
|
+
* @memberof AddEmployeeDto
|
|
167
|
+
*/
|
|
168
|
+
'phone'?: object | null;
|
|
169
|
+
/**
|
|
170
|
+
* A photo of the employee, shown on the till\'s PIN screen. Null clears it.
|
|
171
|
+
* @type {object}
|
|
172
|
+
* @memberof AddEmployeeDto
|
|
173
|
+
*/
|
|
174
|
+
'photoUrl'?: object | null;
|
|
175
|
+
/**
|
|
176
|
+
* The employee\'s name, as the till shows it
|
|
177
|
+
* @type {string}
|
|
178
|
+
* @memberof AddEmployeeDto
|
|
179
|
+
*/
|
|
180
|
+
'name': string;
|
|
181
|
+
/**
|
|
182
|
+
* 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.
|
|
183
|
+
* @type {string}
|
|
184
|
+
* @memberof AddEmployeeDto
|
|
185
|
+
*/
|
|
186
|
+
'pin': string;
|
|
187
|
+
/**
|
|
188
|
+
* 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.
|
|
189
|
+
* @type {string}
|
|
190
|
+
* @memberof AddEmployeeDto
|
|
191
|
+
*/
|
|
192
|
+
'email': string;
|
|
193
|
+
/**
|
|
194
|
+
* 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.
|
|
195
|
+
* @type {Array<EmployeeAssignmentDto>}
|
|
196
|
+
* @memberof AddEmployeeDto
|
|
197
|
+
*/
|
|
198
|
+
'assignments': Array<EmployeeAssignmentDto>;
|
|
199
|
+
}
|
|
200
|
+
/**
|
|
201
|
+
*
|
|
202
|
+
* @export
|
|
203
|
+
* @interface AddEmployeeRoleDto
|
|
204
|
+
*/
|
|
205
|
+
export interface AddEmployeeRoleDto {
|
|
206
|
+
/**
|
|
207
|
+
* The role\'s name, as the staff see it on the till; unique at the venue
|
|
208
|
+
* @type {string}
|
|
209
|
+
* @memberof AddEmployeeRoleDto
|
|
210
|
+
*/
|
|
211
|
+
'name': string;
|
|
212
|
+
/**
|
|
213
|
+
* 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.
|
|
214
|
+
* @type {Array<PosPermission>}
|
|
215
|
+
* @memberof AddEmployeeRoleDto
|
|
216
|
+
*/
|
|
217
|
+
'permissionKeys': Array<PosPermission>;
|
|
218
|
+
}
|
|
157
219
|
/**
|
|
158
220
|
*
|
|
159
221
|
* @export
|
|
@@ -2315,6 +2377,70 @@ export const CdsSessionRole = {
|
|
|
2315
2377
|
export type CdsSessionRole = typeof CdsSessionRole[keyof typeof CdsSessionRole];
|
|
2316
2378
|
|
|
2317
2379
|
|
|
2380
|
+
/**
|
|
2381
|
+
*
|
|
2382
|
+
* @export
|
|
2383
|
+
* @interface ChangeEmployeeDto
|
|
2384
|
+
*/
|
|
2385
|
+
export interface ChangeEmployeeDto {
|
|
2386
|
+
/**
|
|
2387
|
+
* The employee\'s phone, in international format. Null clears it.
|
|
2388
|
+
* @type {object}
|
|
2389
|
+
* @memberof ChangeEmployeeDto
|
|
2390
|
+
*/
|
|
2391
|
+
'phone'?: object | null;
|
|
2392
|
+
/**
|
|
2393
|
+
* A photo of the employee, shown on the till\'s PIN screen. Null clears it.
|
|
2394
|
+
* @type {object}
|
|
2395
|
+
* @memberof ChangeEmployeeDto
|
|
2396
|
+
*/
|
|
2397
|
+
'photoUrl'?: object | null;
|
|
2398
|
+
/**
|
|
2399
|
+
* The employee\'s new name. Absent: the name stays.
|
|
2400
|
+
* @type {string}
|
|
2401
|
+
* @memberof ChangeEmployeeDto
|
|
2402
|
+
*/
|
|
2403
|
+
'name'?: string;
|
|
2404
|
+
/**
|
|
2405
|
+
* 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.
|
|
2406
|
+
* @type {string}
|
|
2407
|
+
* @memberof ChangeEmployeeDto
|
|
2408
|
+
*/
|
|
2409
|
+
'pin'?: string;
|
|
2410
|
+
/**
|
|
2411
|
+
* 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.
|
|
2412
|
+
* @type {string}
|
|
2413
|
+
* @memberof ChangeEmployeeDto
|
|
2414
|
+
*/
|
|
2415
|
+
'email'?: string;
|
|
2416
|
+
/**
|
|
2417
|
+
*
|
|
2418
|
+
* @type {Status}
|
|
2419
|
+
* @memberof ChangeEmployeeDto
|
|
2420
|
+
*/
|
|
2421
|
+
'status'?: Status;
|
|
2422
|
+
}
|
|
2423
|
+
|
|
2424
|
+
|
|
2425
|
+
/**
|
|
2426
|
+
*
|
|
2427
|
+
* @export
|
|
2428
|
+
* @interface ChangeEmployeeRoleDto
|
|
2429
|
+
*/
|
|
2430
|
+
export interface ChangeEmployeeRoleDto {
|
|
2431
|
+
/**
|
|
2432
|
+
* The role\'s new name; unique at the venue. Absent: the name stays.
|
|
2433
|
+
* @type {string}
|
|
2434
|
+
* @memberof ChangeEmployeeRoleDto
|
|
2435
|
+
*/
|
|
2436
|
+
'name'?: string;
|
|
2437
|
+
/**
|
|
2438
|
+
* 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.
|
|
2439
|
+
* @type {Array<PosPermission>}
|
|
2440
|
+
* @memberof ChangeEmployeeRoleDto
|
|
2441
|
+
*/
|
|
2442
|
+
'permissionKeys'?: Array<PosPermission>;
|
|
2443
|
+
}
|
|
2318
2444
|
/**
|
|
2319
2445
|
*
|
|
2320
2446
|
* @export
|
|
@@ -2460,7 +2586,8 @@ export const ChannelEnum = {
|
|
|
2460
2586
|
Kiosk: 'Kiosk',
|
|
2461
2587
|
WoltStorefront: 'WoltStorefront',
|
|
2462
2588
|
Storefront: 'Storefront',
|
|
2463
|
-
MunchiPay: 'MunchiPay'
|
|
2589
|
+
MunchiPay: 'MunchiPay',
|
|
2590
|
+
ResQ: 'ResQ'
|
|
2464
2591
|
} as const;
|
|
2465
2592
|
|
|
2466
2593
|
export type ChannelEnum = typeof ChannelEnum[keyof typeof ChannelEnum];
|
|
@@ -3139,6 +3266,33 @@ export interface ConfirmPreorderDto {
|
|
|
3139
3266
|
}
|
|
3140
3267
|
|
|
3141
3268
|
|
|
3269
|
+
/**
|
|
3270
|
+
*
|
|
3271
|
+
* @export
|
|
3272
|
+
* @interface ConnectDeliveryPlatformDto
|
|
3273
|
+
*/
|
|
3274
|
+
export interface ConnectDeliveryPlatformDto {
|
|
3275
|
+
/**
|
|
3276
|
+
*
|
|
3277
|
+
* @type {DeliveryPlatformOpsConnect}
|
|
3278
|
+
* @memberof ConnectDeliveryPlatformDto
|
|
3279
|
+
*/
|
|
3280
|
+
'channel': DeliveryPlatformOpsConnect;
|
|
3281
|
+
/**
|
|
3282
|
+
* 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
|
|
3283
|
+
* @type {string}
|
|
3284
|
+
* @memberof ConnectDeliveryPlatformDto
|
|
3285
|
+
*/
|
|
3286
|
+
'externalId': string;
|
|
3287
|
+
/**
|
|
3288
|
+
* 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
|
|
3289
|
+
* @type {boolean}
|
|
3290
|
+
* @memberof ConnectDeliveryPlatformDto
|
|
3291
|
+
*/
|
|
3292
|
+
'autoAccept'?: boolean;
|
|
3293
|
+
}
|
|
3294
|
+
|
|
3295
|
+
|
|
3142
3296
|
/**
|
|
3143
3297
|
*
|
|
3144
3298
|
* @export
|
|
@@ -3152,6 +3306,51 @@ export interface ConnectTerminalDto {
|
|
|
3152
3306
|
*/
|
|
3153
3307
|
'terminalHardwareId': string;
|
|
3154
3308
|
}
|
|
3309
|
+
/**
|
|
3310
|
+
*
|
|
3311
|
+
* @export
|
|
3312
|
+
* @interface ConnectedDeliveryPlatformDto
|
|
3313
|
+
*/
|
|
3314
|
+
export interface ConnectedDeliveryPlatformDto {
|
|
3315
|
+
/**
|
|
3316
|
+
* The Munchi venue id (orderingBusinessId)
|
|
3317
|
+
* @type {number}
|
|
3318
|
+
* @memberof ConnectedDeliveryPlatformDto
|
|
3319
|
+
*/
|
|
3320
|
+
'venueId': number;
|
|
3321
|
+
/**
|
|
3322
|
+
*
|
|
3323
|
+
* @type {DeliveryPlatformOpsConnect}
|
|
3324
|
+
* @memberof ConnectedDeliveryPlatformDto
|
|
3325
|
+
*/
|
|
3326
|
+
'channel': DeliveryPlatformOpsConnect;
|
|
3327
|
+
/**
|
|
3328
|
+
* The platform\'s store id, the row\'s externalId
|
|
3329
|
+
* @type {string}
|
|
3330
|
+
* @memberof ConnectedDeliveryPlatformDto
|
|
3331
|
+
*/
|
|
3332
|
+
'externalId': string;
|
|
3333
|
+
/**
|
|
3334
|
+
* Whether the row is active; always true once connected
|
|
3335
|
+
* @type {boolean}
|
|
3336
|
+
* @memberof ConnectedDeliveryPlatformDto
|
|
3337
|
+
*/
|
|
3338
|
+
'isActive': boolean;
|
|
3339
|
+
/**
|
|
3340
|
+
* Whether the till accepts the platform\'s orders on its own
|
|
3341
|
+
* @type {boolean}
|
|
3342
|
+
* @memberof ConnectedDeliveryPlatformDto
|
|
3343
|
+
*/
|
|
3344
|
+
'autoAccept': boolean;
|
|
3345
|
+
/**
|
|
3346
|
+
*
|
|
3347
|
+
* @type {DeliveryPlatformConnection}
|
|
3348
|
+
* @memberof ConnectedDeliveryPlatformDto
|
|
3349
|
+
*/
|
|
3350
|
+
'connection': DeliveryPlatformConnection;
|
|
3351
|
+
}
|
|
3352
|
+
|
|
3353
|
+
|
|
3155
3354
|
/**
|
|
3156
3355
|
*
|
|
3157
3356
|
* @export
|
|
@@ -5428,6 +5627,35 @@ export const DeliveryIntentStatus = {
|
|
|
5428
5627
|
export type DeliveryIntentStatus = typeof DeliveryIntentStatus[keyof typeof DeliveryIntentStatus];
|
|
5429
5628
|
|
|
5430
5629
|
|
|
5630
|
+
/**
|
|
5631
|
+
*
|
|
5632
|
+
* @export
|
|
5633
|
+
* @enum {string}
|
|
5634
|
+
*/
|
|
5635
|
+
|
|
5636
|
+
export const DeliveryPlatformConnection = {
|
|
5637
|
+
Created: 'created',
|
|
5638
|
+
Reactivated: 'reactivated',
|
|
5639
|
+
AlreadyActive: 'already_active'
|
|
5640
|
+
} as const;
|
|
5641
|
+
|
|
5642
|
+
export type DeliveryPlatformConnection = typeof DeliveryPlatformConnection[keyof typeof DeliveryPlatformConnection];
|
|
5643
|
+
|
|
5644
|
+
|
|
5645
|
+
/**
|
|
5646
|
+
*
|
|
5647
|
+
* @export
|
|
5648
|
+
* @enum {string}
|
|
5649
|
+
*/
|
|
5650
|
+
|
|
5651
|
+
export const DeliveryPlatformOpsConnect = {
|
|
5652
|
+
Foodora: 'Foodora',
|
|
5653
|
+
Bolt: 'Bolt'
|
|
5654
|
+
} as const;
|
|
5655
|
+
|
|
5656
|
+
export type DeliveryPlatformOpsConnect = typeof DeliveryPlatformOpsConnect[keyof typeof DeliveryPlatformOpsConnect];
|
|
5657
|
+
|
|
5658
|
+
|
|
5431
5659
|
/**
|
|
5432
5660
|
*
|
|
5433
5661
|
* @export
|
|
@@ -5631,6 +5859,33 @@ export interface DiningTableResponseDto {
|
|
|
5631
5859
|
*/
|
|
5632
5860
|
export type DisconnectOnboarding200Response = DisconnectedUberEatsStoreDto | DisconnectedWoltVenueDto;
|
|
5633
5861
|
|
|
5862
|
+
/**
|
|
5863
|
+
*
|
|
5864
|
+
* @export
|
|
5865
|
+
* @interface DisconnectedDeliveryPlatformDto
|
|
5866
|
+
*/
|
|
5867
|
+
export interface DisconnectedDeliveryPlatformDto {
|
|
5868
|
+
/**
|
|
5869
|
+
* The Munchi venue id (orderingBusinessId)
|
|
5870
|
+
* @type {number}
|
|
5871
|
+
* @memberof DisconnectedDeliveryPlatformDto
|
|
5872
|
+
*/
|
|
5873
|
+
'venueId': number;
|
|
5874
|
+
/**
|
|
5875
|
+
*
|
|
5876
|
+
* @type {DeliveryPlatformOpsConnect}
|
|
5877
|
+
* @memberof DisconnectedDeliveryPlatformDto
|
|
5878
|
+
*/
|
|
5879
|
+
'channel': DeliveryPlatformOpsConnect;
|
|
5880
|
+
/**
|
|
5881
|
+
* 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
|
|
5882
|
+
* @type {Array<string>}
|
|
5883
|
+
* @memberof DisconnectedDeliveryPlatformDto
|
|
5884
|
+
*/
|
|
5885
|
+
'externalIds': Array<string>;
|
|
5886
|
+
}
|
|
5887
|
+
|
|
5888
|
+
|
|
5634
5889
|
/**
|
|
5635
5890
|
*
|
|
5636
5891
|
* @export
|
|
@@ -6050,6 +6305,25 @@ export interface DisplayInitResponseDto {
|
|
|
6050
6305
|
*/
|
|
6051
6306
|
'ablyTokenRequest': object;
|
|
6052
6307
|
}
|
|
6308
|
+
/**
|
|
6309
|
+
*
|
|
6310
|
+
* @export
|
|
6311
|
+
* @interface EmployeeAssignmentDto
|
|
6312
|
+
*/
|
|
6313
|
+
export interface EmployeeAssignmentDto {
|
|
6314
|
+
/**
|
|
6315
|
+
* A venue the employee works at: its orderingBusinessId
|
|
6316
|
+
* @type {number}
|
|
6317
|
+
* @memberof EmployeeAssignmentDto
|
|
6318
|
+
*/
|
|
6319
|
+
'businessId': number;
|
|
6320
|
+
/**
|
|
6321
|
+
* The employee\'s role at that venue: one of that venue\'s roles
|
|
6322
|
+
* @type {string}
|
|
6323
|
+
* @memberof EmployeeAssignmentDto
|
|
6324
|
+
*/
|
|
6325
|
+
'roleId': string;
|
|
6326
|
+
}
|
|
6053
6327
|
/**
|
|
6054
6328
|
*
|
|
6055
6329
|
* @export
|
|
@@ -6063,6 +6337,107 @@ export interface EmployeeEventProcessedDto {
|
|
|
6063
6337
|
*/
|
|
6064
6338
|
'message': string;
|
|
6065
6339
|
}
|
|
6340
|
+
/**
|
|
6341
|
+
*
|
|
6342
|
+
* @export
|
|
6343
|
+
* @interface EmployeePageResponseDto
|
|
6344
|
+
*/
|
|
6345
|
+
export interface EmployeePageResponseDto {
|
|
6346
|
+
/**
|
|
6347
|
+
* The page\'s employees, ordered by name
|
|
6348
|
+
* @type {Array<EmployeeResponseDto>}
|
|
6349
|
+
* @memberof EmployeePageResponseDto
|
|
6350
|
+
*/
|
|
6351
|
+
'employees': Array<EmployeeResponseDto>;
|
|
6352
|
+
/**
|
|
6353
|
+
* The cursor of the next page; null on the last page
|
|
6354
|
+
* @type {string}
|
|
6355
|
+
* @memberof EmployeePageResponseDto
|
|
6356
|
+
*/
|
|
6357
|
+
'nextCursor': string | null;
|
|
6358
|
+
}
|
|
6359
|
+
/**
|
|
6360
|
+
*
|
|
6361
|
+
* @export
|
|
6362
|
+
* @interface EmployeeResponseDto
|
|
6363
|
+
*/
|
|
6364
|
+
export interface EmployeeResponseDto {
|
|
6365
|
+
/**
|
|
6366
|
+
* The employee\'s id
|
|
6367
|
+
* @type {string}
|
|
6368
|
+
* @memberof EmployeeResponseDto
|
|
6369
|
+
*/
|
|
6370
|
+
'id': string;
|
|
6371
|
+
/**
|
|
6372
|
+
* The employee\'s name, as the till shows it
|
|
6373
|
+
* @type {string}
|
|
6374
|
+
* @memberof EmployeeResponseDto
|
|
6375
|
+
*/
|
|
6376
|
+
'name': string;
|
|
6377
|
+
/**
|
|
6378
|
+
*
|
|
6379
|
+
* @type {Status}
|
|
6380
|
+
* @memberof EmployeeResponseDto
|
|
6381
|
+
*/
|
|
6382
|
+
'status': Status;
|
|
6383
|
+
/**
|
|
6384
|
+
* The employee\'s e-mail, in lower case; null only for an employee added before e-mails were required (D145)
|
|
6385
|
+
* @type {string}
|
|
6386
|
+
* @memberof EmployeeResponseDto
|
|
6387
|
+
*/
|
|
6388
|
+
'email': string | null;
|
|
6389
|
+
/**
|
|
6390
|
+
* The employee\'s phone; null when none
|
|
6391
|
+
* @type {string}
|
|
6392
|
+
* @memberof EmployeeResponseDto
|
|
6393
|
+
*/
|
|
6394
|
+
'phone': string | null;
|
|
6395
|
+
/**
|
|
6396
|
+
* The employee\'s photo; null when none
|
|
6397
|
+
* @type {string}
|
|
6398
|
+
* @memberof EmployeeResponseDto
|
|
6399
|
+
*/
|
|
6400
|
+
'photoUrl': string | null;
|
|
6401
|
+
/**
|
|
6402
|
+
* 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.
|
|
6403
|
+
* @type {Array<EmployeeAssignmentDto>}
|
|
6404
|
+
* @memberof EmployeeResponseDto
|
|
6405
|
+
*/
|
|
6406
|
+
'assignments': Array<EmployeeAssignmentDto>;
|
|
6407
|
+
}
|
|
6408
|
+
|
|
6409
|
+
|
|
6410
|
+
/**
|
|
6411
|
+
*
|
|
6412
|
+
* @export
|
|
6413
|
+
* @interface EmployeeRoleResponseDto
|
|
6414
|
+
*/
|
|
6415
|
+
export interface EmployeeRoleResponseDto {
|
|
6416
|
+
/**
|
|
6417
|
+
* The role\'s id
|
|
6418
|
+
* @type {string}
|
|
6419
|
+
* @memberof EmployeeRoleResponseDto
|
|
6420
|
+
*/
|
|
6421
|
+
'id': string;
|
|
6422
|
+
/**
|
|
6423
|
+
* The role\'s name, as the staff see it on the till
|
|
6424
|
+
* @type {string}
|
|
6425
|
+
* @memberof EmployeeRoleResponseDto
|
|
6426
|
+
*/
|
|
6427
|
+
'name': string;
|
|
6428
|
+
/**
|
|
6429
|
+
* The POS keys the role holds. A key stored by an older back office that the POS no longer knows is left out.
|
|
6430
|
+
* @type {Array<PosPermission>}
|
|
6431
|
+
* @memberof EmployeeRoleResponseDto
|
|
6432
|
+
*/
|
|
6433
|
+
'permissionKeys': Array<PosPermission>;
|
|
6434
|
+
/**
|
|
6435
|
+
* How many employees hold the role at the venue; a role is removed only when none does
|
|
6436
|
+
* @type {number}
|
|
6437
|
+
* @memberof EmployeeRoleResponseDto
|
|
6438
|
+
*/
|
|
6439
|
+
'employeeCount': number;
|
|
6440
|
+
}
|
|
6066
6441
|
/**
|
|
6067
6442
|
*
|
|
6068
6443
|
* @export
|
|
@@ -17473,6 +17848,19 @@ export interface PaymentSessionAnalyticsResponseDtoResolvedRange {
|
|
|
17473
17848
|
*/
|
|
17474
17849
|
'end': string;
|
|
17475
17850
|
}
|
|
17851
|
+
/**
|
|
17852
|
+
*
|
|
17853
|
+
* @export
|
|
17854
|
+
* @interface PaymentSessionCurrencyDto
|
|
17855
|
+
*/
|
|
17856
|
+
export interface PaymentSessionCurrencyDto {
|
|
17857
|
+
/**
|
|
17858
|
+
* The ISO 4217 code of the currency the payment session was taken in, as stored on the session (`PaymentSession.currency`)
|
|
17859
|
+
* @type {string}
|
|
17860
|
+
* @memberof PaymentSessionCurrencyDto
|
|
17861
|
+
*/
|
|
17862
|
+
'currency': string;
|
|
17863
|
+
}
|
|
17476
17864
|
/**
|
|
17477
17865
|
*
|
|
17478
17866
|
* @export
|
|
@@ -22250,7 +22638,8 @@ export const ProviderEnum = {
|
|
|
22250
22638
|
Kiosk: 'Kiosk',
|
|
22251
22639
|
WoltStorefront: 'WoltStorefront',
|
|
22252
22640
|
Storefront: 'Storefront',
|
|
22253
|
-
MunchiPay: 'MunchiPay'
|
|
22641
|
+
MunchiPay: 'MunchiPay',
|
|
22642
|
+
ResQ: 'ResQ'
|
|
22254
22643
|
} as const;
|
|
22255
22644
|
|
|
22256
22645
|
export type ProviderEnum = typeof ProviderEnum[keyof typeof ProviderEnum];
|
|
@@ -25660,6 +26049,19 @@ export interface SendReportEmailDto {
|
|
|
25660
26049
|
}
|
|
25661
26050
|
|
|
25662
26051
|
|
|
26052
|
+
/**
|
|
26053
|
+
*
|
|
26054
|
+
* @export
|
|
26055
|
+
* @interface SetEmployeeRoleDto
|
|
26056
|
+
*/
|
|
26057
|
+
export interface SetEmployeeRoleDto {
|
|
26058
|
+
/**
|
|
26059
|
+
* The employee\'s role at the venue: one of the venue\'s roles. Replaces the role they had there.
|
|
26060
|
+
* @type {string}
|
|
26061
|
+
* @memberof SetEmployeeRoleDto
|
|
26062
|
+
*/
|
|
26063
|
+
'roleId': string;
|
|
26064
|
+
}
|
|
25663
26065
|
/**
|
|
25664
26066
|
*
|
|
25665
26067
|
* @export
|
|
@@ -31945,6 +32347,21 @@ export interface VendureSellerUpsertDto {
|
|
|
31945
32347
|
*/
|
|
31946
32348
|
'schedule'?: Array<object>;
|
|
31947
32349
|
}
|
|
32350
|
+
/**
|
|
32351
|
+
*
|
|
32352
|
+
* @export
|
|
32353
|
+
* @interface VenueCurrencyDto
|
|
32354
|
+
*/
|
|
32355
|
+
export interface VenueCurrencyDto {
|
|
32356
|
+
/**
|
|
32357
|
+
*
|
|
32358
|
+
* @type {CurrencyCode}
|
|
32359
|
+
* @memberof VenueCurrencyDto
|
|
32360
|
+
*/
|
|
32361
|
+
'currency': CurrencyCode;
|
|
32362
|
+
}
|
|
32363
|
+
|
|
32364
|
+
|
|
31948
32365
|
/**
|
|
31949
32366
|
*
|
|
31950
32367
|
* @export
|
|
@@ -36098,6 +36515,44 @@ export const BusinessApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
36098
36515
|
|
|
36099
36516
|
|
|
36100
36517
|
|
|
36518
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
36519
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
36520
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
36521
|
+
|
|
36522
|
+
return {
|
|
36523
|
+
url: toPathString(localVarUrlObj),
|
|
36524
|
+
options: localVarRequestOptions,
|
|
36525
|
+
};
|
|
36526
|
+
},
|
|
36527
|
+
/**
|
|
36528
|
+
* 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).
|
|
36529
|
+
* @summary Get the currency the venue sells in
|
|
36530
|
+
* @param {number} businessId The venue\'s business id (orderingBusinessId)
|
|
36531
|
+
* @param {*} [options] Override http request option.
|
|
36532
|
+
* @throws {RequiredError}
|
|
36533
|
+
*/
|
|
36534
|
+
getVenueCurrency: async (businessId: number, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
36535
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
36536
|
+
assertParamExists('getVenueCurrency', 'businessId', businessId)
|
|
36537
|
+
const localVarPath = `/api/v1/business/{businessId}/currency`
|
|
36538
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)));
|
|
36539
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
36540
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
36541
|
+
let baseOptions;
|
|
36542
|
+
if (configuration) {
|
|
36543
|
+
baseOptions = configuration.baseOptions;
|
|
36544
|
+
}
|
|
36545
|
+
|
|
36546
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
36547
|
+
const localVarHeaderParameter = {} as any;
|
|
36548
|
+
const localVarQueryParameter = {} as any;
|
|
36549
|
+
|
|
36550
|
+
// authentication JWT-auth required
|
|
36551
|
+
// http bearer authentication required
|
|
36552
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
36553
|
+
|
|
36554
|
+
|
|
36555
|
+
|
|
36101
36556
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
36102
36557
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
36103
36558
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -36370,6 +36825,17 @@ export const BusinessApiFp = function(configuration?: Configuration) {
|
|
|
36370
36825
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getSingleBusinessProviderStatus(businessId, provider, externalId, options);
|
|
36371
36826
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
36372
36827
|
},
|
|
36828
|
+
/**
|
|
36829
|
+
* 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).
|
|
36830
|
+
* @summary Get the currency the venue sells in
|
|
36831
|
+
* @param {number} businessId The venue\'s business id (orderingBusinessId)
|
|
36832
|
+
* @param {*} [options] Override http request option.
|
|
36833
|
+
* @throws {RequiredError}
|
|
36834
|
+
*/
|
|
36835
|
+
async getVenueCurrency(businessId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueCurrencyDto>> {
|
|
36836
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getVenueCurrency(businessId, options);
|
|
36837
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
36838
|
+
},
|
|
36373
36839
|
/**
|
|
36374
36840
|
* 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.
|
|
36375
36841
|
* @summary Open or close one of the venue\'s sales channels
|
|
@@ -36555,6 +37021,16 @@ export const BusinessApiFactory = function (configuration?: Configuration, baseP
|
|
|
36555
37021
|
getSingleBusinessProviderStatus(businessId: string, provider: ProviderEnum, externalId: string, options?: any): AxiosPromise<SingleProviderStatusResponseDto> {
|
|
36556
37022
|
return localVarFp.getSingleBusinessProviderStatus(businessId, provider, externalId, options).then((request) => request(axios, basePath));
|
|
36557
37023
|
},
|
|
37024
|
+
/**
|
|
37025
|
+
* 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).
|
|
37026
|
+
* @summary Get the currency the venue sells in
|
|
37027
|
+
* @param {number} businessId The venue\'s business id (orderingBusinessId)
|
|
37028
|
+
* @param {*} [options] Override http request option.
|
|
37029
|
+
* @throws {RequiredError}
|
|
37030
|
+
*/
|
|
37031
|
+
getVenueCurrency(businessId: number, options?: any): AxiosPromise<VenueCurrencyDto> {
|
|
37032
|
+
return localVarFp.getVenueCurrency(businessId, options).then((request) => request(axios, basePath));
|
|
37033
|
+
},
|
|
36558
37034
|
/**
|
|
36559
37035
|
* 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.
|
|
36560
37036
|
* @summary Open or close one of the venue\'s sales channels
|
|
@@ -36737,6 +37213,16 @@ export interface BusinessApiInterface {
|
|
|
36737
37213
|
*/
|
|
36738
37214
|
getSingleBusinessProviderStatus(businessId: string, provider: ProviderEnum, externalId: string, options?: AxiosRequestConfig): AxiosPromise<SingleProviderStatusResponseDto>;
|
|
36739
37215
|
|
|
37216
|
+
/**
|
|
37217
|
+
* 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).
|
|
37218
|
+
* @summary Get the currency the venue sells in
|
|
37219
|
+
* @param {number} businessId The venue\'s business id (orderingBusinessId)
|
|
37220
|
+
* @param {*} [options] Override http request option.
|
|
37221
|
+
* @throws {RequiredError}
|
|
37222
|
+
* @memberof BusinessApiInterface
|
|
37223
|
+
*/
|
|
37224
|
+
getVenueCurrency(businessId: number, options?: AxiosRequestConfig): AxiosPromise<VenueCurrencyDto>;
|
|
37225
|
+
|
|
36740
37226
|
/**
|
|
36741
37227
|
* 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.
|
|
36742
37228
|
* @summary Open or close one of the venue\'s sales channels
|
|
@@ -36947,6 +37433,18 @@ export class BusinessApi extends BaseAPI implements BusinessApiInterface {
|
|
|
36947
37433
|
return BusinessApiFp(this.configuration).getSingleBusinessProviderStatus(businessId, provider, externalId, options).then((request) => request(this.axios, this.basePath));
|
|
36948
37434
|
}
|
|
36949
37435
|
|
|
37436
|
+
/**
|
|
37437
|
+
* 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).
|
|
37438
|
+
* @summary Get the currency the venue sells in
|
|
37439
|
+
* @param {number} businessId The venue\'s business id (orderingBusinessId)
|
|
37440
|
+
* @param {*} [options] Override http request option.
|
|
37441
|
+
* @throws {RequiredError}
|
|
37442
|
+
* @memberof BusinessApi
|
|
37443
|
+
*/
|
|
37444
|
+
public getVenueCurrency(businessId: number, options?: AxiosRequestConfig) {
|
|
37445
|
+
return BusinessApiFp(this.configuration).getVenueCurrency(businessId, options).then((request) => request(this.axios, this.basePath));
|
|
37446
|
+
}
|
|
37447
|
+
|
|
36950
37448
|
/**
|
|
36951
37449
|
* 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.
|
|
36952
37450
|
* @summary Open or close one of the venue\'s sales channels
|
|
@@ -37360,11 +37858,11 @@ export const CashManagementApiAxiosParamCreator = function (configuration?: Conf
|
|
|
37360
37858
|
* @param {string} businessId The venue\'s id (its orderingBusinessId), as text
|
|
37361
37859
|
* @param {string} sessionId The cash session\'s id
|
|
37362
37860
|
* @param {SendCashReportDto} sendCashReportDto
|
|
37363
|
-
* @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.
|
|
37861
|
+
* @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.
|
|
37364
37862
|
* @param {*} [options] Override http request option.
|
|
37365
37863
|
* @throws {RequiredError}
|
|
37366
37864
|
*/
|
|
37367
|
-
sendSessionReport: async (businessId: string, sessionId: string, sendCashReportDto: SendCashReportDto, xAppX?: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
37865
|
+
sendSessionReport: async (businessId: string, sessionId: string, sendCashReportDto: SendCashReportDto, xAppX?: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
37368
37866
|
// verify required parameter 'businessId' is not null or undefined
|
|
37369
37867
|
assertParamExists('sendSessionReport', 'businessId', businessId)
|
|
37370
37868
|
// verify required parameter 'sessionId' is not null or undefined
|
|
@@ -37487,11 +37985,11 @@ export const CashManagementApiFp = function(configuration?: Configuration) {
|
|
|
37487
37985
|
* @param {string} businessId The venue\'s id (its orderingBusinessId), as text
|
|
37488
37986
|
* @param {string} sessionId The cash session\'s id
|
|
37489
37987
|
* @param {SendCashReportDto} sendCashReportDto
|
|
37490
|
-
* @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.
|
|
37988
|
+
* @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.
|
|
37491
37989
|
* @param {*} [options] Override http request option.
|
|
37492
37990
|
* @throws {RequiredError}
|
|
37493
37991
|
*/
|
|
37494
|
-
async 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>> {
|
|
37992
|
+
async sendSessionReport(businessId: string, sessionId: string, sendCashReportDto: SendCashReportDto, xAppX?: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CashReportSentDto>> {
|
|
37495
37993
|
const localVarAxiosArgs = await localVarAxiosParamCreator.sendSessionReport(businessId, sessionId, sendCashReportDto, xAppX, options);
|
|
37496
37994
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
37497
37995
|
},
|
|
@@ -37570,11 +38068,11 @@ export const CashManagementApiFactory = function (configuration?: Configuration,
|
|
|
37570
38068
|
* @param {string} businessId The venue\'s id (its orderingBusinessId), as text
|
|
37571
38069
|
* @param {string} sessionId The cash session\'s id
|
|
37572
38070
|
* @param {SendCashReportDto} sendCashReportDto
|
|
37573
|
-
* @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.
|
|
38071
|
+
* @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.
|
|
37574
38072
|
* @param {*} [options] Override http request option.
|
|
37575
38073
|
* @throws {RequiredError}
|
|
37576
38074
|
*/
|
|
37577
|
-
sendSessionReport(businessId: string, sessionId: string, sendCashReportDto: SendCashReportDto, xAppX?: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', options?: any): AxiosPromise<CashReportSentDto> {
|
|
38075
|
+
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> {
|
|
37578
38076
|
return localVarFp.sendSessionReport(businessId, sessionId, sendCashReportDto, xAppX, options).then((request) => request(axios, basePath));
|
|
37579
38077
|
},
|
|
37580
38078
|
};
|
|
@@ -37651,12 +38149,12 @@ export interface CashManagementApiInterface {
|
|
|
37651
38149
|
* @param {string} businessId The venue\'s id (its orderingBusinessId), as text
|
|
37652
38150
|
* @param {string} sessionId The cash session\'s id
|
|
37653
38151
|
* @param {SendCashReportDto} sendCashReportDto
|
|
37654
|
-
* @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.
|
|
38152
|
+
* @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.
|
|
37655
38153
|
* @param {*} [options] Override http request option.
|
|
37656
38154
|
* @throws {RequiredError}
|
|
37657
38155
|
* @memberof CashManagementApiInterface
|
|
37658
38156
|
*/
|
|
37659
|
-
sendSessionReport(businessId: string, sessionId: string, sendCashReportDto: SendCashReportDto, xAppX?: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', options?: AxiosRequestConfig): AxiosPromise<CashReportSentDto>;
|
|
38157
|
+
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>;
|
|
37660
38158
|
|
|
37661
38159
|
}
|
|
37662
38160
|
|
|
@@ -37742,12 +38240,12 @@ export class CashManagementApi extends BaseAPI implements CashManagementApiInter
|
|
|
37742
38240
|
* @param {string} businessId The venue\'s id (its orderingBusinessId), as text
|
|
37743
38241
|
* @param {string} sessionId The cash session\'s id
|
|
37744
38242
|
* @param {SendCashReportDto} sendCashReportDto
|
|
37745
|
-
* @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.
|
|
38243
|
+
* @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.
|
|
37746
38244
|
* @param {*} [options] Override http request option.
|
|
37747
38245
|
* @throws {RequiredError}
|
|
37748
38246
|
* @memberof CashManagementApi
|
|
37749
38247
|
*/
|
|
37750
|
-
public sendSessionReport(businessId: string, sessionId: string, sendCashReportDto: SendCashReportDto, xAppX?: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', options?: AxiosRequestConfig) {
|
|
38248
|
+
public sendSessionReport(businessId: string, sessionId: string, sendCashReportDto: SendCashReportDto, xAppX?: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', options?: AxiosRequestConfig) {
|
|
37751
38249
|
return CashManagementApiFp(this.configuration).sendSessionReport(businessId, sessionId, sendCashReportDto, xAppX, options).then((request) => request(this.axios, this.basePath));
|
|
37752
38250
|
}
|
|
37753
38251
|
}
|
|
@@ -38409,12 +38907,12 @@ export const ConfigManagementApiAxiosParamCreator = function (configuration?: Co
|
|
|
38409
38907
|
* 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.
|
|
38410
38908
|
* @summary Enable or disable first-party Munchi GiftCard integration
|
|
38411
38909
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
38412
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
38910
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
38413
38911
|
* @param {ConfigureMunchiGiftCardDto} configureMunchiGiftCardDto
|
|
38414
38912
|
* @param {*} [options] Override http request option.
|
|
38415
38913
|
* @throws {RequiredError}
|
|
38416
38914
|
*/
|
|
38417
|
-
configConfigureMunchiGiftCard: async (businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', configureMunchiGiftCardDto: ConfigureMunchiGiftCardDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
38915
|
+
configConfigureMunchiGiftCard: async (businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', configureMunchiGiftCardDto: ConfigureMunchiGiftCardDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
38418
38916
|
// verify required parameter 'businessId' is not null or undefined
|
|
38419
38917
|
assertParamExists('configConfigureMunchiGiftCard', 'businessId', businessId)
|
|
38420
38918
|
// verify required parameter 'xAppX' is not null or undefined
|
|
@@ -38460,11 +38958,11 @@ export const ConfigManagementApiAxiosParamCreator = function (configuration?: Co
|
|
|
38460
38958
|
* 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).
|
|
38461
38959
|
* @summary Read a channel\'s card payment providers
|
|
38462
38960
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
38463
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
38961
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
38464
38962
|
* @param {*} [options] Override http request option.
|
|
38465
38963
|
* @throws {RequiredError}
|
|
38466
38964
|
*/
|
|
38467
|
-
configGetProviders: async (businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
38965
|
+
configGetProviders: async (businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
38468
38966
|
// verify required parameter 'businessId' is not null or undefined
|
|
38469
38967
|
assertParamExists('configGetProviders', 'businessId', businessId)
|
|
38470
38968
|
// verify required parameter 'xAppX' is not null or undefined
|
|
@@ -38550,11 +39048,11 @@ export const ConfigManagementApiAxiosParamCreator = function (configuration?: Co
|
|
|
38550
39048
|
* @summary Remove payment option
|
|
38551
39049
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
38552
39050
|
* @param {string} id The payment option\'s id
|
|
38553
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
39051
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
38554
39052
|
* @param {*} [options] Override http request option.
|
|
38555
39053
|
* @throws {RequiredError}
|
|
38556
39054
|
*/
|
|
38557
|
-
configRemovePaymentOption: async (businessId: number, id: string, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
39055
|
+
configRemovePaymentOption: async (businessId: number, id: string, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
38558
39056
|
// verify required parameter 'businessId' is not null or undefined
|
|
38559
39057
|
assertParamExists('configRemovePaymentOption', 'businessId', businessId)
|
|
38560
39058
|
// verify required parameter 'id' is not null or undefined
|
|
@@ -38598,13 +39096,13 @@ export const ConfigManagementApiAxiosParamCreator = function (configuration?: Co
|
|
|
38598
39096
|
* 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.
|
|
38599
39097
|
* @summary Save a channel\'s Epassi credentials and answer the public key to send Epassi
|
|
38600
39098
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
38601
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
39099
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
38602
39100
|
* @param {string} xEpassiAccessKey The access key Epassi issued for this venue; Epassi issues a different one for test and production.
|
|
38603
39101
|
* @param {SaveEpassiCredentialsDto} saveEpassiCredentialsDto
|
|
38604
39102
|
* @param {*} [options] Override http request option.
|
|
38605
39103
|
* @throws {RequiredError}
|
|
38606
39104
|
*/
|
|
38607
|
-
configSaveEpassiCredentials: async (businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', xEpassiAccessKey: string, saveEpassiCredentialsDto: SaveEpassiCredentialsDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
39105
|
+
configSaveEpassiCredentials: async (businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', xEpassiAccessKey: string, saveEpassiCredentialsDto: SaveEpassiCredentialsDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
38608
39106
|
// verify required parameter 'businessId' is not null or undefined
|
|
38609
39107
|
assertParamExists('configSaveEpassiCredentials', 'businessId', businessId)
|
|
38610
39108
|
// verify required parameter 'xAppX' is not null or undefined
|
|
@@ -38700,12 +39198,12 @@ export const ConfigManagementApiAxiosParamCreator = function (configuration?: Co
|
|
|
38700
39198
|
* 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.
|
|
38701
39199
|
* @summary Create or update a channel\'s config
|
|
38702
39200
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
38703
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
39201
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
38704
39202
|
* @param {UpsertConfigDto} upsertConfigDto
|
|
38705
39203
|
* @param {*} [options] Override http request option.
|
|
38706
39204
|
* @throws {RequiredError}
|
|
38707
39205
|
*/
|
|
38708
|
-
configUpsertChannelConfig: async (businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', upsertConfigDto: UpsertConfigDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
39206
|
+
configUpsertChannelConfig: async (businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertConfigDto: UpsertConfigDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
38709
39207
|
// verify required parameter 'businessId' is not null or undefined
|
|
38710
39208
|
assertParamExists('configUpsertChannelConfig', 'businessId', businessId)
|
|
38711
39209
|
// verify required parameter 'xAppX' is not null or undefined
|
|
@@ -38751,12 +39249,12 @@ export const ConfigManagementApiAxiosParamCreator = function (configuration?: Co
|
|
|
38751
39249
|
* 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.
|
|
38752
39250
|
* @summary Create or update a channel\'s third-party gift card integration
|
|
38753
39251
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
38754
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
39252
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
38755
39253
|
* @param {UpsertGiftCardDto} upsertGiftCardDto
|
|
38756
39254
|
* @param {*} [options] Override http request option.
|
|
38757
39255
|
* @throws {RequiredError}
|
|
38758
39256
|
*/
|
|
38759
|
-
configUpsertGiftCard: async (businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', upsertGiftCardDto: UpsertGiftCardDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
39257
|
+
configUpsertGiftCard: async (businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertGiftCardDto: UpsertGiftCardDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
38760
39258
|
// verify required parameter 'businessId' is not null or undefined
|
|
38761
39259
|
assertParamExists('configUpsertGiftCard', 'businessId', businessId)
|
|
38762
39260
|
// verify required parameter 'xAppX' is not null or undefined
|
|
@@ -38846,12 +39344,12 @@ export const ConfigManagementApiAxiosParamCreator = function (configuration?: Co
|
|
|
38846
39344
|
* Creates the channel\'s config first if it has none. Saved active unless isActive is sent. The cached Nets config and token are cleared.
|
|
38847
39345
|
* @summary Create or update a channel\'s Nets config
|
|
38848
39346
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
38849
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
39347
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
38850
39348
|
* @param {UpsertNetsDto} upsertNetsDto
|
|
38851
39349
|
* @param {*} [options] Override http request option.
|
|
38852
39350
|
* @throws {RequiredError}
|
|
38853
39351
|
*/
|
|
38854
|
-
configUpsertNets: async (businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', upsertNetsDto: UpsertNetsDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
39352
|
+
configUpsertNets: async (businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertNetsDto: UpsertNetsDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
38855
39353
|
// verify required parameter 'businessId' is not null or undefined
|
|
38856
39354
|
assertParamExists('configUpsertNets', 'businessId', businessId)
|
|
38857
39355
|
// verify required parameter 'xAppX' is not null or undefined
|
|
@@ -38897,12 +39395,12 @@ export const ConfigManagementApiAxiosParamCreator = function (configuration?: Co
|
|
|
38897
39395
|
* 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.
|
|
38898
39396
|
* @summary Create or update a channel\'s checkout payment options
|
|
38899
39397
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
38900
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
39398
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
38901
39399
|
* @param {UpsertPaymentOptionsDto} upsertPaymentOptionsDto
|
|
38902
39400
|
* @param {*} [options] Override http request option.
|
|
38903
39401
|
* @throws {RequiredError}
|
|
38904
39402
|
*/
|
|
38905
|
-
configUpsertPaymentOptions: async (businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', upsertPaymentOptionsDto: UpsertPaymentOptionsDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
39403
|
+
configUpsertPaymentOptions: async (businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertPaymentOptionsDto: UpsertPaymentOptionsDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
38906
39404
|
// verify required parameter 'businessId' is not null or undefined
|
|
38907
39405
|
assertParamExists('configUpsertPaymentOptions', 'businessId', businessId)
|
|
38908
39406
|
// verify required parameter 'xAppX' is not null or undefined
|
|
@@ -38948,12 +39446,12 @@ export const ConfigManagementApiAxiosParamCreator = function (configuration?: Co
|
|
|
38948
39446
|
* 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.
|
|
38949
39447
|
* @summary Set active provider and upsert its credentials
|
|
38950
39448
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
38951
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
39449
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
38952
39450
|
* @param {UpsertProvidersDto} upsertProvidersDto
|
|
38953
39451
|
* @param {*} [options] Override http request option.
|
|
38954
39452
|
* @throws {RequiredError}
|
|
38955
39453
|
*/
|
|
38956
|
-
configUpsertProviders: async (businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', upsertProvidersDto: UpsertProvidersDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
39454
|
+
configUpsertProviders: async (businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertProvidersDto: UpsertProvidersDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
38957
39455
|
// verify required parameter 'businessId' is not null or undefined
|
|
38958
39456
|
assertParamExists('configUpsertProviders', 'businessId', businessId)
|
|
38959
39457
|
// verify required parameter 'xAppX' is not null or undefined
|
|
@@ -38999,12 +39497,12 @@ export const ConfigManagementApiAxiosParamCreator = function (configuration?: Co
|
|
|
38999
39497
|
* Creates the channel\'s config first if it has none. Saved active unless isActive is sent. The cached Stripe config is cleared.
|
|
39000
39498
|
* @summary Create or update a channel\'s Stripe config
|
|
39001
39499
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
39002
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
39500
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
39003
39501
|
* @param {UpsertStripeDto} upsertStripeDto
|
|
39004
39502
|
* @param {*} [options] Override http request option.
|
|
39005
39503
|
* @throws {RequiredError}
|
|
39006
39504
|
*/
|
|
39007
|
-
configUpsertStripe: async (businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', upsertStripeDto: UpsertStripeDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
39505
|
+
configUpsertStripe: async (businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertStripeDto: UpsertStripeDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
39008
39506
|
// verify required parameter 'businessId' is not null or undefined
|
|
39009
39507
|
assertParamExists('configUpsertStripe', 'businessId', businessId)
|
|
39010
39508
|
// verify required parameter 'xAppX' is not null or undefined
|
|
@@ -39050,12 +39548,12 @@ export const ConfigManagementApiAxiosParamCreator = function (configuration?: Co
|
|
|
39050
39548
|
* 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.
|
|
39051
39549
|
* @summary Create or update a channel\'s Viva config
|
|
39052
39550
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
39053
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
39551
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
39054
39552
|
* @param {UpsertVivaDto} upsertVivaDto
|
|
39055
39553
|
* @param {*} [options] Override http request option.
|
|
39056
39554
|
* @throws {RequiredError}
|
|
39057
39555
|
*/
|
|
39058
|
-
configUpsertViva: async (businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', upsertVivaDto: UpsertVivaDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
39556
|
+
configUpsertViva: async (businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertVivaDto: UpsertVivaDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
39059
39557
|
// verify required parameter 'businessId' is not null or undefined
|
|
39060
39558
|
assertParamExists('configUpsertViva', 'businessId', businessId)
|
|
39061
39559
|
// verify required parameter 'xAppX' is not null or undefined
|
|
@@ -39111,12 +39609,12 @@ export const ConfigManagementApiFp = function(configuration?: Configuration) {
|
|
|
39111
39609
|
* 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.
|
|
39112
39610
|
* @summary Enable or disable first-party Munchi GiftCard integration
|
|
39113
39611
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
39114
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
39612
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
39115
39613
|
* @param {ConfigureMunchiGiftCardDto} configureMunchiGiftCardDto
|
|
39116
39614
|
* @param {*} [options] Override http request option.
|
|
39117
39615
|
* @throws {RequiredError}
|
|
39118
39616
|
*/
|
|
39119
|
-
async 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>> {
|
|
39617
|
+
async configConfigureMunchiGiftCard(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', configureMunchiGiftCardDto: ConfigureMunchiGiftCardDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfigManagementResponseDto>> {
|
|
39120
39618
|
const localVarAxiosArgs = await localVarAxiosParamCreator.configConfigureMunchiGiftCard(businessId, xAppX, configureMunchiGiftCardDto, options);
|
|
39121
39619
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
39122
39620
|
},
|
|
@@ -39124,11 +39622,11 @@ export const ConfigManagementApiFp = function(configuration?: Configuration) {
|
|
|
39124
39622
|
* 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).
|
|
39125
39623
|
* @summary Read a channel\'s card payment providers
|
|
39126
39624
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
39127
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
39625
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
39128
39626
|
* @param {*} [options] Override http request option.
|
|
39129
39627
|
* @throws {RequiredError}
|
|
39130
39628
|
*/
|
|
39131
|
-
async 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>> {
|
|
39629
|
+
async configGetProviders(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProvidersConfigResponseDto>> {
|
|
39132
39630
|
const localVarAxiosArgs = await localVarAxiosParamCreator.configGetProviders(businessId, xAppX, options);
|
|
39133
39631
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
39134
39632
|
},
|
|
@@ -39149,11 +39647,11 @@ export const ConfigManagementApiFp = function(configuration?: Configuration) {
|
|
|
39149
39647
|
* @summary Remove payment option
|
|
39150
39648
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
39151
39649
|
* @param {string} id The payment option\'s id
|
|
39152
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
39650
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
39153
39651
|
* @param {*} [options] Override http request option.
|
|
39154
39652
|
* @throws {RequiredError}
|
|
39155
39653
|
*/
|
|
39156
|
-
async 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>> {
|
|
39654
|
+
async configRemovePaymentOption(businessId: number, id: string, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfigManagementResponseDto>> {
|
|
39157
39655
|
const localVarAxiosArgs = await localVarAxiosParamCreator.configRemovePaymentOption(businessId, id, xAppX, options);
|
|
39158
39656
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
39159
39657
|
},
|
|
@@ -39161,13 +39659,13 @@ export const ConfigManagementApiFp = function(configuration?: Configuration) {
|
|
|
39161
39659
|
* 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.
|
|
39162
39660
|
* @summary Save a channel\'s Epassi credentials and answer the public key to send Epassi
|
|
39163
39661
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
39164
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
39662
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
39165
39663
|
* @param {string} xEpassiAccessKey The access key Epassi issued for this venue; Epassi issues a different one for test and production.
|
|
39166
39664
|
* @param {SaveEpassiCredentialsDto} saveEpassiCredentialsDto
|
|
39167
39665
|
* @param {*} [options] Override http request option.
|
|
39168
39666
|
* @throws {RequiredError}
|
|
39169
39667
|
*/
|
|
39170
|
-
async 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>> {
|
|
39668
|
+
async configSaveEpassiCredentials(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', xEpassiAccessKey: string, saveEpassiCredentialsDto: SaveEpassiCredentialsDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EpassiCredentialsSavedDto>> {
|
|
39171
39669
|
const localVarAxiosArgs = await localVarAxiosParamCreator.configSaveEpassiCredentials(businessId, xAppX, xEpassiAccessKey, saveEpassiCredentialsDto, options);
|
|
39172
39670
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
39173
39671
|
},
|
|
@@ -39187,12 +39685,12 @@ export const ConfigManagementApiFp = function(configuration?: Configuration) {
|
|
|
39187
39685
|
* 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.
|
|
39188
39686
|
* @summary Create or update a channel\'s config
|
|
39189
39687
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
39190
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
39688
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
39191
39689
|
* @param {UpsertConfigDto} upsertConfigDto
|
|
39192
39690
|
* @param {*} [options] Override http request option.
|
|
39193
39691
|
* @throws {RequiredError}
|
|
39194
39692
|
*/
|
|
39195
|
-
async 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>> {
|
|
39693
|
+
async configUpsertChannelConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertConfigDto: UpsertConfigDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfigManagementResponseDto>> {
|
|
39196
39694
|
const localVarAxiosArgs = await localVarAxiosParamCreator.configUpsertChannelConfig(businessId, xAppX, upsertConfigDto, options);
|
|
39197
39695
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
39198
39696
|
},
|
|
@@ -39200,12 +39698,12 @@ export const ConfigManagementApiFp = function(configuration?: Configuration) {
|
|
|
39200
39698
|
* 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.
|
|
39201
39699
|
* @summary Create or update a channel\'s third-party gift card integration
|
|
39202
39700
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
39203
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
39701
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
39204
39702
|
* @param {UpsertGiftCardDto} upsertGiftCardDto
|
|
39205
39703
|
* @param {*} [options] Override http request option.
|
|
39206
39704
|
* @throws {RequiredError}
|
|
39207
39705
|
*/
|
|
39208
|
-
async 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>> {
|
|
39706
|
+
async configUpsertGiftCard(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertGiftCardDto: UpsertGiftCardDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfigManagementResponseDto>> {
|
|
39209
39707
|
const localVarAxiosArgs = await localVarAxiosParamCreator.configUpsertGiftCard(businessId, xAppX, upsertGiftCardDto, options);
|
|
39210
39708
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
39211
39709
|
},
|
|
@@ -39225,12 +39723,12 @@ export const ConfigManagementApiFp = function(configuration?: Configuration) {
|
|
|
39225
39723
|
* Creates the channel\'s config first if it has none. Saved active unless isActive is sent. The cached Nets config and token are cleared.
|
|
39226
39724
|
* @summary Create or update a channel\'s Nets config
|
|
39227
39725
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
39228
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
39726
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
39229
39727
|
* @param {UpsertNetsDto} upsertNetsDto
|
|
39230
39728
|
* @param {*} [options] Override http request option.
|
|
39231
39729
|
* @throws {RequiredError}
|
|
39232
39730
|
*/
|
|
39233
|
-
async 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>> {
|
|
39731
|
+
async configUpsertNets(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertNetsDto: UpsertNetsDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfigManagementResponseDto>> {
|
|
39234
39732
|
const localVarAxiosArgs = await localVarAxiosParamCreator.configUpsertNets(businessId, xAppX, upsertNetsDto, options);
|
|
39235
39733
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
39236
39734
|
},
|
|
@@ -39238,12 +39736,12 @@ export const ConfigManagementApiFp = function(configuration?: Configuration) {
|
|
|
39238
39736
|
* 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.
|
|
39239
39737
|
* @summary Create or update a channel\'s checkout payment options
|
|
39240
39738
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
39241
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
39739
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
39242
39740
|
* @param {UpsertPaymentOptionsDto} upsertPaymentOptionsDto
|
|
39243
39741
|
* @param {*} [options] Override http request option.
|
|
39244
39742
|
* @throws {RequiredError}
|
|
39245
39743
|
*/
|
|
39246
|
-
async 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>> {
|
|
39744
|
+
async configUpsertPaymentOptions(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertPaymentOptionsDto: UpsertPaymentOptionsDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfigManagementResponseDto>> {
|
|
39247
39745
|
const localVarAxiosArgs = await localVarAxiosParamCreator.configUpsertPaymentOptions(businessId, xAppX, upsertPaymentOptionsDto, options);
|
|
39248
39746
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
39249
39747
|
},
|
|
@@ -39251,12 +39749,12 @@ export const ConfigManagementApiFp = function(configuration?: Configuration) {
|
|
|
39251
39749
|
* 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.
|
|
39252
39750
|
* @summary Set active provider and upsert its credentials
|
|
39253
39751
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
39254
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
39752
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
39255
39753
|
* @param {UpsertProvidersDto} upsertProvidersDto
|
|
39256
39754
|
* @param {*} [options] Override http request option.
|
|
39257
39755
|
* @throws {RequiredError}
|
|
39258
39756
|
*/
|
|
39259
|
-
async 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>> {
|
|
39757
|
+
async configUpsertProviders(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertProvidersDto: UpsertProvidersDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProvidersConfigResponseDto>> {
|
|
39260
39758
|
const localVarAxiosArgs = await localVarAxiosParamCreator.configUpsertProviders(businessId, xAppX, upsertProvidersDto, options);
|
|
39261
39759
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
39262
39760
|
},
|
|
@@ -39264,12 +39762,12 @@ export const ConfigManagementApiFp = function(configuration?: Configuration) {
|
|
|
39264
39762
|
* Creates the channel\'s config first if it has none. Saved active unless isActive is sent. The cached Stripe config is cleared.
|
|
39265
39763
|
* @summary Create or update a channel\'s Stripe config
|
|
39266
39764
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
39267
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
39765
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
39268
39766
|
* @param {UpsertStripeDto} upsertStripeDto
|
|
39269
39767
|
* @param {*} [options] Override http request option.
|
|
39270
39768
|
* @throws {RequiredError}
|
|
39271
39769
|
*/
|
|
39272
|
-
async 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>> {
|
|
39770
|
+
async configUpsertStripe(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertStripeDto: UpsertStripeDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfigManagementResponseDto>> {
|
|
39273
39771
|
const localVarAxiosArgs = await localVarAxiosParamCreator.configUpsertStripe(businessId, xAppX, upsertStripeDto, options);
|
|
39274
39772
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
39275
39773
|
},
|
|
@@ -39277,12 +39775,12 @@ export const ConfigManagementApiFp = function(configuration?: Configuration) {
|
|
|
39277
39775
|
* 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.
|
|
39278
39776
|
* @summary Create or update a channel\'s Viva config
|
|
39279
39777
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
39280
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
39778
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
39281
39779
|
* @param {UpsertVivaDto} upsertVivaDto
|
|
39282
39780
|
* @param {*} [options] Override http request option.
|
|
39283
39781
|
* @throws {RequiredError}
|
|
39284
39782
|
*/
|
|
39285
|
-
async 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>> {
|
|
39783
|
+
async configUpsertViva(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertVivaDto: UpsertVivaDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfigManagementResponseDto>> {
|
|
39286
39784
|
const localVarAxiosArgs = await localVarAxiosParamCreator.configUpsertViva(businessId, xAppX, upsertVivaDto, options);
|
|
39287
39785
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
39288
39786
|
},
|
|
@@ -39300,23 +39798,23 @@ export const ConfigManagementApiFactory = function (configuration?: Configuratio
|
|
|
39300
39798
|
* 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.
|
|
39301
39799
|
* @summary Enable or disable first-party Munchi GiftCard integration
|
|
39302
39800
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
39303
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
39801
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
39304
39802
|
* @param {ConfigureMunchiGiftCardDto} configureMunchiGiftCardDto
|
|
39305
39803
|
* @param {*} [options] Override http request option.
|
|
39306
39804
|
* @throws {RequiredError}
|
|
39307
39805
|
*/
|
|
39308
|
-
configConfigureMunchiGiftCard(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', configureMunchiGiftCardDto: ConfigureMunchiGiftCardDto, options?: any): AxiosPromise<ConfigManagementResponseDto> {
|
|
39806
|
+
configConfigureMunchiGiftCard(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', configureMunchiGiftCardDto: ConfigureMunchiGiftCardDto, options?: any): AxiosPromise<ConfigManagementResponseDto> {
|
|
39309
39807
|
return localVarFp.configConfigureMunchiGiftCard(businessId, xAppX, configureMunchiGiftCardDto, options).then((request) => request(axios, basePath));
|
|
39310
39808
|
},
|
|
39311
39809
|
/**
|
|
39312
39810
|
* 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).
|
|
39313
39811
|
* @summary Read a channel\'s card payment providers
|
|
39314
39812
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
39315
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
39813
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
39316
39814
|
* @param {*} [options] Override http request option.
|
|
39317
39815
|
* @throws {RequiredError}
|
|
39318
39816
|
*/
|
|
39319
|
-
configGetProviders(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', options?: any): AxiosPromise<ProvidersConfigResponseDto> {
|
|
39817
|
+
configGetProviders(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', options?: any): AxiosPromise<ProvidersConfigResponseDto> {
|
|
39320
39818
|
return localVarFp.configGetProviders(businessId, xAppX, options).then((request) => request(axios, basePath));
|
|
39321
39819
|
},
|
|
39322
39820
|
/**
|
|
@@ -39335,24 +39833,24 @@ export const ConfigManagementApiFactory = function (configuration?: Configuratio
|
|
|
39335
39833
|
* @summary Remove payment option
|
|
39336
39834
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
39337
39835
|
* @param {string} id The payment option\'s id
|
|
39338
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
39836
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
39339
39837
|
* @param {*} [options] Override http request option.
|
|
39340
39838
|
* @throws {RequiredError}
|
|
39341
39839
|
*/
|
|
39342
|
-
configRemovePaymentOption(businessId: number, id: string, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', options?: any): AxiosPromise<ConfigManagementResponseDto> {
|
|
39840
|
+
configRemovePaymentOption(businessId: number, id: string, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', options?: any): AxiosPromise<ConfigManagementResponseDto> {
|
|
39343
39841
|
return localVarFp.configRemovePaymentOption(businessId, id, xAppX, options).then((request) => request(axios, basePath));
|
|
39344
39842
|
},
|
|
39345
39843
|
/**
|
|
39346
39844
|
* 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.
|
|
39347
39845
|
* @summary Save a channel\'s Epassi credentials and answer the public key to send Epassi
|
|
39348
39846
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
39349
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
39847
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
39350
39848
|
* @param {string} xEpassiAccessKey The access key Epassi issued for this venue; Epassi issues a different one for test and production.
|
|
39351
39849
|
* @param {SaveEpassiCredentialsDto} saveEpassiCredentialsDto
|
|
39352
39850
|
* @param {*} [options] Override http request option.
|
|
39353
39851
|
* @throws {RequiredError}
|
|
39354
39852
|
*/
|
|
39355
|
-
configSaveEpassiCredentials(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', xEpassiAccessKey: string, saveEpassiCredentialsDto: SaveEpassiCredentialsDto, options?: any): AxiosPromise<EpassiCredentialsSavedDto> {
|
|
39853
|
+
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> {
|
|
39356
39854
|
return localVarFp.configSaveEpassiCredentials(businessId, xAppX, xEpassiAccessKey, saveEpassiCredentialsDto, options).then((request) => request(axios, basePath));
|
|
39357
39855
|
},
|
|
39358
39856
|
/**
|
|
@@ -39370,24 +39868,24 @@ export const ConfigManagementApiFactory = function (configuration?: Configuratio
|
|
|
39370
39868
|
* 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.
|
|
39371
39869
|
* @summary Create or update a channel\'s config
|
|
39372
39870
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
39373
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
39871
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
39374
39872
|
* @param {UpsertConfigDto} upsertConfigDto
|
|
39375
39873
|
* @param {*} [options] Override http request option.
|
|
39376
39874
|
* @throws {RequiredError}
|
|
39377
39875
|
*/
|
|
39378
|
-
configUpsertChannelConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', upsertConfigDto: UpsertConfigDto, options?: any): AxiosPromise<ConfigManagementResponseDto> {
|
|
39876
|
+
configUpsertChannelConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertConfigDto: UpsertConfigDto, options?: any): AxiosPromise<ConfigManagementResponseDto> {
|
|
39379
39877
|
return localVarFp.configUpsertChannelConfig(businessId, xAppX, upsertConfigDto, options).then((request) => request(axios, basePath));
|
|
39380
39878
|
},
|
|
39381
39879
|
/**
|
|
39382
39880
|
* 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.
|
|
39383
39881
|
* @summary Create or update a channel\'s third-party gift card integration
|
|
39384
39882
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
39385
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
39883
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
39386
39884
|
* @param {UpsertGiftCardDto} upsertGiftCardDto
|
|
39387
39885
|
* @param {*} [options] Override http request option.
|
|
39388
39886
|
* @throws {RequiredError}
|
|
39389
39887
|
*/
|
|
39390
|
-
configUpsertGiftCard(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', upsertGiftCardDto: UpsertGiftCardDto, options?: any): AxiosPromise<ConfigManagementResponseDto> {
|
|
39888
|
+
configUpsertGiftCard(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertGiftCardDto: UpsertGiftCardDto, options?: any): AxiosPromise<ConfigManagementResponseDto> {
|
|
39391
39889
|
return localVarFp.configUpsertGiftCard(businessId, xAppX, upsertGiftCardDto, options).then((request) => request(axios, basePath));
|
|
39392
39890
|
},
|
|
39393
39891
|
/**
|
|
@@ -39405,60 +39903,60 @@ export const ConfigManagementApiFactory = function (configuration?: Configuratio
|
|
|
39405
39903
|
* Creates the channel\'s config first if it has none. Saved active unless isActive is sent. The cached Nets config and token are cleared.
|
|
39406
39904
|
* @summary Create or update a channel\'s Nets config
|
|
39407
39905
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
39408
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
39906
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
39409
39907
|
* @param {UpsertNetsDto} upsertNetsDto
|
|
39410
39908
|
* @param {*} [options] Override http request option.
|
|
39411
39909
|
* @throws {RequiredError}
|
|
39412
39910
|
*/
|
|
39413
|
-
configUpsertNets(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', upsertNetsDto: UpsertNetsDto, options?: any): AxiosPromise<ConfigManagementResponseDto> {
|
|
39911
|
+
configUpsertNets(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertNetsDto: UpsertNetsDto, options?: any): AxiosPromise<ConfigManagementResponseDto> {
|
|
39414
39912
|
return localVarFp.configUpsertNets(businessId, xAppX, upsertNetsDto, options).then((request) => request(axios, basePath));
|
|
39415
39913
|
},
|
|
39416
39914
|
/**
|
|
39417
39915
|
* 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.
|
|
39418
39916
|
* @summary Create or update a channel\'s checkout payment options
|
|
39419
39917
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
39420
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
39918
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
39421
39919
|
* @param {UpsertPaymentOptionsDto} upsertPaymentOptionsDto
|
|
39422
39920
|
* @param {*} [options] Override http request option.
|
|
39423
39921
|
* @throws {RequiredError}
|
|
39424
39922
|
*/
|
|
39425
|
-
configUpsertPaymentOptions(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', upsertPaymentOptionsDto: UpsertPaymentOptionsDto, options?: any): AxiosPromise<ConfigManagementResponseDto> {
|
|
39923
|
+
configUpsertPaymentOptions(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertPaymentOptionsDto: UpsertPaymentOptionsDto, options?: any): AxiosPromise<ConfigManagementResponseDto> {
|
|
39426
39924
|
return localVarFp.configUpsertPaymentOptions(businessId, xAppX, upsertPaymentOptionsDto, options).then((request) => request(axios, basePath));
|
|
39427
39925
|
},
|
|
39428
39926
|
/**
|
|
39429
39927
|
* 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.
|
|
39430
39928
|
* @summary Set active provider and upsert its credentials
|
|
39431
39929
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
39432
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
39930
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
39433
39931
|
* @param {UpsertProvidersDto} upsertProvidersDto
|
|
39434
39932
|
* @param {*} [options] Override http request option.
|
|
39435
39933
|
* @throws {RequiredError}
|
|
39436
39934
|
*/
|
|
39437
|
-
configUpsertProviders(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', upsertProvidersDto: UpsertProvidersDto, options?: any): AxiosPromise<ProvidersConfigResponseDto> {
|
|
39935
|
+
configUpsertProviders(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertProvidersDto: UpsertProvidersDto, options?: any): AxiosPromise<ProvidersConfigResponseDto> {
|
|
39438
39936
|
return localVarFp.configUpsertProviders(businessId, xAppX, upsertProvidersDto, options).then((request) => request(axios, basePath));
|
|
39439
39937
|
},
|
|
39440
39938
|
/**
|
|
39441
39939
|
* Creates the channel\'s config first if it has none. Saved active unless isActive is sent. The cached Stripe config is cleared.
|
|
39442
39940
|
* @summary Create or update a channel\'s Stripe config
|
|
39443
39941
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
39444
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
39942
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
39445
39943
|
* @param {UpsertStripeDto} upsertStripeDto
|
|
39446
39944
|
* @param {*} [options] Override http request option.
|
|
39447
39945
|
* @throws {RequiredError}
|
|
39448
39946
|
*/
|
|
39449
|
-
configUpsertStripe(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', upsertStripeDto: UpsertStripeDto, options?: any): AxiosPromise<ConfigManagementResponseDto> {
|
|
39947
|
+
configUpsertStripe(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertStripeDto: UpsertStripeDto, options?: any): AxiosPromise<ConfigManagementResponseDto> {
|
|
39450
39948
|
return localVarFp.configUpsertStripe(businessId, xAppX, upsertStripeDto, options).then((request) => request(axios, basePath));
|
|
39451
39949
|
},
|
|
39452
39950
|
/**
|
|
39453
39951
|
* 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.
|
|
39454
39952
|
* @summary Create or update a channel\'s Viva config
|
|
39455
39953
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
39456
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
39954
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
39457
39955
|
* @param {UpsertVivaDto} upsertVivaDto
|
|
39458
39956
|
* @param {*} [options] Override http request option.
|
|
39459
39957
|
* @throws {RequiredError}
|
|
39460
39958
|
*/
|
|
39461
|
-
configUpsertViva(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', upsertVivaDto: UpsertVivaDto, options?: any): AxiosPromise<ConfigManagementResponseDto> {
|
|
39959
|
+
configUpsertViva(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertVivaDto: UpsertVivaDto, options?: any): AxiosPromise<ConfigManagementResponseDto> {
|
|
39462
39960
|
return localVarFp.configUpsertViva(businessId, xAppX, upsertVivaDto, options).then((request) => request(axios, basePath));
|
|
39463
39961
|
},
|
|
39464
39962
|
};
|
|
@@ -39474,24 +39972,24 @@ export interface ConfigManagementApiInterface {
|
|
|
39474
39972
|
* 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.
|
|
39475
39973
|
* @summary Enable or disable first-party Munchi GiftCard integration
|
|
39476
39974
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
39477
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
39975
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
39478
39976
|
* @param {ConfigureMunchiGiftCardDto} configureMunchiGiftCardDto
|
|
39479
39977
|
* @param {*} [options] Override http request option.
|
|
39480
39978
|
* @throws {RequiredError}
|
|
39481
39979
|
* @memberof ConfigManagementApiInterface
|
|
39482
39980
|
*/
|
|
39483
|
-
configConfigureMunchiGiftCard(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', configureMunchiGiftCardDto: ConfigureMunchiGiftCardDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
39981
|
+
configConfigureMunchiGiftCard(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', configureMunchiGiftCardDto: ConfigureMunchiGiftCardDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
39484
39982
|
|
|
39485
39983
|
/**
|
|
39486
39984
|
* 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).
|
|
39487
39985
|
* @summary Read a channel\'s card payment providers
|
|
39488
39986
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
39489
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
39987
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
39490
39988
|
* @param {*} [options] Override http request option.
|
|
39491
39989
|
* @throws {RequiredError}
|
|
39492
39990
|
* @memberof ConfigManagementApiInterface
|
|
39493
39991
|
*/
|
|
39494
|
-
configGetProviders(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', options?: AxiosRequestConfig): AxiosPromise<ProvidersConfigResponseDto>;
|
|
39992
|
+
configGetProviders(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', options?: AxiosRequestConfig): AxiosPromise<ProvidersConfigResponseDto>;
|
|
39495
39993
|
|
|
39496
39994
|
/**
|
|
39497
39995
|
* 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.
|
|
@@ -39509,25 +40007,25 @@ export interface ConfigManagementApiInterface {
|
|
|
39509
40007
|
* @summary Remove payment option
|
|
39510
40008
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
39511
40009
|
* @param {string} id The payment option\'s id
|
|
39512
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
40010
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
39513
40011
|
* @param {*} [options] Override http request option.
|
|
39514
40012
|
* @throws {RequiredError}
|
|
39515
40013
|
* @memberof ConfigManagementApiInterface
|
|
39516
40014
|
*/
|
|
39517
|
-
configRemovePaymentOption(businessId: number, id: string, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
40015
|
+
configRemovePaymentOption(businessId: number, id: string, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
39518
40016
|
|
|
39519
40017
|
/**
|
|
39520
40018
|
* 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.
|
|
39521
40019
|
* @summary Save a channel\'s Epassi credentials and answer the public key to send Epassi
|
|
39522
40020
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
39523
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
40021
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
39524
40022
|
* @param {string} xEpassiAccessKey The access key Epassi issued for this venue; Epassi issues a different one for test and production.
|
|
39525
40023
|
* @param {SaveEpassiCredentialsDto} saveEpassiCredentialsDto
|
|
39526
40024
|
* @param {*} [options] Override http request option.
|
|
39527
40025
|
* @throws {RequiredError}
|
|
39528
40026
|
* @memberof ConfigManagementApiInterface
|
|
39529
40027
|
*/
|
|
39530
|
-
configSaveEpassiCredentials(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', xEpassiAccessKey: string, saveEpassiCredentialsDto: SaveEpassiCredentialsDto, options?: AxiosRequestConfig): AxiosPromise<EpassiCredentialsSavedDto>;
|
|
40028
|
+
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>;
|
|
39531
40029
|
|
|
39532
40030
|
/**
|
|
39533
40031
|
* 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.
|
|
@@ -39544,25 +40042,25 @@ export interface ConfigManagementApiInterface {
|
|
|
39544
40042
|
* 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.
|
|
39545
40043
|
* @summary Create or update a channel\'s config
|
|
39546
40044
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
39547
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
40045
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
39548
40046
|
* @param {UpsertConfigDto} upsertConfigDto
|
|
39549
40047
|
* @param {*} [options] Override http request option.
|
|
39550
40048
|
* @throws {RequiredError}
|
|
39551
40049
|
* @memberof ConfigManagementApiInterface
|
|
39552
40050
|
*/
|
|
39553
|
-
configUpsertChannelConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', upsertConfigDto: UpsertConfigDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
40051
|
+
configUpsertChannelConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertConfigDto: UpsertConfigDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
39554
40052
|
|
|
39555
40053
|
/**
|
|
39556
40054
|
* 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.
|
|
39557
40055
|
* @summary Create or update a channel\'s third-party gift card integration
|
|
39558
40056
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
39559
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
40057
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
39560
40058
|
* @param {UpsertGiftCardDto} upsertGiftCardDto
|
|
39561
40059
|
* @param {*} [options] Override http request option.
|
|
39562
40060
|
* @throws {RequiredError}
|
|
39563
40061
|
* @memberof ConfigManagementApiInterface
|
|
39564
40062
|
*/
|
|
39565
|
-
configUpsertGiftCard(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', upsertGiftCardDto: UpsertGiftCardDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
40063
|
+
configUpsertGiftCard(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertGiftCardDto: UpsertGiftCardDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
39566
40064
|
|
|
39567
40065
|
/**
|
|
39568
40066
|
* 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.
|
|
@@ -39579,61 +40077,61 @@ export interface ConfigManagementApiInterface {
|
|
|
39579
40077
|
* Creates the channel\'s config first if it has none. Saved active unless isActive is sent. The cached Nets config and token are cleared.
|
|
39580
40078
|
* @summary Create or update a channel\'s Nets config
|
|
39581
40079
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
39582
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
40080
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
39583
40081
|
* @param {UpsertNetsDto} upsertNetsDto
|
|
39584
40082
|
* @param {*} [options] Override http request option.
|
|
39585
40083
|
* @throws {RequiredError}
|
|
39586
40084
|
* @memberof ConfigManagementApiInterface
|
|
39587
40085
|
*/
|
|
39588
|
-
configUpsertNets(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', upsertNetsDto: UpsertNetsDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
40086
|
+
configUpsertNets(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertNetsDto: UpsertNetsDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
39589
40087
|
|
|
39590
40088
|
/**
|
|
39591
40089
|
* 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.
|
|
39592
40090
|
* @summary Create or update a channel\'s checkout payment options
|
|
39593
40091
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
39594
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
40092
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
39595
40093
|
* @param {UpsertPaymentOptionsDto} upsertPaymentOptionsDto
|
|
39596
40094
|
* @param {*} [options] Override http request option.
|
|
39597
40095
|
* @throws {RequiredError}
|
|
39598
40096
|
* @memberof ConfigManagementApiInterface
|
|
39599
40097
|
*/
|
|
39600
|
-
configUpsertPaymentOptions(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', upsertPaymentOptionsDto: UpsertPaymentOptionsDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
40098
|
+
configUpsertPaymentOptions(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertPaymentOptionsDto: UpsertPaymentOptionsDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
39601
40099
|
|
|
39602
40100
|
/**
|
|
39603
40101
|
* 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.
|
|
39604
40102
|
* @summary Set active provider and upsert its credentials
|
|
39605
40103
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
39606
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
40104
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
39607
40105
|
* @param {UpsertProvidersDto} upsertProvidersDto
|
|
39608
40106
|
* @param {*} [options] Override http request option.
|
|
39609
40107
|
* @throws {RequiredError}
|
|
39610
40108
|
* @memberof ConfigManagementApiInterface
|
|
39611
40109
|
*/
|
|
39612
|
-
configUpsertProviders(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', upsertProvidersDto: UpsertProvidersDto, options?: AxiosRequestConfig): AxiosPromise<ProvidersConfigResponseDto>;
|
|
40110
|
+
configUpsertProviders(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertProvidersDto: UpsertProvidersDto, options?: AxiosRequestConfig): AxiosPromise<ProvidersConfigResponseDto>;
|
|
39613
40111
|
|
|
39614
40112
|
/**
|
|
39615
40113
|
* Creates the channel\'s config first if it has none. Saved active unless isActive is sent. The cached Stripe config is cleared.
|
|
39616
40114
|
* @summary Create or update a channel\'s Stripe config
|
|
39617
40115
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
39618
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
40116
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
39619
40117
|
* @param {UpsertStripeDto} upsertStripeDto
|
|
39620
40118
|
* @param {*} [options] Override http request option.
|
|
39621
40119
|
* @throws {RequiredError}
|
|
39622
40120
|
* @memberof ConfigManagementApiInterface
|
|
39623
40121
|
*/
|
|
39624
|
-
configUpsertStripe(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', upsertStripeDto: UpsertStripeDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
40122
|
+
configUpsertStripe(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertStripeDto: UpsertStripeDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
39625
40123
|
|
|
39626
40124
|
/**
|
|
39627
40125
|
* 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.
|
|
39628
40126
|
* @summary Create or update a channel\'s Viva config
|
|
39629
40127
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
39630
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
40128
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
39631
40129
|
* @param {UpsertVivaDto} upsertVivaDto
|
|
39632
40130
|
* @param {*} [options] Override http request option.
|
|
39633
40131
|
* @throws {RequiredError}
|
|
39634
40132
|
* @memberof ConfigManagementApiInterface
|
|
39635
40133
|
*/
|
|
39636
|
-
configUpsertViva(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', upsertVivaDto: UpsertVivaDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
40134
|
+
configUpsertViva(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertVivaDto: UpsertVivaDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
39637
40135
|
|
|
39638
40136
|
}
|
|
39639
40137
|
|
|
@@ -39648,13 +40146,13 @@ export class ConfigManagementApi extends BaseAPI implements ConfigManagementApiI
|
|
|
39648
40146
|
* 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.
|
|
39649
40147
|
* @summary Enable or disable first-party Munchi GiftCard integration
|
|
39650
40148
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
39651
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
40149
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
39652
40150
|
* @param {ConfigureMunchiGiftCardDto} configureMunchiGiftCardDto
|
|
39653
40151
|
* @param {*} [options] Override http request option.
|
|
39654
40152
|
* @throws {RequiredError}
|
|
39655
40153
|
* @memberof ConfigManagementApi
|
|
39656
40154
|
*/
|
|
39657
|
-
public configConfigureMunchiGiftCard(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', configureMunchiGiftCardDto: ConfigureMunchiGiftCardDto, options?: AxiosRequestConfig) {
|
|
40155
|
+
public configConfigureMunchiGiftCard(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', configureMunchiGiftCardDto: ConfigureMunchiGiftCardDto, options?: AxiosRequestConfig) {
|
|
39658
40156
|
return ConfigManagementApiFp(this.configuration).configConfigureMunchiGiftCard(businessId, xAppX, configureMunchiGiftCardDto, options).then((request) => request(this.axios, this.basePath));
|
|
39659
40157
|
}
|
|
39660
40158
|
|
|
@@ -39662,12 +40160,12 @@ export class ConfigManagementApi extends BaseAPI implements ConfigManagementApiI
|
|
|
39662
40160
|
* 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).
|
|
39663
40161
|
* @summary Read a channel\'s card payment providers
|
|
39664
40162
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
39665
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
40163
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
39666
40164
|
* @param {*} [options] Override http request option.
|
|
39667
40165
|
* @throws {RequiredError}
|
|
39668
40166
|
* @memberof ConfigManagementApi
|
|
39669
40167
|
*/
|
|
39670
|
-
public configGetProviders(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', options?: AxiosRequestConfig) {
|
|
40168
|
+
public configGetProviders(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', options?: AxiosRequestConfig) {
|
|
39671
40169
|
return ConfigManagementApiFp(this.configuration).configGetProviders(businessId, xAppX, options).then((request) => request(this.axios, this.basePath));
|
|
39672
40170
|
}
|
|
39673
40171
|
|
|
@@ -39689,12 +40187,12 @@ export class ConfigManagementApi extends BaseAPI implements ConfigManagementApiI
|
|
|
39689
40187
|
* @summary Remove payment option
|
|
39690
40188
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
39691
40189
|
* @param {string} id The payment option\'s id
|
|
39692
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
40190
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
39693
40191
|
* @param {*} [options] Override http request option.
|
|
39694
40192
|
* @throws {RequiredError}
|
|
39695
40193
|
* @memberof ConfigManagementApi
|
|
39696
40194
|
*/
|
|
39697
|
-
public configRemovePaymentOption(businessId: number, id: string, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', options?: AxiosRequestConfig) {
|
|
40195
|
+
public configRemovePaymentOption(businessId: number, id: string, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', options?: AxiosRequestConfig) {
|
|
39698
40196
|
return ConfigManagementApiFp(this.configuration).configRemovePaymentOption(businessId, id, xAppX, options).then((request) => request(this.axios, this.basePath));
|
|
39699
40197
|
}
|
|
39700
40198
|
|
|
@@ -39702,14 +40200,14 @@ export class ConfigManagementApi extends BaseAPI implements ConfigManagementApiI
|
|
|
39702
40200
|
* 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.
|
|
39703
40201
|
* @summary Save a channel\'s Epassi credentials and answer the public key to send Epassi
|
|
39704
40202
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
39705
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
40203
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
39706
40204
|
* @param {string} xEpassiAccessKey The access key Epassi issued for this venue; Epassi issues a different one for test and production.
|
|
39707
40205
|
* @param {SaveEpassiCredentialsDto} saveEpassiCredentialsDto
|
|
39708
40206
|
* @param {*} [options] Override http request option.
|
|
39709
40207
|
* @throws {RequiredError}
|
|
39710
40208
|
* @memberof ConfigManagementApi
|
|
39711
40209
|
*/
|
|
39712
|
-
public configSaveEpassiCredentials(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', xEpassiAccessKey: string, saveEpassiCredentialsDto: SaveEpassiCredentialsDto, options?: AxiosRequestConfig) {
|
|
40210
|
+
public configSaveEpassiCredentials(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', xEpassiAccessKey: string, saveEpassiCredentialsDto: SaveEpassiCredentialsDto, options?: AxiosRequestConfig) {
|
|
39713
40211
|
return ConfigManagementApiFp(this.configuration).configSaveEpassiCredentials(businessId, xAppX, xEpassiAccessKey, saveEpassiCredentialsDto, options).then((request) => request(this.axios, this.basePath));
|
|
39714
40212
|
}
|
|
39715
40213
|
|
|
@@ -39730,13 +40228,13 @@ export class ConfigManagementApi extends BaseAPI implements ConfigManagementApiI
|
|
|
39730
40228
|
* 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.
|
|
39731
40229
|
* @summary Create or update a channel\'s config
|
|
39732
40230
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
39733
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
40231
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
39734
40232
|
* @param {UpsertConfigDto} upsertConfigDto
|
|
39735
40233
|
* @param {*} [options] Override http request option.
|
|
39736
40234
|
* @throws {RequiredError}
|
|
39737
40235
|
* @memberof ConfigManagementApi
|
|
39738
40236
|
*/
|
|
39739
|
-
public configUpsertChannelConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', upsertConfigDto: UpsertConfigDto, options?: AxiosRequestConfig) {
|
|
40237
|
+
public configUpsertChannelConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertConfigDto: UpsertConfigDto, options?: AxiosRequestConfig) {
|
|
39740
40238
|
return ConfigManagementApiFp(this.configuration).configUpsertChannelConfig(businessId, xAppX, upsertConfigDto, options).then((request) => request(this.axios, this.basePath));
|
|
39741
40239
|
}
|
|
39742
40240
|
|
|
@@ -39744,13 +40242,13 @@ export class ConfigManagementApi extends BaseAPI implements ConfigManagementApiI
|
|
|
39744
40242
|
* 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.
|
|
39745
40243
|
* @summary Create or update a channel\'s third-party gift card integration
|
|
39746
40244
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
39747
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
40245
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
39748
40246
|
* @param {UpsertGiftCardDto} upsertGiftCardDto
|
|
39749
40247
|
* @param {*} [options] Override http request option.
|
|
39750
40248
|
* @throws {RequiredError}
|
|
39751
40249
|
* @memberof ConfigManagementApi
|
|
39752
40250
|
*/
|
|
39753
|
-
public configUpsertGiftCard(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', upsertGiftCardDto: UpsertGiftCardDto, options?: AxiosRequestConfig) {
|
|
40251
|
+
public configUpsertGiftCard(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertGiftCardDto: UpsertGiftCardDto, options?: AxiosRequestConfig) {
|
|
39754
40252
|
return ConfigManagementApiFp(this.configuration).configUpsertGiftCard(businessId, xAppX, upsertGiftCardDto, options).then((request) => request(this.axios, this.basePath));
|
|
39755
40253
|
}
|
|
39756
40254
|
|
|
@@ -39771,13 +40269,13 @@ export class ConfigManagementApi extends BaseAPI implements ConfigManagementApiI
|
|
|
39771
40269
|
* Creates the channel\'s config first if it has none. Saved active unless isActive is sent. The cached Nets config and token are cleared.
|
|
39772
40270
|
* @summary Create or update a channel\'s Nets config
|
|
39773
40271
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
39774
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
40272
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
39775
40273
|
* @param {UpsertNetsDto} upsertNetsDto
|
|
39776
40274
|
* @param {*} [options] Override http request option.
|
|
39777
40275
|
* @throws {RequiredError}
|
|
39778
40276
|
* @memberof ConfigManagementApi
|
|
39779
40277
|
*/
|
|
39780
|
-
public configUpsertNets(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', upsertNetsDto: UpsertNetsDto, options?: AxiosRequestConfig) {
|
|
40278
|
+
public configUpsertNets(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertNetsDto: UpsertNetsDto, options?: AxiosRequestConfig) {
|
|
39781
40279
|
return ConfigManagementApiFp(this.configuration).configUpsertNets(businessId, xAppX, upsertNetsDto, options).then((request) => request(this.axios, this.basePath));
|
|
39782
40280
|
}
|
|
39783
40281
|
|
|
@@ -39785,13 +40283,13 @@ export class ConfigManagementApi extends BaseAPI implements ConfigManagementApiI
|
|
|
39785
40283
|
* 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.
|
|
39786
40284
|
* @summary Create or update a channel\'s checkout payment options
|
|
39787
40285
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
39788
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
40286
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
39789
40287
|
* @param {UpsertPaymentOptionsDto} upsertPaymentOptionsDto
|
|
39790
40288
|
* @param {*} [options] Override http request option.
|
|
39791
40289
|
* @throws {RequiredError}
|
|
39792
40290
|
* @memberof ConfigManagementApi
|
|
39793
40291
|
*/
|
|
39794
|
-
public configUpsertPaymentOptions(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', upsertPaymentOptionsDto: UpsertPaymentOptionsDto, options?: AxiosRequestConfig) {
|
|
40292
|
+
public configUpsertPaymentOptions(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertPaymentOptionsDto: UpsertPaymentOptionsDto, options?: AxiosRequestConfig) {
|
|
39795
40293
|
return ConfigManagementApiFp(this.configuration).configUpsertPaymentOptions(businessId, xAppX, upsertPaymentOptionsDto, options).then((request) => request(this.axios, this.basePath));
|
|
39796
40294
|
}
|
|
39797
40295
|
|
|
@@ -39799,13 +40297,13 @@ export class ConfigManagementApi extends BaseAPI implements ConfigManagementApiI
|
|
|
39799
40297
|
* 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.
|
|
39800
40298
|
* @summary Set active provider and upsert its credentials
|
|
39801
40299
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
39802
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
40300
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
39803
40301
|
* @param {UpsertProvidersDto} upsertProvidersDto
|
|
39804
40302
|
* @param {*} [options] Override http request option.
|
|
39805
40303
|
* @throws {RequiredError}
|
|
39806
40304
|
* @memberof ConfigManagementApi
|
|
39807
40305
|
*/
|
|
39808
|
-
public configUpsertProviders(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', upsertProvidersDto: UpsertProvidersDto, options?: AxiosRequestConfig) {
|
|
40306
|
+
public configUpsertProviders(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertProvidersDto: UpsertProvidersDto, options?: AxiosRequestConfig) {
|
|
39809
40307
|
return ConfigManagementApiFp(this.configuration).configUpsertProviders(businessId, xAppX, upsertProvidersDto, options).then((request) => request(this.axios, this.basePath));
|
|
39810
40308
|
}
|
|
39811
40309
|
|
|
@@ -39813,13 +40311,13 @@ export class ConfigManagementApi extends BaseAPI implements ConfigManagementApiI
|
|
|
39813
40311
|
* Creates the channel\'s config first if it has none. Saved active unless isActive is sent. The cached Stripe config is cleared.
|
|
39814
40312
|
* @summary Create or update a channel\'s Stripe config
|
|
39815
40313
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
39816
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
40314
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
39817
40315
|
* @param {UpsertStripeDto} upsertStripeDto
|
|
39818
40316
|
* @param {*} [options] Override http request option.
|
|
39819
40317
|
* @throws {RequiredError}
|
|
39820
40318
|
* @memberof ConfigManagementApi
|
|
39821
40319
|
*/
|
|
39822
|
-
public configUpsertStripe(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', upsertStripeDto: UpsertStripeDto, options?: AxiosRequestConfig) {
|
|
40320
|
+
public configUpsertStripe(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertStripeDto: UpsertStripeDto, options?: AxiosRequestConfig) {
|
|
39823
40321
|
return ConfigManagementApiFp(this.configuration).configUpsertStripe(businessId, xAppX, upsertStripeDto, options).then((request) => request(this.axios, this.basePath));
|
|
39824
40322
|
}
|
|
39825
40323
|
|
|
@@ -39827,13 +40325,13 @@ export class ConfigManagementApi extends BaseAPI implements ConfigManagementApiI
|
|
|
39827
40325
|
* 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.
|
|
39828
40326
|
* @summary Create or update a channel\'s Viva config
|
|
39829
40327
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
39830
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
40328
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
39831
40329
|
* @param {UpsertVivaDto} upsertVivaDto
|
|
39832
40330
|
* @param {*} [options] Override http request option.
|
|
39833
40331
|
* @throws {RequiredError}
|
|
39834
40332
|
* @memberof ConfigManagementApi
|
|
39835
40333
|
*/
|
|
39836
|
-
public configUpsertViva(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', upsertVivaDto: UpsertVivaDto, options?: AxiosRequestConfig) {
|
|
40334
|
+
public configUpsertViva(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertVivaDto: UpsertVivaDto, options?: AxiosRequestConfig) {
|
|
39837
40335
|
return ConfigManagementApiFp(this.configuration).configUpsertViva(businessId, xAppX, upsertVivaDto, options).then((request) => request(this.axios, this.basePath));
|
|
39838
40336
|
}
|
|
39839
40337
|
}
|
|
@@ -40617,6 +41115,1016 @@ export class DisplayApi extends BaseAPI implements DisplayApiInterface {
|
|
|
40617
41115
|
}
|
|
40618
41116
|
|
|
40619
41117
|
|
|
41118
|
+
/**
|
|
41119
|
+
* EmployeeRolesApi - axios parameter creator
|
|
41120
|
+
* @export
|
|
41121
|
+
*/
|
|
41122
|
+
export const EmployeeRolesApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
41123
|
+
return {
|
|
41124
|
+
/**
|
|
41125
|
+
* 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.
|
|
41126
|
+
* @summary Add an employee role at the venue
|
|
41127
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
41128
|
+
* @param {AddEmployeeRoleDto} addEmployeeRoleDto
|
|
41129
|
+
* @param {*} [options] Override http request option.
|
|
41130
|
+
* @throws {RequiredError}
|
|
41131
|
+
*/
|
|
41132
|
+
addEmployeeRole: async (businessId: number, addEmployeeRoleDto: AddEmployeeRoleDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
41133
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
41134
|
+
assertParamExists('addEmployeeRole', 'businessId', businessId)
|
|
41135
|
+
// verify required parameter 'addEmployeeRoleDto' is not null or undefined
|
|
41136
|
+
assertParamExists('addEmployeeRole', 'addEmployeeRoleDto', addEmployeeRoleDto)
|
|
41137
|
+
const localVarPath = `/api/v2/businesses/{businessId}/employee-roles`
|
|
41138
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)));
|
|
41139
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
41140
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
41141
|
+
let baseOptions;
|
|
41142
|
+
if (configuration) {
|
|
41143
|
+
baseOptions = configuration.baseOptions;
|
|
41144
|
+
}
|
|
41145
|
+
|
|
41146
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
41147
|
+
const localVarHeaderParameter = {} as any;
|
|
41148
|
+
const localVarQueryParameter = {} as any;
|
|
41149
|
+
|
|
41150
|
+
// authentication JWT-auth required
|
|
41151
|
+
// http bearer authentication required
|
|
41152
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
41153
|
+
|
|
41154
|
+
|
|
41155
|
+
|
|
41156
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
41157
|
+
|
|
41158
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
41159
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
41160
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
41161
|
+
localVarRequestOptions.data = serializeDataIfNeeded(addEmployeeRoleDto, localVarRequestOptions, configuration)
|
|
41162
|
+
|
|
41163
|
+
return {
|
|
41164
|
+
url: toPathString(localVarUrlObj),
|
|
41165
|
+
options: localVarRequestOptions,
|
|
41166
|
+
};
|
|
41167
|
+
},
|
|
41168
|
+
/**
|
|
41169
|
+
* 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.
|
|
41170
|
+
* @summary Add the starter employee roles at the venue
|
|
41171
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
41172
|
+
* @param {*} [options] Override http request option.
|
|
41173
|
+
* @throws {RequiredError}
|
|
41174
|
+
*/
|
|
41175
|
+
addStarterEmployeeRoles: async (businessId: number, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
41176
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
41177
|
+
assertParamExists('addStarterEmployeeRoles', 'businessId', businessId)
|
|
41178
|
+
const localVarPath = `/api/v2/businesses/{businessId}/employee-roles/starter`
|
|
41179
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)));
|
|
41180
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
41181
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
41182
|
+
let baseOptions;
|
|
41183
|
+
if (configuration) {
|
|
41184
|
+
baseOptions = configuration.baseOptions;
|
|
41185
|
+
}
|
|
41186
|
+
|
|
41187
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
41188
|
+
const localVarHeaderParameter = {} as any;
|
|
41189
|
+
const localVarQueryParameter = {} as any;
|
|
41190
|
+
|
|
41191
|
+
// authentication JWT-auth required
|
|
41192
|
+
// http bearer authentication required
|
|
41193
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
41194
|
+
|
|
41195
|
+
|
|
41196
|
+
|
|
41197
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
41198
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
41199
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
41200
|
+
|
|
41201
|
+
return {
|
|
41202
|
+
url: toPathString(localVarUrlObj),
|
|
41203
|
+
options: localVarRequestOptions,
|
|
41204
|
+
};
|
|
41205
|
+
},
|
|
41206
|
+
/**
|
|
41207
|
+
* 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.
|
|
41208
|
+
* @summary Change an employee role of the venue
|
|
41209
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
41210
|
+
* @param {string} roleId The role\'s id, one of the venue\'s
|
|
41211
|
+
* @param {ChangeEmployeeRoleDto} changeEmployeeRoleDto
|
|
41212
|
+
* @param {*} [options] Override http request option.
|
|
41213
|
+
* @throws {RequiredError}
|
|
41214
|
+
*/
|
|
41215
|
+
changeEmployeeRole: async (businessId: number, roleId: string, changeEmployeeRoleDto: ChangeEmployeeRoleDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
41216
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
41217
|
+
assertParamExists('changeEmployeeRole', 'businessId', businessId)
|
|
41218
|
+
// verify required parameter 'roleId' is not null or undefined
|
|
41219
|
+
assertParamExists('changeEmployeeRole', 'roleId', roleId)
|
|
41220
|
+
// verify required parameter 'changeEmployeeRoleDto' is not null or undefined
|
|
41221
|
+
assertParamExists('changeEmployeeRole', 'changeEmployeeRoleDto', changeEmployeeRoleDto)
|
|
41222
|
+
const localVarPath = `/api/v2/businesses/{businessId}/employee-roles/{roleId}`
|
|
41223
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)))
|
|
41224
|
+
.replace(`{${"roleId"}}`, encodeURIComponent(String(roleId)));
|
|
41225
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
41226
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
41227
|
+
let baseOptions;
|
|
41228
|
+
if (configuration) {
|
|
41229
|
+
baseOptions = configuration.baseOptions;
|
|
41230
|
+
}
|
|
41231
|
+
|
|
41232
|
+
const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
|
|
41233
|
+
const localVarHeaderParameter = {} as any;
|
|
41234
|
+
const localVarQueryParameter = {} as any;
|
|
41235
|
+
|
|
41236
|
+
// authentication JWT-auth required
|
|
41237
|
+
// http bearer authentication required
|
|
41238
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
41239
|
+
|
|
41240
|
+
|
|
41241
|
+
|
|
41242
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
41243
|
+
|
|
41244
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
41245
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
41246
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
41247
|
+
localVarRequestOptions.data = serializeDataIfNeeded(changeEmployeeRoleDto, localVarRequestOptions, configuration)
|
|
41248
|
+
|
|
41249
|
+
return {
|
|
41250
|
+
url: toPathString(localVarUrlObj),
|
|
41251
|
+
options: localVarRequestOptions,
|
|
41252
|
+
};
|
|
41253
|
+
},
|
|
41254
|
+
/**
|
|
41255
|
+
* 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.
|
|
41256
|
+
* @summary List the venue\'s employee roles
|
|
41257
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
41258
|
+
* @param {*} [options] Override http request option.
|
|
41259
|
+
* @throws {RequiredError}
|
|
41260
|
+
*/
|
|
41261
|
+
listEmployeeRoles: async (businessId: number, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
41262
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
41263
|
+
assertParamExists('listEmployeeRoles', 'businessId', businessId)
|
|
41264
|
+
const localVarPath = `/api/v2/businesses/{businessId}/employee-roles`
|
|
41265
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)));
|
|
41266
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
41267
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
41268
|
+
let baseOptions;
|
|
41269
|
+
if (configuration) {
|
|
41270
|
+
baseOptions = configuration.baseOptions;
|
|
41271
|
+
}
|
|
41272
|
+
|
|
41273
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
41274
|
+
const localVarHeaderParameter = {} as any;
|
|
41275
|
+
const localVarQueryParameter = {} as any;
|
|
41276
|
+
|
|
41277
|
+
// authentication JWT-auth required
|
|
41278
|
+
// http bearer authentication required
|
|
41279
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
41280
|
+
|
|
41281
|
+
|
|
41282
|
+
|
|
41283
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
41284
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
41285
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
41286
|
+
|
|
41287
|
+
return {
|
|
41288
|
+
url: toPathString(localVarUrlObj),
|
|
41289
|
+
options: localVarRequestOptions,
|
|
41290
|
+
};
|
|
41291
|
+
},
|
|
41292
|
+
/**
|
|
41293
|
+
* 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.
|
|
41294
|
+
* @summary Remove an employee role of the venue
|
|
41295
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
41296
|
+
* @param {string} roleId The role\'s id, one of the venue\'s
|
|
41297
|
+
* @param {*} [options] Override http request option.
|
|
41298
|
+
* @throws {RequiredError}
|
|
41299
|
+
*/
|
|
41300
|
+
removeEmployeeRole: async (businessId: number, roleId: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
41301
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
41302
|
+
assertParamExists('removeEmployeeRole', 'businessId', businessId)
|
|
41303
|
+
// verify required parameter 'roleId' is not null or undefined
|
|
41304
|
+
assertParamExists('removeEmployeeRole', 'roleId', roleId)
|
|
41305
|
+
const localVarPath = `/api/v2/businesses/{businessId}/employee-roles/{roleId}`
|
|
41306
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)))
|
|
41307
|
+
.replace(`{${"roleId"}}`, encodeURIComponent(String(roleId)));
|
|
41308
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
41309
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
41310
|
+
let baseOptions;
|
|
41311
|
+
if (configuration) {
|
|
41312
|
+
baseOptions = configuration.baseOptions;
|
|
41313
|
+
}
|
|
41314
|
+
|
|
41315
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
|
|
41316
|
+
const localVarHeaderParameter = {} as any;
|
|
41317
|
+
const localVarQueryParameter = {} as any;
|
|
41318
|
+
|
|
41319
|
+
// authentication JWT-auth required
|
|
41320
|
+
// http bearer authentication required
|
|
41321
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
41322
|
+
|
|
41323
|
+
|
|
41324
|
+
|
|
41325
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
41326
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
41327
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
41328
|
+
|
|
41329
|
+
return {
|
|
41330
|
+
url: toPathString(localVarUrlObj),
|
|
41331
|
+
options: localVarRequestOptions,
|
|
41332
|
+
};
|
|
41333
|
+
},
|
|
41334
|
+
}
|
|
41335
|
+
};
|
|
41336
|
+
|
|
41337
|
+
/**
|
|
41338
|
+
* EmployeeRolesApi - functional programming interface
|
|
41339
|
+
* @export
|
|
41340
|
+
*/
|
|
41341
|
+
export const EmployeeRolesApiFp = function(configuration?: Configuration) {
|
|
41342
|
+
const localVarAxiosParamCreator = EmployeeRolesApiAxiosParamCreator(configuration)
|
|
41343
|
+
return {
|
|
41344
|
+
/**
|
|
41345
|
+
* 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.
|
|
41346
|
+
* @summary Add an employee role at the venue
|
|
41347
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
41348
|
+
* @param {AddEmployeeRoleDto} addEmployeeRoleDto
|
|
41349
|
+
* @param {*} [options] Override http request option.
|
|
41350
|
+
* @throws {RequiredError}
|
|
41351
|
+
*/
|
|
41352
|
+
async addEmployeeRole(businessId: number, addEmployeeRoleDto: AddEmployeeRoleDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmployeeRoleResponseDto>> {
|
|
41353
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.addEmployeeRole(businessId, addEmployeeRoleDto, options);
|
|
41354
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
41355
|
+
},
|
|
41356
|
+
/**
|
|
41357
|
+
* 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.
|
|
41358
|
+
* @summary Add the starter employee roles at the venue
|
|
41359
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
41360
|
+
* @param {*} [options] Override http request option.
|
|
41361
|
+
* @throws {RequiredError}
|
|
41362
|
+
*/
|
|
41363
|
+
async addStarterEmployeeRoles(businessId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<EmployeeRoleResponseDto>>> {
|
|
41364
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.addStarterEmployeeRoles(businessId, options);
|
|
41365
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
41366
|
+
},
|
|
41367
|
+
/**
|
|
41368
|
+
* 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.
|
|
41369
|
+
* @summary Change an employee role of the venue
|
|
41370
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
41371
|
+
* @param {string} roleId The role\'s id, one of the venue\'s
|
|
41372
|
+
* @param {ChangeEmployeeRoleDto} changeEmployeeRoleDto
|
|
41373
|
+
* @param {*} [options] Override http request option.
|
|
41374
|
+
* @throws {RequiredError}
|
|
41375
|
+
*/
|
|
41376
|
+
async changeEmployeeRole(businessId: number, roleId: string, changeEmployeeRoleDto: ChangeEmployeeRoleDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmployeeRoleResponseDto>> {
|
|
41377
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.changeEmployeeRole(businessId, roleId, changeEmployeeRoleDto, options);
|
|
41378
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
41379
|
+
},
|
|
41380
|
+
/**
|
|
41381
|
+
* 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.
|
|
41382
|
+
* @summary List the venue\'s employee roles
|
|
41383
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
41384
|
+
* @param {*} [options] Override http request option.
|
|
41385
|
+
* @throws {RequiredError}
|
|
41386
|
+
*/
|
|
41387
|
+
async listEmployeeRoles(businessId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<EmployeeRoleResponseDto>>> {
|
|
41388
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listEmployeeRoles(businessId, options);
|
|
41389
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
41390
|
+
},
|
|
41391
|
+
/**
|
|
41392
|
+
* 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.
|
|
41393
|
+
* @summary Remove an employee role of the venue
|
|
41394
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
41395
|
+
* @param {string} roleId The role\'s id, one of the venue\'s
|
|
41396
|
+
* @param {*} [options] Override http request option.
|
|
41397
|
+
* @throws {RequiredError}
|
|
41398
|
+
*/
|
|
41399
|
+
async removeEmployeeRole(businessId: number, roleId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
41400
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.removeEmployeeRole(businessId, roleId, options);
|
|
41401
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
41402
|
+
},
|
|
41403
|
+
}
|
|
41404
|
+
};
|
|
41405
|
+
|
|
41406
|
+
/**
|
|
41407
|
+
* EmployeeRolesApi - factory interface
|
|
41408
|
+
* @export
|
|
41409
|
+
*/
|
|
41410
|
+
export const EmployeeRolesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
41411
|
+
const localVarFp = EmployeeRolesApiFp(configuration)
|
|
41412
|
+
return {
|
|
41413
|
+
/**
|
|
41414
|
+
* 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.
|
|
41415
|
+
* @summary Add an employee role at the venue
|
|
41416
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
41417
|
+
* @param {AddEmployeeRoleDto} addEmployeeRoleDto
|
|
41418
|
+
* @param {*} [options] Override http request option.
|
|
41419
|
+
* @throws {RequiredError}
|
|
41420
|
+
*/
|
|
41421
|
+
addEmployeeRole(businessId: number, addEmployeeRoleDto: AddEmployeeRoleDto, options?: any): AxiosPromise<EmployeeRoleResponseDto> {
|
|
41422
|
+
return localVarFp.addEmployeeRole(businessId, addEmployeeRoleDto, options).then((request) => request(axios, basePath));
|
|
41423
|
+
},
|
|
41424
|
+
/**
|
|
41425
|
+
* 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.
|
|
41426
|
+
* @summary Add the starter employee roles at the venue
|
|
41427
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
41428
|
+
* @param {*} [options] Override http request option.
|
|
41429
|
+
* @throws {RequiredError}
|
|
41430
|
+
*/
|
|
41431
|
+
addStarterEmployeeRoles(businessId: number, options?: any): AxiosPromise<Array<EmployeeRoleResponseDto>> {
|
|
41432
|
+
return localVarFp.addStarterEmployeeRoles(businessId, options).then((request) => request(axios, basePath));
|
|
41433
|
+
},
|
|
41434
|
+
/**
|
|
41435
|
+
* 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.
|
|
41436
|
+
* @summary Change an employee role of the venue
|
|
41437
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
41438
|
+
* @param {string} roleId The role\'s id, one of the venue\'s
|
|
41439
|
+
* @param {ChangeEmployeeRoleDto} changeEmployeeRoleDto
|
|
41440
|
+
* @param {*} [options] Override http request option.
|
|
41441
|
+
* @throws {RequiredError}
|
|
41442
|
+
*/
|
|
41443
|
+
changeEmployeeRole(businessId: number, roleId: string, changeEmployeeRoleDto: ChangeEmployeeRoleDto, options?: any): AxiosPromise<EmployeeRoleResponseDto> {
|
|
41444
|
+
return localVarFp.changeEmployeeRole(businessId, roleId, changeEmployeeRoleDto, options).then((request) => request(axios, basePath));
|
|
41445
|
+
},
|
|
41446
|
+
/**
|
|
41447
|
+
* 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.
|
|
41448
|
+
* @summary List the venue\'s employee roles
|
|
41449
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
41450
|
+
* @param {*} [options] Override http request option.
|
|
41451
|
+
* @throws {RequiredError}
|
|
41452
|
+
*/
|
|
41453
|
+
listEmployeeRoles(businessId: number, options?: any): AxiosPromise<Array<EmployeeRoleResponseDto>> {
|
|
41454
|
+
return localVarFp.listEmployeeRoles(businessId, options).then((request) => request(axios, basePath));
|
|
41455
|
+
},
|
|
41456
|
+
/**
|
|
41457
|
+
* 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.
|
|
41458
|
+
* @summary Remove an employee role of the venue
|
|
41459
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
41460
|
+
* @param {string} roleId The role\'s id, one of the venue\'s
|
|
41461
|
+
* @param {*} [options] Override http request option.
|
|
41462
|
+
* @throws {RequiredError}
|
|
41463
|
+
*/
|
|
41464
|
+
removeEmployeeRole(businessId: number, roleId: string, options?: any): AxiosPromise<void> {
|
|
41465
|
+
return localVarFp.removeEmployeeRole(businessId, roleId, options).then((request) => request(axios, basePath));
|
|
41466
|
+
},
|
|
41467
|
+
};
|
|
41468
|
+
};
|
|
41469
|
+
|
|
41470
|
+
/**
|
|
41471
|
+
* EmployeeRolesApi - interface
|
|
41472
|
+
* @export
|
|
41473
|
+
* @interface EmployeeRolesApi
|
|
41474
|
+
*/
|
|
41475
|
+
export interface EmployeeRolesApiInterface {
|
|
41476
|
+
/**
|
|
41477
|
+
* 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.
|
|
41478
|
+
* @summary Add an employee role at the venue
|
|
41479
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
41480
|
+
* @param {AddEmployeeRoleDto} addEmployeeRoleDto
|
|
41481
|
+
* @param {*} [options] Override http request option.
|
|
41482
|
+
* @throws {RequiredError}
|
|
41483
|
+
* @memberof EmployeeRolesApiInterface
|
|
41484
|
+
*/
|
|
41485
|
+
addEmployeeRole(businessId: number, addEmployeeRoleDto: AddEmployeeRoleDto, options?: AxiosRequestConfig): AxiosPromise<EmployeeRoleResponseDto>;
|
|
41486
|
+
|
|
41487
|
+
/**
|
|
41488
|
+
* 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.
|
|
41489
|
+
* @summary Add the starter employee roles at the venue
|
|
41490
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
41491
|
+
* @param {*} [options] Override http request option.
|
|
41492
|
+
* @throws {RequiredError}
|
|
41493
|
+
* @memberof EmployeeRolesApiInterface
|
|
41494
|
+
*/
|
|
41495
|
+
addStarterEmployeeRoles(businessId: number, options?: AxiosRequestConfig): AxiosPromise<Array<EmployeeRoleResponseDto>>;
|
|
41496
|
+
|
|
41497
|
+
/**
|
|
41498
|
+
* 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.
|
|
41499
|
+
* @summary Change an employee role of the venue
|
|
41500
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
41501
|
+
* @param {string} roleId The role\'s id, one of the venue\'s
|
|
41502
|
+
* @param {ChangeEmployeeRoleDto} changeEmployeeRoleDto
|
|
41503
|
+
* @param {*} [options] Override http request option.
|
|
41504
|
+
* @throws {RequiredError}
|
|
41505
|
+
* @memberof EmployeeRolesApiInterface
|
|
41506
|
+
*/
|
|
41507
|
+
changeEmployeeRole(businessId: number, roleId: string, changeEmployeeRoleDto: ChangeEmployeeRoleDto, options?: AxiosRequestConfig): AxiosPromise<EmployeeRoleResponseDto>;
|
|
41508
|
+
|
|
41509
|
+
/**
|
|
41510
|
+
* 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.
|
|
41511
|
+
* @summary List the venue\'s employee roles
|
|
41512
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
41513
|
+
* @param {*} [options] Override http request option.
|
|
41514
|
+
* @throws {RequiredError}
|
|
41515
|
+
* @memberof EmployeeRolesApiInterface
|
|
41516
|
+
*/
|
|
41517
|
+
listEmployeeRoles(businessId: number, options?: AxiosRequestConfig): AxiosPromise<Array<EmployeeRoleResponseDto>>;
|
|
41518
|
+
|
|
41519
|
+
/**
|
|
41520
|
+
* 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.
|
|
41521
|
+
* @summary Remove an employee role of the venue
|
|
41522
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
41523
|
+
* @param {string} roleId The role\'s id, one of the venue\'s
|
|
41524
|
+
* @param {*} [options] Override http request option.
|
|
41525
|
+
* @throws {RequiredError}
|
|
41526
|
+
* @memberof EmployeeRolesApiInterface
|
|
41527
|
+
*/
|
|
41528
|
+
removeEmployeeRole(businessId: number, roleId: string, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
41529
|
+
|
|
41530
|
+
}
|
|
41531
|
+
|
|
41532
|
+
/**
|
|
41533
|
+
* EmployeeRolesApi - object-oriented interface
|
|
41534
|
+
* @export
|
|
41535
|
+
* @class EmployeeRolesApi
|
|
41536
|
+
* @extends {BaseAPI}
|
|
41537
|
+
*/
|
|
41538
|
+
export class EmployeeRolesApi extends BaseAPI implements EmployeeRolesApiInterface {
|
|
41539
|
+
/**
|
|
41540
|
+
* 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.
|
|
41541
|
+
* @summary Add an employee role at the venue
|
|
41542
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
41543
|
+
* @param {AddEmployeeRoleDto} addEmployeeRoleDto
|
|
41544
|
+
* @param {*} [options] Override http request option.
|
|
41545
|
+
* @throws {RequiredError}
|
|
41546
|
+
* @memberof EmployeeRolesApi
|
|
41547
|
+
*/
|
|
41548
|
+
public addEmployeeRole(businessId: number, addEmployeeRoleDto: AddEmployeeRoleDto, options?: AxiosRequestConfig) {
|
|
41549
|
+
return EmployeeRolesApiFp(this.configuration).addEmployeeRole(businessId, addEmployeeRoleDto, options).then((request) => request(this.axios, this.basePath));
|
|
41550
|
+
}
|
|
41551
|
+
|
|
41552
|
+
/**
|
|
41553
|
+
* 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.
|
|
41554
|
+
* @summary Add the starter employee roles at the venue
|
|
41555
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
41556
|
+
* @param {*} [options] Override http request option.
|
|
41557
|
+
* @throws {RequiredError}
|
|
41558
|
+
* @memberof EmployeeRolesApi
|
|
41559
|
+
*/
|
|
41560
|
+
public addStarterEmployeeRoles(businessId: number, options?: AxiosRequestConfig) {
|
|
41561
|
+
return EmployeeRolesApiFp(this.configuration).addStarterEmployeeRoles(businessId, options).then((request) => request(this.axios, this.basePath));
|
|
41562
|
+
}
|
|
41563
|
+
|
|
41564
|
+
/**
|
|
41565
|
+
* 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.
|
|
41566
|
+
* @summary Change an employee role of the venue
|
|
41567
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
41568
|
+
* @param {string} roleId The role\'s id, one of the venue\'s
|
|
41569
|
+
* @param {ChangeEmployeeRoleDto} changeEmployeeRoleDto
|
|
41570
|
+
* @param {*} [options] Override http request option.
|
|
41571
|
+
* @throws {RequiredError}
|
|
41572
|
+
* @memberof EmployeeRolesApi
|
|
41573
|
+
*/
|
|
41574
|
+
public changeEmployeeRole(businessId: number, roleId: string, changeEmployeeRoleDto: ChangeEmployeeRoleDto, options?: AxiosRequestConfig) {
|
|
41575
|
+
return EmployeeRolesApiFp(this.configuration).changeEmployeeRole(businessId, roleId, changeEmployeeRoleDto, options).then((request) => request(this.axios, this.basePath));
|
|
41576
|
+
}
|
|
41577
|
+
|
|
41578
|
+
/**
|
|
41579
|
+
* 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.
|
|
41580
|
+
* @summary List the venue\'s employee roles
|
|
41581
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
41582
|
+
* @param {*} [options] Override http request option.
|
|
41583
|
+
* @throws {RequiredError}
|
|
41584
|
+
* @memberof EmployeeRolesApi
|
|
41585
|
+
*/
|
|
41586
|
+
public listEmployeeRoles(businessId: number, options?: AxiosRequestConfig) {
|
|
41587
|
+
return EmployeeRolesApiFp(this.configuration).listEmployeeRoles(businessId, options).then((request) => request(this.axios, this.basePath));
|
|
41588
|
+
}
|
|
41589
|
+
|
|
41590
|
+
/**
|
|
41591
|
+
* 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.
|
|
41592
|
+
* @summary Remove an employee role of the venue
|
|
41593
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
41594
|
+
* @param {string} roleId The role\'s id, one of the venue\'s
|
|
41595
|
+
* @param {*} [options] Override http request option.
|
|
41596
|
+
* @throws {RequiredError}
|
|
41597
|
+
* @memberof EmployeeRolesApi
|
|
41598
|
+
*/
|
|
41599
|
+
public removeEmployeeRole(businessId: number, roleId: string, options?: AxiosRequestConfig) {
|
|
41600
|
+
return EmployeeRolesApiFp(this.configuration).removeEmployeeRole(businessId, roleId, options).then((request) => request(this.axios, this.basePath));
|
|
41601
|
+
}
|
|
41602
|
+
}
|
|
41603
|
+
|
|
41604
|
+
|
|
41605
|
+
/**
|
|
41606
|
+
* EmployeesApi - axios parameter creator
|
|
41607
|
+
* @export
|
|
41608
|
+
*/
|
|
41609
|
+
export const EmployeesApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
41610
|
+
return {
|
|
41611
|
+
/**
|
|
41612
|
+
* 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.
|
|
41613
|
+
* @summary Add an employee at the venue
|
|
41614
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
41615
|
+
* @param {AddEmployeeDto} addEmployeeDto
|
|
41616
|
+
* @param {*} [options] Override http request option.
|
|
41617
|
+
* @throws {RequiredError}
|
|
41618
|
+
*/
|
|
41619
|
+
addEmployee: async (businessId: number, addEmployeeDto: AddEmployeeDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
41620
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
41621
|
+
assertParamExists('addEmployee', 'businessId', businessId)
|
|
41622
|
+
// verify required parameter 'addEmployeeDto' is not null or undefined
|
|
41623
|
+
assertParamExists('addEmployee', 'addEmployeeDto', addEmployeeDto)
|
|
41624
|
+
const localVarPath = `/api/v2/businesses/{businessId}/employees`
|
|
41625
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)));
|
|
41626
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
41627
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
41628
|
+
let baseOptions;
|
|
41629
|
+
if (configuration) {
|
|
41630
|
+
baseOptions = configuration.baseOptions;
|
|
41631
|
+
}
|
|
41632
|
+
|
|
41633
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
41634
|
+
const localVarHeaderParameter = {} as any;
|
|
41635
|
+
const localVarQueryParameter = {} as any;
|
|
41636
|
+
|
|
41637
|
+
// authentication JWT-auth required
|
|
41638
|
+
// http bearer authentication required
|
|
41639
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
41640
|
+
|
|
41641
|
+
|
|
41642
|
+
|
|
41643
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
41644
|
+
|
|
41645
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
41646
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
41647
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
41648
|
+
localVarRequestOptions.data = serializeDataIfNeeded(addEmployeeDto, localVarRequestOptions, configuration)
|
|
41649
|
+
|
|
41650
|
+
return {
|
|
41651
|
+
url: toPathString(localVarUrlObj),
|
|
41652
|
+
options: localVarRequestOptions,
|
|
41653
|
+
};
|
|
41654
|
+
},
|
|
41655
|
+
/**
|
|
41656
|
+
* 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.
|
|
41657
|
+
* @summary Change an employee
|
|
41658
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
41659
|
+
* @param {string} employeeId The employee\'s id, one of the venue\'s merchant
|
|
41660
|
+
* @param {ChangeEmployeeDto} changeEmployeeDto
|
|
41661
|
+
* @param {*} [options] Override http request option.
|
|
41662
|
+
* @throws {RequiredError}
|
|
41663
|
+
*/
|
|
41664
|
+
changeEmployee: async (businessId: number, employeeId: string, changeEmployeeDto: ChangeEmployeeDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
41665
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
41666
|
+
assertParamExists('changeEmployee', 'businessId', businessId)
|
|
41667
|
+
// verify required parameter 'employeeId' is not null or undefined
|
|
41668
|
+
assertParamExists('changeEmployee', 'employeeId', employeeId)
|
|
41669
|
+
// verify required parameter 'changeEmployeeDto' is not null or undefined
|
|
41670
|
+
assertParamExists('changeEmployee', 'changeEmployeeDto', changeEmployeeDto)
|
|
41671
|
+
const localVarPath = `/api/v2/businesses/{businessId}/employees/{employeeId}`
|
|
41672
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)))
|
|
41673
|
+
.replace(`{${"employeeId"}}`, encodeURIComponent(String(employeeId)));
|
|
41674
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
41675
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
41676
|
+
let baseOptions;
|
|
41677
|
+
if (configuration) {
|
|
41678
|
+
baseOptions = configuration.baseOptions;
|
|
41679
|
+
}
|
|
41680
|
+
|
|
41681
|
+
const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
|
|
41682
|
+
const localVarHeaderParameter = {} as any;
|
|
41683
|
+
const localVarQueryParameter = {} as any;
|
|
41684
|
+
|
|
41685
|
+
// authentication JWT-auth required
|
|
41686
|
+
// http bearer authentication required
|
|
41687
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
41688
|
+
|
|
41689
|
+
|
|
41690
|
+
|
|
41691
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
41692
|
+
|
|
41693
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
41694
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
41695
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
41696
|
+
localVarRequestOptions.data = serializeDataIfNeeded(changeEmployeeDto, localVarRequestOptions, configuration)
|
|
41697
|
+
|
|
41698
|
+
return {
|
|
41699
|
+
url: toPathString(localVarUrlObj),
|
|
41700
|
+
options: localVarRequestOptions,
|
|
41701
|
+
};
|
|
41702
|
+
},
|
|
41703
|
+
/**
|
|
41704
|
+
* 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.
|
|
41705
|
+
* @summary List the venue\'s employees
|
|
41706
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
41707
|
+
* @param {string} [cursor] The nextCursor of the page before; absent for the first page
|
|
41708
|
+
* @param {number} [limit] How many employees a page holds, 100 at most
|
|
41709
|
+
* @param {*} [options] Override http request option.
|
|
41710
|
+
* @throws {RequiredError}
|
|
41711
|
+
*/
|
|
41712
|
+
listEmployees: async (businessId: number, cursor?: string, limit?: number, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
41713
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
41714
|
+
assertParamExists('listEmployees', 'businessId', businessId)
|
|
41715
|
+
const localVarPath = `/api/v2/businesses/{businessId}/employees`
|
|
41716
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)));
|
|
41717
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
41718
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
41719
|
+
let baseOptions;
|
|
41720
|
+
if (configuration) {
|
|
41721
|
+
baseOptions = configuration.baseOptions;
|
|
41722
|
+
}
|
|
41723
|
+
|
|
41724
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
41725
|
+
const localVarHeaderParameter = {} as any;
|
|
41726
|
+
const localVarQueryParameter = {} as any;
|
|
41727
|
+
|
|
41728
|
+
// authentication JWT-auth required
|
|
41729
|
+
// http bearer authentication required
|
|
41730
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
41731
|
+
|
|
41732
|
+
if (cursor !== undefined) {
|
|
41733
|
+
localVarQueryParameter['cursor'] = cursor;
|
|
41734
|
+
}
|
|
41735
|
+
|
|
41736
|
+
if (limit !== undefined) {
|
|
41737
|
+
localVarQueryParameter['limit'] = limit;
|
|
41738
|
+
}
|
|
41739
|
+
|
|
41740
|
+
|
|
41741
|
+
|
|
41742
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
41743
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
41744
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
41745
|
+
|
|
41746
|
+
return {
|
|
41747
|
+
url: toPathString(localVarUrlObj),
|
|
41748
|
+
options: localVarRequestOptions,
|
|
41749
|
+
};
|
|
41750
|
+
},
|
|
41751
|
+
/**
|
|
41752
|
+
* 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.
|
|
41753
|
+
* @summary Remove an employee from the venue
|
|
41754
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
41755
|
+
* @param {string} employeeId The employee\'s id, one of the venue\'s merchant
|
|
41756
|
+
* @param {*} [options] Override http request option.
|
|
41757
|
+
* @throws {RequiredError}
|
|
41758
|
+
*/
|
|
41759
|
+
removeEmployeeFromVenue: async (businessId: number, employeeId: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
41760
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
41761
|
+
assertParamExists('removeEmployeeFromVenue', 'businessId', businessId)
|
|
41762
|
+
// verify required parameter 'employeeId' is not null or undefined
|
|
41763
|
+
assertParamExists('removeEmployeeFromVenue', 'employeeId', employeeId)
|
|
41764
|
+
const localVarPath = `/api/v2/businesses/{businessId}/employees/{employeeId}/role`
|
|
41765
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)))
|
|
41766
|
+
.replace(`{${"employeeId"}}`, encodeURIComponent(String(employeeId)));
|
|
41767
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
41768
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
41769
|
+
let baseOptions;
|
|
41770
|
+
if (configuration) {
|
|
41771
|
+
baseOptions = configuration.baseOptions;
|
|
41772
|
+
}
|
|
41773
|
+
|
|
41774
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
|
|
41775
|
+
const localVarHeaderParameter = {} as any;
|
|
41776
|
+
const localVarQueryParameter = {} as any;
|
|
41777
|
+
|
|
41778
|
+
// authentication JWT-auth required
|
|
41779
|
+
// http bearer authentication required
|
|
41780
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
41781
|
+
|
|
41782
|
+
|
|
41783
|
+
|
|
41784
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
41785
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
41786
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
41787
|
+
|
|
41788
|
+
return {
|
|
41789
|
+
url: toPathString(localVarUrlObj),
|
|
41790
|
+
options: localVarRequestOptions,
|
|
41791
|
+
};
|
|
41792
|
+
},
|
|
41793
|
+
/**
|
|
41794
|
+
* 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.
|
|
41795
|
+
* @summary Set an employee\'s role at the venue
|
|
41796
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
41797
|
+
* @param {string} employeeId The employee\'s id, one of the venue\'s merchant
|
|
41798
|
+
* @param {SetEmployeeRoleDto} setEmployeeRoleDto
|
|
41799
|
+
* @param {*} [options] Override http request option.
|
|
41800
|
+
* @throws {RequiredError}
|
|
41801
|
+
*/
|
|
41802
|
+
setEmployeeRole: async (businessId: number, employeeId: string, setEmployeeRoleDto: SetEmployeeRoleDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
41803
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
41804
|
+
assertParamExists('setEmployeeRole', 'businessId', businessId)
|
|
41805
|
+
// verify required parameter 'employeeId' is not null or undefined
|
|
41806
|
+
assertParamExists('setEmployeeRole', 'employeeId', employeeId)
|
|
41807
|
+
// verify required parameter 'setEmployeeRoleDto' is not null or undefined
|
|
41808
|
+
assertParamExists('setEmployeeRole', 'setEmployeeRoleDto', setEmployeeRoleDto)
|
|
41809
|
+
const localVarPath = `/api/v2/businesses/{businessId}/employees/{employeeId}/role`
|
|
41810
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)))
|
|
41811
|
+
.replace(`{${"employeeId"}}`, encodeURIComponent(String(employeeId)));
|
|
41812
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
41813
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
41814
|
+
let baseOptions;
|
|
41815
|
+
if (configuration) {
|
|
41816
|
+
baseOptions = configuration.baseOptions;
|
|
41817
|
+
}
|
|
41818
|
+
|
|
41819
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
|
|
41820
|
+
const localVarHeaderParameter = {} as any;
|
|
41821
|
+
const localVarQueryParameter = {} as any;
|
|
41822
|
+
|
|
41823
|
+
// authentication JWT-auth required
|
|
41824
|
+
// http bearer authentication required
|
|
41825
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
41826
|
+
|
|
41827
|
+
|
|
41828
|
+
|
|
41829
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
41830
|
+
|
|
41831
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
41832
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
41833
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
41834
|
+
localVarRequestOptions.data = serializeDataIfNeeded(setEmployeeRoleDto, localVarRequestOptions, configuration)
|
|
41835
|
+
|
|
41836
|
+
return {
|
|
41837
|
+
url: toPathString(localVarUrlObj),
|
|
41838
|
+
options: localVarRequestOptions,
|
|
41839
|
+
};
|
|
41840
|
+
},
|
|
41841
|
+
}
|
|
41842
|
+
};
|
|
41843
|
+
|
|
41844
|
+
/**
|
|
41845
|
+
* EmployeesApi - functional programming interface
|
|
41846
|
+
* @export
|
|
41847
|
+
*/
|
|
41848
|
+
export const EmployeesApiFp = function(configuration?: Configuration) {
|
|
41849
|
+
const localVarAxiosParamCreator = EmployeesApiAxiosParamCreator(configuration)
|
|
41850
|
+
return {
|
|
41851
|
+
/**
|
|
41852
|
+
* 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.
|
|
41853
|
+
* @summary Add an employee at the venue
|
|
41854
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
41855
|
+
* @param {AddEmployeeDto} addEmployeeDto
|
|
41856
|
+
* @param {*} [options] Override http request option.
|
|
41857
|
+
* @throws {RequiredError}
|
|
41858
|
+
*/
|
|
41859
|
+
async addEmployee(businessId: number, addEmployeeDto: AddEmployeeDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmployeeResponseDto>> {
|
|
41860
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.addEmployee(businessId, addEmployeeDto, options);
|
|
41861
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
41862
|
+
},
|
|
41863
|
+
/**
|
|
41864
|
+
* 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.
|
|
41865
|
+
* @summary Change an employee
|
|
41866
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
41867
|
+
* @param {string} employeeId The employee\'s id, one of the venue\'s merchant
|
|
41868
|
+
* @param {ChangeEmployeeDto} changeEmployeeDto
|
|
41869
|
+
* @param {*} [options] Override http request option.
|
|
41870
|
+
* @throws {RequiredError}
|
|
41871
|
+
*/
|
|
41872
|
+
async changeEmployee(businessId: number, employeeId: string, changeEmployeeDto: ChangeEmployeeDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmployeeResponseDto>> {
|
|
41873
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.changeEmployee(businessId, employeeId, changeEmployeeDto, options);
|
|
41874
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
41875
|
+
},
|
|
41876
|
+
/**
|
|
41877
|
+
* 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.
|
|
41878
|
+
* @summary List the venue\'s employees
|
|
41879
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
41880
|
+
* @param {string} [cursor] The nextCursor of the page before; absent for the first page
|
|
41881
|
+
* @param {number} [limit] How many employees a page holds, 100 at most
|
|
41882
|
+
* @param {*} [options] Override http request option.
|
|
41883
|
+
* @throws {RequiredError}
|
|
41884
|
+
*/
|
|
41885
|
+
async listEmployees(businessId: number, cursor?: string, limit?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmployeePageResponseDto>> {
|
|
41886
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listEmployees(businessId, cursor, limit, options);
|
|
41887
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
41888
|
+
},
|
|
41889
|
+
/**
|
|
41890
|
+
* 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.
|
|
41891
|
+
* @summary Remove an employee from the venue
|
|
41892
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
41893
|
+
* @param {string} employeeId The employee\'s id, one of the venue\'s merchant
|
|
41894
|
+
* @param {*} [options] Override http request option.
|
|
41895
|
+
* @throws {RequiredError}
|
|
41896
|
+
*/
|
|
41897
|
+
async removeEmployeeFromVenue(businessId: number, employeeId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
41898
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.removeEmployeeFromVenue(businessId, employeeId, options);
|
|
41899
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
41900
|
+
},
|
|
41901
|
+
/**
|
|
41902
|
+
* 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.
|
|
41903
|
+
* @summary Set an employee\'s role at the venue
|
|
41904
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
41905
|
+
* @param {string} employeeId The employee\'s id, one of the venue\'s merchant
|
|
41906
|
+
* @param {SetEmployeeRoleDto} setEmployeeRoleDto
|
|
41907
|
+
* @param {*} [options] Override http request option.
|
|
41908
|
+
* @throws {RequiredError}
|
|
41909
|
+
*/
|
|
41910
|
+
async setEmployeeRole(businessId: number, employeeId: string, setEmployeeRoleDto: SetEmployeeRoleDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmployeeResponseDto>> {
|
|
41911
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.setEmployeeRole(businessId, employeeId, setEmployeeRoleDto, options);
|
|
41912
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
41913
|
+
},
|
|
41914
|
+
}
|
|
41915
|
+
};
|
|
41916
|
+
|
|
41917
|
+
/**
|
|
41918
|
+
* EmployeesApi - factory interface
|
|
41919
|
+
* @export
|
|
41920
|
+
*/
|
|
41921
|
+
export const EmployeesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
41922
|
+
const localVarFp = EmployeesApiFp(configuration)
|
|
41923
|
+
return {
|
|
41924
|
+
/**
|
|
41925
|
+
* 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.
|
|
41926
|
+
* @summary Add an employee at the venue
|
|
41927
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
41928
|
+
* @param {AddEmployeeDto} addEmployeeDto
|
|
41929
|
+
* @param {*} [options] Override http request option.
|
|
41930
|
+
* @throws {RequiredError}
|
|
41931
|
+
*/
|
|
41932
|
+
addEmployee(businessId: number, addEmployeeDto: AddEmployeeDto, options?: any): AxiosPromise<EmployeeResponseDto> {
|
|
41933
|
+
return localVarFp.addEmployee(businessId, addEmployeeDto, options).then((request) => request(axios, basePath));
|
|
41934
|
+
},
|
|
41935
|
+
/**
|
|
41936
|
+
* 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.
|
|
41937
|
+
* @summary Change an employee
|
|
41938
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
41939
|
+
* @param {string} employeeId The employee\'s id, one of the venue\'s merchant
|
|
41940
|
+
* @param {ChangeEmployeeDto} changeEmployeeDto
|
|
41941
|
+
* @param {*} [options] Override http request option.
|
|
41942
|
+
* @throws {RequiredError}
|
|
41943
|
+
*/
|
|
41944
|
+
changeEmployee(businessId: number, employeeId: string, changeEmployeeDto: ChangeEmployeeDto, options?: any): AxiosPromise<EmployeeResponseDto> {
|
|
41945
|
+
return localVarFp.changeEmployee(businessId, employeeId, changeEmployeeDto, options).then((request) => request(axios, basePath));
|
|
41946
|
+
},
|
|
41947
|
+
/**
|
|
41948
|
+
* 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.
|
|
41949
|
+
* @summary List the venue\'s employees
|
|
41950
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
41951
|
+
* @param {string} [cursor] The nextCursor of the page before; absent for the first page
|
|
41952
|
+
* @param {number} [limit] How many employees a page holds, 100 at most
|
|
41953
|
+
* @param {*} [options] Override http request option.
|
|
41954
|
+
* @throws {RequiredError}
|
|
41955
|
+
*/
|
|
41956
|
+
listEmployees(businessId: number, cursor?: string, limit?: number, options?: any): AxiosPromise<EmployeePageResponseDto> {
|
|
41957
|
+
return localVarFp.listEmployees(businessId, cursor, limit, options).then((request) => request(axios, basePath));
|
|
41958
|
+
},
|
|
41959
|
+
/**
|
|
41960
|
+
* 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.
|
|
41961
|
+
* @summary Remove an employee from the venue
|
|
41962
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
41963
|
+
* @param {string} employeeId The employee\'s id, one of the venue\'s merchant
|
|
41964
|
+
* @param {*} [options] Override http request option.
|
|
41965
|
+
* @throws {RequiredError}
|
|
41966
|
+
*/
|
|
41967
|
+
removeEmployeeFromVenue(businessId: number, employeeId: string, options?: any): AxiosPromise<void> {
|
|
41968
|
+
return localVarFp.removeEmployeeFromVenue(businessId, employeeId, options).then((request) => request(axios, basePath));
|
|
41969
|
+
},
|
|
41970
|
+
/**
|
|
41971
|
+
* 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.
|
|
41972
|
+
* @summary Set an employee\'s role at the venue
|
|
41973
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
41974
|
+
* @param {string} employeeId The employee\'s id, one of the venue\'s merchant
|
|
41975
|
+
* @param {SetEmployeeRoleDto} setEmployeeRoleDto
|
|
41976
|
+
* @param {*} [options] Override http request option.
|
|
41977
|
+
* @throws {RequiredError}
|
|
41978
|
+
*/
|
|
41979
|
+
setEmployeeRole(businessId: number, employeeId: string, setEmployeeRoleDto: SetEmployeeRoleDto, options?: any): AxiosPromise<EmployeeResponseDto> {
|
|
41980
|
+
return localVarFp.setEmployeeRole(businessId, employeeId, setEmployeeRoleDto, options).then((request) => request(axios, basePath));
|
|
41981
|
+
},
|
|
41982
|
+
};
|
|
41983
|
+
};
|
|
41984
|
+
|
|
41985
|
+
/**
|
|
41986
|
+
* EmployeesApi - interface
|
|
41987
|
+
* @export
|
|
41988
|
+
* @interface EmployeesApi
|
|
41989
|
+
*/
|
|
41990
|
+
export interface EmployeesApiInterface {
|
|
41991
|
+
/**
|
|
41992
|
+
* 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.
|
|
41993
|
+
* @summary Add an employee at the venue
|
|
41994
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
41995
|
+
* @param {AddEmployeeDto} addEmployeeDto
|
|
41996
|
+
* @param {*} [options] Override http request option.
|
|
41997
|
+
* @throws {RequiredError}
|
|
41998
|
+
* @memberof EmployeesApiInterface
|
|
41999
|
+
*/
|
|
42000
|
+
addEmployee(businessId: number, addEmployeeDto: AddEmployeeDto, options?: AxiosRequestConfig): AxiosPromise<EmployeeResponseDto>;
|
|
42001
|
+
|
|
42002
|
+
/**
|
|
42003
|
+
* 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.
|
|
42004
|
+
* @summary Change an employee
|
|
42005
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
42006
|
+
* @param {string} employeeId The employee\'s id, one of the venue\'s merchant
|
|
42007
|
+
* @param {ChangeEmployeeDto} changeEmployeeDto
|
|
42008
|
+
* @param {*} [options] Override http request option.
|
|
42009
|
+
* @throws {RequiredError}
|
|
42010
|
+
* @memberof EmployeesApiInterface
|
|
42011
|
+
*/
|
|
42012
|
+
changeEmployee(businessId: number, employeeId: string, changeEmployeeDto: ChangeEmployeeDto, options?: AxiosRequestConfig): AxiosPromise<EmployeeResponseDto>;
|
|
42013
|
+
|
|
42014
|
+
/**
|
|
42015
|
+
* 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.
|
|
42016
|
+
* @summary List the venue\'s employees
|
|
42017
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
42018
|
+
* @param {string} [cursor] The nextCursor of the page before; absent for the first page
|
|
42019
|
+
* @param {number} [limit] How many employees a page holds, 100 at most
|
|
42020
|
+
* @param {*} [options] Override http request option.
|
|
42021
|
+
* @throws {RequiredError}
|
|
42022
|
+
* @memberof EmployeesApiInterface
|
|
42023
|
+
*/
|
|
42024
|
+
listEmployees(businessId: number, cursor?: string, limit?: number, options?: AxiosRequestConfig): AxiosPromise<EmployeePageResponseDto>;
|
|
42025
|
+
|
|
42026
|
+
/**
|
|
42027
|
+
* 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.
|
|
42028
|
+
* @summary Remove an employee from the venue
|
|
42029
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
42030
|
+
* @param {string} employeeId The employee\'s id, one of the venue\'s merchant
|
|
42031
|
+
* @param {*} [options] Override http request option.
|
|
42032
|
+
* @throws {RequiredError}
|
|
42033
|
+
* @memberof EmployeesApiInterface
|
|
42034
|
+
*/
|
|
42035
|
+
removeEmployeeFromVenue(businessId: number, employeeId: string, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
42036
|
+
|
|
42037
|
+
/**
|
|
42038
|
+
* 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.
|
|
42039
|
+
* @summary Set an employee\'s role at the venue
|
|
42040
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
42041
|
+
* @param {string} employeeId The employee\'s id, one of the venue\'s merchant
|
|
42042
|
+
* @param {SetEmployeeRoleDto} setEmployeeRoleDto
|
|
42043
|
+
* @param {*} [options] Override http request option.
|
|
42044
|
+
* @throws {RequiredError}
|
|
42045
|
+
* @memberof EmployeesApiInterface
|
|
42046
|
+
*/
|
|
42047
|
+
setEmployeeRole(businessId: number, employeeId: string, setEmployeeRoleDto: SetEmployeeRoleDto, options?: AxiosRequestConfig): AxiosPromise<EmployeeResponseDto>;
|
|
42048
|
+
|
|
42049
|
+
}
|
|
42050
|
+
|
|
42051
|
+
/**
|
|
42052
|
+
* EmployeesApi - object-oriented interface
|
|
42053
|
+
* @export
|
|
42054
|
+
* @class EmployeesApi
|
|
42055
|
+
* @extends {BaseAPI}
|
|
42056
|
+
*/
|
|
42057
|
+
export class EmployeesApi extends BaseAPI implements EmployeesApiInterface {
|
|
42058
|
+
/**
|
|
42059
|
+
* 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.
|
|
42060
|
+
* @summary Add an employee at the venue
|
|
42061
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
42062
|
+
* @param {AddEmployeeDto} addEmployeeDto
|
|
42063
|
+
* @param {*} [options] Override http request option.
|
|
42064
|
+
* @throws {RequiredError}
|
|
42065
|
+
* @memberof EmployeesApi
|
|
42066
|
+
*/
|
|
42067
|
+
public addEmployee(businessId: number, addEmployeeDto: AddEmployeeDto, options?: AxiosRequestConfig) {
|
|
42068
|
+
return EmployeesApiFp(this.configuration).addEmployee(businessId, addEmployeeDto, options).then((request) => request(this.axios, this.basePath));
|
|
42069
|
+
}
|
|
42070
|
+
|
|
42071
|
+
/**
|
|
42072
|
+
* 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.
|
|
42073
|
+
* @summary Change an employee
|
|
42074
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
42075
|
+
* @param {string} employeeId The employee\'s id, one of the venue\'s merchant
|
|
42076
|
+
* @param {ChangeEmployeeDto} changeEmployeeDto
|
|
42077
|
+
* @param {*} [options] Override http request option.
|
|
42078
|
+
* @throws {RequiredError}
|
|
42079
|
+
* @memberof EmployeesApi
|
|
42080
|
+
*/
|
|
42081
|
+
public changeEmployee(businessId: number, employeeId: string, changeEmployeeDto: ChangeEmployeeDto, options?: AxiosRequestConfig) {
|
|
42082
|
+
return EmployeesApiFp(this.configuration).changeEmployee(businessId, employeeId, changeEmployeeDto, options).then((request) => request(this.axios, this.basePath));
|
|
42083
|
+
}
|
|
42084
|
+
|
|
42085
|
+
/**
|
|
42086
|
+
* 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.
|
|
42087
|
+
* @summary List the venue\'s employees
|
|
42088
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
42089
|
+
* @param {string} [cursor] The nextCursor of the page before; absent for the first page
|
|
42090
|
+
* @param {number} [limit] How many employees a page holds, 100 at most
|
|
42091
|
+
* @param {*} [options] Override http request option.
|
|
42092
|
+
* @throws {RequiredError}
|
|
42093
|
+
* @memberof EmployeesApi
|
|
42094
|
+
*/
|
|
42095
|
+
public listEmployees(businessId: number, cursor?: string, limit?: number, options?: AxiosRequestConfig) {
|
|
42096
|
+
return EmployeesApiFp(this.configuration).listEmployees(businessId, cursor, limit, options).then((request) => request(this.axios, this.basePath));
|
|
42097
|
+
}
|
|
42098
|
+
|
|
42099
|
+
/**
|
|
42100
|
+
* 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.
|
|
42101
|
+
* @summary Remove an employee from the venue
|
|
42102
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
42103
|
+
* @param {string} employeeId The employee\'s id, one of the venue\'s merchant
|
|
42104
|
+
* @param {*} [options] Override http request option.
|
|
42105
|
+
* @throws {RequiredError}
|
|
42106
|
+
* @memberof EmployeesApi
|
|
42107
|
+
*/
|
|
42108
|
+
public removeEmployeeFromVenue(businessId: number, employeeId: string, options?: AxiosRequestConfig) {
|
|
42109
|
+
return EmployeesApiFp(this.configuration).removeEmployeeFromVenue(businessId, employeeId, options).then((request) => request(this.axios, this.basePath));
|
|
42110
|
+
}
|
|
42111
|
+
|
|
42112
|
+
/**
|
|
42113
|
+
* 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.
|
|
42114
|
+
* @summary Set an employee\'s role at the venue
|
|
42115
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
42116
|
+
* @param {string} employeeId The employee\'s id, one of the venue\'s merchant
|
|
42117
|
+
* @param {SetEmployeeRoleDto} setEmployeeRoleDto
|
|
42118
|
+
* @param {*} [options] Override http request option.
|
|
42119
|
+
* @throws {RequiredError}
|
|
42120
|
+
* @memberof EmployeesApi
|
|
42121
|
+
*/
|
|
42122
|
+
public setEmployeeRole(businessId: number, employeeId: string, setEmployeeRoleDto: SetEmployeeRoleDto, options?: AxiosRequestConfig) {
|
|
42123
|
+
return EmployeesApiFp(this.configuration).setEmployeeRole(businessId, employeeId, setEmployeeRoleDto, options).then((request) => request(this.axios, this.basePath));
|
|
42124
|
+
}
|
|
42125
|
+
}
|
|
42126
|
+
|
|
42127
|
+
|
|
40620
42128
|
/**
|
|
40621
42129
|
* FloorPlanApi - axios parameter creator
|
|
40622
42130
|
* @export
|
|
@@ -46656,7 +48164,223 @@ export const NotificationApiAxiosParamCreator = function (configuration?: Config
|
|
|
46656
48164
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
46657
48165
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
46658
48166
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
46659
|
-
localVarRequestOptions.data = serializeDataIfNeeded(deviceSubscriptionDto, localVarRequestOptions, configuration)
|
|
48167
|
+
localVarRequestOptions.data = serializeDataIfNeeded(deviceSubscriptionDto, localVarRequestOptions, configuration)
|
|
48168
|
+
|
|
48169
|
+
return {
|
|
48170
|
+
url: toPathString(localVarUrlObj),
|
|
48171
|
+
options: localVarRequestOptions,
|
|
48172
|
+
};
|
|
48173
|
+
},
|
|
48174
|
+
/**
|
|
48175
|
+
* Unsubscribe a device from multiple venue/business notifications using hardware ID.
|
|
48176
|
+
* @summary Remove venue subscriptions for push notifications
|
|
48177
|
+
* @param {DeviceSubscriptionDto} deviceSubscriptionDto
|
|
48178
|
+
* @param {*} [options] Override http request option.
|
|
48179
|
+
* @throws {RequiredError}
|
|
48180
|
+
*/
|
|
48181
|
+
removeVenueSubscriptionsV2: async (deviceSubscriptionDto: DeviceSubscriptionDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
48182
|
+
// verify required parameter 'deviceSubscriptionDto' is not null or undefined
|
|
48183
|
+
assertParamExists('removeVenueSubscriptionsV2', 'deviceSubscriptionDto', deviceSubscriptionDto)
|
|
48184
|
+
const localVarPath = `/api/v2/notification/remove-venue-subscriptions`;
|
|
48185
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
48186
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
48187
|
+
let baseOptions;
|
|
48188
|
+
if (configuration) {
|
|
48189
|
+
baseOptions = configuration.baseOptions;
|
|
48190
|
+
}
|
|
48191
|
+
|
|
48192
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
|
|
48193
|
+
const localVarHeaderParameter = {} as any;
|
|
48194
|
+
const localVarQueryParameter = {} as any;
|
|
48195
|
+
|
|
48196
|
+
// authentication JWT-auth required
|
|
48197
|
+
// http bearer authentication required
|
|
48198
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
48199
|
+
|
|
48200
|
+
|
|
48201
|
+
|
|
48202
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
48203
|
+
|
|
48204
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
48205
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
48206
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
48207
|
+
localVarRequestOptions.data = serializeDataIfNeeded(deviceSubscriptionDto, localVarRequestOptions, configuration)
|
|
48208
|
+
|
|
48209
|
+
return {
|
|
48210
|
+
url: toPathString(localVarUrlObj),
|
|
48211
|
+
options: localVarRequestOptions,
|
|
48212
|
+
};
|
|
48213
|
+
},
|
|
48214
|
+
}
|
|
48215
|
+
};
|
|
48216
|
+
|
|
48217
|
+
/**
|
|
48218
|
+
* NotificationApi - functional programming interface
|
|
48219
|
+
* @export
|
|
48220
|
+
*/
|
|
48221
|
+
export const NotificationApiFp = function(configuration?: Configuration) {
|
|
48222
|
+
const localVarAxiosParamCreator = NotificationApiAxiosParamCreator(configuration)
|
|
48223
|
+
return {
|
|
48224
|
+
/**
|
|
48225
|
+
* Subscribe a device to multiple venue/business notifications using OneSignal ID and hardware ID.
|
|
48226
|
+
* @summary Add venue subscriptions for push notifications
|
|
48227
|
+
* @param {DeviceSubscriptionDto} deviceSubscriptionDto
|
|
48228
|
+
* @param {*} [options] Override http request option.
|
|
48229
|
+
* @throws {RequiredError}
|
|
48230
|
+
*/
|
|
48231
|
+
async addVenueSubscriptionsV2(deviceSubscriptionDto: DeviceSubscriptionDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueSubscriptionsResponseDto>> {
|
|
48232
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.addVenueSubscriptionsV2(deviceSubscriptionDto, options);
|
|
48233
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
48234
|
+
},
|
|
48235
|
+
/**
|
|
48236
|
+
* Unsubscribe a device from multiple venue/business notifications using hardware ID.
|
|
48237
|
+
* @summary Remove venue subscriptions for push notifications
|
|
48238
|
+
* @param {DeviceSubscriptionDto} deviceSubscriptionDto
|
|
48239
|
+
* @param {*} [options] Override http request option.
|
|
48240
|
+
* @throws {RequiredError}
|
|
48241
|
+
*/
|
|
48242
|
+
async removeVenueSubscriptionsV2(deviceSubscriptionDto: DeviceSubscriptionDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueSubscriptionsResponseDto>> {
|
|
48243
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.removeVenueSubscriptionsV2(deviceSubscriptionDto, options);
|
|
48244
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
48245
|
+
},
|
|
48246
|
+
}
|
|
48247
|
+
};
|
|
48248
|
+
|
|
48249
|
+
/**
|
|
48250
|
+
* NotificationApi - factory interface
|
|
48251
|
+
* @export
|
|
48252
|
+
*/
|
|
48253
|
+
export const NotificationApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
48254
|
+
const localVarFp = NotificationApiFp(configuration)
|
|
48255
|
+
return {
|
|
48256
|
+
/**
|
|
48257
|
+
* Subscribe a device to multiple venue/business notifications using OneSignal ID and hardware ID.
|
|
48258
|
+
* @summary Add venue subscriptions for push notifications
|
|
48259
|
+
* @param {DeviceSubscriptionDto} deviceSubscriptionDto
|
|
48260
|
+
* @param {*} [options] Override http request option.
|
|
48261
|
+
* @throws {RequiredError}
|
|
48262
|
+
*/
|
|
48263
|
+
addVenueSubscriptionsV2(deviceSubscriptionDto: DeviceSubscriptionDto, options?: any): AxiosPromise<VenueSubscriptionsResponseDto> {
|
|
48264
|
+
return localVarFp.addVenueSubscriptionsV2(deviceSubscriptionDto, options).then((request) => request(axios, basePath));
|
|
48265
|
+
},
|
|
48266
|
+
/**
|
|
48267
|
+
* Unsubscribe a device from multiple venue/business notifications using hardware ID.
|
|
48268
|
+
* @summary Remove venue subscriptions for push notifications
|
|
48269
|
+
* @param {DeviceSubscriptionDto} deviceSubscriptionDto
|
|
48270
|
+
* @param {*} [options] Override http request option.
|
|
48271
|
+
* @throws {RequiredError}
|
|
48272
|
+
*/
|
|
48273
|
+
removeVenueSubscriptionsV2(deviceSubscriptionDto: DeviceSubscriptionDto, options?: any): AxiosPromise<VenueSubscriptionsResponseDto> {
|
|
48274
|
+
return localVarFp.removeVenueSubscriptionsV2(deviceSubscriptionDto, options).then((request) => request(axios, basePath));
|
|
48275
|
+
},
|
|
48276
|
+
};
|
|
48277
|
+
};
|
|
48278
|
+
|
|
48279
|
+
/**
|
|
48280
|
+
* NotificationApi - interface
|
|
48281
|
+
* @export
|
|
48282
|
+
* @interface NotificationApi
|
|
48283
|
+
*/
|
|
48284
|
+
export interface NotificationApiInterface {
|
|
48285
|
+
/**
|
|
48286
|
+
* Subscribe a device to multiple venue/business notifications using OneSignal ID and hardware ID.
|
|
48287
|
+
* @summary Add venue subscriptions for push notifications
|
|
48288
|
+
* @param {DeviceSubscriptionDto} deviceSubscriptionDto
|
|
48289
|
+
* @param {*} [options] Override http request option.
|
|
48290
|
+
* @throws {RequiredError}
|
|
48291
|
+
* @memberof NotificationApiInterface
|
|
48292
|
+
*/
|
|
48293
|
+
addVenueSubscriptionsV2(deviceSubscriptionDto: DeviceSubscriptionDto, options?: AxiosRequestConfig): AxiosPromise<VenueSubscriptionsResponseDto>;
|
|
48294
|
+
|
|
48295
|
+
/**
|
|
48296
|
+
* Unsubscribe a device from multiple venue/business notifications using hardware ID.
|
|
48297
|
+
* @summary Remove venue subscriptions for push notifications
|
|
48298
|
+
* @param {DeviceSubscriptionDto} deviceSubscriptionDto
|
|
48299
|
+
* @param {*} [options] Override http request option.
|
|
48300
|
+
* @throws {RequiredError}
|
|
48301
|
+
* @memberof NotificationApiInterface
|
|
48302
|
+
*/
|
|
48303
|
+
removeVenueSubscriptionsV2(deviceSubscriptionDto: DeviceSubscriptionDto, options?: AxiosRequestConfig): AxiosPromise<VenueSubscriptionsResponseDto>;
|
|
48304
|
+
|
|
48305
|
+
}
|
|
48306
|
+
|
|
48307
|
+
/**
|
|
48308
|
+
* NotificationApi - object-oriented interface
|
|
48309
|
+
* @export
|
|
48310
|
+
* @class NotificationApi
|
|
48311
|
+
* @extends {BaseAPI}
|
|
48312
|
+
*/
|
|
48313
|
+
export class NotificationApi extends BaseAPI implements NotificationApiInterface {
|
|
48314
|
+
/**
|
|
48315
|
+
* Subscribe a device to multiple venue/business notifications using OneSignal ID and hardware ID.
|
|
48316
|
+
* @summary Add venue subscriptions for push notifications
|
|
48317
|
+
* @param {DeviceSubscriptionDto} deviceSubscriptionDto
|
|
48318
|
+
* @param {*} [options] Override http request option.
|
|
48319
|
+
* @throws {RequiredError}
|
|
48320
|
+
* @memberof NotificationApi
|
|
48321
|
+
*/
|
|
48322
|
+
public addVenueSubscriptionsV2(deviceSubscriptionDto: DeviceSubscriptionDto, options?: AxiosRequestConfig) {
|
|
48323
|
+
return NotificationApiFp(this.configuration).addVenueSubscriptionsV2(deviceSubscriptionDto, options).then((request) => request(this.axios, this.basePath));
|
|
48324
|
+
}
|
|
48325
|
+
|
|
48326
|
+
/**
|
|
48327
|
+
* Unsubscribe a device from multiple venue/business notifications using hardware ID.
|
|
48328
|
+
* @summary Remove venue subscriptions for push notifications
|
|
48329
|
+
* @param {DeviceSubscriptionDto} deviceSubscriptionDto
|
|
48330
|
+
* @param {*} [options] Override http request option.
|
|
48331
|
+
* @throws {RequiredError}
|
|
48332
|
+
* @memberof NotificationApi
|
|
48333
|
+
*/
|
|
48334
|
+
public removeVenueSubscriptionsV2(deviceSubscriptionDto: DeviceSubscriptionDto, options?: AxiosRequestConfig) {
|
|
48335
|
+
return NotificationApiFp(this.configuration).removeVenueSubscriptionsV2(deviceSubscriptionDto, options).then((request) => request(this.axios, this.basePath));
|
|
48336
|
+
}
|
|
48337
|
+
}
|
|
48338
|
+
|
|
48339
|
+
|
|
48340
|
+
/**
|
|
48341
|
+
* OpsApi - axios parameter creator
|
|
48342
|
+
* @export
|
|
48343
|
+
*/
|
|
48344
|
+
export const OpsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
48345
|
+
return {
|
|
48346
|
+
/**
|
|
48347
|
+
* 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.
|
|
48348
|
+
* @summary Connect a venue to Foodora or Bolt with the platform\'s store id
|
|
48349
|
+
* @param {number} venueId The Munchi venue id
|
|
48350
|
+
* @param {ConnectDeliveryPlatformDto} connectDeliveryPlatformDto
|
|
48351
|
+
* @param {*} [options] Override http request option.
|
|
48352
|
+
* @throws {RequiredError}
|
|
48353
|
+
*/
|
|
48354
|
+
connectDeliveryPlatform: async (venueId: number, connectDeliveryPlatformDto: ConnectDeliveryPlatformDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
48355
|
+
// verify required parameter 'venueId' is not null or undefined
|
|
48356
|
+
assertParamExists('connectDeliveryPlatform', 'venueId', venueId)
|
|
48357
|
+
// verify required parameter 'connectDeliveryPlatformDto' is not null or undefined
|
|
48358
|
+
assertParamExists('connectDeliveryPlatform', 'connectDeliveryPlatformDto', connectDeliveryPlatformDto)
|
|
48359
|
+
const localVarPath = `/api/v1/ops/venues/{venueId}/delivery-platforms`
|
|
48360
|
+
.replace(`{${"venueId"}}`, encodeURIComponent(String(venueId)));
|
|
48361
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
48362
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
48363
|
+
let baseOptions;
|
|
48364
|
+
if (configuration) {
|
|
48365
|
+
baseOptions = configuration.baseOptions;
|
|
48366
|
+
}
|
|
48367
|
+
|
|
48368
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
48369
|
+
const localVarHeaderParameter = {} as any;
|
|
48370
|
+
const localVarQueryParameter = {} as any;
|
|
48371
|
+
|
|
48372
|
+
// authentication JWT-auth required
|
|
48373
|
+
// http bearer authentication required
|
|
48374
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
48375
|
+
|
|
48376
|
+
|
|
48377
|
+
|
|
48378
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
48379
|
+
|
|
48380
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
48381
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
48382
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
48383
|
+
localVarRequestOptions.data = serializeDataIfNeeded(connectDeliveryPlatformDto, localVarRequestOptions, configuration)
|
|
46660
48384
|
|
|
46661
48385
|
return {
|
|
46662
48386
|
url: toPathString(localVarUrlObj),
|
|
@@ -46664,16 +48388,17 @@ export const NotificationApiAxiosParamCreator = function (configuration?: Config
|
|
|
46664
48388
|
};
|
|
46665
48389
|
},
|
|
46666
48390
|
/**
|
|
46667
|
-
*
|
|
46668
|
-
* @summary
|
|
46669
|
-
* @param {
|
|
48391
|
+
* 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.
|
|
48392
|
+
* @summary A venue\'s tills, kiosks and payment terminals
|
|
48393
|
+
* @param {number} venueId The Munchi venue id
|
|
46670
48394
|
* @param {*} [options] Override http request option.
|
|
46671
48395
|
* @throws {RequiredError}
|
|
46672
48396
|
*/
|
|
46673
|
-
|
|
46674
|
-
// verify required parameter '
|
|
46675
|
-
assertParamExists('
|
|
46676
|
-
const localVarPath = `/api/
|
|
48397
|
+
devicesOfVenue: async (venueId: number, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
48398
|
+
// verify required parameter 'venueId' is not null or undefined
|
|
48399
|
+
assertParamExists('devicesOfVenue', 'venueId', venueId)
|
|
48400
|
+
const localVarPath = `/api/v1/ops/venues/{venueId}/devices`
|
|
48401
|
+
.replace(`{${"venueId"}}`, encodeURIComponent(String(venueId)));
|
|
46677
48402
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
46678
48403
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
46679
48404
|
let baseOptions;
|
|
@@ -46681,7 +48406,7 @@ export const NotificationApiAxiosParamCreator = function (configuration?: Config
|
|
|
46681
48406
|
baseOptions = configuration.baseOptions;
|
|
46682
48407
|
}
|
|
46683
48408
|
|
|
46684
|
-
const localVarRequestOptions = { method: '
|
|
48409
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
46685
48410
|
const localVarHeaderParameter = {} as any;
|
|
46686
48411
|
const localVarQueryParameter = {} as any;
|
|
46687
48412
|
|
|
@@ -46691,162 +48416,31 @@ export const NotificationApiAxiosParamCreator = function (configuration?: Config
|
|
|
46691
48416
|
|
|
46692
48417
|
|
|
46693
48418
|
|
|
46694
|
-
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
46695
|
-
|
|
46696
48419
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
46697
48420
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
46698
48421
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
46699
|
-
localVarRequestOptions.data = serializeDataIfNeeded(deviceSubscriptionDto, localVarRequestOptions, configuration)
|
|
46700
48422
|
|
|
46701
48423
|
return {
|
|
46702
48424
|
url: toPathString(localVarUrlObj),
|
|
46703
48425
|
options: localVarRequestOptions,
|
|
46704
48426
|
};
|
|
46705
48427
|
},
|
|
46706
|
-
}
|
|
46707
|
-
};
|
|
46708
|
-
|
|
46709
|
-
/**
|
|
46710
|
-
* NotificationApi - functional programming interface
|
|
46711
|
-
* @export
|
|
46712
|
-
*/
|
|
46713
|
-
export const NotificationApiFp = function(configuration?: Configuration) {
|
|
46714
|
-
const localVarAxiosParamCreator = NotificationApiAxiosParamCreator(configuration)
|
|
46715
|
-
return {
|
|
46716
|
-
/**
|
|
46717
|
-
* Subscribe a device to multiple venue/business notifications using OneSignal ID and hardware ID.
|
|
46718
|
-
* @summary Add venue subscriptions for push notifications
|
|
46719
|
-
* @param {DeviceSubscriptionDto} deviceSubscriptionDto
|
|
46720
|
-
* @param {*} [options] Override http request option.
|
|
46721
|
-
* @throws {RequiredError}
|
|
46722
|
-
*/
|
|
46723
|
-
async addVenueSubscriptionsV2(deviceSubscriptionDto: DeviceSubscriptionDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueSubscriptionsResponseDto>> {
|
|
46724
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.addVenueSubscriptionsV2(deviceSubscriptionDto, options);
|
|
46725
|
-
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
46726
|
-
},
|
|
46727
|
-
/**
|
|
46728
|
-
* Unsubscribe a device from multiple venue/business notifications using hardware ID.
|
|
46729
|
-
* @summary Remove venue subscriptions for push notifications
|
|
46730
|
-
* @param {DeviceSubscriptionDto} deviceSubscriptionDto
|
|
46731
|
-
* @param {*} [options] Override http request option.
|
|
46732
|
-
* @throws {RequiredError}
|
|
46733
|
-
*/
|
|
46734
|
-
async removeVenueSubscriptionsV2(deviceSubscriptionDto: DeviceSubscriptionDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueSubscriptionsResponseDto>> {
|
|
46735
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.removeVenueSubscriptionsV2(deviceSubscriptionDto, options);
|
|
46736
|
-
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
46737
|
-
},
|
|
46738
|
-
}
|
|
46739
|
-
};
|
|
46740
|
-
|
|
46741
|
-
/**
|
|
46742
|
-
* NotificationApi - factory interface
|
|
46743
|
-
* @export
|
|
46744
|
-
*/
|
|
46745
|
-
export const NotificationApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
46746
|
-
const localVarFp = NotificationApiFp(configuration)
|
|
46747
|
-
return {
|
|
46748
|
-
/**
|
|
46749
|
-
* Subscribe a device to multiple venue/business notifications using OneSignal ID and hardware ID.
|
|
46750
|
-
* @summary Add venue subscriptions for push notifications
|
|
46751
|
-
* @param {DeviceSubscriptionDto} deviceSubscriptionDto
|
|
46752
|
-
* @param {*} [options] Override http request option.
|
|
46753
|
-
* @throws {RequiredError}
|
|
46754
|
-
*/
|
|
46755
|
-
addVenueSubscriptionsV2(deviceSubscriptionDto: DeviceSubscriptionDto, options?: any): AxiosPromise<VenueSubscriptionsResponseDto> {
|
|
46756
|
-
return localVarFp.addVenueSubscriptionsV2(deviceSubscriptionDto, options).then((request) => request(axios, basePath));
|
|
46757
|
-
},
|
|
46758
48428
|
/**
|
|
46759
|
-
*
|
|
46760
|
-
* @summary
|
|
46761
|
-
* @param {DeviceSubscriptionDto} deviceSubscriptionDto
|
|
46762
|
-
* @param {*} [options] Override http request option.
|
|
46763
|
-
* @throws {RequiredError}
|
|
46764
|
-
*/
|
|
46765
|
-
removeVenueSubscriptionsV2(deviceSubscriptionDto: DeviceSubscriptionDto, options?: any): AxiosPromise<VenueSubscriptionsResponseDto> {
|
|
46766
|
-
return localVarFp.removeVenueSubscriptionsV2(deviceSubscriptionDto, options).then((request) => request(axios, basePath));
|
|
46767
|
-
},
|
|
46768
|
-
};
|
|
46769
|
-
};
|
|
46770
|
-
|
|
46771
|
-
/**
|
|
46772
|
-
* NotificationApi - interface
|
|
46773
|
-
* @export
|
|
46774
|
-
* @interface NotificationApi
|
|
46775
|
-
*/
|
|
46776
|
-
export interface NotificationApiInterface {
|
|
46777
|
-
/**
|
|
46778
|
-
* Subscribe a device to multiple venue/business notifications using OneSignal ID and hardware ID.
|
|
46779
|
-
* @summary Add venue subscriptions for push notifications
|
|
46780
|
-
* @param {DeviceSubscriptionDto} deviceSubscriptionDto
|
|
46781
|
-
* @param {*} [options] Override http request option.
|
|
46782
|
-
* @throws {RequiredError}
|
|
46783
|
-
* @memberof NotificationApiInterface
|
|
46784
|
-
*/
|
|
46785
|
-
addVenueSubscriptionsV2(deviceSubscriptionDto: DeviceSubscriptionDto, options?: AxiosRequestConfig): AxiosPromise<VenueSubscriptionsResponseDto>;
|
|
46786
|
-
|
|
46787
|
-
/**
|
|
46788
|
-
* Unsubscribe a device from multiple venue/business notifications using hardware ID.
|
|
46789
|
-
* @summary Remove venue subscriptions for push notifications
|
|
46790
|
-
* @param {DeviceSubscriptionDto} deviceSubscriptionDto
|
|
46791
|
-
* @param {*} [options] Override http request option.
|
|
46792
|
-
* @throws {RequiredError}
|
|
46793
|
-
* @memberof NotificationApiInterface
|
|
46794
|
-
*/
|
|
46795
|
-
removeVenueSubscriptionsV2(deviceSubscriptionDto: DeviceSubscriptionDto, options?: AxiosRequestConfig): AxiosPromise<VenueSubscriptionsResponseDto>;
|
|
46796
|
-
|
|
46797
|
-
}
|
|
46798
|
-
|
|
46799
|
-
/**
|
|
46800
|
-
* NotificationApi - object-oriented interface
|
|
46801
|
-
* @export
|
|
46802
|
-
* @class NotificationApi
|
|
46803
|
-
* @extends {BaseAPI}
|
|
46804
|
-
*/
|
|
46805
|
-
export class NotificationApi extends BaseAPI implements NotificationApiInterface {
|
|
46806
|
-
/**
|
|
46807
|
-
* Subscribe a device to multiple venue/business notifications using OneSignal ID and hardware ID.
|
|
46808
|
-
* @summary Add venue subscriptions for push notifications
|
|
46809
|
-
* @param {DeviceSubscriptionDto} deviceSubscriptionDto
|
|
46810
|
-
* @param {*} [options] Override http request option.
|
|
46811
|
-
* @throws {RequiredError}
|
|
46812
|
-
* @memberof NotificationApi
|
|
46813
|
-
*/
|
|
46814
|
-
public addVenueSubscriptionsV2(deviceSubscriptionDto: DeviceSubscriptionDto, options?: AxiosRequestConfig) {
|
|
46815
|
-
return NotificationApiFp(this.configuration).addVenueSubscriptionsV2(deviceSubscriptionDto, options).then((request) => request(this.axios, this.basePath));
|
|
46816
|
-
}
|
|
46817
|
-
|
|
46818
|
-
/**
|
|
46819
|
-
* Unsubscribe a device from multiple venue/business notifications using hardware ID.
|
|
46820
|
-
* @summary Remove venue subscriptions for push notifications
|
|
46821
|
-
* @param {DeviceSubscriptionDto} deviceSubscriptionDto
|
|
46822
|
-
* @param {*} [options] Override http request option.
|
|
46823
|
-
* @throws {RequiredError}
|
|
46824
|
-
* @memberof NotificationApi
|
|
46825
|
-
*/
|
|
46826
|
-
public removeVenueSubscriptionsV2(deviceSubscriptionDto: DeviceSubscriptionDto, options?: AxiosRequestConfig) {
|
|
46827
|
-
return NotificationApiFp(this.configuration).removeVenueSubscriptionsV2(deviceSubscriptionDto, options).then((request) => request(this.axios, this.basePath));
|
|
46828
|
-
}
|
|
46829
|
-
}
|
|
46830
|
-
|
|
46831
|
-
|
|
46832
|
-
/**
|
|
46833
|
-
* OpsApi - axios parameter creator
|
|
46834
|
-
* @export
|
|
46835
|
-
*/
|
|
46836
|
-
export const OpsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
46837
|
-
return {
|
|
46838
|
-
/**
|
|
46839
|
-
* 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.
|
|
46840
|
-
* @summary A venue\'s tills, kiosks and payment terminals
|
|
48429
|
+
* 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}).
|
|
48430
|
+
* @summary Disconnect a venue from Foodora or Bolt
|
|
46841
48431
|
* @param {number} venueId The Munchi venue id
|
|
48432
|
+
* @param {DeliveryPlatformOpsConnect} channel Foodora or Bolt
|
|
46842
48433
|
* @param {*} [options] Override http request option.
|
|
46843
48434
|
* @throws {RequiredError}
|
|
46844
48435
|
*/
|
|
46845
|
-
|
|
48436
|
+
disconnectDeliveryPlatform: async (venueId: number, channel: DeliveryPlatformOpsConnect, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
46846
48437
|
// verify required parameter 'venueId' is not null or undefined
|
|
46847
|
-
assertParamExists('
|
|
46848
|
-
|
|
46849
|
-
|
|
48438
|
+
assertParamExists('disconnectDeliveryPlatform', 'venueId', venueId)
|
|
48439
|
+
// verify required parameter 'channel' is not null or undefined
|
|
48440
|
+
assertParamExists('disconnectDeliveryPlatform', 'channel', channel)
|
|
48441
|
+
const localVarPath = `/api/v1/ops/venues/{venueId}/delivery-platforms/{channel}`
|
|
48442
|
+
.replace(`{${"venueId"}}`, encodeURIComponent(String(venueId)))
|
|
48443
|
+
.replace(`{${"channel"}}`, encodeURIComponent(String(channel)));
|
|
46850
48444
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
46851
48445
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
46852
48446
|
let baseOptions;
|
|
@@ -46854,7 +48448,7 @@ export const OpsApiAxiosParamCreator = function (configuration?: Configuration)
|
|
|
46854
48448
|
baseOptions = configuration.baseOptions;
|
|
46855
48449
|
}
|
|
46856
48450
|
|
|
46857
|
-
const localVarRequestOptions = { method: '
|
|
48451
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
|
|
46858
48452
|
const localVarHeaderParameter = {} as any;
|
|
46859
48453
|
const localVarQueryParameter = {} as any;
|
|
46860
48454
|
|
|
@@ -46929,6 +48523,18 @@ export const OpsApiAxiosParamCreator = function (configuration?: Configuration)
|
|
|
46929
48523
|
export const OpsApiFp = function(configuration?: Configuration) {
|
|
46930
48524
|
const localVarAxiosParamCreator = OpsApiAxiosParamCreator(configuration)
|
|
46931
48525
|
return {
|
|
48526
|
+
/**
|
|
48527
|
+
* 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.
|
|
48528
|
+
* @summary Connect a venue to Foodora or Bolt with the platform\'s store id
|
|
48529
|
+
* @param {number} venueId The Munchi venue id
|
|
48530
|
+
* @param {ConnectDeliveryPlatformDto} connectDeliveryPlatformDto
|
|
48531
|
+
* @param {*} [options] Override http request option.
|
|
48532
|
+
* @throws {RequiredError}
|
|
48533
|
+
*/
|
|
48534
|
+
async connectDeliveryPlatform(venueId: number, connectDeliveryPlatformDto: ConnectDeliveryPlatformDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConnectedDeliveryPlatformDto>> {
|
|
48535
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.connectDeliveryPlatform(venueId, connectDeliveryPlatformDto, options);
|
|
48536
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
48537
|
+
},
|
|
46932
48538
|
/**
|
|
46933
48539
|
* 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.
|
|
46934
48540
|
* @summary A venue\'s tills, kiosks and payment terminals
|
|
@@ -46940,6 +48546,18 @@ export const OpsApiFp = function(configuration?: Configuration) {
|
|
|
46940
48546
|
const localVarAxiosArgs = await localVarAxiosParamCreator.devicesOfVenue(venueId, options);
|
|
46941
48547
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
46942
48548
|
},
|
|
48549
|
+
/**
|
|
48550
|
+
* 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}).
|
|
48551
|
+
* @summary Disconnect a venue from Foodora or Bolt
|
|
48552
|
+
* @param {number} venueId The Munchi venue id
|
|
48553
|
+
* @param {DeliveryPlatformOpsConnect} channel Foodora or Bolt
|
|
48554
|
+
* @param {*} [options] Override http request option.
|
|
48555
|
+
* @throws {RequiredError}
|
|
48556
|
+
*/
|
|
48557
|
+
async disconnectDeliveryPlatform(venueId: number, channel: DeliveryPlatformOpsConnect, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DisconnectedDeliveryPlatformDto>> {
|
|
48558
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.disconnectDeliveryPlatform(venueId, channel, options);
|
|
48559
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
48560
|
+
},
|
|
46943
48561
|
/**
|
|
46944
48562
|
* 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.
|
|
46945
48563
|
* @summary Find venues by name or id, across every venue
|
|
@@ -46962,6 +48580,17 @@ export const OpsApiFp = function(configuration?: Configuration) {
|
|
|
46962
48580
|
export const OpsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
46963
48581
|
const localVarFp = OpsApiFp(configuration)
|
|
46964
48582
|
return {
|
|
48583
|
+
/**
|
|
48584
|
+
* 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.
|
|
48585
|
+
* @summary Connect a venue to Foodora or Bolt with the platform\'s store id
|
|
48586
|
+
* @param {number} venueId The Munchi venue id
|
|
48587
|
+
* @param {ConnectDeliveryPlatformDto} connectDeliveryPlatformDto
|
|
48588
|
+
* @param {*} [options] Override http request option.
|
|
48589
|
+
* @throws {RequiredError}
|
|
48590
|
+
*/
|
|
48591
|
+
connectDeliveryPlatform(venueId: number, connectDeliveryPlatformDto: ConnectDeliveryPlatformDto, options?: any): AxiosPromise<ConnectedDeliveryPlatformDto> {
|
|
48592
|
+
return localVarFp.connectDeliveryPlatform(venueId, connectDeliveryPlatformDto, options).then((request) => request(axios, basePath));
|
|
48593
|
+
},
|
|
46965
48594
|
/**
|
|
46966
48595
|
* 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.
|
|
46967
48596
|
* @summary A venue\'s tills, kiosks and payment terminals
|
|
@@ -46972,6 +48601,17 @@ export const OpsApiFactory = function (configuration?: Configuration, basePath?:
|
|
|
46972
48601
|
devicesOfVenue(venueId: number, options?: any): AxiosPromise<VenueDevicesDto> {
|
|
46973
48602
|
return localVarFp.devicesOfVenue(venueId, options).then((request) => request(axios, basePath));
|
|
46974
48603
|
},
|
|
48604
|
+
/**
|
|
48605
|
+
* 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}).
|
|
48606
|
+
* @summary Disconnect a venue from Foodora or Bolt
|
|
48607
|
+
* @param {number} venueId The Munchi venue id
|
|
48608
|
+
* @param {DeliveryPlatformOpsConnect} channel Foodora or Bolt
|
|
48609
|
+
* @param {*} [options] Override http request option.
|
|
48610
|
+
* @throws {RequiredError}
|
|
48611
|
+
*/
|
|
48612
|
+
disconnectDeliveryPlatform(venueId: number, channel: DeliveryPlatformOpsConnect, options?: any): AxiosPromise<DisconnectedDeliveryPlatformDto> {
|
|
48613
|
+
return localVarFp.disconnectDeliveryPlatform(venueId, channel, options).then((request) => request(axios, basePath));
|
|
48614
|
+
},
|
|
46975
48615
|
/**
|
|
46976
48616
|
* 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.
|
|
46977
48617
|
* @summary Find venues by name or id, across every venue
|
|
@@ -46992,6 +48632,17 @@ export const OpsApiFactory = function (configuration?: Configuration, basePath?:
|
|
|
46992
48632
|
* @interface OpsApi
|
|
46993
48633
|
*/
|
|
46994
48634
|
export interface OpsApiInterface {
|
|
48635
|
+
/**
|
|
48636
|
+
* 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.
|
|
48637
|
+
* @summary Connect a venue to Foodora or Bolt with the platform\'s store id
|
|
48638
|
+
* @param {number} venueId The Munchi venue id
|
|
48639
|
+
* @param {ConnectDeliveryPlatformDto} connectDeliveryPlatformDto
|
|
48640
|
+
* @param {*} [options] Override http request option.
|
|
48641
|
+
* @throws {RequiredError}
|
|
48642
|
+
* @memberof OpsApiInterface
|
|
48643
|
+
*/
|
|
48644
|
+
connectDeliveryPlatform(venueId: number, connectDeliveryPlatformDto: ConnectDeliveryPlatformDto, options?: AxiosRequestConfig): AxiosPromise<ConnectedDeliveryPlatformDto>;
|
|
48645
|
+
|
|
46995
48646
|
/**
|
|
46996
48647
|
* 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.
|
|
46997
48648
|
* @summary A venue\'s tills, kiosks and payment terminals
|
|
@@ -47002,6 +48653,17 @@ export interface OpsApiInterface {
|
|
|
47002
48653
|
*/
|
|
47003
48654
|
devicesOfVenue(venueId: number, options?: AxiosRequestConfig): AxiosPromise<VenueDevicesDto>;
|
|
47004
48655
|
|
|
48656
|
+
/**
|
|
48657
|
+
* 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}).
|
|
48658
|
+
* @summary Disconnect a venue from Foodora or Bolt
|
|
48659
|
+
* @param {number} venueId The Munchi venue id
|
|
48660
|
+
* @param {DeliveryPlatformOpsConnect} channel Foodora or Bolt
|
|
48661
|
+
* @param {*} [options] Override http request option.
|
|
48662
|
+
* @throws {RequiredError}
|
|
48663
|
+
* @memberof OpsApiInterface
|
|
48664
|
+
*/
|
|
48665
|
+
disconnectDeliveryPlatform(venueId: number, channel: DeliveryPlatformOpsConnect, options?: AxiosRequestConfig): AxiosPromise<DisconnectedDeliveryPlatformDto>;
|
|
48666
|
+
|
|
47005
48667
|
/**
|
|
47006
48668
|
* 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.
|
|
47007
48669
|
* @summary Find venues by name or id, across every venue
|
|
@@ -47022,6 +48684,19 @@ export interface OpsApiInterface {
|
|
|
47022
48684
|
* @extends {BaseAPI}
|
|
47023
48685
|
*/
|
|
47024
48686
|
export class OpsApi extends BaseAPI implements OpsApiInterface {
|
|
48687
|
+
/**
|
|
48688
|
+
* 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.
|
|
48689
|
+
* @summary Connect a venue to Foodora or Bolt with the platform\'s store id
|
|
48690
|
+
* @param {number} venueId The Munchi venue id
|
|
48691
|
+
* @param {ConnectDeliveryPlatformDto} connectDeliveryPlatformDto
|
|
48692
|
+
* @param {*} [options] Override http request option.
|
|
48693
|
+
* @throws {RequiredError}
|
|
48694
|
+
* @memberof OpsApi
|
|
48695
|
+
*/
|
|
48696
|
+
public connectDeliveryPlatform(venueId: number, connectDeliveryPlatformDto: ConnectDeliveryPlatformDto, options?: AxiosRequestConfig) {
|
|
48697
|
+
return OpsApiFp(this.configuration).connectDeliveryPlatform(venueId, connectDeliveryPlatformDto, options).then((request) => request(this.axios, this.basePath));
|
|
48698
|
+
}
|
|
48699
|
+
|
|
47025
48700
|
/**
|
|
47026
48701
|
* 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.
|
|
47027
48702
|
* @summary A venue\'s tills, kiosks and payment terminals
|
|
@@ -47034,6 +48709,19 @@ export class OpsApi extends BaseAPI implements OpsApiInterface {
|
|
|
47034
48709
|
return OpsApiFp(this.configuration).devicesOfVenue(venueId, options).then((request) => request(this.axios, this.basePath));
|
|
47035
48710
|
}
|
|
47036
48711
|
|
|
48712
|
+
/**
|
|
48713
|
+
* 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}).
|
|
48714
|
+
* @summary Disconnect a venue from Foodora or Bolt
|
|
48715
|
+
* @param {number} venueId The Munchi venue id
|
|
48716
|
+
* @param {DeliveryPlatformOpsConnect} channel Foodora or Bolt
|
|
48717
|
+
* @param {*} [options] Override http request option.
|
|
48718
|
+
* @throws {RequiredError}
|
|
48719
|
+
* @memberof OpsApi
|
|
48720
|
+
*/
|
|
48721
|
+
public disconnectDeliveryPlatform(venueId: number, channel: DeliveryPlatformOpsConnect, options?: AxiosRequestConfig) {
|
|
48722
|
+
return OpsApiFp(this.configuration).disconnectDeliveryPlatform(venueId, channel, options).then((request) => request(this.axios, this.basePath));
|
|
48723
|
+
}
|
|
48724
|
+
|
|
47037
48725
|
/**
|
|
47038
48726
|
* 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.
|
|
47039
48727
|
* @summary Find venues by name or id, across every venue
|
|
@@ -51431,6 +53119,40 @@ export const PaymentSessionApiAxiosParamCreator = function (configuration?: Conf
|
|
|
51431
53119
|
|
|
51432
53120
|
|
|
51433
53121
|
|
|
53122
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
53123
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
53124
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
53125
|
+
|
|
53126
|
+
return {
|
|
53127
|
+
url: toPathString(localVarUrlObj),
|
|
53128
|
+
options: localVarRequestOptions,
|
|
53129
|
+
};
|
|
53130
|
+
},
|
|
53131
|
+
/**
|
|
53132
|
+
* 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).
|
|
53133
|
+
* @summary Get the currency of a payment session by its sessionId
|
|
53134
|
+
* @param {string} sessionId The payment session\'s sessionId, the same value stored as the order paymentEvent referenceId
|
|
53135
|
+
* @param {*} [options] Override http request option.
|
|
53136
|
+
* @throws {RequiredError}
|
|
53137
|
+
*/
|
|
53138
|
+
getPaymentSessionCurrency: async (sessionId: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
53139
|
+
// verify required parameter 'sessionId' is not null or undefined
|
|
53140
|
+
assertParamExists('getPaymentSessionCurrency', 'sessionId', sessionId)
|
|
53141
|
+
const localVarPath = `/api/v1/payment-session/currency/{sessionId}`
|
|
53142
|
+
.replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId)));
|
|
53143
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
53144
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
53145
|
+
let baseOptions;
|
|
53146
|
+
if (configuration) {
|
|
53147
|
+
baseOptions = configuration.baseOptions;
|
|
53148
|
+
}
|
|
53149
|
+
|
|
53150
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
53151
|
+
const localVarHeaderParameter = {} as any;
|
|
53152
|
+
const localVarQueryParameter = {} as any;
|
|
53153
|
+
|
|
53154
|
+
|
|
53155
|
+
|
|
51434
53156
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
51435
53157
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
51436
53158
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -52249,6 +53971,17 @@ export const PaymentSessionApiFp = function(configuration?: Configuration) {
|
|
|
52249
53971
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getPaymentSessionAnalytics(businessId, timeSpan, start, end, options);
|
|
52250
53972
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
52251
53973
|
},
|
|
53974
|
+
/**
|
|
53975
|
+
* 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).
|
|
53976
|
+
* @summary Get the currency of a payment session by its sessionId
|
|
53977
|
+
* @param {string} sessionId The payment session\'s sessionId, the same value stored as the order paymentEvent referenceId
|
|
53978
|
+
* @param {*} [options] Override http request option.
|
|
53979
|
+
* @throws {RequiredError}
|
|
53980
|
+
*/
|
|
53981
|
+
async getPaymentSessionCurrency(sessionId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentSessionCurrencyDto>> {
|
|
53982
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getPaymentSessionCurrency(sessionId, options);
|
|
53983
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
53984
|
+
},
|
|
52252
53985
|
/**
|
|
52253
53986
|
* 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.
|
|
52254
53987
|
* @summary Charge an Epassi QR code
|
|
@@ -52530,6 +54263,16 @@ export const PaymentSessionApiFactory = function (configuration?: Configuration,
|
|
|
52530
54263
|
getPaymentSessionAnalytics(businessId: number, timeSpan: TimeSpan, start?: string, end?: string, options?: any): AxiosPromise<PaymentSessionAnalyticsResponseDto> {
|
|
52531
54264
|
return localVarFp.getPaymentSessionAnalytics(businessId, timeSpan, start, end, options).then((request) => request(axios, basePath));
|
|
52532
54265
|
},
|
|
54266
|
+
/**
|
|
54267
|
+
* 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).
|
|
54268
|
+
* @summary Get the currency of a payment session by its sessionId
|
|
54269
|
+
* @param {string} sessionId The payment session\'s sessionId, the same value stored as the order paymentEvent referenceId
|
|
54270
|
+
* @param {*} [options] Override http request option.
|
|
54271
|
+
* @throws {RequiredError}
|
|
54272
|
+
*/
|
|
54273
|
+
getPaymentSessionCurrency(sessionId: string, options?: any): AxiosPromise<PaymentSessionCurrencyDto> {
|
|
54274
|
+
return localVarFp.getPaymentSessionCurrency(sessionId, options).then((request) => request(axios, basePath));
|
|
54275
|
+
},
|
|
52533
54276
|
/**
|
|
52534
54277
|
* 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.
|
|
52535
54278
|
* @summary Charge an Epassi QR code
|
|
@@ -52790,6 +54533,16 @@ export interface PaymentSessionApiInterface {
|
|
|
52790
54533
|
*/
|
|
52791
54534
|
getPaymentSessionAnalytics(businessId: number, timeSpan: TimeSpan, start?: string, end?: string, options?: AxiosRequestConfig): AxiosPromise<PaymentSessionAnalyticsResponseDto>;
|
|
52792
54535
|
|
|
54536
|
+
/**
|
|
54537
|
+
* 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).
|
|
54538
|
+
* @summary Get the currency of a payment session by its sessionId
|
|
54539
|
+
* @param {string} sessionId The payment session\'s sessionId, the same value stored as the order paymentEvent referenceId
|
|
54540
|
+
* @param {*} [options] Override http request option.
|
|
54541
|
+
* @throws {RequiredError}
|
|
54542
|
+
* @memberof PaymentSessionApiInterface
|
|
54543
|
+
*/
|
|
54544
|
+
getPaymentSessionCurrency(sessionId: string, options?: AxiosRequestConfig): AxiosPromise<PaymentSessionCurrencyDto>;
|
|
54545
|
+
|
|
52793
54546
|
/**
|
|
52794
54547
|
* 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.
|
|
52795
54548
|
* @summary Charge an Epassi QR code
|
|
@@ -53058,6 +54811,18 @@ export class PaymentSessionApi extends BaseAPI implements PaymentSessionApiInter
|
|
|
53058
54811
|
return PaymentSessionApiFp(this.configuration).getPaymentSessionAnalytics(businessId, timeSpan, start, end, options).then((request) => request(this.axios, this.basePath));
|
|
53059
54812
|
}
|
|
53060
54813
|
|
|
54814
|
+
/**
|
|
54815
|
+
* 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).
|
|
54816
|
+
* @summary Get the currency of a payment session by its sessionId
|
|
54817
|
+
* @param {string} sessionId The payment session\'s sessionId, the same value stored as the order paymentEvent referenceId
|
|
54818
|
+
* @param {*} [options] Override http request option.
|
|
54819
|
+
* @throws {RequiredError}
|
|
54820
|
+
* @memberof PaymentSessionApi
|
|
54821
|
+
*/
|
|
54822
|
+
public getPaymentSessionCurrency(sessionId: string, options?: AxiosRequestConfig) {
|
|
54823
|
+
return PaymentSessionApiFp(this.configuration).getPaymentSessionCurrency(sessionId, options).then((request) => request(this.axios, this.basePath));
|
|
54824
|
+
}
|
|
54825
|
+
|
|
53061
54826
|
/**
|
|
53062
54827
|
* 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.
|
|
53063
54828
|
* @summary Charge an Epassi QR code
|
|
@@ -53982,9 +55747,9 @@ export class ProductApi extends BaseAPI implements ProductApiInterface {
|
|
|
53982
55747
|
export const ProviderApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
53983
55748
|
return {
|
|
53984
55749
|
/**
|
|
53985
|
-
* 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.
|
|
53986
|
-
* @summary Start connecting a venue to Uber Eats or
|
|
53987
|
-
* @param {ProviderEnum} channel The channel to connect: UberEats, Wolt or
|
|
55750
|
+
* 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.
|
|
55751
|
+
* @summary Start connecting a venue to Uber Eats, Wolt or ResQ
|
|
55752
|
+
* @param {ProviderEnum} channel The channel to connect: UberEats, Wolt, WoltStorefront or ResQ. Any other channel is answered 400
|
|
53988
55753
|
* @param {CreateOnboardingSessionDto} createOnboardingSessionDto
|
|
53989
55754
|
* @param {*} [options] Override http request option.
|
|
53990
55755
|
* @throws {RequiredError}
|
|
@@ -54022,9 +55787,9 @@ export const ProviderApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
54022
55787
|
};
|
|
54023
55788
|
},
|
|
54024
55789
|
/**
|
|
54025
|
-
* 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
|
|
54026
|
-
* @summary Disconnect a venue from Uber Eats or
|
|
54027
|
-
* @param {ProviderEnum} channel The channel to connect: UberEats, Wolt or
|
|
55790
|
+
* 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.
|
|
55791
|
+
* @summary Disconnect a venue from Uber Eats, Wolt or ResQ
|
|
55792
|
+
* @param {ProviderEnum} channel The channel to connect: UberEats, Wolt, WoltStorefront or ResQ. Any other channel is answered 400
|
|
54028
55793
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
54029
55794
|
* @param {*} [options] Override http request option.
|
|
54030
55795
|
* @throws {RequiredError}
|
|
@@ -54094,9 +55859,9 @@ export const ProviderApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
54094
55859
|
};
|
|
54095
55860
|
},
|
|
54096
55861
|
/**
|
|
54097
|
-
* The channel\'s service answers, and its answer is passed on as it is: Uber Eats\' shape for UberEats, Wolt\'s for Wolt and
|
|
54098
|
-
* @summary Whether a venue is connected to Uber Eats or
|
|
54099
|
-
* @param {ProviderEnum} channel The channel to connect: UberEats, Wolt or
|
|
55862
|
+
* 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.
|
|
55863
|
+
* @summary Whether a venue is connected to Uber Eats, Wolt or ResQ
|
|
55864
|
+
* @param {ProviderEnum} channel The channel to connect: UberEats, Wolt, WoltStorefront or ResQ. Any other channel is answered 400
|
|
54100
55865
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
54101
55866
|
* @param {*} [options] Override http request option.
|
|
54102
55867
|
* @throws {RequiredError}
|
|
@@ -54264,9 +56029,9 @@ export const ProviderApiFp = function(configuration?: Configuration) {
|
|
|
54264
56029
|
const localVarAxiosParamCreator = ProviderApiAxiosParamCreator(configuration)
|
|
54265
56030
|
return {
|
|
54266
56031
|
/**
|
|
54267
|
-
* 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.
|
|
54268
|
-
* @summary Start connecting a venue to Uber Eats or
|
|
54269
|
-
* @param {ProviderEnum} channel The channel to connect: UberEats, Wolt or
|
|
56032
|
+
* 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.
|
|
56033
|
+
* @summary Start connecting a venue to Uber Eats, Wolt or ResQ
|
|
56034
|
+
* @param {ProviderEnum} channel The channel to connect: UberEats, Wolt, WoltStorefront or ResQ. Any other channel is answered 400
|
|
54270
56035
|
* @param {CreateOnboardingSessionDto} createOnboardingSessionDto
|
|
54271
56036
|
* @param {*} [options] Override http request option.
|
|
54272
56037
|
* @throws {RequiredError}
|
|
@@ -54276,9 +56041,9 @@ export const ProviderApiFp = function(configuration?: Configuration) {
|
|
|
54276
56041
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
54277
56042
|
},
|
|
54278
56043
|
/**
|
|
54279
|
-
* 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
|
|
54280
|
-
* @summary Disconnect a venue from Uber Eats or
|
|
54281
|
-
* @param {ProviderEnum} channel The channel to connect: UberEats, Wolt or
|
|
56044
|
+
* 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.
|
|
56045
|
+
* @summary Disconnect a venue from Uber Eats, Wolt or ResQ
|
|
56046
|
+
* @param {ProviderEnum} channel The channel to connect: UberEats, Wolt, WoltStorefront or ResQ. Any other channel is answered 400
|
|
54282
56047
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
54283
56048
|
* @param {*} [options] Override http request option.
|
|
54284
56049
|
* @throws {RequiredError}
|
|
@@ -54299,9 +56064,9 @@ export const ProviderApiFp = function(configuration?: Configuration) {
|
|
|
54299
56064
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
54300
56065
|
},
|
|
54301
56066
|
/**
|
|
54302
|
-
* The channel\'s service answers, and its answer is passed on as it is: Uber Eats\' shape for UberEats, Wolt\'s for Wolt and
|
|
54303
|
-
* @summary Whether a venue is connected to Uber Eats or
|
|
54304
|
-
* @param {ProviderEnum} channel The channel to connect: UberEats, Wolt or
|
|
56067
|
+
* 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.
|
|
56068
|
+
* @summary Whether a venue is connected to Uber Eats, Wolt or ResQ
|
|
56069
|
+
* @param {ProviderEnum} channel The channel to connect: UberEats, Wolt, WoltStorefront or ResQ. Any other channel is answered 400
|
|
54305
56070
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
54306
56071
|
* @param {*} [options] Override http request option.
|
|
54307
56072
|
* @throws {RequiredError}
|
|
@@ -54358,9 +56123,9 @@ export const ProviderApiFactory = function (configuration?: Configuration, baseP
|
|
|
54358
56123
|
const localVarFp = ProviderApiFp(configuration)
|
|
54359
56124
|
return {
|
|
54360
56125
|
/**
|
|
54361
|
-
* 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.
|
|
54362
|
-
* @summary Start connecting a venue to Uber Eats or
|
|
54363
|
-
* @param {ProviderEnum} channel The channel to connect: UberEats, Wolt or
|
|
56126
|
+
* 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.
|
|
56127
|
+
* @summary Start connecting a venue to Uber Eats, Wolt or ResQ
|
|
56128
|
+
* @param {ProviderEnum} channel The channel to connect: UberEats, Wolt, WoltStorefront or ResQ. Any other channel is answered 400
|
|
54364
56129
|
* @param {CreateOnboardingSessionDto} createOnboardingSessionDto
|
|
54365
56130
|
* @param {*} [options] Override http request option.
|
|
54366
56131
|
* @throws {RequiredError}
|
|
@@ -54369,9 +56134,9 @@ export const ProviderApiFactory = function (configuration?: Configuration, baseP
|
|
|
54369
56134
|
return localVarFp.createOnboardingSession(channel, createOnboardingSessionDto, options).then((request) => request(axios, basePath));
|
|
54370
56135
|
},
|
|
54371
56136
|
/**
|
|
54372
|
-
* 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
|
|
54373
|
-
* @summary Disconnect a venue from Uber Eats or
|
|
54374
|
-
* @param {ProviderEnum} channel The channel to connect: UberEats, Wolt or
|
|
56137
|
+
* 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.
|
|
56138
|
+
* @summary Disconnect a venue from Uber Eats, Wolt or ResQ
|
|
56139
|
+
* @param {ProviderEnum} channel The channel to connect: UberEats, Wolt, WoltStorefront or ResQ. Any other channel is answered 400
|
|
54375
56140
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
54376
56141
|
* @param {*} [options] Override http request option.
|
|
54377
56142
|
* @throws {RequiredError}
|
|
@@ -54390,9 +56155,9 @@ export const ProviderApiFactory = function (configuration?: Configuration, baseP
|
|
|
54390
56155
|
return localVarFp.getMenuIntegrations(businessId, options).then((request) => request(axios, basePath));
|
|
54391
56156
|
},
|
|
54392
56157
|
/**
|
|
54393
|
-
* The channel\'s service answers, and its answer is passed on as it is: Uber Eats\' shape for UberEats, Wolt\'s for Wolt and
|
|
54394
|
-
* @summary Whether a venue is connected to Uber Eats or
|
|
54395
|
-
* @param {ProviderEnum} channel The channel to connect: UberEats, Wolt or
|
|
56158
|
+
* 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.
|
|
56159
|
+
* @summary Whether a venue is connected to Uber Eats, Wolt or ResQ
|
|
56160
|
+
* @param {ProviderEnum} channel The channel to connect: UberEats, Wolt, WoltStorefront or ResQ. Any other channel is answered 400
|
|
54396
56161
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
54397
56162
|
* @param {*} [options] Override http request option.
|
|
54398
56163
|
* @throws {RequiredError}
|
|
@@ -54444,9 +56209,9 @@ export const ProviderApiFactory = function (configuration?: Configuration, baseP
|
|
|
54444
56209
|
*/
|
|
54445
56210
|
export interface ProviderApiInterface {
|
|
54446
56211
|
/**
|
|
54447
|
-
* 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.
|
|
54448
|
-
* @summary Start connecting a venue to Uber Eats or
|
|
54449
|
-
* @param {ProviderEnum} channel The channel to connect: UberEats, Wolt or
|
|
56212
|
+
* 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.
|
|
56213
|
+
* @summary Start connecting a venue to Uber Eats, Wolt or ResQ
|
|
56214
|
+
* @param {ProviderEnum} channel The channel to connect: UberEats, Wolt, WoltStorefront or ResQ. Any other channel is answered 400
|
|
54450
56215
|
* @param {CreateOnboardingSessionDto} createOnboardingSessionDto
|
|
54451
56216
|
* @param {*} [options] Override http request option.
|
|
54452
56217
|
* @throws {RequiredError}
|
|
@@ -54455,9 +56220,9 @@ export interface ProviderApiInterface {
|
|
|
54455
56220
|
createOnboardingSession(channel: ProviderEnum, createOnboardingSessionDto: CreateOnboardingSessionDto, options?: AxiosRequestConfig): AxiosPromise<OnboardingSessionDto>;
|
|
54456
56221
|
|
|
54457
56222
|
/**
|
|
54458
|
-
* 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
|
|
54459
|
-
* @summary Disconnect a venue from Uber Eats or
|
|
54460
|
-
* @param {ProviderEnum} channel The channel to connect: UberEats, Wolt or
|
|
56223
|
+
* 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.
|
|
56224
|
+
* @summary Disconnect a venue from Uber Eats, Wolt or ResQ
|
|
56225
|
+
* @param {ProviderEnum} channel The channel to connect: UberEats, Wolt, WoltStorefront or ResQ. Any other channel is answered 400
|
|
54461
56226
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
54462
56227
|
* @param {*} [options] Override http request option.
|
|
54463
56228
|
* @throws {RequiredError}
|
|
@@ -54476,9 +56241,9 @@ export interface ProviderApiInterface {
|
|
|
54476
56241
|
getMenuIntegrations(businessId: number, options?: AxiosRequestConfig): AxiosPromise<Array<ProviderIntegrationDto>>;
|
|
54477
56242
|
|
|
54478
56243
|
/**
|
|
54479
|
-
* The channel\'s service answers, and its answer is passed on as it is: Uber Eats\' shape for UberEats, Wolt\'s for Wolt and
|
|
54480
|
-
* @summary Whether a venue is connected to Uber Eats or
|
|
54481
|
-
* @param {ProviderEnum} channel The channel to connect: UberEats, Wolt or
|
|
56244
|
+
* 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.
|
|
56245
|
+
* @summary Whether a venue is connected to Uber Eats, Wolt or ResQ
|
|
56246
|
+
* @param {ProviderEnum} channel The channel to connect: UberEats, Wolt, WoltStorefront or ResQ. Any other channel is answered 400
|
|
54482
56247
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
54483
56248
|
* @param {*} [options] Override http request option.
|
|
54484
56249
|
* @throws {RequiredError}
|
|
@@ -54530,9 +56295,9 @@ export interface ProviderApiInterface {
|
|
|
54530
56295
|
*/
|
|
54531
56296
|
export class ProviderApi extends BaseAPI implements ProviderApiInterface {
|
|
54532
56297
|
/**
|
|
54533
|
-
* 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.
|
|
54534
|
-
* @summary Start connecting a venue to Uber Eats or
|
|
54535
|
-
* @param {ProviderEnum} channel The channel to connect: UberEats, Wolt or
|
|
56298
|
+
* 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.
|
|
56299
|
+
* @summary Start connecting a venue to Uber Eats, Wolt or ResQ
|
|
56300
|
+
* @param {ProviderEnum} channel The channel to connect: UberEats, Wolt, WoltStorefront or ResQ. Any other channel is answered 400
|
|
54536
56301
|
* @param {CreateOnboardingSessionDto} createOnboardingSessionDto
|
|
54537
56302
|
* @param {*} [options] Override http request option.
|
|
54538
56303
|
* @throws {RequiredError}
|
|
@@ -54543,9 +56308,9 @@ export class ProviderApi extends BaseAPI implements ProviderApiInterface {
|
|
|
54543
56308
|
}
|
|
54544
56309
|
|
|
54545
56310
|
/**
|
|
54546
|
-
* 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
|
|
54547
|
-
* @summary Disconnect a venue from Uber Eats or
|
|
54548
|
-
* @param {ProviderEnum} channel The channel to connect: UberEats, Wolt or
|
|
56311
|
+
* 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.
|
|
56312
|
+
* @summary Disconnect a venue from Uber Eats, Wolt or ResQ
|
|
56313
|
+
* @param {ProviderEnum} channel The channel to connect: UberEats, Wolt, WoltStorefront or ResQ. Any other channel is answered 400
|
|
54549
56314
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
54550
56315
|
* @param {*} [options] Override http request option.
|
|
54551
56316
|
* @throws {RequiredError}
|
|
@@ -54568,9 +56333,9 @@ export class ProviderApi extends BaseAPI implements ProviderApiInterface {
|
|
|
54568
56333
|
}
|
|
54569
56334
|
|
|
54570
56335
|
/**
|
|
54571
|
-
* The channel\'s service answers, and its answer is passed on as it is: Uber Eats\' shape for UberEats, Wolt\'s for Wolt and
|
|
54572
|
-
* @summary Whether a venue is connected to Uber Eats or
|
|
54573
|
-
* @param {ProviderEnum} channel The channel to connect: UberEats, Wolt or
|
|
56336
|
+
* 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.
|
|
56337
|
+
* @summary Whether a venue is connected to Uber Eats, Wolt or ResQ
|
|
56338
|
+
* @param {ProviderEnum} channel The channel to connect: UberEats, Wolt, WoltStorefront or ResQ. Any other channel is answered 400
|
|
54574
56339
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
54575
56340
|
* @param {*} [options] Override http request option.
|
|
54576
56341
|
* @throws {RequiredError}
|
|
@@ -54632,11 +56397,11 @@ export const ReceiptFooterApiAxiosParamCreator = function (configuration?: Confi
|
|
|
54632
56397
|
* 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.
|
|
54633
56398
|
* @summary Get the receipt footer config for a business + channel
|
|
54634
56399
|
* @param {number} businessId The venue whose footer is read or written: its orderingBusinessId
|
|
54635
|
-
* @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
|
|
56400
|
+
* @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
|
|
54636
56401
|
* @param {*} [options] Override http request option.
|
|
54637
56402
|
* @throws {RequiredError}
|
|
54638
56403
|
*/
|
|
54639
|
-
receiptFooterGetConfig: async (businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
56404
|
+
receiptFooterGetConfig: async (businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
54640
56405
|
// verify required parameter 'businessId' is not null or undefined
|
|
54641
56406
|
assertParamExists('receiptFooterGetConfig', 'businessId', businessId)
|
|
54642
56407
|
// verify required parameter 'xAppX' is not null or undefined
|
|
@@ -54677,12 +56442,12 @@ export const ReceiptFooterApiAxiosParamCreator = function (configuration?: Confi
|
|
|
54677
56442
|
* 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.
|
|
54678
56443
|
* @summary Create or update the receipt footer config for a business + channel
|
|
54679
56444
|
* @param {number} businessId The venue whose footer is read or written: its orderingBusinessId
|
|
54680
|
-
* @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
|
|
56445
|
+
* @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
|
|
54681
56446
|
* @param {UpsertReceiptFooterDto} upsertReceiptFooterDto
|
|
54682
56447
|
* @param {*} [options] Override http request option.
|
|
54683
56448
|
* @throws {RequiredError}
|
|
54684
56449
|
*/
|
|
54685
|
-
receiptFooterUpsertConfig: async (businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', upsertReceiptFooterDto: UpsertReceiptFooterDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
56450
|
+
receiptFooterUpsertConfig: async (businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertReceiptFooterDto: UpsertReceiptFooterDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
54686
56451
|
// verify required parameter 'businessId' is not null or undefined
|
|
54687
56452
|
assertParamExists('receiptFooterUpsertConfig', 'businessId', businessId)
|
|
54688
56453
|
// verify required parameter 'xAppX' is not null or undefined
|
|
@@ -54738,11 +56503,11 @@ export const ReceiptFooterApiFp = function(configuration?: Configuration) {
|
|
|
54738
56503
|
* 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.
|
|
54739
56504
|
* @summary Get the receipt footer config for a business + channel
|
|
54740
56505
|
* @param {number} businessId The venue whose footer is read or written: its orderingBusinessId
|
|
54741
|
-
* @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
|
|
56506
|
+
* @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
|
|
54742
56507
|
* @param {*} [options] Override http request option.
|
|
54743
56508
|
* @throws {RequiredError}
|
|
54744
56509
|
*/
|
|
54745
|
-
async 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>> {
|
|
56510
|
+
async receiptFooterGetConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReceiptFooterConfigDto>> {
|
|
54746
56511
|
const localVarAxiosArgs = await localVarAxiosParamCreator.receiptFooterGetConfig(businessId, xAppX, options);
|
|
54747
56512
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
54748
56513
|
},
|
|
@@ -54750,12 +56515,12 @@ export const ReceiptFooterApiFp = function(configuration?: Configuration) {
|
|
|
54750
56515
|
* 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.
|
|
54751
56516
|
* @summary Create or update the receipt footer config for a business + channel
|
|
54752
56517
|
* @param {number} businessId The venue whose footer is read or written: its orderingBusinessId
|
|
54753
|
-
* @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
|
|
56518
|
+
* @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
|
|
54754
56519
|
* @param {UpsertReceiptFooterDto} upsertReceiptFooterDto
|
|
54755
56520
|
* @param {*} [options] Override http request option.
|
|
54756
56521
|
* @throws {RequiredError}
|
|
54757
56522
|
*/
|
|
54758
|
-
async 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>> {
|
|
56523
|
+
async receiptFooterUpsertConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertReceiptFooterDto: UpsertReceiptFooterDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReceiptFooterConfigDto>> {
|
|
54759
56524
|
const localVarAxiosArgs = await localVarAxiosParamCreator.receiptFooterUpsertConfig(businessId, xAppX, upsertReceiptFooterDto, options);
|
|
54760
56525
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
54761
56526
|
},
|
|
@@ -54773,23 +56538,23 @@ export const ReceiptFooterApiFactory = function (configuration?: Configuration,
|
|
|
54773
56538
|
* 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.
|
|
54774
56539
|
* @summary Get the receipt footer config for a business + channel
|
|
54775
56540
|
* @param {number} businessId The venue whose footer is read or written: its orderingBusinessId
|
|
54776
|
-
* @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
|
|
56541
|
+
* @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
|
|
54777
56542
|
* @param {*} [options] Override http request option.
|
|
54778
56543
|
* @throws {RequiredError}
|
|
54779
56544
|
*/
|
|
54780
|
-
receiptFooterGetConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', options?: any): AxiosPromise<ReceiptFooterConfigDto> {
|
|
56545
|
+
receiptFooterGetConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', options?: any): AxiosPromise<ReceiptFooterConfigDto> {
|
|
54781
56546
|
return localVarFp.receiptFooterGetConfig(businessId, xAppX, options).then((request) => request(axios, basePath));
|
|
54782
56547
|
},
|
|
54783
56548
|
/**
|
|
54784
56549
|
* 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.
|
|
54785
56550
|
* @summary Create or update the receipt footer config for a business + channel
|
|
54786
56551
|
* @param {number} businessId The venue whose footer is read or written: its orderingBusinessId
|
|
54787
|
-
* @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
|
|
56552
|
+
* @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
|
|
54788
56553
|
* @param {UpsertReceiptFooterDto} upsertReceiptFooterDto
|
|
54789
56554
|
* @param {*} [options] Override http request option.
|
|
54790
56555
|
* @throws {RequiredError}
|
|
54791
56556
|
*/
|
|
54792
|
-
receiptFooterUpsertConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', upsertReceiptFooterDto: UpsertReceiptFooterDto, options?: any): AxiosPromise<ReceiptFooterConfigDto> {
|
|
56557
|
+
receiptFooterUpsertConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertReceiptFooterDto: UpsertReceiptFooterDto, options?: any): AxiosPromise<ReceiptFooterConfigDto> {
|
|
54793
56558
|
return localVarFp.receiptFooterUpsertConfig(businessId, xAppX, upsertReceiptFooterDto, options).then((request) => request(axios, basePath));
|
|
54794
56559
|
},
|
|
54795
56560
|
};
|
|
@@ -54805,24 +56570,24 @@ export interface ReceiptFooterApiInterface {
|
|
|
54805
56570
|
* 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.
|
|
54806
56571
|
* @summary Get the receipt footer config for a business + channel
|
|
54807
56572
|
* @param {number} businessId The venue whose footer is read or written: its orderingBusinessId
|
|
54808
|
-
* @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
|
|
56573
|
+
* @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
|
|
54809
56574
|
* @param {*} [options] Override http request option.
|
|
54810
56575
|
* @throws {RequiredError}
|
|
54811
56576
|
* @memberof ReceiptFooterApiInterface
|
|
54812
56577
|
*/
|
|
54813
|
-
receiptFooterGetConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', options?: AxiosRequestConfig): AxiosPromise<ReceiptFooterConfigDto>;
|
|
56578
|
+
receiptFooterGetConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', options?: AxiosRequestConfig): AxiosPromise<ReceiptFooterConfigDto>;
|
|
54814
56579
|
|
|
54815
56580
|
/**
|
|
54816
56581
|
* 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.
|
|
54817
56582
|
* @summary Create or update the receipt footer config for a business + channel
|
|
54818
56583
|
* @param {number} businessId The venue whose footer is read or written: its orderingBusinessId
|
|
54819
|
-
* @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
|
|
56584
|
+
* @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
|
|
54820
56585
|
* @param {UpsertReceiptFooterDto} upsertReceiptFooterDto
|
|
54821
56586
|
* @param {*} [options] Override http request option.
|
|
54822
56587
|
* @throws {RequiredError}
|
|
54823
56588
|
* @memberof ReceiptFooterApiInterface
|
|
54824
56589
|
*/
|
|
54825
|
-
receiptFooterUpsertConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', upsertReceiptFooterDto: UpsertReceiptFooterDto, options?: AxiosRequestConfig): AxiosPromise<ReceiptFooterConfigDto>;
|
|
56590
|
+
receiptFooterUpsertConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertReceiptFooterDto: UpsertReceiptFooterDto, options?: AxiosRequestConfig): AxiosPromise<ReceiptFooterConfigDto>;
|
|
54826
56591
|
|
|
54827
56592
|
}
|
|
54828
56593
|
|
|
@@ -54837,12 +56602,12 @@ export class ReceiptFooterApi extends BaseAPI implements ReceiptFooterApiInterfa
|
|
|
54837
56602
|
* 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.
|
|
54838
56603
|
* @summary Get the receipt footer config for a business + channel
|
|
54839
56604
|
* @param {number} businessId The venue whose footer is read or written: its orderingBusinessId
|
|
54840
|
-
* @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
|
|
56605
|
+
* @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
|
|
54841
56606
|
* @param {*} [options] Override http request option.
|
|
54842
56607
|
* @throws {RequiredError}
|
|
54843
56608
|
* @memberof ReceiptFooterApi
|
|
54844
56609
|
*/
|
|
54845
|
-
public receiptFooterGetConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', options?: AxiosRequestConfig) {
|
|
56610
|
+
public receiptFooterGetConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', options?: AxiosRequestConfig) {
|
|
54846
56611
|
return ReceiptFooterApiFp(this.configuration).receiptFooterGetConfig(businessId, xAppX, options).then((request) => request(this.axios, this.basePath));
|
|
54847
56612
|
}
|
|
54848
56613
|
|
|
@@ -54850,13 +56615,13 @@ export class ReceiptFooterApi extends BaseAPI implements ReceiptFooterApiInterfa
|
|
|
54850
56615
|
* 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.
|
|
54851
56616
|
* @summary Create or update the receipt footer config for a business + channel
|
|
54852
56617
|
* @param {number} businessId The venue whose footer is read or written: its orderingBusinessId
|
|
54853
|
-
* @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
|
|
56618
|
+
* @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
|
|
54854
56619
|
* @param {UpsertReceiptFooterDto} upsertReceiptFooterDto
|
|
54855
56620
|
* @param {*} [options] Override http request option.
|
|
54856
56621
|
* @throws {RequiredError}
|
|
54857
56622
|
* @memberof ReceiptFooterApi
|
|
54858
56623
|
*/
|
|
54859
|
-
public receiptFooterUpsertConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', upsertReceiptFooterDto: UpsertReceiptFooterDto, options?: AxiosRequestConfig) {
|
|
56624
|
+
public receiptFooterUpsertConfig(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertReceiptFooterDto: UpsertReceiptFooterDto, options?: AxiosRequestConfig) {
|
|
54860
56625
|
return ReceiptFooterApiFp(this.configuration).receiptFooterUpsertConfig(businessId, xAppX, upsertReceiptFooterDto, options).then((request) => request(this.axios, this.basePath));
|
|
54861
56626
|
}
|
|
54862
56627
|
}
|