@waffo/waffo-node 2.3.4 → 2.5.0

package/README.md

@@ -1,6 +1,6 @@
 # Waffo Node.js SDK
 
-<!-- Synced with waffo-sdk/README.md @ commit ee83ead -->
+<!-- Synced with waffo-sdk/README.md @ commit d483eba -->
 
 **English** | [中文](README_CN.md)
 
@@ -544,9 +544,9 @@ try {
     notifyUrl: 'https://your-site.com/webhook/subscription',
     productInfoList: [
       {
-        description: 'Yearly Premium Subscription',
-        periodType: 'YEAR',
-        periodInterval: '1',
+        description: 'Annual Premium Subscription (12 months)',
+        periodType: 'MONTHLY',
+        periodInterval: '12',
         amount: '999.00',
       },
     ],

package/dist/index.d.mts

@@ -187,6 +187,7 @@ interface CreateSubscriptionParams {
     merchantSubscriptionId: string;
     currency: string;
     amount: string;
+    userCurrency?: string;
     notifyUrl: string;
     productInfo: ProductInfo;
     userInfo: SubscriptionUserInfo;
@@ -210,6 +211,13 @@ interface CreateSubscriptionParams {
      * Order expiry time (ISO 8601 format, max 24 characters).
      */
     orderExpiredAt?: string;
+    addressInfo?: SubscriptionAddressInfo;
+    riskData?: SubscriptionRiskData;
+    brandInfo?: SubscriptionBrandInfo;
+    subscriptionMode?: string;
+    acqMerchant?: Record<string, unknown>;
+    acqProduct?: Record<string, unknown>;
+    acqAgreements?: Record<string, unknown>[];
     [key: string]: unknown;
 }
 /**
@@ -219,6 +227,7 @@ interface CreateSubscriptionData {
     subscriptionRequest?: string;
     merchantSubscriptionId?: string;
     subscriptionId?: string;
+    payMethodSubscriptionId?: string;
     subscriptionStatus?: SubscriptionStatus;
     subscriptionAction?: string;
     [key: string]: unknown;
@@ -229,7 +238,19 @@ interface CreateSubscriptionData {
 interface InquirySubscriptionParams {
     subscriptionRequest?: string;
     subscriptionId?: string;
-    merchantInfo?: SubscriptionMerchantInfo;
+    paymentDetails?: 0 | 1 | number;
+    [key: string]: unknown;
+}
+/**
+ * Subscription payment detail returned when inquiry paymentDetails=1.
+ */
+interface SubscriptionPaymentDetail {
+    acquiringOrderId?: string;
+    orderCurrency?: string;
+    orderAmount?: string;
+    orderStatus?: string;
+    orderUpdatedAt?: string;
+    period?: string;
     [key: string]: unknown;
 }
 /**
@@ -246,13 +267,30 @@ interface InquirySubscriptionData {
     userCurrency?: string;
     amount?: string;
     productInfo?: ProductInfo;
+    merchantInfo?: SubscriptionMerchantInfo;
+    userInfo?: SubscriptionUserInfo;
+    paymentInfo?: SubscriptionPaymentInfo;
+    requestedAt?: string;
+    updatedAt?: string;
+    failedReason?: string;
+    subscriptionManagementUrl?: string;
+    extendInfo?: string;
+    paymentDetails?: SubscriptionPaymentDetail[];
+    goodsInfo?: {
+        goodsId?: string;
+        goodsName?: string;
+        goodsCategory?: string;
+        goodsUrl?: string;
+        [key: string]: unknown;
+    };
+    addressInfo?: SubscriptionAddressInfo;
     [key: string]: unknown;
 }
 /**
  * Cancel subscription request parameters.
  */
 interface CancelSubscriptionParams {
-    subscriptionId?: string;
+    subscriptionId: string;
     merchantId?: string;
     requestedAt?: string;
     [key: string]: unknown;
@@ -264,30 +302,122 @@ interface CancelSubscriptionData {
     subscriptionRequest?: string;
     merchantSubscriptionId?: string;
     subscriptionId?: string;
-    subscriptionStatus?: SubscriptionStatus;
+    orderStatus?: string;
     [key: string]: unknown;
 }
 /**
  * Manage subscription request parameters.
  */
 interface ManageSubscriptionParams {
-    subscriptionId: string;
-    merchantId: string;
-    action: SubscriptionManageAction;
-    newAmount?: string;
-    newPeriodType?: PeriodType;
-    newPeriodValue?: number;
-    requestedAt?: string;
+    subscriptionId?: string;
+    subscriptionRequest?: string;
     [key: string]: unknown;
 }
 /**
  * Manage subscription response data.
  */
 interface ManageSubscriptionData {
+    subscriptionRequest?: string;
+    merchantSubscriptionId?: string;
     subscriptionId?: string;
+    managementUrl?: string;
+    expiredAt?: string;
     subscriptionStatus?: SubscriptionStatus;
     [key: string]: unknown;
 }
+/**
+ * Scheduled amount item for a specific subscription period.
+ */
+interface SubscriptionScheduledAmount {
+    /**
+     * Period number, for example "1".
+     */
+    period?: string;
+    /**
+     * Merchant subscription amount for this period.
+     */
+    amount?: string;
+    [key: string]: unknown;
+}
+/**
+ * Product information for subscription update operations.
+ */
+interface SubscriptionUpdateProductInfo {
+    /**
+     * Updated trial period amount. Empty means no trial period.
+     */
+    trialPeriodAmount?: string;
+    /**
+     * Scheduled amount list for each period.
+     */
+    scheduledAmounts?: SubscriptionScheduledAmount[];
+    [key: string]: unknown;
+}
+/**
+ * Update subscription request parameters.
+ */
+interface UpdateSubscriptionParams {
+    /**
+     * Merchant subscription request ID. Provide subscriptionRequest or subscriptionId.
+     */
+    subscriptionRequest?: string;
+    /**
+     * Waffo subscription ID. Provide subscriptionRequest or subscriptionId.
+     */
+    subscriptionId?: string;
+    /**
+     * New merchant subscription amount. At least one of amount and
+     * productInfo.scheduledAmounts must be provided.
+     */
+    amount?: string;
+    /**
+     * Product information containing trial or scheduled amount updates.
+     */
+    productInfo?: SubscriptionUpdateProductInfo;
+    [key: string]: unknown;
+}
+/**
+ * Update subscription response data.
+ */
+interface UpdateSubscriptionData {
+    /**
+     * Waffo subscription ID.
+     */
+    subscriptionId?: string;
+    /**
+     * Subscription request ID sent from Merchant.
+     */
+    subscriptionRequest?: string;
+    /**
+     * Previous trial period amount.
+     */
+    previousTrialPeriodAmount?: string;
+    /**
+     * New trial period amount.
+     */
+    newTrialPeriodAmount?: string;
+    /**
+     * Previous merchant subscription amount.
+     */
+    previousAmount?: string;
+    /**
+     * New merchant subscription amount.
+     */
+    newAmount?: string;
+    /**
+     * Previous scheduled amount list for each period.
+     */
+    previousScheduledAmounts?: SubscriptionScheduledAmount[];
+    /**
+     * New scheduled amount list for each period.
+     */
+    newScheduledAmounts?: SubscriptionScheduledAmount[];
+    /**
+     * The next period number when the new amount takes effect.
+     */
+    nextEffectivePeriod?: string;
+    [key: string]: unknown;
+}
 /**
  * Subscription status enum.
  * Based on openapi.json SubscriptionInquiryResponse.subscriptionStatus.
@@ -362,6 +492,10 @@ interface ProductInfo {
      * Current billing period number.
      */
     currentPeriod?: string;
+    /**
+     * Scheduled amount list for each period.
+     */
+    scheduledAmounts?: SubscriptionScheduledAmount[];
     [key: string]: unknown;
 }
 /**
@@ -387,6 +521,48 @@ interface SubscriptionPaymentInfo {
     payMethodName?: string;
     [key: string]: unknown;
 }
+/**
+ * Address information for subscription.
+ */
+interface SubscriptionAddressInfo {
+    shippingAddress?: {
+        country?: string;
+        state?: string;
+        city?: string;
+        address1?: string;
+        address2?: string;
+        postalCode?: string;
+        [key: string]: unknown;
+    };
+    billingAddress?: {
+        country?: string;
+        state?: string;
+        city?: string;
+        address1?: string;
+        address2?: string;
+        postalCode?: string;
+        [key: string]: unknown;
+    };
+    [key: string]: unknown;
+}
+/**
+ * Risk data for subscription.
+ */
+interface SubscriptionRiskData {
+    deviceType?: string;
+    deviceId?: string;
+    deviceTokenId?: string;
+    [key: string]: unknown;
+}
+/**
+ * Brand display information for cashier.
+ */
+interface SubscriptionBrandInfo {
+    cashierLogoUrl?: string;
+    cashierDisplayName?: string;
+    cashierProductImageUrl?: string;
+    [key: string]: unknown;
+}
 /**
  * Merchant information for subscription.
  */
@@ -464,6 +640,10 @@ interface SubscriptionChangeProductInfo {
      * Trial period interval (max 12 characters).
      */
     trialPeriodInterval?: string;
+    /**
+     * Scheduled amount list for each period.
+     */
+    scheduledAmounts?: SubscriptionScheduledAmount[];
     [key: string]: unknown;
 }
 /**
@@ -581,6 +761,10 @@ interface SubscriptionChangeParams {
         userIsFirstPurchase?: string;
         [key: string]: unknown;
     };
+    /**
+     * Brand display information for cashier.
+     */
+    brandInfo?: SubscriptionBrandInfo;
     [key: string]: unknown;
 }
 /**
@@ -1177,6 +1361,12 @@ interface CreateOrderParams {
     addressInfo?: AddressInfo;
     cardInfo?: CardInfo;
     riskData?: RiskData;
+    paymentTokenData?: PaymentTokenData;
+    brandInfo?: BrandInfo;
+    productDetail?: ProductDetail;
+    acqOrderExtSubscriptionInfo?: AcqOrderExtSubscriptionInfo;
+    channelId?: string;
+    innerCardData?: WaffoTokenCardData;
     userCurrency?: string;
     successRedirectUrl?: string;
     failedRedirectUrl?: string;
@@ -1184,7 +1374,6 @@ interface CreateOrderParams {
     orderRequestedAt?: string;
     orderExpiredAt?: string;
     extendInfo?: string;
-    metadata?: string;
     [key: string]: unknown;
 }
 /**
@@ -1200,11 +1389,11 @@ interface CreateOrderData {
 }
 /**
  * Inquiry order request parameters.
+ * Provide paymentRequestId or acquiringOrderId.
  */
 interface InquiryOrderParams {
     paymentRequestId?: string;
     acquiringOrderId?: string;
-    merchantInfo?: MerchantInfo;
     [key: string]: unknown;
 }
 /**
@@ -1215,13 +1404,27 @@ interface InquiryOrderData {
     merchantOrderId?: string;
     acquiringOrderId?: string;
     orderStatus?: OrderStatus;
+    orderAction?: string;
     orderCurrency?: string;
     orderAmount?: string;
     finalDealAmount?: string;
+    orderDescription?: string;
+    merchantInfo?: MerchantInfo;
+    userInfo?: UserInfo;
+    goodsInfo?: GoodsInfo;
+    paymentInfo?: PaymentInfo;
+    addressInfo?: AddressInfo;
+    orderRequestedAt?: string;
+    orderExpiredAt?: string;
+    orderUpdatedAt?: string;
+    orderCompletedAt?: string;
     /**
      * Refund expiry time (ISO 8601 format).
      */
     refundExpiryAt?: string;
+    orderFailedReason?: string;
+    extendInfo?: string;
+    userCurrency?: string;
     /**
      * The associated subscription info.
      */
@@ -1238,7 +1441,7 @@ interface InquiryOrderData {
 interface CancelOrderParams {
     paymentRequestId?: string;
     acquiringOrderId?: string;
-    merchantInfo?: MerchantInfo;
+    merchantId?: string;
     orderRequestedAt?: string;
     [key: string]: unknown;
 }
@@ -1266,6 +1469,7 @@ interface RefundOrderParams {
     refundNotifyUrl?: string;
     userInfo?: RefundUserInfo;
     extendInfo?: string;
+    refundSource?: string;
     [key: string]: unknown;
 }
 /**
@@ -1279,6 +1483,7 @@ interface RefundOrderData {
     refundAmount?: string;
     refundStatus?: RefundStatus$1;
     remainingRefundAmount?: string;
+    refundSource?: string;
     [key: string]: unknown;
 }
 /**
@@ -1287,8 +1492,9 @@ interface RefundOrderData {
 interface CaptureOrderParams {
     paymentRequestId?: string;
     acquiringOrderId?: string;
-    merchantId: string;
-    captureAmount?: string;
+    merchantId?: string;
+    captureRequestedAt?: string;
+    captureAmount: string;
     [key: string]: unknown;
 }
 /**
@@ -1337,6 +1543,7 @@ interface PaymentInfo {
     payMethodType?: string;
     payMethodName?: string;
     payMethodProperties?: string;
+    captureMode?: string;
     [key: string]: unknown;
 }
 /**
@@ -1398,6 +1605,49 @@ interface RiskData {
     userIsFirstPurchase?: string;
     [key: string]: unknown;
 }
+/**
+ * Payment token data.
+ */
+interface PaymentTokenData {
+    tokenId?: string;
+    [key: string]: unknown;
+}
+/**
+ * Brand display information for cashier.
+ */
+interface BrandInfo {
+    cashierLogoUrl?: string;
+    cashierDisplayName?: string;
+    cashierProductImageUrl?: string;
+    [key: string]: unknown;
+}
+/**
+ * Product detail extension payload.
+ */
+interface ProductDetail {
+    subscriptionInfo?: SubscriptionInfo;
+    [key: string]: unknown;
+}
+/**
+ * Subscription extension information for an acquiring order.
+ */
+interface AcqOrderExtSubscriptionInfo {
+    subscriptionId?: string;
+    periodNo?: number;
+    merchantRequest?: string;
+    subscriptionEvent?: string;
+    [key: string]: unknown;
+}
+/**
+ * Tokenized card data used for direct card payment flows.
+ */
+interface WaffoTokenCardData {
+    cardBinDataList?: Record<string, unknown>[];
+    maskedCardInfo?: string;
+    cardBin?: string;
+    cardExpiry?: string;
+    [key: string]: unknown;
+}
 /**
  * Refund user information.
  */
@@ -1544,6 +1794,7 @@ declare class SubscriptionResource extends BaseResource {
     private static readonly PATH_INQUIRY;
     private static readonly PATH_CANCEL;
     private static readonly PATH_MANAGE;
+    private static readonly PATH_UPDATE;
     private static readonly PATH_CHANGE;
     private static readonly PATH_CHANGE_INQUIRY;
     /**
@@ -1582,6 +1833,18 @@ declare class SubscriptionResource extends BaseResource {
      * @throws WaffoUnknownStatusError for network errors
      */
     manage(params: ManageSubscriptionParams, options?: RequestOptions): Promise<ApiResponse<ManageSubscriptionData>>;
+    /**
+     * Updates an existing subscription amount or scheduled period amounts.
+     *
+     * Provide either subscriptionRequest or subscriptionId. At least one of amount
+     * or productInfo.scheduledAmounts must be provided.
+     *
+     * @param params - Subscription update parameters
+     * @param options - Optional request options
+     * @returns API response with update result
+     * @throws WaffoUnknownStatusError for network errors
+     */
+    update(params: UpdateSubscriptionParams, options?: RequestOptions): Promise<ApiResponse<UpdateSubscriptionData>>;
     /**
      * Changes (upgrades/downgrades) an existing subscription.
      *
@@ -1663,7 +1926,6 @@ declare class SubscriptionResource extends BaseResource {
 interface InquiryRefundParams {
     refundRequestId?: string;
     acquiringRefundOrderId?: string;
-    merchantInfo?: MerchantInfo;
     [key: string]: unknown;
 }
 /**
@@ -1677,13 +1939,20 @@ interface InquiryRefundData {
     acquiringRefundOrderId?: string;
     origPaymentRequestId?: string;
     refundAmount?: string;
-    refundCurrency?: string;
     refundStatus?: RefundStatus;
     refundReason?: string;
     refundRequestedAt?: string;
     refundUpdatedAt?: string;
     refundFailedReason?: string;
     extendInfo?: string;
+    userCurrency?: string;
+    finalDealAmount?: string;
+    remainingRefundAmount?: string;
+    merchantUserId?: string;
+    subscriptionInfo?: SubscriptionInfo;
+    userInfo?: RefundUserInfo;
+    refundCompletedAt?: string;
+    refundSource?: string;
     [key: string]: unknown;
 }
 /**
@@ -1740,10 +2009,9 @@ interface InquiryMerchantConfigParams {
  */
 interface InquiryMerchantConfigData {
     merchantId?: string;
-    merchantName?: string;
-    merchantStatus?: string;
-    supportedCurrencies?: string[];
-    supportedPayMethods?: PayMethodInfo[];
+    totalDailyLimit?: Record<string, string>;
+    remainingDailyLimit?: Record<string, string>;
+    transactionLimit?: Record<string, string>;
     [key: string]: unknown;
 }
 /**
@@ -2172,4 +2440,4 @@ declare const RsaUtils: {
     generateKeyPair: typeof generateKeyPair;
 };
 
-export { type AddressInfo, ApiResponse, type BaseNotification, type CancelOrderData, type CancelOrderParams, type CancelSubscriptionData, type CancelSubscriptionParams, type CaptureOrderData, type CaptureOrderParams, type CardInfo, type CreateOrderData, type CreateOrderParams, type CreateSubscriptionData, type CreateSubscriptionParams, Environment, EnvironmentBaseUrl, type GoodsInfo, type HttpRequest, type HttpResponse, type HttpTransport, type InquiryMerchantConfigData, type InquiryMerchantConfigParams, type InquiryOrderData, type InquiryOrderParams, type InquiryPayMethodConfigData, type InquiryPayMethodConfigParams, type InquiryRefundData, type InquiryRefundParams, type InquirySubscriptionData, type InquirySubscriptionParams, type ManageSubscriptionData, type ManageSubscriptionParams, MerchantConfigResource, type MerchantInfo, OrderResource, type OrderStatus, PayMethodConfigResource, type PayMethodInfo, type PaymentInfo, type PaymentNotification, type PaymentNotificationResult, type PeriodType, type ProductInfo, type RefundNotification, type RefundNotificationResult, type RefundOrderData, type RefundOrderParams, RefundResource, type RefundStatus$1 as RefundStatus, type RefundUserInfo, type RequestOptions, type RiskData, RsaUtils, type SubscriptionInfo, type SubscriptionManageAction, type SubscriptionMerchantInfo, type SubscriptionNotificationResult, type SubscriptionPaymentInfo, type SubscriptionPeriodChangedNotification, SubscriptionResource, type SubscriptionStatus, type SubscriptionStatusNotification, type SubscriptionUserInfo, type UserInfo, Waffo, type WaffoConfig, WaffoConfigDefaults, WaffoError, WaffoErrorCode, WaffoHttpClient, type WaffoLogger, WaffoUnknownStatusError, WebhookEventType, WebhookHandler, type WebhookResult };
+export { type AddressInfo, ApiResponse, type BaseNotification, type CancelOrderData, type CancelOrderParams, type CancelSubscriptionData, type CancelSubscriptionParams, type CaptureOrderData, type CaptureOrderParams, type CardInfo, type CreateOrderData, type CreateOrderParams, type CreateSubscriptionData, type CreateSubscriptionParams, Environment, EnvironmentBaseUrl, type GoodsInfo, type HttpRequest, type HttpResponse, type HttpTransport, type InquiryMerchantConfigData, type InquiryMerchantConfigParams, type InquiryOrderData, type InquiryOrderParams, type InquiryPayMethodConfigData, type InquiryPayMethodConfigParams, type InquiryRefundData, type InquiryRefundParams, type InquirySubscriptionData, type InquirySubscriptionParams, type ManageSubscriptionData, type ManageSubscriptionParams, MerchantConfigResource, type MerchantInfo, OrderResource, type OrderStatus, PayMethodConfigResource, type PayMethodInfo, type PaymentInfo, type PaymentNotification, type PaymentNotificationResult, type PeriodType, type ProductInfo, type RefundNotification, type RefundNotificationResult, type RefundOrderData, type RefundOrderParams, RefundResource, type RefundStatus$1 as RefundStatus, type RefundUserInfo, type RequestOptions, type RiskData, RsaUtils, type SubscriptionChangeData, type SubscriptionChangeInquiryData, type SubscriptionChangeInquiryParams, type SubscriptionChangeParams, type SubscriptionChangeProductInfo, type SubscriptionChangeStatus, type SubscriptionInfo, type SubscriptionManageAction, type SubscriptionMerchantInfo, type SubscriptionNotificationResult, type SubscriptionPaymentDetail, type SubscriptionPaymentInfo, type SubscriptionPeriodChangedNotification, SubscriptionResource, type SubscriptionScheduledAmount, type SubscriptionStatus, type SubscriptionStatusNotification, type SubscriptionUpdateProductInfo, type SubscriptionUserInfo, type UpdateSubscriptionData, type UpdateSubscriptionParams, type UserInfo, Waffo, type WaffoConfig, WaffoConfigDefaults, WaffoError, WaffoErrorCode, WaffoHttpClient, type WaffoLogger, WaffoUnknownStatusError, WebhookEventType, WebhookHandler, type WebhookResult };