@munchi_oy/core 1.9.43 → 1.9.45
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 +595 -14
- 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 +611 -20
- package/package.json +1 -1
- package/src/version.ts +1 -1
package/generated/api.ts
CHANGED
|
@@ -3526,6 +3526,249 @@ export interface CreateManualSessionDto {
|
|
|
3526
3526
|
* @memberof CreateManualSessionDto
|
|
3527
3527
|
*/
|
|
3528
3528
|
'metadata'?: object;
|
|
3529
|
+
/**
|
|
3530
|
+
*
|
|
3531
|
+
* @type {CreateManualSessionDtoOrder}
|
|
3532
|
+
* @memberof CreateManualSessionDto
|
|
3533
|
+
*/
|
|
3534
|
+
'order': CreateManualSessionDtoOrder;
|
|
3535
|
+
/**
|
|
3536
|
+
* Cash handling config forwarded from the client. When enabled the backend additionally records a cash session.
|
|
3537
|
+
* @type {object}
|
|
3538
|
+
* @memberof CreateManualSessionDto
|
|
3539
|
+
*/
|
|
3540
|
+
'cashConfig'?: object;
|
|
3541
|
+
}
|
|
3542
|
+
|
|
3543
|
+
|
|
3544
|
+
/**
|
|
3545
|
+
* The full POS order (cart) this payment is for. Sent by the client instead of a separate Firestore upsert so the backend writes the order, records the payment and returns the computed order in one round-trip.
|
|
3546
|
+
* @export
|
|
3547
|
+
* @interface CreateManualSessionDtoOrder
|
|
3548
|
+
*/
|
|
3549
|
+
export interface CreateManualSessionDtoOrder {
|
|
3550
|
+
/**
|
|
3551
|
+
*
|
|
3552
|
+
* @type {string}
|
|
3553
|
+
* @memberof CreateManualSessionDtoOrder
|
|
3554
|
+
*/
|
|
3555
|
+
'id': string;
|
|
3556
|
+
/**
|
|
3557
|
+
*
|
|
3558
|
+
* @type {string}
|
|
3559
|
+
* @memberof CreateManualSessionDtoOrder
|
|
3560
|
+
*/
|
|
3561
|
+
'businessId': string;
|
|
3562
|
+
/**
|
|
3563
|
+
*
|
|
3564
|
+
* @type {ProviderEnum}
|
|
3565
|
+
* @memberof CreateManualSessionDtoOrder
|
|
3566
|
+
*/
|
|
3567
|
+
'provider': ProviderEnum;
|
|
3568
|
+
/**
|
|
3569
|
+
*
|
|
3570
|
+
* @type {CurrencyCode}
|
|
3571
|
+
* @memberof CreateManualSessionDtoOrder
|
|
3572
|
+
*/
|
|
3573
|
+
'currency': CurrencyCode;
|
|
3574
|
+
/**
|
|
3575
|
+
*
|
|
3576
|
+
* @type {PosBusinessDto}
|
|
3577
|
+
* @memberof CreateManualSessionDtoOrder
|
|
3578
|
+
*/
|
|
3579
|
+
'business': PosBusinessDto;
|
|
3580
|
+
/**
|
|
3581
|
+
*
|
|
3582
|
+
* @type {string}
|
|
3583
|
+
* @memberof CreateManualSessionDtoOrder
|
|
3584
|
+
*/
|
|
3585
|
+
'createdAt': string;
|
|
3586
|
+
/**
|
|
3587
|
+
*
|
|
3588
|
+
* @type {OrderStatusEnum}
|
|
3589
|
+
* @memberof CreateManualSessionDtoOrder
|
|
3590
|
+
*/
|
|
3591
|
+
'status': OrderStatusEnum;
|
|
3592
|
+
/**
|
|
3593
|
+
*
|
|
3594
|
+
* @type {string}
|
|
3595
|
+
* @memberof CreateManualSessionDtoOrder
|
|
3596
|
+
*/
|
|
3597
|
+
'updatedAt': string;
|
|
3598
|
+
/**
|
|
3599
|
+
*
|
|
3600
|
+
* @type {string}
|
|
3601
|
+
* @memberof CreateManualSessionDtoOrder
|
|
3602
|
+
*/
|
|
3603
|
+
'completedAt'?: string;
|
|
3604
|
+
/**
|
|
3605
|
+
*
|
|
3606
|
+
* @type {string}
|
|
3607
|
+
* @memberof CreateManualSessionDtoOrder
|
|
3608
|
+
*/
|
|
3609
|
+
'orderNumber': string;
|
|
3610
|
+
/**
|
|
3611
|
+
*
|
|
3612
|
+
* @type {CheckoutModelEnum}
|
|
3613
|
+
* @memberof CreateManualSessionDtoOrder
|
|
3614
|
+
*/
|
|
3615
|
+
'checkoutModel': CheckoutModelEnum;
|
|
3616
|
+
/**
|
|
3617
|
+
*
|
|
3618
|
+
* @type {OrderTypePOS}
|
|
3619
|
+
* @memberof CreateManualSessionDtoOrder
|
|
3620
|
+
*/
|
|
3621
|
+
'orderType': OrderTypePOS;
|
|
3622
|
+
/**
|
|
3623
|
+
*
|
|
3624
|
+
* @type {string}
|
|
3625
|
+
* @memberof CreateManualSessionDtoOrder
|
|
3626
|
+
*/
|
|
3627
|
+
'spotNumber': string | null;
|
|
3628
|
+
/**
|
|
3629
|
+
* ID of the floor plan dining table linked to this order
|
|
3630
|
+
* @type {string}
|
|
3631
|
+
* @memberof CreateManualSessionDtoOrder
|
|
3632
|
+
*/
|
|
3633
|
+
'tableId'?: string | null;
|
|
3634
|
+
/**
|
|
3635
|
+
*
|
|
3636
|
+
* @type {string}
|
|
3637
|
+
* @memberof CreateManualSessionDtoOrder
|
|
3638
|
+
*/
|
|
3639
|
+
'comments': string | null;
|
|
3640
|
+
/**
|
|
3641
|
+
*
|
|
3642
|
+
* @type {PosOrderDtoTableService}
|
|
3643
|
+
* @memberof CreateManualSessionDtoOrder
|
|
3644
|
+
*/
|
|
3645
|
+
'tableService'?: PosOrderDtoTableService | null;
|
|
3646
|
+
/**
|
|
3647
|
+
*
|
|
3648
|
+
* @type {PosOrderDtoEqualSplitState}
|
|
3649
|
+
* @memberof CreateManualSessionDtoOrder
|
|
3650
|
+
*/
|
|
3651
|
+
'equalSplitState'?: PosOrderDtoEqualSplitState | null;
|
|
3652
|
+
/**
|
|
3653
|
+
* Id of the staff in shift
|
|
3654
|
+
* @type {string}
|
|
3655
|
+
* @memberof CreateManualSessionDtoOrder
|
|
3656
|
+
*/
|
|
3657
|
+
'staffId': string | null;
|
|
3658
|
+
/**
|
|
3659
|
+
* Id of the shift
|
|
3660
|
+
* @type {string}
|
|
3661
|
+
* @memberof CreateManualSessionDtoOrder
|
|
3662
|
+
*/
|
|
3663
|
+
'shiftId': string | null;
|
|
3664
|
+
/**
|
|
3665
|
+
*
|
|
3666
|
+
* @type {OrderRefundStatus}
|
|
3667
|
+
* @memberof CreateManualSessionDtoOrder
|
|
3668
|
+
*/
|
|
3669
|
+
'orderRefundStatus': OrderRefundStatus;
|
|
3670
|
+
/**
|
|
3671
|
+
*
|
|
3672
|
+
* @type {LocatorType}
|
|
3673
|
+
* @memberof CreateManualSessionDtoOrder
|
|
3674
|
+
*/
|
|
3675
|
+
'locatorType': LocatorType;
|
|
3676
|
+
/**
|
|
3677
|
+
*
|
|
3678
|
+
* @type {PosOrderPriceDto}
|
|
3679
|
+
* @memberof CreateManualSessionDtoOrder
|
|
3680
|
+
*/
|
|
3681
|
+
'basketPrice': PosOrderPriceDto;
|
|
3682
|
+
/**
|
|
3683
|
+
*
|
|
3684
|
+
* @type {Array<PosOrderItemDto>}
|
|
3685
|
+
* @memberof CreateManualSessionDtoOrder
|
|
3686
|
+
*/
|
|
3687
|
+
'items': Array<PosOrderItemDto>;
|
|
3688
|
+
/**
|
|
3689
|
+
*
|
|
3690
|
+
* @type {Array<PosDiscountDto>}
|
|
3691
|
+
* @memberof CreateManualSessionDtoOrder
|
|
3692
|
+
*/
|
|
3693
|
+
'discounts': Array<PosDiscountDto>;
|
|
3694
|
+
/**
|
|
3695
|
+
*
|
|
3696
|
+
* @type {PosCustomerDto}
|
|
3697
|
+
* @memberof CreateManualSessionDtoOrder
|
|
3698
|
+
*/
|
|
3699
|
+
'customer': PosCustomerDto | null;
|
|
3700
|
+
/**
|
|
3701
|
+
*
|
|
3702
|
+
* @type {Array<TransactionDto>}
|
|
3703
|
+
* @memberof CreateManualSessionDtoOrder
|
|
3704
|
+
*/
|
|
3705
|
+
'paymentEvents': Array<TransactionDto>;
|
|
3706
|
+
/**
|
|
3707
|
+
*
|
|
3708
|
+
* @type {Array<PaymentRefundDto>}
|
|
3709
|
+
* @memberof CreateManualSessionDtoOrder
|
|
3710
|
+
*/
|
|
3711
|
+
'refunds'?: Array<PaymentRefundDto>;
|
|
3712
|
+
/**
|
|
3713
|
+
* Data version code
|
|
3714
|
+
* @type {string}
|
|
3715
|
+
* @memberof CreateManualSessionDtoOrder
|
|
3716
|
+
*/
|
|
3717
|
+
'version': string;
|
|
3718
|
+
/**
|
|
3719
|
+
*
|
|
3720
|
+
* @type {OrderFormat}
|
|
3721
|
+
* @memberof CreateManualSessionDtoOrder
|
|
3722
|
+
*/
|
|
3723
|
+
'orderFormat'?: OrderFormat;
|
|
3724
|
+
/**
|
|
3725
|
+
* The ID of the loyalty program active during this order.
|
|
3726
|
+
* @type {string}
|
|
3727
|
+
* @memberof CreateManualSessionDtoOrder
|
|
3728
|
+
*/
|
|
3729
|
+
'loyaltyProgramId': string | null;
|
|
3730
|
+
/**
|
|
3731
|
+
* An array of loyalty transaction IDs related to this order.
|
|
3732
|
+
* @type {Array<string>}
|
|
3733
|
+
* @memberof CreateManualSessionDtoOrder
|
|
3734
|
+
*/
|
|
3735
|
+
'loyaltyTransactionIds': Array<string>;
|
|
3736
|
+
/**
|
|
3737
|
+
*
|
|
3738
|
+
* @type {PosOrderDtoTaxSummary}
|
|
3739
|
+
* @memberof CreateManualSessionDtoOrder
|
|
3740
|
+
*/
|
|
3741
|
+
'taxSummary'?: PosOrderDtoTaxSummary;
|
|
3742
|
+
/**
|
|
3743
|
+
* Name of staff member who created the order
|
|
3744
|
+
* @type {string}
|
|
3745
|
+
* @memberof CreateManualSessionDtoOrder
|
|
3746
|
+
*/
|
|
3747
|
+
'staffName'?: string | null;
|
|
3748
|
+
/**
|
|
3749
|
+
*
|
|
3750
|
+
* @type {PosOrderDtoInvoiceCompany}
|
|
3751
|
+
* @memberof CreateManualSessionDtoOrder
|
|
3752
|
+
*/
|
|
3753
|
+
'invoiceCompany'?: PosOrderDtoInvoiceCompany | null;
|
|
3754
|
+
/**
|
|
3755
|
+
*
|
|
3756
|
+
* @type {object}
|
|
3757
|
+
* @memberof CreateManualSessionDtoOrder
|
|
3758
|
+
*/
|
|
3759
|
+
'lastPaymentError'?: object;
|
|
3760
|
+
/**
|
|
3761
|
+
*
|
|
3762
|
+
* @type {Array<OrderFeeDto>}
|
|
3763
|
+
* @memberof CreateManualSessionDtoOrder
|
|
3764
|
+
*/
|
|
3765
|
+
'fees'?: Array<OrderFeeDto> | null;
|
|
3766
|
+
/**
|
|
3767
|
+
* Loyalty user ID associated with this order
|
|
3768
|
+
* @type {number}
|
|
3769
|
+
* @memberof CreateManualSessionDtoOrder
|
|
3770
|
+
*/
|
|
3771
|
+
'targetUserId'?: number;
|
|
3529
3772
|
}
|
|
3530
3773
|
|
|
3531
3774
|
|
|
@@ -10017,6 +10260,18 @@ export interface OrderActionDataDto {
|
|
|
10017
10260
|
* @memberof OrderActionDataDto
|
|
10018
10261
|
*/
|
|
10019
10262
|
'targetUserId'?: number;
|
|
10263
|
+
/**
|
|
10264
|
+
* Line item IDs to fire for the CourseFire action
|
|
10265
|
+
* @type {Array<string>}
|
|
10266
|
+
* @memberof OrderActionDataDto
|
|
10267
|
+
*/
|
|
10268
|
+
'courseItemIds'?: Array<string>;
|
|
10269
|
+
/**
|
|
10270
|
+
* Course name used on the course-fire ticket
|
|
10271
|
+
* @type {string}
|
|
10272
|
+
* @memberof OrderActionDataDto
|
|
10273
|
+
*/
|
|
10274
|
+
'courseName'?: string;
|
|
10020
10275
|
}
|
|
10021
10276
|
/**
|
|
10022
10277
|
*
|
|
@@ -15197,7 +15452,8 @@ export const ActionsEnum = {
|
|
|
15197
15452
|
NewOrder: 'NewOrder',
|
|
15198
15453
|
Printing: 'Printing',
|
|
15199
15454
|
PosOrderChange: 'PosOrderChange',
|
|
15200
|
-
UpdateLoyaltyPoints: 'UpdateLoyaltyPoints'
|
|
15455
|
+
UpdateLoyaltyPoints: 'UpdateLoyaltyPoints',
|
|
15456
|
+
CourseFire: 'CourseFire'
|
|
15201
15457
|
} as const;
|
|
15202
15458
|
|
|
15203
15459
|
export type ActionsEnum = typeof ActionsEnum[keyof typeof ActionsEnum];
|
|
@@ -15232,6 +15488,18 @@ export interface ProcessOrderActionsDtoData {
|
|
|
15232
15488
|
* @memberof ProcessOrderActionsDtoData
|
|
15233
15489
|
*/
|
|
15234
15490
|
'targetUserId'?: number;
|
|
15491
|
+
/**
|
|
15492
|
+
* Line item IDs to fire for the CourseFire action
|
|
15493
|
+
* @type {Array<string>}
|
|
15494
|
+
* @memberof ProcessOrderActionsDtoData
|
|
15495
|
+
*/
|
|
15496
|
+
'courseItemIds'?: Array<string>;
|
|
15497
|
+
/**
|
|
15498
|
+
* Course name used on the course-fire ticket
|
|
15499
|
+
* @type {string}
|
|
15500
|
+
* @memberof ProcessOrderActionsDtoData
|
|
15501
|
+
*/
|
|
15502
|
+
'courseName'?: string;
|
|
15235
15503
|
}
|
|
15236
15504
|
/**
|
|
15237
15505
|
*
|
|
@@ -16211,6 +16479,298 @@ export interface ReceiptDetailsDto {
|
|
|
16211
16479
|
*/
|
|
16212
16480
|
'transactionStatusInformation': string;
|
|
16213
16481
|
}
|
|
16482
|
+
/**
|
|
16483
|
+
*
|
|
16484
|
+
* @export
|
|
16485
|
+
* @interface RecordManualPaymentResultDto
|
|
16486
|
+
*/
|
|
16487
|
+
export interface RecordManualPaymentResultDto {
|
|
16488
|
+
/**
|
|
16489
|
+
* Whether the payment was recorded on the order.
|
|
16490
|
+
* @type {boolean}
|
|
16491
|
+
* @memberof RecordManualPaymentResultDto
|
|
16492
|
+
*/
|
|
16493
|
+
'success': boolean;
|
|
16494
|
+
/**
|
|
16495
|
+
*
|
|
16496
|
+
* @type {RecordManualStatus}
|
|
16497
|
+
* @memberof RecordManualPaymentResultDto
|
|
16498
|
+
*/
|
|
16499
|
+
'status': RecordManualStatus;
|
|
16500
|
+
/**
|
|
16501
|
+
* Id of the paymentEvent just written to the order (SUCCESS only).
|
|
16502
|
+
* @type {string}
|
|
16503
|
+
* @memberof RecordManualPaymentResultDto
|
|
16504
|
+
*/
|
|
16505
|
+
'transactionId'?: string;
|
|
16506
|
+
/**
|
|
16507
|
+
* Machine-readable failure code (ORDER_ALREADY_PAID | EXCEEDS_AVAILABLE | ...).
|
|
16508
|
+
* @type {string}
|
|
16509
|
+
* @memberof RecordManualPaymentResultDto
|
|
16510
|
+
*/
|
|
16511
|
+
'errorCode'?: string;
|
|
16512
|
+
/**
|
|
16513
|
+
* Human-readable failure message.
|
|
16514
|
+
* @type {string}
|
|
16515
|
+
* @memberof RecordManualPaymentResultDto
|
|
16516
|
+
*/
|
|
16517
|
+
'errorMessage'?: string;
|
|
16518
|
+
/**
|
|
16519
|
+
*
|
|
16520
|
+
* @type {RecordManualPaymentResultDtoOrder}
|
|
16521
|
+
* @memberof RecordManualPaymentResultDto
|
|
16522
|
+
*/
|
|
16523
|
+
'order': RecordManualPaymentResultDtoOrder;
|
|
16524
|
+
}
|
|
16525
|
+
|
|
16526
|
+
|
|
16527
|
+
/**
|
|
16528
|
+
* The full POS order after the attempt — same shape as getPosOrderById returns.
|
|
16529
|
+
* @export
|
|
16530
|
+
* @interface RecordManualPaymentResultDtoOrder
|
|
16531
|
+
*/
|
|
16532
|
+
export interface RecordManualPaymentResultDtoOrder {
|
|
16533
|
+
/**
|
|
16534
|
+
*
|
|
16535
|
+
* @type {string}
|
|
16536
|
+
* @memberof RecordManualPaymentResultDtoOrder
|
|
16537
|
+
*/
|
|
16538
|
+
'id': string;
|
|
16539
|
+
/**
|
|
16540
|
+
*
|
|
16541
|
+
* @type {string}
|
|
16542
|
+
* @memberof RecordManualPaymentResultDtoOrder
|
|
16543
|
+
*/
|
|
16544
|
+
'businessId': string;
|
|
16545
|
+
/**
|
|
16546
|
+
*
|
|
16547
|
+
* @type {ProviderEnum}
|
|
16548
|
+
* @memberof RecordManualPaymentResultDtoOrder
|
|
16549
|
+
*/
|
|
16550
|
+
'provider': ProviderEnum;
|
|
16551
|
+
/**
|
|
16552
|
+
*
|
|
16553
|
+
* @type {CurrencyCode}
|
|
16554
|
+
* @memberof RecordManualPaymentResultDtoOrder
|
|
16555
|
+
*/
|
|
16556
|
+
'currency': CurrencyCode;
|
|
16557
|
+
/**
|
|
16558
|
+
*
|
|
16559
|
+
* @type {PosBusinessDto}
|
|
16560
|
+
* @memberof RecordManualPaymentResultDtoOrder
|
|
16561
|
+
*/
|
|
16562
|
+
'business': PosBusinessDto;
|
|
16563
|
+
/**
|
|
16564
|
+
*
|
|
16565
|
+
* @type {string}
|
|
16566
|
+
* @memberof RecordManualPaymentResultDtoOrder
|
|
16567
|
+
*/
|
|
16568
|
+
'createdAt': string;
|
|
16569
|
+
/**
|
|
16570
|
+
*
|
|
16571
|
+
* @type {OrderStatusEnum}
|
|
16572
|
+
* @memberof RecordManualPaymentResultDtoOrder
|
|
16573
|
+
*/
|
|
16574
|
+
'status': OrderStatusEnum;
|
|
16575
|
+
/**
|
|
16576
|
+
*
|
|
16577
|
+
* @type {string}
|
|
16578
|
+
* @memberof RecordManualPaymentResultDtoOrder
|
|
16579
|
+
*/
|
|
16580
|
+
'updatedAt': string;
|
|
16581
|
+
/**
|
|
16582
|
+
*
|
|
16583
|
+
* @type {string}
|
|
16584
|
+
* @memberof RecordManualPaymentResultDtoOrder
|
|
16585
|
+
*/
|
|
16586
|
+
'completedAt'?: string;
|
|
16587
|
+
/**
|
|
16588
|
+
*
|
|
16589
|
+
* @type {string}
|
|
16590
|
+
* @memberof RecordManualPaymentResultDtoOrder
|
|
16591
|
+
*/
|
|
16592
|
+
'orderNumber': string;
|
|
16593
|
+
/**
|
|
16594
|
+
*
|
|
16595
|
+
* @type {CheckoutModelEnum}
|
|
16596
|
+
* @memberof RecordManualPaymentResultDtoOrder
|
|
16597
|
+
*/
|
|
16598
|
+
'checkoutModel': CheckoutModelEnum;
|
|
16599
|
+
/**
|
|
16600
|
+
*
|
|
16601
|
+
* @type {OrderTypePOS}
|
|
16602
|
+
* @memberof RecordManualPaymentResultDtoOrder
|
|
16603
|
+
*/
|
|
16604
|
+
'orderType': OrderTypePOS;
|
|
16605
|
+
/**
|
|
16606
|
+
*
|
|
16607
|
+
* @type {string}
|
|
16608
|
+
* @memberof RecordManualPaymentResultDtoOrder
|
|
16609
|
+
*/
|
|
16610
|
+
'spotNumber': string | null;
|
|
16611
|
+
/**
|
|
16612
|
+
* ID of the floor plan dining table linked to this order
|
|
16613
|
+
* @type {string}
|
|
16614
|
+
* @memberof RecordManualPaymentResultDtoOrder
|
|
16615
|
+
*/
|
|
16616
|
+
'tableId'?: string | null;
|
|
16617
|
+
/**
|
|
16618
|
+
*
|
|
16619
|
+
* @type {string}
|
|
16620
|
+
* @memberof RecordManualPaymentResultDtoOrder
|
|
16621
|
+
*/
|
|
16622
|
+
'comments': string | null;
|
|
16623
|
+
/**
|
|
16624
|
+
*
|
|
16625
|
+
* @type {PosOrderDtoTableService}
|
|
16626
|
+
* @memberof RecordManualPaymentResultDtoOrder
|
|
16627
|
+
*/
|
|
16628
|
+
'tableService'?: PosOrderDtoTableService | null;
|
|
16629
|
+
/**
|
|
16630
|
+
*
|
|
16631
|
+
* @type {PosOrderDtoEqualSplitState}
|
|
16632
|
+
* @memberof RecordManualPaymentResultDtoOrder
|
|
16633
|
+
*/
|
|
16634
|
+
'equalSplitState'?: PosOrderDtoEqualSplitState | null;
|
|
16635
|
+
/**
|
|
16636
|
+
* Id of the staff in shift
|
|
16637
|
+
* @type {string}
|
|
16638
|
+
* @memberof RecordManualPaymentResultDtoOrder
|
|
16639
|
+
*/
|
|
16640
|
+
'staffId': string | null;
|
|
16641
|
+
/**
|
|
16642
|
+
* Id of the shift
|
|
16643
|
+
* @type {string}
|
|
16644
|
+
* @memberof RecordManualPaymentResultDtoOrder
|
|
16645
|
+
*/
|
|
16646
|
+
'shiftId': string | null;
|
|
16647
|
+
/**
|
|
16648
|
+
*
|
|
16649
|
+
* @type {OrderRefundStatus}
|
|
16650
|
+
* @memberof RecordManualPaymentResultDtoOrder
|
|
16651
|
+
*/
|
|
16652
|
+
'orderRefundStatus': OrderRefundStatus;
|
|
16653
|
+
/**
|
|
16654
|
+
*
|
|
16655
|
+
* @type {LocatorType}
|
|
16656
|
+
* @memberof RecordManualPaymentResultDtoOrder
|
|
16657
|
+
*/
|
|
16658
|
+
'locatorType': LocatorType;
|
|
16659
|
+
/**
|
|
16660
|
+
*
|
|
16661
|
+
* @type {PosOrderPriceDto}
|
|
16662
|
+
* @memberof RecordManualPaymentResultDtoOrder
|
|
16663
|
+
*/
|
|
16664
|
+
'basketPrice': PosOrderPriceDto;
|
|
16665
|
+
/**
|
|
16666
|
+
*
|
|
16667
|
+
* @type {Array<PosOrderItemDto>}
|
|
16668
|
+
* @memberof RecordManualPaymentResultDtoOrder
|
|
16669
|
+
*/
|
|
16670
|
+
'items': Array<PosOrderItemDto>;
|
|
16671
|
+
/**
|
|
16672
|
+
*
|
|
16673
|
+
* @type {Array<PosDiscountDto>}
|
|
16674
|
+
* @memberof RecordManualPaymentResultDtoOrder
|
|
16675
|
+
*/
|
|
16676
|
+
'discounts': Array<PosDiscountDto>;
|
|
16677
|
+
/**
|
|
16678
|
+
*
|
|
16679
|
+
* @type {PosCustomerDto}
|
|
16680
|
+
* @memberof RecordManualPaymentResultDtoOrder
|
|
16681
|
+
*/
|
|
16682
|
+
'customer': PosCustomerDto | null;
|
|
16683
|
+
/**
|
|
16684
|
+
*
|
|
16685
|
+
* @type {Array<TransactionDto>}
|
|
16686
|
+
* @memberof RecordManualPaymentResultDtoOrder
|
|
16687
|
+
*/
|
|
16688
|
+
'paymentEvents': Array<TransactionDto>;
|
|
16689
|
+
/**
|
|
16690
|
+
*
|
|
16691
|
+
* @type {Array<PaymentRefundDto>}
|
|
16692
|
+
* @memberof RecordManualPaymentResultDtoOrder
|
|
16693
|
+
*/
|
|
16694
|
+
'refunds'?: Array<PaymentRefundDto>;
|
|
16695
|
+
/**
|
|
16696
|
+
* Data version code
|
|
16697
|
+
* @type {string}
|
|
16698
|
+
* @memberof RecordManualPaymentResultDtoOrder
|
|
16699
|
+
*/
|
|
16700
|
+
'version': string;
|
|
16701
|
+
/**
|
|
16702
|
+
*
|
|
16703
|
+
* @type {OrderFormat}
|
|
16704
|
+
* @memberof RecordManualPaymentResultDtoOrder
|
|
16705
|
+
*/
|
|
16706
|
+
'orderFormat'?: OrderFormat;
|
|
16707
|
+
/**
|
|
16708
|
+
* The ID of the loyalty program active during this order.
|
|
16709
|
+
* @type {string}
|
|
16710
|
+
* @memberof RecordManualPaymentResultDtoOrder
|
|
16711
|
+
*/
|
|
16712
|
+
'loyaltyProgramId': string | null;
|
|
16713
|
+
/**
|
|
16714
|
+
* An array of loyalty transaction IDs related to this order.
|
|
16715
|
+
* @type {Array<string>}
|
|
16716
|
+
* @memberof RecordManualPaymentResultDtoOrder
|
|
16717
|
+
*/
|
|
16718
|
+
'loyaltyTransactionIds': Array<string>;
|
|
16719
|
+
/**
|
|
16720
|
+
*
|
|
16721
|
+
* @type {PosOrderDtoTaxSummary}
|
|
16722
|
+
* @memberof RecordManualPaymentResultDtoOrder
|
|
16723
|
+
*/
|
|
16724
|
+
'taxSummary'?: PosOrderDtoTaxSummary;
|
|
16725
|
+
/**
|
|
16726
|
+
* Name of staff member who created the order
|
|
16727
|
+
* @type {string}
|
|
16728
|
+
* @memberof RecordManualPaymentResultDtoOrder
|
|
16729
|
+
*/
|
|
16730
|
+
'staffName'?: string | null;
|
|
16731
|
+
/**
|
|
16732
|
+
*
|
|
16733
|
+
* @type {PosOrderDtoInvoiceCompany}
|
|
16734
|
+
* @memberof RecordManualPaymentResultDtoOrder
|
|
16735
|
+
*/
|
|
16736
|
+
'invoiceCompany'?: PosOrderDtoInvoiceCompany | null;
|
|
16737
|
+
/**
|
|
16738
|
+
*
|
|
16739
|
+
* @type {object}
|
|
16740
|
+
* @memberof RecordManualPaymentResultDtoOrder
|
|
16741
|
+
*/
|
|
16742
|
+
'lastPaymentError'?: object;
|
|
16743
|
+
/**
|
|
16744
|
+
*
|
|
16745
|
+
* @type {Array<OrderFeeDto>}
|
|
16746
|
+
* @memberof RecordManualPaymentResultDtoOrder
|
|
16747
|
+
*/
|
|
16748
|
+
'fees'?: Array<OrderFeeDto> | null;
|
|
16749
|
+
/**
|
|
16750
|
+
* Loyalty user ID associated with this order
|
|
16751
|
+
* @type {number}
|
|
16752
|
+
* @memberof RecordManualPaymentResultDtoOrder
|
|
16753
|
+
*/
|
|
16754
|
+
'targetUserId'?: number;
|
|
16755
|
+
}
|
|
16756
|
+
|
|
16757
|
+
|
|
16758
|
+
/**
|
|
16759
|
+
*
|
|
16760
|
+
* @export
|
|
16761
|
+
* @enum {string}
|
|
16762
|
+
*/
|
|
16763
|
+
|
|
16764
|
+
export const RecordManualStatus = {
|
|
16765
|
+
Success: 'SUCCESS',
|
|
16766
|
+
AlreadyPaid: 'ALREADY_PAID',
|
|
16767
|
+
Rejected: 'REJECTED',
|
|
16768
|
+
Failed: 'FAILED'
|
|
16769
|
+
} as const;
|
|
16770
|
+
|
|
16771
|
+
export type RecordManualStatus = typeof RecordManualStatus[keyof typeof RecordManualStatus];
|
|
16772
|
+
|
|
16773
|
+
|
|
16214
16774
|
/**
|
|
16215
16775
|
*
|
|
16216
16776
|
* @export
|
|
@@ -22619,6 +23179,37 @@ export const EventTypeIdEnum = {
|
|
|
22619
23179
|
|
|
22620
23180
|
export type EventTypeIdEnum = typeof EventTypeIdEnum[keyof typeof EventTypeIdEnum];
|
|
22621
23181
|
|
|
23182
|
+
/**
|
|
23183
|
+
*
|
|
23184
|
+
* @export
|
|
23185
|
+
* @interface VoidManualSessionDto
|
|
23186
|
+
*/
|
|
23187
|
+
export interface VoidManualSessionDto {
|
|
23188
|
+
/**
|
|
23189
|
+
* The order paymentEvent referenceId (sessionId) to reverse. No payment session is created for manual payments, so the order is located directly.
|
|
23190
|
+
* @type {string}
|
|
23191
|
+
* @memberof VoidManualSessionDto
|
|
23192
|
+
*/
|
|
23193
|
+
'sessionId': string;
|
|
23194
|
+
/**
|
|
23195
|
+
* The internal business ID.
|
|
23196
|
+
* @type {number}
|
|
23197
|
+
* @memberof VoidManualSessionDto
|
|
23198
|
+
*/
|
|
23199
|
+
'businessId': number;
|
|
23200
|
+
/**
|
|
23201
|
+
* The POS order ID the paymentEvent lives on.
|
|
23202
|
+
* @type {string}
|
|
23203
|
+
* @memberof VoidManualSessionDto
|
|
23204
|
+
*/
|
|
23205
|
+
'orderId': string;
|
|
23206
|
+
/**
|
|
23207
|
+
* Cash handling config forwarded from the client. When enabled the backend additionally records a REFUND cash log for the reversal.
|
|
23208
|
+
* @type {object}
|
|
23209
|
+
* @memberof VoidManualSessionDto
|
|
23210
|
+
*/
|
|
23211
|
+
'cashConfig'?: object;
|
|
23212
|
+
}
|
|
22622
23213
|
/**
|
|
22623
23214
|
*
|
|
22624
23215
|
* @export
|
|
@@ -38007,13 +38598,13 @@ export const PaymentSessionApiAxiosParamCreator = function (configuration?: Conf
|
|
|
38007
38598
|
/**
|
|
38008
38599
|
* Reverses a manually-recorded payment (cash / voucher / CardManual / gift card / …) by its sessionId (the order paymentEvent referenceId). Not for card paymethods (Card/Debit/Credit/Edenred) — those use cancel/refund. Idempotent: re-calling a voided session is a no-op.
|
|
38009
38600
|
* @summary Void a manual payment session
|
|
38010
|
-
* @param {
|
|
38601
|
+
* @param {VoidManualSessionDto} voidManualSessionDto
|
|
38011
38602
|
* @param {*} [options] Override http request option.
|
|
38012
38603
|
* @throws {RequiredError}
|
|
38013
38604
|
*/
|
|
38014
|
-
voidManualPayment: async (
|
|
38015
|
-
// verify required parameter '
|
|
38016
|
-
assertParamExists('voidManualPayment', '
|
|
38605
|
+
voidManualPayment: async (voidManualSessionDto: VoidManualSessionDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
38606
|
+
// verify required parameter 'voidManualSessionDto' is not null or undefined
|
|
38607
|
+
assertParamExists('voidManualPayment', 'voidManualSessionDto', voidManualSessionDto)
|
|
38017
38608
|
const localVarPath = `/api/v1/payment-session/void`;
|
|
38018
38609
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
38019
38610
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -38033,7 +38624,7 @@ export const PaymentSessionApiAxiosParamCreator = function (configuration?: Conf
|
|
|
38033
38624
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
38034
38625
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
38035
38626
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
38036
|
-
localVarRequestOptions.data = serializeDataIfNeeded(
|
|
38627
|
+
localVarRequestOptions.data = serializeDataIfNeeded(voidManualSessionDto, localVarRequestOptions, configuration)
|
|
38037
38628
|
|
|
38038
38629
|
return {
|
|
38039
38630
|
url: toPathString(localVarUrlObj),
|
|
@@ -38091,7 +38682,7 @@ export const PaymentSessionApiFp = function(configuration?: Configuration) {
|
|
|
38091
38682
|
* @param {*} [options] Override http request option.
|
|
38092
38683
|
* @throws {RequiredError}
|
|
38093
38684
|
*/
|
|
38094
|
-
async recordManualPayment(createManualSessionDto: CreateManualSessionDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
38685
|
+
async recordManualPayment(createManualSessionDto: CreateManualSessionDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RecordManualPaymentResultDto>> {
|
|
38095
38686
|
const localVarAxiosArgs = await localVarAxiosParamCreator.recordManualPayment(createManualSessionDto, options);
|
|
38096
38687
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
38097
38688
|
},
|
|
@@ -38120,12 +38711,12 @@ export const PaymentSessionApiFp = function(configuration?: Configuration) {
|
|
|
38120
38711
|
/**
|
|
38121
38712
|
* Reverses a manually-recorded payment (cash / voucher / CardManual / gift card / …) by its sessionId (the order paymentEvent referenceId). Not for card paymethods (Card/Debit/Credit/Edenred) — those use cancel/refund. Idempotent: re-calling a voided session is a no-op.
|
|
38122
38713
|
* @summary Void a manual payment session
|
|
38123
|
-
* @param {
|
|
38714
|
+
* @param {VoidManualSessionDto} voidManualSessionDto
|
|
38124
38715
|
* @param {*} [options] Override http request option.
|
|
38125
38716
|
* @throws {RequiredError}
|
|
38126
38717
|
*/
|
|
38127
|
-
async voidManualPayment(
|
|
38128
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.voidManualPayment(
|
|
38718
|
+
async voidManualPayment(voidManualSessionDto: VoidManualSessionDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RecordManualPaymentResultDto>> {
|
|
38719
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.voidManualPayment(voidManualSessionDto, options);
|
|
38129
38720
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
38130
38721
|
},
|
|
38131
38722
|
}
|
|
@@ -38176,7 +38767,7 @@ export const PaymentSessionApiFactory = function (configuration?: Configuration,
|
|
|
38176
38767
|
* @param {*} [options] Override http request option.
|
|
38177
38768
|
* @throws {RequiredError}
|
|
38178
38769
|
*/
|
|
38179
|
-
recordManualPayment(createManualSessionDto: CreateManualSessionDto, options?: any): AxiosPromise<
|
|
38770
|
+
recordManualPayment(createManualSessionDto: CreateManualSessionDto, options?: any): AxiosPromise<RecordManualPaymentResultDto> {
|
|
38180
38771
|
return localVarFp.recordManualPayment(createManualSessionDto, options).then((request) => request(axios, basePath));
|
|
38181
38772
|
},
|
|
38182
38773
|
/**
|
|
@@ -38202,12 +38793,12 @@ export const PaymentSessionApiFactory = function (configuration?: Configuration,
|
|
|
38202
38793
|
/**
|
|
38203
38794
|
* Reverses a manually-recorded payment (cash / voucher / CardManual / gift card / …) by its sessionId (the order paymentEvent referenceId). Not for card paymethods (Card/Debit/Credit/Edenred) — those use cancel/refund. Idempotent: re-calling a voided session is a no-op.
|
|
38204
38795
|
* @summary Void a manual payment session
|
|
38205
|
-
* @param {
|
|
38796
|
+
* @param {VoidManualSessionDto} voidManualSessionDto
|
|
38206
38797
|
* @param {*} [options] Override http request option.
|
|
38207
38798
|
* @throws {RequiredError}
|
|
38208
38799
|
*/
|
|
38209
|
-
voidManualPayment(
|
|
38210
|
-
return localVarFp.voidManualPayment(
|
|
38800
|
+
voidManualPayment(voidManualSessionDto: VoidManualSessionDto, options?: any): AxiosPromise<RecordManualPaymentResultDto> {
|
|
38801
|
+
return localVarFp.voidManualPayment(voidManualSessionDto, options).then((request) => request(axios, basePath));
|
|
38211
38802
|
},
|
|
38212
38803
|
};
|
|
38213
38804
|
};
|
|
@@ -38257,7 +38848,7 @@ export interface PaymentSessionApiInterface {
|
|
|
38257
38848
|
* @throws {RequiredError}
|
|
38258
38849
|
* @memberof PaymentSessionApiInterface
|
|
38259
38850
|
*/
|
|
38260
|
-
recordManualPayment(createManualSessionDto: CreateManualSessionDto, options?: AxiosRequestConfig): AxiosPromise<
|
|
38851
|
+
recordManualPayment(createManualSessionDto: CreateManualSessionDto, options?: AxiosRequestConfig): AxiosPromise<RecordManualPaymentResultDto>;
|
|
38261
38852
|
|
|
38262
38853
|
/**
|
|
38263
38854
|
* Refunds a Viva card payment at the gateway by its sessionId, optionally a partial `amount` (item / cluster refund). Validates the remaining refundable balance and supports multiple partial refunds. Does NOT write a reversal paymentEvent to the order — order-side accounting is handled by the refund plan. For a full reversal that writes the order paymentEvent, use /revert.
|
|
@@ -38282,12 +38873,12 @@ export interface PaymentSessionApiInterface {
|
|
|
38282
38873
|
/**
|
|
38283
38874
|
* Reverses a manually-recorded payment (cash / voucher / CardManual / gift card / …) by its sessionId (the order paymentEvent referenceId). Not for card paymethods (Card/Debit/Credit/Edenred) — those use cancel/refund. Idempotent: re-calling a voided session is a no-op.
|
|
38284
38875
|
* @summary Void a manual payment session
|
|
38285
|
-
* @param {
|
|
38876
|
+
* @param {VoidManualSessionDto} voidManualSessionDto
|
|
38286
38877
|
* @param {*} [options] Override http request option.
|
|
38287
38878
|
* @throws {RequiredError}
|
|
38288
38879
|
* @memberof PaymentSessionApiInterface
|
|
38289
38880
|
*/
|
|
38290
|
-
voidManualPayment(
|
|
38881
|
+
voidManualPayment(voidManualSessionDto: VoidManualSessionDto, options?: AxiosRequestConfig): AxiosPromise<RecordManualPaymentResultDto>;
|
|
38291
38882
|
|
|
38292
38883
|
}
|
|
38293
38884
|
|
|
@@ -38374,13 +38965,13 @@ export class PaymentSessionApi extends BaseAPI implements PaymentSessionApiInter
|
|
|
38374
38965
|
/**
|
|
38375
38966
|
* Reverses a manually-recorded payment (cash / voucher / CardManual / gift card / …) by its sessionId (the order paymentEvent referenceId). Not for card paymethods (Card/Debit/Credit/Edenred) — those use cancel/refund. Idempotent: re-calling a voided session is a no-op.
|
|
38376
38967
|
* @summary Void a manual payment session
|
|
38377
|
-
* @param {
|
|
38968
|
+
* @param {VoidManualSessionDto} voidManualSessionDto
|
|
38378
38969
|
* @param {*} [options] Override http request option.
|
|
38379
38970
|
* @throws {RequiredError}
|
|
38380
38971
|
* @memberof PaymentSessionApi
|
|
38381
38972
|
*/
|
|
38382
|
-
public voidManualPayment(
|
|
38383
|
-
return PaymentSessionApiFp(this.configuration).voidManualPayment(
|
|
38973
|
+
public voidManualPayment(voidManualSessionDto: VoidManualSessionDto, options?: AxiosRequestConfig) {
|
|
38974
|
+
return PaymentSessionApiFp(this.configuration).voidManualPayment(voidManualSessionDto, options).then((request) => request(this.axios, this.basePath));
|
|
38384
38975
|
}
|
|
38385
38976
|
}
|
|
38386
38977
|
|