@gofynd/fdk-client-javascript 1.0.0 → 1.0.2

package/sdk/platform/Billing/BillingPlatformClient.js

@@ -2,6 +2,9 @@ const Paginator = require("../../common/Paginator");
 const { FDKClientValidationError } = require("../../common/FDKError");
 const PlatformAPIClient = require("../PlatformAPIClient");
 const BillingValidator = require("./BillingPlatformValidator");
+const BillingModel = require("./BillingPlatformModel");
+const { Logger } = require("./../../common/Logger");
+
 class Billing {
   constructor(config) {
     this.config = config;
@@ -11,10 +14,11 @@ class Billing {
    * @param {Object} arg - Arg object.
    * @param {string} arg.plan - ID of the plan.
    * @param {string} arg.couponCode - Coupon code.
+   * @returns {Promise<CheckValidityResponse>} - Success response
    * @summary: Check coupon validity
    * @description: Check coupon validity.
    */
-  checkCouponValidity({ plan, couponCode } = {}) {
+  async checkCouponValidity({ plan, couponCode } = {}) {
     const { error } = BillingValidator.checkCouponValidity().validate(
       {
         plan,
@@ -26,13 +30,29 @@ class Billing {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = BillingValidator.checkCouponValidity().validate(
+      {
+        plan,
+        couponCode,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for checkCouponValidity",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
     query_params["plan"] = plan;
     query_params["coupon_code"] = couponCode;
 
     const xHeaders = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "get",
       `/service/platform/billing/v1.0/company/${this.config.companyId}/coupon/check-validity`,
@@ -40,16 +60,34 @@ class Billing {
       undefined,
       xHeaders
     );
+
+    const {
+      error: res_error,
+    } = BillingModel.CheckValidityResponse().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for checkCouponValidity",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @param {Object} arg - Arg object.
    * @param {string} arg.extensionId - Extension _id
    * @param {CreateSubscriptionCharge} arg.body
+   * @returns {Promise<CreateSubscriptionResponse>} - Success response
    * @summary: Create subscription charge
    * @description: Register subscription charge for a seller of your extension.
    */
-  createSubscriptionCharge({ extensionId, body } = {}) {
+  async createSubscriptionCharge({ extensionId, body } = {}) {
     const { error } = BillingValidator.createSubscriptionCharge().validate(
       {
         extensionId,
@@ -61,11 +99,29 @@ class Billing {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = BillingValidator.createSubscriptionCharge().validate(
+      {
+        extensionId,
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for createSubscriptionCharge",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
 
     const xHeaders = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "post",
       `/service/platform/billing/v1.0/company/${this.config.companyId}/extension/${extensionId}/subscription`,
@@ -73,16 +129,34 @@ class Billing {
       body,
       xHeaders
     );
+
+    const {
+      error: res_error,
+    } = BillingModel.CreateSubscriptionResponse().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for createSubscriptionCharge",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @param {Object} arg - Arg object.
    * @param {string} arg.extensionId - Extension _id
    * @param {string} arg.subscriptionId - Subscription charge _id
+   * @returns {Promise<EntitySubscription>} - Success response
    * @summary: Get subscription charge details
    * @description: Get created subscription charge details
    */
-  getSubscriptionCharge({ extensionId, subscriptionId } = {}) {
+  async getSubscriptionCharge({ extensionId, subscriptionId } = {}) {
     const { error } = BillingValidator.getSubscriptionCharge().validate(
       {
         extensionId,
@@ -94,11 +168,29 @@ class Billing {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = BillingValidator.getSubscriptionCharge().validate(
+      {
+        extensionId,
+        subscriptionId,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getSubscriptionCharge",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
 
     const xHeaders = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "get",
       `/service/platform/billing/v1.0/company/${this.config.companyId}/extension/${extensionId}/subscription/${subscriptionId}`,
@@ -106,16 +198,34 @@ class Billing {
       undefined,
       xHeaders
     );
+
+    const {
+      error: res_error,
+    } = BillingModel.EntitySubscription().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for getSubscriptionCharge",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @param {Object} arg - Arg object.
    * @param {string} arg.extensionId - Extension _id
    * @param {string} arg.subscriptionId - Subscription charge _id
+   * @returns {Promise<EntitySubscription>} - Success response
    * @summary: Cancel subscription charge
    * @description: Cancel subscription and attached charges.
    */
-  cancelSubscriptionCharge({ extensionId, subscriptionId } = {}) {
+  async cancelSubscriptionCharge({ extensionId, subscriptionId } = {}) {
     const { error } = BillingValidator.cancelSubscriptionCharge().validate(
       {
         extensionId,
@@ -127,11 +237,29 @@ class Billing {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = BillingValidator.cancelSubscriptionCharge().validate(
+      {
+        extensionId,
+        subscriptionId,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for cancelSubscriptionCharge",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
 
     const xHeaders = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "post",
       `/service/platform/billing/v1.0/company/${this.config.companyId}/extension/${extensionId}/subscription/${subscriptionId}/cancel`,
@@ -139,14 +267,32 @@ class Billing {
       undefined,
       xHeaders
     );
+
+    const {
+      error: res_error,
+    } = BillingModel.EntitySubscription().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for cancelSubscriptionCharge",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @param {Object} arg - Arg object.
+   * @returns {Promise<Invoices>} - Success response
    * @summary: Get invoices
    * @description: Get invoices.
    */
-  getInvoices({} = {}) {
+  async getInvoices({} = {}) {
     const { error } = BillingValidator.getInvoices().validate(
       {},
       { abortEarly: false, allowUnknown: true }
@@ -155,11 +301,24 @@ class Billing {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = BillingValidator.getInvoices().validate(
+      {},
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getInvoices",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
 
     const xHeaders = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "get",
       `/service/platform/billing/v1.0/company/${this.config.companyId}/invoice/list`,
@@ -167,15 +326,31 @@ class Billing {
       undefined,
       xHeaders
     );
+
+    const { error: res_error } = BillingModel.Invoices().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for getInvoices",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @param {Object} arg - Arg object.
    * @param {string} arg.invoiceId - Invoice id
+   * @returns {Promise<Invoice>} - Success response
    * @summary: Get invoice by id
    * @description: Get invoice by id.
    */
-  getInvoiceById({ invoiceId } = {}) {
+  async getInvoiceById({ invoiceId } = {}) {
     const { error } = BillingValidator.getInvoiceById().validate(
       {
         invoiceId,
@@ -186,11 +361,26 @@ class Billing {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = BillingValidator.getInvoiceById().validate(
+      {
+        invoiceId,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getInvoiceById",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
 
     const xHeaders = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "get",
       `/service/platform/billing/v1.0/company/${this.config.companyId}/invoice/${invoiceId}`,
@@ -198,14 +388,30 @@ class Billing {
       undefined,
       xHeaders
     );
+
+    const { error: res_error } = BillingModel.Invoice().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for getInvoiceById",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @param {Object} arg - Arg object.
+   * @returns {Promise<SubscriptionCustomer>} - Success response
    * @summary: Get subscription customer detail
    * @description: Get subscription customer detail.
    */
-  getCustomerDetail({} = {}) {
+  async getCustomerDetail({} = {}) {
     const { error } = BillingValidator.getCustomerDetail().validate(
       {},
       { abortEarly: false, allowUnknown: true }
@@ -214,11 +420,24 @@ class Billing {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = BillingValidator.getCustomerDetail().validate(
+      {},
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getCustomerDetail",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
 
     const xHeaders = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "get",
       `/service/platform/billing/v1.0/company/${this.config.companyId}/subscription/customer-detail`,
@@ -226,15 +445,33 @@ class Billing {
       undefined,
       xHeaders
     );
+
+    const {
+      error: res_error,
+    } = BillingModel.SubscriptionCustomer().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for getCustomerDetail",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @param {Object} arg - Arg object.
    * @param {SubscriptionCustomerCreate} arg.body
+   * @returns {Promise<SubscriptionCustomer>} - Success response
    * @summary: Upsert subscription customer detail
    * @description: Upsert subscription customer detail.
    */
-  upsertCustomerDetail({ body } = {}) {
+  async upsertCustomerDetail({ body } = {}) {
     const { error } = BillingValidator.upsertCustomerDetail().validate(
       {
         body,
@@ -245,11 +482,28 @@ class Billing {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = BillingValidator.upsertCustomerDetail().validate(
+      {
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for upsertCustomerDetail",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
 
     const xHeaders = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "post",
       `/service/platform/billing/v1.0/company/${this.config.companyId}/subscription/customer-detail`,
@@ -257,14 +511,32 @@ class Billing {
       body,
       xHeaders
     );
+
+    const {
+      error: res_error,
+    } = BillingModel.SubscriptionCustomer().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for upsertCustomerDetail",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @param {Object} arg - Arg object.
+   * @returns {Promise<SubscriptionStatus>} - Success response
    * @summary: Get current subscription detail
    * @description: If subscription is active then it will return is_enabled true and return subscription object. If subscription is not active then is_enabled false and message.
    */
-  getSubscription({} = {}) {
+  async getSubscription({} = {}) {
     const { error } = BillingValidator.getSubscription().validate(
       {},
       { abortEarly: false, allowUnknown: true }
@@ -273,11 +545,24 @@ class Billing {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = BillingValidator.getSubscription().validate(
+      {},
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getSubscription",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
 
     const xHeaders = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "get",
       `/service/platform/billing/v1.0/company/${this.config.companyId}/subscription/current`,
@@ -285,14 +570,32 @@ class Billing {
       undefined,
       xHeaders
     );
+
+    const {
+      error: res_error,
+    } = BillingModel.SubscriptionStatus().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for getSubscription",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @param {Object} arg - Arg object.
+   * @returns {Promise<SubscriptionLimit>} - Success response
    * @summary: Get subscription subscription limits
    * @description: Get subscription subscription limits.
    */
-  getFeatureLimitConfig({} = {}) {
+  async getFeatureLimitConfig({} = {}) {
     const { error } = BillingValidator.getFeatureLimitConfig().validate(
       {},
       { abortEarly: false, allowUnknown: true }
@@ -301,11 +604,26 @@ class Billing {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = BillingValidator.getFeatureLimitConfig().validate(
+      {},
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getFeatureLimitConfig",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
 
     const xHeaders = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "get",
       `/service/platform/billing/v1.0/company/${this.config.companyId}/subscription/current-limit`,
@@ -313,15 +631,33 @@ class Billing {
       undefined,
       xHeaders
     );
+
+    const {
+      error: res_error,
+    } = BillingModel.SubscriptionLimit().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for getFeatureLimitConfig",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @param {Object} arg - Arg object.
    * @param {SubscriptionActivateReq} arg.body
+   * @returns {Promise<SubscriptionActivateRes>} - Success response
    * @summary: Activate subscription
    * @description: It will activate subscription plan for customer
    */
-  activateSubscriptionPlan({ body } = {}) {
+  async activateSubscriptionPlan({ body } = {}) {
     const { error } = BillingValidator.activateSubscriptionPlan().validate(
       {
         body,
@@ -332,11 +668,28 @@ class Billing {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = BillingValidator.activateSubscriptionPlan().validate(
+      {
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for activateSubscriptionPlan",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
 
     const xHeaders = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "post",
       `/service/platform/billing/v1.0/company/${this.config.companyId}/subscription/activate`,
@@ -344,15 +697,33 @@ class Billing {
       body,
       xHeaders
     );
+
+    const {
+      error: res_error,
+    } = BillingModel.SubscriptionActivateRes().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for activateSubscriptionPlan",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @param {Object} arg - Arg object.
    * @param {CancelSubscriptionReq} arg.body
+   * @returns {Promise<CancelSubscriptionRes>} - Success response
    * @summary: Cancel subscription
    * @description: It will cancel current active subscription.
    */
-  cancelSubscriptionPlan({ body } = {}) {
+  async cancelSubscriptionPlan({ body } = {}) {
     const { error } = BillingValidator.cancelSubscriptionPlan().validate(
       {
         body,
@@ -363,11 +734,28 @@ class Billing {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = BillingValidator.cancelSubscriptionPlan().validate(
+      {
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for cancelSubscriptionPlan",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
 
     const xHeaders = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "post",
       `/service/platform/billing/v1.0/company/${this.config.companyId}/subscription/cancel`,
@@ -375,6 +763,23 @@ class Billing {
       body,
       xHeaders
     );
+
+    const {
+      error: res_error,
+    } = BillingModel.CancelSubscriptionRes().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for cancelSubscriptionPlan",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 }