@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/dist/generated/api.d.ts
CHANGED
|
@@ -3420,6 +3420,247 @@ export interface CreateManualSessionDto {
|
|
|
3420
3420
|
* @memberof CreateManualSessionDto
|
|
3421
3421
|
*/
|
|
3422
3422
|
'metadata'?: object;
|
|
3423
|
+
/**
|
|
3424
|
+
*
|
|
3425
|
+
* @type {CreateManualSessionDtoOrder}
|
|
3426
|
+
* @memberof CreateManualSessionDto
|
|
3427
|
+
*/
|
|
3428
|
+
'order': CreateManualSessionDtoOrder;
|
|
3429
|
+
/**
|
|
3430
|
+
* Cash handling config forwarded from the client. When enabled the backend additionally records a cash session.
|
|
3431
|
+
* @type {object}
|
|
3432
|
+
* @memberof CreateManualSessionDto
|
|
3433
|
+
*/
|
|
3434
|
+
'cashConfig'?: object;
|
|
3435
|
+
}
|
|
3436
|
+
/**
|
|
3437
|
+
* 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.
|
|
3438
|
+
* @export
|
|
3439
|
+
* @interface CreateManualSessionDtoOrder
|
|
3440
|
+
*/
|
|
3441
|
+
export interface CreateManualSessionDtoOrder {
|
|
3442
|
+
/**
|
|
3443
|
+
*
|
|
3444
|
+
* @type {string}
|
|
3445
|
+
* @memberof CreateManualSessionDtoOrder
|
|
3446
|
+
*/
|
|
3447
|
+
'id': string;
|
|
3448
|
+
/**
|
|
3449
|
+
*
|
|
3450
|
+
* @type {string}
|
|
3451
|
+
* @memberof CreateManualSessionDtoOrder
|
|
3452
|
+
*/
|
|
3453
|
+
'businessId': string;
|
|
3454
|
+
/**
|
|
3455
|
+
*
|
|
3456
|
+
* @type {ProviderEnum}
|
|
3457
|
+
* @memberof CreateManualSessionDtoOrder
|
|
3458
|
+
*/
|
|
3459
|
+
'provider': ProviderEnum;
|
|
3460
|
+
/**
|
|
3461
|
+
*
|
|
3462
|
+
* @type {CurrencyCode}
|
|
3463
|
+
* @memberof CreateManualSessionDtoOrder
|
|
3464
|
+
*/
|
|
3465
|
+
'currency': CurrencyCode;
|
|
3466
|
+
/**
|
|
3467
|
+
*
|
|
3468
|
+
* @type {PosBusinessDto}
|
|
3469
|
+
* @memberof CreateManualSessionDtoOrder
|
|
3470
|
+
*/
|
|
3471
|
+
'business': PosBusinessDto;
|
|
3472
|
+
/**
|
|
3473
|
+
*
|
|
3474
|
+
* @type {string}
|
|
3475
|
+
* @memberof CreateManualSessionDtoOrder
|
|
3476
|
+
*/
|
|
3477
|
+
'createdAt': string;
|
|
3478
|
+
/**
|
|
3479
|
+
*
|
|
3480
|
+
* @type {OrderStatusEnum}
|
|
3481
|
+
* @memberof CreateManualSessionDtoOrder
|
|
3482
|
+
*/
|
|
3483
|
+
'status': OrderStatusEnum;
|
|
3484
|
+
/**
|
|
3485
|
+
*
|
|
3486
|
+
* @type {string}
|
|
3487
|
+
* @memberof CreateManualSessionDtoOrder
|
|
3488
|
+
*/
|
|
3489
|
+
'updatedAt': string;
|
|
3490
|
+
/**
|
|
3491
|
+
*
|
|
3492
|
+
* @type {string}
|
|
3493
|
+
* @memberof CreateManualSessionDtoOrder
|
|
3494
|
+
*/
|
|
3495
|
+
'completedAt'?: string;
|
|
3496
|
+
/**
|
|
3497
|
+
*
|
|
3498
|
+
* @type {string}
|
|
3499
|
+
* @memberof CreateManualSessionDtoOrder
|
|
3500
|
+
*/
|
|
3501
|
+
'orderNumber': string;
|
|
3502
|
+
/**
|
|
3503
|
+
*
|
|
3504
|
+
* @type {CheckoutModelEnum}
|
|
3505
|
+
* @memberof CreateManualSessionDtoOrder
|
|
3506
|
+
*/
|
|
3507
|
+
'checkoutModel': CheckoutModelEnum;
|
|
3508
|
+
/**
|
|
3509
|
+
*
|
|
3510
|
+
* @type {OrderTypePOS}
|
|
3511
|
+
* @memberof CreateManualSessionDtoOrder
|
|
3512
|
+
*/
|
|
3513
|
+
'orderType': OrderTypePOS;
|
|
3514
|
+
/**
|
|
3515
|
+
*
|
|
3516
|
+
* @type {string}
|
|
3517
|
+
* @memberof CreateManualSessionDtoOrder
|
|
3518
|
+
*/
|
|
3519
|
+
'spotNumber': string | null;
|
|
3520
|
+
/**
|
|
3521
|
+
* ID of the floor plan dining table linked to this order
|
|
3522
|
+
* @type {string}
|
|
3523
|
+
* @memberof CreateManualSessionDtoOrder
|
|
3524
|
+
*/
|
|
3525
|
+
'tableId'?: string | null;
|
|
3526
|
+
/**
|
|
3527
|
+
*
|
|
3528
|
+
* @type {string}
|
|
3529
|
+
* @memberof CreateManualSessionDtoOrder
|
|
3530
|
+
*/
|
|
3531
|
+
'comments': string | null;
|
|
3532
|
+
/**
|
|
3533
|
+
*
|
|
3534
|
+
* @type {PosOrderDtoTableService}
|
|
3535
|
+
* @memberof CreateManualSessionDtoOrder
|
|
3536
|
+
*/
|
|
3537
|
+
'tableService'?: PosOrderDtoTableService | null;
|
|
3538
|
+
/**
|
|
3539
|
+
*
|
|
3540
|
+
* @type {PosOrderDtoEqualSplitState}
|
|
3541
|
+
* @memberof CreateManualSessionDtoOrder
|
|
3542
|
+
*/
|
|
3543
|
+
'equalSplitState'?: PosOrderDtoEqualSplitState | null;
|
|
3544
|
+
/**
|
|
3545
|
+
* Id of the staff in shift
|
|
3546
|
+
* @type {string}
|
|
3547
|
+
* @memberof CreateManualSessionDtoOrder
|
|
3548
|
+
*/
|
|
3549
|
+
'staffId': string | null;
|
|
3550
|
+
/**
|
|
3551
|
+
* Id of the shift
|
|
3552
|
+
* @type {string}
|
|
3553
|
+
* @memberof CreateManualSessionDtoOrder
|
|
3554
|
+
*/
|
|
3555
|
+
'shiftId': string | null;
|
|
3556
|
+
/**
|
|
3557
|
+
*
|
|
3558
|
+
* @type {OrderRefundStatus}
|
|
3559
|
+
* @memberof CreateManualSessionDtoOrder
|
|
3560
|
+
*/
|
|
3561
|
+
'orderRefundStatus': OrderRefundStatus;
|
|
3562
|
+
/**
|
|
3563
|
+
*
|
|
3564
|
+
* @type {LocatorType}
|
|
3565
|
+
* @memberof CreateManualSessionDtoOrder
|
|
3566
|
+
*/
|
|
3567
|
+
'locatorType': LocatorType;
|
|
3568
|
+
/**
|
|
3569
|
+
*
|
|
3570
|
+
* @type {PosOrderPriceDto}
|
|
3571
|
+
* @memberof CreateManualSessionDtoOrder
|
|
3572
|
+
*/
|
|
3573
|
+
'basketPrice': PosOrderPriceDto;
|
|
3574
|
+
/**
|
|
3575
|
+
*
|
|
3576
|
+
* @type {Array<PosOrderItemDto>}
|
|
3577
|
+
* @memberof CreateManualSessionDtoOrder
|
|
3578
|
+
*/
|
|
3579
|
+
'items': Array<PosOrderItemDto>;
|
|
3580
|
+
/**
|
|
3581
|
+
*
|
|
3582
|
+
* @type {Array<PosDiscountDto>}
|
|
3583
|
+
* @memberof CreateManualSessionDtoOrder
|
|
3584
|
+
*/
|
|
3585
|
+
'discounts': Array<PosDiscountDto>;
|
|
3586
|
+
/**
|
|
3587
|
+
*
|
|
3588
|
+
* @type {PosCustomerDto}
|
|
3589
|
+
* @memberof CreateManualSessionDtoOrder
|
|
3590
|
+
*/
|
|
3591
|
+
'customer': PosCustomerDto | null;
|
|
3592
|
+
/**
|
|
3593
|
+
*
|
|
3594
|
+
* @type {Array<TransactionDto>}
|
|
3595
|
+
* @memberof CreateManualSessionDtoOrder
|
|
3596
|
+
*/
|
|
3597
|
+
'paymentEvents': Array<TransactionDto>;
|
|
3598
|
+
/**
|
|
3599
|
+
*
|
|
3600
|
+
* @type {Array<PaymentRefundDto>}
|
|
3601
|
+
* @memberof CreateManualSessionDtoOrder
|
|
3602
|
+
*/
|
|
3603
|
+
'refunds'?: Array<PaymentRefundDto>;
|
|
3604
|
+
/**
|
|
3605
|
+
* Data version code
|
|
3606
|
+
* @type {string}
|
|
3607
|
+
* @memberof CreateManualSessionDtoOrder
|
|
3608
|
+
*/
|
|
3609
|
+
'version': string;
|
|
3610
|
+
/**
|
|
3611
|
+
*
|
|
3612
|
+
* @type {OrderFormat}
|
|
3613
|
+
* @memberof CreateManualSessionDtoOrder
|
|
3614
|
+
*/
|
|
3615
|
+
'orderFormat'?: OrderFormat;
|
|
3616
|
+
/**
|
|
3617
|
+
* The ID of the loyalty program active during this order.
|
|
3618
|
+
* @type {string}
|
|
3619
|
+
* @memberof CreateManualSessionDtoOrder
|
|
3620
|
+
*/
|
|
3621
|
+
'loyaltyProgramId': string | null;
|
|
3622
|
+
/**
|
|
3623
|
+
* An array of loyalty transaction IDs related to this order.
|
|
3624
|
+
* @type {Array<string>}
|
|
3625
|
+
* @memberof CreateManualSessionDtoOrder
|
|
3626
|
+
*/
|
|
3627
|
+
'loyaltyTransactionIds': Array<string>;
|
|
3628
|
+
/**
|
|
3629
|
+
*
|
|
3630
|
+
* @type {PosOrderDtoTaxSummary}
|
|
3631
|
+
* @memberof CreateManualSessionDtoOrder
|
|
3632
|
+
*/
|
|
3633
|
+
'taxSummary'?: PosOrderDtoTaxSummary;
|
|
3634
|
+
/**
|
|
3635
|
+
* Name of staff member who created the order
|
|
3636
|
+
* @type {string}
|
|
3637
|
+
* @memberof CreateManualSessionDtoOrder
|
|
3638
|
+
*/
|
|
3639
|
+
'staffName'?: string | null;
|
|
3640
|
+
/**
|
|
3641
|
+
*
|
|
3642
|
+
* @type {PosOrderDtoInvoiceCompany}
|
|
3643
|
+
* @memberof CreateManualSessionDtoOrder
|
|
3644
|
+
*/
|
|
3645
|
+
'invoiceCompany'?: PosOrderDtoInvoiceCompany | null;
|
|
3646
|
+
/**
|
|
3647
|
+
*
|
|
3648
|
+
* @type {object}
|
|
3649
|
+
* @memberof CreateManualSessionDtoOrder
|
|
3650
|
+
*/
|
|
3651
|
+
'lastPaymentError'?: object;
|
|
3652
|
+
/**
|
|
3653
|
+
*
|
|
3654
|
+
* @type {Array<OrderFeeDto>}
|
|
3655
|
+
* @memberof CreateManualSessionDtoOrder
|
|
3656
|
+
*/
|
|
3657
|
+
'fees'?: Array<OrderFeeDto> | null;
|
|
3658
|
+
/**
|
|
3659
|
+
* Loyalty user ID associated with this order
|
|
3660
|
+
* @type {number}
|
|
3661
|
+
* @memberof CreateManualSessionDtoOrder
|
|
3662
|
+
*/
|
|
3663
|
+
'targetUserId'?: number;
|
|
3423
3664
|
}
|
|
3424
3665
|
/**
|
|
3425
3666
|
*
|
|
@@ -9753,6 +9994,18 @@ export interface OrderActionDataDto {
|
|
|
9753
9994
|
* @memberof OrderActionDataDto
|
|
9754
9995
|
*/
|
|
9755
9996
|
'targetUserId'?: number;
|
|
9997
|
+
/**
|
|
9998
|
+
* Line item IDs to fire for the CourseFire action
|
|
9999
|
+
* @type {Array<string>}
|
|
10000
|
+
* @memberof OrderActionDataDto
|
|
10001
|
+
*/
|
|
10002
|
+
'courseItemIds'?: Array<string>;
|
|
10003
|
+
/**
|
|
10004
|
+
* Course name used on the course-fire ticket
|
|
10005
|
+
* @type {string}
|
|
10006
|
+
* @memberof OrderActionDataDto
|
|
10007
|
+
*/
|
|
10008
|
+
'courseName'?: string;
|
|
9756
10009
|
}
|
|
9757
10010
|
/**
|
|
9758
10011
|
*
|
|
@@ -14769,6 +15022,7 @@ export declare const ActionsEnum: {
|
|
|
14769
15022
|
readonly Printing: "Printing";
|
|
14770
15023
|
readonly PosOrderChange: "PosOrderChange";
|
|
14771
15024
|
readonly UpdateLoyaltyPoints: "UpdateLoyaltyPoints";
|
|
15025
|
+
readonly CourseFire: "CourseFire";
|
|
14772
15026
|
};
|
|
14773
15027
|
export type ActionsEnum = typeof ActionsEnum[keyof typeof ActionsEnum];
|
|
14774
15028
|
/**
|
|
@@ -14801,6 +15055,18 @@ export interface ProcessOrderActionsDtoData {
|
|
|
14801
15055
|
* @memberof ProcessOrderActionsDtoData
|
|
14802
15056
|
*/
|
|
14803
15057
|
'targetUserId'?: number;
|
|
15058
|
+
/**
|
|
15059
|
+
* Line item IDs to fire for the CourseFire action
|
|
15060
|
+
* @type {Array<string>}
|
|
15061
|
+
* @memberof ProcessOrderActionsDtoData
|
|
15062
|
+
*/
|
|
15063
|
+
'courseItemIds'?: Array<string>;
|
|
15064
|
+
/**
|
|
15065
|
+
* Course name used on the course-fire ticket
|
|
15066
|
+
* @type {string}
|
|
15067
|
+
* @memberof ProcessOrderActionsDtoData
|
|
15068
|
+
*/
|
|
15069
|
+
'courseName'?: string;
|
|
14804
15070
|
}
|
|
14805
15071
|
/**
|
|
14806
15072
|
*
|
|
@@ -15748,6 +16014,290 @@ export interface ReceiptDetailsDto {
|
|
|
15748
16014
|
*/
|
|
15749
16015
|
'transactionStatusInformation': string;
|
|
15750
16016
|
}
|
|
16017
|
+
/**
|
|
16018
|
+
*
|
|
16019
|
+
* @export
|
|
16020
|
+
* @interface RecordManualPaymentResultDto
|
|
16021
|
+
*/
|
|
16022
|
+
export interface RecordManualPaymentResultDto {
|
|
16023
|
+
/**
|
|
16024
|
+
* Whether the payment was recorded on the order.
|
|
16025
|
+
* @type {boolean}
|
|
16026
|
+
* @memberof RecordManualPaymentResultDto
|
|
16027
|
+
*/
|
|
16028
|
+
'success': boolean;
|
|
16029
|
+
/**
|
|
16030
|
+
*
|
|
16031
|
+
* @type {RecordManualStatus}
|
|
16032
|
+
* @memberof RecordManualPaymentResultDto
|
|
16033
|
+
*/
|
|
16034
|
+
'status': RecordManualStatus;
|
|
16035
|
+
/**
|
|
16036
|
+
* Id of the paymentEvent just written to the order (SUCCESS only).
|
|
16037
|
+
* @type {string}
|
|
16038
|
+
* @memberof RecordManualPaymentResultDto
|
|
16039
|
+
*/
|
|
16040
|
+
'transactionId'?: string;
|
|
16041
|
+
/**
|
|
16042
|
+
* Machine-readable failure code (ORDER_ALREADY_PAID | EXCEEDS_AVAILABLE | ...).
|
|
16043
|
+
* @type {string}
|
|
16044
|
+
* @memberof RecordManualPaymentResultDto
|
|
16045
|
+
*/
|
|
16046
|
+
'errorCode'?: string;
|
|
16047
|
+
/**
|
|
16048
|
+
* Human-readable failure message.
|
|
16049
|
+
* @type {string}
|
|
16050
|
+
* @memberof RecordManualPaymentResultDto
|
|
16051
|
+
*/
|
|
16052
|
+
'errorMessage'?: string;
|
|
16053
|
+
/**
|
|
16054
|
+
*
|
|
16055
|
+
* @type {RecordManualPaymentResultDtoOrder}
|
|
16056
|
+
* @memberof RecordManualPaymentResultDto
|
|
16057
|
+
*/
|
|
16058
|
+
'order': RecordManualPaymentResultDtoOrder;
|
|
16059
|
+
}
|
|
16060
|
+
/**
|
|
16061
|
+
* The full POS order after the attempt — same shape as getPosOrderById returns.
|
|
16062
|
+
* @export
|
|
16063
|
+
* @interface RecordManualPaymentResultDtoOrder
|
|
16064
|
+
*/
|
|
16065
|
+
export interface RecordManualPaymentResultDtoOrder {
|
|
16066
|
+
/**
|
|
16067
|
+
*
|
|
16068
|
+
* @type {string}
|
|
16069
|
+
* @memberof RecordManualPaymentResultDtoOrder
|
|
16070
|
+
*/
|
|
16071
|
+
'id': string;
|
|
16072
|
+
/**
|
|
16073
|
+
*
|
|
16074
|
+
* @type {string}
|
|
16075
|
+
* @memberof RecordManualPaymentResultDtoOrder
|
|
16076
|
+
*/
|
|
16077
|
+
'businessId': string;
|
|
16078
|
+
/**
|
|
16079
|
+
*
|
|
16080
|
+
* @type {ProviderEnum}
|
|
16081
|
+
* @memberof RecordManualPaymentResultDtoOrder
|
|
16082
|
+
*/
|
|
16083
|
+
'provider': ProviderEnum;
|
|
16084
|
+
/**
|
|
16085
|
+
*
|
|
16086
|
+
* @type {CurrencyCode}
|
|
16087
|
+
* @memberof RecordManualPaymentResultDtoOrder
|
|
16088
|
+
*/
|
|
16089
|
+
'currency': CurrencyCode;
|
|
16090
|
+
/**
|
|
16091
|
+
*
|
|
16092
|
+
* @type {PosBusinessDto}
|
|
16093
|
+
* @memberof RecordManualPaymentResultDtoOrder
|
|
16094
|
+
*/
|
|
16095
|
+
'business': PosBusinessDto;
|
|
16096
|
+
/**
|
|
16097
|
+
*
|
|
16098
|
+
* @type {string}
|
|
16099
|
+
* @memberof RecordManualPaymentResultDtoOrder
|
|
16100
|
+
*/
|
|
16101
|
+
'createdAt': string;
|
|
16102
|
+
/**
|
|
16103
|
+
*
|
|
16104
|
+
* @type {OrderStatusEnum}
|
|
16105
|
+
* @memberof RecordManualPaymentResultDtoOrder
|
|
16106
|
+
*/
|
|
16107
|
+
'status': OrderStatusEnum;
|
|
16108
|
+
/**
|
|
16109
|
+
*
|
|
16110
|
+
* @type {string}
|
|
16111
|
+
* @memberof RecordManualPaymentResultDtoOrder
|
|
16112
|
+
*/
|
|
16113
|
+
'updatedAt': string;
|
|
16114
|
+
/**
|
|
16115
|
+
*
|
|
16116
|
+
* @type {string}
|
|
16117
|
+
* @memberof RecordManualPaymentResultDtoOrder
|
|
16118
|
+
*/
|
|
16119
|
+
'completedAt'?: string;
|
|
16120
|
+
/**
|
|
16121
|
+
*
|
|
16122
|
+
* @type {string}
|
|
16123
|
+
* @memberof RecordManualPaymentResultDtoOrder
|
|
16124
|
+
*/
|
|
16125
|
+
'orderNumber': string;
|
|
16126
|
+
/**
|
|
16127
|
+
*
|
|
16128
|
+
* @type {CheckoutModelEnum}
|
|
16129
|
+
* @memberof RecordManualPaymentResultDtoOrder
|
|
16130
|
+
*/
|
|
16131
|
+
'checkoutModel': CheckoutModelEnum;
|
|
16132
|
+
/**
|
|
16133
|
+
*
|
|
16134
|
+
* @type {OrderTypePOS}
|
|
16135
|
+
* @memberof RecordManualPaymentResultDtoOrder
|
|
16136
|
+
*/
|
|
16137
|
+
'orderType': OrderTypePOS;
|
|
16138
|
+
/**
|
|
16139
|
+
*
|
|
16140
|
+
* @type {string}
|
|
16141
|
+
* @memberof RecordManualPaymentResultDtoOrder
|
|
16142
|
+
*/
|
|
16143
|
+
'spotNumber': string | null;
|
|
16144
|
+
/**
|
|
16145
|
+
* ID of the floor plan dining table linked to this order
|
|
16146
|
+
* @type {string}
|
|
16147
|
+
* @memberof RecordManualPaymentResultDtoOrder
|
|
16148
|
+
*/
|
|
16149
|
+
'tableId'?: string | null;
|
|
16150
|
+
/**
|
|
16151
|
+
*
|
|
16152
|
+
* @type {string}
|
|
16153
|
+
* @memberof RecordManualPaymentResultDtoOrder
|
|
16154
|
+
*/
|
|
16155
|
+
'comments': string | null;
|
|
16156
|
+
/**
|
|
16157
|
+
*
|
|
16158
|
+
* @type {PosOrderDtoTableService}
|
|
16159
|
+
* @memberof RecordManualPaymentResultDtoOrder
|
|
16160
|
+
*/
|
|
16161
|
+
'tableService'?: PosOrderDtoTableService | null;
|
|
16162
|
+
/**
|
|
16163
|
+
*
|
|
16164
|
+
* @type {PosOrderDtoEqualSplitState}
|
|
16165
|
+
* @memberof RecordManualPaymentResultDtoOrder
|
|
16166
|
+
*/
|
|
16167
|
+
'equalSplitState'?: PosOrderDtoEqualSplitState | null;
|
|
16168
|
+
/**
|
|
16169
|
+
* Id of the staff in shift
|
|
16170
|
+
* @type {string}
|
|
16171
|
+
* @memberof RecordManualPaymentResultDtoOrder
|
|
16172
|
+
*/
|
|
16173
|
+
'staffId': string | null;
|
|
16174
|
+
/**
|
|
16175
|
+
* Id of the shift
|
|
16176
|
+
* @type {string}
|
|
16177
|
+
* @memberof RecordManualPaymentResultDtoOrder
|
|
16178
|
+
*/
|
|
16179
|
+
'shiftId': string | null;
|
|
16180
|
+
/**
|
|
16181
|
+
*
|
|
16182
|
+
* @type {OrderRefundStatus}
|
|
16183
|
+
* @memberof RecordManualPaymentResultDtoOrder
|
|
16184
|
+
*/
|
|
16185
|
+
'orderRefundStatus': OrderRefundStatus;
|
|
16186
|
+
/**
|
|
16187
|
+
*
|
|
16188
|
+
* @type {LocatorType}
|
|
16189
|
+
* @memberof RecordManualPaymentResultDtoOrder
|
|
16190
|
+
*/
|
|
16191
|
+
'locatorType': LocatorType;
|
|
16192
|
+
/**
|
|
16193
|
+
*
|
|
16194
|
+
* @type {PosOrderPriceDto}
|
|
16195
|
+
* @memberof RecordManualPaymentResultDtoOrder
|
|
16196
|
+
*/
|
|
16197
|
+
'basketPrice': PosOrderPriceDto;
|
|
16198
|
+
/**
|
|
16199
|
+
*
|
|
16200
|
+
* @type {Array<PosOrderItemDto>}
|
|
16201
|
+
* @memberof RecordManualPaymentResultDtoOrder
|
|
16202
|
+
*/
|
|
16203
|
+
'items': Array<PosOrderItemDto>;
|
|
16204
|
+
/**
|
|
16205
|
+
*
|
|
16206
|
+
* @type {Array<PosDiscountDto>}
|
|
16207
|
+
* @memberof RecordManualPaymentResultDtoOrder
|
|
16208
|
+
*/
|
|
16209
|
+
'discounts': Array<PosDiscountDto>;
|
|
16210
|
+
/**
|
|
16211
|
+
*
|
|
16212
|
+
* @type {PosCustomerDto}
|
|
16213
|
+
* @memberof RecordManualPaymentResultDtoOrder
|
|
16214
|
+
*/
|
|
16215
|
+
'customer': PosCustomerDto | null;
|
|
16216
|
+
/**
|
|
16217
|
+
*
|
|
16218
|
+
* @type {Array<TransactionDto>}
|
|
16219
|
+
* @memberof RecordManualPaymentResultDtoOrder
|
|
16220
|
+
*/
|
|
16221
|
+
'paymentEvents': Array<TransactionDto>;
|
|
16222
|
+
/**
|
|
16223
|
+
*
|
|
16224
|
+
* @type {Array<PaymentRefundDto>}
|
|
16225
|
+
* @memberof RecordManualPaymentResultDtoOrder
|
|
16226
|
+
*/
|
|
16227
|
+
'refunds'?: Array<PaymentRefundDto>;
|
|
16228
|
+
/**
|
|
16229
|
+
* Data version code
|
|
16230
|
+
* @type {string}
|
|
16231
|
+
* @memberof RecordManualPaymentResultDtoOrder
|
|
16232
|
+
*/
|
|
16233
|
+
'version': string;
|
|
16234
|
+
/**
|
|
16235
|
+
*
|
|
16236
|
+
* @type {OrderFormat}
|
|
16237
|
+
* @memberof RecordManualPaymentResultDtoOrder
|
|
16238
|
+
*/
|
|
16239
|
+
'orderFormat'?: OrderFormat;
|
|
16240
|
+
/**
|
|
16241
|
+
* The ID of the loyalty program active during this order.
|
|
16242
|
+
* @type {string}
|
|
16243
|
+
* @memberof RecordManualPaymentResultDtoOrder
|
|
16244
|
+
*/
|
|
16245
|
+
'loyaltyProgramId': string | null;
|
|
16246
|
+
/**
|
|
16247
|
+
* An array of loyalty transaction IDs related to this order.
|
|
16248
|
+
* @type {Array<string>}
|
|
16249
|
+
* @memberof RecordManualPaymentResultDtoOrder
|
|
16250
|
+
*/
|
|
16251
|
+
'loyaltyTransactionIds': Array<string>;
|
|
16252
|
+
/**
|
|
16253
|
+
*
|
|
16254
|
+
* @type {PosOrderDtoTaxSummary}
|
|
16255
|
+
* @memberof RecordManualPaymentResultDtoOrder
|
|
16256
|
+
*/
|
|
16257
|
+
'taxSummary'?: PosOrderDtoTaxSummary;
|
|
16258
|
+
/**
|
|
16259
|
+
* Name of staff member who created the order
|
|
16260
|
+
* @type {string}
|
|
16261
|
+
* @memberof RecordManualPaymentResultDtoOrder
|
|
16262
|
+
*/
|
|
16263
|
+
'staffName'?: string | null;
|
|
16264
|
+
/**
|
|
16265
|
+
*
|
|
16266
|
+
* @type {PosOrderDtoInvoiceCompany}
|
|
16267
|
+
* @memberof RecordManualPaymentResultDtoOrder
|
|
16268
|
+
*/
|
|
16269
|
+
'invoiceCompany'?: PosOrderDtoInvoiceCompany | null;
|
|
16270
|
+
/**
|
|
16271
|
+
*
|
|
16272
|
+
* @type {object}
|
|
16273
|
+
* @memberof RecordManualPaymentResultDtoOrder
|
|
16274
|
+
*/
|
|
16275
|
+
'lastPaymentError'?: object;
|
|
16276
|
+
/**
|
|
16277
|
+
*
|
|
16278
|
+
* @type {Array<OrderFeeDto>}
|
|
16279
|
+
* @memberof RecordManualPaymentResultDtoOrder
|
|
16280
|
+
*/
|
|
16281
|
+
'fees'?: Array<OrderFeeDto> | null;
|
|
16282
|
+
/**
|
|
16283
|
+
* Loyalty user ID associated with this order
|
|
16284
|
+
* @type {number}
|
|
16285
|
+
* @memberof RecordManualPaymentResultDtoOrder
|
|
16286
|
+
*/
|
|
16287
|
+
'targetUserId'?: number;
|
|
16288
|
+
}
|
|
16289
|
+
/**
|
|
16290
|
+
*
|
|
16291
|
+
* @export
|
|
16292
|
+
* @enum {string}
|
|
16293
|
+
*/
|
|
16294
|
+
export declare const RecordManualStatus: {
|
|
16295
|
+
readonly Success: "SUCCESS";
|
|
16296
|
+
readonly AlreadyPaid: "ALREADY_PAID";
|
|
16297
|
+
readonly Rejected: "REJECTED";
|
|
16298
|
+
readonly Failed: "FAILED";
|
|
16299
|
+
};
|
|
16300
|
+
export type RecordManualStatus = typeof RecordManualStatus[keyof typeof RecordManualStatus];
|
|
15751
16301
|
/**
|
|
15752
16302
|
*
|
|
15753
16303
|
* @export
|
|
@@ -21964,6 +22514,37 @@ export declare const EventTypeIdEnum: {
|
|
|
21964
22514
|
readonly NUMBER_8194: 8194;
|
|
21965
22515
|
};
|
|
21966
22516
|
export type EventTypeIdEnum = typeof EventTypeIdEnum[keyof typeof EventTypeIdEnum];
|
|
22517
|
+
/**
|
|
22518
|
+
*
|
|
22519
|
+
* @export
|
|
22520
|
+
* @interface VoidManualSessionDto
|
|
22521
|
+
*/
|
|
22522
|
+
export interface VoidManualSessionDto {
|
|
22523
|
+
/**
|
|
22524
|
+
* The order paymentEvent referenceId (sessionId) to reverse. No payment session is created for manual payments, so the order is located directly.
|
|
22525
|
+
* @type {string}
|
|
22526
|
+
* @memberof VoidManualSessionDto
|
|
22527
|
+
*/
|
|
22528
|
+
'sessionId': string;
|
|
22529
|
+
/**
|
|
22530
|
+
* The internal business ID.
|
|
22531
|
+
* @type {number}
|
|
22532
|
+
* @memberof VoidManualSessionDto
|
|
22533
|
+
*/
|
|
22534
|
+
'businessId': number;
|
|
22535
|
+
/**
|
|
22536
|
+
* The POS order ID the paymentEvent lives on.
|
|
22537
|
+
* @type {string}
|
|
22538
|
+
* @memberof VoidManualSessionDto
|
|
22539
|
+
*/
|
|
22540
|
+
'orderId': string;
|
|
22541
|
+
/**
|
|
22542
|
+
* Cash handling config forwarded from the client. When enabled the backend additionally records a REFUND cash log for the reversal.
|
|
22543
|
+
* @type {object}
|
|
22544
|
+
* @memberof VoidManualSessionDto
|
|
22545
|
+
*/
|
|
22546
|
+
'cashConfig'?: object;
|
|
22547
|
+
}
|
|
21967
22548
|
/**
|
|
21968
22549
|
*
|
|
21969
22550
|
* @export
|
|
@@ -30738,11 +31319,11 @@ export declare const PaymentSessionApiAxiosParamCreator: (configuration?: Config
|
|
|
30738
31319
|
/**
|
|
30739
31320
|
* 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.
|
|
30740
31321
|
* @summary Void a manual payment session
|
|
30741
|
-
* @param {
|
|
31322
|
+
* @param {VoidManualSessionDto} voidManualSessionDto
|
|
30742
31323
|
* @param {*} [options] Override http request option.
|
|
30743
31324
|
* @throws {RequiredError}
|
|
30744
31325
|
*/
|
|
30745
|
-
voidManualPayment: (
|
|
31326
|
+
voidManualPayment: (voidManualSessionDto: VoidManualSessionDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
30746
31327
|
};
|
|
30747
31328
|
/**
|
|
30748
31329
|
* PaymentSessionApi - functional programming interface
|
|
@@ -30781,7 +31362,7 @@ export declare const PaymentSessionApiFp: (configuration?: Configuration) => {
|
|
|
30781
31362
|
* @param {*} [options] Override http request option.
|
|
30782
31363
|
* @throws {RequiredError}
|
|
30783
31364
|
*/
|
|
30784
|
-
recordManualPayment(createManualSessionDto: CreateManualSessionDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
31365
|
+
recordManualPayment(createManualSessionDto: CreateManualSessionDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RecordManualPaymentResultDto>>;
|
|
30785
31366
|
/**
|
|
30786
31367
|
* 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.
|
|
30787
31368
|
* @summary Refund a settled Viva payment session (gateway only)
|
|
@@ -30801,11 +31382,11 @@ export declare const PaymentSessionApiFp: (configuration?: Configuration) => {
|
|
|
30801
31382
|
/**
|
|
30802
31383
|
* 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.
|
|
30803
31384
|
* @summary Void a manual payment session
|
|
30804
|
-
* @param {
|
|
31385
|
+
* @param {VoidManualSessionDto} voidManualSessionDto
|
|
30805
31386
|
* @param {*} [options] Override http request option.
|
|
30806
31387
|
* @throws {RequiredError}
|
|
30807
31388
|
*/
|
|
30808
|
-
voidManualPayment(
|
|
31389
|
+
voidManualPayment(voidManualSessionDto: VoidManualSessionDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RecordManualPaymentResultDto>>;
|
|
30809
31390
|
};
|
|
30810
31391
|
/**
|
|
30811
31392
|
* PaymentSessionApi - factory interface
|
|
@@ -30844,7 +31425,7 @@ export declare const PaymentSessionApiFactory: (configuration?: Configuration, b
|
|
|
30844
31425
|
* @param {*} [options] Override http request option.
|
|
30845
31426
|
* @throws {RequiredError}
|
|
30846
31427
|
*/
|
|
30847
|
-
recordManualPayment(createManualSessionDto: CreateManualSessionDto, options?: any): AxiosPromise<
|
|
31428
|
+
recordManualPayment(createManualSessionDto: CreateManualSessionDto, options?: any): AxiosPromise<RecordManualPaymentResultDto>;
|
|
30848
31429
|
/**
|
|
30849
31430
|
* 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.
|
|
30850
31431
|
* @summary Refund a settled Viva payment session (gateway only)
|
|
@@ -30864,11 +31445,11 @@ export declare const PaymentSessionApiFactory: (configuration?: Configuration, b
|
|
|
30864
31445
|
/**
|
|
30865
31446
|
* 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.
|
|
30866
31447
|
* @summary Void a manual payment session
|
|
30867
|
-
* @param {
|
|
31448
|
+
* @param {VoidManualSessionDto} voidManualSessionDto
|
|
30868
31449
|
* @param {*} [options] Override http request option.
|
|
30869
31450
|
* @throws {RequiredError}
|
|
30870
31451
|
*/
|
|
30871
|
-
voidManualPayment(
|
|
31452
|
+
voidManualPayment(voidManualSessionDto: VoidManualSessionDto, options?: any): AxiosPromise<RecordManualPaymentResultDto>;
|
|
30872
31453
|
};
|
|
30873
31454
|
/**
|
|
30874
31455
|
* PaymentSessionApi - interface
|
|
@@ -30912,7 +31493,7 @@ export interface PaymentSessionApiInterface {
|
|
|
30912
31493
|
* @throws {RequiredError}
|
|
30913
31494
|
* @memberof PaymentSessionApiInterface
|
|
30914
31495
|
*/
|
|
30915
|
-
recordManualPayment(createManualSessionDto: CreateManualSessionDto, options?: AxiosRequestConfig): AxiosPromise<
|
|
31496
|
+
recordManualPayment(createManualSessionDto: CreateManualSessionDto, options?: AxiosRequestConfig): AxiosPromise<RecordManualPaymentResultDto>;
|
|
30916
31497
|
/**
|
|
30917
31498
|
* 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.
|
|
30918
31499
|
* @summary Refund a settled Viva payment session (gateway only)
|
|
@@ -30934,12 +31515,12 @@ export interface PaymentSessionApiInterface {
|
|
|
30934
31515
|
/**
|
|
30935
31516
|
* 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.
|
|
30936
31517
|
* @summary Void a manual payment session
|
|
30937
|
-
* @param {
|
|
31518
|
+
* @param {VoidManualSessionDto} voidManualSessionDto
|
|
30938
31519
|
* @param {*} [options] Override http request option.
|
|
30939
31520
|
* @throws {RequiredError}
|
|
30940
31521
|
* @memberof PaymentSessionApiInterface
|
|
30941
31522
|
*/
|
|
30942
|
-
voidManualPayment(
|
|
31523
|
+
voidManualPayment(voidManualSessionDto: VoidManualSessionDto, options?: AxiosRequestConfig): AxiosPromise<RecordManualPaymentResultDto>;
|
|
30943
31524
|
}
|
|
30944
31525
|
/**
|
|
30945
31526
|
* PaymentSessionApi - object-oriented interface
|
|
@@ -30984,7 +31565,7 @@ export declare class PaymentSessionApi extends BaseAPI implements PaymentSession
|
|
|
30984
31565
|
* @throws {RequiredError}
|
|
30985
31566
|
* @memberof PaymentSessionApi
|
|
30986
31567
|
*/
|
|
30987
|
-
recordManualPayment(createManualSessionDto: CreateManualSessionDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
31568
|
+
recordManualPayment(createManualSessionDto: CreateManualSessionDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RecordManualPaymentResultDto, any, {}>>;
|
|
30988
31569
|
/**
|
|
30989
31570
|
* 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.
|
|
30990
31571
|
* @summary Refund a settled Viva payment session (gateway only)
|
|
@@ -31006,12 +31587,12 @@ export declare class PaymentSessionApi extends BaseAPI implements PaymentSession
|
|
|
31006
31587
|
/**
|
|
31007
31588
|
* 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.
|
|
31008
31589
|
* @summary Void a manual payment session
|
|
31009
|
-
* @param {
|
|
31590
|
+
* @param {VoidManualSessionDto} voidManualSessionDto
|
|
31010
31591
|
* @param {*} [options] Override http request option.
|
|
31011
31592
|
* @throws {RequiredError}
|
|
31012
31593
|
* @memberof PaymentSessionApi
|
|
31013
31594
|
*/
|
|
31014
|
-
voidManualPayment(
|
|
31595
|
+
voidManualPayment(voidManualSessionDto: VoidManualSessionDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RecordManualPaymentResultDto, any, {}>>;
|
|
31015
31596
|
}
|
|
31016
31597
|
/**
|
|
31017
31598
|
* PluginApi - axios parameter creator
|