@munchi_oy/core 1.9.75 → 1.9.76
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 +574 -0
- 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 +692 -0
- package/package.json +1 -1
- package/src/version.ts +1 -1
package/dist/generated/api.d.ts
CHANGED
|
@@ -11330,6 +11330,172 @@ export interface OrderResponseDtoPriceSummary {
|
|
|
11330
11330
|
*/
|
|
11331
11331
|
'totalNet': number;
|
|
11332
11332
|
}
|
|
11333
|
+
/**
|
|
11334
|
+
*
|
|
11335
|
+
* @export
|
|
11336
|
+
* @interface OrderSettlementStatusDto
|
|
11337
|
+
*/
|
|
11338
|
+
export interface OrderSettlementStatusDto {
|
|
11339
|
+
/**
|
|
11340
|
+
* The internal business ID.
|
|
11341
|
+
* @type {number}
|
|
11342
|
+
* @memberof OrderSettlementStatusDto
|
|
11343
|
+
*/
|
|
11344
|
+
'businessId': number;
|
|
11345
|
+
/**
|
|
11346
|
+
* The order ID the settlement is computed for.
|
|
11347
|
+
* @type {string}
|
|
11348
|
+
* @memberof OrderSettlementStatusDto
|
|
11349
|
+
*/
|
|
11350
|
+
'orderId': string;
|
|
11351
|
+
/**
|
|
11352
|
+
* The order\'s checkout model (FULL / EQUAL_SPLIT / ITEM_SPLIT).
|
|
11353
|
+
* @type {string}
|
|
11354
|
+
* @memberof OrderSettlementStatusDto
|
|
11355
|
+
*/
|
|
11356
|
+
'checkoutModel': string;
|
|
11357
|
+
/**
|
|
11358
|
+
* Overall settlement status: \'underpaid\' | \'settled\' | \'overpaid\'.
|
|
11359
|
+
* @type {string}
|
|
11360
|
+
* @memberof OrderSettlementStatusDto
|
|
11361
|
+
*/
|
|
11362
|
+
'status': string;
|
|
11363
|
+
/**
|
|
11364
|
+
* True once the order is fully paid (settled or overpaid). The FE\'s stop condition.
|
|
11365
|
+
* @type {boolean}
|
|
11366
|
+
* @memberof OrderSettlementStatusDto
|
|
11367
|
+
*/
|
|
11368
|
+
'isFullyPaid': boolean;
|
|
11369
|
+
/**
|
|
11370
|
+
* Order total in the smallest currency unit (cents).
|
|
11371
|
+
* @type {number}
|
|
11372
|
+
* @memberof OrderSettlementStatusDto
|
|
11373
|
+
*/
|
|
11374
|
+
'cartTotal': number;
|
|
11375
|
+
/**
|
|
11376
|
+
* Sum of settled payments in cents.
|
|
11377
|
+
* @type {number}
|
|
11378
|
+
* @memberof OrderSettlementStatusDto
|
|
11379
|
+
*/
|
|
11380
|
+
'paidAmount': number;
|
|
11381
|
+
/**
|
|
11382
|
+
* Outstanding balance in cents (0 when settled/overpaid).
|
|
11383
|
+
* @type {number}
|
|
11384
|
+
* @memberof OrderSettlementStatusDto
|
|
11385
|
+
*/
|
|
11386
|
+
'remainingAmount': number;
|
|
11387
|
+
/**
|
|
11388
|
+
* Amount still payable in cents (never negative).
|
|
11389
|
+
* @type {number}
|
|
11390
|
+
* @memberof OrderSettlementStatusDto
|
|
11391
|
+
*/
|
|
11392
|
+
'amountLeftToPay': number;
|
|
11393
|
+
/**
|
|
11394
|
+
* Number of paymentEvents currently on the order.
|
|
11395
|
+
* @type {number}
|
|
11396
|
+
* @memberof OrderSettlementStatusDto
|
|
11397
|
+
*/
|
|
11398
|
+
'paymentEventCount': number;
|
|
11399
|
+
}
|
|
11400
|
+
/**
|
|
11401
|
+
*
|
|
11402
|
+
* @export
|
|
11403
|
+
* @interface OrderSettlementStatusRequestDto
|
|
11404
|
+
*/
|
|
11405
|
+
export interface OrderSettlementStatusRequestDto {
|
|
11406
|
+
/**
|
|
11407
|
+
* 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.
|
|
11408
|
+
* @type {number}
|
|
11409
|
+
* @memberof OrderSettlementStatusRequestDto
|
|
11410
|
+
*/
|
|
11411
|
+
'cashChange'?: number;
|
|
11412
|
+
/**
|
|
11413
|
+
* 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).
|
|
11414
|
+
* @type {number}
|
|
11415
|
+
* @memberof OrderSettlementStatusRequestDto
|
|
11416
|
+
*/
|
|
11417
|
+
'cartTotalAmount'?: number;
|
|
11418
|
+
}
|
|
11419
|
+
/**
|
|
11420
|
+
*
|
|
11421
|
+
* @export
|
|
11422
|
+
* @interface OrderSettlementStatusResponseDto
|
|
11423
|
+
*/
|
|
11424
|
+
export interface OrderSettlementStatusResponseDto {
|
|
11425
|
+
/**
|
|
11426
|
+
*
|
|
11427
|
+
* @type {OrderSettlementStatusResponseDtoSettlement}
|
|
11428
|
+
* @memberof OrderSettlementStatusResponseDto
|
|
11429
|
+
*/
|
|
11430
|
+
'settlement': OrderSettlementStatusResponseDtoSettlement | null;
|
|
11431
|
+
}
|
|
11432
|
+
/**
|
|
11433
|
+
* The settlement status, or null when the order is unavailable / not computable.
|
|
11434
|
+
* @export
|
|
11435
|
+
* @interface OrderSettlementStatusResponseDtoSettlement
|
|
11436
|
+
*/
|
|
11437
|
+
export interface OrderSettlementStatusResponseDtoSettlement {
|
|
11438
|
+
/**
|
|
11439
|
+
* The internal business ID.
|
|
11440
|
+
* @type {number}
|
|
11441
|
+
* @memberof OrderSettlementStatusResponseDtoSettlement
|
|
11442
|
+
*/
|
|
11443
|
+
'businessId': number;
|
|
11444
|
+
/**
|
|
11445
|
+
* The order ID the settlement is computed for.
|
|
11446
|
+
* @type {string}
|
|
11447
|
+
* @memberof OrderSettlementStatusResponseDtoSettlement
|
|
11448
|
+
*/
|
|
11449
|
+
'orderId': string;
|
|
11450
|
+
/**
|
|
11451
|
+
* The order\'s checkout model (FULL / EQUAL_SPLIT / ITEM_SPLIT).
|
|
11452
|
+
* @type {string}
|
|
11453
|
+
* @memberof OrderSettlementStatusResponseDtoSettlement
|
|
11454
|
+
*/
|
|
11455
|
+
'checkoutModel': string;
|
|
11456
|
+
/**
|
|
11457
|
+
* Overall settlement status: \'underpaid\' | \'settled\' | \'overpaid\'.
|
|
11458
|
+
* @type {string}
|
|
11459
|
+
* @memberof OrderSettlementStatusResponseDtoSettlement
|
|
11460
|
+
*/
|
|
11461
|
+
'status': string;
|
|
11462
|
+
/**
|
|
11463
|
+
* True once the order is fully paid (settled or overpaid). The FE\'s stop condition.
|
|
11464
|
+
* @type {boolean}
|
|
11465
|
+
* @memberof OrderSettlementStatusResponseDtoSettlement
|
|
11466
|
+
*/
|
|
11467
|
+
'isFullyPaid': boolean;
|
|
11468
|
+
/**
|
|
11469
|
+
* Order total in the smallest currency unit (cents).
|
|
11470
|
+
* @type {number}
|
|
11471
|
+
* @memberof OrderSettlementStatusResponseDtoSettlement
|
|
11472
|
+
*/
|
|
11473
|
+
'cartTotal': number;
|
|
11474
|
+
/**
|
|
11475
|
+
* Sum of settled payments in cents.
|
|
11476
|
+
* @type {number}
|
|
11477
|
+
* @memberof OrderSettlementStatusResponseDtoSettlement
|
|
11478
|
+
*/
|
|
11479
|
+
'paidAmount': number;
|
|
11480
|
+
/**
|
|
11481
|
+
* Outstanding balance in cents (0 when settled/overpaid).
|
|
11482
|
+
* @type {number}
|
|
11483
|
+
* @memberof OrderSettlementStatusResponseDtoSettlement
|
|
11484
|
+
*/
|
|
11485
|
+
'remainingAmount': number;
|
|
11486
|
+
/**
|
|
11487
|
+
* Amount still payable in cents (never negative).
|
|
11488
|
+
* @type {number}
|
|
11489
|
+
* @memberof OrderSettlementStatusResponseDtoSettlement
|
|
11490
|
+
*/
|
|
11491
|
+
'amountLeftToPay': number;
|
|
11492
|
+
/**
|
|
11493
|
+
* Number of paymentEvents currently on the order.
|
|
11494
|
+
* @type {number}
|
|
11495
|
+
* @memberof OrderSettlementStatusResponseDtoSettlement
|
|
11496
|
+
*/
|
|
11497
|
+
'paymentEventCount': number;
|
|
11498
|
+
}
|
|
11333
11499
|
/**
|
|
11334
11500
|
*
|
|
11335
11501
|
* @export
|
|
@@ -19344,6 +19510,273 @@ export interface SupportedChannelDto {
|
|
|
19344
19510
|
*/
|
|
19345
19511
|
'label': string;
|
|
19346
19512
|
}
|
|
19513
|
+
/**
|
|
19514
|
+
*
|
|
19515
|
+
* @export
|
|
19516
|
+
* @interface SyncKioskOrderDto
|
|
19517
|
+
*/
|
|
19518
|
+
export interface SyncKioskOrderDto {
|
|
19519
|
+
/**
|
|
19520
|
+
*
|
|
19521
|
+
* @type {SyncKioskOrderDtoOrder}
|
|
19522
|
+
* @memberof SyncKioskOrderDto
|
|
19523
|
+
*/
|
|
19524
|
+
'order': SyncKioskOrderDtoOrder;
|
|
19525
|
+
}
|
|
19526
|
+
/**
|
|
19527
|
+
* Kiosk order snapshot to persist (same shape as PosOrderDto). Transitional: paymentEvents are still client-owned and persisted as sent.
|
|
19528
|
+
* @export
|
|
19529
|
+
* @interface SyncKioskOrderDtoOrder
|
|
19530
|
+
*/
|
|
19531
|
+
export interface SyncKioskOrderDtoOrder {
|
|
19532
|
+
/**
|
|
19533
|
+
*
|
|
19534
|
+
* @type {string}
|
|
19535
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
19536
|
+
*/
|
|
19537
|
+
'id': string;
|
|
19538
|
+
/**
|
|
19539
|
+
*
|
|
19540
|
+
* @type {string}
|
|
19541
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
19542
|
+
*/
|
|
19543
|
+
'businessId': string;
|
|
19544
|
+
/**
|
|
19545
|
+
*
|
|
19546
|
+
* @type {ProviderEnum}
|
|
19547
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
19548
|
+
*/
|
|
19549
|
+
'provider': ProviderEnum;
|
|
19550
|
+
/**
|
|
19551
|
+
*
|
|
19552
|
+
* @type {CurrencyCode}
|
|
19553
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
19554
|
+
*/
|
|
19555
|
+
'currency': CurrencyCode;
|
|
19556
|
+
/**
|
|
19557
|
+
*
|
|
19558
|
+
* @type {PosBusinessDto}
|
|
19559
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
19560
|
+
*/
|
|
19561
|
+
'business': PosBusinessDto;
|
|
19562
|
+
/**
|
|
19563
|
+
*
|
|
19564
|
+
* @type {string}
|
|
19565
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
19566
|
+
*/
|
|
19567
|
+
'createdAt': string;
|
|
19568
|
+
/**
|
|
19569
|
+
*
|
|
19570
|
+
* @type {OrderStatusEnum}
|
|
19571
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
19572
|
+
*/
|
|
19573
|
+
'status': OrderStatusEnum;
|
|
19574
|
+
/**
|
|
19575
|
+
*
|
|
19576
|
+
* @type {string}
|
|
19577
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
19578
|
+
*/
|
|
19579
|
+
'updatedAt': string;
|
|
19580
|
+
/**
|
|
19581
|
+
*
|
|
19582
|
+
* @type {string}
|
|
19583
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
19584
|
+
*/
|
|
19585
|
+
'completedAt'?: string;
|
|
19586
|
+
/**
|
|
19587
|
+
*
|
|
19588
|
+
* @type {string}
|
|
19589
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
19590
|
+
*/
|
|
19591
|
+
'orderNumber': string;
|
|
19592
|
+
/**
|
|
19593
|
+
*
|
|
19594
|
+
* @type {CheckoutModelEnum}
|
|
19595
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
19596
|
+
*/
|
|
19597
|
+
'checkoutModel': CheckoutModelEnum;
|
|
19598
|
+
/**
|
|
19599
|
+
*
|
|
19600
|
+
* @type {OrderTypePOS}
|
|
19601
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
19602
|
+
*/
|
|
19603
|
+
'orderType': OrderTypePOS;
|
|
19604
|
+
/**
|
|
19605
|
+
*
|
|
19606
|
+
* @type {string}
|
|
19607
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
19608
|
+
*/
|
|
19609
|
+
'spotNumber': string | null;
|
|
19610
|
+
/**
|
|
19611
|
+
* ID of the floor plan dining table linked to this order
|
|
19612
|
+
* @type {string}
|
|
19613
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
19614
|
+
*/
|
|
19615
|
+
'tableId'?: string | null;
|
|
19616
|
+
/**
|
|
19617
|
+
*
|
|
19618
|
+
* @type {string}
|
|
19619
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
19620
|
+
*/
|
|
19621
|
+
'comments': string | null;
|
|
19622
|
+
/**
|
|
19623
|
+
*
|
|
19624
|
+
* @type {PosOrderDtoTableService}
|
|
19625
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
19626
|
+
*/
|
|
19627
|
+
'tableService'?: PosOrderDtoTableService | null;
|
|
19628
|
+
/**
|
|
19629
|
+
*
|
|
19630
|
+
* @type {PosOrderDtoEqualSplitState}
|
|
19631
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
19632
|
+
*/
|
|
19633
|
+
'equalSplitState'?: PosOrderDtoEqualSplitState | null;
|
|
19634
|
+
/**
|
|
19635
|
+
* Id of the staff in shift
|
|
19636
|
+
* @type {string}
|
|
19637
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
19638
|
+
*/
|
|
19639
|
+
'staffId': string | null;
|
|
19640
|
+
/**
|
|
19641
|
+
* Id of the shift
|
|
19642
|
+
* @type {string}
|
|
19643
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
19644
|
+
*/
|
|
19645
|
+
'shiftId': string | null;
|
|
19646
|
+
/**
|
|
19647
|
+
*
|
|
19648
|
+
* @type {OrderRefundStatus}
|
|
19649
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
19650
|
+
*/
|
|
19651
|
+
'orderRefundStatus': OrderRefundStatus;
|
|
19652
|
+
/**
|
|
19653
|
+
*
|
|
19654
|
+
* @type {LocatorType}
|
|
19655
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
19656
|
+
*/
|
|
19657
|
+
'locatorType': LocatorType;
|
|
19658
|
+
/**
|
|
19659
|
+
*
|
|
19660
|
+
* @type {PosOrderPriceDto}
|
|
19661
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
19662
|
+
*/
|
|
19663
|
+
'basketPrice': PosOrderPriceDto;
|
|
19664
|
+
/**
|
|
19665
|
+
*
|
|
19666
|
+
* @type {Array<PosOrderItemDto>}
|
|
19667
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
19668
|
+
*/
|
|
19669
|
+
'items': Array<PosOrderItemDto>;
|
|
19670
|
+
/**
|
|
19671
|
+
*
|
|
19672
|
+
* @type {Array<PosDiscountDto>}
|
|
19673
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
19674
|
+
*/
|
|
19675
|
+
'discounts': Array<PosDiscountDto>;
|
|
19676
|
+
/**
|
|
19677
|
+
*
|
|
19678
|
+
* @type {PosCustomerDto}
|
|
19679
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
19680
|
+
*/
|
|
19681
|
+
'customer': PosCustomerDto | null;
|
|
19682
|
+
/**
|
|
19683
|
+
*
|
|
19684
|
+
* @type {Array<TransactionDto>}
|
|
19685
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
19686
|
+
*/
|
|
19687
|
+
'paymentEvents': Array<TransactionDto>;
|
|
19688
|
+
/**
|
|
19689
|
+
*
|
|
19690
|
+
* @type {Array<PaymentRefundDto>}
|
|
19691
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
19692
|
+
*/
|
|
19693
|
+
'refunds'?: Array<PaymentRefundDto>;
|
|
19694
|
+
/**
|
|
19695
|
+
* Data version code
|
|
19696
|
+
* @type {string}
|
|
19697
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
19698
|
+
*/
|
|
19699
|
+
'version': string;
|
|
19700
|
+
/**
|
|
19701
|
+
*
|
|
19702
|
+
* @type {OrderFormat}
|
|
19703
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
19704
|
+
*/
|
|
19705
|
+
'orderFormat'?: OrderFormat;
|
|
19706
|
+
/**
|
|
19707
|
+
* The ID of the loyalty program active during this order.
|
|
19708
|
+
* @type {string}
|
|
19709
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
19710
|
+
*/
|
|
19711
|
+
'loyaltyProgramId': string | null;
|
|
19712
|
+
/**
|
|
19713
|
+
* An array of loyalty transaction IDs related to this order.
|
|
19714
|
+
* @type {Array<string>}
|
|
19715
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
19716
|
+
*/
|
|
19717
|
+
'loyaltyTransactionIds': Array<string>;
|
|
19718
|
+
/**
|
|
19719
|
+
*
|
|
19720
|
+
* @type {PosOrderDtoTaxSummary}
|
|
19721
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
19722
|
+
*/
|
|
19723
|
+
'taxSummary'?: PosOrderDtoTaxSummary;
|
|
19724
|
+
/**
|
|
19725
|
+
* Name of staff member who created the order
|
|
19726
|
+
* @type {string}
|
|
19727
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
19728
|
+
*/
|
|
19729
|
+
'staffName'?: string | null;
|
|
19730
|
+
/**
|
|
19731
|
+
*
|
|
19732
|
+
* @type {PosOrderDtoInvoiceCompany}
|
|
19733
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
19734
|
+
*/
|
|
19735
|
+
'invoiceCompany'?: PosOrderDtoInvoiceCompany | null;
|
|
19736
|
+
/**
|
|
19737
|
+
*
|
|
19738
|
+
* @type {object}
|
|
19739
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
19740
|
+
*/
|
|
19741
|
+
'lastPaymentError'?: object;
|
|
19742
|
+
/**
|
|
19743
|
+
*
|
|
19744
|
+
* @type {Array<OrderFeeDto>}
|
|
19745
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
19746
|
+
*/
|
|
19747
|
+
'fees'?: Array<OrderFeeDto> | null;
|
|
19748
|
+
/**
|
|
19749
|
+
* Loyalty user ID associated with this order
|
|
19750
|
+
* @type {number}
|
|
19751
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
19752
|
+
*/
|
|
19753
|
+
'targetUserId'?: number;
|
|
19754
|
+
/**
|
|
19755
|
+
* ID of the table group this order belongs to
|
|
19756
|
+
* @type {string}
|
|
19757
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
19758
|
+
*/
|
|
19759
|
+
'tableGroupId'?: string | null;
|
|
19760
|
+
}
|
|
19761
|
+
/**
|
|
19762
|
+
*
|
|
19763
|
+
* @export
|
|
19764
|
+
* @interface SyncKioskOrderResponseDto
|
|
19765
|
+
*/
|
|
19766
|
+
export interface SyncKioskOrderResponseDto {
|
|
19767
|
+
/**
|
|
19768
|
+
* Whether the order snapshot was persisted.
|
|
19769
|
+
* @type {boolean}
|
|
19770
|
+
* @memberof SyncKioskOrderResponseDto
|
|
19771
|
+
*/
|
|
19772
|
+
'synced': boolean;
|
|
19773
|
+
/**
|
|
19774
|
+
* Id of the synced order.
|
|
19775
|
+
* @type {string}
|
|
19776
|
+
* @memberof SyncKioskOrderResponseDto
|
|
19777
|
+
*/
|
|
19778
|
+
'orderId': string;
|
|
19779
|
+
}
|
|
19347
19780
|
/**
|
|
19348
19781
|
*
|
|
19349
19782
|
* @export
|
|
@@ -29749,6 +30182,15 @@ export declare class KDSApi extends BaseAPI implements KDSApiInterface {
|
|
|
29749
30182
|
* @export
|
|
29750
30183
|
*/
|
|
29751
30184
|
export declare const KiosksApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
30185
|
+
/**
|
|
30186
|
+
* 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.
|
|
30187
|
+
* @summary Get the full kiosk order snapshot by id
|
|
30188
|
+
* @param {string} orderId The unique ID of the order.
|
|
30189
|
+
* @param {string} businessId The unique ID of the business.
|
|
30190
|
+
* @param {*} [options] Override http request option.
|
|
30191
|
+
* @throws {RequiredError}
|
|
30192
|
+
*/
|
|
30193
|
+
getKioskOrder: (orderId: string, businessId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
29752
30194
|
/**
|
|
29753
30195
|
*
|
|
29754
30196
|
* @param {string} orderId The unique ID of the order to validate against the system.
|
|
@@ -29765,6 +30207,14 @@ export declare const KiosksApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
29765
30207
|
* @throws {RequiredError}
|
|
29766
30208
|
*/
|
|
29767
30209
|
recoverOrder: (orderId: string, businessId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
30210
|
+
/**
|
|
30211
|
+
*
|
|
30212
|
+
* @summary Sync a kiosk order snapshot
|
|
30213
|
+
* @param {SyncKioskOrderDto} syncKioskOrderDto
|
|
30214
|
+
* @param {*} [options] Override http request option.
|
|
30215
|
+
* @throws {RequiredError}
|
|
30216
|
+
*/
|
|
30217
|
+
syncKioskOrder: (syncKioskOrderDto: SyncKioskOrderDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
29768
30218
|
/**
|
|
29769
30219
|
*
|
|
29770
30220
|
* @param {string} terminalId The unique ID of the terminal to validate against the system.
|
|
@@ -29779,6 +30229,15 @@ export declare const KiosksApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
29779
30229
|
* @export
|
|
29780
30230
|
*/
|
|
29781
30231
|
export declare const KiosksApiFp: (configuration?: Configuration) => {
|
|
30232
|
+
/**
|
|
30233
|
+
* 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.
|
|
30234
|
+
* @summary Get the full kiosk order snapshot by id
|
|
30235
|
+
* @param {string} orderId The unique ID of the order.
|
|
30236
|
+
* @param {string} businessId The unique ID of the business.
|
|
30237
|
+
* @param {*} [options] Override http request option.
|
|
30238
|
+
* @throws {RequiredError}
|
|
30239
|
+
*/
|
|
30240
|
+
getKioskOrder(orderId: string, businessId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PosOrderDto>>;
|
|
29782
30241
|
/**
|
|
29783
30242
|
*
|
|
29784
30243
|
* @param {string} orderId The unique ID of the order to validate against the system.
|
|
@@ -29795,6 +30254,14 @@ export declare const KiosksApiFp: (configuration?: Configuration) => {
|
|
|
29795
30254
|
* @throws {RequiredError}
|
|
29796
30255
|
*/
|
|
29797
30256
|
recoverOrder(orderId: string, businessId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
30257
|
+
/**
|
|
30258
|
+
*
|
|
30259
|
+
* @summary Sync a kiosk order snapshot
|
|
30260
|
+
* @param {SyncKioskOrderDto} syncKioskOrderDto
|
|
30261
|
+
* @param {*} [options] Override http request option.
|
|
30262
|
+
* @throws {RequiredError}
|
|
30263
|
+
*/
|
|
30264
|
+
syncKioskOrder(syncKioskOrderDto: SyncKioskOrderDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SyncKioskOrderResponseDto>>;
|
|
29798
30265
|
/**
|
|
29799
30266
|
*
|
|
29800
30267
|
* @param {string} terminalId The unique ID of the terminal to validate against the system.
|
|
@@ -29809,6 +30276,15 @@ export declare const KiosksApiFp: (configuration?: Configuration) => {
|
|
|
29809
30276
|
* @export
|
|
29810
30277
|
*/
|
|
29811
30278
|
export declare const KiosksApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
30279
|
+
/**
|
|
30280
|
+
* 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.
|
|
30281
|
+
* @summary Get the full kiosk order snapshot by id
|
|
30282
|
+
* @param {string} orderId The unique ID of the order.
|
|
30283
|
+
* @param {string} businessId The unique ID of the business.
|
|
30284
|
+
* @param {*} [options] Override http request option.
|
|
30285
|
+
* @throws {RequiredError}
|
|
30286
|
+
*/
|
|
30287
|
+
getKioskOrder(orderId: string, businessId: string, options?: any): AxiosPromise<PosOrderDto>;
|
|
29812
30288
|
/**
|
|
29813
30289
|
*
|
|
29814
30290
|
* @param {string} orderId The unique ID of the order to validate against the system.
|
|
@@ -29825,6 +30301,14 @@ export declare const KiosksApiFactory: (configuration?: Configuration, basePath?
|
|
|
29825
30301
|
* @throws {RequiredError}
|
|
29826
30302
|
*/
|
|
29827
30303
|
recoverOrder(orderId: string, businessId: string, options?: any): AxiosPromise<void>;
|
|
30304
|
+
/**
|
|
30305
|
+
*
|
|
30306
|
+
* @summary Sync a kiosk order snapshot
|
|
30307
|
+
* @param {SyncKioskOrderDto} syncKioskOrderDto
|
|
30308
|
+
* @param {*} [options] Override http request option.
|
|
30309
|
+
* @throws {RequiredError}
|
|
30310
|
+
*/
|
|
30311
|
+
syncKioskOrder(syncKioskOrderDto: SyncKioskOrderDto, options?: any): AxiosPromise<SyncKioskOrderResponseDto>;
|
|
29828
30312
|
/**
|
|
29829
30313
|
*
|
|
29830
30314
|
* @param {string} terminalId The unique ID of the terminal to validate against the system.
|
|
@@ -29840,6 +30324,16 @@ export declare const KiosksApiFactory: (configuration?: Configuration, basePath?
|
|
|
29840
30324
|
* @interface KiosksApi
|
|
29841
30325
|
*/
|
|
29842
30326
|
export interface KiosksApiInterface {
|
|
30327
|
+
/**
|
|
30328
|
+
* 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.
|
|
30329
|
+
* @summary Get the full kiosk order snapshot by id
|
|
30330
|
+
* @param {string} orderId The unique ID of the order.
|
|
30331
|
+
* @param {string} businessId The unique ID of the business.
|
|
30332
|
+
* @param {*} [options] Override http request option.
|
|
30333
|
+
* @throws {RequiredError}
|
|
30334
|
+
* @memberof KiosksApiInterface
|
|
30335
|
+
*/
|
|
30336
|
+
getKioskOrder(orderId: string, businessId: string, options?: AxiosRequestConfig): AxiosPromise<PosOrderDto>;
|
|
29843
30337
|
/**
|
|
29844
30338
|
*
|
|
29845
30339
|
* @param {string} orderId The unique ID of the order to validate against the system.
|
|
@@ -29858,6 +30352,15 @@ export interface KiosksApiInterface {
|
|
|
29858
30352
|
* @memberof KiosksApiInterface
|
|
29859
30353
|
*/
|
|
29860
30354
|
recoverOrder(orderId: string, businessId: string, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
30355
|
+
/**
|
|
30356
|
+
*
|
|
30357
|
+
* @summary Sync a kiosk order snapshot
|
|
30358
|
+
* @param {SyncKioskOrderDto} syncKioskOrderDto
|
|
30359
|
+
* @param {*} [options] Override http request option.
|
|
30360
|
+
* @throws {RequiredError}
|
|
30361
|
+
* @memberof KiosksApiInterface
|
|
30362
|
+
*/
|
|
30363
|
+
syncKioskOrder(syncKioskOrderDto: SyncKioskOrderDto, options?: AxiosRequestConfig): AxiosPromise<SyncKioskOrderResponseDto>;
|
|
29861
30364
|
/**
|
|
29862
30365
|
*
|
|
29863
30366
|
* @param {string} terminalId The unique ID of the terminal to validate against the system.
|
|
@@ -29875,6 +30378,16 @@ export interface KiosksApiInterface {
|
|
|
29875
30378
|
* @extends {BaseAPI}
|
|
29876
30379
|
*/
|
|
29877
30380
|
export declare class KiosksApi extends BaseAPI implements KiosksApiInterface {
|
|
30381
|
+
/**
|
|
30382
|
+
* 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.
|
|
30383
|
+
* @summary Get the full kiosk order snapshot by id
|
|
30384
|
+
* @param {string} orderId The unique ID of the order.
|
|
30385
|
+
* @param {string} businessId The unique ID of the business.
|
|
30386
|
+
* @param {*} [options] Override http request option.
|
|
30387
|
+
* @throws {RequiredError}
|
|
30388
|
+
* @memberof KiosksApi
|
|
30389
|
+
*/
|
|
30390
|
+
getKioskOrder(orderId: string, businessId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PosOrderDto, any, {}>>;
|
|
29878
30391
|
/**
|
|
29879
30392
|
*
|
|
29880
30393
|
* @param {string} orderId The unique ID of the order to validate against the system.
|
|
@@ -29893,6 +30406,15 @@ export declare class KiosksApi extends BaseAPI implements KiosksApiInterface {
|
|
|
29893
30406
|
* @memberof KiosksApi
|
|
29894
30407
|
*/
|
|
29895
30408
|
recoverOrder(orderId: string, businessId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
30409
|
+
/**
|
|
30410
|
+
*
|
|
30411
|
+
* @summary Sync a kiosk order snapshot
|
|
30412
|
+
* @param {SyncKioskOrderDto} syncKioskOrderDto
|
|
30413
|
+
* @param {*} [options] Override http request option.
|
|
30414
|
+
* @throws {RequiredError}
|
|
30415
|
+
* @memberof KiosksApi
|
|
30416
|
+
*/
|
|
30417
|
+
syncKioskOrder(syncKioskOrderDto: SyncKioskOrderDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SyncKioskOrderResponseDto, any, {}>>;
|
|
29896
30418
|
/**
|
|
29897
30419
|
*
|
|
29898
30420
|
* @param {string} terminalId The unique ID of the terminal to validate against the system.
|
|
@@ -33133,6 +33655,16 @@ export declare const PaymentSessionApiAxiosParamCreator: (configuration?: Config
|
|
|
33133
33655
|
* @throws {RequiredError}
|
|
33134
33656
|
*/
|
|
33135
33657
|
cancelSession: (clientToken: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
33658
|
+
/**
|
|
33659
|
+
* 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).
|
|
33660
|
+
* @summary Get an order\'s paid/reconcile status (POS or kiosk)
|
|
33661
|
+
* @param {number} businessId The internal business ID.
|
|
33662
|
+
* @param {string} orderId The order ID.
|
|
33663
|
+
* @param {OrderSettlementStatusRequestDto} [orderSettlementStatusRequestDto]
|
|
33664
|
+
* @param {*} [options] Override http request option.
|
|
33665
|
+
* @throws {RequiredError}
|
|
33666
|
+
*/
|
|
33667
|
+
getOrderSettlementStatus: (businessId: number, orderId: string, orderSettlementStatusRequestDto?: OrderSettlementStatusRequestDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
33136
33668
|
/**
|
|
33137
33669
|
* Reads PaymentSession from Postgres. Use this to poll session lifecycle without hitting the Viva API.
|
|
33138
33670
|
* @summary Get payment session status by clientToken
|
|
@@ -33270,6 +33802,16 @@ export declare const PaymentSessionApiFp: (configuration?: Configuration) => {
|
|
|
33270
33802
|
* @throws {RequiredError}
|
|
33271
33803
|
*/
|
|
33272
33804
|
cancelSession(clientToken: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentSessionViewDto>>;
|
|
33805
|
+
/**
|
|
33806
|
+
* 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).
|
|
33807
|
+
* @summary Get an order\'s paid/reconcile status (POS or kiosk)
|
|
33808
|
+
* @param {number} businessId The internal business ID.
|
|
33809
|
+
* @param {string} orderId The order ID.
|
|
33810
|
+
* @param {OrderSettlementStatusRequestDto} [orderSettlementStatusRequestDto]
|
|
33811
|
+
* @param {*} [options] Override http request option.
|
|
33812
|
+
* @throws {RequiredError}
|
|
33813
|
+
*/
|
|
33814
|
+
getOrderSettlementStatus(businessId: number, orderId: string, orderSettlementStatusRequestDto?: OrderSettlementStatusRequestDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrderSettlementStatusResponseDto>>;
|
|
33273
33815
|
/**
|
|
33274
33816
|
* Reads PaymentSession from Postgres. Use this to poll session lifecycle without hitting the Viva API.
|
|
33275
33817
|
* @summary Get payment session status by clientToken
|
|
@@ -33407,6 +33949,16 @@ export declare const PaymentSessionApiFactory: (configuration?: Configuration, b
|
|
|
33407
33949
|
* @throws {RequiredError}
|
|
33408
33950
|
*/
|
|
33409
33951
|
cancelSession(clientToken: string, options?: any): AxiosPromise<PaymentSessionViewDto>;
|
|
33952
|
+
/**
|
|
33953
|
+
* 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).
|
|
33954
|
+
* @summary Get an order\'s paid/reconcile status (POS or kiosk)
|
|
33955
|
+
* @param {number} businessId The internal business ID.
|
|
33956
|
+
* @param {string} orderId The order ID.
|
|
33957
|
+
* @param {OrderSettlementStatusRequestDto} [orderSettlementStatusRequestDto]
|
|
33958
|
+
* @param {*} [options] Override http request option.
|
|
33959
|
+
* @throws {RequiredError}
|
|
33960
|
+
*/
|
|
33961
|
+
getOrderSettlementStatus(businessId: number, orderId: string, orderSettlementStatusRequestDto?: OrderSettlementStatusRequestDto, options?: any): AxiosPromise<OrderSettlementStatusResponseDto>;
|
|
33410
33962
|
/**
|
|
33411
33963
|
* Reads PaymentSession from Postgres. Use this to poll session lifecycle without hitting the Viva API.
|
|
33412
33964
|
* @summary Get payment session status by clientToken
|
|
@@ -33546,6 +34098,17 @@ export interface PaymentSessionApiInterface {
|
|
|
33546
34098
|
* @memberof PaymentSessionApiInterface
|
|
33547
34099
|
*/
|
|
33548
34100
|
cancelSession(clientToken: string, options?: AxiosRequestConfig): AxiosPromise<PaymentSessionViewDto>;
|
|
34101
|
+
/**
|
|
34102
|
+
* 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).
|
|
34103
|
+
* @summary Get an order\'s paid/reconcile status (POS or kiosk)
|
|
34104
|
+
* @param {number} businessId The internal business ID.
|
|
34105
|
+
* @param {string} orderId The order ID.
|
|
34106
|
+
* @param {OrderSettlementStatusRequestDto} [orderSettlementStatusRequestDto]
|
|
34107
|
+
* @param {*} [options] Override http request option.
|
|
34108
|
+
* @throws {RequiredError}
|
|
34109
|
+
* @memberof PaymentSessionApiInterface
|
|
34110
|
+
*/
|
|
34111
|
+
getOrderSettlementStatus(businessId: number, orderId: string, orderSettlementStatusRequestDto?: OrderSettlementStatusRequestDto, options?: AxiosRequestConfig): AxiosPromise<OrderSettlementStatusResponseDto>;
|
|
33549
34112
|
/**
|
|
33550
34113
|
* Reads PaymentSession from Postgres. Use this to poll session lifecycle without hitting the Viva API.
|
|
33551
34114
|
* @summary Get payment session status by clientToken
|
|
@@ -33701,6 +34264,17 @@ export declare class PaymentSessionApi extends BaseAPI implements PaymentSession
|
|
|
33701
34264
|
* @memberof PaymentSessionApi
|
|
33702
34265
|
*/
|
|
33703
34266
|
cancelSession(clientToken: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PaymentSessionViewDto, any, {}>>;
|
|
34267
|
+
/**
|
|
34268
|
+
* 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).
|
|
34269
|
+
* @summary Get an order\'s paid/reconcile status (POS or kiosk)
|
|
34270
|
+
* @param {number} businessId The internal business ID.
|
|
34271
|
+
* @param {string} orderId The order ID.
|
|
34272
|
+
* @param {OrderSettlementStatusRequestDto} [orderSettlementStatusRequestDto]
|
|
34273
|
+
* @param {*} [options] Override http request option.
|
|
34274
|
+
* @throws {RequiredError}
|
|
34275
|
+
* @memberof PaymentSessionApi
|
|
34276
|
+
*/
|
|
34277
|
+
getOrderSettlementStatus(businessId: number, orderId: string, orderSettlementStatusRequestDto?: OrderSettlementStatusRequestDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderSettlementStatusResponseDto, any, {}>>;
|
|
33704
34278
|
/**
|
|
33705
34279
|
* Reads PaymentSession from Postgres. Use this to poll session lifecycle without hitting the Viva API.
|
|
33706
34280
|
* @summary Get payment session status by clientToken
|