@gofynd/fdk-client-javascript 1.1.6 → 1.3.0

package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts

@@ -1,35 +1,443 @@
-export = PaymentValidator;
-declare class PaymentValidator {
-    static addEdcDevice(): any;
-    static addRefundBankAccountUsingOTP(): any;
-    static cancelPaymentLink(): any;
-    static checkAndUpdatePaymentStatus(): any;
-    static confirmPayment(): any;
-    static createPaymentLink(): any;
+export = PaymentPlatformApplicationValidator;
+/**
+ * @typedef AddEdcDeviceParam
+ * @property {string} terminalUniqueIdentifier - Terminal unique identifier
+ * @property {PaymentPlatformModel.EdcUpdateRequest} body
+ */
+/**
+ * @typedef AddRefundBankAccountUsingOTPParam
+ * @property {PaymentPlatformModel.AddBeneficiaryDetailsOTPRequest} body
+ */
+/**
+ * @typedef CancelPaymentLinkParam
+ * @property {PaymentPlatformModel.CancelOrResendPaymentLinkRequest} body
+ */
+/**
+ * @typedef CheckAndUpdatePaymentStatusParam
+ * @property {PaymentPlatformModel.PaymentStatusUpdateRequest} body
+ */
+/**
+ * @typedef ConfirmPaymentParam
+ * @property {PaymentPlatformModel.PaymentConfirmationRequest} body
+ */
+/**
+ * @typedef CreatePaymentLinkParam
+ * @property {PaymentPlatformModel.CreatePaymentLinkRequest} body
+ */
+/** @typedef EdcAggregatorsAndModelListParam */
+/**
+ * @typedef EdcDeviceListParam
+ * @property {number} [pageNo]
+ * @property {number} [pageSize]
+ * @property {boolean} [isActive]
+ * @property {number} [storeId]
+ * @property {string} [deviceTag]
+ */
+/** @typedef EdcDeviceStatsParam */
+/**
+ * @typedef GetBankAccountDetailsOpenAPIParam
+ * @property {string} orderId
+ * @property {string} [requestHash]
+ */
+/** @typedef GetBrandPaymentGatewayConfigParam */
+/**
+ * @typedef GetEdcDeviceParam
+ * @property {string} terminalUniqueIdentifier - Terminal unique identifier
+ */
+/**
+ * @typedef GetMerchantAggregatorPaymentModeDetailsParam
+ * @property {number} aggregatorId - Aggregators Id
+ * @property {string} businessUnit
+ * @property {string} device
+ */
+/** @typedef GetMerchantPaymentOptionParam */
+/** @typedef GetPGConfigAggregatorsParam */
+/** @typedef GetPaymentCodeOptionParam */
+/**
+ * @typedef GetPaymentLinkParam
+ * @property {string} [paymentLinkId]
+ */
+/**
+ * @typedef GetPaymentModeRoutesParam
+ * @property {boolean} refresh
+ * @property {string} requestType
+ */
+/**
+ * @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 GetUserBeneficiariesParam
+ * @property {string} orderId
+ */
+/**
+ * @typedef GetUserCODlimitRoutesParam
+ * @property {string} merchantUserId
+ * @property {string} mobileNo
+ */
+/**
+ * @typedef GetUserOrderBeneficiariesParam
+ * @property {string} orderId
+ */
+/**
+ * @typedef InitialisePaymentParam
+ * @property {PaymentPlatformModel.PaymentInitializationRequest} body
+ */
+/**
+ * @typedef MerchantOnBoardingParam
+ * @property {PaymentPlatformModel.MerchantOnBoardingRequest} body
+ */
+/**
+ * @typedef OauthGetUrlParam
+ * @property {string} aggregator - Aggregator
+ * @property {string} [successRedirectUrl]
+ * @property {string} [failureRedirectUrl]
+ */
+/**
+ * @typedef PatchMerchantAggregatorPaymentModeDetailsParam
+ * @property {number} aggregatorId - Aggregators Id
+ * @property {PaymentPlatformModel.MerchnatPaymentModeResponse} body
+ */
+/**
+ * @typedef PatchMerchantPaymentOptionParam
+ * @property {PaymentPlatformModel.MerchnatPaymentModeRequest} body
+ */
+/**
+ * @typedef PaymentStatusBulkParam
+ * @property {PaymentPlatformModel.PaymentStatusBulkHandlerRequest} body
+ */
+/**
+ * @typedef PollingPaymentLinkParam
+ * @property {string} [paymentLinkId]
+ */
+/**
+ * @typedef RepaymentDetailsParam
+ * @property {PaymentPlatformModel.RepaymentDetailsSerialiserPayAll} body
+ */
+/**
+ * @typedef ResendOrCancelPaymentParam
+ * @property {PaymentPlatformModel.ResendOrCancelPaymentRequest} body
+ */
+/**
+ * @typedef ResendPaymentLinkParam
+ * @property {PaymentPlatformModel.CancelOrResendPaymentLinkRequest} body
+ */
+/**
+ * @typedef RevokeOauthTokenParam
+ * @property {string} aggregator - Aggregator_slug
+ */
+/**
+ * @typedef SaveBrandPaymentGatewayConfigParam
+ * @property {PaymentPlatformModel.PaymentGatewayConfigRequest} body
+ */
+/**
+ * @typedef SetUserCODlimitRoutesParam
+ * @property {PaymentPlatformModel.SetCODForUserRequest} body
+ */
+/**
+ * @typedef UpdateEdcDeviceParam
+ * @property {PaymentPlatformModel.EdcAddRequest} body
+ */
+/**
+ * @typedef UpdatePaymentSessionParam
+ * @property {string} gid - Global identifier of the entity (e.g. order, cart
+ *   etc.) against which payment_session was initiated. This is generated by
+ *   Fynd payments platform and is unique.
+ * @property {PaymentPlatformModel.PaymentSessionRequestSerializer} body
+ */
+/**
+ * @typedef UpdateRefundSessionParam
+ * @property {string} gid - Global identifier of the entity (e.g. order, cart
+ *   etc.) against which payment_session was initiated. This is generated by
+ *   Fynd payments platform and is unique.
+ * @property {string} requestId - A unique id that was used to initiate a refund
+ *   session. This is generated by Fynd platform and is usually shipment_id.
+ * @property {PaymentPlatformModel.RefundSessionRequestSerializer} body
+ */
+/**
+ * @typedef VerifyCustomerForPaymentParam
+ * @property {PaymentPlatformModel.ValidateCustomerRequest} body
+ */
+declare class PaymentPlatformApplicationValidator {
+    /** @returns {AddEdcDeviceParam} */
+    static addEdcDevice(): AddEdcDeviceParam;
+    /** @returns {AddRefundBankAccountUsingOTPParam} */
+    static addRefundBankAccountUsingOTP(): AddRefundBankAccountUsingOTPParam;
+    /** @returns {CancelPaymentLinkParam} */
+    static cancelPaymentLink(): CancelPaymentLinkParam;
+    /** @returns {CheckAndUpdatePaymentStatusParam} */
+    static checkAndUpdatePaymentStatus(): CheckAndUpdatePaymentStatusParam;
+    /** @returns {ConfirmPaymentParam} */
+    static confirmPayment(): ConfirmPaymentParam;
+    /** @returns {CreatePaymentLinkParam} */
+    static createPaymentLink(): CreatePaymentLinkParam;
+    /** @returns {EdcAggregatorsAndModelListParam} */
     static edcAggregatorsAndModelList(): any;
-    static edcDeviceList(): any;
+    /** @returns {EdcDeviceListParam} */
+    static edcDeviceList(): EdcDeviceListParam;
+    /** @returns {EdcDeviceStatsParam} */
     static edcDeviceStats(): any;
-    static getBankAccountDetailsOpenAPI(): any;
+    /** @returns {GetBankAccountDetailsOpenAPIParam} */
+    static getBankAccountDetailsOpenAPI(): GetBankAccountDetailsOpenAPIParam;
+    /** @returns {GetBrandPaymentGatewayConfigParam} */
     static getBrandPaymentGatewayConfig(): any;
-    static getEdcDevice(): any;
+    /** @returns {GetEdcDeviceParam} */
+    static getEdcDevice(): GetEdcDeviceParam;
+    /** @returns {GetMerchantAggregatorPaymentModeDetailsParam} */
+    static getMerchantAggregatorPaymentModeDetails(): GetMerchantAggregatorPaymentModeDetailsParam;
+    /** @returns {GetMerchantPaymentOptionParam} */
+    static getMerchantPaymentOption(): any;
+    /** @returns {GetPGConfigAggregatorsParam} */
+    static getPGConfigAggregators(): any;
+    /** @returns {GetPaymentCodeOptionParam} */
     static getPaymentCodeOption(): any;
-    static getPaymentLink(): any;
-    static getPaymentModeRoutes(): any;
-    static getPosPaymentModeRoutes(): any;
-    static getUserBeneficiaries(): any;
-    static getUserCODlimitRoutes(): any;
-    static getUserOrderBeneficiaries(): any;
-    static initialisePayment(): any;
-    static merchantOnBoarding(): any;
-    static oauthGetUrl(): any;
-    static paymentStatusBulk(): any;
-    static pollingPaymentLink(): any;
-    static repaymentDetails(): any;
-    static resendOrCancelPayment(): any;
-    static resendPaymentLink(): any;
-    static revokeOauthToken(): any;
-    static saveBrandPaymentGatewayConfig(): any;
-    static setUserCODlimitRoutes(): any;
-    static updateEdcDevice(): any;
-    static verifyCustomerForPayment(): any;
+    /** @returns {GetPaymentLinkParam} */
+    static getPaymentLink(): GetPaymentLinkParam;
+    /** @returns {GetPaymentModeRoutesParam} */
+    static getPaymentModeRoutes(): GetPaymentModeRoutesParam;
+    /** @returns {GetPosPaymentModeRoutesParam} */
+    static getPosPaymentModeRoutes(): GetPosPaymentModeRoutesParam;
+    /** @returns {GetUserBeneficiariesParam} */
+    static getUserBeneficiaries(): GetUserBeneficiariesParam;
+    /** @returns {GetUserCODlimitRoutesParam} */
+    static getUserCODlimitRoutes(): GetUserCODlimitRoutesParam;
+    /** @returns {GetUserOrderBeneficiariesParam} */
+    static getUserOrderBeneficiaries(): GetUserOrderBeneficiariesParam;
+    /** @returns {InitialisePaymentParam} */
+    static initialisePayment(): InitialisePaymentParam;
+    /** @returns {MerchantOnBoardingParam} */
+    static merchantOnBoarding(): MerchantOnBoardingParam;
+    /** @returns {OauthGetUrlParam} */
+    static oauthGetUrl(): OauthGetUrlParam;
+    /** @returns {PatchMerchantAggregatorPaymentModeDetailsParam} */
+    static patchMerchantAggregatorPaymentModeDetails(): PatchMerchantAggregatorPaymentModeDetailsParam;
+    /** @returns {PatchMerchantPaymentOptionParam} */
+    static patchMerchantPaymentOption(): PatchMerchantPaymentOptionParam;
+    /** @returns {PaymentStatusBulkParam} */
+    static paymentStatusBulk(): PaymentStatusBulkParam;
+    /** @returns {PollingPaymentLinkParam} */
+    static pollingPaymentLink(): PollingPaymentLinkParam;
+    /** @returns {RepaymentDetailsParam} */
+    static repaymentDetails(): RepaymentDetailsParam;
+    /** @returns {ResendOrCancelPaymentParam} */
+    static resendOrCancelPayment(): ResendOrCancelPaymentParam;
+    /** @returns {ResendPaymentLinkParam} */
+    static resendPaymentLink(): ResendPaymentLinkParam;
+    /** @returns {RevokeOauthTokenParam} */
+    static revokeOauthToken(): RevokeOauthTokenParam;
+    /** @returns {SaveBrandPaymentGatewayConfigParam} */
+    static saveBrandPaymentGatewayConfig(): SaveBrandPaymentGatewayConfigParam;
+    /** @returns {SetUserCODlimitRoutesParam} */
+    static setUserCODlimitRoutes(): SetUserCODlimitRoutesParam;
+    /** @returns {UpdateEdcDeviceParam} */
+    static updateEdcDevice(): UpdateEdcDeviceParam;
+    /** @returns {UpdatePaymentSessionParam} */
+    static updatePaymentSession(): UpdatePaymentSessionParam;
+    /** @returns {UpdateRefundSessionParam} */
+    static updateRefundSession(): UpdateRefundSessionParam;
+    /** @returns {VerifyCustomerForPaymentParam} */
+    static verifyCustomerForPayment(): VerifyCustomerForPaymentParam;
 }
+declare namespace PaymentPlatformApplicationValidator {
+    export { AddEdcDeviceParam, AddRefundBankAccountUsingOTPParam, CancelPaymentLinkParam, CheckAndUpdatePaymentStatusParam, ConfirmPaymentParam, CreatePaymentLinkParam, EdcAggregatorsAndModelListParam, EdcDeviceListParam, EdcDeviceStatsParam, GetBankAccountDetailsOpenAPIParam, GetBrandPaymentGatewayConfigParam, GetEdcDeviceParam, GetMerchantAggregatorPaymentModeDetailsParam, GetMerchantPaymentOptionParam, GetPGConfigAggregatorsParam, GetPaymentCodeOptionParam, GetPaymentLinkParam, GetPaymentModeRoutesParam, GetPosPaymentModeRoutesParam, GetUserBeneficiariesParam, GetUserCODlimitRoutesParam, GetUserOrderBeneficiariesParam, InitialisePaymentParam, MerchantOnBoardingParam, OauthGetUrlParam, PatchMerchantAggregatorPaymentModeDetailsParam, PatchMerchantPaymentOptionParam, PaymentStatusBulkParam, PollingPaymentLinkParam, RepaymentDetailsParam, ResendOrCancelPaymentParam, ResendPaymentLinkParam, RevokeOauthTokenParam, SaveBrandPaymentGatewayConfigParam, SetUserCODlimitRoutesParam, UpdateEdcDeviceParam, UpdatePaymentSessionParam, UpdateRefundSessionParam, VerifyCustomerForPaymentParam };
+}
+type AddEdcDeviceParam = {
+    /**
+     * - Terminal unique identifier
+     */
+    terminalUniqueIdentifier: string;
+    body: PaymentPlatformModel.EdcUpdateRequest;
+};
+type AddRefundBankAccountUsingOTPParam = {
+    body: PaymentPlatformModel.AddBeneficiaryDetailsOTPRequest;
+};
+type CancelPaymentLinkParam = {
+    body: PaymentPlatformModel.CancelOrResendPaymentLinkRequest;
+};
+type CheckAndUpdatePaymentStatusParam = {
+    body: PaymentPlatformModel.PaymentStatusUpdateRequest;
+};
+type ConfirmPaymentParam = {
+    body: PaymentPlatformModel.PaymentConfirmationRequest;
+};
+type CreatePaymentLinkParam = {
+    body: PaymentPlatformModel.CreatePaymentLinkRequest;
+};
+type EdcDeviceListParam = {
+    pageNo?: number;
+    pageSize?: number;
+    isActive?: boolean;
+    storeId?: number;
+    deviceTag?: string;
+};
+type GetBankAccountDetailsOpenAPIParam = {
+    orderId: string;
+    requestHash?: string;
+};
+type GetEdcDeviceParam = {
+    /**
+     * - Terminal unique identifier
+     */
+    terminalUniqueIdentifier: string;
+};
+type GetMerchantAggregatorPaymentModeDetailsParam = {
+    /**
+     * - Aggregators Id
+     */
+    aggregatorId: number;
+    businessUnit: string;
+    device: string;
+};
+type GetPaymentLinkParam = {
+    paymentLinkId?: string;
+};
+type GetPaymentModeRoutesParam = {
+    refresh: boolean;
+    requestType: 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 GetUserBeneficiariesParam = {
+    orderId: string;
+};
+type GetUserCODlimitRoutesParam = {
+    merchantUserId: string;
+    mobileNo: string;
+};
+type GetUserOrderBeneficiariesParam = {
+    orderId: string;
+};
+type InitialisePaymentParam = {
+    body: PaymentPlatformModel.PaymentInitializationRequest;
+};
+type MerchantOnBoardingParam = {
+    body: PaymentPlatformModel.MerchantOnBoardingRequest;
+};
+type OauthGetUrlParam = {
+    /**
+     * - Aggregator
+     */
+    aggregator: string;
+    successRedirectUrl?: string;
+    failureRedirectUrl?: string;
+};
+type PatchMerchantAggregatorPaymentModeDetailsParam = {
+    /**
+     * - Aggregators Id
+     */
+    aggregatorId: number;
+    body: PaymentPlatformModel.MerchnatPaymentModeResponse;
+};
+type PatchMerchantPaymentOptionParam = {
+    body: PaymentPlatformModel.MerchnatPaymentModeRequest;
+};
+type PaymentStatusBulkParam = {
+    body: PaymentPlatformModel.PaymentStatusBulkHandlerRequest;
+};
+type PollingPaymentLinkParam = {
+    paymentLinkId?: string;
+};
+type RepaymentDetailsParam = {
+    body: PaymentPlatformModel.RepaymentDetailsSerialiserPayAll;
+};
+type ResendOrCancelPaymentParam = {
+    body: PaymentPlatformModel.ResendOrCancelPaymentRequest;
+};
+type ResendPaymentLinkParam = {
+    body: PaymentPlatformModel.CancelOrResendPaymentLinkRequest;
+};
+type RevokeOauthTokenParam = {
+    /**
+     * - Aggregator_slug
+     */
+    aggregator: string;
+};
+type SaveBrandPaymentGatewayConfigParam = {
+    body: PaymentPlatformModel.PaymentGatewayConfigRequest;
+};
+type SetUserCODlimitRoutesParam = {
+    body: PaymentPlatformModel.SetCODForUserRequest;
+};
+type UpdateEdcDeviceParam = {
+    body: PaymentPlatformModel.EdcAddRequest;
+};
+type UpdatePaymentSessionParam = {
+    /**
+     * - Global identifier of the entity (e.g. order, cart
+     * etc.) against which payment_session was initiated. This is generated by
+     * Fynd payments platform and is unique.
+     */
+    gid: string;
+    body: PaymentPlatformModel.PaymentSessionRequestSerializer;
+};
+type UpdateRefundSessionParam = {
+    /**
+     * - Global identifier of the entity (e.g. order, cart
+     * etc.) against which payment_session was initiated. This is generated by
+     * Fynd payments platform and is unique.
+     */
+    gid: string;
+    /**
+     * - A unique id that was used to initiate a refund
+     * session. This is generated by Fynd platform and is usually shipment_id.
+     */
+    requestId: string;
+    body: PaymentPlatformModel.RefundSessionRequestSerializer;
+};
+type VerifyCustomerForPaymentParam = {
+    body: PaymentPlatformModel.ValidateCustomerRequest;
+};
+type EdcAggregatorsAndModelListParam = any;
+type EdcDeviceStatsParam = any;
+type GetBrandPaymentGatewayConfigParam = any;
+type GetMerchantPaymentOptionParam = any;
+type GetPGConfigAggregatorsParam = any;
+type GetPaymentCodeOptionParam = any;
+import PaymentPlatformModel = require("./PaymentPlatformModel");