zova-module-a-pay 5.0.2 → 5.0.3

package/dist/api/openapi/types.d.ts

@@ -95,7 +95,39 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
-    '/api/payment-session/{id}/start': {
+    '/api/payment-callback/return': {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get: operations['PaymentCallback_returned'];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    '/api/payment-callback/cancel': {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get: operations['PaymentCallback_cancelled'];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    '/api/pay/payment-session/{id}/start': {
         parameters: {
             query?: never;
             header?: never;
@@ -111,7 +143,23 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
-    '/api/payment-session/{id}': {
+    '/api/pay/payment-session/{id}/reconcile': {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post: operations['PaymentSession_reconcile'];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    '/api/pay/payment-session/{id}': {
         parameters: {
             query?: never;
             header?: never;
@@ -527,6 +575,22 @@ export interface paths {
         patch: operations['CommerceTradeCart_updateItem'];
         trace?: never;
     };
+    '/api/commerce/trade/checkout/payment-methods': {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get: operations['CommerceTradeCheckout_paymentMethods'];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     '/api/commerce/trade/checkout': {
         parameters: {
             query?: never;
@@ -623,7 +687,7 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
-    '/api/commerce/trade/order/{id}/refundOutcome': {
+    '/api/commerce/trade/order/{id}/executeRefund': {
         parameters: {
             query?: never;
             header?: never;
@@ -632,7 +696,7 @@ export interface paths {
         };
         get?: never;
         put?: never;
-        post: operations['CommerceTradeOrder_refundOutcome'];
+        post: operations['CommerceTradeOrder_executeRefund'];
         delete?: never;
         options?: never;
         head?: never;
@@ -1264,6 +1328,22 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    '/api/pay/mock/payment-session/refund-operation/{id}/complete': {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post: operations['PayMockPayment_completeRefund'];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     '/api/paypal/getRecord/{recordId}': {
         parameters: {
             query?: never;
@@ -2114,6 +2194,7 @@ export interface components {
             pageNo: number;
         };
         'commerce-member.dto.addressMineItem': {
+            /** @description ID */
             id: number | string;
             /** @description Recipient Name */
             recipientName: string;
@@ -2133,6 +2214,7 @@ export interface components {
             addressLine2?: string | undefined;
         };
         'commerce-member.dto.addressMineView_2d063d28bc7243bed02ebd8bddf1212a93c6305b': {
+            /** @description ID */
             id: number | string;
             /** @description Recipient Name */
             recipientName: string;
@@ -2405,20 +2487,39 @@ export interface components {
             reason: string;
         };
         'commerce-promotion.dto.couponTemplateCreate': {
+            /** @description Name */
             name: string;
-            /** @enum {string} */
+            /**
+             * @description Template State
+             * @enum {string}
+             */
             state: 'draft' | 'active';
-            /** @enum {string} */
+            /**
+             * @description Currency
+             * @enum {string}
+             */
             currency: 'USD';
+            /** @description Fixed Discount */
             discountCents: number;
+            /** @description Minimum Spend */
             minSpendCents: number;
-            /** Format: date-time */
+            /**
+             * Format: date-time
+             * @description Valid From
+             */
             validFrom: Date;
-            /** Format: date-time */
+            /**
+             * Format: date-time
+             * @description Valid Until
+             */
             validUntil: Date;
+            /** @description Total Issue Limit */
             totalIssueLimit?: number | undefined;
+            /** @description Total Usage Limit */
             totalUsageLimit?: number | undefined;
+            /** @description Per-customer Issue Limit */
             perCustomerIssueLimit?: number | undefined;
+            /** @description Description */
             description?: string | undefined;
         };
         'commerce-promotion.dto.couponTemplateSelectRes': {
@@ -2463,9 +2564,9 @@ export interface components {
              * @enum {string}
              */
             currency: 'USD';
-            /** @description Fixed Discount (Cents) */
+            /** @description Fixed Discount */
             discountCents: number;
-            /** @description Minimum Spend (Cents) */
+            /** @description Minimum Spend */
             minSpendCents: number;
             /**
              * Format: date-time
@@ -2492,7 +2593,7 @@ export interface components {
             /** @description Operations */
             _operationsRow?: unknown;
         };
-        'commerce-promotion.dto.couponTemplateView_2d063d28bc7243bed02ebd8bddf1212a93c6305b_425dbecccd52e19e24888f99e1b1670233afa875': {
+        'commerce-promotion.dto.couponTemplateView_2d063d28bc7243bed02ebd8bddf1212a93c6305b_91abd8df366c0c4d47021b38af2a356349ee178b': {
             /**
              * Format: date-time
              * @description Created At
@@ -2527,9 +2628,9 @@ export interface components {
              * @enum {string}
              */
             currency: 'USD';
-            /** @description Fixed Discount (Cents) */
+            /** @description Fixed Discount */
             discountCents: number;
-            /** @description Minimum Spend (Cents) */
+            /** @description Minimum Spend */
             minSpendCents: number;
             /**
              * Format: date-time
@@ -2586,6 +2687,16 @@ export interface components {
             /** @description Quantity */
             quantity: number;
         };
+        'commerce-trade.dto.checkoutPaymentMethods': {
+            items: components['schemas']['commerce-trade.dto.checkoutPaymentMethod'][];
+            defaultKey: string;
+        };
+        'commerce-trade.dto.checkoutPaymentMethod': {
+            key: string;
+            label: string;
+            /** @enum {string} */
+            interaction: 'redirect' | 'embedded';
+        };
         'commerce-trade.dto.checkoutResult': {
             orderId: number | string;
             paymentAttemptId: number | string;
@@ -2604,6 +2715,7 @@ export interface components {
             addressId: number | string;
             couponGrantId?: number | string | undefined;
             correlationId: string;
+            providerCandidateKey?: string | undefined;
         };
         'commerce-trade.dto.orderMineRes': {
             list: components['schemas']['commerce-trade.dto.orderSummary'][];
@@ -2613,14 +2725,18 @@ export interface components {
             pageNo: number;
         };
         'commerce-trade.dto.orderSummary': {
+            /**
+             * Format: date-time
+             * @description Created At
+             */
+            createdAt: Date;
+            /** @description ID */
             id: number | string;
             /** @enum {string} */
             state: 'awaiting_payment' | 'paid' | 'refund_requested' | 'refund_approved' | 'refund_rejected' | 'shipped' | 'refunded' | 'cancelled' | 'expired';
             /** @enum {string} */
             currency: 'USD';
             payableTotalCents: number;
-            /** Format: date-time */
-            createdAt: Date;
         };
         'commerce-trade.dto.orderDetail_2d063d28bc7243bed02ebd8bddf1212a93c6305b': {
             id: number | string;
@@ -2668,6 +2784,7 @@ export interface components {
             appliedDiscountCents: number;
         } | undefined;
         'commerce-trade.dto.shipmentView_2d063d28bc7243bed02ebd8bddf1212a93c6305b': {
+            /** @description ID */
             id: number | string;
             carrier: string;
             trackingNumber: string;
@@ -2700,12 +2817,8 @@ export interface components {
             reason: string;
             idempotencyKey: string;
         };
-        'commerce-trade.dto.refundOutcomeCreate': {
-            /** @enum {string} */
-            outcome: 'succeeded' | 'failed';
-            idempotencyKey: string;
-        };
         'commerce-trade.dto.shipmentView': {
+            /** @description ID */
             id: number | string;
             carrier: string;
             trackingNumber: string;
@@ -3543,7 +3656,7 @@ export interface components {
             /** @description Description */
             description?: string | undefined;
             /** @description # */
-            _lineNumber: number;
+            _lineNumber?: number | undefined;
             /** @description Operations */
             _operationsRow?: unknown;
         };
@@ -3598,6 +3711,12 @@ export interface components {
             dossierFileIds?: (number | string)[] | undefined;
             /** @description Description */
             description?: string | undefined;
+            student?: {
+                /** @description ID */
+                id: number | string;
+                /** @description Student Name */
+                name: string;
+            };
             sceneImages?: components['schemas']['a-image.dto.imageView'][] | undefined;
             /** @description Dossier Files */
             dossierFiles?: components['schemas']['a-file.dto.fileView'][] | undefined;
@@ -3670,6 +3789,12 @@ export interface components {
             dossierFileIds?: (number | string)[] | undefined;
             /** @description Description */
             description?: string | undefined;
+            student?: {
+                /** @description ID */
+                id: number | string;
+                /** @description Student Name */
+                name: string;
+            };
             /** @description Student Training Record Details */
             trainingRecordSubjects: {
                 /**
@@ -3859,7 +3984,7 @@ export interface components {
                 signed?: boolean | undefined;
             }[] | undefined;
             /** @description # */
-            _lineNumber: number;
+            _lineNumber?: number | undefined;
             /** @description Operations */
             _operationsRow?: unknown;
         };
@@ -4105,17 +4230,18 @@ export interface components {
             _trainingRecords?: components['schemas']['training-student.dto.detailRecordResItem'][] | undefined;
         };
         'training-student.dto.studentSummary_2d063d28bc7243bed02ebd8bddf1212a93c6305b': {
+            /** @description ID */
             id: number | string;
             /** @description Student Name */
             name: string;
+            /** @description Description */
+            description?: string | undefined;
             /** @description Mobile */
             mobile: string;
             /** @description Training Stage */
-            level: number;
+            level: 1 | 2 | 3;
             /** @description Level Title */
             levelTitle: string;
-            /** @description Description */
-            description?: string | undefined;
             /** @description Description Length */
             descriptionLength: number;
             /** @description Summary */
@@ -4296,6 +4422,14 @@ export interface components {
             /** @enum {string} */
             outcome: 'succeeded' | 'failed' | 'cancelled';
         };
+        'pay-mock.dto.mockRefundReceipt': {
+            refundOperationId: number | string;
+            accepted: boolean;
+        };
+        'pay-mock.dto.mockRefundComplete': {
+            /** @enum {string} */
+            outcome: 'succeeded' | 'failed' | 'cancelled';
+        };
         'a-paypal.entity.paypalRecord': {
             /**
              * Format: date-time
@@ -5004,6 +5138,56 @@ export interface operations {
             };
         };
     };
+    PaymentCallback_returned: {
+        parameters: {
+            query: {
+                state: string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': {
+                        code: string;
+                        message: string;
+                        data?: unknown;
+                    };
+                };
+            };
+        };
+    };
+    PaymentCallback_cancelled: {
+        parameters: {
+            query: {
+                state: string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': {
+                        code: string;
+                        message: string;
+                        data?: unknown;
+                    };
+                };
+            };
+        };
+    };
     PaymentSession_start: {
         parameters: {
             query?: never;
@@ -5030,6 +5214,32 @@ export interface operations {
         };
         authToken: true;
     };
+    PaymentSession_reconcile: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: number | string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': {
+                        code: string;
+                        message: string;
+                        data: components['schemas']['a-pay.dto.paymentSessionView'];
+                    };
+                };
+            };
+        };
+        authToken: true;
+    };
     PaymentSession_view: {
         parameters: {
             query?: never;
@@ -5690,7 +5900,7 @@ export interface operations {
                     'application/json': {
                         code: string;
                         message: string;
-                        data?: components['schemas']['commerce-promotion.dto.couponTemplateView_2d063d28bc7243bed02ebd8bddf1212a93c6305b_425dbecccd52e19e24888f99e1b1670233afa875'];
+                        data?: components['schemas']['commerce-promotion.dto.couponTemplateView_2d063d28bc7243bed02ebd8bddf1212a93c6305b_91abd8df366c0c4d47021b38af2a356349ee178b'];
                     };
                 };
             };
@@ -5885,6 +6095,30 @@ export interface operations {
         };
         authToken: true;
     };
+    CommerceTradeCheckout_paymentMethods: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': {
+                        code: string;
+                        message: string;
+                        data: components['schemas']['commerce-trade.dto.checkoutPaymentMethods'];
+                    };
+                };
+            };
+        };
+        authToken: true;
+    };
     CommerceTradeCheckout_create: {
         parameters: {
             query?: never;
@@ -6063,7 +6297,7 @@ export interface operations {
         };
         authToken: true;
     };
-    CommerceTradeOrder_refundOutcome: {
+    CommerceTradeOrder_executeRefund: {
         parameters: {
             query?: never;
             header?: never;
@@ -6072,11 +6306,7 @@ export interface operations {
             };
             cookie?: never;
         };
-        requestBody: {
-            content: {
-                'application/json': components['schemas']['commerce-trade.dto.refundOutcomeCreate'];
-            };
-        };
+        requestBody?: never;
         responses: {
             200: {
                 headers: {
@@ -7628,6 +7858,36 @@ export interface operations {
         };
         authToken: true;
     };
+    PayMockPayment_completeRefund: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: number | string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                'application/json': components['schemas']['pay-mock.dto.mockRefundComplete'];
+            };
+        };
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': {
+                        code: string;
+                        message: string;
+                        data: components['schemas']['pay-mock.dto.mockRefundReceipt'];
+                    };
+                };
+            };
+        };
+        authToken: true;
+    };
     Paypal_getRecord: {
         parameters: {
             query?: never;