@munchi_oy/core 2.6.0 → 2.6.1
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 +701 -16
- 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 +871 -16
- package/package.json +1 -1
- package/src/version.ts +1 -1
package/generated/api.ts
CHANGED
|
@@ -2687,6 +2687,12 @@ export interface ChangeKioskDto {
|
|
|
2687
2687
|
* @memberof ChangeKioskDto
|
|
2688
2688
|
*/
|
|
2689
2689
|
'prefix'?: string;
|
|
2690
|
+
/**
|
|
2691
|
+
*
|
|
2692
|
+
* @type {KioskDeviceType}
|
|
2693
|
+
* @memberof ChangeKioskDto
|
|
2694
|
+
*/
|
|
2695
|
+
'deviceType'?: KioskDeviceType;
|
|
2690
2696
|
/**
|
|
2691
2697
|
*
|
|
2692
2698
|
* @type {Status}
|
|
@@ -3196,7 +3202,15 @@ export interface ClaimKioskDto {
|
|
|
3196
3202
|
* @memberof ClaimKioskDto
|
|
3197
3203
|
*/
|
|
3198
3204
|
'prefix'?: string;
|
|
3205
|
+
/**
|
|
3206
|
+
*
|
|
3207
|
+
* @type {KioskDeviceType}
|
|
3208
|
+
* @memberof ClaimKioskDto
|
|
3209
|
+
*/
|
|
3210
|
+
'deviceType'?: KioskDeviceType;
|
|
3199
3211
|
}
|
|
3212
|
+
|
|
3213
|
+
|
|
3200
3214
|
/**
|
|
3201
3215
|
*
|
|
3202
3216
|
* @export
|
|
@@ -9365,6 +9379,49 @@ export interface InitiateVivaSessionResponseDtoVivaIntent {
|
|
|
9365
9379
|
}
|
|
9366
9380
|
|
|
9367
9381
|
|
|
9382
|
+
/**
|
|
9383
|
+
*
|
|
9384
|
+
* @export
|
|
9385
|
+
* @interface InitiateWorldlineA2aSessionDto
|
|
9386
|
+
*/
|
|
9387
|
+
export interface InitiateWorldlineA2aSessionDto {
|
|
9388
|
+
/**
|
|
9389
|
+
*
|
|
9390
|
+
* @type {CreateManualSessionDtoDevice}
|
|
9391
|
+
* @memberof InitiateWorldlineA2aSessionDto
|
|
9392
|
+
*/
|
|
9393
|
+
'device'?: CreateManualSessionDtoDevice | null;
|
|
9394
|
+
/**
|
|
9395
|
+
* The internal business ID.
|
|
9396
|
+
* @type {number}
|
|
9397
|
+
* @memberof InitiateWorldlineA2aSessionDto
|
|
9398
|
+
*/
|
|
9399
|
+
'businessId': number;
|
|
9400
|
+
/**
|
|
9401
|
+
* The POS order ID this payment session is for.
|
|
9402
|
+
* @type {string}
|
|
9403
|
+
* @memberof InitiateWorldlineA2aSessionDto
|
|
9404
|
+
*/
|
|
9405
|
+
'orderId': string;
|
|
9406
|
+
/**
|
|
9407
|
+
* Amount to charge in smallest currency unit (cents).
|
|
9408
|
+
* @type {number}
|
|
9409
|
+
* @memberof InitiateWorldlineA2aSessionDto
|
|
9410
|
+
*/
|
|
9411
|
+
'amount': number;
|
|
9412
|
+
/**
|
|
9413
|
+
* Optional tip amount in the smallest currency unit (cents).
|
|
9414
|
+
* @type {number}
|
|
9415
|
+
* @memberof InitiateWorldlineA2aSessionDto
|
|
9416
|
+
*/
|
|
9417
|
+
'tipAmount'?: number;
|
|
9418
|
+
/**
|
|
9419
|
+
*
|
|
9420
|
+
* @type {CreateManualSessionDtoSplitContext}
|
|
9421
|
+
* @memberof InitiateWorldlineA2aSessionDto
|
|
9422
|
+
*/
|
|
9423
|
+
'splitContext'?: CreateManualSessionDtoSplitContext;
|
|
9424
|
+
}
|
|
9368
9425
|
/**
|
|
9369
9426
|
*
|
|
9370
9427
|
* @export
|
|
@@ -11400,6 +11457,20 @@ export interface KdsStationDto {
|
|
|
11400
11457
|
}
|
|
11401
11458
|
|
|
11402
11459
|
|
|
11460
|
+
/**
|
|
11461
|
+
*
|
|
11462
|
+
* @export
|
|
11463
|
+
* @enum {string}
|
|
11464
|
+
*/
|
|
11465
|
+
|
|
11466
|
+
export const KioskDeviceType = {
|
|
11467
|
+
Tablet: 'TABLET',
|
|
11468
|
+
KioskStand: 'KIOSK_STAND'
|
|
11469
|
+
} as const;
|
|
11470
|
+
|
|
11471
|
+
export type KioskDeviceType = typeof KioskDeviceType[keyof typeof KioskDeviceType];
|
|
11472
|
+
|
|
11473
|
+
|
|
11403
11474
|
/**
|
|
11404
11475
|
*
|
|
11405
11476
|
* @export
|
|
@@ -25533,6 +25604,130 @@ export const RecordManualStatus = {
|
|
|
25533
25604
|
export type RecordManualStatus = typeof RecordManualStatus[keyof typeof RecordManualStatus];
|
|
25534
25605
|
|
|
25535
25606
|
|
|
25607
|
+
/**
|
|
25608
|
+
*
|
|
25609
|
+
* @export
|
|
25610
|
+
* @interface RecordWorldlineA2aResultDto
|
|
25611
|
+
*/
|
|
25612
|
+
export interface RecordWorldlineA2aResultDto {
|
|
25613
|
+
/**
|
|
25614
|
+
* The sessionId the start, refund or revert route answered, which the payment app was given as its reference.
|
|
25615
|
+
* @type {string}
|
|
25616
|
+
* @memberof RecordWorldlineA2aResultDto
|
|
25617
|
+
*/
|
|
25618
|
+
'sessionId': string;
|
|
25619
|
+
/**
|
|
25620
|
+
*
|
|
25621
|
+
* @type {RecordWorldlineA2aResultDtoAnswer}
|
|
25622
|
+
* @memberof RecordWorldlineA2aResultDto
|
|
25623
|
+
*/
|
|
25624
|
+
'answer': RecordWorldlineA2aResultDtoAnswer;
|
|
25625
|
+
}
|
|
25626
|
+
/**
|
|
25627
|
+
* The payment app\'s answer (WPI_RESPONSE), parsed from its JSON.
|
|
25628
|
+
* @export
|
|
25629
|
+
* @interface RecordWorldlineA2aResultDtoAnswer
|
|
25630
|
+
*/
|
|
25631
|
+
export interface RecordWorldlineA2aResultDtoAnswer {
|
|
25632
|
+
/**
|
|
25633
|
+
*
|
|
25634
|
+
* @type {WorldlineAppResult}
|
|
25635
|
+
* @memberof RecordWorldlineA2aResultDtoAnswer
|
|
25636
|
+
*/
|
|
25637
|
+
'result': WorldlineAppResult;
|
|
25638
|
+
/**
|
|
25639
|
+
* Why the transaction failed, as the payment app names it (WPI_ERR_COND_…). WPI_ERR_COND_USER_CANCEL ends the session CANCELLED; any other failure ends it FAILED. Absent on an approval.
|
|
25640
|
+
* @type {string}
|
|
25641
|
+
* @memberof RecordWorldlineA2aResultDtoAnswer
|
|
25642
|
+
*/
|
|
25643
|
+
'errorCondition'?: string;
|
|
25644
|
+
/**
|
|
25645
|
+
* The payment app\'s free-text remark on the transaction, if any.
|
|
25646
|
+
* @type {string}
|
|
25647
|
+
* @memberof RecordWorldlineA2aResultDtoAnswer
|
|
25648
|
+
*/
|
|
25649
|
+
'remark'?: string;
|
|
25650
|
+
/**
|
|
25651
|
+
* The reference the payment app was given, which it echoes: the session\'s sessionId. Required on a sale\'s or a refund\'s answer, which is refused when it is not the session\'s. Absent on a revert\'s answer: WPI_SVC_CANCEL_PAYMENT takes no reference.
|
|
25652
|
+
* @type {string}
|
|
25653
|
+
* @memberof RecordWorldlineA2aResultDtoAnswer
|
|
25654
|
+
*/
|
|
25655
|
+
'reference'?: string;
|
|
25656
|
+
/**
|
|
25657
|
+
* When the payment app ran the transaction, ISO 8601, as the device\'s clock says. Kept in the stored answer only; the payment event\'s time is the server\'s.
|
|
25658
|
+
* @type {string}
|
|
25659
|
+
* @memberof RecordWorldlineA2aResultDtoAnswer
|
|
25660
|
+
*/
|
|
25661
|
+
'timestamp'?: string;
|
|
25662
|
+
/**
|
|
25663
|
+
* The currency charged, ISO 4217 alpha code. Required on an approval, and must be the session\'s.
|
|
25664
|
+
* @type {string}
|
|
25665
|
+
* @memberof RecordWorldlineA2aResultDtoAnswer
|
|
25666
|
+
*/
|
|
25667
|
+
'currency'?: string;
|
|
25668
|
+
/**
|
|
25669
|
+
* What the card was charged, in the smallest currency unit (cents), every tip included. Required on a sale\'s or a refund\'s approval: a sale\'s must be the session\'s amount plus its tip, or that plus the tipAmount the cardholder added on the payment app; a refund\'s must be the refund\'s amount. A sale\'s or a refund\'s approval that does not match is refused, kept on the session and alerted to ops. Not checked on a revert, which cancels the whole sale.
|
|
25670
|
+
* @type {number}
|
|
25671
|
+
* @memberof RecordWorldlineA2aResultDtoAnswer
|
|
25672
|
+
*/
|
|
25673
|
+
'authorizedAmount'?: number;
|
|
25674
|
+
/**
|
|
25675
|
+
* The tip the cardholder entered on the payment app, or the one the request sent, in the smallest currency unit (cents). A tip added on the payment app is recorded with the session\'s tip, as a fee of the payment event.
|
|
25676
|
+
* @type {number}
|
|
25677
|
+
* @memberof RecordWorldlineA2aResultDtoAnswer
|
|
25678
|
+
*/
|
|
25679
|
+
'tipAmount'?: number;
|
|
25680
|
+
/**
|
|
25681
|
+
* The card brand.
|
|
25682
|
+
* @type {string}
|
|
25683
|
+
* @memberof RecordWorldlineA2aResultDtoAnswer
|
|
25684
|
+
*/
|
|
25685
|
+
'brandName'?: string;
|
|
25686
|
+
/**
|
|
25687
|
+
* The card application\'s label.
|
|
25688
|
+
* @type {string}
|
|
25689
|
+
* @memberof RecordWorldlineA2aResultDtoAnswer
|
|
25690
|
+
*/
|
|
25691
|
+
'applicationLabel'?: string;
|
|
25692
|
+
/**
|
|
25693
|
+
* The card application\'s identifier (AID).
|
|
25694
|
+
* @type {string}
|
|
25695
|
+
* @memberof RecordWorldlineA2aResultDtoAnswer
|
|
25696
|
+
*/
|
|
25697
|
+
'applicationIdentifier'?: string;
|
|
25698
|
+
/**
|
|
25699
|
+
* The payment app\'s own id of the transaction. Required on an approval. On a sale or a refund it becomes the session\'s providerTransactionId, and one id settles one session only. On a revert it is the cancelled sale\'s id and must be the sale\'s; it is kept in the stored answer only.
|
|
25700
|
+
* @type {string}
|
|
25701
|
+
* @memberof RecordWorldlineA2aResultDtoAnswer
|
|
25702
|
+
*/
|
|
25703
|
+
'paymentSolutionReference'?: string;
|
|
25704
|
+
/**
|
|
25705
|
+
* The issuer\'s authorisation code.
|
|
25706
|
+
* @type {string}
|
|
25707
|
+
* @memberof RecordWorldlineA2aResultDtoAnswer
|
|
25708
|
+
*/
|
|
25709
|
+
'authorizationCode'?: string;
|
|
25710
|
+
/**
|
|
25711
|
+
* The merchant id the payment app charged under. Kept, not checked.
|
|
25712
|
+
* @type {string}
|
|
25713
|
+
* @memberof RecordWorldlineA2aResultDtoAnswer
|
|
25714
|
+
*/
|
|
25715
|
+
'merchantIdentifier'?: string;
|
|
25716
|
+
/**
|
|
25717
|
+
* The terminal id the payment app charged on. Kept, not checked.
|
|
25718
|
+
* @type {string}
|
|
25719
|
+
* @memberof RecordWorldlineA2aResultDtoAnswer
|
|
25720
|
+
*/
|
|
25721
|
+
'terminalIdentifier'?: string;
|
|
25722
|
+
/**
|
|
25723
|
+
* The card number, masked by the payment app: at most the first 6 digits, then * or X, then the last 4. A full card number is refused.
|
|
25724
|
+
* @type {string}
|
|
25725
|
+
* @memberof RecordWorldlineA2aResultDtoAnswer
|
|
25726
|
+
*/
|
|
25727
|
+
'pan'?: string;
|
|
25728
|
+
}
|
|
25729
|
+
|
|
25730
|
+
|
|
25536
25731
|
/**
|
|
25537
25732
|
*
|
|
25538
25733
|
* @export
|
|
@@ -27314,7 +27509,7 @@ export interface RestoreLoyaltyRedemptionDto {
|
|
|
27314
27509
|
*/
|
|
27315
27510
|
'businessId': number;
|
|
27316
27511
|
/**
|
|
27317
|
-
* The id of the POS or kiosk order that carries the redemption
|
|
27512
|
+
* The id of the POS or kiosk order, or the code of the website order (its externalId), that carries the redemption
|
|
27318
27513
|
* @type {string}
|
|
27319
27514
|
* @memberof RestoreLoyaltyRedemptionDto
|
|
27320
27515
|
*/
|
|
@@ -36859,6 +37054,12 @@ export interface VenueKioskDto {
|
|
|
36859
37054
|
* @memberof VenueKioskDto
|
|
36860
37055
|
*/
|
|
36861
37056
|
'hardwareId': string;
|
|
37057
|
+
/**
|
|
37058
|
+
*
|
|
37059
|
+
* @type {DeviceType}
|
|
37060
|
+
* @memberof VenueKioskDto
|
|
37061
|
+
*/
|
|
37062
|
+
'deviceType': DeviceType;
|
|
36862
37063
|
/**
|
|
36863
37064
|
*
|
|
36864
37065
|
* @type {Status}
|
|
@@ -39165,6 +39366,216 @@ export interface WoltSwitchesTaskDto {
|
|
|
39165
39366
|
*/
|
|
39166
39367
|
'orderingBusinessId': string;
|
|
39167
39368
|
}
|
|
39369
|
+
/**
|
|
39370
|
+
*
|
|
39371
|
+
* @export
|
|
39372
|
+
* @interface WorldlineA2aResultViewDto
|
|
39373
|
+
*/
|
|
39374
|
+
export interface WorldlineA2aResultViewDto {
|
|
39375
|
+
/**
|
|
39376
|
+
* Opaque client token.
|
|
39377
|
+
* @type {string}
|
|
39378
|
+
* @memberof WorldlineA2aResultViewDto
|
|
39379
|
+
*/
|
|
39380
|
+
'clientToken': string;
|
|
39381
|
+
/**
|
|
39382
|
+
* Internal session ID.
|
|
39383
|
+
* @type {string}
|
|
39384
|
+
* @memberof WorldlineA2aResultViewDto
|
|
39385
|
+
*/
|
|
39386
|
+
'sessionId': string;
|
|
39387
|
+
/**
|
|
39388
|
+
* Viva transaction ID set after webhook completes.
|
|
39389
|
+
* @type {string}
|
|
39390
|
+
* @memberof WorldlineA2aResultViewDto
|
|
39391
|
+
*/
|
|
39392
|
+
'providerTransactionId'?: string;
|
|
39393
|
+
/**
|
|
39394
|
+
*
|
|
39395
|
+
* @type {PaymentSessionStatus}
|
|
39396
|
+
* @memberof WorldlineA2aResultViewDto
|
|
39397
|
+
*/
|
|
39398
|
+
'status': PaymentSessionStatus;
|
|
39399
|
+
/**
|
|
39400
|
+
* Amount in cents.
|
|
39401
|
+
* @type {number}
|
|
39402
|
+
* @memberof WorldlineA2aResultViewDto
|
|
39403
|
+
*/
|
|
39404
|
+
'amount': number;
|
|
39405
|
+
/**
|
|
39406
|
+
* Currency.
|
|
39407
|
+
* @type {string}
|
|
39408
|
+
* @memberof WorldlineA2aResultViewDto
|
|
39409
|
+
*/
|
|
39410
|
+
'currency': string;
|
|
39411
|
+
/**
|
|
39412
|
+
* Tip amount (cents).
|
|
39413
|
+
* @type {number}
|
|
39414
|
+
* @memberof WorldlineA2aResultViewDto
|
|
39415
|
+
*/
|
|
39416
|
+
'tipAmount': number;
|
|
39417
|
+
/**
|
|
39418
|
+
* Surcharge amount (cents).
|
|
39419
|
+
* @type {number}
|
|
39420
|
+
* @memberof WorldlineA2aResultViewDto
|
|
39421
|
+
*/
|
|
39422
|
+
'surchargeAmount': number;
|
|
39423
|
+
/**
|
|
39424
|
+
* Error code if failed.
|
|
39425
|
+
* @type {string}
|
|
39426
|
+
* @memberof WorldlineA2aResultViewDto
|
|
39427
|
+
*/
|
|
39428
|
+
'errorCode'?: string;
|
|
39429
|
+
/**
|
|
39430
|
+
* Error message if failed.
|
|
39431
|
+
* @type {string}
|
|
39432
|
+
* @memberof WorldlineA2aResultViewDto
|
|
39433
|
+
*/
|
|
39434
|
+
'errorMessage'?: string;
|
|
39435
|
+
/**
|
|
39436
|
+
* When the session was started (ISO 8601, UTC).
|
|
39437
|
+
* @type {string}
|
|
39438
|
+
* @memberof WorldlineA2aResultViewDto
|
|
39439
|
+
*/
|
|
39440
|
+
'createdAt': string;
|
|
39441
|
+
/**
|
|
39442
|
+
* When the session last changed (ISO 8601, UTC).
|
|
39443
|
+
* @type {string}
|
|
39444
|
+
* @memberof WorldlineA2aResultViewDto
|
|
39445
|
+
*/
|
|
39446
|
+
'updatedAt': string;
|
|
39447
|
+
/**
|
|
39448
|
+
* When the sale was written to the order and closed (ISO 8601, UTC); null while it is not.
|
|
39449
|
+
* @type {string}
|
|
39450
|
+
* @memberof WorldlineA2aResultViewDto
|
|
39451
|
+
*/
|
|
39452
|
+
'closedAt'?: string;
|
|
39453
|
+
/**
|
|
39454
|
+
*
|
|
39455
|
+
* @type {WorldlineA2aResultViewDtoTransaction}
|
|
39456
|
+
* @memberof WorldlineA2aResultViewDto
|
|
39457
|
+
*/
|
|
39458
|
+
'transaction'?: WorldlineA2aResultViewDtoTransaction;
|
|
39459
|
+
}
|
|
39460
|
+
|
|
39461
|
+
|
|
39462
|
+
/**
|
|
39463
|
+
* The payment event the order receives for this sale, built from the payment app\'s approval: the session\'s amount, the tip as a fee, the card\'s details. Present while the session is a paid sale (SUCCESS or CLOSED), a repeated answer included; absent for a failure, a cancel, a refund or a revert.
|
|
39464
|
+
* @export
|
|
39465
|
+
* @interface WorldlineA2aResultViewDtoTransaction
|
|
39466
|
+
*/
|
|
39467
|
+
export interface WorldlineA2aResultViewDtoTransaction {
|
|
39468
|
+
/**
|
|
39469
|
+
* Id of this payment: the payment provider\'s transaction id for a card payment, or an id the till made
|
|
39470
|
+
* @type {string}
|
|
39471
|
+
* @memberof WorldlineA2aResultViewDtoTransaction
|
|
39472
|
+
*/
|
|
39473
|
+
'id': string;
|
|
39474
|
+
/**
|
|
39475
|
+
* The payment\'s reference: the provider\'s session or merchant reference for a card payment, or, on a reversal, the id of the payment it reverses; null when there is none
|
|
39476
|
+
* @type {string}
|
|
39477
|
+
* @memberof WorldlineA2aResultViewDtoTransaction
|
|
39478
|
+
*/
|
|
39479
|
+
'referenceId': string | null;
|
|
39480
|
+
/**
|
|
39481
|
+
*
|
|
39482
|
+
* @type {PaymentProvider}
|
|
39483
|
+
* @memberof WorldlineA2aResultViewDtoTransaction
|
|
39484
|
+
*/
|
|
39485
|
+
'provider': PaymentProvider;
|
|
39486
|
+
/**
|
|
39487
|
+
*
|
|
39488
|
+
* @type {PaymentMethod}
|
|
39489
|
+
* @memberof WorldlineA2aResultViewDtoTransaction
|
|
39490
|
+
*/
|
|
39491
|
+
'type': PaymentMethod;
|
|
39492
|
+
/**
|
|
39493
|
+
*
|
|
39494
|
+
* @type {PaymentOutcomeStatus}
|
|
39495
|
+
* @memberof WorldlineA2aResultViewDtoTransaction
|
|
39496
|
+
*/
|
|
39497
|
+
'paymentOutcomeStatus'?: PaymentOutcomeStatus;
|
|
39498
|
+
/**
|
|
39499
|
+
* Amount paid in cents
|
|
39500
|
+
* @type {number}
|
|
39501
|
+
* @memberof WorldlineA2aResultViewDtoTransaction
|
|
39502
|
+
*/
|
|
39503
|
+
'amount': number;
|
|
39504
|
+
/**
|
|
39505
|
+
* Difference from cash rounding in cents
|
|
39506
|
+
* @type {number}
|
|
39507
|
+
* @memberof WorldlineA2aResultViewDtoTransaction
|
|
39508
|
+
*/
|
|
39509
|
+
'roundingDifference': number;
|
|
39510
|
+
/**
|
|
39511
|
+
* Raw data from payment provider, as it sent it
|
|
39512
|
+
* @type {object}
|
|
39513
|
+
* @memberof WorldlineA2aResultViewDtoTransaction
|
|
39514
|
+
*/
|
|
39515
|
+
'rawData': object;
|
|
39516
|
+
/**
|
|
39517
|
+
* When the payment was taken
|
|
39518
|
+
* @type {string}
|
|
39519
|
+
* @memberof WorldlineA2aResultViewDtoTransaction
|
|
39520
|
+
*/
|
|
39521
|
+
'createdAt': string;
|
|
39522
|
+
/**
|
|
39523
|
+
*
|
|
39524
|
+
* @type {TransactionDtoCardDetail}
|
|
39525
|
+
* @memberof WorldlineA2aResultViewDtoTransaction
|
|
39526
|
+
*/
|
|
39527
|
+
'cardDetail': TransactionDtoCardDetail | null;
|
|
39528
|
+
/**
|
|
39529
|
+
* The monetary amount of the voucher value that was *not* used and *not* refunded to the customer (i.e., the overage). This is applicable only when a voucher is used and its value exceeds the order total.
|
|
39530
|
+
* @type {number}
|
|
39531
|
+
* @memberof WorldlineA2aResultViewDtoTransaction
|
|
39532
|
+
*/
|
|
39533
|
+
'voucherForfeitedAmount'?: number | null;
|
|
39534
|
+
/**
|
|
39535
|
+
* The specific line items this transaction paid for. If null or empty, it was a pooled payment against the total bill.
|
|
39536
|
+
* @type {Array<string>}
|
|
39537
|
+
* @memberof WorldlineA2aResultViewDtoTransaction
|
|
39538
|
+
*/
|
|
39539
|
+
'lineItemIds'?: Array<string> | null;
|
|
39540
|
+
/**
|
|
39541
|
+
* The specific split part this transaction paid for. If null, it was not a payment for a split part.
|
|
39542
|
+
* @type {string}
|
|
39543
|
+
* @memberof WorldlineA2aResultViewDtoTransaction
|
|
39544
|
+
*/
|
|
39545
|
+
'splitPartId'?: string | null;
|
|
39546
|
+
/**
|
|
39547
|
+
* Detailed settlement allocations for this transaction. Use this for accurate refund and reconciliation logic, especially when one line item is split across multiple payments.
|
|
39548
|
+
* @type {Array<TransactionItemAllocationDto>}
|
|
39549
|
+
* @memberof WorldlineA2aResultViewDtoTransaction
|
|
39550
|
+
*/
|
|
39551
|
+
'itemAllocations'?: Array<TransactionItemAllocationDto> | null;
|
|
39552
|
+
/**
|
|
39553
|
+
*
|
|
39554
|
+
* @type {TransactionDtoDevice}
|
|
39555
|
+
* @memberof WorldlineA2aResultViewDtoTransaction
|
|
39556
|
+
*/
|
|
39557
|
+
'device'?: TransactionDtoDevice | null;
|
|
39558
|
+
/**
|
|
39559
|
+
*
|
|
39560
|
+
* @type {TransactionDtoCapturedBy}
|
|
39561
|
+
* @memberof WorldlineA2aResultViewDtoTransaction
|
|
39562
|
+
*/
|
|
39563
|
+
'capturedBy'?: TransactionDtoCapturedBy | null;
|
|
39564
|
+
/**
|
|
39565
|
+
* Indicates whether this transaction was processed as a pre-authorization.
|
|
39566
|
+
* @type {string}
|
|
39567
|
+
* @memberof WorldlineA2aResultViewDtoTransaction
|
|
39568
|
+
*/
|
|
39569
|
+
'label': string | null;
|
|
39570
|
+
/**
|
|
39571
|
+
*
|
|
39572
|
+
* @type {TransactionDtoFees}
|
|
39573
|
+
* @memberof WorldlineA2aResultViewDtoTransaction
|
|
39574
|
+
*/
|
|
39575
|
+
'fees'?: TransactionDtoFees | null;
|
|
39576
|
+
}
|
|
39577
|
+
|
|
39578
|
+
|
|
39168
39579
|
/**
|
|
39169
39580
|
*
|
|
39170
39581
|
* @export
|
|
@@ -39190,6 +39601,125 @@ export interface WorldlineAmountsRequestDto {
|
|
|
39190
39601
|
*/
|
|
39191
39602
|
'tip'?: number;
|
|
39192
39603
|
}
|
|
39604
|
+
/**
|
|
39605
|
+
*
|
|
39606
|
+
* @export
|
|
39607
|
+
* @interface WorldlineAppAnswerDto
|
|
39608
|
+
*/
|
|
39609
|
+
export interface WorldlineAppAnswerDto {
|
|
39610
|
+
/**
|
|
39611
|
+
*
|
|
39612
|
+
* @type {WorldlineAppResult}
|
|
39613
|
+
* @memberof WorldlineAppAnswerDto
|
|
39614
|
+
*/
|
|
39615
|
+
'result': WorldlineAppResult;
|
|
39616
|
+
/**
|
|
39617
|
+
* Why the transaction failed, as the payment app names it (WPI_ERR_COND_…). WPI_ERR_COND_USER_CANCEL ends the session CANCELLED; any other failure ends it FAILED. Absent on an approval.
|
|
39618
|
+
* @type {string}
|
|
39619
|
+
* @memberof WorldlineAppAnswerDto
|
|
39620
|
+
*/
|
|
39621
|
+
'errorCondition'?: string;
|
|
39622
|
+
/**
|
|
39623
|
+
* The payment app\'s free-text remark on the transaction, if any.
|
|
39624
|
+
* @type {string}
|
|
39625
|
+
* @memberof WorldlineAppAnswerDto
|
|
39626
|
+
*/
|
|
39627
|
+
'remark'?: string;
|
|
39628
|
+
/**
|
|
39629
|
+
* The reference the payment app was given, which it echoes: the session\'s sessionId. Required on a sale\'s or a refund\'s answer, which is refused when it is not the session\'s. Absent on a revert\'s answer: WPI_SVC_CANCEL_PAYMENT takes no reference.
|
|
39630
|
+
* @type {string}
|
|
39631
|
+
* @memberof WorldlineAppAnswerDto
|
|
39632
|
+
*/
|
|
39633
|
+
'reference'?: string;
|
|
39634
|
+
/**
|
|
39635
|
+
* When the payment app ran the transaction, ISO 8601, as the device\'s clock says. Kept in the stored answer only; the payment event\'s time is the server\'s.
|
|
39636
|
+
* @type {string}
|
|
39637
|
+
* @memberof WorldlineAppAnswerDto
|
|
39638
|
+
*/
|
|
39639
|
+
'timestamp'?: string;
|
|
39640
|
+
/**
|
|
39641
|
+
* The currency charged, ISO 4217 alpha code. Required on an approval, and must be the session\'s.
|
|
39642
|
+
* @type {string}
|
|
39643
|
+
* @memberof WorldlineAppAnswerDto
|
|
39644
|
+
*/
|
|
39645
|
+
'currency'?: string;
|
|
39646
|
+
/**
|
|
39647
|
+
* What the card was charged, in the smallest currency unit (cents), every tip included. Required on a sale\'s or a refund\'s approval: a sale\'s must be the session\'s amount plus its tip, or that plus the tipAmount the cardholder added on the payment app; a refund\'s must be the refund\'s amount. A sale\'s or a refund\'s approval that does not match is refused, kept on the session and alerted to ops. Not checked on a revert, which cancels the whole sale.
|
|
39648
|
+
* @type {number}
|
|
39649
|
+
* @memberof WorldlineAppAnswerDto
|
|
39650
|
+
*/
|
|
39651
|
+
'authorizedAmount'?: number;
|
|
39652
|
+
/**
|
|
39653
|
+
* The tip the cardholder entered on the payment app, or the one the request sent, in the smallest currency unit (cents). A tip added on the payment app is recorded with the session\'s tip, as a fee of the payment event.
|
|
39654
|
+
* @type {number}
|
|
39655
|
+
* @memberof WorldlineAppAnswerDto
|
|
39656
|
+
*/
|
|
39657
|
+
'tipAmount'?: number;
|
|
39658
|
+
/**
|
|
39659
|
+
* The card brand.
|
|
39660
|
+
* @type {string}
|
|
39661
|
+
* @memberof WorldlineAppAnswerDto
|
|
39662
|
+
*/
|
|
39663
|
+
'brandName'?: string;
|
|
39664
|
+
/**
|
|
39665
|
+
* The card application\'s label.
|
|
39666
|
+
* @type {string}
|
|
39667
|
+
* @memberof WorldlineAppAnswerDto
|
|
39668
|
+
*/
|
|
39669
|
+
'applicationLabel'?: string;
|
|
39670
|
+
/**
|
|
39671
|
+
* The card application\'s identifier (AID).
|
|
39672
|
+
* @type {string}
|
|
39673
|
+
* @memberof WorldlineAppAnswerDto
|
|
39674
|
+
*/
|
|
39675
|
+
'applicationIdentifier'?: string;
|
|
39676
|
+
/**
|
|
39677
|
+
* The payment app\'s own id of the transaction. Required on an approval. On a sale or a refund it becomes the session\'s providerTransactionId, and one id settles one session only. On a revert it is the cancelled sale\'s id and must be the sale\'s; it is kept in the stored answer only.
|
|
39678
|
+
* @type {string}
|
|
39679
|
+
* @memberof WorldlineAppAnswerDto
|
|
39680
|
+
*/
|
|
39681
|
+
'paymentSolutionReference'?: string;
|
|
39682
|
+
/**
|
|
39683
|
+
* The issuer\'s authorisation code.
|
|
39684
|
+
* @type {string}
|
|
39685
|
+
* @memberof WorldlineAppAnswerDto
|
|
39686
|
+
*/
|
|
39687
|
+
'authorizationCode'?: string;
|
|
39688
|
+
/**
|
|
39689
|
+
* The merchant id the payment app charged under. Kept, not checked.
|
|
39690
|
+
* @type {string}
|
|
39691
|
+
* @memberof WorldlineAppAnswerDto
|
|
39692
|
+
*/
|
|
39693
|
+
'merchantIdentifier'?: string;
|
|
39694
|
+
/**
|
|
39695
|
+
* The terminal id the payment app charged on. Kept, not checked.
|
|
39696
|
+
* @type {string}
|
|
39697
|
+
* @memberof WorldlineAppAnswerDto
|
|
39698
|
+
*/
|
|
39699
|
+
'terminalIdentifier'?: string;
|
|
39700
|
+
/**
|
|
39701
|
+
* The card number, masked by the payment app: at most the first 6 digits, then * or X, then the last 4. A full card number is refused.
|
|
39702
|
+
* @type {string}
|
|
39703
|
+
* @memberof WorldlineAppAnswerDto
|
|
39704
|
+
*/
|
|
39705
|
+
'pan'?: string;
|
|
39706
|
+
}
|
|
39707
|
+
|
|
39708
|
+
|
|
39709
|
+
/**
|
|
39710
|
+
*
|
|
39711
|
+
* @export
|
|
39712
|
+
* @enum {string}
|
|
39713
|
+
*/
|
|
39714
|
+
|
|
39715
|
+
export const WorldlineAppResult = {
|
|
39716
|
+
Success: 'WPI_RESULT_SUCCESS',
|
|
39717
|
+
Failure: 'WPI_RESULT_FAILURE'
|
|
39718
|
+
} as const;
|
|
39719
|
+
|
|
39720
|
+
export type WorldlineAppResult = typeof WorldlineAppResult[keyof typeof WorldlineAppResult];
|
|
39721
|
+
|
|
39722
|
+
|
|
39193
39723
|
/**
|
|
39194
39724
|
*
|
|
39195
39725
|
* @export
|
|
@@ -51744,7 +52274,7 @@ export class KiosksApi extends BaseAPI implements KiosksApiInterface {
|
|
|
51744
52274
|
export const LoyaltyCommerceApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
51745
52275
|
return {
|
|
51746
52276
|
/**
|
|
51747
|
-
* The till\'s Restore reward button. The order is read from the POS orders, else from the kiosk orders, and the loyalty ledger is asked to give the points back; the ledger owns the points, so the answer says the request was made, not that the points are back. An entry the order already shows as reversed is answered without asking the ledger again.
|
|
52277
|
+
* The till\'s Restore reward button. The order is read from the POS orders, else from the kiosk orders, else from the website orders, and the loyalty ledger is asked to give the points back; the ledger owns the points, so the answer says the request was made, not that the points are back. An entry the order already shows as reversed is answered without asking the ledger again.
|
|
51748
52278
|
* @summary Ask the loyalty ledger to restore a settled redemption
|
|
51749
52279
|
* @param {RestoreLoyaltyRedemptionDto} restoreLoyaltyRedemptionDto
|
|
51750
52280
|
* @param {*} [options] Override http request option.
|
|
@@ -51794,7 +52324,7 @@ export const LoyaltyCommerceApiFp = function(configuration?: Configuration) {
|
|
|
51794
52324
|
const localVarAxiosParamCreator = LoyaltyCommerceApiAxiosParamCreator(configuration)
|
|
51795
52325
|
return {
|
|
51796
52326
|
/**
|
|
51797
|
-
* The till\'s Restore reward button. The order is read from the POS orders, else from the kiosk orders, and the loyalty ledger is asked to give the points back; the ledger owns the points, so the answer says the request was made, not that the points are back. An entry the order already shows as reversed is answered without asking the ledger again.
|
|
52327
|
+
* The till\'s Restore reward button. The order is read from the POS orders, else from the kiosk orders, else from the website orders, and the loyalty ledger is asked to give the points back; the ledger owns the points, so the answer says the request was made, not that the points are back. An entry the order already shows as reversed is answered without asking the ledger again.
|
|
51798
52328
|
* @summary Ask the loyalty ledger to restore a settled redemption
|
|
51799
52329
|
* @param {RestoreLoyaltyRedemptionDto} restoreLoyaltyRedemptionDto
|
|
51800
52330
|
* @param {*} [options] Override http request option.
|
|
@@ -51815,7 +52345,7 @@ export const LoyaltyCommerceApiFactory = function (configuration?: Configuration
|
|
|
51815
52345
|
const localVarFp = LoyaltyCommerceApiFp(configuration)
|
|
51816
52346
|
return {
|
|
51817
52347
|
/**
|
|
51818
|
-
* The till\'s Restore reward button. The order is read from the POS orders, else from the kiosk orders, and the loyalty ledger is asked to give the points back; the ledger owns the points, so the answer says the request was made, not that the points are back. An entry the order already shows as reversed is answered without asking the ledger again.
|
|
52348
|
+
* The till\'s Restore reward button. The order is read from the POS orders, else from the kiosk orders, else from the website orders, and the loyalty ledger is asked to give the points back; the ledger owns the points, so the answer says the request was made, not that the points are back. An entry the order already shows as reversed is answered without asking the ledger again.
|
|
51819
52349
|
* @summary Ask the loyalty ledger to restore a settled redemption
|
|
51820
52350
|
* @param {RestoreLoyaltyRedemptionDto} restoreLoyaltyRedemptionDto
|
|
51821
52351
|
* @param {*} [options] Override http request option.
|
|
@@ -51834,7 +52364,7 @@ export const LoyaltyCommerceApiFactory = function (configuration?: Configuration
|
|
|
51834
52364
|
*/
|
|
51835
52365
|
export interface LoyaltyCommerceApiInterface {
|
|
51836
52366
|
/**
|
|
51837
|
-
* The till\'s Restore reward button. The order is read from the POS orders, else from the kiosk orders, and the loyalty ledger is asked to give the points back; the ledger owns the points, so the answer says the request was made, not that the points are back. An entry the order already shows as reversed is answered without asking the ledger again.
|
|
52367
|
+
* The till\'s Restore reward button. The order is read from the POS orders, else from the kiosk orders, else from the website orders, and the loyalty ledger is asked to give the points back; the ledger owns the points, so the answer says the request was made, not that the points are back. An entry the order already shows as reversed is answered without asking the ledger again.
|
|
51838
52368
|
* @summary Ask the loyalty ledger to restore a settled redemption
|
|
51839
52369
|
* @param {RestoreLoyaltyRedemptionDto} restoreLoyaltyRedemptionDto
|
|
51840
52370
|
* @param {*} [options] Override http request option.
|
|
@@ -51853,7 +52383,7 @@ export interface LoyaltyCommerceApiInterface {
|
|
|
51853
52383
|
*/
|
|
51854
52384
|
export class LoyaltyCommerceApi extends BaseAPI implements LoyaltyCommerceApiInterface {
|
|
51855
52385
|
/**
|
|
51856
|
-
* The till\'s Restore reward button. The order is read from the POS orders, else from the kiosk orders, and the loyalty ledger is asked to give the points back; the ledger owns the points, so the answer says the request was made, not that the points are back. An entry the order already shows as reversed is answered without asking the ledger again.
|
|
52386
|
+
* The till\'s Restore reward button. The order is read from the POS orders, else from the kiosk orders, else from the website orders, and the loyalty ledger is asked to give the points back; the ledger owns the points, so the answer says the request was made, not that the points are back. An entry the order already shows as reversed is answered without asking the ledger again.
|
|
51857
52387
|
* @summary Ask the loyalty ledger to restore a settled redemption
|
|
51858
52388
|
* @param {RestoreLoyaltyRedemptionDto} restoreLoyaltyRedemptionDto
|
|
51859
52389
|
* @param {*} [options] Override http request option.
|
|
@@ -59010,6 +59540,47 @@ export const PaymentSessionApiAxiosParamCreator = function (configuration?: Conf
|
|
|
59010
59540
|
options: localVarRequestOptions,
|
|
59011
59541
|
};
|
|
59012
59542
|
},
|
|
59543
|
+
/**
|
|
59544
|
+
* Stores a DISPATCHED Worldline session for a sale the handheld\'s own Worldline payment app (WPI) will take. Its sessionId is the reference the payment app is given; the handheld then reports the app\'s answer to worldline/a2a/result, and the server writes the order. Refused for a venue whose channel does not pay by Worldline. Nothing polls the session and it is never cancelled through :clientToken/cancel. Idempotent via X-Idempotency-Key. A signed-in ticket only.
|
|
59545
|
+
* @summary Start a Worldline sale on the handheld\'s payment app
|
|
59546
|
+
* @param {InitiateWorldlineA2aSessionDto} initiateWorldlineA2aSessionDto
|
|
59547
|
+
* @param {string} [xIdempotencyKey] Client-generated UUID. If a session already exists for this key, the existing session is returned.
|
|
59548
|
+
* @param {*} [options] Override http request option.
|
|
59549
|
+
* @throws {RequiredError}
|
|
59550
|
+
*/
|
|
59551
|
+
initiateWorldlineA2aSession: async (initiateWorldlineA2aSessionDto: InitiateWorldlineA2aSessionDto, xIdempotencyKey?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
59552
|
+
// verify required parameter 'initiateWorldlineA2aSessionDto' is not null or undefined
|
|
59553
|
+
assertParamExists('initiateWorldlineA2aSession', 'initiateWorldlineA2aSessionDto', initiateWorldlineA2aSessionDto)
|
|
59554
|
+
const localVarPath = `/api/v1/payment-session/worldline/a2a`;
|
|
59555
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
59556
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
59557
|
+
let baseOptions;
|
|
59558
|
+
if (configuration) {
|
|
59559
|
+
baseOptions = configuration.baseOptions;
|
|
59560
|
+
}
|
|
59561
|
+
|
|
59562
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
59563
|
+
const localVarHeaderParameter = {} as any;
|
|
59564
|
+
const localVarQueryParameter = {} as any;
|
|
59565
|
+
|
|
59566
|
+
if (xIdempotencyKey != null) {
|
|
59567
|
+
localVarHeaderParameter['X-Idempotency-Key'] = String(xIdempotencyKey);
|
|
59568
|
+
}
|
|
59569
|
+
|
|
59570
|
+
|
|
59571
|
+
|
|
59572
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
59573
|
+
|
|
59574
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
59575
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
59576
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
59577
|
+
localVarRequestOptions.data = serializeDataIfNeeded(initiateWorldlineA2aSessionDto, localVarRequestOptions, configuration)
|
|
59578
|
+
|
|
59579
|
+
return {
|
|
59580
|
+
url: toPathString(localVarUrlObj),
|
|
59581
|
+
options: localVarRequestOptions,
|
|
59582
|
+
};
|
|
59583
|
+
},
|
|
59013
59584
|
/**
|
|
59014
59585
|
* Creates a PaymentSession row and pushes the transaction to the station\'s Worldline terminal via the Worldline microservice (async — the result arrives via the Worldline webhook). Returns a client-facing token to poll. The backend owns the order mutation (webhook → reconciliation), replacing the legacy FE-writes-from-Ably flow. Idempotent via X-Idempotency-Key header.
|
|
59015
59586
|
* @summary Initiate a Worldline terminal payment session
|
|
@@ -59270,6 +59841,42 @@ export const PaymentSessionApiAxiosParamCreator = function (configuration?: Conf
|
|
|
59270
59841
|
options: localVarRequestOptions,
|
|
59271
59842
|
};
|
|
59272
59843
|
},
|
|
59844
|
+
/**
|
|
59845
|
+
* Settles a handheld Worldline sale, refund or revert with the payment app\'s answer (WPI_RESPONSE). A sale\'s or a refund\'s answer carries the session\'s sessionId as its reference; a revert\'s (WPI_SVC_CANCEL_PAYMENT) carries none and names the sale\'s paymentSolutionReference instead. An approval makes a sale SUCCESS, a refund REFUNDED and a revert REFUNDING; reconciliation then writes the payment or the reversal onto the order. A sale\'s approval may carry a tip the cardholder added on the payment app: it is recorded with the session\'s tip. A failure makes it FAILED, or CANCELLED when the app reports WPI_ERR_COND_USER_CANCEL. An approval may replace a failure; a failure never replaces anything. A repeated answer is answered as the session stands. The payment event\'s time is the server\'s. A signed-in ticket only.
|
|
59846
|
+
* @summary Record the Worldline payment app\'s answer for a handheld session
|
|
59847
|
+
* @param {RecordWorldlineA2aResultDto} recordWorldlineA2aResultDto
|
|
59848
|
+
* @param {*} [options] Override http request option.
|
|
59849
|
+
* @throws {RequiredError}
|
|
59850
|
+
*/
|
|
59851
|
+
recordWorldlineA2aResult: async (recordWorldlineA2aResultDto: RecordWorldlineA2aResultDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
59852
|
+
// verify required parameter 'recordWorldlineA2aResultDto' is not null or undefined
|
|
59853
|
+
assertParamExists('recordWorldlineA2aResult', 'recordWorldlineA2aResultDto', recordWorldlineA2aResultDto)
|
|
59854
|
+
const localVarPath = `/api/v1/payment-session/worldline/a2a/result`;
|
|
59855
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
59856
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
59857
|
+
let baseOptions;
|
|
59858
|
+
if (configuration) {
|
|
59859
|
+
baseOptions = configuration.baseOptions;
|
|
59860
|
+
}
|
|
59861
|
+
|
|
59862
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
59863
|
+
const localVarHeaderParameter = {} as any;
|
|
59864
|
+
const localVarQueryParameter = {} as any;
|
|
59865
|
+
|
|
59866
|
+
|
|
59867
|
+
|
|
59868
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
59869
|
+
|
|
59870
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
59871
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
59872
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
59873
|
+
localVarRequestOptions.data = serializeDataIfNeeded(recordWorldlineA2aResultDto, localVarRequestOptions, configuration)
|
|
59874
|
+
|
|
59875
|
+
return {
|
|
59876
|
+
url: toPathString(localVarUrlObj),
|
|
59877
|
+
options: localVarRequestOptions,
|
|
59878
|
+
};
|
|
59879
|
+
},
|
|
59273
59880
|
/**
|
|
59274
59881
|
* Gives the whole payment back through Epassi, which refunds only whole payments and only within 7 days. Answers the refund session: REFUNDED, FAILED with the reason, or PROCESSING when Epassi did not answer; calling again 40 seconds after it started sends Epassi that same refund again instead of starting another; then only Epassi\'s OK settles it, and a refusal leaves it PROCESSING with the message to check in Epassi whether the refund went through, because Epassi also refuses a payment it already refunded. The order is not written. Accepts the shared service key as well as a signed-in ticket: a named R27 exception, because the kiosk calls with that key until the apps have credentials of their own.
|
|
59275
59882
|
* @summary Refund an Epassi payment in full
|
|
@@ -59366,6 +59973,42 @@ export const PaymentSessionApiAxiosParamCreator = function (configuration?: Conf
|
|
|
59366
59973
|
|
|
59367
59974
|
|
|
59368
59975
|
|
|
59976
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
59977
|
+
|
|
59978
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
59979
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
59980
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
59981
|
+
localVarRequestOptions.data = serializeDataIfNeeded(reverseSessionDto, localVarRequestOptions, configuration)
|
|
59982
|
+
|
|
59983
|
+
return {
|
|
59984
|
+
url: toPathString(localVarUrlObj),
|
|
59985
|
+
options: localVarRequestOptions,
|
|
59986
|
+
};
|
|
59987
|
+
},
|
|
59988
|
+
/**
|
|
59989
|
+
* Stores a DISPATCHED refund session for the amount asked (what is left of the sale when none is), within what is left of the sale. The handheld then makes the refund on the payment app (WPI_SVC_REFUND) with the refund\'s sessionId as its reference and reports the answer to worldline/a2a/result. Does NOT write a reversal onto the order: the refund plan records it. A signed-in ticket only.
|
|
59990
|
+
* @summary Start a refund of a Worldline handheld sale
|
|
59991
|
+
* @param {ReverseSessionDto} reverseSessionDto
|
|
59992
|
+
* @param {*} [options] Override http request option.
|
|
59993
|
+
* @throws {RequiredError}
|
|
59994
|
+
*/
|
|
59995
|
+
refundWorldlineA2aSession: async (reverseSessionDto: ReverseSessionDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
59996
|
+
// verify required parameter 'reverseSessionDto' is not null or undefined
|
|
59997
|
+
assertParamExists('refundWorldlineA2aSession', 'reverseSessionDto', reverseSessionDto)
|
|
59998
|
+
const localVarPath = `/api/v1/payment-session/worldline/a2a/refund`;
|
|
59999
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
60000
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
60001
|
+
let baseOptions;
|
|
60002
|
+
if (configuration) {
|
|
60003
|
+
baseOptions = configuration.baseOptions;
|
|
60004
|
+
}
|
|
60005
|
+
|
|
60006
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
60007
|
+
const localVarHeaderParameter = {} as any;
|
|
60008
|
+
const localVarQueryParameter = {} as any;
|
|
60009
|
+
|
|
60010
|
+
|
|
60011
|
+
|
|
59369
60012
|
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
59370
60013
|
|
|
59371
60014
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -59510,6 +60153,42 @@ export const PaymentSessionApiAxiosParamCreator = function (configuration?: Conf
|
|
|
59510
60153
|
|
|
59511
60154
|
|
|
59512
60155
|
|
|
60156
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
60157
|
+
|
|
60158
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
60159
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
60160
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
60161
|
+
localVarRequestOptions.data = serializeDataIfNeeded(reverseSessionDto, localVarRequestOptions, configuration)
|
|
60162
|
+
|
|
60163
|
+
return {
|
|
60164
|
+
url: toPathString(localVarUrlObj),
|
|
60165
|
+
options: localVarRequestOptions,
|
|
60166
|
+
};
|
|
60167
|
+
},
|
|
60168
|
+
/**
|
|
60169
|
+
* Stores a DISPATCHED reversal session for the whole sale. The handheld then cancels the payment on the payment app (WPI_SVC_CANCEL_PAYMENT, which takes only the sale\'s paymentSolutionReference and cancels the whole transaction) and reports the answer, with the reversal\'s sessionId, to worldline/a2a/result; once approved, reconciliation writes the reversal onto the order. Refused when the sale already has refund activity: the waiter refunds instead. A signed-in ticket only.
|
|
60170
|
+
* @summary Start a revert (full reversal) of a Worldline handheld sale
|
|
60171
|
+
* @param {ReverseSessionDto} reverseSessionDto
|
|
60172
|
+
* @param {*} [options] Override http request option.
|
|
60173
|
+
* @throws {RequiredError}
|
|
60174
|
+
*/
|
|
60175
|
+
revertWorldlineA2aSession: async (reverseSessionDto: ReverseSessionDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
60176
|
+
// verify required parameter 'reverseSessionDto' is not null or undefined
|
|
60177
|
+
assertParamExists('revertWorldlineA2aSession', 'reverseSessionDto', reverseSessionDto)
|
|
60178
|
+
const localVarPath = `/api/v1/payment-session/worldline/a2a/revert`;
|
|
60179
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
60180
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
60181
|
+
let baseOptions;
|
|
60182
|
+
if (configuration) {
|
|
60183
|
+
baseOptions = configuration.baseOptions;
|
|
60184
|
+
}
|
|
60185
|
+
|
|
60186
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
60187
|
+
const localVarHeaderParameter = {} as any;
|
|
60188
|
+
const localVarQueryParameter = {} as any;
|
|
60189
|
+
|
|
60190
|
+
|
|
60191
|
+
|
|
59513
60192
|
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
59514
60193
|
|
|
59515
60194
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -59712,6 +60391,18 @@ export const PaymentSessionApiFp = function(configuration?: Configuration) {
|
|
|
59712
60391
|
const localVarAxiosArgs = await localVarAxiosParamCreator.initiateVivaSession(initiateVivaSessionDto, xIdempotencyKey, options);
|
|
59713
60392
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
59714
60393
|
},
|
|
60394
|
+
/**
|
|
60395
|
+
* Stores a DISPATCHED Worldline session for a sale the handheld\'s own Worldline payment app (WPI) will take. Its sessionId is the reference the payment app is given; the handheld then reports the app\'s answer to worldline/a2a/result, and the server writes the order. Refused for a venue whose channel does not pay by Worldline. Nothing polls the session and it is never cancelled through :clientToken/cancel. Idempotent via X-Idempotency-Key. A signed-in ticket only.
|
|
60396
|
+
* @summary Start a Worldline sale on the handheld\'s payment app
|
|
60397
|
+
* @param {InitiateWorldlineA2aSessionDto} initiateWorldlineA2aSessionDto
|
|
60398
|
+
* @param {string} [xIdempotencyKey] Client-generated UUID. If a session already exists for this key, the existing session is returned.
|
|
60399
|
+
* @param {*} [options] Override http request option.
|
|
60400
|
+
* @throws {RequiredError}
|
|
60401
|
+
*/
|
|
60402
|
+
async initiateWorldlineA2aSession(initiateWorldlineA2aSessionDto: InitiateWorldlineA2aSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentSessionViewDto>> {
|
|
60403
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.initiateWorldlineA2aSession(initiateWorldlineA2aSessionDto, xIdempotencyKey, options);
|
|
60404
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
60405
|
+
},
|
|
59715
60406
|
/**
|
|
59716
60407
|
* Creates a PaymentSession row and pushes the transaction to the station\'s Worldline terminal via the Worldline microservice (async — the result arrives via the Worldline webhook). Returns a client-facing token to poll. The backend owns the order mutation (webhook → reconciliation), replacing the legacy FE-writes-from-Ably flow. Idempotent via X-Idempotency-Key header.
|
|
59717
60408
|
* @summary Initiate a Worldline terminal payment session
|
|
@@ -59791,6 +60482,17 @@ export const PaymentSessionApiFp = function(configuration?: Configuration) {
|
|
|
59791
60482
|
const localVarAxiosArgs = await localVarAxiosParamCreator.recordManualPayment(createManualSessionDto, xIdempotencyKey, options);
|
|
59792
60483
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
59793
60484
|
},
|
|
60485
|
+
/**
|
|
60486
|
+
* Settles a handheld Worldline sale, refund or revert with the payment app\'s answer (WPI_RESPONSE). A sale\'s or a refund\'s answer carries the session\'s sessionId as its reference; a revert\'s (WPI_SVC_CANCEL_PAYMENT) carries none and names the sale\'s paymentSolutionReference instead. An approval makes a sale SUCCESS, a refund REFUNDED and a revert REFUNDING; reconciliation then writes the payment or the reversal onto the order. A sale\'s approval may carry a tip the cardholder added on the payment app: it is recorded with the session\'s tip. A failure makes it FAILED, or CANCELLED when the app reports WPI_ERR_COND_USER_CANCEL. An approval may replace a failure; a failure never replaces anything. A repeated answer is answered as the session stands. The payment event\'s time is the server\'s. A signed-in ticket only.
|
|
60487
|
+
* @summary Record the Worldline payment app\'s answer for a handheld session
|
|
60488
|
+
* @param {RecordWorldlineA2aResultDto} recordWorldlineA2aResultDto
|
|
60489
|
+
* @param {*} [options] Override http request option.
|
|
60490
|
+
* @throws {RequiredError}
|
|
60491
|
+
*/
|
|
60492
|
+
async recordWorldlineA2aResult(recordWorldlineA2aResultDto: RecordWorldlineA2aResultDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WorldlineA2aResultViewDto>> {
|
|
60493
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.recordWorldlineA2aResult(recordWorldlineA2aResultDto, options);
|
|
60494
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
60495
|
+
},
|
|
59794
60496
|
/**
|
|
59795
60497
|
* Gives the whole payment back through Epassi, which refunds only whole payments and only within 7 days. Answers the refund session: REFUNDED, FAILED with the reason, or PROCESSING when Epassi did not answer; calling again 40 seconds after it started sends Epassi that same refund again instead of starting another; then only Epassi\'s OK settles it, and a refusal leaves it PROCESSING with the message to check in Epassi whether the refund went through, because Epassi also refuses a payment it already refunded. The order is not written. Accepts the shared service key as well as a signed-in ticket: a named R27 exception, because the kiosk calls with that key until the apps have credentials of their own.
|
|
59796
60498
|
* @summary Refund an Epassi payment in full
|
|
@@ -59824,6 +60526,17 @@ export const PaymentSessionApiFp = function(configuration?: Configuration) {
|
|
|
59824
60526
|
const localVarAxiosArgs = await localVarAxiosParamCreator.refundVivaSession(reverseSessionDto, options);
|
|
59825
60527
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
59826
60528
|
},
|
|
60529
|
+
/**
|
|
60530
|
+
* Stores a DISPATCHED refund session for the amount asked (what is left of the sale when none is), within what is left of the sale. The handheld then makes the refund on the payment app (WPI_SVC_REFUND) with the refund\'s sessionId as its reference and reports the answer to worldline/a2a/result. Does NOT write a reversal onto the order: the refund plan records it. A signed-in ticket only.
|
|
60531
|
+
* @summary Start a refund of a Worldline handheld sale
|
|
60532
|
+
* @param {ReverseSessionDto} reverseSessionDto
|
|
60533
|
+
* @param {*} [options] Override http request option.
|
|
60534
|
+
* @throws {RequiredError}
|
|
60535
|
+
*/
|
|
60536
|
+
async refundWorldlineA2aSession(reverseSessionDto: ReverseSessionDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentSessionViewDto>> {
|
|
60537
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.refundWorldlineA2aSession(reverseSessionDto, options);
|
|
60538
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
60539
|
+
},
|
|
59827
60540
|
/**
|
|
59828
60541
|
* Starts a terminal-present ReturnOfGoods on the station\'s Worldline terminal for the given sessionId, refunding the payload `amount` (defaults to the full session amount). Returns a PENDING refund session — the customer must tap their card; poll GET /:clientToken until REFUNDED/FAILED/CANCELLED. Does NOT write a reversal paymentEvent to the order.
|
|
59829
60542
|
* @summary Refund a settled Worldline payment session (gateway only, async)
|
|
@@ -59868,6 +60581,17 @@ export const PaymentSessionApiFp = function(configuration?: Configuration) {
|
|
|
59868
60581
|
const localVarAxiosArgs = await localVarAxiosParamCreator.revertVivaSession(reverseSessionDto, options);
|
|
59869
60582
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
59870
60583
|
},
|
|
60584
|
+
/**
|
|
60585
|
+
* Stores a DISPATCHED reversal session for the whole sale. The handheld then cancels the payment on the payment app (WPI_SVC_CANCEL_PAYMENT, which takes only the sale\'s paymentSolutionReference and cancels the whole transaction) and reports the answer, with the reversal\'s sessionId, to worldline/a2a/result; once approved, reconciliation writes the reversal onto the order. Refused when the sale already has refund activity: the waiter refunds instead. A signed-in ticket only.
|
|
60586
|
+
* @summary Start a revert (full reversal) of a Worldline handheld sale
|
|
60587
|
+
* @param {ReverseSessionDto} reverseSessionDto
|
|
60588
|
+
* @param {*} [options] Override http request option.
|
|
60589
|
+
* @throws {RequiredError}
|
|
60590
|
+
*/
|
|
60591
|
+
async revertWorldlineA2aSession(reverseSessionDto: ReverseSessionDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentSessionViewDto>> {
|
|
60592
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.revertWorldlineA2aSession(reverseSessionDto, options);
|
|
60593
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
60594
|
+
},
|
|
59871
60595
|
/**
|
|
59872
60596
|
* Starts a terminal reversal for the full remaining amount AND writes a reversal paymentEvent to the order once the reversal settles (via reconciliation). Returns a PENDING refund session — poll GET /:clientToken until REFUNDED/FAILED/CANCELLED. A reversal typically settles without a card tap; if the payment is already batched/settled the reversal fails and the client should fall back to /worldline/refund.
|
|
59873
60597
|
* @summary Revert (fully reverse) a settled Worldline payment session (async)
|
|
@@ -59999,6 +60723,17 @@ export const PaymentSessionApiFactory = function (configuration?: Configuration,
|
|
|
59999
60723
|
initiateVivaSession(initiateVivaSessionDto: InitiateVivaSessionDto, xIdempotencyKey?: string, options?: any): AxiosPromise<InitiateVivaSessionResponseDto> {
|
|
60000
60724
|
return localVarFp.initiateVivaSession(initiateVivaSessionDto, xIdempotencyKey, options).then((request) => request(axios, basePath));
|
|
60001
60725
|
},
|
|
60726
|
+
/**
|
|
60727
|
+
* Stores a DISPATCHED Worldline session for a sale the handheld\'s own Worldline payment app (WPI) will take. Its sessionId is the reference the payment app is given; the handheld then reports the app\'s answer to worldline/a2a/result, and the server writes the order. Refused for a venue whose channel does not pay by Worldline. Nothing polls the session and it is never cancelled through :clientToken/cancel. Idempotent via X-Idempotency-Key. A signed-in ticket only.
|
|
60728
|
+
* @summary Start a Worldline sale on the handheld\'s payment app
|
|
60729
|
+
* @param {InitiateWorldlineA2aSessionDto} initiateWorldlineA2aSessionDto
|
|
60730
|
+
* @param {string} [xIdempotencyKey] Client-generated UUID. If a session already exists for this key, the existing session is returned.
|
|
60731
|
+
* @param {*} [options] Override http request option.
|
|
60732
|
+
* @throws {RequiredError}
|
|
60733
|
+
*/
|
|
60734
|
+
initiateWorldlineA2aSession(initiateWorldlineA2aSessionDto: InitiateWorldlineA2aSessionDto, xIdempotencyKey?: string, options?: any): AxiosPromise<PaymentSessionViewDto> {
|
|
60735
|
+
return localVarFp.initiateWorldlineA2aSession(initiateWorldlineA2aSessionDto, xIdempotencyKey, options).then((request) => request(axios, basePath));
|
|
60736
|
+
},
|
|
60002
60737
|
/**
|
|
60003
60738
|
* Creates a PaymentSession row and pushes the transaction to the station\'s Worldline terminal via the Worldline microservice (async — the result arrives via the Worldline webhook). Returns a client-facing token to poll. The backend owns the order mutation (webhook → reconciliation), replacing the legacy FE-writes-from-Ably flow. Idempotent via X-Idempotency-Key header.
|
|
60004
60739
|
* @summary Initiate a Worldline terminal payment session
|
|
@@ -60071,6 +60806,16 @@ export const PaymentSessionApiFactory = function (configuration?: Configuration,
|
|
|
60071
60806
|
recordManualPayment(createManualSessionDto: CreateManualSessionDto, xIdempotencyKey?: string, options?: any): AxiosPromise<RecordManualPaymentResultDto> {
|
|
60072
60807
|
return localVarFp.recordManualPayment(createManualSessionDto, xIdempotencyKey, options).then((request) => request(axios, basePath));
|
|
60073
60808
|
},
|
|
60809
|
+
/**
|
|
60810
|
+
* Settles a handheld Worldline sale, refund or revert with the payment app\'s answer (WPI_RESPONSE). A sale\'s or a refund\'s answer carries the session\'s sessionId as its reference; a revert\'s (WPI_SVC_CANCEL_PAYMENT) carries none and names the sale\'s paymentSolutionReference instead. An approval makes a sale SUCCESS, a refund REFUNDED and a revert REFUNDING; reconciliation then writes the payment or the reversal onto the order. A sale\'s approval may carry a tip the cardholder added on the payment app: it is recorded with the session\'s tip. A failure makes it FAILED, or CANCELLED when the app reports WPI_ERR_COND_USER_CANCEL. An approval may replace a failure; a failure never replaces anything. A repeated answer is answered as the session stands. The payment event\'s time is the server\'s. A signed-in ticket only.
|
|
60811
|
+
* @summary Record the Worldline payment app\'s answer for a handheld session
|
|
60812
|
+
* @param {RecordWorldlineA2aResultDto} recordWorldlineA2aResultDto
|
|
60813
|
+
* @param {*} [options] Override http request option.
|
|
60814
|
+
* @throws {RequiredError}
|
|
60815
|
+
*/
|
|
60816
|
+
recordWorldlineA2aResult(recordWorldlineA2aResultDto: RecordWorldlineA2aResultDto, options?: any): AxiosPromise<WorldlineA2aResultViewDto> {
|
|
60817
|
+
return localVarFp.recordWorldlineA2aResult(recordWorldlineA2aResultDto, options).then((request) => request(axios, basePath));
|
|
60818
|
+
},
|
|
60074
60819
|
/**
|
|
60075
60820
|
* Gives the whole payment back through Epassi, which refunds only whole payments and only within 7 days. Answers the refund session: REFUNDED, FAILED with the reason, or PROCESSING when Epassi did not answer; calling again 40 seconds after it started sends Epassi that same refund again instead of starting another; then only Epassi\'s OK settles it, and a refusal leaves it PROCESSING with the message to check in Epassi whether the refund went through, because Epassi also refuses a payment it already refunded. The order is not written. Accepts the shared service key as well as a signed-in ticket: a named R27 exception, because the kiosk calls with that key until the apps have credentials of their own.
|
|
60076
60821
|
* @summary Refund an Epassi payment in full
|
|
@@ -60101,6 +60846,16 @@ export const PaymentSessionApiFactory = function (configuration?: Configuration,
|
|
|
60101
60846
|
refundVivaSession(reverseSessionDto: ReverseSessionDto, options?: any): AxiosPromise<PaymentSessionViewDto> {
|
|
60102
60847
|
return localVarFp.refundVivaSession(reverseSessionDto, options).then((request) => request(axios, basePath));
|
|
60103
60848
|
},
|
|
60849
|
+
/**
|
|
60850
|
+
* Stores a DISPATCHED refund session for the amount asked (what is left of the sale when none is), within what is left of the sale. The handheld then makes the refund on the payment app (WPI_SVC_REFUND) with the refund\'s sessionId as its reference and reports the answer to worldline/a2a/result. Does NOT write a reversal onto the order: the refund plan records it. A signed-in ticket only.
|
|
60851
|
+
* @summary Start a refund of a Worldline handheld sale
|
|
60852
|
+
* @param {ReverseSessionDto} reverseSessionDto
|
|
60853
|
+
* @param {*} [options] Override http request option.
|
|
60854
|
+
* @throws {RequiredError}
|
|
60855
|
+
*/
|
|
60856
|
+
refundWorldlineA2aSession(reverseSessionDto: ReverseSessionDto, options?: any): AxiosPromise<PaymentSessionViewDto> {
|
|
60857
|
+
return localVarFp.refundWorldlineA2aSession(reverseSessionDto, options).then((request) => request(axios, basePath));
|
|
60858
|
+
},
|
|
60104
60859
|
/**
|
|
60105
60860
|
* Starts a terminal-present ReturnOfGoods on the station\'s Worldline terminal for the given sessionId, refunding the payload `amount` (defaults to the full session amount). Returns a PENDING refund session — the customer must tap their card; poll GET /:clientToken until REFUNDED/FAILED/CANCELLED. Does NOT write a reversal paymentEvent to the order.
|
|
60106
60861
|
* @summary Refund a settled Worldline payment session (gateway only, async)
|
|
@@ -60141,6 +60896,16 @@ export const PaymentSessionApiFactory = function (configuration?: Configuration,
|
|
|
60141
60896
|
revertVivaSession(reverseSessionDto: ReverseSessionDto, options?: any): AxiosPromise<PaymentSessionViewDto> {
|
|
60142
60897
|
return localVarFp.revertVivaSession(reverseSessionDto, options).then((request) => request(axios, basePath));
|
|
60143
60898
|
},
|
|
60899
|
+
/**
|
|
60900
|
+
* Stores a DISPATCHED reversal session for the whole sale. The handheld then cancels the payment on the payment app (WPI_SVC_CANCEL_PAYMENT, which takes only the sale\'s paymentSolutionReference and cancels the whole transaction) and reports the answer, with the reversal\'s sessionId, to worldline/a2a/result; once approved, reconciliation writes the reversal onto the order. Refused when the sale already has refund activity: the waiter refunds instead. A signed-in ticket only.
|
|
60901
|
+
* @summary Start a revert (full reversal) of a Worldline handheld sale
|
|
60902
|
+
* @param {ReverseSessionDto} reverseSessionDto
|
|
60903
|
+
* @param {*} [options] Override http request option.
|
|
60904
|
+
* @throws {RequiredError}
|
|
60905
|
+
*/
|
|
60906
|
+
revertWorldlineA2aSession(reverseSessionDto: ReverseSessionDto, options?: any): AxiosPromise<PaymentSessionViewDto> {
|
|
60907
|
+
return localVarFp.revertWorldlineA2aSession(reverseSessionDto, options).then((request) => request(axios, basePath));
|
|
60908
|
+
},
|
|
60144
60909
|
/**
|
|
60145
60910
|
* Starts a terminal reversal for the full remaining amount AND writes a reversal paymentEvent to the order once the reversal settles (via reconciliation). Returns a PENDING refund session — poll GET /:clientToken until REFUNDED/FAILED/CANCELLED. A reversal typically settles without a card tap; if the payment is already batched/settled the reversal fails and the client should fall back to /worldline/refund.
|
|
60146
60911
|
* @summary Revert (fully reverse) a settled Worldline payment session (async)
|
|
@@ -60269,6 +61034,17 @@ export interface PaymentSessionApiInterface {
|
|
|
60269
61034
|
*/
|
|
60270
61035
|
initiateVivaSession(initiateVivaSessionDto: InitiateVivaSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): AxiosPromise<InitiateVivaSessionResponseDto>;
|
|
60271
61036
|
|
|
61037
|
+
/**
|
|
61038
|
+
* Stores a DISPATCHED Worldline session for a sale the handheld\'s own Worldline payment app (WPI) will take. Its sessionId is the reference the payment app is given; the handheld then reports the app\'s answer to worldline/a2a/result, and the server writes the order. Refused for a venue whose channel does not pay by Worldline. Nothing polls the session and it is never cancelled through :clientToken/cancel. Idempotent via X-Idempotency-Key. A signed-in ticket only.
|
|
61039
|
+
* @summary Start a Worldline sale on the handheld\'s payment app
|
|
61040
|
+
* @param {InitiateWorldlineA2aSessionDto} initiateWorldlineA2aSessionDto
|
|
61041
|
+
* @param {string} [xIdempotencyKey] Client-generated UUID. If a session already exists for this key, the existing session is returned.
|
|
61042
|
+
* @param {*} [options] Override http request option.
|
|
61043
|
+
* @throws {RequiredError}
|
|
61044
|
+
* @memberof PaymentSessionApiInterface
|
|
61045
|
+
*/
|
|
61046
|
+
initiateWorldlineA2aSession(initiateWorldlineA2aSessionDto: InitiateWorldlineA2aSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): AxiosPromise<PaymentSessionViewDto>;
|
|
61047
|
+
|
|
60272
61048
|
/**
|
|
60273
61049
|
* Creates a PaymentSession row and pushes the transaction to the station\'s Worldline terminal via the Worldline microservice (async — the result arrives via the Worldline webhook). Returns a client-facing token to poll. The backend owns the order mutation (webhook → reconciliation), replacing the legacy FE-writes-from-Ably flow. Idempotent via X-Idempotency-Key header.
|
|
60274
61050
|
* @summary Initiate a Worldline terminal payment session
|
|
@@ -60341,6 +61117,16 @@ export interface PaymentSessionApiInterface {
|
|
|
60341
61117
|
*/
|
|
60342
61118
|
recordManualPayment(createManualSessionDto: CreateManualSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): AxiosPromise<RecordManualPaymentResultDto>;
|
|
60343
61119
|
|
|
61120
|
+
/**
|
|
61121
|
+
* Settles a handheld Worldline sale, refund or revert with the payment app\'s answer (WPI_RESPONSE). A sale\'s or a refund\'s answer carries the session\'s sessionId as its reference; a revert\'s (WPI_SVC_CANCEL_PAYMENT) carries none and names the sale\'s paymentSolutionReference instead. An approval makes a sale SUCCESS, a refund REFUNDED and a revert REFUNDING; reconciliation then writes the payment or the reversal onto the order. A sale\'s approval may carry a tip the cardholder added on the payment app: it is recorded with the session\'s tip. A failure makes it FAILED, or CANCELLED when the app reports WPI_ERR_COND_USER_CANCEL. An approval may replace a failure; a failure never replaces anything. A repeated answer is answered as the session stands. The payment event\'s time is the server\'s. A signed-in ticket only.
|
|
61122
|
+
* @summary Record the Worldline payment app\'s answer for a handheld session
|
|
61123
|
+
* @param {RecordWorldlineA2aResultDto} recordWorldlineA2aResultDto
|
|
61124
|
+
* @param {*} [options] Override http request option.
|
|
61125
|
+
* @throws {RequiredError}
|
|
61126
|
+
* @memberof PaymentSessionApiInterface
|
|
61127
|
+
*/
|
|
61128
|
+
recordWorldlineA2aResult(recordWorldlineA2aResultDto: RecordWorldlineA2aResultDto, options?: AxiosRequestConfig): AxiosPromise<WorldlineA2aResultViewDto>;
|
|
61129
|
+
|
|
60344
61130
|
/**
|
|
60345
61131
|
* Gives the whole payment back through Epassi, which refunds only whole payments and only within 7 days. Answers the refund session: REFUNDED, FAILED with the reason, or PROCESSING when Epassi did not answer; calling again 40 seconds after it started sends Epassi that same refund again instead of starting another; then only Epassi\'s OK settles it, and a refusal leaves it PROCESSING with the message to check in Epassi whether the refund went through, because Epassi also refuses a payment it already refunded. The order is not written. Accepts the shared service key as well as a signed-in ticket: a named R27 exception, because the kiosk calls with that key until the apps have credentials of their own.
|
|
60346
61132
|
* @summary Refund an Epassi payment in full
|
|
@@ -60371,6 +61157,16 @@ export interface PaymentSessionApiInterface {
|
|
|
60371
61157
|
*/
|
|
60372
61158
|
refundVivaSession(reverseSessionDto: ReverseSessionDto, options?: AxiosRequestConfig): AxiosPromise<PaymentSessionViewDto>;
|
|
60373
61159
|
|
|
61160
|
+
/**
|
|
61161
|
+
* Stores a DISPATCHED refund session for the amount asked (what is left of the sale when none is), within what is left of the sale. The handheld then makes the refund on the payment app (WPI_SVC_REFUND) with the refund\'s sessionId as its reference and reports the answer to worldline/a2a/result. Does NOT write a reversal onto the order: the refund plan records it. A signed-in ticket only.
|
|
61162
|
+
* @summary Start a refund of a Worldline handheld sale
|
|
61163
|
+
* @param {ReverseSessionDto} reverseSessionDto
|
|
61164
|
+
* @param {*} [options] Override http request option.
|
|
61165
|
+
* @throws {RequiredError}
|
|
61166
|
+
* @memberof PaymentSessionApiInterface
|
|
61167
|
+
*/
|
|
61168
|
+
refundWorldlineA2aSession(reverseSessionDto: ReverseSessionDto, options?: AxiosRequestConfig): AxiosPromise<PaymentSessionViewDto>;
|
|
61169
|
+
|
|
60374
61170
|
/**
|
|
60375
61171
|
* Starts a terminal-present ReturnOfGoods on the station\'s Worldline terminal for the given sessionId, refunding the payload `amount` (defaults to the full session amount). Returns a PENDING refund session — the customer must tap their card; poll GET /:clientToken until REFUNDED/FAILED/CANCELLED. Does NOT write a reversal paymentEvent to the order.
|
|
60376
61172
|
* @summary Refund a settled Worldline payment session (gateway only, async)
|
|
@@ -60411,6 +61207,16 @@ export interface PaymentSessionApiInterface {
|
|
|
60411
61207
|
*/
|
|
60412
61208
|
revertVivaSession(reverseSessionDto: ReverseSessionDto, options?: AxiosRequestConfig): AxiosPromise<PaymentSessionViewDto>;
|
|
60413
61209
|
|
|
61210
|
+
/**
|
|
61211
|
+
* Stores a DISPATCHED reversal session for the whole sale. The handheld then cancels the payment on the payment app (WPI_SVC_CANCEL_PAYMENT, which takes only the sale\'s paymentSolutionReference and cancels the whole transaction) and reports the answer, with the reversal\'s sessionId, to worldline/a2a/result; once approved, reconciliation writes the reversal onto the order. Refused when the sale already has refund activity: the waiter refunds instead. A signed-in ticket only.
|
|
61212
|
+
* @summary Start a revert (full reversal) of a Worldline handheld sale
|
|
61213
|
+
* @param {ReverseSessionDto} reverseSessionDto
|
|
61214
|
+
* @param {*} [options] Override http request option.
|
|
61215
|
+
* @throws {RequiredError}
|
|
61216
|
+
* @memberof PaymentSessionApiInterface
|
|
61217
|
+
*/
|
|
61218
|
+
revertWorldlineA2aSession(reverseSessionDto: ReverseSessionDto, options?: AxiosRequestConfig): AxiosPromise<PaymentSessionViewDto>;
|
|
61219
|
+
|
|
60414
61220
|
/**
|
|
60415
61221
|
* Starts a terminal reversal for the full remaining amount AND writes a reversal paymentEvent to the order once the reversal settles (via reconciliation). Returns a PENDING refund session — poll GET /:clientToken until REFUNDED/FAILED/CANCELLED. A reversal typically settles without a card tap; if the payment is already batched/settled the reversal fails and the client should fall back to /worldline/refund.
|
|
60416
61222
|
* @summary Revert (fully reverse) a settled Worldline payment session (async)
|
|
@@ -60557,6 +61363,19 @@ export class PaymentSessionApi extends BaseAPI implements PaymentSessionApiInter
|
|
|
60557
61363
|
return PaymentSessionApiFp(this.configuration).initiateVivaSession(initiateVivaSessionDto, xIdempotencyKey, options).then((request) => request(this.axios, this.basePath));
|
|
60558
61364
|
}
|
|
60559
61365
|
|
|
61366
|
+
/**
|
|
61367
|
+
* Stores a DISPATCHED Worldline session for a sale the handheld\'s own Worldline payment app (WPI) will take. Its sessionId is the reference the payment app is given; the handheld then reports the app\'s answer to worldline/a2a/result, and the server writes the order. Refused for a venue whose channel does not pay by Worldline. Nothing polls the session and it is never cancelled through :clientToken/cancel. Idempotent via X-Idempotency-Key. A signed-in ticket only.
|
|
61368
|
+
* @summary Start a Worldline sale on the handheld\'s payment app
|
|
61369
|
+
* @param {InitiateWorldlineA2aSessionDto} initiateWorldlineA2aSessionDto
|
|
61370
|
+
* @param {string} [xIdempotencyKey] Client-generated UUID. If a session already exists for this key, the existing session is returned.
|
|
61371
|
+
* @param {*} [options] Override http request option.
|
|
61372
|
+
* @throws {RequiredError}
|
|
61373
|
+
* @memberof PaymentSessionApi
|
|
61374
|
+
*/
|
|
61375
|
+
public initiateWorldlineA2aSession(initiateWorldlineA2aSessionDto: InitiateWorldlineA2aSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig) {
|
|
61376
|
+
return PaymentSessionApiFp(this.configuration).initiateWorldlineA2aSession(initiateWorldlineA2aSessionDto, xIdempotencyKey, options).then((request) => request(this.axios, this.basePath));
|
|
61377
|
+
}
|
|
61378
|
+
|
|
60560
61379
|
/**
|
|
60561
61380
|
* Creates a PaymentSession row and pushes the transaction to the station\'s Worldline terminal via the Worldline microservice (async — the result arrives via the Worldline webhook). Returns a client-facing token to poll. The backend owns the order mutation (webhook → reconciliation), replacing the legacy FE-writes-from-Ably flow. Idempotent via X-Idempotency-Key header.
|
|
60562
61381
|
* @summary Initiate a Worldline terminal payment session
|
|
@@ -60643,6 +61462,18 @@ export class PaymentSessionApi extends BaseAPI implements PaymentSessionApiInter
|
|
|
60643
61462
|
return PaymentSessionApiFp(this.configuration).recordManualPayment(createManualSessionDto, xIdempotencyKey, options).then((request) => request(this.axios, this.basePath));
|
|
60644
61463
|
}
|
|
60645
61464
|
|
|
61465
|
+
/**
|
|
61466
|
+
* Settles a handheld Worldline sale, refund or revert with the payment app\'s answer (WPI_RESPONSE). A sale\'s or a refund\'s answer carries the session\'s sessionId as its reference; a revert\'s (WPI_SVC_CANCEL_PAYMENT) carries none and names the sale\'s paymentSolutionReference instead. An approval makes a sale SUCCESS, a refund REFUNDED and a revert REFUNDING; reconciliation then writes the payment or the reversal onto the order. A sale\'s approval may carry a tip the cardholder added on the payment app: it is recorded with the session\'s tip. A failure makes it FAILED, or CANCELLED when the app reports WPI_ERR_COND_USER_CANCEL. An approval may replace a failure; a failure never replaces anything. A repeated answer is answered as the session stands. The payment event\'s time is the server\'s. A signed-in ticket only.
|
|
61467
|
+
* @summary Record the Worldline payment app\'s answer for a handheld session
|
|
61468
|
+
* @param {RecordWorldlineA2aResultDto} recordWorldlineA2aResultDto
|
|
61469
|
+
* @param {*} [options] Override http request option.
|
|
61470
|
+
* @throws {RequiredError}
|
|
61471
|
+
* @memberof PaymentSessionApi
|
|
61472
|
+
*/
|
|
61473
|
+
public recordWorldlineA2aResult(recordWorldlineA2aResultDto: RecordWorldlineA2aResultDto, options?: AxiosRequestConfig) {
|
|
61474
|
+
return PaymentSessionApiFp(this.configuration).recordWorldlineA2aResult(recordWorldlineA2aResultDto, options).then((request) => request(this.axios, this.basePath));
|
|
61475
|
+
}
|
|
61476
|
+
|
|
60646
61477
|
/**
|
|
60647
61478
|
* Gives the whole payment back through Epassi, which refunds only whole payments and only within 7 days. Answers the refund session: REFUNDED, FAILED with the reason, or PROCESSING when Epassi did not answer; calling again 40 seconds after it started sends Epassi that same refund again instead of starting another; then only Epassi\'s OK settles it, and a refusal leaves it PROCESSING with the message to check in Epassi whether the refund went through, because Epassi also refuses a payment it already refunded. The order is not written. Accepts the shared service key as well as a signed-in ticket: a named R27 exception, because the kiosk calls with that key until the apps have credentials of their own.
|
|
60648
61479
|
* @summary Refund an Epassi payment in full
|
|
@@ -60679,6 +61510,18 @@ export class PaymentSessionApi extends BaseAPI implements PaymentSessionApiInter
|
|
|
60679
61510
|
return PaymentSessionApiFp(this.configuration).refundVivaSession(reverseSessionDto, options).then((request) => request(this.axios, this.basePath));
|
|
60680
61511
|
}
|
|
60681
61512
|
|
|
61513
|
+
/**
|
|
61514
|
+
* Stores a DISPATCHED refund session for the amount asked (what is left of the sale when none is), within what is left of the sale. The handheld then makes the refund on the payment app (WPI_SVC_REFUND) with the refund\'s sessionId as its reference and reports the answer to worldline/a2a/result. Does NOT write a reversal onto the order: the refund plan records it. A signed-in ticket only.
|
|
61515
|
+
* @summary Start a refund of a Worldline handheld sale
|
|
61516
|
+
* @param {ReverseSessionDto} reverseSessionDto
|
|
61517
|
+
* @param {*} [options] Override http request option.
|
|
61518
|
+
* @throws {RequiredError}
|
|
61519
|
+
* @memberof PaymentSessionApi
|
|
61520
|
+
*/
|
|
61521
|
+
public refundWorldlineA2aSession(reverseSessionDto: ReverseSessionDto, options?: AxiosRequestConfig) {
|
|
61522
|
+
return PaymentSessionApiFp(this.configuration).refundWorldlineA2aSession(reverseSessionDto, options).then((request) => request(this.axios, this.basePath));
|
|
61523
|
+
}
|
|
61524
|
+
|
|
60682
61525
|
/**
|
|
60683
61526
|
* Starts a terminal-present ReturnOfGoods on the station\'s Worldline terminal for the given sessionId, refunding the payload `amount` (defaults to the full session amount). Returns a PENDING refund session — the customer must tap their card; poll GET /:clientToken until REFUNDED/FAILED/CANCELLED. Does NOT write a reversal paymentEvent to the order.
|
|
60684
61527
|
* @summary Refund a settled Worldline payment session (gateway only, async)
|
|
@@ -60727,6 +61570,18 @@ export class PaymentSessionApi extends BaseAPI implements PaymentSessionApiInter
|
|
|
60727
61570
|
return PaymentSessionApiFp(this.configuration).revertVivaSession(reverseSessionDto, options).then((request) => request(this.axios, this.basePath));
|
|
60728
61571
|
}
|
|
60729
61572
|
|
|
61573
|
+
/**
|
|
61574
|
+
* Stores a DISPATCHED reversal session for the whole sale. The handheld then cancels the payment on the payment app (WPI_SVC_CANCEL_PAYMENT, which takes only the sale\'s paymentSolutionReference and cancels the whole transaction) and reports the answer, with the reversal\'s sessionId, to worldline/a2a/result; once approved, reconciliation writes the reversal onto the order. Refused when the sale already has refund activity: the waiter refunds instead. A signed-in ticket only.
|
|
61575
|
+
* @summary Start a revert (full reversal) of a Worldline handheld sale
|
|
61576
|
+
* @param {ReverseSessionDto} reverseSessionDto
|
|
61577
|
+
* @param {*} [options] Override http request option.
|
|
61578
|
+
* @throws {RequiredError}
|
|
61579
|
+
* @memberof PaymentSessionApi
|
|
61580
|
+
*/
|
|
61581
|
+
public revertWorldlineA2aSession(reverseSessionDto: ReverseSessionDto, options?: AxiosRequestConfig) {
|
|
61582
|
+
return PaymentSessionApiFp(this.configuration).revertWorldlineA2aSession(reverseSessionDto, options).then((request) => request(this.axios, this.basePath));
|
|
61583
|
+
}
|
|
61584
|
+
|
|
60730
61585
|
/**
|
|
60731
61586
|
* Starts a terminal reversal for the full remaining amount AND writes a reversal paymentEvent to the order once the reversal settles (via reconciliation). Returns a PENDING refund session — poll GET /:clientToken until REFUNDED/FAILED/CANCELLED. A reversal typically settles without a card tap; if the payment is already batched/settled the reversal fails and the client should fall back to /worldline/refund.
|
|
60732
61587
|
* @summary Revert (fully reverse) a settled Worldline payment session (async)
|
|
@@ -71294,7 +72149,7 @@ export const VenueKiosksApiAxiosParamCreator = function (configuration?: Configu
|
|
|
71294
72149
|
return {
|
|
71295
72150
|
/**
|
|
71296
72151
|
* Only the fields sent change. status ACTIVE on a removed kiosk puts it back in use, asks the licence exactly as a claim does, and makes it the station the device resolves to. Every other change keeps the kiosk\'s updatedAt, so it never takes the device from a venue it moved to (the device resolves to its station with the newest updatedAt), and changes only a kiosk in use: one removed meanwhile answers 409. status INACTIVE takes the kiosk out of use and unlinks its terminal; on a kiosk already removed it answers the kiosk unchanged. Any other change of a removed kiosk is refused. The kiosk\'s kept station is forgotten, so the device sees the change on its next request.
|
|
71297
|
-
* @summary Rename a kiosk, change its prefix, or put it in or out of use
|
|
72152
|
+
* @summary Rename a kiosk, change its prefix or device, or put it in or out of use
|
|
71298
72153
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71299
72154
|
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
71300
72155
|
* @param {ChangeKioskDto} changeKioskDto
|
|
@@ -71341,7 +72196,7 @@ export const VenueKiosksApiAxiosParamCreator = function (configuration?: Configu
|
|
|
71341
72196
|
};
|
|
71342
72197
|
},
|
|
71343
72198
|
/**
|
|
71344
|
-
* The kiosk shows its Hardware ID on its Getting started screen until it is linked; the id is trimmed and written in the case the device sends it (an iOS vendor id upper case, an Android id lower case). A device that is one of the venue\'s tills, in use or not, or active at another venue, is refused first, before the licence is asked. A kiosk already in use here
|
|
72199
|
+
* The kiosk shows its Hardware ID on its Getting started screen until it is linked; the id is trimmed and written in the case the device sends it (an iOS vendor id upper case, an Android id lower case). A device that is one of the venue\'s tills, in use or not, or active at another venue, is refused first, before the licence is asked. A kiosk already in use here only takes the name, prefix and device sent, with no licence check. Otherwise the licence is read from the license server and must have the kiosk add-on; then, under a lock on the venue\'s kiosks and then one on the device, the device\'s other uses are checked again and the venue\'s active kiosks with this one must fit the licence\'s kiosk limit. The venue\'s station of the device becomes an active kiosk (type KIOSK), created when the venue has none (device KIOSK_STAND and prefix empty unless sent), with the name sent, and becomes the station the device resolves to; the kiosk then continues on its next check. A kiosk the venue already had, inactive, counts like a new one. Nothing is claimed unchecked: when the licence cannot be read, the claim is refused.
|
|
71345
72200
|
* @summary Link a kiosk to the venue by the Hardware ID it shows
|
|
71346
72201
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71347
72202
|
* @param {ClaimKioskDto} claimKioskDto
|
|
@@ -71562,7 +72417,7 @@ export const VenueKiosksApiFp = function(configuration?: Configuration) {
|
|
|
71562
72417
|
return {
|
|
71563
72418
|
/**
|
|
71564
72419
|
* Only the fields sent change. status ACTIVE on a removed kiosk puts it back in use, asks the licence exactly as a claim does, and makes it the station the device resolves to. Every other change keeps the kiosk\'s updatedAt, so it never takes the device from a venue it moved to (the device resolves to its station with the newest updatedAt), and changes only a kiosk in use: one removed meanwhile answers 409. status INACTIVE takes the kiosk out of use and unlinks its terminal; on a kiosk already removed it answers the kiosk unchanged. Any other change of a removed kiosk is refused. The kiosk\'s kept station is forgotten, so the device sees the change on its next request.
|
|
71565
|
-
* @summary Rename a kiosk, change its prefix, or put it in or out of use
|
|
72420
|
+
* @summary Rename a kiosk, change its prefix or device, or put it in or out of use
|
|
71566
72421
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71567
72422
|
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
71568
72423
|
* @param {ChangeKioskDto} changeKioskDto
|
|
@@ -71574,7 +72429,7 @@ export const VenueKiosksApiFp = function(configuration?: Configuration) {
|
|
|
71574
72429
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
71575
72430
|
},
|
|
71576
72431
|
/**
|
|
71577
|
-
* The kiosk shows its Hardware ID on its Getting started screen until it is linked; the id is trimmed and written in the case the device sends it (an iOS vendor id upper case, an Android id lower case). A device that is one of the venue\'s tills, in use or not, or active at another venue, is refused first, before the licence is asked. A kiosk already in use here
|
|
72432
|
+
* The kiosk shows its Hardware ID on its Getting started screen until it is linked; the id is trimmed and written in the case the device sends it (an iOS vendor id upper case, an Android id lower case). A device that is one of the venue\'s tills, in use or not, or active at another venue, is refused first, before the licence is asked. A kiosk already in use here only takes the name, prefix and device sent, with no licence check. Otherwise the licence is read from the license server and must have the kiosk add-on; then, under a lock on the venue\'s kiosks and then one on the device, the device\'s other uses are checked again and the venue\'s active kiosks with this one must fit the licence\'s kiosk limit. The venue\'s station of the device becomes an active kiosk (type KIOSK), created when the venue has none (device KIOSK_STAND and prefix empty unless sent), with the name sent, and becomes the station the device resolves to; the kiosk then continues on its next check. A kiosk the venue already had, inactive, counts like a new one. Nothing is claimed unchecked: when the licence cannot be read, the claim is refused.
|
|
71578
72433
|
* @summary Link a kiosk to the venue by the Hardware ID it shows
|
|
71579
72434
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71580
72435
|
* @param {ClaimKioskDto} claimKioskDto
|
|
@@ -71644,7 +72499,7 @@ export const VenueKiosksApiFactory = function (configuration?: Configuration, ba
|
|
|
71644
72499
|
return {
|
|
71645
72500
|
/**
|
|
71646
72501
|
* Only the fields sent change. status ACTIVE on a removed kiosk puts it back in use, asks the licence exactly as a claim does, and makes it the station the device resolves to. Every other change keeps the kiosk\'s updatedAt, so it never takes the device from a venue it moved to (the device resolves to its station with the newest updatedAt), and changes only a kiosk in use: one removed meanwhile answers 409. status INACTIVE takes the kiosk out of use and unlinks its terminal; on a kiosk already removed it answers the kiosk unchanged. Any other change of a removed kiosk is refused. The kiosk\'s kept station is forgotten, so the device sees the change on its next request.
|
|
71647
|
-
* @summary Rename a kiosk, change its prefix, or put it in or out of use
|
|
72502
|
+
* @summary Rename a kiosk, change its prefix or device, or put it in or out of use
|
|
71648
72503
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71649
72504
|
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
71650
72505
|
* @param {ChangeKioskDto} changeKioskDto
|
|
@@ -71655,7 +72510,7 @@ export const VenueKiosksApiFactory = function (configuration?: Configuration, ba
|
|
|
71655
72510
|
return localVarFp.changeVenueKiosk(businessId, stationId, changeKioskDto, options).then((request) => request(axios, basePath));
|
|
71656
72511
|
},
|
|
71657
72512
|
/**
|
|
71658
|
-
* The kiosk shows its Hardware ID on its Getting started screen until it is linked; the id is trimmed and written in the case the device sends it (an iOS vendor id upper case, an Android id lower case). A device that is one of the venue\'s tills, in use or not, or active at another venue, is refused first, before the licence is asked. A kiosk already in use here
|
|
72513
|
+
* The kiosk shows its Hardware ID on its Getting started screen until it is linked; the id is trimmed and written in the case the device sends it (an iOS vendor id upper case, an Android id lower case). A device that is one of the venue\'s tills, in use or not, or active at another venue, is refused first, before the licence is asked. A kiosk already in use here only takes the name, prefix and device sent, with no licence check. Otherwise the licence is read from the license server and must have the kiosk add-on; then, under a lock on the venue\'s kiosks and then one on the device, the device\'s other uses are checked again and the venue\'s active kiosks with this one must fit the licence\'s kiosk limit. The venue\'s station of the device becomes an active kiosk (type KIOSK), created when the venue has none (device KIOSK_STAND and prefix empty unless sent), with the name sent, and becomes the station the device resolves to; the kiosk then continues on its next check. A kiosk the venue already had, inactive, counts like a new one. Nothing is claimed unchecked: when the licence cannot be read, the claim is refused.
|
|
71659
72514
|
* @summary Link a kiosk to the venue by the Hardware ID it shows
|
|
71660
72515
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71661
72516
|
* @param {ClaimKioskDto} claimKioskDto
|
|
@@ -71719,7 +72574,7 @@ export const VenueKiosksApiFactory = function (configuration?: Configuration, ba
|
|
|
71719
72574
|
export interface VenueKiosksApiInterface {
|
|
71720
72575
|
/**
|
|
71721
72576
|
* Only the fields sent change. status ACTIVE on a removed kiosk puts it back in use, asks the licence exactly as a claim does, and makes it the station the device resolves to. Every other change keeps the kiosk\'s updatedAt, so it never takes the device from a venue it moved to (the device resolves to its station with the newest updatedAt), and changes only a kiosk in use: one removed meanwhile answers 409. status INACTIVE takes the kiosk out of use and unlinks its terminal; on a kiosk already removed it answers the kiosk unchanged. Any other change of a removed kiosk is refused. The kiosk\'s kept station is forgotten, so the device sees the change on its next request.
|
|
71722
|
-
* @summary Rename a kiosk, change its prefix, or put it in or out of use
|
|
72577
|
+
* @summary Rename a kiosk, change its prefix or device, or put it in or out of use
|
|
71723
72578
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71724
72579
|
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
71725
72580
|
* @param {ChangeKioskDto} changeKioskDto
|
|
@@ -71730,7 +72585,7 @@ export interface VenueKiosksApiInterface {
|
|
|
71730
72585
|
changeVenueKiosk(businessId: number, stationId: string, changeKioskDto: ChangeKioskDto, options?: AxiosRequestConfig): AxiosPromise<VenueKioskDto>;
|
|
71731
72586
|
|
|
71732
72587
|
/**
|
|
71733
|
-
* The kiosk shows its Hardware ID on its Getting started screen until it is linked; the id is trimmed and written in the case the device sends it (an iOS vendor id upper case, an Android id lower case). A device that is one of the venue\'s tills, in use or not, or active at another venue, is refused first, before the licence is asked. A kiosk already in use here
|
|
72588
|
+
* The kiosk shows its Hardware ID on its Getting started screen until it is linked; the id is trimmed and written in the case the device sends it (an iOS vendor id upper case, an Android id lower case). A device that is one of the venue\'s tills, in use or not, or active at another venue, is refused first, before the licence is asked. A kiosk already in use here only takes the name, prefix and device sent, with no licence check. Otherwise the licence is read from the license server and must have the kiosk add-on; then, under a lock on the venue\'s kiosks and then one on the device, the device\'s other uses are checked again and the venue\'s active kiosks with this one must fit the licence\'s kiosk limit. The venue\'s station of the device becomes an active kiosk (type KIOSK), created when the venue has none (device KIOSK_STAND and prefix empty unless sent), with the name sent, and becomes the station the device resolves to; the kiosk then continues on its next check. A kiosk the venue already had, inactive, counts like a new one. Nothing is claimed unchecked: when the licence cannot be read, the claim is refused.
|
|
71734
72589
|
* @summary Link a kiosk to the venue by the Hardware ID it shows
|
|
71735
72590
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71736
72591
|
* @param {ClaimKioskDto} claimKioskDto
|
|
@@ -71794,7 +72649,7 @@ export interface VenueKiosksApiInterface {
|
|
|
71794
72649
|
export class VenueKiosksApi extends BaseAPI implements VenueKiosksApiInterface {
|
|
71795
72650
|
/**
|
|
71796
72651
|
* Only the fields sent change. status ACTIVE on a removed kiosk puts it back in use, asks the licence exactly as a claim does, and makes it the station the device resolves to. Every other change keeps the kiosk\'s updatedAt, so it never takes the device from a venue it moved to (the device resolves to its station with the newest updatedAt), and changes only a kiosk in use: one removed meanwhile answers 409. status INACTIVE takes the kiosk out of use and unlinks its terminal; on a kiosk already removed it answers the kiosk unchanged. Any other change of a removed kiosk is refused. The kiosk\'s kept station is forgotten, so the device sees the change on its next request.
|
|
71797
|
-
* @summary Rename a kiosk, change its prefix, or put it in or out of use
|
|
72652
|
+
* @summary Rename a kiosk, change its prefix or device, or put it in or out of use
|
|
71798
72653
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71799
72654
|
* @param {string} stationId The kiosk\'s station id, as the venue\'s kiosk list answers it
|
|
71800
72655
|
* @param {ChangeKioskDto} changeKioskDto
|
|
@@ -71807,7 +72662,7 @@ export class VenueKiosksApi extends BaseAPI implements VenueKiosksApiInterface {
|
|
|
71807
72662
|
}
|
|
71808
72663
|
|
|
71809
72664
|
/**
|
|
71810
|
-
* The kiosk shows its Hardware ID on its Getting started screen until it is linked; the id is trimmed and written in the case the device sends it (an iOS vendor id upper case, an Android id lower case). A device that is one of the venue\'s tills, in use or not, or active at another venue, is refused first, before the licence is asked. A kiosk already in use here
|
|
72665
|
+
* The kiosk shows its Hardware ID on its Getting started screen until it is linked; the id is trimmed and written in the case the device sends it (an iOS vendor id upper case, an Android id lower case). A device that is one of the venue\'s tills, in use or not, or active at another venue, is refused first, before the licence is asked. A kiosk already in use here only takes the name, prefix and device sent, with no licence check. Otherwise the licence is read from the license server and must have the kiosk add-on; then, under a lock on the venue\'s kiosks and then one on the device, the device\'s other uses are checked again and the venue\'s active kiosks with this one must fit the licence\'s kiosk limit. The venue\'s station of the device becomes an active kiosk (type KIOSK), created when the venue has none (device KIOSK_STAND and prefix empty unless sent), with the name sent, and becomes the station the device resolves to; the kiosk then continues on its next check. A kiosk the venue already had, inactive, counts like a new one. Nothing is claimed unchecked: when the licence cannot be read, the claim is refused.
|
|
71811
72666
|
* @summary Link a kiosk to the venue by the Hardware ID it shows
|
|
71812
72667
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71813
72668
|
* @param {ClaimKioskDto} claimKioskDto
|