@gofynd/fdk-client-javascript 3.1.0-beta.1 → 3.2.0

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

@@ -6,123 +6,113 @@ declare class Payment {
      * @param {PaymentPlatformValidator.ActivateAndDectivatePayoutParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<PaymentPlatformModel.UpdatePayoutResponse>} - Success response
+     * @returns {Promise<PaymentPlatformModel.UpdatePayoutDetails>} - Success response
      * @name activateAndDectivatePayout
      * @summary: Activate/Deactivate payout
      * @description: Enable or disable payout functionality. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/activateAndDectivatePayout/).
      */
-    activateAndDectivatePayout({ uniqueTransferNo, body, requestHeaders }?: PaymentPlatformValidator.ActivateAndDectivatePayoutParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.UpdatePayoutResponse>;
-    /**
-     * @param {PaymentPlatformValidator.ActivateAndDectivatePayoutsParam} arg - Arg object
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<PaymentPlatformModel.UpdatePayoutResponse>} - Success response
-     * @name activateAndDectivatePayouts
-     * @summary: Activate/Deactivate payout.
-     * @description: Enable or disable payout functionality. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/activateAndDectivatePayouts/).
-     */
-    activateAndDectivatePayouts({ body, requestHeaders }?: PaymentPlatformValidator.ActivateAndDectivatePayoutsParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.UpdatePayoutResponse>;
+    activateAndDectivatePayout({ uniqueTransferNo, body, requestHeaders }?: PaymentPlatformValidator.ActivateAndDectivatePayoutParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.UpdatePayoutDetails>;
     /**
      * @param {PaymentPlatformValidator.DeletePayoutParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<PaymentPlatformModel.DeletePayoutResponse>} - Success response
+     * @returns {Promise<PaymentPlatformModel.DeletePayoutDetails>} - Success response
      * @name deletePayout
-     * @summary: Delete Payout
-     * @description: Delete Payout - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/deletePayout/).
-     */
-    deletePayout({ uniqueTransferNo, requestHeaders }?: PaymentPlatformValidator.DeletePayoutParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.DeletePayoutResponse>;
-    /**
-     * @param {PaymentPlatformValidator.DeletePayoutsParam} arg - Arg object
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<PaymentPlatformModel.DeletePayoutResponse>} - Success response
-     * @name deletePayouts
-     * @summary: Delete payout.
-     * @description: Remove a payout transaction from the system. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/deletePayouts/).
+     * @summary: Delete payout
+     * @description: Remove a payout transaction from the system. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/deletePayout/).
      */
-    deletePayouts({ uniqueTransferNo, requestHeaders }?: PaymentPlatformValidator.DeletePayoutsParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.DeletePayoutResponse>;
+    deletePayout({ uniqueTransferNo, requestHeaders }?: PaymentPlatformValidator.DeletePayoutParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.DeletePayoutDetails>;
     /**
-     * @param {PaymentPlatformValidator.GetAllPayoutParam} arg - Arg object
+     * @param {PaymentPlatformValidator.DeleteSubscriptionPaymentMethodParam} arg
+     *   - Arg object
+     *
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<PaymentPlatformModel.PayoutsResponse>} - Success response
-     * @name getAllPayout
-     * @summary: Get All Payouts
-     * @description: Get All Payouts - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getAllPayout/).
+     * @returns {Promise<PaymentPlatformModel.DeleteSubscriptionPaymentMethodDetails>}
+     *   - Success response
+     *
+     * @name deleteSubscriptionPaymentMethod
+     * @summary: Delete subscription payment method
+     * @description: Remove a payment method from subscription options. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/deleteSubscriptionPaymentMethod/).
      */
-    getAllPayout({ uniqueTransferNo, uniqueExternalId, requestHeaders }?: PaymentPlatformValidator.GetAllPayoutParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PayoutsResponse>;
+    deleteSubscriptionPaymentMethod({ uniqueExternalId, paymentMethodId, requestHeaders }?: PaymentPlatformValidator.DeleteSubscriptionPaymentMethodParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.DeleteSubscriptionPaymentMethodDetails>;
     /**
      * @param {PaymentPlatformValidator.GetAllPayoutsParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<PaymentPlatformModel.PayoutsResponse>} - Success response
+     * @returns {Promise<PaymentPlatformModel.PayoutsDetails>} - Success response
      * @name getAllPayouts
      * @summary: List payouts
      * @description: Retrieve a list of all payout transactions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getAllPayouts/).
      */
-    getAllPayouts({ uniqueExternalId, requestHeaders }?: PaymentPlatformValidator.GetAllPayoutsParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PayoutsResponse>;
+    getAllPayouts({ uniqueExternalId, requestHeaders }?: PaymentPlatformValidator.GetAllPayoutsParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PayoutsDetails>;
     /**
-     * @param {PaymentPlatformValidator.GetPaymentMethodConfigParam} arg - Arg object
+     * @param {PaymentPlatformValidator.GetSubscriptionConfigParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<PaymentPlatformModel.PaymentMethodConfigResponse>} -
+     * @returns {Promise<PaymentPlatformModel.SubscriptionConfigDetails>} -
      *   Success response
-     * @name getPaymentMethodConfig
-     * @summary: List Payment Method Configs
-     * @description: Get all active List Payment  Method Configs - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getPaymentMethodConfig/).
+     * @name getSubscriptionConfig
+     * @summary: Get subscription config
+     * @description: Retrieve configuration settings for subscriptions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getSubscriptionConfig/).
      */
-    getPaymentMethodConfig({ requestHeaders }?: any, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentMethodConfigResponse>;
+    getSubscriptionConfig({ requestHeaders }?: any, { responseHeaders }?: object): Promise<PaymentPlatformModel.SubscriptionConfigDetails>;
+    /**
+     * @param {PaymentPlatformValidator.GetSubscriptionPaymentMethodParam} arg
+     *   - Arg object
+     *
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<PaymentPlatformModel.SubscriptionPaymentMethodDetails>}
+     *   - Success response
+     *
+     * @name getSubscriptionPaymentMethod
+     * @summary: Get subscription payment method
+     * @description: Retrieve payment methods for subscriptions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getSubscriptionPaymentMethod/).
+     */
+    getSubscriptionPaymentMethod({ uniqueExternalId, requestHeaders }?: PaymentPlatformValidator.GetSubscriptionPaymentMethodParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.SubscriptionPaymentMethodDetails>;
     /**
      * @param {PaymentPlatformValidator.SavePayoutParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<PaymentPlatformModel.PayoutResponse>} - Success response
+     * @returns {Promise<PaymentPlatformModel.PayoutDetails>} - Success response
      * @name savePayout
-     * @summary: Save payout.
+     * @summary: Save payout
      * @description: Store and process a payout transaction. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/savePayout/).
      */
-    savePayout({ body, requestHeaders }?: PaymentPlatformValidator.SavePayoutParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PayoutResponse>;
+    savePayout({ body, requestHeaders }?: PaymentPlatformValidator.SavePayoutParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PayoutDetails>;
     /**
-     * @param {PaymentPlatformValidator.SavePayoutsParam} arg - Arg object
+     * @param {PaymentPlatformValidator.SaveSubscriptionSetupIntentParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<PaymentPlatformModel.PayoutResponse>} - Success response
-     * @name savePayouts
-     * @summary: Save Payout
-     * @description: Save Payout - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/savePayouts/).
+     * @returns {Promise<PaymentPlatformModel.SaveSubscriptionSetupIntentDetails>}
+     *   - Success response
+     *
+     * @name saveSubscriptionSetupIntent
+     * @summary: Save subscription setup intent
+     * @description: Store and process setup intent for subscriptions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/saveSubscriptionSetupIntent/).
      */
-    savePayouts({ uniqueTransferNo, body, requestHeaders }?: PaymentPlatformValidator.SavePayoutsParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PayoutResponse>;
+    saveSubscriptionSetupIntent({ body, requestHeaders }?: PaymentPlatformValidator.SaveSubscriptionSetupIntentParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.SaveSubscriptionSetupIntentDetails>;
     /**
      * @param {PaymentPlatformValidator.UpdatePayoutParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<PaymentPlatformModel.UpdatePayoutResponse>} - Success response
+     * @returns {Promise<PaymentPlatformModel.UpdatePayoutDetails>} - Success response
      * @name updatePayout
-     * @summary: Update Payout
-     * @description: Update Payout - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/updatePayout/).
-     */
-    updatePayout({ uniqueTransferNo, body, requestHeaders }?: PaymentPlatformValidator.UpdatePayoutParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.UpdatePayoutResponse>;
-    /**
-     * @param {PaymentPlatformValidator.UpdatePayoutsParam} arg - Arg object
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<PaymentPlatformModel.UpdatePayoutResponse>} - Success response
-     * @name updatePayouts
-     * @summary: Update payout.
-     * @description: Modify the details of a payout transaction. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/updatePayouts/).
+     * @summary: Update payout
+     * @description: Modify the details of a payout transaction. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/updatePayout/).
      */
-    updatePayouts({ body, requestHeaders }?: PaymentPlatformValidator.UpdatePayoutsParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.UpdatePayoutResponse>;
+    updatePayout({ uniqueTransferNo, body, requestHeaders }?: PaymentPlatformValidator.UpdatePayoutParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.UpdatePayoutDetails>;
     /**
      * @param {PaymentPlatformValidator.VerifyIfscCodeParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<PaymentPlatformModel.IfscCodeResponse>} - Success response
+     * @returns {Promise<PaymentPlatformModel.IfscCodeDetails>} - Success response
      * @name verifyIfscCode
-     * @summary: Verify IFSC code.
+     * @summary: Verify IFSC code
      * @description: Checks the validity of the provided IFSC code and returns bank details if valid. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/verifyIfscCode/).
      */
-    verifyIfscCode({ ifscCode, requestHeaders }?: PaymentPlatformValidator.VerifyIfscCodeParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.IfscCodeResponse>;
+    verifyIfscCode({ ifscCode, requestHeaders }?: PaymentPlatformValidator.VerifyIfscCodeParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.IfscCodeDetails>;
 }
 import PaymentPlatformValidator = require("./PaymentPlatformValidator");
 import PaymentPlatformModel = require("./PaymentPlatformModel");