@munchi_oy/core 1.9.75 → 1.9.77
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 +954 -54
- 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 +1143 -0
- package/package.json +15 -13
- package/src/version.ts +1 -1
package/dist/generated/api.d.ts
CHANGED
|
@@ -5009,6 +5009,62 @@ export interface DiscoverTerminalDto {
|
|
|
5009
5009
|
*/
|
|
5010
5010
|
'provider': PaymentProvider;
|
|
5011
5011
|
}
|
|
5012
|
+
/**
|
|
5013
|
+
*
|
|
5014
|
+
* @export
|
|
5015
|
+
* @interface DisplayInitBodyDto
|
|
5016
|
+
*/
|
|
5017
|
+
export interface DisplayInitBodyDto {
|
|
5018
|
+
/**
|
|
5019
|
+
* Optional human-readable label for the display device.
|
|
5020
|
+
* @type {string}
|
|
5021
|
+
* @memberof DisplayInitBodyDto
|
|
5022
|
+
*/
|
|
5023
|
+
'displayName'?: string | null;
|
|
5024
|
+
}
|
|
5025
|
+
/**
|
|
5026
|
+
*
|
|
5027
|
+
* @export
|
|
5028
|
+
* @interface DisplayInitResponseDto
|
|
5029
|
+
*/
|
|
5030
|
+
export interface DisplayInitResponseDto {
|
|
5031
|
+
/**
|
|
5032
|
+
* Server-issued display identity.
|
|
5033
|
+
* @type {string}
|
|
5034
|
+
* @memberof DisplayInitResponseDto
|
|
5035
|
+
*/
|
|
5036
|
+
'displayId': string;
|
|
5037
|
+
/**
|
|
5038
|
+
* Short pairing code shown on the display.
|
|
5039
|
+
* @type {string}
|
|
5040
|
+
* @memberof DisplayInitResponseDto
|
|
5041
|
+
*/
|
|
5042
|
+
'code': string;
|
|
5043
|
+
/**
|
|
5044
|
+
* One-time nonce carried in the pairing QR.
|
|
5045
|
+
* @type {string}
|
|
5046
|
+
* @memberof DisplayInitResponseDto
|
|
5047
|
+
*/
|
|
5048
|
+
'nonce': string;
|
|
5049
|
+
/**
|
|
5050
|
+
* Ably channel the display subscribes to for the ack.
|
|
5051
|
+
* @type {string}
|
|
5052
|
+
* @memberof DisplayInitResponseDto
|
|
5053
|
+
*/
|
|
5054
|
+
'pairingChannel': string;
|
|
5055
|
+
/**
|
|
5056
|
+
* Epoch ms when the code/nonce expires.
|
|
5057
|
+
* @type {number}
|
|
5058
|
+
* @memberof DisplayInitResponseDto
|
|
5059
|
+
*/
|
|
5060
|
+
'expiresAt': number;
|
|
5061
|
+
/**
|
|
5062
|
+
* Ably TokenRequest scoped to the pairing channel.
|
|
5063
|
+
* @type {object}
|
|
5064
|
+
* @memberof DisplayInitResponseDto
|
|
5065
|
+
*/
|
|
5066
|
+
'ablyTokenRequest': object;
|
|
5067
|
+
}
|
|
5012
5068
|
/**
|
|
5013
5069
|
*
|
|
5014
5070
|
* @export
|
|
@@ -11330,6 +11386,172 @@ export interface OrderResponseDtoPriceSummary {
|
|
|
11330
11386
|
*/
|
|
11331
11387
|
'totalNet': number;
|
|
11332
11388
|
}
|
|
11389
|
+
/**
|
|
11390
|
+
*
|
|
11391
|
+
* @export
|
|
11392
|
+
* @interface OrderSettlementStatusDto
|
|
11393
|
+
*/
|
|
11394
|
+
export interface OrderSettlementStatusDto {
|
|
11395
|
+
/**
|
|
11396
|
+
* The internal business ID.
|
|
11397
|
+
* @type {number}
|
|
11398
|
+
* @memberof OrderSettlementStatusDto
|
|
11399
|
+
*/
|
|
11400
|
+
'businessId': number;
|
|
11401
|
+
/**
|
|
11402
|
+
* The order ID the settlement is computed for.
|
|
11403
|
+
* @type {string}
|
|
11404
|
+
* @memberof OrderSettlementStatusDto
|
|
11405
|
+
*/
|
|
11406
|
+
'orderId': string;
|
|
11407
|
+
/**
|
|
11408
|
+
* The order\'s checkout model (FULL / EQUAL_SPLIT / ITEM_SPLIT).
|
|
11409
|
+
* @type {string}
|
|
11410
|
+
* @memberof OrderSettlementStatusDto
|
|
11411
|
+
*/
|
|
11412
|
+
'checkoutModel': string;
|
|
11413
|
+
/**
|
|
11414
|
+
* Overall settlement status: \'underpaid\' | \'settled\' | \'overpaid\'.
|
|
11415
|
+
* @type {string}
|
|
11416
|
+
* @memberof OrderSettlementStatusDto
|
|
11417
|
+
*/
|
|
11418
|
+
'status': string;
|
|
11419
|
+
/**
|
|
11420
|
+
* True once the order is fully paid (settled or overpaid). The FE\'s stop condition.
|
|
11421
|
+
* @type {boolean}
|
|
11422
|
+
* @memberof OrderSettlementStatusDto
|
|
11423
|
+
*/
|
|
11424
|
+
'isFullyPaid': boolean;
|
|
11425
|
+
/**
|
|
11426
|
+
* Order total in the smallest currency unit (cents).
|
|
11427
|
+
* @type {number}
|
|
11428
|
+
* @memberof OrderSettlementStatusDto
|
|
11429
|
+
*/
|
|
11430
|
+
'cartTotal': number;
|
|
11431
|
+
/**
|
|
11432
|
+
* Sum of settled payments in cents.
|
|
11433
|
+
* @type {number}
|
|
11434
|
+
* @memberof OrderSettlementStatusDto
|
|
11435
|
+
*/
|
|
11436
|
+
'paidAmount': number;
|
|
11437
|
+
/**
|
|
11438
|
+
* Outstanding balance in cents (0 when settled/overpaid).
|
|
11439
|
+
* @type {number}
|
|
11440
|
+
* @memberof OrderSettlementStatusDto
|
|
11441
|
+
*/
|
|
11442
|
+
'remainingAmount': number;
|
|
11443
|
+
/**
|
|
11444
|
+
* Amount still payable in cents (never negative).
|
|
11445
|
+
* @type {number}
|
|
11446
|
+
* @memberof OrderSettlementStatusDto
|
|
11447
|
+
*/
|
|
11448
|
+
'amountLeftToPay': number;
|
|
11449
|
+
/**
|
|
11450
|
+
* Number of paymentEvents currently on the order.
|
|
11451
|
+
* @type {number}
|
|
11452
|
+
* @memberof OrderSettlementStatusDto
|
|
11453
|
+
*/
|
|
11454
|
+
'paymentEventCount': number;
|
|
11455
|
+
}
|
|
11456
|
+
/**
|
|
11457
|
+
*
|
|
11458
|
+
* @export
|
|
11459
|
+
* @interface OrderSettlementStatusRequestDto
|
|
11460
|
+
*/
|
|
11461
|
+
export interface OrderSettlementStatusRequestDto {
|
|
11462
|
+
/**
|
|
11463
|
+
* Cash change handed back to the customer (cents), netted out of the paid amount so an over-tender does not read as overpaid. Omit or 0 for no adjustment.
|
|
11464
|
+
* @type {number}
|
|
11465
|
+
* @memberof OrderSettlementStatusRequestDto
|
|
11466
|
+
*/
|
|
11467
|
+
'cashChange'?: number;
|
|
11468
|
+
/**
|
|
11469
|
+
* Override the cart total (cents) instead of the persisted order total. For FULL-cart callers whose total differs from the snapshot (e.g. cash-rounded).
|
|
11470
|
+
* @type {number}
|
|
11471
|
+
* @memberof OrderSettlementStatusRequestDto
|
|
11472
|
+
*/
|
|
11473
|
+
'cartTotalAmount'?: number;
|
|
11474
|
+
}
|
|
11475
|
+
/**
|
|
11476
|
+
*
|
|
11477
|
+
* @export
|
|
11478
|
+
* @interface OrderSettlementStatusResponseDto
|
|
11479
|
+
*/
|
|
11480
|
+
export interface OrderSettlementStatusResponseDto {
|
|
11481
|
+
/**
|
|
11482
|
+
*
|
|
11483
|
+
* @type {OrderSettlementStatusResponseDtoSettlement}
|
|
11484
|
+
* @memberof OrderSettlementStatusResponseDto
|
|
11485
|
+
*/
|
|
11486
|
+
'settlement': OrderSettlementStatusResponseDtoSettlement | null;
|
|
11487
|
+
}
|
|
11488
|
+
/**
|
|
11489
|
+
* The settlement status, or null when the order is unavailable / not computable.
|
|
11490
|
+
* @export
|
|
11491
|
+
* @interface OrderSettlementStatusResponseDtoSettlement
|
|
11492
|
+
*/
|
|
11493
|
+
export interface OrderSettlementStatusResponseDtoSettlement {
|
|
11494
|
+
/**
|
|
11495
|
+
* The internal business ID.
|
|
11496
|
+
* @type {number}
|
|
11497
|
+
* @memberof OrderSettlementStatusResponseDtoSettlement
|
|
11498
|
+
*/
|
|
11499
|
+
'businessId': number;
|
|
11500
|
+
/**
|
|
11501
|
+
* The order ID the settlement is computed for.
|
|
11502
|
+
* @type {string}
|
|
11503
|
+
* @memberof OrderSettlementStatusResponseDtoSettlement
|
|
11504
|
+
*/
|
|
11505
|
+
'orderId': string;
|
|
11506
|
+
/**
|
|
11507
|
+
* The order\'s checkout model (FULL / EQUAL_SPLIT / ITEM_SPLIT).
|
|
11508
|
+
* @type {string}
|
|
11509
|
+
* @memberof OrderSettlementStatusResponseDtoSettlement
|
|
11510
|
+
*/
|
|
11511
|
+
'checkoutModel': string;
|
|
11512
|
+
/**
|
|
11513
|
+
* Overall settlement status: \'underpaid\' | \'settled\' | \'overpaid\'.
|
|
11514
|
+
* @type {string}
|
|
11515
|
+
* @memberof OrderSettlementStatusResponseDtoSettlement
|
|
11516
|
+
*/
|
|
11517
|
+
'status': string;
|
|
11518
|
+
/**
|
|
11519
|
+
* True once the order is fully paid (settled or overpaid). The FE\'s stop condition.
|
|
11520
|
+
* @type {boolean}
|
|
11521
|
+
* @memberof OrderSettlementStatusResponseDtoSettlement
|
|
11522
|
+
*/
|
|
11523
|
+
'isFullyPaid': boolean;
|
|
11524
|
+
/**
|
|
11525
|
+
* Order total in the smallest currency unit (cents).
|
|
11526
|
+
* @type {number}
|
|
11527
|
+
* @memberof OrderSettlementStatusResponseDtoSettlement
|
|
11528
|
+
*/
|
|
11529
|
+
'cartTotal': number;
|
|
11530
|
+
/**
|
|
11531
|
+
* Sum of settled payments in cents.
|
|
11532
|
+
* @type {number}
|
|
11533
|
+
* @memberof OrderSettlementStatusResponseDtoSettlement
|
|
11534
|
+
*/
|
|
11535
|
+
'paidAmount': number;
|
|
11536
|
+
/**
|
|
11537
|
+
* Outstanding balance in cents (0 when settled/overpaid).
|
|
11538
|
+
* @type {number}
|
|
11539
|
+
* @memberof OrderSettlementStatusResponseDtoSettlement
|
|
11540
|
+
*/
|
|
11541
|
+
'remainingAmount': number;
|
|
11542
|
+
/**
|
|
11543
|
+
* Amount still payable in cents (never negative).
|
|
11544
|
+
* @type {number}
|
|
11545
|
+
* @memberof OrderSettlementStatusResponseDtoSettlement
|
|
11546
|
+
*/
|
|
11547
|
+
'amountLeftToPay': number;
|
|
11548
|
+
/**
|
|
11549
|
+
* Number of paymentEvents currently on the order.
|
|
11550
|
+
* @type {number}
|
|
11551
|
+
* @memberof OrderSettlementStatusResponseDtoSettlement
|
|
11552
|
+
*/
|
|
11553
|
+
'paymentEventCount': number;
|
|
11554
|
+
}
|
|
11333
11555
|
/**
|
|
11334
11556
|
*
|
|
11335
11557
|
* @export
|
|
@@ -12057,6 +12279,68 @@ export interface PaginationDto {
|
|
|
12057
12279
|
*/
|
|
12058
12280
|
'totalPages': number;
|
|
12059
12281
|
}
|
|
12282
|
+
/**
|
|
12283
|
+
*
|
|
12284
|
+
* @export
|
|
12285
|
+
* @interface PairDisplayBodyDto
|
|
12286
|
+
*/
|
|
12287
|
+
export interface PairDisplayBodyDto {
|
|
12288
|
+
/**
|
|
12289
|
+
* Stable POS device identifier.
|
|
12290
|
+
* @type {string}
|
|
12291
|
+
* @memberof PairDisplayBodyDto
|
|
12292
|
+
*/
|
|
12293
|
+
'posDeviceId': string;
|
|
12294
|
+
/**
|
|
12295
|
+
* Pairing code entered on the POS.
|
|
12296
|
+
* @type {string}
|
|
12297
|
+
* @memberof PairDisplayBodyDto
|
|
12298
|
+
*/
|
|
12299
|
+
'code'?: string;
|
|
12300
|
+
/**
|
|
12301
|
+
* Display id (QR path, with nonce).
|
|
12302
|
+
* @type {string}
|
|
12303
|
+
* @memberof PairDisplayBodyDto
|
|
12304
|
+
*/
|
|
12305
|
+
'displayId'?: string;
|
|
12306
|
+
/**
|
|
12307
|
+
* One-time nonce (QR path).
|
|
12308
|
+
* @type {string}
|
|
12309
|
+
* @memberof PairDisplayBodyDto
|
|
12310
|
+
*/
|
|
12311
|
+
'nonce'?: string;
|
|
12312
|
+
/**
|
|
12313
|
+
* Business to pair to; must be in the caller\'s scope.
|
|
12314
|
+
* @type {number}
|
|
12315
|
+
* @memberof PairDisplayBodyDto
|
|
12316
|
+
*/
|
|
12317
|
+
'businessId'?: number;
|
|
12318
|
+
}
|
|
12319
|
+
/**
|
|
12320
|
+
*
|
|
12321
|
+
* @export
|
|
12322
|
+
* @interface PairDisplayResponseDto
|
|
12323
|
+
*/
|
|
12324
|
+
export interface PairDisplayResponseDto {
|
|
12325
|
+
/**
|
|
12326
|
+
*
|
|
12327
|
+
* @type {string}
|
|
12328
|
+
* @memberof PairDisplayResponseDto
|
|
12329
|
+
*/
|
|
12330
|
+
'sessionId': string;
|
|
12331
|
+
/**
|
|
12332
|
+
*
|
|
12333
|
+
* @type {string}
|
|
12334
|
+
* @memberof PairDisplayResponseDto
|
|
12335
|
+
*/
|
|
12336
|
+
'sessionChannel': string;
|
|
12337
|
+
/**
|
|
12338
|
+
*
|
|
12339
|
+
* @type {string}
|
|
12340
|
+
* @memberof PairDisplayResponseDto
|
|
12341
|
+
*/
|
|
12342
|
+
'displayId': string;
|
|
12343
|
+
}
|
|
12060
12344
|
/**
|
|
12061
12345
|
*
|
|
12062
12346
|
* @export
|
|
@@ -18258,6 +18542,55 @@ export interface ReportingCategoryDto {
|
|
|
18258
18542
|
*/
|
|
18259
18543
|
'updated_at': string;
|
|
18260
18544
|
}
|
|
18545
|
+
/**
|
|
18546
|
+
*
|
|
18547
|
+
* @export
|
|
18548
|
+
* @interface RequestSessionTokenBodyDto
|
|
18549
|
+
*/
|
|
18550
|
+
export interface RequestSessionTokenBodyDto {
|
|
18551
|
+
/**
|
|
18552
|
+
*
|
|
18553
|
+
* @type {string}
|
|
18554
|
+
* @memberof RequestSessionTokenBodyDto
|
|
18555
|
+
*/
|
|
18556
|
+
'sessionId': string;
|
|
18557
|
+
/**
|
|
18558
|
+
* Which device is requesting the token.
|
|
18559
|
+
* @type {string}
|
|
18560
|
+
* @memberof RequestSessionTokenBodyDto
|
|
18561
|
+
*/
|
|
18562
|
+
'role': RoleEnum;
|
|
18563
|
+
/**
|
|
18564
|
+
* Requesting device id (posDeviceId or displayId).
|
|
18565
|
+
* @type {string}
|
|
18566
|
+
* @memberof RequestSessionTokenBodyDto
|
|
18567
|
+
*/
|
|
18568
|
+
'deviceId': string;
|
|
18569
|
+
}
|
|
18570
|
+
export declare const RoleEnum: {
|
|
18571
|
+
readonly Pos: "pos";
|
|
18572
|
+
readonly Display: "display";
|
|
18573
|
+
};
|
|
18574
|
+
export type RoleEnum = typeof RoleEnum[keyof typeof RoleEnum];
|
|
18575
|
+
/**
|
|
18576
|
+
*
|
|
18577
|
+
* @export
|
|
18578
|
+
* @interface RequestSessionTokenResponseDto
|
|
18579
|
+
*/
|
|
18580
|
+
export interface RequestSessionTokenResponseDto {
|
|
18581
|
+
/**
|
|
18582
|
+
* Ably TokenRequest scoped to the session channel.
|
|
18583
|
+
* @type {object}
|
|
18584
|
+
* @memberof RequestSessionTokenResponseDto
|
|
18585
|
+
*/
|
|
18586
|
+
'ablyTokenRequest': object;
|
|
18587
|
+
/**
|
|
18588
|
+
*
|
|
18589
|
+
* @type {string}
|
|
18590
|
+
* @memberof RequestSessionTokenResponseDto
|
|
18591
|
+
*/
|
|
18592
|
+
'sessionChannel': string;
|
|
18593
|
+
}
|
|
18261
18594
|
/**
|
|
18262
18595
|
*
|
|
18263
18596
|
* @export
|
|
@@ -19347,261 +19680,528 @@ export interface SupportedChannelDto {
|
|
|
19347
19680
|
/**
|
|
19348
19681
|
*
|
|
19349
19682
|
* @export
|
|
19350
|
-
* @interface
|
|
19683
|
+
* @interface SyncKioskOrderDto
|
|
19351
19684
|
*/
|
|
19352
|
-
export interface
|
|
19353
|
-
/**
|
|
19354
|
-
*
|
|
19355
|
-
* @type {SyncPosOrderDtoOrder}
|
|
19356
|
-
* @memberof SyncPosOrderDto
|
|
19357
|
-
*/
|
|
19358
|
-
'order': SyncPosOrderDtoOrder;
|
|
19685
|
+
export interface SyncKioskOrderDto {
|
|
19359
19686
|
/**
|
|
19360
19687
|
*
|
|
19361
|
-
* @type {
|
|
19362
|
-
* @memberof
|
|
19688
|
+
* @type {SyncKioskOrderDtoOrder}
|
|
19689
|
+
* @memberof SyncKioskOrderDto
|
|
19363
19690
|
*/
|
|
19364
|
-
'
|
|
19691
|
+
'order': SyncKioskOrderDtoOrder;
|
|
19365
19692
|
}
|
|
19366
19693
|
/**
|
|
19367
|
-
*
|
|
19694
|
+
* Kiosk order snapshot to persist (same shape as PosOrderDto). Transitional: paymentEvents are still client-owned and persisted as sent.
|
|
19368
19695
|
* @export
|
|
19369
|
-
* @interface
|
|
19696
|
+
* @interface SyncKioskOrderDtoOrder
|
|
19370
19697
|
*/
|
|
19371
|
-
export interface
|
|
19698
|
+
export interface SyncKioskOrderDtoOrder {
|
|
19372
19699
|
/**
|
|
19373
19700
|
*
|
|
19374
19701
|
* @type {string}
|
|
19375
|
-
* @memberof
|
|
19702
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
19376
19703
|
*/
|
|
19377
19704
|
'id': string;
|
|
19378
19705
|
/**
|
|
19379
19706
|
*
|
|
19380
19707
|
* @type {string}
|
|
19381
|
-
* @memberof
|
|
19708
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
19382
19709
|
*/
|
|
19383
19710
|
'businessId': string;
|
|
19384
19711
|
/**
|
|
19385
19712
|
*
|
|
19386
19713
|
* @type {ProviderEnum}
|
|
19387
|
-
* @memberof
|
|
19714
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
19388
19715
|
*/
|
|
19389
19716
|
'provider': ProviderEnum;
|
|
19390
19717
|
/**
|
|
19391
19718
|
*
|
|
19392
19719
|
* @type {CurrencyCode}
|
|
19393
|
-
* @memberof
|
|
19720
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
19394
19721
|
*/
|
|
19395
19722
|
'currency': CurrencyCode;
|
|
19396
19723
|
/**
|
|
19397
19724
|
*
|
|
19398
19725
|
* @type {PosBusinessDto}
|
|
19399
|
-
* @memberof
|
|
19726
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
19400
19727
|
*/
|
|
19401
19728
|
'business': PosBusinessDto;
|
|
19402
19729
|
/**
|
|
19403
19730
|
*
|
|
19404
19731
|
* @type {string}
|
|
19405
|
-
* @memberof
|
|
19732
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
19406
19733
|
*/
|
|
19407
19734
|
'createdAt': string;
|
|
19408
19735
|
/**
|
|
19409
19736
|
*
|
|
19410
19737
|
* @type {OrderStatusEnum}
|
|
19411
|
-
* @memberof
|
|
19738
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
19412
19739
|
*/
|
|
19413
19740
|
'status': OrderStatusEnum;
|
|
19414
19741
|
/**
|
|
19415
19742
|
*
|
|
19416
19743
|
* @type {string}
|
|
19417
|
-
* @memberof
|
|
19744
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
19418
19745
|
*/
|
|
19419
19746
|
'updatedAt': string;
|
|
19420
19747
|
/**
|
|
19421
19748
|
*
|
|
19422
19749
|
* @type {string}
|
|
19423
|
-
* @memberof
|
|
19750
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
19424
19751
|
*/
|
|
19425
19752
|
'completedAt'?: string;
|
|
19426
19753
|
/**
|
|
19427
19754
|
*
|
|
19428
19755
|
* @type {string}
|
|
19429
|
-
* @memberof
|
|
19756
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
19430
19757
|
*/
|
|
19431
19758
|
'orderNumber': string;
|
|
19432
19759
|
/**
|
|
19433
19760
|
*
|
|
19434
19761
|
* @type {CheckoutModelEnum}
|
|
19435
|
-
* @memberof
|
|
19762
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
19436
19763
|
*/
|
|
19437
19764
|
'checkoutModel': CheckoutModelEnum;
|
|
19438
19765
|
/**
|
|
19439
19766
|
*
|
|
19440
19767
|
* @type {OrderTypePOS}
|
|
19441
|
-
* @memberof
|
|
19768
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
19442
19769
|
*/
|
|
19443
19770
|
'orderType': OrderTypePOS;
|
|
19444
19771
|
/**
|
|
19445
19772
|
*
|
|
19446
19773
|
* @type {string}
|
|
19447
|
-
* @memberof
|
|
19774
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
19448
19775
|
*/
|
|
19449
19776
|
'spotNumber': string | null;
|
|
19450
19777
|
/**
|
|
19451
19778
|
* ID of the floor plan dining table linked to this order
|
|
19452
19779
|
* @type {string}
|
|
19453
|
-
* @memberof
|
|
19780
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
19454
19781
|
*/
|
|
19455
19782
|
'tableId'?: string | null;
|
|
19456
19783
|
/**
|
|
19457
19784
|
*
|
|
19458
19785
|
* @type {string}
|
|
19459
|
-
* @memberof
|
|
19786
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
19460
19787
|
*/
|
|
19461
19788
|
'comments': string | null;
|
|
19462
19789
|
/**
|
|
19463
19790
|
*
|
|
19464
19791
|
* @type {PosOrderDtoTableService}
|
|
19465
|
-
* @memberof
|
|
19792
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
19466
19793
|
*/
|
|
19467
19794
|
'tableService'?: PosOrderDtoTableService | null;
|
|
19468
19795
|
/**
|
|
19469
19796
|
*
|
|
19470
19797
|
* @type {PosOrderDtoEqualSplitState}
|
|
19471
|
-
* @memberof
|
|
19798
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
19472
19799
|
*/
|
|
19473
19800
|
'equalSplitState'?: PosOrderDtoEqualSplitState | null;
|
|
19474
19801
|
/**
|
|
19475
19802
|
* Id of the staff in shift
|
|
19476
19803
|
* @type {string}
|
|
19477
|
-
* @memberof
|
|
19804
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
19478
19805
|
*/
|
|
19479
19806
|
'staffId': string | null;
|
|
19480
19807
|
/**
|
|
19481
19808
|
* Id of the shift
|
|
19482
19809
|
* @type {string}
|
|
19483
|
-
* @memberof
|
|
19810
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
19484
19811
|
*/
|
|
19485
19812
|
'shiftId': string | null;
|
|
19486
19813
|
/**
|
|
19487
19814
|
*
|
|
19488
19815
|
* @type {OrderRefundStatus}
|
|
19489
|
-
* @memberof
|
|
19816
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
19490
19817
|
*/
|
|
19491
19818
|
'orderRefundStatus': OrderRefundStatus;
|
|
19492
19819
|
/**
|
|
19493
19820
|
*
|
|
19494
19821
|
* @type {LocatorType}
|
|
19495
|
-
* @memberof
|
|
19822
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
19496
19823
|
*/
|
|
19497
19824
|
'locatorType': LocatorType;
|
|
19498
19825
|
/**
|
|
19499
19826
|
*
|
|
19500
19827
|
* @type {PosOrderPriceDto}
|
|
19501
|
-
* @memberof
|
|
19828
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
19502
19829
|
*/
|
|
19503
19830
|
'basketPrice': PosOrderPriceDto;
|
|
19504
19831
|
/**
|
|
19505
19832
|
*
|
|
19506
19833
|
* @type {Array<PosOrderItemDto>}
|
|
19507
|
-
* @memberof
|
|
19834
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
19508
19835
|
*/
|
|
19509
19836
|
'items': Array<PosOrderItemDto>;
|
|
19510
19837
|
/**
|
|
19511
19838
|
*
|
|
19512
19839
|
* @type {Array<PosDiscountDto>}
|
|
19513
|
-
* @memberof
|
|
19840
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
19514
19841
|
*/
|
|
19515
19842
|
'discounts': Array<PosDiscountDto>;
|
|
19516
19843
|
/**
|
|
19517
19844
|
*
|
|
19518
19845
|
* @type {PosCustomerDto}
|
|
19519
|
-
* @memberof
|
|
19846
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
19520
19847
|
*/
|
|
19521
19848
|
'customer': PosCustomerDto | null;
|
|
19522
19849
|
/**
|
|
19523
19850
|
*
|
|
19524
19851
|
* @type {Array<TransactionDto>}
|
|
19525
|
-
* @memberof
|
|
19852
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
19526
19853
|
*/
|
|
19527
19854
|
'paymentEvents': Array<TransactionDto>;
|
|
19528
19855
|
/**
|
|
19529
19856
|
*
|
|
19530
19857
|
* @type {Array<PaymentRefundDto>}
|
|
19531
|
-
* @memberof
|
|
19858
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
19532
19859
|
*/
|
|
19533
19860
|
'refunds'?: Array<PaymentRefundDto>;
|
|
19534
19861
|
/**
|
|
19535
19862
|
* Data version code
|
|
19536
19863
|
* @type {string}
|
|
19537
|
-
* @memberof
|
|
19864
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
19538
19865
|
*/
|
|
19539
19866
|
'version': string;
|
|
19540
19867
|
/**
|
|
19541
19868
|
*
|
|
19542
19869
|
* @type {OrderFormat}
|
|
19543
|
-
* @memberof
|
|
19870
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
19544
19871
|
*/
|
|
19545
19872
|
'orderFormat'?: OrderFormat;
|
|
19546
19873
|
/**
|
|
19547
19874
|
* The ID of the loyalty program active during this order.
|
|
19548
19875
|
* @type {string}
|
|
19549
|
-
* @memberof
|
|
19876
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
19550
19877
|
*/
|
|
19551
19878
|
'loyaltyProgramId': string | null;
|
|
19552
19879
|
/**
|
|
19553
19880
|
* An array of loyalty transaction IDs related to this order.
|
|
19554
19881
|
* @type {Array<string>}
|
|
19555
|
-
* @memberof
|
|
19882
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
19556
19883
|
*/
|
|
19557
19884
|
'loyaltyTransactionIds': Array<string>;
|
|
19558
19885
|
/**
|
|
19559
19886
|
*
|
|
19560
19887
|
* @type {PosOrderDtoTaxSummary}
|
|
19561
|
-
* @memberof
|
|
19888
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
19562
19889
|
*/
|
|
19563
19890
|
'taxSummary'?: PosOrderDtoTaxSummary;
|
|
19564
19891
|
/**
|
|
19565
19892
|
* Name of staff member who created the order
|
|
19566
19893
|
* @type {string}
|
|
19567
|
-
* @memberof
|
|
19894
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
19568
19895
|
*/
|
|
19569
19896
|
'staffName'?: string | null;
|
|
19570
19897
|
/**
|
|
19571
19898
|
*
|
|
19572
19899
|
* @type {PosOrderDtoInvoiceCompany}
|
|
19573
|
-
* @memberof
|
|
19900
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
19574
19901
|
*/
|
|
19575
19902
|
'invoiceCompany'?: PosOrderDtoInvoiceCompany | null;
|
|
19576
19903
|
/**
|
|
19577
19904
|
*
|
|
19578
19905
|
* @type {object}
|
|
19579
|
-
* @memberof
|
|
19906
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
19580
19907
|
*/
|
|
19581
19908
|
'lastPaymentError'?: object;
|
|
19582
19909
|
/**
|
|
19583
19910
|
*
|
|
19584
19911
|
* @type {Array<OrderFeeDto>}
|
|
19585
|
-
* @memberof
|
|
19912
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
19586
19913
|
*/
|
|
19587
19914
|
'fees'?: Array<OrderFeeDto> | null;
|
|
19588
19915
|
/**
|
|
19589
19916
|
* Loyalty user ID associated with this order
|
|
19590
19917
|
* @type {number}
|
|
19591
|
-
* @memberof
|
|
19918
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
19592
19919
|
*/
|
|
19593
19920
|
'targetUserId'?: number;
|
|
19594
19921
|
/**
|
|
19595
19922
|
* ID of the table group this order belongs to
|
|
19596
19923
|
* @type {string}
|
|
19597
|
-
* @memberof
|
|
19924
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
19598
19925
|
*/
|
|
19599
19926
|
'tableGroupId'?: string | null;
|
|
19600
19927
|
}
|
|
19601
19928
|
/**
|
|
19602
|
-
*
|
|
19929
|
+
*
|
|
19603
19930
|
* @export
|
|
19604
|
-
* @interface
|
|
19931
|
+
* @interface SyncKioskOrderResponseDto
|
|
19932
|
+
*/
|
|
19933
|
+
export interface SyncKioskOrderResponseDto {
|
|
19934
|
+
/**
|
|
19935
|
+
* Whether the order snapshot was persisted.
|
|
19936
|
+
* @type {boolean}
|
|
19937
|
+
* @memberof SyncKioskOrderResponseDto
|
|
19938
|
+
*/
|
|
19939
|
+
'synced': boolean;
|
|
19940
|
+
/**
|
|
19941
|
+
* Id of the synced order.
|
|
19942
|
+
* @type {string}
|
|
19943
|
+
* @memberof SyncKioskOrderResponseDto
|
|
19944
|
+
*/
|
|
19945
|
+
'orderId': string;
|
|
19946
|
+
}
|
|
19947
|
+
/**
|
|
19948
|
+
*
|
|
19949
|
+
* @export
|
|
19950
|
+
* @interface SyncPosOrderDto
|
|
19951
|
+
*/
|
|
19952
|
+
export interface SyncPosOrderDto {
|
|
19953
|
+
/**
|
|
19954
|
+
*
|
|
19955
|
+
* @type {SyncPosOrderDtoOrder}
|
|
19956
|
+
* @memberof SyncPosOrderDto
|
|
19957
|
+
*/
|
|
19958
|
+
'order': SyncPosOrderDtoOrder;
|
|
19959
|
+
/**
|
|
19960
|
+
*
|
|
19961
|
+
* @type {SyncPosOrderDtoWorkflow}
|
|
19962
|
+
* @memberof SyncPosOrderDto
|
|
19963
|
+
*/
|
|
19964
|
+
'workflow'?: SyncPosOrderDtoWorkflow;
|
|
19965
|
+
}
|
|
19966
|
+
/**
|
|
19967
|
+
* POS order snapshot to persist. paymentEvents are ignored (server-owned).
|
|
19968
|
+
* @export
|
|
19969
|
+
* @interface SyncPosOrderDtoOrder
|
|
19970
|
+
*/
|
|
19971
|
+
export interface SyncPosOrderDtoOrder {
|
|
19972
|
+
/**
|
|
19973
|
+
*
|
|
19974
|
+
* @type {string}
|
|
19975
|
+
* @memberof SyncPosOrderDtoOrder
|
|
19976
|
+
*/
|
|
19977
|
+
'id': string;
|
|
19978
|
+
/**
|
|
19979
|
+
*
|
|
19980
|
+
* @type {string}
|
|
19981
|
+
* @memberof SyncPosOrderDtoOrder
|
|
19982
|
+
*/
|
|
19983
|
+
'businessId': string;
|
|
19984
|
+
/**
|
|
19985
|
+
*
|
|
19986
|
+
* @type {ProviderEnum}
|
|
19987
|
+
* @memberof SyncPosOrderDtoOrder
|
|
19988
|
+
*/
|
|
19989
|
+
'provider': ProviderEnum;
|
|
19990
|
+
/**
|
|
19991
|
+
*
|
|
19992
|
+
* @type {CurrencyCode}
|
|
19993
|
+
* @memberof SyncPosOrderDtoOrder
|
|
19994
|
+
*/
|
|
19995
|
+
'currency': CurrencyCode;
|
|
19996
|
+
/**
|
|
19997
|
+
*
|
|
19998
|
+
* @type {PosBusinessDto}
|
|
19999
|
+
* @memberof SyncPosOrderDtoOrder
|
|
20000
|
+
*/
|
|
20001
|
+
'business': PosBusinessDto;
|
|
20002
|
+
/**
|
|
20003
|
+
*
|
|
20004
|
+
* @type {string}
|
|
20005
|
+
* @memberof SyncPosOrderDtoOrder
|
|
20006
|
+
*/
|
|
20007
|
+
'createdAt': string;
|
|
20008
|
+
/**
|
|
20009
|
+
*
|
|
20010
|
+
* @type {OrderStatusEnum}
|
|
20011
|
+
* @memberof SyncPosOrderDtoOrder
|
|
20012
|
+
*/
|
|
20013
|
+
'status': OrderStatusEnum;
|
|
20014
|
+
/**
|
|
20015
|
+
*
|
|
20016
|
+
* @type {string}
|
|
20017
|
+
* @memberof SyncPosOrderDtoOrder
|
|
20018
|
+
*/
|
|
20019
|
+
'updatedAt': string;
|
|
20020
|
+
/**
|
|
20021
|
+
*
|
|
20022
|
+
* @type {string}
|
|
20023
|
+
* @memberof SyncPosOrderDtoOrder
|
|
20024
|
+
*/
|
|
20025
|
+
'completedAt'?: string;
|
|
20026
|
+
/**
|
|
20027
|
+
*
|
|
20028
|
+
* @type {string}
|
|
20029
|
+
* @memberof SyncPosOrderDtoOrder
|
|
20030
|
+
*/
|
|
20031
|
+
'orderNumber': string;
|
|
20032
|
+
/**
|
|
20033
|
+
*
|
|
20034
|
+
* @type {CheckoutModelEnum}
|
|
20035
|
+
* @memberof SyncPosOrderDtoOrder
|
|
20036
|
+
*/
|
|
20037
|
+
'checkoutModel': CheckoutModelEnum;
|
|
20038
|
+
/**
|
|
20039
|
+
*
|
|
20040
|
+
* @type {OrderTypePOS}
|
|
20041
|
+
* @memberof SyncPosOrderDtoOrder
|
|
20042
|
+
*/
|
|
20043
|
+
'orderType': OrderTypePOS;
|
|
20044
|
+
/**
|
|
20045
|
+
*
|
|
20046
|
+
* @type {string}
|
|
20047
|
+
* @memberof SyncPosOrderDtoOrder
|
|
20048
|
+
*/
|
|
20049
|
+
'spotNumber': string | null;
|
|
20050
|
+
/**
|
|
20051
|
+
* ID of the floor plan dining table linked to this order
|
|
20052
|
+
* @type {string}
|
|
20053
|
+
* @memberof SyncPosOrderDtoOrder
|
|
20054
|
+
*/
|
|
20055
|
+
'tableId'?: string | null;
|
|
20056
|
+
/**
|
|
20057
|
+
*
|
|
20058
|
+
* @type {string}
|
|
20059
|
+
* @memberof SyncPosOrderDtoOrder
|
|
20060
|
+
*/
|
|
20061
|
+
'comments': string | null;
|
|
20062
|
+
/**
|
|
20063
|
+
*
|
|
20064
|
+
* @type {PosOrderDtoTableService}
|
|
20065
|
+
* @memberof SyncPosOrderDtoOrder
|
|
20066
|
+
*/
|
|
20067
|
+
'tableService'?: PosOrderDtoTableService | null;
|
|
20068
|
+
/**
|
|
20069
|
+
*
|
|
20070
|
+
* @type {PosOrderDtoEqualSplitState}
|
|
20071
|
+
* @memberof SyncPosOrderDtoOrder
|
|
20072
|
+
*/
|
|
20073
|
+
'equalSplitState'?: PosOrderDtoEqualSplitState | null;
|
|
20074
|
+
/**
|
|
20075
|
+
* Id of the staff in shift
|
|
20076
|
+
* @type {string}
|
|
20077
|
+
* @memberof SyncPosOrderDtoOrder
|
|
20078
|
+
*/
|
|
20079
|
+
'staffId': string | null;
|
|
20080
|
+
/**
|
|
20081
|
+
* Id of the shift
|
|
20082
|
+
* @type {string}
|
|
20083
|
+
* @memberof SyncPosOrderDtoOrder
|
|
20084
|
+
*/
|
|
20085
|
+
'shiftId': string | null;
|
|
20086
|
+
/**
|
|
20087
|
+
*
|
|
20088
|
+
* @type {OrderRefundStatus}
|
|
20089
|
+
* @memberof SyncPosOrderDtoOrder
|
|
20090
|
+
*/
|
|
20091
|
+
'orderRefundStatus': OrderRefundStatus;
|
|
20092
|
+
/**
|
|
20093
|
+
*
|
|
20094
|
+
* @type {LocatorType}
|
|
20095
|
+
* @memberof SyncPosOrderDtoOrder
|
|
20096
|
+
*/
|
|
20097
|
+
'locatorType': LocatorType;
|
|
20098
|
+
/**
|
|
20099
|
+
*
|
|
20100
|
+
* @type {PosOrderPriceDto}
|
|
20101
|
+
* @memberof SyncPosOrderDtoOrder
|
|
20102
|
+
*/
|
|
20103
|
+
'basketPrice': PosOrderPriceDto;
|
|
20104
|
+
/**
|
|
20105
|
+
*
|
|
20106
|
+
* @type {Array<PosOrderItemDto>}
|
|
20107
|
+
* @memberof SyncPosOrderDtoOrder
|
|
20108
|
+
*/
|
|
20109
|
+
'items': Array<PosOrderItemDto>;
|
|
20110
|
+
/**
|
|
20111
|
+
*
|
|
20112
|
+
* @type {Array<PosDiscountDto>}
|
|
20113
|
+
* @memberof SyncPosOrderDtoOrder
|
|
20114
|
+
*/
|
|
20115
|
+
'discounts': Array<PosDiscountDto>;
|
|
20116
|
+
/**
|
|
20117
|
+
*
|
|
20118
|
+
* @type {PosCustomerDto}
|
|
20119
|
+
* @memberof SyncPosOrderDtoOrder
|
|
20120
|
+
*/
|
|
20121
|
+
'customer': PosCustomerDto | null;
|
|
20122
|
+
/**
|
|
20123
|
+
*
|
|
20124
|
+
* @type {Array<TransactionDto>}
|
|
20125
|
+
* @memberof SyncPosOrderDtoOrder
|
|
20126
|
+
*/
|
|
20127
|
+
'paymentEvents': Array<TransactionDto>;
|
|
20128
|
+
/**
|
|
20129
|
+
*
|
|
20130
|
+
* @type {Array<PaymentRefundDto>}
|
|
20131
|
+
* @memberof SyncPosOrderDtoOrder
|
|
20132
|
+
*/
|
|
20133
|
+
'refunds'?: Array<PaymentRefundDto>;
|
|
20134
|
+
/**
|
|
20135
|
+
* Data version code
|
|
20136
|
+
* @type {string}
|
|
20137
|
+
* @memberof SyncPosOrderDtoOrder
|
|
20138
|
+
*/
|
|
20139
|
+
'version': string;
|
|
20140
|
+
/**
|
|
20141
|
+
*
|
|
20142
|
+
* @type {OrderFormat}
|
|
20143
|
+
* @memberof SyncPosOrderDtoOrder
|
|
20144
|
+
*/
|
|
20145
|
+
'orderFormat'?: OrderFormat;
|
|
20146
|
+
/**
|
|
20147
|
+
* The ID of the loyalty program active during this order.
|
|
20148
|
+
* @type {string}
|
|
20149
|
+
* @memberof SyncPosOrderDtoOrder
|
|
20150
|
+
*/
|
|
20151
|
+
'loyaltyProgramId': string | null;
|
|
20152
|
+
/**
|
|
20153
|
+
* An array of loyalty transaction IDs related to this order.
|
|
20154
|
+
* @type {Array<string>}
|
|
20155
|
+
* @memberof SyncPosOrderDtoOrder
|
|
20156
|
+
*/
|
|
20157
|
+
'loyaltyTransactionIds': Array<string>;
|
|
20158
|
+
/**
|
|
20159
|
+
*
|
|
20160
|
+
* @type {PosOrderDtoTaxSummary}
|
|
20161
|
+
* @memberof SyncPosOrderDtoOrder
|
|
20162
|
+
*/
|
|
20163
|
+
'taxSummary'?: PosOrderDtoTaxSummary;
|
|
20164
|
+
/**
|
|
20165
|
+
* Name of staff member who created the order
|
|
20166
|
+
* @type {string}
|
|
20167
|
+
* @memberof SyncPosOrderDtoOrder
|
|
20168
|
+
*/
|
|
20169
|
+
'staffName'?: string | null;
|
|
20170
|
+
/**
|
|
20171
|
+
*
|
|
20172
|
+
* @type {PosOrderDtoInvoiceCompany}
|
|
20173
|
+
* @memberof SyncPosOrderDtoOrder
|
|
20174
|
+
*/
|
|
20175
|
+
'invoiceCompany'?: PosOrderDtoInvoiceCompany | null;
|
|
20176
|
+
/**
|
|
20177
|
+
*
|
|
20178
|
+
* @type {object}
|
|
20179
|
+
* @memberof SyncPosOrderDtoOrder
|
|
20180
|
+
*/
|
|
20181
|
+
'lastPaymentError'?: object;
|
|
20182
|
+
/**
|
|
20183
|
+
*
|
|
20184
|
+
* @type {Array<OrderFeeDto>}
|
|
20185
|
+
* @memberof SyncPosOrderDtoOrder
|
|
20186
|
+
*/
|
|
20187
|
+
'fees'?: Array<OrderFeeDto> | null;
|
|
20188
|
+
/**
|
|
20189
|
+
* Loyalty user ID associated with this order
|
|
20190
|
+
* @type {number}
|
|
20191
|
+
* @memberof SyncPosOrderDtoOrder
|
|
20192
|
+
*/
|
|
20193
|
+
'targetUserId'?: number;
|
|
20194
|
+
/**
|
|
20195
|
+
* ID of the table group this order belongs to
|
|
20196
|
+
* @type {string}
|
|
20197
|
+
* @memberof SyncPosOrderDtoOrder
|
|
20198
|
+
*/
|
|
20199
|
+
'tableGroupId'?: string | null;
|
|
20200
|
+
}
|
|
20201
|
+
/**
|
|
20202
|
+
* POS order actions to run in the background after persist (same shape as /pos/actions). Omit to only sync the order.
|
|
20203
|
+
* @export
|
|
20204
|
+
* @interface SyncPosOrderDtoWorkflow
|
|
19605
20205
|
*/
|
|
19606
20206
|
export interface SyncPosOrderDtoWorkflow {
|
|
19607
20207
|
/**
|
|
@@ -27871,6 +28471,165 @@ export declare class CoursesApi extends BaseAPI implements CoursesApiInterface {
|
|
|
27871
28471
|
*/
|
|
27872
28472
|
getCourses(businessId: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CourseDto[], any, {}>>;
|
|
27873
28473
|
}
|
|
28474
|
+
/**
|
|
28475
|
+
* DisplayApi - axios parameter creator
|
|
28476
|
+
* @export
|
|
28477
|
+
*/
|
|
28478
|
+
export declare const DisplayApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
28479
|
+
/**
|
|
28480
|
+
*
|
|
28481
|
+
* @summary Register a customer display and mint a pairing token + code.
|
|
28482
|
+
* @param {DisplayInitBodyDto} [displayInitBodyDto]
|
|
28483
|
+
* @param {*} [options] Override http request option.
|
|
28484
|
+
* @throws {RequiredError}
|
|
28485
|
+
*/
|
|
28486
|
+
init: (displayInitBodyDto?: DisplayInitBodyDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
28487
|
+
/**
|
|
28488
|
+
*
|
|
28489
|
+
* @summary Pair a display with the POS using its code or QR nonce.
|
|
28490
|
+
* @param {PairDisplayBodyDto} pairDisplayBodyDto
|
|
28491
|
+
* @param {*} [options] Override http request option.
|
|
28492
|
+
* @throws {RequiredError}
|
|
28493
|
+
*/
|
|
28494
|
+
pair: (pairDisplayBodyDto: PairDisplayBodyDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
28495
|
+
/**
|
|
28496
|
+
*
|
|
28497
|
+
* @summary Mint a session-channel Ably token scoped to the device role.
|
|
28498
|
+
* @param {RequestSessionTokenBodyDto} requestSessionTokenBodyDto
|
|
28499
|
+
* @param {*} [options] Override http request option.
|
|
28500
|
+
* @throws {RequiredError}
|
|
28501
|
+
*/
|
|
28502
|
+
sessionToken: (requestSessionTokenBodyDto: RequestSessionTokenBodyDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
28503
|
+
};
|
|
28504
|
+
/**
|
|
28505
|
+
* DisplayApi - functional programming interface
|
|
28506
|
+
* @export
|
|
28507
|
+
*/
|
|
28508
|
+
export declare const DisplayApiFp: (configuration?: Configuration) => {
|
|
28509
|
+
/**
|
|
28510
|
+
*
|
|
28511
|
+
* @summary Register a customer display and mint a pairing token + code.
|
|
28512
|
+
* @param {DisplayInitBodyDto} [displayInitBodyDto]
|
|
28513
|
+
* @param {*} [options] Override http request option.
|
|
28514
|
+
* @throws {RequiredError}
|
|
28515
|
+
*/
|
|
28516
|
+
init(displayInitBodyDto?: DisplayInitBodyDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DisplayInitResponseDto>>;
|
|
28517
|
+
/**
|
|
28518
|
+
*
|
|
28519
|
+
* @summary Pair a display with the POS using its code or QR nonce.
|
|
28520
|
+
* @param {PairDisplayBodyDto} pairDisplayBodyDto
|
|
28521
|
+
* @param {*} [options] Override http request option.
|
|
28522
|
+
* @throws {RequiredError}
|
|
28523
|
+
*/
|
|
28524
|
+
pair(pairDisplayBodyDto: PairDisplayBodyDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PairDisplayResponseDto>>;
|
|
28525
|
+
/**
|
|
28526
|
+
*
|
|
28527
|
+
* @summary Mint a session-channel Ably token scoped to the device role.
|
|
28528
|
+
* @param {RequestSessionTokenBodyDto} requestSessionTokenBodyDto
|
|
28529
|
+
* @param {*} [options] Override http request option.
|
|
28530
|
+
* @throws {RequiredError}
|
|
28531
|
+
*/
|
|
28532
|
+
sessionToken(requestSessionTokenBodyDto: RequestSessionTokenBodyDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RequestSessionTokenResponseDto>>;
|
|
28533
|
+
};
|
|
28534
|
+
/**
|
|
28535
|
+
* DisplayApi - factory interface
|
|
28536
|
+
* @export
|
|
28537
|
+
*/
|
|
28538
|
+
export declare const DisplayApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
28539
|
+
/**
|
|
28540
|
+
*
|
|
28541
|
+
* @summary Register a customer display and mint a pairing token + code.
|
|
28542
|
+
* @param {DisplayInitBodyDto} [displayInitBodyDto]
|
|
28543
|
+
* @param {*} [options] Override http request option.
|
|
28544
|
+
* @throws {RequiredError}
|
|
28545
|
+
*/
|
|
28546
|
+
init(displayInitBodyDto?: DisplayInitBodyDto, options?: any): AxiosPromise<DisplayInitResponseDto>;
|
|
28547
|
+
/**
|
|
28548
|
+
*
|
|
28549
|
+
* @summary Pair a display with the POS using its code or QR nonce.
|
|
28550
|
+
* @param {PairDisplayBodyDto} pairDisplayBodyDto
|
|
28551
|
+
* @param {*} [options] Override http request option.
|
|
28552
|
+
* @throws {RequiredError}
|
|
28553
|
+
*/
|
|
28554
|
+
pair(pairDisplayBodyDto: PairDisplayBodyDto, options?: any): AxiosPromise<PairDisplayResponseDto>;
|
|
28555
|
+
/**
|
|
28556
|
+
*
|
|
28557
|
+
* @summary Mint a session-channel Ably token scoped to the device role.
|
|
28558
|
+
* @param {RequestSessionTokenBodyDto} requestSessionTokenBodyDto
|
|
28559
|
+
* @param {*} [options] Override http request option.
|
|
28560
|
+
* @throws {RequiredError}
|
|
28561
|
+
*/
|
|
28562
|
+
sessionToken(requestSessionTokenBodyDto: RequestSessionTokenBodyDto, options?: any): AxiosPromise<RequestSessionTokenResponseDto>;
|
|
28563
|
+
};
|
|
28564
|
+
/**
|
|
28565
|
+
* DisplayApi - interface
|
|
28566
|
+
* @export
|
|
28567
|
+
* @interface DisplayApi
|
|
28568
|
+
*/
|
|
28569
|
+
export interface DisplayApiInterface {
|
|
28570
|
+
/**
|
|
28571
|
+
*
|
|
28572
|
+
* @summary Register a customer display and mint a pairing token + code.
|
|
28573
|
+
* @param {DisplayInitBodyDto} [displayInitBodyDto]
|
|
28574
|
+
* @param {*} [options] Override http request option.
|
|
28575
|
+
* @throws {RequiredError}
|
|
28576
|
+
* @memberof DisplayApiInterface
|
|
28577
|
+
*/
|
|
28578
|
+
init(displayInitBodyDto?: DisplayInitBodyDto, options?: AxiosRequestConfig): AxiosPromise<DisplayInitResponseDto>;
|
|
28579
|
+
/**
|
|
28580
|
+
*
|
|
28581
|
+
* @summary Pair a display with the POS using its code or QR nonce.
|
|
28582
|
+
* @param {PairDisplayBodyDto} pairDisplayBodyDto
|
|
28583
|
+
* @param {*} [options] Override http request option.
|
|
28584
|
+
* @throws {RequiredError}
|
|
28585
|
+
* @memberof DisplayApiInterface
|
|
28586
|
+
*/
|
|
28587
|
+
pair(pairDisplayBodyDto: PairDisplayBodyDto, options?: AxiosRequestConfig): AxiosPromise<PairDisplayResponseDto>;
|
|
28588
|
+
/**
|
|
28589
|
+
*
|
|
28590
|
+
* @summary Mint a session-channel Ably token scoped to the device role.
|
|
28591
|
+
* @param {RequestSessionTokenBodyDto} requestSessionTokenBodyDto
|
|
28592
|
+
* @param {*} [options] Override http request option.
|
|
28593
|
+
* @throws {RequiredError}
|
|
28594
|
+
* @memberof DisplayApiInterface
|
|
28595
|
+
*/
|
|
28596
|
+
sessionToken(requestSessionTokenBodyDto: RequestSessionTokenBodyDto, options?: AxiosRequestConfig): AxiosPromise<RequestSessionTokenResponseDto>;
|
|
28597
|
+
}
|
|
28598
|
+
/**
|
|
28599
|
+
* DisplayApi - object-oriented interface
|
|
28600
|
+
* @export
|
|
28601
|
+
* @class DisplayApi
|
|
28602
|
+
* @extends {BaseAPI}
|
|
28603
|
+
*/
|
|
28604
|
+
export declare class DisplayApi extends BaseAPI implements DisplayApiInterface {
|
|
28605
|
+
/**
|
|
28606
|
+
*
|
|
28607
|
+
* @summary Register a customer display and mint a pairing token + code.
|
|
28608
|
+
* @param {DisplayInitBodyDto} [displayInitBodyDto]
|
|
28609
|
+
* @param {*} [options] Override http request option.
|
|
28610
|
+
* @throws {RequiredError}
|
|
28611
|
+
* @memberof DisplayApi
|
|
28612
|
+
*/
|
|
28613
|
+
init(displayInitBodyDto?: DisplayInitBodyDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DisplayInitResponseDto, any, {}>>;
|
|
28614
|
+
/**
|
|
28615
|
+
*
|
|
28616
|
+
* @summary Pair a display with the POS using its code or QR nonce.
|
|
28617
|
+
* @param {PairDisplayBodyDto} pairDisplayBodyDto
|
|
28618
|
+
* @param {*} [options] Override http request option.
|
|
28619
|
+
* @throws {RequiredError}
|
|
28620
|
+
* @memberof DisplayApi
|
|
28621
|
+
*/
|
|
28622
|
+
pair(pairDisplayBodyDto: PairDisplayBodyDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PairDisplayResponseDto, any, {}>>;
|
|
28623
|
+
/**
|
|
28624
|
+
*
|
|
28625
|
+
* @summary Mint a session-channel Ably token scoped to the device role.
|
|
28626
|
+
* @param {RequestSessionTokenBodyDto} requestSessionTokenBodyDto
|
|
28627
|
+
* @param {*} [options] Override http request option.
|
|
28628
|
+
* @throws {RequiredError}
|
|
28629
|
+
* @memberof DisplayApi
|
|
28630
|
+
*/
|
|
28631
|
+
sessionToken(requestSessionTokenBodyDto: RequestSessionTokenBodyDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RequestSessionTokenResponseDto, any, {}>>;
|
|
28632
|
+
}
|
|
27874
28633
|
/**
|
|
27875
28634
|
* EmployeesApi - axios parameter creator
|
|
27876
28635
|
* @export
|
|
@@ -29749,6 +30508,15 @@ export declare class KDSApi extends BaseAPI implements KDSApiInterface {
|
|
|
29749
30508
|
* @export
|
|
29750
30509
|
*/
|
|
29751
30510
|
export declare const KiosksApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
30511
|
+
/**
|
|
30512
|
+
* Fresh read of the persisted kiosk order (same PosOrderDto shape as POS): basketPrice, paymentEvents, targetUserId, etc. 404 when the order snapshot does not exist. Replaces the client\'s direct Firestore reads for the receipt screen and the recovery paid-status gate.
|
|
30513
|
+
* @summary Get the full kiosk order snapshot by id
|
|
30514
|
+
* @param {string} orderId The unique ID of the order.
|
|
30515
|
+
* @param {string} businessId The unique ID of the business.
|
|
30516
|
+
* @param {*} [options] Override http request option.
|
|
30517
|
+
* @throws {RequiredError}
|
|
30518
|
+
*/
|
|
30519
|
+
getKioskOrder: (orderId: string, businessId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
29752
30520
|
/**
|
|
29753
30521
|
*
|
|
29754
30522
|
* @param {string} orderId The unique ID of the order to validate against the system.
|
|
@@ -29765,6 +30533,14 @@ export declare const KiosksApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
29765
30533
|
* @throws {RequiredError}
|
|
29766
30534
|
*/
|
|
29767
30535
|
recoverOrder: (orderId: string, businessId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
30536
|
+
/**
|
|
30537
|
+
*
|
|
30538
|
+
* @summary Sync a kiosk order snapshot
|
|
30539
|
+
* @param {SyncKioskOrderDto} syncKioskOrderDto
|
|
30540
|
+
* @param {*} [options] Override http request option.
|
|
30541
|
+
* @throws {RequiredError}
|
|
30542
|
+
*/
|
|
30543
|
+
syncKioskOrder: (syncKioskOrderDto: SyncKioskOrderDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
29768
30544
|
/**
|
|
29769
30545
|
*
|
|
29770
30546
|
* @param {string} terminalId The unique ID of the terminal to validate against the system.
|
|
@@ -29779,6 +30555,15 @@ export declare const KiosksApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
29779
30555
|
* @export
|
|
29780
30556
|
*/
|
|
29781
30557
|
export declare const KiosksApiFp: (configuration?: Configuration) => {
|
|
30558
|
+
/**
|
|
30559
|
+
* Fresh read of the persisted kiosk order (same PosOrderDto shape as POS): basketPrice, paymentEvents, targetUserId, etc. 404 when the order snapshot does not exist. Replaces the client\'s direct Firestore reads for the receipt screen and the recovery paid-status gate.
|
|
30560
|
+
* @summary Get the full kiosk order snapshot by id
|
|
30561
|
+
* @param {string} orderId The unique ID of the order.
|
|
30562
|
+
* @param {string} businessId The unique ID of the business.
|
|
30563
|
+
* @param {*} [options] Override http request option.
|
|
30564
|
+
* @throws {RequiredError}
|
|
30565
|
+
*/
|
|
30566
|
+
getKioskOrder(orderId: string, businessId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PosOrderDto>>;
|
|
29782
30567
|
/**
|
|
29783
30568
|
*
|
|
29784
30569
|
* @param {string} orderId The unique ID of the order to validate against the system.
|
|
@@ -29795,6 +30580,14 @@ export declare const KiosksApiFp: (configuration?: Configuration) => {
|
|
|
29795
30580
|
* @throws {RequiredError}
|
|
29796
30581
|
*/
|
|
29797
30582
|
recoverOrder(orderId: string, businessId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
30583
|
+
/**
|
|
30584
|
+
*
|
|
30585
|
+
* @summary Sync a kiosk order snapshot
|
|
30586
|
+
* @param {SyncKioskOrderDto} syncKioskOrderDto
|
|
30587
|
+
* @param {*} [options] Override http request option.
|
|
30588
|
+
* @throws {RequiredError}
|
|
30589
|
+
*/
|
|
30590
|
+
syncKioskOrder(syncKioskOrderDto: SyncKioskOrderDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SyncKioskOrderResponseDto>>;
|
|
29798
30591
|
/**
|
|
29799
30592
|
*
|
|
29800
30593
|
* @param {string} terminalId The unique ID of the terminal to validate against the system.
|
|
@@ -29809,6 +30602,15 @@ export declare const KiosksApiFp: (configuration?: Configuration) => {
|
|
|
29809
30602
|
* @export
|
|
29810
30603
|
*/
|
|
29811
30604
|
export declare const KiosksApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
30605
|
+
/**
|
|
30606
|
+
* Fresh read of the persisted kiosk order (same PosOrderDto shape as POS): basketPrice, paymentEvents, targetUserId, etc. 404 when the order snapshot does not exist. Replaces the client\'s direct Firestore reads for the receipt screen and the recovery paid-status gate.
|
|
30607
|
+
* @summary Get the full kiosk order snapshot by id
|
|
30608
|
+
* @param {string} orderId The unique ID of the order.
|
|
30609
|
+
* @param {string} businessId The unique ID of the business.
|
|
30610
|
+
* @param {*} [options] Override http request option.
|
|
30611
|
+
* @throws {RequiredError}
|
|
30612
|
+
*/
|
|
30613
|
+
getKioskOrder(orderId: string, businessId: string, options?: any): AxiosPromise<PosOrderDto>;
|
|
29812
30614
|
/**
|
|
29813
30615
|
*
|
|
29814
30616
|
* @param {string} orderId The unique ID of the order to validate against the system.
|
|
@@ -29825,6 +30627,14 @@ export declare const KiosksApiFactory: (configuration?: Configuration, basePath?
|
|
|
29825
30627
|
* @throws {RequiredError}
|
|
29826
30628
|
*/
|
|
29827
30629
|
recoverOrder(orderId: string, businessId: string, options?: any): AxiosPromise<void>;
|
|
30630
|
+
/**
|
|
30631
|
+
*
|
|
30632
|
+
* @summary Sync a kiosk order snapshot
|
|
30633
|
+
* @param {SyncKioskOrderDto} syncKioskOrderDto
|
|
30634
|
+
* @param {*} [options] Override http request option.
|
|
30635
|
+
* @throws {RequiredError}
|
|
30636
|
+
*/
|
|
30637
|
+
syncKioskOrder(syncKioskOrderDto: SyncKioskOrderDto, options?: any): AxiosPromise<SyncKioskOrderResponseDto>;
|
|
29828
30638
|
/**
|
|
29829
30639
|
*
|
|
29830
30640
|
* @param {string} terminalId The unique ID of the terminal to validate against the system.
|
|
@@ -29840,6 +30650,16 @@ export declare const KiosksApiFactory: (configuration?: Configuration, basePath?
|
|
|
29840
30650
|
* @interface KiosksApi
|
|
29841
30651
|
*/
|
|
29842
30652
|
export interface KiosksApiInterface {
|
|
30653
|
+
/**
|
|
30654
|
+
* Fresh read of the persisted kiosk order (same PosOrderDto shape as POS): basketPrice, paymentEvents, targetUserId, etc. 404 when the order snapshot does not exist. Replaces the client\'s direct Firestore reads for the receipt screen and the recovery paid-status gate.
|
|
30655
|
+
* @summary Get the full kiosk order snapshot by id
|
|
30656
|
+
* @param {string} orderId The unique ID of the order.
|
|
30657
|
+
* @param {string} businessId The unique ID of the business.
|
|
30658
|
+
* @param {*} [options] Override http request option.
|
|
30659
|
+
* @throws {RequiredError}
|
|
30660
|
+
* @memberof KiosksApiInterface
|
|
30661
|
+
*/
|
|
30662
|
+
getKioskOrder(orderId: string, businessId: string, options?: AxiosRequestConfig): AxiosPromise<PosOrderDto>;
|
|
29843
30663
|
/**
|
|
29844
30664
|
*
|
|
29845
30665
|
* @param {string} orderId The unique ID of the order to validate against the system.
|
|
@@ -29858,6 +30678,15 @@ export interface KiosksApiInterface {
|
|
|
29858
30678
|
* @memberof KiosksApiInterface
|
|
29859
30679
|
*/
|
|
29860
30680
|
recoverOrder(orderId: string, businessId: string, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
30681
|
+
/**
|
|
30682
|
+
*
|
|
30683
|
+
* @summary Sync a kiosk order snapshot
|
|
30684
|
+
* @param {SyncKioskOrderDto} syncKioskOrderDto
|
|
30685
|
+
* @param {*} [options] Override http request option.
|
|
30686
|
+
* @throws {RequiredError}
|
|
30687
|
+
* @memberof KiosksApiInterface
|
|
30688
|
+
*/
|
|
30689
|
+
syncKioskOrder(syncKioskOrderDto: SyncKioskOrderDto, options?: AxiosRequestConfig): AxiosPromise<SyncKioskOrderResponseDto>;
|
|
29861
30690
|
/**
|
|
29862
30691
|
*
|
|
29863
30692
|
* @param {string} terminalId The unique ID of the terminal to validate against the system.
|
|
@@ -29875,6 +30704,16 @@ export interface KiosksApiInterface {
|
|
|
29875
30704
|
* @extends {BaseAPI}
|
|
29876
30705
|
*/
|
|
29877
30706
|
export declare class KiosksApi extends BaseAPI implements KiosksApiInterface {
|
|
30707
|
+
/**
|
|
30708
|
+
* Fresh read of the persisted kiosk order (same PosOrderDto shape as POS): basketPrice, paymentEvents, targetUserId, etc. 404 when the order snapshot does not exist. Replaces the client\'s direct Firestore reads for the receipt screen and the recovery paid-status gate.
|
|
30709
|
+
* @summary Get the full kiosk order snapshot by id
|
|
30710
|
+
* @param {string} orderId The unique ID of the order.
|
|
30711
|
+
* @param {string} businessId The unique ID of the business.
|
|
30712
|
+
* @param {*} [options] Override http request option.
|
|
30713
|
+
* @throws {RequiredError}
|
|
30714
|
+
* @memberof KiosksApi
|
|
30715
|
+
*/
|
|
30716
|
+
getKioskOrder(orderId: string, businessId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PosOrderDto, any, {}>>;
|
|
29878
30717
|
/**
|
|
29879
30718
|
*
|
|
29880
30719
|
* @param {string} orderId The unique ID of the order to validate against the system.
|
|
@@ -29893,6 +30732,15 @@ export declare class KiosksApi extends BaseAPI implements KiosksApiInterface {
|
|
|
29893
30732
|
* @memberof KiosksApi
|
|
29894
30733
|
*/
|
|
29895
30734
|
recoverOrder(orderId: string, businessId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
30735
|
+
/**
|
|
30736
|
+
*
|
|
30737
|
+
* @summary Sync a kiosk order snapshot
|
|
30738
|
+
* @param {SyncKioskOrderDto} syncKioskOrderDto
|
|
30739
|
+
* @param {*} [options] Override http request option.
|
|
30740
|
+
* @throws {RequiredError}
|
|
30741
|
+
* @memberof KiosksApi
|
|
30742
|
+
*/
|
|
30743
|
+
syncKioskOrder(syncKioskOrderDto: SyncKioskOrderDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SyncKioskOrderResponseDto, any, {}>>;
|
|
29896
30744
|
/**
|
|
29897
30745
|
*
|
|
29898
30746
|
* @param {string} terminalId The unique ID of the terminal to validate against the system.
|
|
@@ -33133,6 +33981,16 @@ export declare const PaymentSessionApiAxiosParamCreator: (configuration?: Config
|
|
|
33133
33981
|
* @throws {RequiredError}
|
|
33134
33982
|
*/
|
|
33135
33983
|
cancelSession: (clientToken: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
33984
|
+
/**
|
|
33985
|
+
* Unified paid-status check for both POS and kiosk. Reads the order from the channel-appropriate collection (via the x-app-x channel header) and derives the settlement from its persisted paymentEvents — the same events reconciliation writes for every provider (Viva/Nets/Worldline, card or manual). The FE polls this after a payment and stops when isFullyPaid is true. Send an empty body for the plain check, or optional { cashChange, cartTotalAmount } overrides. Always 200: `settlement` is null while the order snapshot does not yet exist / cannot be computed (treat as pending).
|
|
33986
|
+
* @summary Get an order\'s paid/reconcile status (POS or kiosk)
|
|
33987
|
+
* @param {number} businessId The internal business ID.
|
|
33988
|
+
* @param {string} orderId The order ID.
|
|
33989
|
+
* @param {OrderSettlementStatusRequestDto} [orderSettlementStatusRequestDto]
|
|
33990
|
+
* @param {*} [options] Override http request option.
|
|
33991
|
+
* @throws {RequiredError}
|
|
33992
|
+
*/
|
|
33993
|
+
getOrderSettlementStatus: (businessId: number, orderId: string, orderSettlementStatusRequestDto?: OrderSettlementStatusRequestDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
33136
33994
|
/**
|
|
33137
33995
|
* Reads PaymentSession from Postgres. Use this to poll session lifecycle without hitting the Viva API.
|
|
33138
33996
|
* @summary Get payment session status by clientToken
|
|
@@ -33270,6 +34128,16 @@ export declare const PaymentSessionApiFp: (configuration?: Configuration) => {
|
|
|
33270
34128
|
* @throws {RequiredError}
|
|
33271
34129
|
*/
|
|
33272
34130
|
cancelSession(clientToken: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentSessionViewDto>>;
|
|
34131
|
+
/**
|
|
34132
|
+
* Unified paid-status check for both POS and kiosk. Reads the order from the channel-appropriate collection (via the x-app-x channel header) and derives the settlement from its persisted paymentEvents — the same events reconciliation writes for every provider (Viva/Nets/Worldline, card or manual). The FE polls this after a payment and stops when isFullyPaid is true. Send an empty body for the plain check, or optional { cashChange, cartTotalAmount } overrides. Always 200: `settlement` is null while the order snapshot does not yet exist / cannot be computed (treat as pending).
|
|
34133
|
+
* @summary Get an order\'s paid/reconcile status (POS or kiosk)
|
|
34134
|
+
* @param {number} businessId The internal business ID.
|
|
34135
|
+
* @param {string} orderId The order ID.
|
|
34136
|
+
* @param {OrderSettlementStatusRequestDto} [orderSettlementStatusRequestDto]
|
|
34137
|
+
* @param {*} [options] Override http request option.
|
|
34138
|
+
* @throws {RequiredError}
|
|
34139
|
+
*/
|
|
34140
|
+
getOrderSettlementStatus(businessId: number, orderId: string, orderSettlementStatusRequestDto?: OrderSettlementStatusRequestDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrderSettlementStatusResponseDto>>;
|
|
33273
34141
|
/**
|
|
33274
34142
|
* Reads PaymentSession from Postgres. Use this to poll session lifecycle without hitting the Viva API.
|
|
33275
34143
|
* @summary Get payment session status by clientToken
|
|
@@ -33407,6 +34275,16 @@ export declare const PaymentSessionApiFactory: (configuration?: Configuration, b
|
|
|
33407
34275
|
* @throws {RequiredError}
|
|
33408
34276
|
*/
|
|
33409
34277
|
cancelSession(clientToken: string, options?: any): AxiosPromise<PaymentSessionViewDto>;
|
|
34278
|
+
/**
|
|
34279
|
+
* Unified paid-status check for both POS and kiosk. Reads the order from the channel-appropriate collection (via the x-app-x channel header) and derives the settlement from its persisted paymentEvents — the same events reconciliation writes for every provider (Viva/Nets/Worldline, card or manual). The FE polls this after a payment and stops when isFullyPaid is true. Send an empty body for the plain check, or optional { cashChange, cartTotalAmount } overrides. Always 200: `settlement` is null while the order snapshot does not yet exist / cannot be computed (treat as pending).
|
|
34280
|
+
* @summary Get an order\'s paid/reconcile status (POS or kiosk)
|
|
34281
|
+
* @param {number} businessId The internal business ID.
|
|
34282
|
+
* @param {string} orderId The order ID.
|
|
34283
|
+
* @param {OrderSettlementStatusRequestDto} [orderSettlementStatusRequestDto]
|
|
34284
|
+
* @param {*} [options] Override http request option.
|
|
34285
|
+
* @throws {RequiredError}
|
|
34286
|
+
*/
|
|
34287
|
+
getOrderSettlementStatus(businessId: number, orderId: string, orderSettlementStatusRequestDto?: OrderSettlementStatusRequestDto, options?: any): AxiosPromise<OrderSettlementStatusResponseDto>;
|
|
33410
34288
|
/**
|
|
33411
34289
|
* Reads PaymentSession from Postgres. Use this to poll session lifecycle without hitting the Viva API.
|
|
33412
34290
|
* @summary Get payment session status by clientToken
|
|
@@ -33546,6 +34424,17 @@ export interface PaymentSessionApiInterface {
|
|
|
33546
34424
|
* @memberof PaymentSessionApiInterface
|
|
33547
34425
|
*/
|
|
33548
34426
|
cancelSession(clientToken: string, options?: AxiosRequestConfig): AxiosPromise<PaymentSessionViewDto>;
|
|
34427
|
+
/**
|
|
34428
|
+
* Unified paid-status check for both POS and kiosk. Reads the order from the channel-appropriate collection (via the x-app-x channel header) and derives the settlement from its persisted paymentEvents — the same events reconciliation writes for every provider (Viva/Nets/Worldline, card or manual). The FE polls this after a payment and stops when isFullyPaid is true. Send an empty body for the plain check, or optional { cashChange, cartTotalAmount } overrides. Always 200: `settlement` is null while the order snapshot does not yet exist / cannot be computed (treat as pending).
|
|
34429
|
+
* @summary Get an order\'s paid/reconcile status (POS or kiosk)
|
|
34430
|
+
* @param {number} businessId The internal business ID.
|
|
34431
|
+
* @param {string} orderId The order ID.
|
|
34432
|
+
* @param {OrderSettlementStatusRequestDto} [orderSettlementStatusRequestDto]
|
|
34433
|
+
* @param {*} [options] Override http request option.
|
|
34434
|
+
* @throws {RequiredError}
|
|
34435
|
+
* @memberof PaymentSessionApiInterface
|
|
34436
|
+
*/
|
|
34437
|
+
getOrderSettlementStatus(businessId: number, orderId: string, orderSettlementStatusRequestDto?: OrderSettlementStatusRequestDto, options?: AxiosRequestConfig): AxiosPromise<OrderSettlementStatusResponseDto>;
|
|
33549
34438
|
/**
|
|
33550
34439
|
* Reads PaymentSession from Postgres. Use this to poll session lifecycle without hitting the Viva API.
|
|
33551
34440
|
* @summary Get payment session status by clientToken
|
|
@@ -33701,6 +34590,17 @@ export declare class PaymentSessionApi extends BaseAPI implements PaymentSession
|
|
|
33701
34590
|
* @memberof PaymentSessionApi
|
|
33702
34591
|
*/
|
|
33703
34592
|
cancelSession(clientToken: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PaymentSessionViewDto, any, {}>>;
|
|
34593
|
+
/**
|
|
34594
|
+
* Unified paid-status check for both POS and kiosk. Reads the order from the channel-appropriate collection (via the x-app-x channel header) and derives the settlement from its persisted paymentEvents — the same events reconciliation writes for every provider (Viva/Nets/Worldline, card or manual). The FE polls this after a payment and stops when isFullyPaid is true. Send an empty body for the plain check, or optional { cashChange, cartTotalAmount } overrides. Always 200: `settlement` is null while the order snapshot does not yet exist / cannot be computed (treat as pending).
|
|
34595
|
+
* @summary Get an order\'s paid/reconcile status (POS or kiosk)
|
|
34596
|
+
* @param {number} businessId The internal business ID.
|
|
34597
|
+
* @param {string} orderId The order ID.
|
|
34598
|
+
* @param {OrderSettlementStatusRequestDto} [orderSettlementStatusRequestDto]
|
|
34599
|
+
* @param {*} [options] Override http request option.
|
|
34600
|
+
* @throws {RequiredError}
|
|
34601
|
+
* @memberof PaymentSessionApi
|
|
34602
|
+
*/
|
|
34603
|
+
getOrderSettlementStatus(businessId: number, orderId: string, orderSettlementStatusRequestDto?: OrderSettlementStatusRequestDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderSettlementStatusResponseDto, any, {}>>;
|
|
33704
34604
|
/**
|
|
33705
34605
|
* Reads PaymentSession from Postgres. Use this to poll session lifecycle without hitting the Viva API.
|
|
33706
34606
|
* @summary Get payment session status by clientToken
|