@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/generated/api.ts
CHANGED
|
@@ -5193,6 +5193,62 @@ export interface DiscoverTerminalDto {
|
|
|
5193
5193
|
}
|
|
5194
5194
|
|
|
5195
5195
|
|
|
5196
|
+
/**
|
|
5197
|
+
*
|
|
5198
|
+
* @export
|
|
5199
|
+
* @interface DisplayInitBodyDto
|
|
5200
|
+
*/
|
|
5201
|
+
export interface DisplayInitBodyDto {
|
|
5202
|
+
/**
|
|
5203
|
+
* Optional human-readable label for the display device.
|
|
5204
|
+
* @type {string}
|
|
5205
|
+
* @memberof DisplayInitBodyDto
|
|
5206
|
+
*/
|
|
5207
|
+
'displayName'?: string | null;
|
|
5208
|
+
}
|
|
5209
|
+
/**
|
|
5210
|
+
*
|
|
5211
|
+
* @export
|
|
5212
|
+
* @interface DisplayInitResponseDto
|
|
5213
|
+
*/
|
|
5214
|
+
export interface DisplayInitResponseDto {
|
|
5215
|
+
/**
|
|
5216
|
+
* Server-issued display identity.
|
|
5217
|
+
* @type {string}
|
|
5218
|
+
* @memberof DisplayInitResponseDto
|
|
5219
|
+
*/
|
|
5220
|
+
'displayId': string;
|
|
5221
|
+
/**
|
|
5222
|
+
* Short pairing code shown on the display.
|
|
5223
|
+
* @type {string}
|
|
5224
|
+
* @memberof DisplayInitResponseDto
|
|
5225
|
+
*/
|
|
5226
|
+
'code': string;
|
|
5227
|
+
/**
|
|
5228
|
+
* One-time nonce carried in the pairing QR.
|
|
5229
|
+
* @type {string}
|
|
5230
|
+
* @memberof DisplayInitResponseDto
|
|
5231
|
+
*/
|
|
5232
|
+
'nonce': string;
|
|
5233
|
+
/**
|
|
5234
|
+
* Ably channel the display subscribes to for the ack.
|
|
5235
|
+
* @type {string}
|
|
5236
|
+
* @memberof DisplayInitResponseDto
|
|
5237
|
+
*/
|
|
5238
|
+
'pairingChannel': string;
|
|
5239
|
+
/**
|
|
5240
|
+
* Epoch ms when the code/nonce expires.
|
|
5241
|
+
* @type {number}
|
|
5242
|
+
* @memberof DisplayInitResponseDto
|
|
5243
|
+
*/
|
|
5244
|
+
'expiresAt': number;
|
|
5245
|
+
/**
|
|
5246
|
+
* Ably TokenRequest scoped to the pairing channel.
|
|
5247
|
+
* @type {object}
|
|
5248
|
+
* @memberof DisplayInitResponseDto
|
|
5249
|
+
*/
|
|
5250
|
+
'ablyTokenRequest': object;
|
|
5251
|
+
}
|
|
5196
5252
|
/**
|
|
5197
5253
|
*
|
|
5198
5254
|
* @export
|
|
@@ -11632,6 +11688,172 @@ export interface OrderResponseDtoPriceSummary {
|
|
|
11632
11688
|
*/
|
|
11633
11689
|
'totalNet': number;
|
|
11634
11690
|
}
|
|
11691
|
+
/**
|
|
11692
|
+
*
|
|
11693
|
+
* @export
|
|
11694
|
+
* @interface OrderSettlementStatusDto
|
|
11695
|
+
*/
|
|
11696
|
+
export interface OrderSettlementStatusDto {
|
|
11697
|
+
/**
|
|
11698
|
+
* The internal business ID.
|
|
11699
|
+
* @type {number}
|
|
11700
|
+
* @memberof OrderSettlementStatusDto
|
|
11701
|
+
*/
|
|
11702
|
+
'businessId': number;
|
|
11703
|
+
/**
|
|
11704
|
+
* The order ID the settlement is computed for.
|
|
11705
|
+
* @type {string}
|
|
11706
|
+
* @memberof OrderSettlementStatusDto
|
|
11707
|
+
*/
|
|
11708
|
+
'orderId': string;
|
|
11709
|
+
/**
|
|
11710
|
+
* The order\'s checkout model (FULL / EQUAL_SPLIT / ITEM_SPLIT).
|
|
11711
|
+
* @type {string}
|
|
11712
|
+
* @memberof OrderSettlementStatusDto
|
|
11713
|
+
*/
|
|
11714
|
+
'checkoutModel': string;
|
|
11715
|
+
/**
|
|
11716
|
+
* Overall settlement status: \'underpaid\' | \'settled\' | \'overpaid\'.
|
|
11717
|
+
* @type {string}
|
|
11718
|
+
* @memberof OrderSettlementStatusDto
|
|
11719
|
+
*/
|
|
11720
|
+
'status': string;
|
|
11721
|
+
/**
|
|
11722
|
+
* True once the order is fully paid (settled or overpaid). The FE\'s stop condition.
|
|
11723
|
+
* @type {boolean}
|
|
11724
|
+
* @memberof OrderSettlementStatusDto
|
|
11725
|
+
*/
|
|
11726
|
+
'isFullyPaid': boolean;
|
|
11727
|
+
/**
|
|
11728
|
+
* Order total in the smallest currency unit (cents).
|
|
11729
|
+
* @type {number}
|
|
11730
|
+
* @memberof OrderSettlementStatusDto
|
|
11731
|
+
*/
|
|
11732
|
+
'cartTotal': number;
|
|
11733
|
+
/**
|
|
11734
|
+
* Sum of settled payments in cents.
|
|
11735
|
+
* @type {number}
|
|
11736
|
+
* @memberof OrderSettlementStatusDto
|
|
11737
|
+
*/
|
|
11738
|
+
'paidAmount': number;
|
|
11739
|
+
/**
|
|
11740
|
+
* Outstanding balance in cents (0 when settled/overpaid).
|
|
11741
|
+
* @type {number}
|
|
11742
|
+
* @memberof OrderSettlementStatusDto
|
|
11743
|
+
*/
|
|
11744
|
+
'remainingAmount': number;
|
|
11745
|
+
/**
|
|
11746
|
+
* Amount still payable in cents (never negative).
|
|
11747
|
+
* @type {number}
|
|
11748
|
+
* @memberof OrderSettlementStatusDto
|
|
11749
|
+
*/
|
|
11750
|
+
'amountLeftToPay': number;
|
|
11751
|
+
/**
|
|
11752
|
+
* Number of paymentEvents currently on the order.
|
|
11753
|
+
* @type {number}
|
|
11754
|
+
* @memberof OrderSettlementStatusDto
|
|
11755
|
+
*/
|
|
11756
|
+
'paymentEventCount': number;
|
|
11757
|
+
}
|
|
11758
|
+
/**
|
|
11759
|
+
*
|
|
11760
|
+
* @export
|
|
11761
|
+
* @interface OrderSettlementStatusRequestDto
|
|
11762
|
+
*/
|
|
11763
|
+
export interface OrderSettlementStatusRequestDto {
|
|
11764
|
+
/**
|
|
11765
|
+
* 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.
|
|
11766
|
+
* @type {number}
|
|
11767
|
+
* @memberof OrderSettlementStatusRequestDto
|
|
11768
|
+
*/
|
|
11769
|
+
'cashChange'?: number;
|
|
11770
|
+
/**
|
|
11771
|
+
* 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).
|
|
11772
|
+
* @type {number}
|
|
11773
|
+
* @memberof OrderSettlementStatusRequestDto
|
|
11774
|
+
*/
|
|
11775
|
+
'cartTotalAmount'?: number;
|
|
11776
|
+
}
|
|
11777
|
+
/**
|
|
11778
|
+
*
|
|
11779
|
+
* @export
|
|
11780
|
+
* @interface OrderSettlementStatusResponseDto
|
|
11781
|
+
*/
|
|
11782
|
+
export interface OrderSettlementStatusResponseDto {
|
|
11783
|
+
/**
|
|
11784
|
+
*
|
|
11785
|
+
* @type {OrderSettlementStatusResponseDtoSettlement}
|
|
11786
|
+
* @memberof OrderSettlementStatusResponseDto
|
|
11787
|
+
*/
|
|
11788
|
+
'settlement': OrderSettlementStatusResponseDtoSettlement | null;
|
|
11789
|
+
}
|
|
11790
|
+
/**
|
|
11791
|
+
* The settlement status, or null when the order is unavailable / not computable.
|
|
11792
|
+
* @export
|
|
11793
|
+
* @interface OrderSettlementStatusResponseDtoSettlement
|
|
11794
|
+
*/
|
|
11795
|
+
export interface OrderSettlementStatusResponseDtoSettlement {
|
|
11796
|
+
/**
|
|
11797
|
+
* The internal business ID.
|
|
11798
|
+
* @type {number}
|
|
11799
|
+
* @memberof OrderSettlementStatusResponseDtoSettlement
|
|
11800
|
+
*/
|
|
11801
|
+
'businessId': number;
|
|
11802
|
+
/**
|
|
11803
|
+
* The order ID the settlement is computed for.
|
|
11804
|
+
* @type {string}
|
|
11805
|
+
* @memberof OrderSettlementStatusResponseDtoSettlement
|
|
11806
|
+
*/
|
|
11807
|
+
'orderId': string;
|
|
11808
|
+
/**
|
|
11809
|
+
* The order\'s checkout model (FULL / EQUAL_SPLIT / ITEM_SPLIT).
|
|
11810
|
+
* @type {string}
|
|
11811
|
+
* @memberof OrderSettlementStatusResponseDtoSettlement
|
|
11812
|
+
*/
|
|
11813
|
+
'checkoutModel': string;
|
|
11814
|
+
/**
|
|
11815
|
+
* Overall settlement status: \'underpaid\' | \'settled\' | \'overpaid\'.
|
|
11816
|
+
* @type {string}
|
|
11817
|
+
* @memberof OrderSettlementStatusResponseDtoSettlement
|
|
11818
|
+
*/
|
|
11819
|
+
'status': string;
|
|
11820
|
+
/**
|
|
11821
|
+
* True once the order is fully paid (settled or overpaid). The FE\'s stop condition.
|
|
11822
|
+
* @type {boolean}
|
|
11823
|
+
* @memberof OrderSettlementStatusResponseDtoSettlement
|
|
11824
|
+
*/
|
|
11825
|
+
'isFullyPaid': boolean;
|
|
11826
|
+
/**
|
|
11827
|
+
* Order total in the smallest currency unit (cents).
|
|
11828
|
+
* @type {number}
|
|
11829
|
+
* @memberof OrderSettlementStatusResponseDtoSettlement
|
|
11830
|
+
*/
|
|
11831
|
+
'cartTotal': number;
|
|
11832
|
+
/**
|
|
11833
|
+
* Sum of settled payments in cents.
|
|
11834
|
+
* @type {number}
|
|
11835
|
+
* @memberof OrderSettlementStatusResponseDtoSettlement
|
|
11836
|
+
*/
|
|
11837
|
+
'paidAmount': number;
|
|
11838
|
+
/**
|
|
11839
|
+
* Outstanding balance in cents (0 when settled/overpaid).
|
|
11840
|
+
* @type {number}
|
|
11841
|
+
* @memberof OrderSettlementStatusResponseDtoSettlement
|
|
11842
|
+
*/
|
|
11843
|
+
'remainingAmount': number;
|
|
11844
|
+
/**
|
|
11845
|
+
* Amount still payable in cents (never negative).
|
|
11846
|
+
* @type {number}
|
|
11847
|
+
* @memberof OrderSettlementStatusResponseDtoSettlement
|
|
11848
|
+
*/
|
|
11849
|
+
'amountLeftToPay': number;
|
|
11850
|
+
/**
|
|
11851
|
+
* Number of paymentEvents currently on the order.
|
|
11852
|
+
* @type {number}
|
|
11853
|
+
* @memberof OrderSettlementStatusResponseDtoSettlement
|
|
11854
|
+
*/
|
|
11855
|
+
'paymentEventCount': number;
|
|
11856
|
+
}
|
|
11635
11857
|
/**
|
|
11636
11858
|
*
|
|
11637
11859
|
* @export
|
|
@@ -12383,6 +12605,68 @@ export interface PaginationDto {
|
|
|
12383
12605
|
*/
|
|
12384
12606
|
'totalPages': number;
|
|
12385
12607
|
}
|
|
12608
|
+
/**
|
|
12609
|
+
*
|
|
12610
|
+
* @export
|
|
12611
|
+
* @interface PairDisplayBodyDto
|
|
12612
|
+
*/
|
|
12613
|
+
export interface PairDisplayBodyDto {
|
|
12614
|
+
/**
|
|
12615
|
+
* Stable POS device identifier.
|
|
12616
|
+
* @type {string}
|
|
12617
|
+
* @memberof PairDisplayBodyDto
|
|
12618
|
+
*/
|
|
12619
|
+
'posDeviceId': string;
|
|
12620
|
+
/**
|
|
12621
|
+
* Pairing code entered on the POS.
|
|
12622
|
+
* @type {string}
|
|
12623
|
+
* @memberof PairDisplayBodyDto
|
|
12624
|
+
*/
|
|
12625
|
+
'code'?: string;
|
|
12626
|
+
/**
|
|
12627
|
+
* Display id (QR path, with nonce).
|
|
12628
|
+
* @type {string}
|
|
12629
|
+
* @memberof PairDisplayBodyDto
|
|
12630
|
+
*/
|
|
12631
|
+
'displayId'?: string;
|
|
12632
|
+
/**
|
|
12633
|
+
* One-time nonce (QR path).
|
|
12634
|
+
* @type {string}
|
|
12635
|
+
* @memberof PairDisplayBodyDto
|
|
12636
|
+
*/
|
|
12637
|
+
'nonce'?: string;
|
|
12638
|
+
/**
|
|
12639
|
+
* Business to pair to; must be in the caller\'s scope.
|
|
12640
|
+
* @type {number}
|
|
12641
|
+
* @memberof PairDisplayBodyDto
|
|
12642
|
+
*/
|
|
12643
|
+
'businessId'?: number;
|
|
12644
|
+
}
|
|
12645
|
+
/**
|
|
12646
|
+
*
|
|
12647
|
+
* @export
|
|
12648
|
+
* @interface PairDisplayResponseDto
|
|
12649
|
+
*/
|
|
12650
|
+
export interface PairDisplayResponseDto {
|
|
12651
|
+
/**
|
|
12652
|
+
*
|
|
12653
|
+
* @type {string}
|
|
12654
|
+
* @memberof PairDisplayResponseDto
|
|
12655
|
+
*/
|
|
12656
|
+
'sessionId': string;
|
|
12657
|
+
/**
|
|
12658
|
+
*
|
|
12659
|
+
* @type {string}
|
|
12660
|
+
* @memberof PairDisplayResponseDto
|
|
12661
|
+
*/
|
|
12662
|
+
'sessionChannel': string;
|
|
12663
|
+
/**
|
|
12664
|
+
*
|
|
12665
|
+
* @type {string}
|
|
12666
|
+
* @memberof PairDisplayResponseDto
|
|
12667
|
+
*/
|
|
12668
|
+
'displayId': string;
|
|
12669
|
+
}
|
|
12386
12670
|
/**
|
|
12387
12671
|
*
|
|
12388
12672
|
* @export
|
|
@@ -18790,6 +19074,58 @@ export interface ReportingCategoryDto {
|
|
|
18790
19074
|
*/
|
|
18791
19075
|
'updated_at': string;
|
|
18792
19076
|
}
|
|
19077
|
+
/**
|
|
19078
|
+
*
|
|
19079
|
+
* @export
|
|
19080
|
+
* @interface RequestSessionTokenBodyDto
|
|
19081
|
+
*/
|
|
19082
|
+
export interface RequestSessionTokenBodyDto {
|
|
19083
|
+
/**
|
|
19084
|
+
*
|
|
19085
|
+
* @type {string}
|
|
19086
|
+
* @memberof RequestSessionTokenBodyDto
|
|
19087
|
+
*/
|
|
19088
|
+
'sessionId': string;
|
|
19089
|
+
/**
|
|
19090
|
+
* Which device is requesting the token.
|
|
19091
|
+
* @type {string}
|
|
19092
|
+
* @memberof RequestSessionTokenBodyDto
|
|
19093
|
+
*/
|
|
19094
|
+
'role': RoleEnum;
|
|
19095
|
+
/**
|
|
19096
|
+
* Requesting device id (posDeviceId or displayId).
|
|
19097
|
+
* @type {string}
|
|
19098
|
+
* @memberof RequestSessionTokenBodyDto
|
|
19099
|
+
*/
|
|
19100
|
+
'deviceId': string;
|
|
19101
|
+
}
|
|
19102
|
+
|
|
19103
|
+
export const RoleEnum = {
|
|
19104
|
+
Pos: 'pos',
|
|
19105
|
+
Display: 'display'
|
|
19106
|
+
} as const;
|
|
19107
|
+
|
|
19108
|
+
export type RoleEnum = typeof RoleEnum[keyof typeof RoleEnum];
|
|
19109
|
+
|
|
19110
|
+
/**
|
|
19111
|
+
*
|
|
19112
|
+
* @export
|
|
19113
|
+
* @interface RequestSessionTokenResponseDto
|
|
19114
|
+
*/
|
|
19115
|
+
export interface RequestSessionTokenResponseDto {
|
|
19116
|
+
/**
|
|
19117
|
+
* Ably TokenRequest scoped to the session channel.
|
|
19118
|
+
* @type {object}
|
|
19119
|
+
* @memberof RequestSessionTokenResponseDto
|
|
19120
|
+
*/
|
|
19121
|
+
'ablyTokenRequest': object;
|
|
19122
|
+
/**
|
|
19123
|
+
*
|
|
19124
|
+
* @type {string}
|
|
19125
|
+
* @memberof RequestSessionTokenResponseDto
|
|
19126
|
+
*/
|
|
19127
|
+
'sessionChannel': string;
|
|
19128
|
+
}
|
|
18793
19129
|
/**
|
|
18794
19130
|
*
|
|
18795
19131
|
* @export
|
|
@@ -19927,6 +20263,275 @@ export interface SupportedChannelDto {
|
|
|
19927
20263
|
}
|
|
19928
20264
|
|
|
19929
20265
|
|
|
20266
|
+
/**
|
|
20267
|
+
*
|
|
20268
|
+
* @export
|
|
20269
|
+
* @interface SyncKioskOrderDto
|
|
20270
|
+
*/
|
|
20271
|
+
export interface SyncKioskOrderDto {
|
|
20272
|
+
/**
|
|
20273
|
+
*
|
|
20274
|
+
* @type {SyncKioskOrderDtoOrder}
|
|
20275
|
+
* @memberof SyncKioskOrderDto
|
|
20276
|
+
*/
|
|
20277
|
+
'order': SyncKioskOrderDtoOrder;
|
|
20278
|
+
}
|
|
20279
|
+
/**
|
|
20280
|
+
* Kiosk order snapshot to persist (same shape as PosOrderDto). Transitional: paymentEvents are still client-owned and persisted as sent.
|
|
20281
|
+
* @export
|
|
20282
|
+
* @interface SyncKioskOrderDtoOrder
|
|
20283
|
+
*/
|
|
20284
|
+
export interface SyncKioskOrderDtoOrder {
|
|
20285
|
+
/**
|
|
20286
|
+
*
|
|
20287
|
+
* @type {string}
|
|
20288
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
20289
|
+
*/
|
|
20290
|
+
'id': string;
|
|
20291
|
+
/**
|
|
20292
|
+
*
|
|
20293
|
+
* @type {string}
|
|
20294
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
20295
|
+
*/
|
|
20296
|
+
'businessId': string;
|
|
20297
|
+
/**
|
|
20298
|
+
*
|
|
20299
|
+
* @type {ProviderEnum}
|
|
20300
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
20301
|
+
*/
|
|
20302
|
+
'provider': ProviderEnum;
|
|
20303
|
+
/**
|
|
20304
|
+
*
|
|
20305
|
+
* @type {CurrencyCode}
|
|
20306
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
20307
|
+
*/
|
|
20308
|
+
'currency': CurrencyCode;
|
|
20309
|
+
/**
|
|
20310
|
+
*
|
|
20311
|
+
* @type {PosBusinessDto}
|
|
20312
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
20313
|
+
*/
|
|
20314
|
+
'business': PosBusinessDto;
|
|
20315
|
+
/**
|
|
20316
|
+
*
|
|
20317
|
+
* @type {string}
|
|
20318
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
20319
|
+
*/
|
|
20320
|
+
'createdAt': string;
|
|
20321
|
+
/**
|
|
20322
|
+
*
|
|
20323
|
+
* @type {OrderStatusEnum}
|
|
20324
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
20325
|
+
*/
|
|
20326
|
+
'status': OrderStatusEnum;
|
|
20327
|
+
/**
|
|
20328
|
+
*
|
|
20329
|
+
* @type {string}
|
|
20330
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
20331
|
+
*/
|
|
20332
|
+
'updatedAt': string;
|
|
20333
|
+
/**
|
|
20334
|
+
*
|
|
20335
|
+
* @type {string}
|
|
20336
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
20337
|
+
*/
|
|
20338
|
+
'completedAt'?: string;
|
|
20339
|
+
/**
|
|
20340
|
+
*
|
|
20341
|
+
* @type {string}
|
|
20342
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
20343
|
+
*/
|
|
20344
|
+
'orderNumber': string;
|
|
20345
|
+
/**
|
|
20346
|
+
*
|
|
20347
|
+
* @type {CheckoutModelEnum}
|
|
20348
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
20349
|
+
*/
|
|
20350
|
+
'checkoutModel': CheckoutModelEnum;
|
|
20351
|
+
/**
|
|
20352
|
+
*
|
|
20353
|
+
* @type {OrderTypePOS}
|
|
20354
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
20355
|
+
*/
|
|
20356
|
+
'orderType': OrderTypePOS;
|
|
20357
|
+
/**
|
|
20358
|
+
*
|
|
20359
|
+
* @type {string}
|
|
20360
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
20361
|
+
*/
|
|
20362
|
+
'spotNumber': string | null;
|
|
20363
|
+
/**
|
|
20364
|
+
* ID of the floor plan dining table linked to this order
|
|
20365
|
+
* @type {string}
|
|
20366
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
20367
|
+
*/
|
|
20368
|
+
'tableId'?: string | null;
|
|
20369
|
+
/**
|
|
20370
|
+
*
|
|
20371
|
+
* @type {string}
|
|
20372
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
20373
|
+
*/
|
|
20374
|
+
'comments': string | null;
|
|
20375
|
+
/**
|
|
20376
|
+
*
|
|
20377
|
+
* @type {PosOrderDtoTableService}
|
|
20378
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
20379
|
+
*/
|
|
20380
|
+
'tableService'?: PosOrderDtoTableService | null;
|
|
20381
|
+
/**
|
|
20382
|
+
*
|
|
20383
|
+
* @type {PosOrderDtoEqualSplitState}
|
|
20384
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
20385
|
+
*/
|
|
20386
|
+
'equalSplitState'?: PosOrderDtoEqualSplitState | null;
|
|
20387
|
+
/**
|
|
20388
|
+
* Id of the staff in shift
|
|
20389
|
+
* @type {string}
|
|
20390
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
20391
|
+
*/
|
|
20392
|
+
'staffId': string | null;
|
|
20393
|
+
/**
|
|
20394
|
+
* Id of the shift
|
|
20395
|
+
* @type {string}
|
|
20396
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
20397
|
+
*/
|
|
20398
|
+
'shiftId': string | null;
|
|
20399
|
+
/**
|
|
20400
|
+
*
|
|
20401
|
+
* @type {OrderRefundStatus}
|
|
20402
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
20403
|
+
*/
|
|
20404
|
+
'orderRefundStatus': OrderRefundStatus;
|
|
20405
|
+
/**
|
|
20406
|
+
*
|
|
20407
|
+
* @type {LocatorType}
|
|
20408
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
20409
|
+
*/
|
|
20410
|
+
'locatorType': LocatorType;
|
|
20411
|
+
/**
|
|
20412
|
+
*
|
|
20413
|
+
* @type {PosOrderPriceDto}
|
|
20414
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
20415
|
+
*/
|
|
20416
|
+
'basketPrice': PosOrderPriceDto;
|
|
20417
|
+
/**
|
|
20418
|
+
*
|
|
20419
|
+
* @type {Array<PosOrderItemDto>}
|
|
20420
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
20421
|
+
*/
|
|
20422
|
+
'items': Array<PosOrderItemDto>;
|
|
20423
|
+
/**
|
|
20424
|
+
*
|
|
20425
|
+
* @type {Array<PosDiscountDto>}
|
|
20426
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
20427
|
+
*/
|
|
20428
|
+
'discounts': Array<PosDiscountDto>;
|
|
20429
|
+
/**
|
|
20430
|
+
*
|
|
20431
|
+
* @type {PosCustomerDto}
|
|
20432
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
20433
|
+
*/
|
|
20434
|
+
'customer': PosCustomerDto | null;
|
|
20435
|
+
/**
|
|
20436
|
+
*
|
|
20437
|
+
* @type {Array<TransactionDto>}
|
|
20438
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
20439
|
+
*/
|
|
20440
|
+
'paymentEvents': Array<TransactionDto>;
|
|
20441
|
+
/**
|
|
20442
|
+
*
|
|
20443
|
+
* @type {Array<PaymentRefundDto>}
|
|
20444
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
20445
|
+
*/
|
|
20446
|
+
'refunds'?: Array<PaymentRefundDto>;
|
|
20447
|
+
/**
|
|
20448
|
+
* Data version code
|
|
20449
|
+
* @type {string}
|
|
20450
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
20451
|
+
*/
|
|
20452
|
+
'version': string;
|
|
20453
|
+
/**
|
|
20454
|
+
*
|
|
20455
|
+
* @type {OrderFormat}
|
|
20456
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
20457
|
+
*/
|
|
20458
|
+
'orderFormat'?: OrderFormat;
|
|
20459
|
+
/**
|
|
20460
|
+
* The ID of the loyalty program active during this order.
|
|
20461
|
+
* @type {string}
|
|
20462
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
20463
|
+
*/
|
|
20464
|
+
'loyaltyProgramId': string | null;
|
|
20465
|
+
/**
|
|
20466
|
+
* An array of loyalty transaction IDs related to this order.
|
|
20467
|
+
* @type {Array<string>}
|
|
20468
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
20469
|
+
*/
|
|
20470
|
+
'loyaltyTransactionIds': Array<string>;
|
|
20471
|
+
/**
|
|
20472
|
+
*
|
|
20473
|
+
* @type {PosOrderDtoTaxSummary}
|
|
20474
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
20475
|
+
*/
|
|
20476
|
+
'taxSummary'?: PosOrderDtoTaxSummary;
|
|
20477
|
+
/**
|
|
20478
|
+
* Name of staff member who created the order
|
|
20479
|
+
* @type {string}
|
|
20480
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
20481
|
+
*/
|
|
20482
|
+
'staffName'?: string | null;
|
|
20483
|
+
/**
|
|
20484
|
+
*
|
|
20485
|
+
* @type {PosOrderDtoInvoiceCompany}
|
|
20486
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
20487
|
+
*/
|
|
20488
|
+
'invoiceCompany'?: PosOrderDtoInvoiceCompany | null;
|
|
20489
|
+
/**
|
|
20490
|
+
*
|
|
20491
|
+
* @type {object}
|
|
20492
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
20493
|
+
*/
|
|
20494
|
+
'lastPaymentError'?: object;
|
|
20495
|
+
/**
|
|
20496
|
+
*
|
|
20497
|
+
* @type {Array<OrderFeeDto>}
|
|
20498
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
20499
|
+
*/
|
|
20500
|
+
'fees'?: Array<OrderFeeDto> | null;
|
|
20501
|
+
/**
|
|
20502
|
+
* Loyalty user ID associated with this order
|
|
20503
|
+
* @type {number}
|
|
20504
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
20505
|
+
*/
|
|
20506
|
+
'targetUserId'?: number;
|
|
20507
|
+
/**
|
|
20508
|
+
* ID of the table group this order belongs to
|
|
20509
|
+
* @type {string}
|
|
20510
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
20511
|
+
*/
|
|
20512
|
+
'tableGroupId'?: string | null;
|
|
20513
|
+
}
|
|
20514
|
+
|
|
20515
|
+
|
|
20516
|
+
/**
|
|
20517
|
+
*
|
|
20518
|
+
* @export
|
|
20519
|
+
* @interface SyncKioskOrderResponseDto
|
|
20520
|
+
*/
|
|
20521
|
+
export interface SyncKioskOrderResponseDto {
|
|
20522
|
+
/**
|
|
20523
|
+
* Whether the order snapshot was persisted.
|
|
20524
|
+
* @type {boolean}
|
|
20525
|
+
* @memberof SyncKioskOrderResponseDto
|
|
20526
|
+
*/
|
|
20527
|
+
'synced': boolean;
|
|
20528
|
+
/**
|
|
20529
|
+
* Id of the synced order.
|
|
20530
|
+
* @type {string}
|
|
20531
|
+
* @memberof SyncKioskOrderResponseDto
|
|
20532
|
+
*/
|
|
20533
|
+
'orderId': string;
|
|
20534
|
+
}
|
|
19930
20535
|
/**
|
|
19931
20536
|
*
|
|
19932
20537
|
* @export
|
|
@@ -31270,6 +31875,287 @@ export class CoursesApi extends BaseAPI implements CoursesApiInterface {
|
|
|
31270
31875
|
}
|
|
31271
31876
|
|
|
31272
31877
|
|
|
31878
|
+
/**
|
|
31879
|
+
* DisplayApi - axios parameter creator
|
|
31880
|
+
* @export
|
|
31881
|
+
*/
|
|
31882
|
+
export const DisplayApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
31883
|
+
return {
|
|
31884
|
+
/**
|
|
31885
|
+
*
|
|
31886
|
+
* @summary Register a customer display and mint a pairing token + code.
|
|
31887
|
+
* @param {DisplayInitBodyDto} [displayInitBodyDto]
|
|
31888
|
+
* @param {*} [options] Override http request option.
|
|
31889
|
+
* @throws {RequiredError}
|
|
31890
|
+
*/
|
|
31891
|
+
init: async (displayInitBodyDto?: DisplayInitBodyDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
31892
|
+
const localVarPath = `/api/v1/display/init`;
|
|
31893
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
31894
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
31895
|
+
let baseOptions;
|
|
31896
|
+
if (configuration) {
|
|
31897
|
+
baseOptions = configuration.baseOptions;
|
|
31898
|
+
}
|
|
31899
|
+
|
|
31900
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
31901
|
+
const localVarHeaderParameter = {} as any;
|
|
31902
|
+
const localVarQueryParameter = {} as any;
|
|
31903
|
+
|
|
31904
|
+
|
|
31905
|
+
|
|
31906
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
31907
|
+
|
|
31908
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
31909
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
31910
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
31911
|
+
localVarRequestOptions.data = serializeDataIfNeeded(displayInitBodyDto, localVarRequestOptions, configuration)
|
|
31912
|
+
|
|
31913
|
+
return {
|
|
31914
|
+
url: toPathString(localVarUrlObj),
|
|
31915
|
+
options: localVarRequestOptions,
|
|
31916
|
+
};
|
|
31917
|
+
},
|
|
31918
|
+
/**
|
|
31919
|
+
*
|
|
31920
|
+
* @summary Pair a display with the POS using its code or QR nonce.
|
|
31921
|
+
* @param {PairDisplayBodyDto} pairDisplayBodyDto
|
|
31922
|
+
* @param {*} [options] Override http request option.
|
|
31923
|
+
* @throws {RequiredError}
|
|
31924
|
+
*/
|
|
31925
|
+
pair: async (pairDisplayBodyDto: PairDisplayBodyDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
31926
|
+
// verify required parameter 'pairDisplayBodyDto' is not null or undefined
|
|
31927
|
+
assertParamExists('pair', 'pairDisplayBodyDto', pairDisplayBodyDto)
|
|
31928
|
+
const localVarPath = `/api/v1/display/pair`;
|
|
31929
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
31930
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
31931
|
+
let baseOptions;
|
|
31932
|
+
if (configuration) {
|
|
31933
|
+
baseOptions = configuration.baseOptions;
|
|
31934
|
+
}
|
|
31935
|
+
|
|
31936
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
31937
|
+
const localVarHeaderParameter = {} as any;
|
|
31938
|
+
const localVarQueryParameter = {} as any;
|
|
31939
|
+
|
|
31940
|
+
|
|
31941
|
+
|
|
31942
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
31943
|
+
|
|
31944
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
31945
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
31946
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
31947
|
+
localVarRequestOptions.data = serializeDataIfNeeded(pairDisplayBodyDto, localVarRequestOptions, configuration)
|
|
31948
|
+
|
|
31949
|
+
return {
|
|
31950
|
+
url: toPathString(localVarUrlObj),
|
|
31951
|
+
options: localVarRequestOptions,
|
|
31952
|
+
};
|
|
31953
|
+
},
|
|
31954
|
+
/**
|
|
31955
|
+
*
|
|
31956
|
+
* @summary Mint a session-channel Ably token scoped to the device role.
|
|
31957
|
+
* @param {RequestSessionTokenBodyDto} requestSessionTokenBodyDto
|
|
31958
|
+
* @param {*} [options] Override http request option.
|
|
31959
|
+
* @throws {RequiredError}
|
|
31960
|
+
*/
|
|
31961
|
+
sessionToken: async (requestSessionTokenBodyDto: RequestSessionTokenBodyDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
31962
|
+
// verify required parameter 'requestSessionTokenBodyDto' is not null or undefined
|
|
31963
|
+
assertParamExists('sessionToken', 'requestSessionTokenBodyDto', requestSessionTokenBodyDto)
|
|
31964
|
+
const localVarPath = `/api/v1/display/session-token`;
|
|
31965
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
31966
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
31967
|
+
let baseOptions;
|
|
31968
|
+
if (configuration) {
|
|
31969
|
+
baseOptions = configuration.baseOptions;
|
|
31970
|
+
}
|
|
31971
|
+
|
|
31972
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
31973
|
+
const localVarHeaderParameter = {} as any;
|
|
31974
|
+
const localVarQueryParameter = {} as any;
|
|
31975
|
+
|
|
31976
|
+
|
|
31977
|
+
|
|
31978
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
31979
|
+
|
|
31980
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
31981
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
31982
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
31983
|
+
localVarRequestOptions.data = serializeDataIfNeeded(requestSessionTokenBodyDto, localVarRequestOptions, configuration)
|
|
31984
|
+
|
|
31985
|
+
return {
|
|
31986
|
+
url: toPathString(localVarUrlObj),
|
|
31987
|
+
options: localVarRequestOptions,
|
|
31988
|
+
};
|
|
31989
|
+
},
|
|
31990
|
+
}
|
|
31991
|
+
};
|
|
31992
|
+
|
|
31993
|
+
/**
|
|
31994
|
+
* DisplayApi - functional programming interface
|
|
31995
|
+
* @export
|
|
31996
|
+
*/
|
|
31997
|
+
export const DisplayApiFp = function(configuration?: Configuration) {
|
|
31998
|
+
const localVarAxiosParamCreator = DisplayApiAxiosParamCreator(configuration)
|
|
31999
|
+
return {
|
|
32000
|
+
/**
|
|
32001
|
+
*
|
|
32002
|
+
* @summary Register a customer display and mint a pairing token + code.
|
|
32003
|
+
* @param {DisplayInitBodyDto} [displayInitBodyDto]
|
|
32004
|
+
* @param {*} [options] Override http request option.
|
|
32005
|
+
* @throws {RequiredError}
|
|
32006
|
+
*/
|
|
32007
|
+
async init(displayInitBodyDto?: DisplayInitBodyDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DisplayInitResponseDto>> {
|
|
32008
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.init(displayInitBodyDto, options);
|
|
32009
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
32010
|
+
},
|
|
32011
|
+
/**
|
|
32012
|
+
*
|
|
32013
|
+
* @summary Pair a display with the POS using its code or QR nonce.
|
|
32014
|
+
* @param {PairDisplayBodyDto} pairDisplayBodyDto
|
|
32015
|
+
* @param {*} [options] Override http request option.
|
|
32016
|
+
* @throws {RequiredError}
|
|
32017
|
+
*/
|
|
32018
|
+
async pair(pairDisplayBodyDto: PairDisplayBodyDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PairDisplayResponseDto>> {
|
|
32019
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.pair(pairDisplayBodyDto, options);
|
|
32020
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
32021
|
+
},
|
|
32022
|
+
/**
|
|
32023
|
+
*
|
|
32024
|
+
* @summary Mint a session-channel Ably token scoped to the device role.
|
|
32025
|
+
* @param {RequestSessionTokenBodyDto} requestSessionTokenBodyDto
|
|
32026
|
+
* @param {*} [options] Override http request option.
|
|
32027
|
+
* @throws {RequiredError}
|
|
32028
|
+
*/
|
|
32029
|
+
async sessionToken(requestSessionTokenBodyDto: RequestSessionTokenBodyDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RequestSessionTokenResponseDto>> {
|
|
32030
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.sessionToken(requestSessionTokenBodyDto, options);
|
|
32031
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
32032
|
+
},
|
|
32033
|
+
}
|
|
32034
|
+
};
|
|
32035
|
+
|
|
32036
|
+
/**
|
|
32037
|
+
* DisplayApi - factory interface
|
|
32038
|
+
* @export
|
|
32039
|
+
*/
|
|
32040
|
+
export const DisplayApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
32041
|
+
const localVarFp = DisplayApiFp(configuration)
|
|
32042
|
+
return {
|
|
32043
|
+
/**
|
|
32044
|
+
*
|
|
32045
|
+
* @summary Register a customer display and mint a pairing token + code.
|
|
32046
|
+
* @param {DisplayInitBodyDto} [displayInitBodyDto]
|
|
32047
|
+
* @param {*} [options] Override http request option.
|
|
32048
|
+
* @throws {RequiredError}
|
|
32049
|
+
*/
|
|
32050
|
+
init(displayInitBodyDto?: DisplayInitBodyDto, options?: any): AxiosPromise<DisplayInitResponseDto> {
|
|
32051
|
+
return localVarFp.init(displayInitBodyDto, options).then((request) => request(axios, basePath));
|
|
32052
|
+
},
|
|
32053
|
+
/**
|
|
32054
|
+
*
|
|
32055
|
+
* @summary Pair a display with the POS using its code or QR nonce.
|
|
32056
|
+
* @param {PairDisplayBodyDto} pairDisplayBodyDto
|
|
32057
|
+
* @param {*} [options] Override http request option.
|
|
32058
|
+
* @throws {RequiredError}
|
|
32059
|
+
*/
|
|
32060
|
+
pair(pairDisplayBodyDto: PairDisplayBodyDto, options?: any): AxiosPromise<PairDisplayResponseDto> {
|
|
32061
|
+
return localVarFp.pair(pairDisplayBodyDto, options).then((request) => request(axios, basePath));
|
|
32062
|
+
},
|
|
32063
|
+
/**
|
|
32064
|
+
*
|
|
32065
|
+
* @summary Mint a session-channel Ably token scoped to the device role.
|
|
32066
|
+
* @param {RequestSessionTokenBodyDto} requestSessionTokenBodyDto
|
|
32067
|
+
* @param {*} [options] Override http request option.
|
|
32068
|
+
* @throws {RequiredError}
|
|
32069
|
+
*/
|
|
32070
|
+
sessionToken(requestSessionTokenBodyDto: RequestSessionTokenBodyDto, options?: any): AxiosPromise<RequestSessionTokenResponseDto> {
|
|
32071
|
+
return localVarFp.sessionToken(requestSessionTokenBodyDto, options).then((request) => request(axios, basePath));
|
|
32072
|
+
},
|
|
32073
|
+
};
|
|
32074
|
+
};
|
|
32075
|
+
|
|
32076
|
+
/**
|
|
32077
|
+
* DisplayApi - interface
|
|
32078
|
+
* @export
|
|
32079
|
+
* @interface DisplayApi
|
|
32080
|
+
*/
|
|
32081
|
+
export interface DisplayApiInterface {
|
|
32082
|
+
/**
|
|
32083
|
+
*
|
|
32084
|
+
* @summary Register a customer display and mint a pairing token + code.
|
|
32085
|
+
* @param {DisplayInitBodyDto} [displayInitBodyDto]
|
|
32086
|
+
* @param {*} [options] Override http request option.
|
|
32087
|
+
* @throws {RequiredError}
|
|
32088
|
+
* @memberof DisplayApiInterface
|
|
32089
|
+
*/
|
|
32090
|
+
init(displayInitBodyDto?: DisplayInitBodyDto, options?: AxiosRequestConfig): AxiosPromise<DisplayInitResponseDto>;
|
|
32091
|
+
|
|
32092
|
+
/**
|
|
32093
|
+
*
|
|
32094
|
+
* @summary Pair a display with the POS using its code or QR nonce.
|
|
32095
|
+
* @param {PairDisplayBodyDto} pairDisplayBodyDto
|
|
32096
|
+
* @param {*} [options] Override http request option.
|
|
32097
|
+
* @throws {RequiredError}
|
|
32098
|
+
* @memberof DisplayApiInterface
|
|
32099
|
+
*/
|
|
32100
|
+
pair(pairDisplayBodyDto: PairDisplayBodyDto, options?: AxiosRequestConfig): AxiosPromise<PairDisplayResponseDto>;
|
|
32101
|
+
|
|
32102
|
+
/**
|
|
32103
|
+
*
|
|
32104
|
+
* @summary Mint a session-channel Ably token scoped to the device role.
|
|
32105
|
+
* @param {RequestSessionTokenBodyDto} requestSessionTokenBodyDto
|
|
32106
|
+
* @param {*} [options] Override http request option.
|
|
32107
|
+
* @throws {RequiredError}
|
|
32108
|
+
* @memberof DisplayApiInterface
|
|
32109
|
+
*/
|
|
32110
|
+
sessionToken(requestSessionTokenBodyDto: RequestSessionTokenBodyDto, options?: AxiosRequestConfig): AxiosPromise<RequestSessionTokenResponseDto>;
|
|
32111
|
+
|
|
32112
|
+
}
|
|
32113
|
+
|
|
32114
|
+
/**
|
|
32115
|
+
* DisplayApi - object-oriented interface
|
|
32116
|
+
* @export
|
|
32117
|
+
* @class DisplayApi
|
|
32118
|
+
* @extends {BaseAPI}
|
|
32119
|
+
*/
|
|
32120
|
+
export class DisplayApi extends BaseAPI implements DisplayApiInterface {
|
|
32121
|
+
/**
|
|
32122
|
+
*
|
|
32123
|
+
* @summary Register a customer display and mint a pairing token + code.
|
|
32124
|
+
* @param {DisplayInitBodyDto} [displayInitBodyDto]
|
|
32125
|
+
* @param {*} [options] Override http request option.
|
|
32126
|
+
* @throws {RequiredError}
|
|
32127
|
+
* @memberof DisplayApi
|
|
32128
|
+
*/
|
|
32129
|
+
public init(displayInitBodyDto?: DisplayInitBodyDto, options?: AxiosRequestConfig) {
|
|
32130
|
+
return DisplayApiFp(this.configuration).init(displayInitBodyDto, options).then((request) => request(this.axios, this.basePath));
|
|
32131
|
+
}
|
|
32132
|
+
|
|
32133
|
+
/**
|
|
32134
|
+
*
|
|
32135
|
+
* @summary Pair a display with the POS using its code or QR nonce.
|
|
32136
|
+
* @param {PairDisplayBodyDto} pairDisplayBodyDto
|
|
32137
|
+
* @param {*} [options] Override http request option.
|
|
32138
|
+
* @throws {RequiredError}
|
|
32139
|
+
* @memberof DisplayApi
|
|
32140
|
+
*/
|
|
32141
|
+
public pair(pairDisplayBodyDto: PairDisplayBodyDto, options?: AxiosRequestConfig) {
|
|
32142
|
+
return DisplayApiFp(this.configuration).pair(pairDisplayBodyDto, options).then((request) => request(this.axios, this.basePath));
|
|
32143
|
+
}
|
|
32144
|
+
|
|
32145
|
+
/**
|
|
32146
|
+
*
|
|
32147
|
+
* @summary Mint a session-channel Ably token scoped to the device role.
|
|
32148
|
+
* @param {RequestSessionTokenBodyDto} requestSessionTokenBodyDto
|
|
32149
|
+
* @param {*} [options] Override http request option.
|
|
32150
|
+
* @throws {RequiredError}
|
|
32151
|
+
* @memberof DisplayApi
|
|
32152
|
+
*/
|
|
32153
|
+
public sessionToken(requestSessionTokenBodyDto: RequestSessionTokenBodyDto, options?: AxiosRequestConfig) {
|
|
32154
|
+
return DisplayApiFp(this.configuration).sessionToken(requestSessionTokenBodyDto, options).then((request) => request(this.axios, this.basePath));
|
|
32155
|
+
}
|
|
32156
|
+
}
|
|
32157
|
+
|
|
32158
|
+
|
|
31273
32159
|
/**
|
|
31274
32160
|
* EmployeesApi - axios parameter creator
|
|
31275
32161
|
* @export
|
|
@@ -34764,6 +35650,44 @@ export class KDSApi extends BaseAPI implements KDSApiInterface {
|
|
|
34764
35650
|
*/
|
|
34765
35651
|
export const KiosksApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
34766
35652
|
return {
|
|
35653
|
+
/**
|
|
35654
|
+
* 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.
|
|
35655
|
+
* @summary Get the full kiosk order snapshot by id
|
|
35656
|
+
* @param {string} orderId The unique ID of the order.
|
|
35657
|
+
* @param {string} businessId The unique ID of the business.
|
|
35658
|
+
* @param {*} [options] Override http request option.
|
|
35659
|
+
* @throws {RequiredError}
|
|
35660
|
+
*/
|
|
35661
|
+
getKioskOrder: async (orderId: string, businessId: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
35662
|
+
// verify required parameter 'orderId' is not null or undefined
|
|
35663
|
+
assertParamExists('getKioskOrder', 'orderId', orderId)
|
|
35664
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
35665
|
+
assertParamExists('getKioskOrder', 'businessId', businessId)
|
|
35666
|
+
const localVarPath = `/api/v1/kiosk/orders/{orderId}/{businessId}`
|
|
35667
|
+
.replace(`{${"orderId"}}`, encodeURIComponent(String(orderId)))
|
|
35668
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)));
|
|
35669
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
35670
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
35671
|
+
let baseOptions;
|
|
35672
|
+
if (configuration) {
|
|
35673
|
+
baseOptions = configuration.baseOptions;
|
|
35674
|
+
}
|
|
35675
|
+
|
|
35676
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
35677
|
+
const localVarHeaderParameter = {} as any;
|
|
35678
|
+
const localVarQueryParameter = {} as any;
|
|
35679
|
+
|
|
35680
|
+
|
|
35681
|
+
|
|
35682
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
35683
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
35684
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
35685
|
+
|
|
35686
|
+
return {
|
|
35687
|
+
url: toPathString(localVarUrlObj),
|
|
35688
|
+
options: localVarRequestOptions,
|
|
35689
|
+
};
|
|
35690
|
+
},
|
|
34767
35691
|
/**
|
|
34768
35692
|
*
|
|
34769
35693
|
* @param {string} orderId The unique ID of the order to validate against the system.
|
|
@@ -34838,6 +35762,42 @@ export const KiosksApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
34838
35762
|
options: localVarRequestOptions,
|
|
34839
35763
|
};
|
|
34840
35764
|
},
|
|
35765
|
+
/**
|
|
35766
|
+
*
|
|
35767
|
+
* @summary Sync a kiosk order snapshot
|
|
35768
|
+
* @param {SyncKioskOrderDto} syncKioskOrderDto
|
|
35769
|
+
* @param {*} [options] Override http request option.
|
|
35770
|
+
* @throws {RequiredError}
|
|
35771
|
+
*/
|
|
35772
|
+
syncKioskOrder: async (syncKioskOrderDto: SyncKioskOrderDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
35773
|
+
// verify required parameter 'syncKioskOrderDto' is not null or undefined
|
|
35774
|
+
assertParamExists('syncKioskOrder', 'syncKioskOrderDto', syncKioskOrderDto)
|
|
35775
|
+
const localVarPath = `/api/v1/kiosk/orders/sync`;
|
|
35776
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
35777
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
35778
|
+
let baseOptions;
|
|
35779
|
+
if (configuration) {
|
|
35780
|
+
baseOptions = configuration.baseOptions;
|
|
35781
|
+
}
|
|
35782
|
+
|
|
35783
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
35784
|
+
const localVarHeaderParameter = {} as any;
|
|
35785
|
+
const localVarQueryParameter = {} as any;
|
|
35786
|
+
|
|
35787
|
+
|
|
35788
|
+
|
|
35789
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
35790
|
+
|
|
35791
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
35792
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
35793
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
35794
|
+
localVarRequestOptions.data = serializeDataIfNeeded(syncKioskOrderDto, localVarRequestOptions, configuration)
|
|
35795
|
+
|
|
35796
|
+
return {
|
|
35797
|
+
url: toPathString(localVarUrlObj),
|
|
35798
|
+
options: localVarRequestOptions,
|
|
35799
|
+
};
|
|
35800
|
+
},
|
|
34841
35801
|
/**
|
|
34842
35802
|
*
|
|
34843
35803
|
* @param {string} terminalId The unique ID of the terminal to validate against the system.
|
|
@@ -34891,6 +35851,18 @@ export const KiosksApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
34891
35851
|
export const KiosksApiFp = function(configuration?: Configuration) {
|
|
34892
35852
|
const localVarAxiosParamCreator = KiosksApiAxiosParamCreator(configuration)
|
|
34893
35853
|
return {
|
|
35854
|
+
/**
|
|
35855
|
+
* 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.
|
|
35856
|
+
* @summary Get the full kiosk order snapshot by id
|
|
35857
|
+
* @param {string} orderId The unique ID of the order.
|
|
35858
|
+
* @param {string} businessId The unique ID of the business.
|
|
35859
|
+
* @param {*} [options] Override http request option.
|
|
35860
|
+
* @throws {RequiredError}
|
|
35861
|
+
*/
|
|
35862
|
+
async getKioskOrder(orderId: string, businessId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PosOrderDto>> {
|
|
35863
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getKioskOrder(orderId, businessId, options);
|
|
35864
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
35865
|
+
},
|
|
34894
35866
|
/**
|
|
34895
35867
|
*
|
|
34896
35868
|
* @param {string} orderId The unique ID of the order to validate against the system.
|
|
@@ -34913,6 +35885,17 @@ export const KiosksApiFp = function(configuration?: Configuration) {
|
|
|
34913
35885
|
const localVarAxiosArgs = await localVarAxiosParamCreator.recoverOrder(orderId, businessId, options);
|
|
34914
35886
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
34915
35887
|
},
|
|
35888
|
+
/**
|
|
35889
|
+
*
|
|
35890
|
+
* @summary Sync a kiosk order snapshot
|
|
35891
|
+
* @param {SyncKioskOrderDto} syncKioskOrderDto
|
|
35892
|
+
* @param {*} [options] Override http request option.
|
|
35893
|
+
* @throws {RequiredError}
|
|
35894
|
+
*/
|
|
35895
|
+
async syncKioskOrder(syncKioskOrderDto: SyncKioskOrderDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SyncKioskOrderResponseDto>> {
|
|
35896
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.syncKioskOrder(syncKioskOrderDto, options);
|
|
35897
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
35898
|
+
},
|
|
34916
35899
|
/**
|
|
34917
35900
|
*
|
|
34918
35901
|
* @param {string} terminalId The unique ID of the terminal to validate against the system.
|
|
@@ -34934,6 +35917,17 @@ export const KiosksApiFp = function(configuration?: Configuration) {
|
|
|
34934
35917
|
export const KiosksApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
34935
35918
|
const localVarFp = KiosksApiFp(configuration)
|
|
34936
35919
|
return {
|
|
35920
|
+
/**
|
|
35921
|
+
* 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.
|
|
35922
|
+
* @summary Get the full kiosk order snapshot by id
|
|
35923
|
+
* @param {string} orderId The unique ID of the order.
|
|
35924
|
+
* @param {string} businessId The unique ID of the business.
|
|
35925
|
+
* @param {*} [options] Override http request option.
|
|
35926
|
+
* @throws {RequiredError}
|
|
35927
|
+
*/
|
|
35928
|
+
getKioskOrder(orderId: string, businessId: string, options?: any): AxiosPromise<PosOrderDto> {
|
|
35929
|
+
return localVarFp.getKioskOrder(orderId, businessId, options).then((request) => request(axios, basePath));
|
|
35930
|
+
},
|
|
34937
35931
|
/**
|
|
34938
35932
|
*
|
|
34939
35933
|
* @param {string} orderId The unique ID of the order to validate against the system.
|
|
@@ -34954,6 +35948,16 @@ export const KiosksApiFactory = function (configuration?: Configuration, basePat
|
|
|
34954
35948
|
recoverOrder(orderId: string, businessId: string, options?: any): AxiosPromise<void> {
|
|
34955
35949
|
return localVarFp.recoverOrder(orderId, businessId, options).then((request) => request(axios, basePath));
|
|
34956
35950
|
},
|
|
35951
|
+
/**
|
|
35952
|
+
*
|
|
35953
|
+
* @summary Sync a kiosk order snapshot
|
|
35954
|
+
* @param {SyncKioskOrderDto} syncKioskOrderDto
|
|
35955
|
+
* @param {*} [options] Override http request option.
|
|
35956
|
+
* @throws {RequiredError}
|
|
35957
|
+
*/
|
|
35958
|
+
syncKioskOrder(syncKioskOrderDto: SyncKioskOrderDto, options?: any): AxiosPromise<SyncKioskOrderResponseDto> {
|
|
35959
|
+
return localVarFp.syncKioskOrder(syncKioskOrderDto, options).then((request) => request(axios, basePath));
|
|
35960
|
+
},
|
|
34957
35961
|
/**
|
|
34958
35962
|
*
|
|
34959
35963
|
* @param {string} terminalId The unique ID of the terminal to validate against the system.
|
|
@@ -34973,6 +35977,17 @@ export const KiosksApiFactory = function (configuration?: Configuration, basePat
|
|
|
34973
35977
|
* @interface KiosksApi
|
|
34974
35978
|
*/
|
|
34975
35979
|
export interface KiosksApiInterface {
|
|
35980
|
+
/**
|
|
35981
|
+
* 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.
|
|
35982
|
+
* @summary Get the full kiosk order snapshot by id
|
|
35983
|
+
* @param {string} orderId The unique ID of the order.
|
|
35984
|
+
* @param {string} businessId The unique ID of the business.
|
|
35985
|
+
* @param {*} [options] Override http request option.
|
|
35986
|
+
* @throws {RequiredError}
|
|
35987
|
+
* @memberof KiosksApiInterface
|
|
35988
|
+
*/
|
|
35989
|
+
getKioskOrder(orderId: string, businessId: string, options?: AxiosRequestConfig): AxiosPromise<PosOrderDto>;
|
|
35990
|
+
|
|
34976
35991
|
/**
|
|
34977
35992
|
*
|
|
34978
35993
|
* @param {string} orderId The unique ID of the order to validate against the system.
|
|
@@ -34993,6 +36008,16 @@ export interface KiosksApiInterface {
|
|
|
34993
36008
|
*/
|
|
34994
36009
|
recoverOrder(orderId: string, businessId: string, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
34995
36010
|
|
|
36011
|
+
/**
|
|
36012
|
+
*
|
|
36013
|
+
* @summary Sync a kiosk order snapshot
|
|
36014
|
+
* @param {SyncKioskOrderDto} syncKioskOrderDto
|
|
36015
|
+
* @param {*} [options] Override http request option.
|
|
36016
|
+
* @throws {RequiredError}
|
|
36017
|
+
* @memberof KiosksApiInterface
|
|
36018
|
+
*/
|
|
36019
|
+
syncKioskOrder(syncKioskOrderDto: SyncKioskOrderDto, options?: AxiosRequestConfig): AxiosPromise<SyncKioskOrderResponseDto>;
|
|
36020
|
+
|
|
34996
36021
|
/**
|
|
34997
36022
|
*
|
|
34998
36023
|
* @param {string} terminalId The unique ID of the terminal to validate against the system.
|
|
@@ -35012,6 +36037,19 @@ export interface KiosksApiInterface {
|
|
|
35012
36037
|
* @extends {BaseAPI}
|
|
35013
36038
|
*/
|
|
35014
36039
|
export class KiosksApi extends BaseAPI implements KiosksApiInterface {
|
|
36040
|
+
/**
|
|
36041
|
+
* 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.
|
|
36042
|
+
* @summary Get the full kiosk order snapshot by id
|
|
36043
|
+
* @param {string} orderId The unique ID of the order.
|
|
36044
|
+
* @param {string} businessId The unique ID of the business.
|
|
36045
|
+
* @param {*} [options] Override http request option.
|
|
36046
|
+
* @throws {RequiredError}
|
|
36047
|
+
* @memberof KiosksApi
|
|
36048
|
+
*/
|
|
36049
|
+
public getKioskOrder(orderId: string, businessId: string, options?: AxiosRequestConfig) {
|
|
36050
|
+
return KiosksApiFp(this.configuration).getKioskOrder(orderId, businessId, options).then((request) => request(this.axios, this.basePath));
|
|
36051
|
+
}
|
|
36052
|
+
|
|
35015
36053
|
/**
|
|
35016
36054
|
*
|
|
35017
36055
|
* @param {string} orderId The unique ID of the order to validate against the system.
|
|
@@ -35036,6 +36074,18 @@ export class KiosksApi extends BaseAPI implements KiosksApiInterface {
|
|
|
35036
36074
|
return KiosksApiFp(this.configuration).recoverOrder(orderId, businessId, options).then((request) => request(this.axios, this.basePath));
|
|
35037
36075
|
}
|
|
35038
36076
|
|
|
36077
|
+
/**
|
|
36078
|
+
*
|
|
36079
|
+
* @summary Sync a kiosk order snapshot
|
|
36080
|
+
* @param {SyncKioskOrderDto} syncKioskOrderDto
|
|
36081
|
+
* @param {*} [options] Override http request option.
|
|
36082
|
+
* @throws {RequiredError}
|
|
36083
|
+
* @memberof KiosksApi
|
|
36084
|
+
*/
|
|
36085
|
+
public syncKioskOrder(syncKioskOrderDto: SyncKioskOrderDto, options?: AxiosRequestConfig) {
|
|
36086
|
+
return KiosksApiFp(this.configuration).syncKioskOrder(syncKioskOrderDto, options).then((request) => request(this.axios, this.basePath));
|
|
36087
|
+
}
|
|
36088
|
+
|
|
35039
36089
|
/**
|
|
35040
36090
|
*
|
|
35041
36091
|
* @param {string} terminalId The unique ID of the terminal to validate against the system.
|
|
@@ -41057,6 +42107,48 @@ export const PaymentSessionApiAxiosParamCreator = function (configuration?: Conf
|
|
|
41057
42107
|
options: localVarRequestOptions,
|
|
41058
42108
|
};
|
|
41059
42109
|
},
|
|
42110
|
+
/**
|
|
42111
|
+
* 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).
|
|
42112
|
+
* @summary Get an order\'s paid/reconcile status (POS or kiosk)
|
|
42113
|
+
* @param {number} businessId The internal business ID.
|
|
42114
|
+
* @param {string} orderId The order ID.
|
|
42115
|
+
* @param {OrderSettlementStatusRequestDto} [orderSettlementStatusRequestDto]
|
|
42116
|
+
* @param {*} [options] Override http request option.
|
|
42117
|
+
* @throws {RequiredError}
|
|
42118
|
+
*/
|
|
42119
|
+
getOrderSettlementStatus: async (businessId: number, orderId: string, orderSettlementStatusRequestDto?: OrderSettlementStatusRequestDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
42120
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
42121
|
+
assertParamExists('getOrderSettlementStatus', 'businessId', businessId)
|
|
42122
|
+
// verify required parameter 'orderId' is not null or undefined
|
|
42123
|
+
assertParamExists('getOrderSettlementStatus', 'orderId', orderId)
|
|
42124
|
+
const localVarPath = `/api/v1/payment-session/order-settlement/{businessId}/{orderId}`
|
|
42125
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)))
|
|
42126
|
+
.replace(`{${"orderId"}}`, encodeURIComponent(String(orderId)));
|
|
42127
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
42128
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
42129
|
+
let baseOptions;
|
|
42130
|
+
if (configuration) {
|
|
42131
|
+
baseOptions = configuration.baseOptions;
|
|
42132
|
+
}
|
|
42133
|
+
|
|
42134
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
42135
|
+
const localVarHeaderParameter = {} as any;
|
|
42136
|
+
const localVarQueryParameter = {} as any;
|
|
42137
|
+
|
|
42138
|
+
|
|
42139
|
+
|
|
42140
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
42141
|
+
|
|
42142
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
42143
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
42144
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
42145
|
+
localVarRequestOptions.data = serializeDataIfNeeded(orderSettlementStatusRequestDto, localVarRequestOptions, configuration)
|
|
42146
|
+
|
|
42147
|
+
return {
|
|
42148
|
+
url: toPathString(localVarUrlObj),
|
|
42149
|
+
options: localVarRequestOptions,
|
|
42150
|
+
};
|
|
42151
|
+
},
|
|
41060
42152
|
/**
|
|
41061
42153
|
* Reads PaymentSession from Postgres. Use this to poll session lifecycle without hitting the Viva API.
|
|
41062
42154
|
* @summary Get payment session status by clientToken
|
|
@@ -41631,6 +42723,19 @@ export const PaymentSessionApiFp = function(configuration?: Configuration) {
|
|
|
41631
42723
|
const localVarAxiosArgs = await localVarAxiosParamCreator.cancelSession(clientToken, options);
|
|
41632
42724
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
41633
42725
|
},
|
|
42726
|
+
/**
|
|
42727
|
+
* 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).
|
|
42728
|
+
* @summary Get an order\'s paid/reconcile status (POS or kiosk)
|
|
42729
|
+
* @param {number} businessId The internal business ID.
|
|
42730
|
+
* @param {string} orderId The order ID.
|
|
42731
|
+
* @param {OrderSettlementStatusRequestDto} [orderSettlementStatusRequestDto]
|
|
42732
|
+
* @param {*} [options] Override http request option.
|
|
42733
|
+
* @throws {RequiredError}
|
|
42734
|
+
*/
|
|
42735
|
+
async getOrderSettlementStatus(businessId: number, orderId: string, orderSettlementStatusRequestDto?: OrderSettlementStatusRequestDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrderSettlementStatusResponseDto>> {
|
|
42736
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getOrderSettlementStatus(businessId, orderId, orderSettlementStatusRequestDto, options);
|
|
42737
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
42738
|
+
},
|
|
41634
42739
|
/**
|
|
41635
42740
|
* Reads PaymentSession from Postgres. Use this to poll session lifecycle without hitting the Viva API.
|
|
41636
42741
|
* @summary Get payment session status by clientToken
|
|
@@ -41819,6 +42924,18 @@ export const PaymentSessionApiFactory = function (configuration?: Configuration,
|
|
|
41819
42924
|
cancelSession(clientToken: string, options?: any): AxiosPromise<PaymentSessionViewDto> {
|
|
41820
42925
|
return localVarFp.cancelSession(clientToken, options).then((request) => request(axios, basePath));
|
|
41821
42926
|
},
|
|
42927
|
+
/**
|
|
42928
|
+
* 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).
|
|
42929
|
+
* @summary Get an order\'s paid/reconcile status (POS or kiosk)
|
|
42930
|
+
* @param {number} businessId The internal business ID.
|
|
42931
|
+
* @param {string} orderId The order ID.
|
|
42932
|
+
* @param {OrderSettlementStatusRequestDto} [orderSettlementStatusRequestDto]
|
|
42933
|
+
* @param {*} [options] Override http request option.
|
|
42934
|
+
* @throws {RequiredError}
|
|
42935
|
+
*/
|
|
42936
|
+
getOrderSettlementStatus(businessId: number, orderId: string, orderSettlementStatusRequestDto?: OrderSettlementStatusRequestDto, options?: any): AxiosPromise<OrderSettlementStatusResponseDto> {
|
|
42937
|
+
return localVarFp.getOrderSettlementStatus(businessId, orderId, orderSettlementStatusRequestDto, options).then((request) => request(axios, basePath));
|
|
42938
|
+
},
|
|
41822
42939
|
/**
|
|
41823
42940
|
* Reads PaymentSession from Postgres. Use this to poll session lifecycle without hitting the Viva API.
|
|
41824
42941
|
* @summary Get payment session status by clientToken
|
|
@@ -41991,6 +43108,18 @@ export interface PaymentSessionApiInterface {
|
|
|
41991
43108
|
*/
|
|
41992
43109
|
cancelSession(clientToken: string, options?: AxiosRequestConfig): AxiosPromise<PaymentSessionViewDto>;
|
|
41993
43110
|
|
|
43111
|
+
/**
|
|
43112
|
+
* 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).
|
|
43113
|
+
* @summary Get an order\'s paid/reconcile status (POS or kiosk)
|
|
43114
|
+
* @param {number} businessId The internal business ID.
|
|
43115
|
+
* @param {string} orderId The order ID.
|
|
43116
|
+
* @param {OrderSettlementStatusRequestDto} [orderSettlementStatusRequestDto]
|
|
43117
|
+
* @param {*} [options] Override http request option.
|
|
43118
|
+
* @throws {RequiredError}
|
|
43119
|
+
* @memberof PaymentSessionApiInterface
|
|
43120
|
+
*/
|
|
43121
|
+
getOrderSettlementStatus(businessId: number, orderId: string, orderSettlementStatusRequestDto?: OrderSettlementStatusRequestDto, options?: AxiosRequestConfig): AxiosPromise<OrderSettlementStatusResponseDto>;
|
|
43122
|
+
|
|
41994
43123
|
/**
|
|
41995
43124
|
* Reads PaymentSession from Postgres. Use this to poll session lifecycle without hitting the Viva API.
|
|
41996
43125
|
* @summary Get payment session status by clientToken
|
|
@@ -42165,6 +43294,20 @@ export class PaymentSessionApi extends BaseAPI implements PaymentSessionApiInter
|
|
|
42165
43294
|
return PaymentSessionApiFp(this.configuration).cancelSession(clientToken, options).then((request) => request(this.axios, this.basePath));
|
|
42166
43295
|
}
|
|
42167
43296
|
|
|
43297
|
+
/**
|
|
43298
|
+
* 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).
|
|
43299
|
+
* @summary Get an order\'s paid/reconcile status (POS or kiosk)
|
|
43300
|
+
* @param {number} businessId The internal business ID.
|
|
43301
|
+
* @param {string} orderId The order ID.
|
|
43302
|
+
* @param {OrderSettlementStatusRequestDto} [orderSettlementStatusRequestDto]
|
|
43303
|
+
* @param {*} [options] Override http request option.
|
|
43304
|
+
* @throws {RequiredError}
|
|
43305
|
+
* @memberof PaymentSessionApi
|
|
43306
|
+
*/
|
|
43307
|
+
public getOrderSettlementStatus(businessId: number, orderId: string, orderSettlementStatusRequestDto?: OrderSettlementStatusRequestDto, options?: AxiosRequestConfig) {
|
|
43308
|
+
return PaymentSessionApiFp(this.configuration).getOrderSettlementStatus(businessId, orderId, orderSettlementStatusRequestDto, options).then((request) => request(this.axios, this.basePath));
|
|
43309
|
+
}
|
|
43310
|
+
|
|
42168
43311
|
/**
|
|
42169
43312
|
* Reads PaymentSession from Postgres. Use this to poll session lifecycle without hitting the Viva API.
|
|
42170
43313
|
* @summary Get payment session status by clientToken
|