@gofynd/fdk-client-javascript 1.0.0 → 1.0.2

package/sdk/platform/Payment/PaymentPlatformClient.js

@@ -2,6 +2,9 @@ const Paginator = require("../../common/Paginator");
 const { FDKClientValidationError } = require("../../common/FDKError");
 const PlatformAPIClient = require("../PlatformAPIClient");
 const PaymentValidator = require("./PaymentPlatformValidator");
+const PaymentModel = require("./PaymentPlatformModel");
+const { Logger } = require("./../../common/Logger");
+
 class Payment {
   constructor(config) {
     this.config = config;
@@ -10,10 +13,11 @@ class Payment {
   /**
    * @param {Object} arg - Arg object.
    * @param {string} [arg.uniqueExternalId] - Fetch payouts using unique external id
+   * @returns {Promise<PayoutsResponse>} - Success response
    * @summary: Get All Payouts
    * @description: Get All Payouts
    */
-  getAllPayouts({ uniqueExternalId } = {}) {
+  async getAllPayouts({ uniqueExternalId } = {}) {
     const { error } = PaymentValidator.getAllPayouts().validate(
       {
         uniqueExternalId,
@@ -24,12 +28,27 @@ class Payment {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = PaymentValidator.getAllPayouts().validate(
+      {
+        uniqueExternalId,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getAllPayouts",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
     query_params["unique_external_id"] = uniqueExternalId;
 
     const xHeaders = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "get",
       `/service/platform/payment/v1.0/company/${this.config.companyId}/payouts`,
@@ -37,15 +56,33 @@ class Payment {
       undefined,
       xHeaders
     );
+
+    const {
+      error: res_error,
+    } = PaymentModel.PayoutsResponse().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for getAllPayouts",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @param {Object} arg - Arg object.
    * @param {PayoutRequest} arg.body
+   * @returns {Promise<PayoutResponse>} - Success response
    * @summary: Save Payout
    * @description: Save Payout
    */
-  savePayout({ body } = {}) {
+  async savePayout({ body } = {}) {
     const { error } = PaymentValidator.savePayout().validate(
       {
         body,
@@ -56,11 +93,26 @@ class Payment {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = PaymentValidator.savePayout().validate(
+      {
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for savePayout",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
 
     const xHeaders = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "post",
       `/service/platform/payment/v1.0/company/${this.config.companyId}/payouts`,
@@ -68,16 +120,34 @@ class Payment {
       body,
       xHeaders
     );
+
+    const {
+      error: res_error,
+    } = PaymentModel.PayoutResponse().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for savePayout",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @param {Object} arg - Arg object.
    * @param {string} arg.uniqueTransferNo - Unique transfer id
    * @param {PayoutRequest} arg.body
+   * @returns {Promise<UpdatePayoutResponse>} - Success response
    * @summary: Update Payout
    * @description: Update Payout
    */
-  updatePayout({ uniqueTransferNo, body } = {}) {
+  async updatePayout({ uniqueTransferNo, body } = {}) {
     const { error } = PaymentValidator.updatePayout().validate(
       {
         uniqueTransferNo,
@@ -89,11 +159,27 @@ class Payment {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = PaymentValidator.updatePayout().validate(
+      {
+        uniqueTransferNo,
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for updatePayout",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
 
     const xHeaders = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "put",
       `/service/platform/payment/v1.0/company/${this.config.companyId}/payouts/${uniqueTransferNo}`,
@@ -101,16 +187,34 @@ class Payment {
       body,
       xHeaders
     );
+
+    const {
+      error: res_error,
+    } = PaymentModel.UpdatePayoutResponse().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for updatePayout",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @param {Object} arg - Arg object.
    * @param {string} arg.uniqueTransferNo - Unique transfer id
    * @param {UpdatePayoutRequest} arg.body
+   * @returns {Promise<UpdatePayoutResponse>} - Success response
    * @summary: Partial Update Payout
    * @description: Partial Update Payout
    */
-  activateAndDectivatePayout({ uniqueTransferNo, body } = {}) {
+  async activateAndDectivatePayout({ uniqueTransferNo, body } = {}) {
     const { error } = PaymentValidator.activateAndDectivatePayout().validate(
       {
         uniqueTransferNo,
@@ -122,11 +226,30 @@ class Payment {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = PaymentValidator.activateAndDectivatePayout().validate(
+      {
+        uniqueTransferNo,
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message:
+          "Parameter Validation warrnings for activateAndDectivatePayout",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
 
     const xHeaders = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "patch",
       `/service/platform/payment/v1.0/company/${this.config.companyId}/payouts/${uniqueTransferNo}`,
@@ -134,15 +257,33 @@ class Payment {
       body,
       xHeaders
     );
+
+    const {
+      error: res_error,
+    } = PaymentModel.UpdatePayoutResponse().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for activateAndDectivatePayout",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @param {Object} arg - Arg object.
    * @param {string} arg.uniqueTransferNo - Unique transfer id
+   * @returns {Promise<DeletePayoutResponse>} - Success response
    * @summary: Delete Payout
    * @description: Delete Payout
    */
-  deletePayout({ uniqueTransferNo } = {}) {
+  async deletePayout({ uniqueTransferNo } = {}) {
     const { error } = PaymentValidator.deletePayout().validate(
       {
         uniqueTransferNo,
@@ -153,11 +294,26 @@ class Payment {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = PaymentValidator.deletePayout().validate(
+      {
+        uniqueTransferNo,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for deletePayout",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
 
     const xHeaders = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "delete",
       `/service/platform/payment/v1.0/company/${this.config.companyId}/payouts/${uniqueTransferNo}`,
@@ -165,15 +321,33 @@ class Payment {
       undefined,
       xHeaders
     );
+
+    const {
+      error: res_error,
+    } = PaymentModel.DeletePayoutResponse().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for deletePayout",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @param {Object} arg - Arg object.
    * @param {string} [arg.uniqueExternalId] - Unique external id
+   * @returns {Promise<SubscriptionPaymentMethodResponse>} - Success response
    * @summary: List Subscription Payment Method
    * @description: Get all  Subscription  Payment Method
    */
-  getSubscriptionPaymentMethod({ uniqueExternalId } = {}) {
+  async getSubscriptionPaymentMethod({ uniqueExternalId } = {}) {
     const { error } = PaymentValidator.getSubscriptionPaymentMethod().validate(
       {
         uniqueExternalId,
@@ -184,12 +358,30 @@ class Payment {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = PaymentValidator.getSubscriptionPaymentMethod().validate(
+      {
+        uniqueExternalId,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message:
+          "Parameter Validation warrnings for getSubscriptionPaymentMethod",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
     query_params["unique_external_id"] = uniqueExternalId;
 
     const xHeaders = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "get",
       `/service/platform/payment/v1.0/company/${this.config.companyId}/subscription/methods`,
@@ -197,16 +389,38 @@ class Payment {
       undefined,
       xHeaders
     );
+
+    const {
+      error: res_error,
+    } = PaymentModel.SubscriptionPaymentMethodResponse().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message:
+          "Response Validation Warnnings for getSubscriptionPaymentMethod",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @param {Object} arg - Arg object.
    * @param {string} arg.uniqueExternalId -
    * @param {string} arg.paymentMethodId -
+   * @returns {Promise<DeleteSubscriptionPaymentMethodResponse>} - Success response
    * @summary: Delete Subscription Payment Method
    * @description: Uses this api to Delete Subscription Payment Method
    */
-  deleteSubscriptionPaymentMethod({ uniqueExternalId, paymentMethodId } = {}) {
+  async deleteSubscriptionPaymentMethod({
+    uniqueExternalId,
+    paymentMethodId,
+  } = {}) {
     const {
       error,
     } = PaymentValidator.deleteSubscriptionPaymentMethod().validate(
@@ -220,13 +434,32 @@ class Payment {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = PaymentValidator.deleteSubscriptionPaymentMethod().validate(
+      {
+        uniqueExternalId,
+        paymentMethodId,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message:
+          "Parameter Validation warrnings for deleteSubscriptionPaymentMethod",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
     query_params["unique_external_id"] = uniqueExternalId;
     query_params["payment_method_id"] = paymentMethodId;
 
     const xHeaders = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "delete",
       `/service/platform/payment/v1.0/company/${this.config.companyId}/subscription/methods`,
@@ -234,14 +467,33 @@ class Payment {
       undefined,
       xHeaders
     );
+
+    const {
+      error: res_error,
+    } = PaymentModel.DeleteSubscriptionPaymentMethodResponse().validate(
+      response,
+      { abortEarly: false, allowUnknown: false }
+    );
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message:
+          "Response Validation Warnnings for deleteSubscriptionPaymentMethod",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @param {Object} arg - Arg object.
+   * @returns {Promise<SubscriptionConfigResponse>} - Success response
    * @summary: List Subscription Config
    * @description: Get all  Subscription Config details
    */
-  getSubscriptionConfig({} = {}) {
+  async getSubscriptionConfig({} = {}) {
     const { error } = PaymentValidator.getSubscriptionConfig().validate(
       {},
       { abortEarly: false, allowUnknown: true }
@@ -250,11 +502,26 @@ class Payment {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = PaymentValidator.getSubscriptionConfig().validate(
+      {},
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getSubscriptionConfig",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
 
     const xHeaders = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "get",
       `/service/platform/payment/v1.0/company/${this.config.companyId}/subscription/configs`,
@@ -262,15 +529,33 @@ class Payment {
       undefined,
       xHeaders
     );
+
+    const {
+      error: res_error,
+    } = PaymentModel.SubscriptionConfigResponse().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for getSubscriptionConfig",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @param {Object} arg - Arg object.
    * @param {SaveSubscriptionSetupIntentRequest} arg.body
+   * @returns {Promise<SaveSubscriptionSetupIntentResponse>} - Success response
    * @summary: Save Subscription Setup Intent
    * @description: Uses this api to Save Subscription Setup Intent
    */
-  saveSubscriptionSetupIntent({ body } = {}) {
+  async saveSubscriptionSetupIntent({ body } = {}) {
     const { error } = PaymentValidator.saveSubscriptionSetupIntent().validate(
       {
         body,
@@ -281,11 +566,29 @@ class Payment {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = PaymentValidator.saveSubscriptionSetupIntent().validate(
+      {
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message:
+          "Parameter Validation warrnings for saveSubscriptionSetupIntent",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
 
     const xHeaders = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "post",
       `/service/platform/payment/v1.0/company/${this.config.companyId}/subscription/setup/intent`,
@@ -293,15 +596,34 @@ class Payment {
       body,
       xHeaders
     );
+
+    const {
+      error: res_error,
+    } = PaymentModel.SaveSubscriptionSetupIntentResponse().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message:
+          "Response Validation Warnnings for saveSubscriptionSetupIntent",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @param {Object} arg - Arg object.
    * @param {string} [arg.ifscCode] -
+   * @returns {Promise<IfscCodeResponse>} - Success response
    * @summary: Ifsc Code Verification
    * @description: Get True/False for correct IFSC Code for adding bank details for refund
    */
-  verifyIfscCode({ ifscCode } = {}) {
+  async verifyIfscCode({ ifscCode } = {}) {
     const { error } = PaymentValidator.verifyIfscCode().validate(
       {
         ifscCode,
@@ -312,12 +634,27 @@ class Payment {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = PaymentValidator.verifyIfscCode().validate(
+      {
+        ifscCode,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for verifyIfscCode",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
     query_params["ifsc_code"] = ifscCode;
 
     const xHeaders = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "get",
       `/service/platform/payment/v1.0/company/${this.config.companyId}/ifsc-code/verify`,
@@ -325,6 +662,23 @@ class Payment {
       undefined,
       xHeaders
     );
+
+    const {
+      error: res_error,
+    } = PaymentModel.IfscCodeResponse().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for verifyIfscCode",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 }