@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/generated/api.ts
CHANGED
|
@@ -11632,6 +11632,172 @@ export interface OrderResponseDtoPriceSummary {
|
|
|
11632
11632
|
*/
|
|
11633
11633
|
'totalNet': number;
|
|
11634
11634
|
}
|
|
11635
|
+
/**
|
|
11636
|
+
*
|
|
11637
|
+
* @export
|
|
11638
|
+
* @interface OrderSettlementStatusDto
|
|
11639
|
+
*/
|
|
11640
|
+
export interface OrderSettlementStatusDto {
|
|
11641
|
+
/**
|
|
11642
|
+
* The internal business ID.
|
|
11643
|
+
* @type {number}
|
|
11644
|
+
* @memberof OrderSettlementStatusDto
|
|
11645
|
+
*/
|
|
11646
|
+
'businessId': number;
|
|
11647
|
+
/**
|
|
11648
|
+
* The order ID the settlement is computed for.
|
|
11649
|
+
* @type {string}
|
|
11650
|
+
* @memberof OrderSettlementStatusDto
|
|
11651
|
+
*/
|
|
11652
|
+
'orderId': string;
|
|
11653
|
+
/**
|
|
11654
|
+
* The order\'s checkout model (FULL / EQUAL_SPLIT / ITEM_SPLIT).
|
|
11655
|
+
* @type {string}
|
|
11656
|
+
* @memberof OrderSettlementStatusDto
|
|
11657
|
+
*/
|
|
11658
|
+
'checkoutModel': string;
|
|
11659
|
+
/**
|
|
11660
|
+
* Overall settlement status: \'underpaid\' | \'settled\' | \'overpaid\'.
|
|
11661
|
+
* @type {string}
|
|
11662
|
+
* @memberof OrderSettlementStatusDto
|
|
11663
|
+
*/
|
|
11664
|
+
'status': string;
|
|
11665
|
+
/**
|
|
11666
|
+
* True once the order is fully paid (settled or overpaid). The FE\'s stop condition.
|
|
11667
|
+
* @type {boolean}
|
|
11668
|
+
* @memberof OrderSettlementStatusDto
|
|
11669
|
+
*/
|
|
11670
|
+
'isFullyPaid': boolean;
|
|
11671
|
+
/**
|
|
11672
|
+
* Order total in the smallest currency unit (cents).
|
|
11673
|
+
* @type {number}
|
|
11674
|
+
* @memberof OrderSettlementStatusDto
|
|
11675
|
+
*/
|
|
11676
|
+
'cartTotal': number;
|
|
11677
|
+
/**
|
|
11678
|
+
* Sum of settled payments in cents.
|
|
11679
|
+
* @type {number}
|
|
11680
|
+
* @memberof OrderSettlementStatusDto
|
|
11681
|
+
*/
|
|
11682
|
+
'paidAmount': number;
|
|
11683
|
+
/**
|
|
11684
|
+
* Outstanding balance in cents (0 when settled/overpaid).
|
|
11685
|
+
* @type {number}
|
|
11686
|
+
* @memberof OrderSettlementStatusDto
|
|
11687
|
+
*/
|
|
11688
|
+
'remainingAmount': number;
|
|
11689
|
+
/**
|
|
11690
|
+
* Amount still payable in cents (never negative).
|
|
11691
|
+
* @type {number}
|
|
11692
|
+
* @memberof OrderSettlementStatusDto
|
|
11693
|
+
*/
|
|
11694
|
+
'amountLeftToPay': number;
|
|
11695
|
+
/**
|
|
11696
|
+
* Number of paymentEvents currently on the order.
|
|
11697
|
+
* @type {number}
|
|
11698
|
+
* @memberof OrderSettlementStatusDto
|
|
11699
|
+
*/
|
|
11700
|
+
'paymentEventCount': number;
|
|
11701
|
+
}
|
|
11702
|
+
/**
|
|
11703
|
+
*
|
|
11704
|
+
* @export
|
|
11705
|
+
* @interface OrderSettlementStatusRequestDto
|
|
11706
|
+
*/
|
|
11707
|
+
export interface OrderSettlementStatusRequestDto {
|
|
11708
|
+
/**
|
|
11709
|
+
* 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.
|
|
11710
|
+
* @type {number}
|
|
11711
|
+
* @memberof OrderSettlementStatusRequestDto
|
|
11712
|
+
*/
|
|
11713
|
+
'cashChange'?: number;
|
|
11714
|
+
/**
|
|
11715
|
+
* 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).
|
|
11716
|
+
* @type {number}
|
|
11717
|
+
* @memberof OrderSettlementStatusRequestDto
|
|
11718
|
+
*/
|
|
11719
|
+
'cartTotalAmount'?: number;
|
|
11720
|
+
}
|
|
11721
|
+
/**
|
|
11722
|
+
*
|
|
11723
|
+
* @export
|
|
11724
|
+
* @interface OrderSettlementStatusResponseDto
|
|
11725
|
+
*/
|
|
11726
|
+
export interface OrderSettlementStatusResponseDto {
|
|
11727
|
+
/**
|
|
11728
|
+
*
|
|
11729
|
+
* @type {OrderSettlementStatusResponseDtoSettlement}
|
|
11730
|
+
* @memberof OrderSettlementStatusResponseDto
|
|
11731
|
+
*/
|
|
11732
|
+
'settlement': OrderSettlementStatusResponseDtoSettlement | null;
|
|
11733
|
+
}
|
|
11734
|
+
/**
|
|
11735
|
+
* The settlement status, or null when the order is unavailable / not computable.
|
|
11736
|
+
* @export
|
|
11737
|
+
* @interface OrderSettlementStatusResponseDtoSettlement
|
|
11738
|
+
*/
|
|
11739
|
+
export interface OrderSettlementStatusResponseDtoSettlement {
|
|
11740
|
+
/**
|
|
11741
|
+
* The internal business ID.
|
|
11742
|
+
* @type {number}
|
|
11743
|
+
* @memberof OrderSettlementStatusResponseDtoSettlement
|
|
11744
|
+
*/
|
|
11745
|
+
'businessId': number;
|
|
11746
|
+
/**
|
|
11747
|
+
* The order ID the settlement is computed for.
|
|
11748
|
+
* @type {string}
|
|
11749
|
+
* @memberof OrderSettlementStatusResponseDtoSettlement
|
|
11750
|
+
*/
|
|
11751
|
+
'orderId': string;
|
|
11752
|
+
/**
|
|
11753
|
+
* The order\'s checkout model (FULL / EQUAL_SPLIT / ITEM_SPLIT).
|
|
11754
|
+
* @type {string}
|
|
11755
|
+
* @memberof OrderSettlementStatusResponseDtoSettlement
|
|
11756
|
+
*/
|
|
11757
|
+
'checkoutModel': string;
|
|
11758
|
+
/**
|
|
11759
|
+
* Overall settlement status: \'underpaid\' | \'settled\' | \'overpaid\'.
|
|
11760
|
+
* @type {string}
|
|
11761
|
+
* @memberof OrderSettlementStatusResponseDtoSettlement
|
|
11762
|
+
*/
|
|
11763
|
+
'status': string;
|
|
11764
|
+
/**
|
|
11765
|
+
* True once the order is fully paid (settled or overpaid). The FE\'s stop condition.
|
|
11766
|
+
* @type {boolean}
|
|
11767
|
+
* @memberof OrderSettlementStatusResponseDtoSettlement
|
|
11768
|
+
*/
|
|
11769
|
+
'isFullyPaid': boolean;
|
|
11770
|
+
/**
|
|
11771
|
+
* Order total in the smallest currency unit (cents).
|
|
11772
|
+
* @type {number}
|
|
11773
|
+
* @memberof OrderSettlementStatusResponseDtoSettlement
|
|
11774
|
+
*/
|
|
11775
|
+
'cartTotal': number;
|
|
11776
|
+
/**
|
|
11777
|
+
* Sum of settled payments in cents.
|
|
11778
|
+
* @type {number}
|
|
11779
|
+
* @memberof OrderSettlementStatusResponseDtoSettlement
|
|
11780
|
+
*/
|
|
11781
|
+
'paidAmount': number;
|
|
11782
|
+
/**
|
|
11783
|
+
* Outstanding balance in cents (0 when settled/overpaid).
|
|
11784
|
+
* @type {number}
|
|
11785
|
+
* @memberof OrderSettlementStatusResponseDtoSettlement
|
|
11786
|
+
*/
|
|
11787
|
+
'remainingAmount': number;
|
|
11788
|
+
/**
|
|
11789
|
+
* Amount still payable in cents (never negative).
|
|
11790
|
+
* @type {number}
|
|
11791
|
+
* @memberof OrderSettlementStatusResponseDtoSettlement
|
|
11792
|
+
*/
|
|
11793
|
+
'amountLeftToPay': number;
|
|
11794
|
+
/**
|
|
11795
|
+
* Number of paymentEvents currently on the order.
|
|
11796
|
+
* @type {number}
|
|
11797
|
+
* @memberof OrderSettlementStatusResponseDtoSettlement
|
|
11798
|
+
*/
|
|
11799
|
+
'paymentEventCount': number;
|
|
11800
|
+
}
|
|
11635
11801
|
/**
|
|
11636
11802
|
*
|
|
11637
11803
|
* @export
|
|
@@ -19927,6 +20093,275 @@ export interface SupportedChannelDto {
|
|
|
19927
20093
|
}
|
|
19928
20094
|
|
|
19929
20095
|
|
|
20096
|
+
/**
|
|
20097
|
+
*
|
|
20098
|
+
* @export
|
|
20099
|
+
* @interface SyncKioskOrderDto
|
|
20100
|
+
*/
|
|
20101
|
+
export interface SyncKioskOrderDto {
|
|
20102
|
+
/**
|
|
20103
|
+
*
|
|
20104
|
+
* @type {SyncKioskOrderDtoOrder}
|
|
20105
|
+
* @memberof SyncKioskOrderDto
|
|
20106
|
+
*/
|
|
20107
|
+
'order': SyncKioskOrderDtoOrder;
|
|
20108
|
+
}
|
|
20109
|
+
/**
|
|
20110
|
+
* Kiosk order snapshot to persist (same shape as PosOrderDto). Transitional: paymentEvents are still client-owned and persisted as sent.
|
|
20111
|
+
* @export
|
|
20112
|
+
* @interface SyncKioskOrderDtoOrder
|
|
20113
|
+
*/
|
|
20114
|
+
export interface SyncKioskOrderDtoOrder {
|
|
20115
|
+
/**
|
|
20116
|
+
*
|
|
20117
|
+
* @type {string}
|
|
20118
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
20119
|
+
*/
|
|
20120
|
+
'id': string;
|
|
20121
|
+
/**
|
|
20122
|
+
*
|
|
20123
|
+
* @type {string}
|
|
20124
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
20125
|
+
*/
|
|
20126
|
+
'businessId': string;
|
|
20127
|
+
/**
|
|
20128
|
+
*
|
|
20129
|
+
* @type {ProviderEnum}
|
|
20130
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
20131
|
+
*/
|
|
20132
|
+
'provider': ProviderEnum;
|
|
20133
|
+
/**
|
|
20134
|
+
*
|
|
20135
|
+
* @type {CurrencyCode}
|
|
20136
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
20137
|
+
*/
|
|
20138
|
+
'currency': CurrencyCode;
|
|
20139
|
+
/**
|
|
20140
|
+
*
|
|
20141
|
+
* @type {PosBusinessDto}
|
|
20142
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
20143
|
+
*/
|
|
20144
|
+
'business': PosBusinessDto;
|
|
20145
|
+
/**
|
|
20146
|
+
*
|
|
20147
|
+
* @type {string}
|
|
20148
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
20149
|
+
*/
|
|
20150
|
+
'createdAt': string;
|
|
20151
|
+
/**
|
|
20152
|
+
*
|
|
20153
|
+
* @type {OrderStatusEnum}
|
|
20154
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
20155
|
+
*/
|
|
20156
|
+
'status': OrderStatusEnum;
|
|
20157
|
+
/**
|
|
20158
|
+
*
|
|
20159
|
+
* @type {string}
|
|
20160
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
20161
|
+
*/
|
|
20162
|
+
'updatedAt': string;
|
|
20163
|
+
/**
|
|
20164
|
+
*
|
|
20165
|
+
* @type {string}
|
|
20166
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
20167
|
+
*/
|
|
20168
|
+
'completedAt'?: string;
|
|
20169
|
+
/**
|
|
20170
|
+
*
|
|
20171
|
+
* @type {string}
|
|
20172
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
20173
|
+
*/
|
|
20174
|
+
'orderNumber': string;
|
|
20175
|
+
/**
|
|
20176
|
+
*
|
|
20177
|
+
* @type {CheckoutModelEnum}
|
|
20178
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
20179
|
+
*/
|
|
20180
|
+
'checkoutModel': CheckoutModelEnum;
|
|
20181
|
+
/**
|
|
20182
|
+
*
|
|
20183
|
+
* @type {OrderTypePOS}
|
|
20184
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
20185
|
+
*/
|
|
20186
|
+
'orderType': OrderTypePOS;
|
|
20187
|
+
/**
|
|
20188
|
+
*
|
|
20189
|
+
* @type {string}
|
|
20190
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
20191
|
+
*/
|
|
20192
|
+
'spotNumber': string | null;
|
|
20193
|
+
/**
|
|
20194
|
+
* ID of the floor plan dining table linked to this order
|
|
20195
|
+
* @type {string}
|
|
20196
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
20197
|
+
*/
|
|
20198
|
+
'tableId'?: string | null;
|
|
20199
|
+
/**
|
|
20200
|
+
*
|
|
20201
|
+
* @type {string}
|
|
20202
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
20203
|
+
*/
|
|
20204
|
+
'comments': string | null;
|
|
20205
|
+
/**
|
|
20206
|
+
*
|
|
20207
|
+
* @type {PosOrderDtoTableService}
|
|
20208
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
20209
|
+
*/
|
|
20210
|
+
'tableService'?: PosOrderDtoTableService | null;
|
|
20211
|
+
/**
|
|
20212
|
+
*
|
|
20213
|
+
* @type {PosOrderDtoEqualSplitState}
|
|
20214
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
20215
|
+
*/
|
|
20216
|
+
'equalSplitState'?: PosOrderDtoEqualSplitState | null;
|
|
20217
|
+
/**
|
|
20218
|
+
* Id of the staff in shift
|
|
20219
|
+
* @type {string}
|
|
20220
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
20221
|
+
*/
|
|
20222
|
+
'staffId': string | null;
|
|
20223
|
+
/**
|
|
20224
|
+
* Id of the shift
|
|
20225
|
+
* @type {string}
|
|
20226
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
20227
|
+
*/
|
|
20228
|
+
'shiftId': string | null;
|
|
20229
|
+
/**
|
|
20230
|
+
*
|
|
20231
|
+
* @type {OrderRefundStatus}
|
|
20232
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
20233
|
+
*/
|
|
20234
|
+
'orderRefundStatus': OrderRefundStatus;
|
|
20235
|
+
/**
|
|
20236
|
+
*
|
|
20237
|
+
* @type {LocatorType}
|
|
20238
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
20239
|
+
*/
|
|
20240
|
+
'locatorType': LocatorType;
|
|
20241
|
+
/**
|
|
20242
|
+
*
|
|
20243
|
+
* @type {PosOrderPriceDto}
|
|
20244
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
20245
|
+
*/
|
|
20246
|
+
'basketPrice': PosOrderPriceDto;
|
|
20247
|
+
/**
|
|
20248
|
+
*
|
|
20249
|
+
* @type {Array<PosOrderItemDto>}
|
|
20250
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
20251
|
+
*/
|
|
20252
|
+
'items': Array<PosOrderItemDto>;
|
|
20253
|
+
/**
|
|
20254
|
+
*
|
|
20255
|
+
* @type {Array<PosDiscountDto>}
|
|
20256
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
20257
|
+
*/
|
|
20258
|
+
'discounts': Array<PosDiscountDto>;
|
|
20259
|
+
/**
|
|
20260
|
+
*
|
|
20261
|
+
* @type {PosCustomerDto}
|
|
20262
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
20263
|
+
*/
|
|
20264
|
+
'customer': PosCustomerDto | null;
|
|
20265
|
+
/**
|
|
20266
|
+
*
|
|
20267
|
+
* @type {Array<TransactionDto>}
|
|
20268
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
20269
|
+
*/
|
|
20270
|
+
'paymentEvents': Array<TransactionDto>;
|
|
20271
|
+
/**
|
|
20272
|
+
*
|
|
20273
|
+
* @type {Array<PaymentRefundDto>}
|
|
20274
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
20275
|
+
*/
|
|
20276
|
+
'refunds'?: Array<PaymentRefundDto>;
|
|
20277
|
+
/**
|
|
20278
|
+
* Data version code
|
|
20279
|
+
* @type {string}
|
|
20280
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
20281
|
+
*/
|
|
20282
|
+
'version': string;
|
|
20283
|
+
/**
|
|
20284
|
+
*
|
|
20285
|
+
* @type {OrderFormat}
|
|
20286
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
20287
|
+
*/
|
|
20288
|
+
'orderFormat'?: OrderFormat;
|
|
20289
|
+
/**
|
|
20290
|
+
* The ID of the loyalty program active during this order.
|
|
20291
|
+
* @type {string}
|
|
20292
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
20293
|
+
*/
|
|
20294
|
+
'loyaltyProgramId': string | null;
|
|
20295
|
+
/**
|
|
20296
|
+
* An array of loyalty transaction IDs related to this order.
|
|
20297
|
+
* @type {Array<string>}
|
|
20298
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
20299
|
+
*/
|
|
20300
|
+
'loyaltyTransactionIds': Array<string>;
|
|
20301
|
+
/**
|
|
20302
|
+
*
|
|
20303
|
+
* @type {PosOrderDtoTaxSummary}
|
|
20304
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
20305
|
+
*/
|
|
20306
|
+
'taxSummary'?: PosOrderDtoTaxSummary;
|
|
20307
|
+
/**
|
|
20308
|
+
* Name of staff member who created the order
|
|
20309
|
+
* @type {string}
|
|
20310
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
20311
|
+
*/
|
|
20312
|
+
'staffName'?: string | null;
|
|
20313
|
+
/**
|
|
20314
|
+
*
|
|
20315
|
+
* @type {PosOrderDtoInvoiceCompany}
|
|
20316
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
20317
|
+
*/
|
|
20318
|
+
'invoiceCompany'?: PosOrderDtoInvoiceCompany | null;
|
|
20319
|
+
/**
|
|
20320
|
+
*
|
|
20321
|
+
* @type {object}
|
|
20322
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
20323
|
+
*/
|
|
20324
|
+
'lastPaymentError'?: object;
|
|
20325
|
+
/**
|
|
20326
|
+
*
|
|
20327
|
+
* @type {Array<OrderFeeDto>}
|
|
20328
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
20329
|
+
*/
|
|
20330
|
+
'fees'?: Array<OrderFeeDto> | null;
|
|
20331
|
+
/**
|
|
20332
|
+
* Loyalty user ID associated with this order
|
|
20333
|
+
* @type {number}
|
|
20334
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
20335
|
+
*/
|
|
20336
|
+
'targetUserId'?: number;
|
|
20337
|
+
/**
|
|
20338
|
+
* ID of the table group this order belongs to
|
|
20339
|
+
* @type {string}
|
|
20340
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
20341
|
+
*/
|
|
20342
|
+
'tableGroupId'?: string | null;
|
|
20343
|
+
}
|
|
20344
|
+
|
|
20345
|
+
|
|
20346
|
+
/**
|
|
20347
|
+
*
|
|
20348
|
+
* @export
|
|
20349
|
+
* @interface SyncKioskOrderResponseDto
|
|
20350
|
+
*/
|
|
20351
|
+
export interface SyncKioskOrderResponseDto {
|
|
20352
|
+
/**
|
|
20353
|
+
* Whether the order snapshot was persisted.
|
|
20354
|
+
* @type {boolean}
|
|
20355
|
+
* @memberof SyncKioskOrderResponseDto
|
|
20356
|
+
*/
|
|
20357
|
+
'synced': boolean;
|
|
20358
|
+
/**
|
|
20359
|
+
* Id of the synced order.
|
|
20360
|
+
* @type {string}
|
|
20361
|
+
* @memberof SyncKioskOrderResponseDto
|
|
20362
|
+
*/
|
|
20363
|
+
'orderId': string;
|
|
20364
|
+
}
|
|
19930
20365
|
/**
|
|
19931
20366
|
*
|
|
19932
20367
|
* @export
|
|
@@ -34764,6 +35199,44 @@ export class KDSApi extends BaseAPI implements KDSApiInterface {
|
|
|
34764
35199
|
*/
|
|
34765
35200
|
export const KiosksApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
34766
35201
|
return {
|
|
35202
|
+
/**
|
|
35203
|
+
* 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.
|
|
35204
|
+
* @summary Get the full kiosk order snapshot by id
|
|
35205
|
+
* @param {string} orderId The unique ID of the order.
|
|
35206
|
+
* @param {string} businessId The unique ID of the business.
|
|
35207
|
+
* @param {*} [options] Override http request option.
|
|
35208
|
+
* @throws {RequiredError}
|
|
35209
|
+
*/
|
|
35210
|
+
getKioskOrder: async (orderId: string, businessId: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
35211
|
+
// verify required parameter 'orderId' is not null or undefined
|
|
35212
|
+
assertParamExists('getKioskOrder', 'orderId', orderId)
|
|
35213
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
35214
|
+
assertParamExists('getKioskOrder', 'businessId', businessId)
|
|
35215
|
+
const localVarPath = `/api/v1/kiosk/orders/{orderId}/{businessId}`
|
|
35216
|
+
.replace(`{${"orderId"}}`, encodeURIComponent(String(orderId)))
|
|
35217
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)));
|
|
35218
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
35219
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
35220
|
+
let baseOptions;
|
|
35221
|
+
if (configuration) {
|
|
35222
|
+
baseOptions = configuration.baseOptions;
|
|
35223
|
+
}
|
|
35224
|
+
|
|
35225
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
35226
|
+
const localVarHeaderParameter = {} as any;
|
|
35227
|
+
const localVarQueryParameter = {} as any;
|
|
35228
|
+
|
|
35229
|
+
|
|
35230
|
+
|
|
35231
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
35232
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
35233
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
35234
|
+
|
|
35235
|
+
return {
|
|
35236
|
+
url: toPathString(localVarUrlObj),
|
|
35237
|
+
options: localVarRequestOptions,
|
|
35238
|
+
};
|
|
35239
|
+
},
|
|
34767
35240
|
/**
|
|
34768
35241
|
*
|
|
34769
35242
|
* @param {string} orderId The unique ID of the order to validate against the system.
|
|
@@ -34838,6 +35311,42 @@ export const KiosksApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
34838
35311
|
options: localVarRequestOptions,
|
|
34839
35312
|
};
|
|
34840
35313
|
},
|
|
35314
|
+
/**
|
|
35315
|
+
*
|
|
35316
|
+
* @summary Sync a kiosk order snapshot
|
|
35317
|
+
* @param {SyncKioskOrderDto} syncKioskOrderDto
|
|
35318
|
+
* @param {*} [options] Override http request option.
|
|
35319
|
+
* @throws {RequiredError}
|
|
35320
|
+
*/
|
|
35321
|
+
syncKioskOrder: async (syncKioskOrderDto: SyncKioskOrderDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
35322
|
+
// verify required parameter 'syncKioskOrderDto' is not null or undefined
|
|
35323
|
+
assertParamExists('syncKioskOrder', 'syncKioskOrderDto', syncKioskOrderDto)
|
|
35324
|
+
const localVarPath = `/api/v1/kiosk/orders/sync`;
|
|
35325
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
35326
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
35327
|
+
let baseOptions;
|
|
35328
|
+
if (configuration) {
|
|
35329
|
+
baseOptions = configuration.baseOptions;
|
|
35330
|
+
}
|
|
35331
|
+
|
|
35332
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
35333
|
+
const localVarHeaderParameter = {} as any;
|
|
35334
|
+
const localVarQueryParameter = {} as any;
|
|
35335
|
+
|
|
35336
|
+
|
|
35337
|
+
|
|
35338
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
35339
|
+
|
|
35340
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
35341
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
35342
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
35343
|
+
localVarRequestOptions.data = serializeDataIfNeeded(syncKioskOrderDto, localVarRequestOptions, configuration)
|
|
35344
|
+
|
|
35345
|
+
return {
|
|
35346
|
+
url: toPathString(localVarUrlObj),
|
|
35347
|
+
options: localVarRequestOptions,
|
|
35348
|
+
};
|
|
35349
|
+
},
|
|
34841
35350
|
/**
|
|
34842
35351
|
*
|
|
34843
35352
|
* @param {string} terminalId The unique ID of the terminal to validate against the system.
|
|
@@ -34891,6 +35400,18 @@ export const KiosksApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
34891
35400
|
export const KiosksApiFp = function(configuration?: Configuration) {
|
|
34892
35401
|
const localVarAxiosParamCreator = KiosksApiAxiosParamCreator(configuration)
|
|
34893
35402
|
return {
|
|
35403
|
+
/**
|
|
35404
|
+
* 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.
|
|
35405
|
+
* @summary Get the full kiosk order snapshot by id
|
|
35406
|
+
* @param {string} orderId The unique ID of the order.
|
|
35407
|
+
* @param {string} businessId The unique ID of the business.
|
|
35408
|
+
* @param {*} [options] Override http request option.
|
|
35409
|
+
* @throws {RequiredError}
|
|
35410
|
+
*/
|
|
35411
|
+
async getKioskOrder(orderId: string, businessId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PosOrderDto>> {
|
|
35412
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getKioskOrder(orderId, businessId, options);
|
|
35413
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
35414
|
+
},
|
|
34894
35415
|
/**
|
|
34895
35416
|
*
|
|
34896
35417
|
* @param {string} orderId The unique ID of the order to validate against the system.
|
|
@@ -34913,6 +35434,17 @@ export const KiosksApiFp = function(configuration?: Configuration) {
|
|
|
34913
35434
|
const localVarAxiosArgs = await localVarAxiosParamCreator.recoverOrder(orderId, businessId, options);
|
|
34914
35435
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
34915
35436
|
},
|
|
35437
|
+
/**
|
|
35438
|
+
*
|
|
35439
|
+
* @summary Sync a kiosk order snapshot
|
|
35440
|
+
* @param {SyncKioskOrderDto} syncKioskOrderDto
|
|
35441
|
+
* @param {*} [options] Override http request option.
|
|
35442
|
+
* @throws {RequiredError}
|
|
35443
|
+
*/
|
|
35444
|
+
async syncKioskOrder(syncKioskOrderDto: SyncKioskOrderDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SyncKioskOrderResponseDto>> {
|
|
35445
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.syncKioskOrder(syncKioskOrderDto, options);
|
|
35446
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
35447
|
+
},
|
|
34916
35448
|
/**
|
|
34917
35449
|
*
|
|
34918
35450
|
* @param {string} terminalId The unique ID of the terminal to validate against the system.
|
|
@@ -34934,6 +35466,17 @@ export const KiosksApiFp = function(configuration?: Configuration) {
|
|
|
34934
35466
|
export const KiosksApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
34935
35467
|
const localVarFp = KiosksApiFp(configuration)
|
|
34936
35468
|
return {
|
|
35469
|
+
/**
|
|
35470
|
+
* 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.
|
|
35471
|
+
* @summary Get the full kiosk order snapshot by id
|
|
35472
|
+
* @param {string} orderId The unique ID of the order.
|
|
35473
|
+
* @param {string} businessId The unique ID of the business.
|
|
35474
|
+
* @param {*} [options] Override http request option.
|
|
35475
|
+
* @throws {RequiredError}
|
|
35476
|
+
*/
|
|
35477
|
+
getKioskOrder(orderId: string, businessId: string, options?: any): AxiosPromise<PosOrderDto> {
|
|
35478
|
+
return localVarFp.getKioskOrder(orderId, businessId, options).then((request) => request(axios, basePath));
|
|
35479
|
+
},
|
|
34937
35480
|
/**
|
|
34938
35481
|
*
|
|
34939
35482
|
* @param {string} orderId The unique ID of the order to validate against the system.
|
|
@@ -34954,6 +35497,16 @@ export const KiosksApiFactory = function (configuration?: Configuration, basePat
|
|
|
34954
35497
|
recoverOrder(orderId: string, businessId: string, options?: any): AxiosPromise<void> {
|
|
34955
35498
|
return localVarFp.recoverOrder(orderId, businessId, options).then((request) => request(axios, basePath));
|
|
34956
35499
|
},
|
|
35500
|
+
/**
|
|
35501
|
+
*
|
|
35502
|
+
* @summary Sync a kiosk order snapshot
|
|
35503
|
+
* @param {SyncKioskOrderDto} syncKioskOrderDto
|
|
35504
|
+
* @param {*} [options] Override http request option.
|
|
35505
|
+
* @throws {RequiredError}
|
|
35506
|
+
*/
|
|
35507
|
+
syncKioskOrder(syncKioskOrderDto: SyncKioskOrderDto, options?: any): AxiosPromise<SyncKioskOrderResponseDto> {
|
|
35508
|
+
return localVarFp.syncKioskOrder(syncKioskOrderDto, options).then((request) => request(axios, basePath));
|
|
35509
|
+
},
|
|
34957
35510
|
/**
|
|
34958
35511
|
*
|
|
34959
35512
|
* @param {string} terminalId The unique ID of the terminal to validate against the system.
|
|
@@ -34973,6 +35526,17 @@ export const KiosksApiFactory = function (configuration?: Configuration, basePat
|
|
|
34973
35526
|
* @interface KiosksApi
|
|
34974
35527
|
*/
|
|
34975
35528
|
export interface KiosksApiInterface {
|
|
35529
|
+
/**
|
|
35530
|
+
* 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.
|
|
35531
|
+
* @summary Get the full kiosk order snapshot by id
|
|
35532
|
+
* @param {string} orderId The unique ID of the order.
|
|
35533
|
+
* @param {string} businessId The unique ID of the business.
|
|
35534
|
+
* @param {*} [options] Override http request option.
|
|
35535
|
+
* @throws {RequiredError}
|
|
35536
|
+
* @memberof KiosksApiInterface
|
|
35537
|
+
*/
|
|
35538
|
+
getKioskOrder(orderId: string, businessId: string, options?: AxiosRequestConfig): AxiosPromise<PosOrderDto>;
|
|
35539
|
+
|
|
34976
35540
|
/**
|
|
34977
35541
|
*
|
|
34978
35542
|
* @param {string} orderId The unique ID of the order to validate against the system.
|
|
@@ -34993,6 +35557,16 @@ export interface KiosksApiInterface {
|
|
|
34993
35557
|
*/
|
|
34994
35558
|
recoverOrder(orderId: string, businessId: string, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
34995
35559
|
|
|
35560
|
+
/**
|
|
35561
|
+
*
|
|
35562
|
+
* @summary Sync a kiosk order snapshot
|
|
35563
|
+
* @param {SyncKioskOrderDto} syncKioskOrderDto
|
|
35564
|
+
* @param {*} [options] Override http request option.
|
|
35565
|
+
* @throws {RequiredError}
|
|
35566
|
+
* @memberof KiosksApiInterface
|
|
35567
|
+
*/
|
|
35568
|
+
syncKioskOrder(syncKioskOrderDto: SyncKioskOrderDto, options?: AxiosRequestConfig): AxiosPromise<SyncKioskOrderResponseDto>;
|
|
35569
|
+
|
|
34996
35570
|
/**
|
|
34997
35571
|
*
|
|
34998
35572
|
* @param {string} terminalId The unique ID of the terminal to validate against the system.
|
|
@@ -35012,6 +35586,19 @@ export interface KiosksApiInterface {
|
|
|
35012
35586
|
* @extends {BaseAPI}
|
|
35013
35587
|
*/
|
|
35014
35588
|
export class KiosksApi extends BaseAPI implements KiosksApiInterface {
|
|
35589
|
+
/**
|
|
35590
|
+
* 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.
|
|
35591
|
+
* @summary Get the full kiosk order snapshot by id
|
|
35592
|
+
* @param {string} orderId The unique ID of the order.
|
|
35593
|
+
* @param {string} businessId The unique ID of the business.
|
|
35594
|
+
* @param {*} [options] Override http request option.
|
|
35595
|
+
* @throws {RequiredError}
|
|
35596
|
+
* @memberof KiosksApi
|
|
35597
|
+
*/
|
|
35598
|
+
public getKioskOrder(orderId: string, businessId: string, options?: AxiosRequestConfig) {
|
|
35599
|
+
return KiosksApiFp(this.configuration).getKioskOrder(orderId, businessId, options).then((request) => request(this.axios, this.basePath));
|
|
35600
|
+
}
|
|
35601
|
+
|
|
35015
35602
|
/**
|
|
35016
35603
|
*
|
|
35017
35604
|
* @param {string} orderId The unique ID of the order to validate against the system.
|
|
@@ -35036,6 +35623,18 @@ export class KiosksApi extends BaseAPI implements KiosksApiInterface {
|
|
|
35036
35623
|
return KiosksApiFp(this.configuration).recoverOrder(orderId, businessId, options).then((request) => request(this.axios, this.basePath));
|
|
35037
35624
|
}
|
|
35038
35625
|
|
|
35626
|
+
/**
|
|
35627
|
+
*
|
|
35628
|
+
* @summary Sync a kiosk order snapshot
|
|
35629
|
+
* @param {SyncKioskOrderDto} syncKioskOrderDto
|
|
35630
|
+
* @param {*} [options] Override http request option.
|
|
35631
|
+
* @throws {RequiredError}
|
|
35632
|
+
* @memberof KiosksApi
|
|
35633
|
+
*/
|
|
35634
|
+
public syncKioskOrder(syncKioskOrderDto: SyncKioskOrderDto, options?: AxiosRequestConfig) {
|
|
35635
|
+
return KiosksApiFp(this.configuration).syncKioskOrder(syncKioskOrderDto, options).then((request) => request(this.axios, this.basePath));
|
|
35636
|
+
}
|
|
35637
|
+
|
|
35039
35638
|
/**
|
|
35040
35639
|
*
|
|
35041
35640
|
* @param {string} terminalId The unique ID of the terminal to validate against the system.
|
|
@@ -41057,6 +41656,48 @@ export const PaymentSessionApiAxiosParamCreator = function (configuration?: Conf
|
|
|
41057
41656
|
options: localVarRequestOptions,
|
|
41058
41657
|
};
|
|
41059
41658
|
},
|
|
41659
|
+
/**
|
|
41660
|
+
* 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).
|
|
41661
|
+
* @summary Get an order\'s paid/reconcile status (POS or kiosk)
|
|
41662
|
+
* @param {number} businessId The internal business ID.
|
|
41663
|
+
* @param {string} orderId The order ID.
|
|
41664
|
+
* @param {OrderSettlementStatusRequestDto} [orderSettlementStatusRequestDto]
|
|
41665
|
+
* @param {*} [options] Override http request option.
|
|
41666
|
+
* @throws {RequiredError}
|
|
41667
|
+
*/
|
|
41668
|
+
getOrderSettlementStatus: async (businessId: number, orderId: string, orderSettlementStatusRequestDto?: OrderSettlementStatusRequestDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
41669
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
41670
|
+
assertParamExists('getOrderSettlementStatus', 'businessId', businessId)
|
|
41671
|
+
// verify required parameter 'orderId' is not null or undefined
|
|
41672
|
+
assertParamExists('getOrderSettlementStatus', 'orderId', orderId)
|
|
41673
|
+
const localVarPath = `/api/v1/payment-session/order-settlement/{businessId}/{orderId}`
|
|
41674
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)))
|
|
41675
|
+
.replace(`{${"orderId"}}`, encodeURIComponent(String(orderId)));
|
|
41676
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
41677
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
41678
|
+
let baseOptions;
|
|
41679
|
+
if (configuration) {
|
|
41680
|
+
baseOptions = configuration.baseOptions;
|
|
41681
|
+
}
|
|
41682
|
+
|
|
41683
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
41684
|
+
const localVarHeaderParameter = {} as any;
|
|
41685
|
+
const localVarQueryParameter = {} as any;
|
|
41686
|
+
|
|
41687
|
+
|
|
41688
|
+
|
|
41689
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
41690
|
+
|
|
41691
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
41692
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
41693
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
41694
|
+
localVarRequestOptions.data = serializeDataIfNeeded(orderSettlementStatusRequestDto, localVarRequestOptions, configuration)
|
|
41695
|
+
|
|
41696
|
+
return {
|
|
41697
|
+
url: toPathString(localVarUrlObj),
|
|
41698
|
+
options: localVarRequestOptions,
|
|
41699
|
+
};
|
|
41700
|
+
},
|
|
41060
41701
|
/**
|
|
41061
41702
|
* Reads PaymentSession from Postgres. Use this to poll session lifecycle without hitting the Viva API.
|
|
41062
41703
|
* @summary Get payment session status by clientToken
|
|
@@ -41631,6 +42272,19 @@ export const PaymentSessionApiFp = function(configuration?: Configuration) {
|
|
|
41631
42272
|
const localVarAxiosArgs = await localVarAxiosParamCreator.cancelSession(clientToken, options);
|
|
41632
42273
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
41633
42274
|
},
|
|
42275
|
+
/**
|
|
42276
|
+
* 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).
|
|
42277
|
+
* @summary Get an order\'s paid/reconcile status (POS or kiosk)
|
|
42278
|
+
* @param {number} businessId The internal business ID.
|
|
42279
|
+
* @param {string} orderId The order ID.
|
|
42280
|
+
* @param {OrderSettlementStatusRequestDto} [orderSettlementStatusRequestDto]
|
|
42281
|
+
* @param {*} [options] Override http request option.
|
|
42282
|
+
* @throws {RequiredError}
|
|
42283
|
+
*/
|
|
42284
|
+
async getOrderSettlementStatus(businessId: number, orderId: string, orderSettlementStatusRequestDto?: OrderSettlementStatusRequestDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrderSettlementStatusResponseDto>> {
|
|
42285
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getOrderSettlementStatus(businessId, orderId, orderSettlementStatusRequestDto, options);
|
|
42286
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
42287
|
+
},
|
|
41634
42288
|
/**
|
|
41635
42289
|
* Reads PaymentSession from Postgres. Use this to poll session lifecycle without hitting the Viva API.
|
|
41636
42290
|
* @summary Get payment session status by clientToken
|
|
@@ -41819,6 +42473,18 @@ export const PaymentSessionApiFactory = function (configuration?: Configuration,
|
|
|
41819
42473
|
cancelSession(clientToken: string, options?: any): AxiosPromise<PaymentSessionViewDto> {
|
|
41820
42474
|
return localVarFp.cancelSession(clientToken, options).then((request) => request(axios, basePath));
|
|
41821
42475
|
},
|
|
42476
|
+
/**
|
|
42477
|
+
* 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).
|
|
42478
|
+
* @summary Get an order\'s paid/reconcile status (POS or kiosk)
|
|
42479
|
+
* @param {number} businessId The internal business ID.
|
|
42480
|
+
* @param {string} orderId The order ID.
|
|
42481
|
+
* @param {OrderSettlementStatusRequestDto} [orderSettlementStatusRequestDto]
|
|
42482
|
+
* @param {*} [options] Override http request option.
|
|
42483
|
+
* @throws {RequiredError}
|
|
42484
|
+
*/
|
|
42485
|
+
getOrderSettlementStatus(businessId: number, orderId: string, orderSettlementStatusRequestDto?: OrderSettlementStatusRequestDto, options?: any): AxiosPromise<OrderSettlementStatusResponseDto> {
|
|
42486
|
+
return localVarFp.getOrderSettlementStatus(businessId, orderId, orderSettlementStatusRequestDto, options).then((request) => request(axios, basePath));
|
|
42487
|
+
},
|
|
41822
42488
|
/**
|
|
41823
42489
|
* Reads PaymentSession from Postgres. Use this to poll session lifecycle without hitting the Viva API.
|
|
41824
42490
|
* @summary Get payment session status by clientToken
|
|
@@ -41991,6 +42657,18 @@ export interface PaymentSessionApiInterface {
|
|
|
41991
42657
|
*/
|
|
41992
42658
|
cancelSession(clientToken: string, options?: AxiosRequestConfig): AxiosPromise<PaymentSessionViewDto>;
|
|
41993
42659
|
|
|
42660
|
+
/**
|
|
42661
|
+
* 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).
|
|
42662
|
+
* @summary Get an order\'s paid/reconcile status (POS or kiosk)
|
|
42663
|
+
* @param {number} businessId The internal business ID.
|
|
42664
|
+
* @param {string} orderId The order ID.
|
|
42665
|
+
* @param {OrderSettlementStatusRequestDto} [orderSettlementStatusRequestDto]
|
|
42666
|
+
* @param {*} [options] Override http request option.
|
|
42667
|
+
* @throws {RequiredError}
|
|
42668
|
+
* @memberof PaymentSessionApiInterface
|
|
42669
|
+
*/
|
|
42670
|
+
getOrderSettlementStatus(businessId: number, orderId: string, orderSettlementStatusRequestDto?: OrderSettlementStatusRequestDto, options?: AxiosRequestConfig): AxiosPromise<OrderSettlementStatusResponseDto>;
|
|
42671
|
+
|
|
41994
42672
|
/**
|
|
41995
42673
|
* Reads PaymentSession from Postgres. Use this to poll session lifecycle without hitting the Viva API.
|
|
41996
42674
|
* @summary Get payment session status by clientToken
|
|
@@ -42165,6 +42843,20 @@ export class PaymentSessionApi extends BaseAPI implements PaymentSessionApiInter
|
|
|
42165
42843
|
return PaymentSessionApiFp(this.configuration).cancelSession(clientToken, options).then((request) => request(this.axios, this.basePath));
|
|
42166
42844
|
}
|
|
42167
42845
|
|
|
42846
|
+
/**
|
|
42847
|
+
* 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).
|
|
42848
|
+
* @summary Get an order\'s paid/reconcile status (POS or kiosk)
|
|
42849
|
+
* @param {number} businessId The internal business ID.
|
|
42850
|
+
* @param {string} orderId The order ID.
|
|
42851
|
+
* @param {OrderSettlementStatusRequestDto} [orderSettlementStatusRequestDto]
|
|
42852
|
+
* @param {*} [options] Override http request option.
|
|
42853
|
+
* @throws {RequiredError}
|
|
42854
|
+
* @memberof PaymentSessionApi
|
|
42855
|
+
*/
|
|
42856
|
+
public getOrderSettlementStatus(businessId: number, orderId: string, orderSettlementStatusRequestDto?: OrderSettlementStatusRequestDto, options?: AxiosRequestConfig) {
|
|
42857
|
+
return PaymentSessionApiFp(this.configuration).getOrderSettlementStatus(businessId, orderId, orderSettlementStatusRequestDto, options).then((request) => request(this.axios, this.basePath));
|
|
42858
|
+
}
|
|
42859
|
+
|
|
42168
42860
|
/**
|
|
42169
42861
|
* Reads PaymentSession from Postgres. Use this to poll session lifecycle without hitting the Viva API.
|
|
42170
42862
|
* @summary Get payment session status by clientToken
|