@gofynd/fdk-client-javascript 1.1.6 → 1.3.0

package/sdk/application/Payment/PaymentApplicationValidator.d.ts

@@ -1,45 +1,498 @@
-export = PaymentValidator;
-declare class PaymentValidator {
-    static addBeneficiaryDetails(): any;
-    static addRefundBankAccountUsingOTP(): any;
-    static attachCardToCustomer(): any;
-    static cancelPaymentLink(): any;
-    static cardDetails(): any;
-    static checkAndUpdatePaymentStatus(): any;
-    static checkAndUpdatePaymentStatusPaymentLink(): any;
-    static checkCredit(): any;
-    static createOrderHandlerPaymentLink(): any;
-    static createPaymentLink(): any;
-    static customerCreditSummary(): any;
-    static customerOnboard(): any;
-    static deleteUserCard(): any;
-    static enableOrDisableRefundTransferMode(): any;
-    static getActiveCardAggregator(): any;
+export = PaymentApplicationValidator;
+/**
+ * @typedef AddBeneficiaryDetailsParam
+ * @property {PaymentApplicationModel.AddBeneficiaryDetailsRequest} body
+ */
+/**
+ * @typedef AddRefundBankAccountUsingOTPParam
+ * @property {PaymentApplicationModel.AddBeneficiaryDetailsOTPRequest} body
+ */
+/**
+ * @typedef AttachCardToCustomerParam
+ * @property {PaymentApplicationModel.AttachCardRequest} body
+ */
+/**
+ * @typedef CancelPaymentLinkParam
+ * @property {PaymentApplicationModel.CancelOrResendPaymentLinkRequest} body
+ */
+/**
+ * @typedef CardDetailsParam
+ * @property {string} cardInfo - Card first 6 digit IIN(prefix) number.
+ * @property {string} [aggregator]
+ */
+/**
+ * @typedef CheckAndUpdatePaymentStatusParam
+ * @property {PaymentApplicationModel.PaymentStatusUpdateRequest} body
+ */
+/**
+ * @typedef CheckAndUpdatePaymentStatusPaymentLinkParam
+ * @property {PaymentApplicationModel.PaymentStatusUpdateRequest} body
+ */
+/**
+ * @typedef CheckCreditParam
+ * @property {string} [aggregator]
+ */
+/**
+ * @typedef CreateOrderHandlerPaymentLinkParam
+ * @property {PaymentApplicationModel.CreateOrderUserRequest} body
+ */
+/**
+ * @typedef CreatePaymentLinkParam
+ * @property {PaymentApplicationModel.CreatePaymentLinkRequest} body
+ */
+/**
+ * @typedef CustomerCreditSummaryParam
+ * @property {string} [aggregator]
+ */
+/**
+ * @typedef CustomerOnboardParam
+ * @property {PaymentApplicationModel.CustomerOnboardingRequest} body
+ */
+/**
+ * @typedef DeleteUserCardParam
+ * @property {PaymentApplicationModel.DeletehCardRequest} body
+ */
+/**
+ * @typedef EnableOrDisableRefundTransferModeParam
+ * @property {PaymentApplicationModel.UpdateRefundTransferModeRequest} body
+ */
+/**
+ * @typedef GetActiveCardAggregatorParam
+ * @property {boolean} [refresh]
+ */
+/** @typedef GetActiveRefundTransferModesParam */
+/**
+ * @typedef GetActiveUserCardsParam
+ * @property {boolean} [forceRefresh]
+ */
+/**
+ * @typedef GetAggregatorsConfigParam
+ * @property {string} [xApiToken] - Used for basic authentication.
+ * @property {boolean} [refresh] - This is a boolean value. Select `true` to
+ *   remove temporary cache files on payment gateway and replace with the latest one.
+ */
+/** @typedef GetEpaylaterBannerDetailsParam */
+/**
+ * @typedef GetOrderBeneficiariesDetailParam
+ * @property {string} orderId - A unique number used for identifying and
+ *   tracking your orders.
+ */
+/**
+ * @typedef GetPaymentLinkParam
+ * @property {string} [paymentLinkId]
+ */
+/**
+ * @typedef GetPaymentModeRoutesParam
+ * @property {number} amount - Payable amount.
+ * @property {string} cartId - Identifier of the cart.
+ * @property {string} pincode - The PIN Code of the destination address, e.g. 400059
+ * @property {string} checkoutMode - Option to checkout for self or for others.
+ * @property {boolean} [refresh] - This is a boolean value. Select `true` to
+ *   remove temporary cache files on payment gateway and replace with the latest one.
+ * @property {string} [cardReference] - Card reference id of user's debit or credit card.
+ * @property {string} [userDetails] - URIencoded JSON containing details of an
+ *   anonymous user.
+ */
+/**
+ * @typedef GetPaymentModeRoutesPaymentLinkParam
+ * @property {string} paymentLinkId - Payment link id
+ */
+/**
+ * @typedef GetPosPaymentModeRoutesParam
+ * @property {number} amount - Payable amount.
+ * @property {string} cartId - Identifier of the cart.
+ * @property {string} pincode - The PIN Code of the destination address, e.g. 400059
+ * @property {string} checkoutMode - Option to checkout for self or for others.
+ * @property {boolean} [refresh] - This is a boolean value. Select `true` to
+ *   remove temporary cache files on payment gateway and replace with the latest one.
+ * @property {string} [cardReference] - Card reference id of user's debit or credit card.
+ * @property {string} orderType - The order type of shipment * HomeDelivery - If
+ *   the customer wants the order home-delivered * PickAtStore - If the customer
+ *   wants the handover of an order at the store itself.
+ * @property {string} [userDetails] - URIencoded JSON containing details of an
+ *   anonymous user.
+ */
+/** @typedef GetRupifiBannerDetailsParam */
+/**
+ * @typedef GetUserBeneficiariesDetailParam
+ * @property {string} orderId - A unique number used for identifying and
+ *   tracking your orders.
+ */
+/**
+ * @typedef InitialisePaymentParam
+ * @property {PaymentApplicationModel.PaymentInitializationRequest} body
+ */
+/**
+ * @typedef InitialisePaymentPaymentLinkParam
+ * @property {PaymentApplicationModel.PaymentInitializationRequest} body
+ */
+/**
+ * @typedef OutstandingOrderDetailsParam
+ * @property {string} [aggregator]
+ */
+/**
+ * @typedef PaidOrderDetailsParam
+ * @property {string} [aggregator]
+ */
+/**
+ * @typedef PollingPaymentLinkParam
+ * @property {string} [paymentLinkId]
+ */
+/**
+ * @typedef RedirectToAggregatorParam
+ * @property {string} [source] - This is a String value that contains callback
+ *   URL as value.
+ * @property {string} [aggregator] - This is a String value that contains
+ *   aggregator name as value.
+ */
+/**
+ * @typedef RenderHTMLParam
+ * @property {PaymentApplicationModel.renderHTMLRequest} body
+ */
+/**
+ * @typedef ResendOrCancelPaymentParam
+ * @property {PaymentApplicationModel.ResendOrCancelPaymentRequest} body
+ */
+/**
+ * @typedef ResendPaymentLinkParam
+ * @property {PaymentApplicationModel.CancelOrResendPaymentLinkRequest} body
+ */
+/**
+ * @typedef UpdateDefaultBeneficiaryParam
+ * @property {PaymentApplicationModel.SetDefaultBeneficiaryRequest} body
+ */
+/**
+ * @typedef ValidateVPAParam
+ * @property {PaymentApplicationModel.ValidateVPARequest} body
+ */
+/**
+ * @typedef VerifyAndChargePaymentParam
+ * @property {PaymentApplicationModel.ChargeCustomerRequest} body
+ */
+/**
+ * @typedef VerifyCustomerForPaymentParam
+ * @property {PaymentApplicationModel.ValidateCustomerRequest} body
+ */
+/**
+ * @typedef VerifyIfscCodeParam
+ * @property {string} [ifscCode] - A 11-digit alphanumeric code that uniquely
+ *   identifies a bank branch.
+ */
+/**
+ * @typedef VerifyOtpAndAddBeneficiaryForBankParam
+ * @property {PaymentApplicationModel.AddBeneficiaryViaOtpVerificationRequest} body
+ */
+/**
+ * @typedef VerifyOtpAndAddBeneficiaryForWalletParam
+ * @property {PaymentApplicationModel.WalletOtpRequest} body
+ */
+declare class PaymentApplicationValidator {
+    /** @returns {AddBeneficiaryDetailsParam} */
+    static addBeneficiaryDetails(): AddBeneficiaryDetailsParam;
+    /** @returns {AddRefundBankAccountUsingOTPParam} */
+    static addRefundBankAccountUsingOTP(): AddRefundBankAccountUsingOTPParam;
+    /** @returns {AttachCardToCustomerParam} */
+    static attachCardToCustomer(): AttachCardToCustomerParam;
+    /** @returns {CancelPaymentLinkParam} */
+    static cancelPaymentLink(): CancelPaymentLinkParam;
+    /** @returns {CardDetailsParam} */
+    static cardDetails(): CardDetailsParam;
+    /** @returns {CheckAndUpdatePaymentStatusParam} */
+    static checkAndUpdatePaymentStatus(): CheckAndUpdatePaymentStatusParam;
+    /** @returns {CheckAndUpdatePaymentStatusPaymentLinkParam} */
+    static checkAndUpdatePaymentStatusPaymentLink(): CheckAndUpdatePaymentStatusPaymentLinkParam;
+    /** @returns {CheckCreditParam} */
+    static checkCredit(): CheckCreditParam;
+    /** @returns {CreateOrderHandlerPaymentLinkParam} */
+    static createOrderHandlerPaymentLink(): CreateOrderHandlerPaymentLinkParam;
+    /** @returns {CreatePaymentLinkParam} */
+    static createPaymentLink(): CreatePaymentLinkParam;
+    /** @returns {CustomerCreditSummaryParam} */
+    static customerCreditSummary(): CustomerCreditSummaryParam;
+    /** @returns {CustomerOnboardParam} */
+    static customerOnboard(): CustomerOnboardParam;
+    /** @returns {DeleteUserCardParam} */
+    static deleteUserCard(): DeleteUserCardParam;
+    /** @returns {EnableOrDisableRefundTransferModeParam} */
+    static enableOrDisableRefundTransferMode(): EnableOrDisableRefundTransferModeParam;
+    /** @returns {GetActiveCardAggregatorParam} */
+    static getActiveCardAggregator(): GetActiveCardAggregatorParam;
+    /** @returns {GetActiveRefundTransferModesParam} */
     static getActiveRefundTransferModes(): any;
-    static getActiveUserCards(): any;
-    static getAggregatorsConfig(): any;
+    /** @returns {GetActiveUserCardsParam} */
+    static getActiveUserCards(): GetActiveUserCardsParam;
+    /** @returns {GetAggregatorsConfigParam} */
+    static getAggregatorsConfig(): GetAggregatorsConfigParam;
+    /** @returns {GetEpaylaterBannerDetailsParam} */
     static getEpaylaterBannerDetails(): any;
-    static getOrderBeneficiariesDetail(): any;
-    static getPaymentLink(): any;
-    static getPaymentModeRoutes(): any;
-    static getPaymentModeRoutesPaymentLink(): any;
-    static getPosPaymentModeRoutes(): any;
+    /** @returns {GetOrderBeneficiariesDetailParam} */
+    static getOrderBeneficiariesDetail(): GetOrderBeneficiariesDetailParam;
+    /** @returns {GetPaymentLinkParam} */
+    static getPaymentLink(): GetPaymentLinkParam;
+    /** @returns {GetPaymentModeRoutesParam} */
+    static getPaymentModeRoutes(): GetPaymentModeRoutesParam;
+    /** @returns {GetPaymentModeRoutesPaymentLinkParam} */
+    static getPaymentModeRoutesPaymentLink(): GetPaymentModeRoutesPaymentLinkParam;
+    /** @returns {GetPosPaymentModeRoutesParam} */
+    static getPosPaymentModeRoutes(): GetPosPaymentModeRoutesParam;
+    /** @returns {GetRupifiBannerDetailsParam} */
     static getRupifiBannerDetails(): any;
-    static getUserBeneficiariesDetail(): any;
-    static initialisePayment(): any;
-    static initialisePaymentPaymentLink(): any;
-    static outstandingOrderDetails(): any;
-    static paidOrderDetails(): any;
-    static pollingPaymentLink(): any;
-    static redirectToAggregator(): any;
-    static renderHTML(): any;
-    static resendOrCancelPayment(): any;
-    static resendPaymentLink(): any;
-    static updateDefaultBeneficiary(): any;
-    static validateVPA(): any;
-    static verifyAndChargePayment(): any;
-    static verifyCustomerForPayment(): any;
-    static verifyIfscCode(): any;
-    static verifyOtpAndAddBeneficiaryForBank(): any;
-    static verifyOtpAndAddBeneficiaryForWallet(): any;
+    /** @returns {GetUserBeneficiariesDetailParam} */
+    static getUserBeneficiariesDetail(): GetUserBeneficiariesDetailParam;
+    /** @returns {InitialisePaymentParam} */
+    static initialisePayment(): InitialisePaymentParam;
+    /** @returns {InitialisePaymentPaymentLinkParam} */
+    static initialisePaymentPaymentLink(): InitialisePaymentPaymentLinkParam;
+    /** @returns {OutstandingOrderDetailsParam} */
+    static outstandingOrderDetails(): OutstandingOrderDetailsParam;
+    /** @returns {PaidOrderDetailsParam} */
+    static paidOrderDetails(): PaidOrderDetailsParam;
+    /** @returns {PollingPaymentLinkParam} */
+    static pollingPaymentLink(): PollingPaymentLinkParam;
+    /** @returns {RedirectToAggregatorParam} */
+    static redirectToAggregator(): RedirectToAggregatorParam;
+    /** @returns {RenderHTMLParam} */
+    static renderHTML(): RenderHTMLParam;
+    /** @returns {ResendOrCancelPaymentParam} */
+    static resendOrCancelPayment(): ResendOrCancelPaymentParam;
+    /** @returns {ResendPaymentLinkParam} */
+    static resendPaymentLink(): ResendPaymentLinkParam;
+    /** @returns {UpdateDefaultBeneficiaryParam} */
+    static updateDefaultBeneficiary(): UpdateDefaultBeneficiaryParam;
+    /** @returns {ValidateVPAParam} */
+    static validateVPA(): ValidateVPAParam;
+    /** @returns {VerifyAndChargePaymentParam} */
+    static verifyAndChargePayment(): VerifyAndChargePaymentParam;
+    /** @returns {VerifyCustomerForPaymentParam} */
+    static verifyCustomerForPayment(): VerifyCustomerForPaymentParam;
+    /** @returns {VerifyIfscCodeParam} */
+    static verifyIfscCode(): VerifyIfscCodeParam;
+    /** @returns {VerifyOtpAndAddBeneficiaryForBankParam} */
+    static verifyOtpAndAddBeneficiaryForBank(): VerifyOtpAndAddBeneficiaryForBankParam;
+    /** @returns {VerifyOtpAndAddBeneficiaryForWalletParam} */
+    static verifyOtpAndAddBeneficiaryForWallet(): VerifyOtpAndAddBeneficiaryForWalletParam;
 }
+declare namespace PaymentApplicationValidator {
+    export { AddBeneficiaryDetailsParam, AddRefundBankAccountUsingOTPParam, AttachCardToCustomerParam, CancelPaymentLinkParam, CardDetailsParam, CheckAndUpdatePaymentStatusParam, CheckAndUpdatePaymentStatusPaymentLinkParam, CheckCreditParam, CreateOrderHandlerPaymentLinkParam, CreatePaymentLinkParam, CustomerCreditSummaryParam, CustomerOnboardParam, DeleteUserCardParam, EnableOrDisableRefundTransferModeParam, GetActiveCardAggregatorParam, GetActiveRefundTransferModesParam, GetActiveUserCardsParam, GetAggregatorsConfigParam, GetEpaylaterBannerDetailsParam, GetOrderBeneficiariesDetailParam, GetPaymentLinkParam, GetPaymentModeRoutesParam, GetPaymentModeRoutesPaymentLinkParam, GetPosPaymentModeRoutesParam, GetRupifiBannerDetailsParam, GetUserBeneficiariesDetailParam, InitialisePaymentParam, InitialisePaymentPaymentLinkParam, OutstandingOrderDetailsParam, PaidOrderDetailsParam, PollingPaymentLinkParam, RedirectToAggregatorParam, RenderHTMLParam, ResendOrCancelPaymentParam, ResendPaymentLinkParam, UpdateDefaultBeneficiaryParam, ValidateVPAParam, VerifyAndChargePaymentParam, VerifyCustomerForPaymentParam, VerifyIfscCodeParam, VerifyOtpAndAddBeneficiaryForBankParam, VerifyOtpAndAddBeneficiaryForWalletParam };
+}
+type AddBeneficiaryDetailsParam = {
+    body: PaymentApplicationModel.AddBeneficiaryDetailsRequest;
+};
+type AddRefundBankAccountUsingOTPParam = {
+    body: PaymentApplicationModel.AddBeneficiaryDetailsOTPRequest;
+};
+type AttachCardToCustomerParam = {
+    body: PaymentApplicationModel.AttachCardRequest;
+};
+type CancelPaymentLinkParam = {
+    body: PaymentApplicationModel.CancelOrResendPaymentLinkRequest;
+};
+type CardDetailsParam = {
+    /**
+     * - Card first 6 digit IIN(prefix) number.
+     */
+    cardInfo: string;
+    aggregator?: string;
+};
+type CheckAndUpdatePaymentStatusParam = {
+    body: PaymentApplicationModel.PaymentStatusUpdateRequest;
+};
+type CheckAndUpdatePaymentStatusPaymentLinkParam = {
+    body: PaymentApplicationModel.PaymentStatusUpdateRequest;
+};
+type CheckCreditParam = {
+    aggregator?: string;
+};
+type CreateOrderHandlerPaymentLinkParam = {
+    body: PaymentApplicationModel.CreateOrderUserRequest;
+};
+type CreatePaymentLinkParam = {
+    body: PaymentApplicationModel.CreatePaymentLinkRequest;
+};
+type CustomerCreditSummaryParam = {
+    aggregator?: string;
+};
+type CustomerOnboardParam = {
+    body: PaymentApplicationModel.CustomerOnboardingRequest;
+};
+type DeleteUserCardParam = {
+    body: PaymentApplicationModel.DeletehCardRequest;
+};
+type EnableOrDisableRefundTransferModeParam = {
+    body: PaymentApplicationModel.UpdateRefundTransferModeRequest;
+};
+type GetActiveCardAggregatorParam = {
+    refresh?: boolean;
+};
+type GetActiveUserCardsParam = {
+    forceRefresh?: boolean;
+};
+type GetAggregatorsConfigParam = {
+    /**
+     * - Used for basic authentication.
+     */
+    xApiToken?: string;
+    /**
+     * - This is a boolean value. Select `true` to
+     * remove temporary cache files on payment gateway and replace with the latest one.
+     */
+    refresh?: boolean;
+};
+type GetOrderBeneficiariesDetailParam = {
+    /**
+     * - A unique number used for identifying and
+     * tracking your orders.
+     */
+    orderId: string;
+};
+type GetPaymentLinkParam = {
+    paymentLinkId?: string;
+};
+type GetPaymentModeRoutesParam = {
+    /**
+     * - Payable amount.
+     */
+    amount: number;
+    /**
+     * - Identifier of the cart.
+     */
+    cartId: string;
+    /**
+     * - The PIN Code of the destination address, e.g. 400059
+     */
+    pincode: string;
+    /**
+     * - Option to checkout for self or for others.
+     */
+    checkoutMode: string;
+    /**
+     * - This is a boolean value. Select `true` to
+     * remove temporary cache files on payment gateway and replace with the latest one.
+     */
+    refresh?: boolean;
+    /**
+     * - Card reference id of user's debit or credit card.
+     */
+    cardReference?: string;
+    /**
+     * - URIencoded JSON containing details of an
+     * anonymous user.
+     */
+    userDetails?: string;
+};
+type GetPaymentModeRoutesPaymentLinkParam = {
+    /**
+     * - Payment link id
+     */
+    paymentLinkId: string;
+};
+type GetPosPaymentModeRoutesParam = {
+    /**
+     * - Payable amount.
+     */
+    amount: number;
+    /**
+     * - Identifier of the cart.
+     */
+    cartId: string;
+    /**
+     * - The PIN Code of the destination address, e.g. 400059
+     */
+    pincode: string;
+    /**
+     * - Option to checkout for self or for others.
+     */
+    checkoutMode: string;
+    /**
+     * - This is a boolean value. Select `true` to
+     * remove temporary cache files on payment gateway and replace with the latest one.
+     */
+    refresh?: boolean;
+    /**
+     * - Card reference id of user's debit or credit card.
+     */
+    cardReference?: string;
+    /**
+     * - The order type of shipment * HomeDelivery - If
+     * the customer wants the order home-delivered * PickAtStore - If the customer
+     * wants the handover of an order at the store itself.
+     */
+    orderType: string;
+    /**
+     * - URIencoded JSON containing details of an
+     * anonymous user.
+     */
+    userDetails?: string;
+};
+type GetUserBeneficiariesDetailParam = {
+    /**
+     * - A unique number used for identifying and
+     * tracking your orders.
+     */
+    orderId: string;
+};
+type InitialisePaymentParam = {
+    body: PaymentApplicationModel.PaymentInitializationRequest;
+};
+type InitialisePaymentPaymentLinkParam = {
+    body: PaymentApplicationModel.PaymentInitializationRequest;
+};
+type OutstandingOrderDetailsParam = {
+    aggregator?: string;
+};
+type PaidOrderDetailsParam = {
+    aggregator?: string;
+};
+type PollingPaymentLinkParam = {
+    paymentLinkId?: string;
+};
+type RedirectToAggregatorParam = {
+    /**
+     * - This is a String value that contains callback
+     * URL as value.
+     */
+    source?: string;
+    /**
+     * - This is a String value that contains
+     * aggregator name as value.
+     */
+    aggregator?: string;
+};
+type RenderHTMLParam = {
+    body: PaymentApplicationModel.renderHTMLRequest;
+};
+type ResendOrCancelPaymentParam = {
+    body: PaymentApplicationModel.ResendOrCancelPaymentRequest;
+};
+type ResendPaymentLinkParam = {
+    body: PaymentApplicationModel.CancelOrResendPaymentLinkRequest;
+};
+type UpdateDefaultBeneficiaryParam = {
+    body: PaymentApplicationModel.SetDefaultBeneficiaryRequest;
+};
+type ValidateVPAParam = {
+    body: PaymentApplicationModel.ValidateVPARequest;
+};
+type VerifyAndChargePaymentParam = {
+    body: PaymentApplicationModel.ChargeCustomerRequest;
+};
+type VerifyCustomerForPaymentParam = {
+    body: PaymentApplicationModel.ValidateCustomerRequest;
+};
+type VerifyIfscCodeParam = {
+    /**
+     * - A 11-digit alphanumeric code that uniquely
+     * identifies a bank branch.
+     */
+    ifscCode?: string;
+};
+type VerifyOtpAndAddBeneficiaryForBankParam = {
+    body: PaymentApplicationModel.AddBeneficiaryViaOtpVerificationRequest;
+};
+type VerifyOtpAndAddBeneficiaryForWalletParam = {
+    body: PaymentApplicationModel.WalletOtpRequest;
+};
+type GetActiveRefundTransferModesParam = any;
+type GetEpaylaterBannerDetailsParam = any;
+type GetRupifiBannerDetailsParam = any;
+import PaymentApplicationModel = require("./PaymentApplicationModel");