@gofynd/fdk-client-javascript 1.1.6 → 1.2.0

package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js

@@ -1,8 +1,8 @@
 const PlatformAPIClient = require("../PlatformAPIClient");
 const { FDKClientValidationError } = require("../../common/FDKError");
 const Paginator = require("../../common/Paginator");
-const CompanyProfileValidator = require("./CompanyProfilePlatformValidator");
-const CompanyProfileModel = require("./CompanyProfilePlatformModel");
+const CompanyProfilePlatformValidator = require("./CompanyProfilePlatformValidator");
+const CompanyProfilePlatformModel = require("./CompanyProfilePlatformModel");
 const { Logger } = require("./../../common/Logger");
 const Joi = require("joi");
 
@@ -12,13 +12,17 @@ class CompanyProfile {
   }
 
   /**
-   * @param {Object} arg - Arg object.
-   * @returns {Promise<GetCompanyProfileSerializerResponse>} - Success response
+   * @param {CompanyProfilePlatformValidator.CbsOnboardGetParam} arg - Arg object
+   * @param {import("../PlatformAPIClient").Options} - Options
+   * @returns {Promise<CompanyProfilePlatformModel.GetCompanyProfileSerializerResponse>}
+   *   - Success response
+   *
+   * @name cbsOnboardGet
    * @summary: Get company profile
-   * @description: This API allows to view the company profile of the seller account.
+   * @description: This API allows to view the company profile of the seller account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/cbsOnboardGet/).
    */
-  async cbsOnboardGet({} = {}) {
-    const { error } = CompanyProfileValidator.cbsOnboardGet().validate(
+  async cbsOnboardGet({ headers } = { headers: false }) {
+    const { error } = CompanyProfilePlatformValidator.cbsOnboardGet().validate(
       {},
       { abortEarly: false, allowUnknown: true }
     );
@@ -29,16 +33,15 @@ class CompanyProfile {
     // Showing warrnings if extra unknown parameters are found
     const {
       error: warrning,
-    } = CompanyProfileValidator.cbsOnboardGet().validate(
+    } = CompanyProfilePlatformValidator.cbsOnboardGet().validate(
       {},
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for cbsOnboardGet",
+        message: `Parameter Validation warrnings for platform > CompanyProfile > cbsOnboardGet \n ${warrning}`,
       });
-      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
@@ -51,36 +54,43 @@ class CompanyProfile {
       `/service/platform/company-profile/v1.0/company/${this.config.companyId}`,
       query_params,
       undefined,
-      xHeaders
+      xHeaders,
+      { headers }
     );
 
+    let responseData = response;
+    if (headers) {
+      responseData = response[0];
+    }
+
     const {
       error: res_error,
-    } = CompanyProfileModel.GetCompanyProfileSerializerResponse().validate(
-      response,
+    } = CompanyProfilePlatformModel.GetCompanyProfileSerializerResponse().validate(
+      responseData,
       { abortEarly: false, allowUnknown: false }
     );
 
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for cbsOnboardGet",
+        message: `Response Validation Warnnings for platform > CompanyProfile > cbsOnboardGet \n ${res_error}`,
       });
-      Logger({ level: "WARN", message: res_error });
     }
 
     return response;
   }
 
   /**
-   * @param {Object} arg - Arg object.
-   * @param {CreateUpdateBrandRequestSerializer} arg.body
-   * @returns {Promise<ProfileSuccessResponse>} - Success response
+   * @param {CompanyProfilePlatformValidator.CreateBrandParam} arg - Arg object
+   * @param {import("../PlatformAPIClient").Options} - Options
+   * @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
+   *   Success response
+   * @name createBrand
    * @summary: Create a Brand.
-   * @description: This API allows to create a brand associated to a company.
+   * @description: This API allows to create a brand associated to a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/createBrand/).
    */
-  async createBrand({ body } = {}) {
-    const { error } = CompanyProfileValidator.createBrand().validate(
+  async createBrand({ body } = {}, { headers } = { headers: false }) {
+    const { error } = CompanyProfilePlatformValidator.createBrand().validate(
       {
         body,
       },
@@ -91,7 +101,9 @@ class CompanyProfile {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = CompanyProfileValidator.createBrand().validate(
+    const {
+      error: warrning,
+    } = CompanyProfilePlatformValidator.createBrand().validate(
       {
         body,
       },
@@ -100,9 +112,8 @@ class CompanyProfile {
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for createBrand",
+        message: `Parameter Validation warrnings for platform > CompanyProfile > createBrand \n ${warrning}`,
       });
-      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
@@ -115,38 +126,50 @@ class CompanyProfile {
       `/service/platform/company-profile/v1.0/company/${this.config.companyId}/brand/`,
       query_params,
       body,
-      xHeaders
+      xHeaders,
+      { headers }
     );
 
+    let responseData = response;
+    if (headers) {
+      responseData = response[0];
+    }
+
     const {
       error: res_error,
-    } = CompanyProfileModel.ProfileSuccessResponse().validate(response, {
-      abortEarly: false,
-      allowUnknown: false,
-    });
+    } = CompanyProfilePlatformModel.ProfileSuccessResponse().validate(
+      responseData,
+      { abortEarly: false, allowUnknown: false }
+    );
 
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for createBrand",
+        message: `Response Validation Warnnings for platform > CompanyProfile > createBrand \n ${res_error}`,
       });
-      Logger({ level: "WARN", message: res_error });
     }
 
     return response;
   }
 
   /**
-   * @param {Object} arg - Arg object.
-   * @param {CompanyBrandPostRequestSerializer} arg.body
-   * @returns {Promise<ProfileSuccessResponse>} - Success response
+   * @param {CompanyProfilePlatformValidator.CreateCompanyBrandMappingParam} arg
+   *   - Arg object
+   *
+   * @param {import("../PlatformAPIClient").Options} - Options
+   * @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
+   *   Success response
+   * @name createCompanyBrandMapping
    * @summary: Create a company brand mapping.
-   * @description: This API allows to create a company brand mapping, for a already existing brand in the system.
+   * @description: This API allows to create a company brand mapping, for a already existing brand in the system. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/createCompanyBrandMapping/).
    */
-  async createCompanyBrandMapping({ body } = {}) {
+  async createCompanyBrandMapping(
+    { body } = {},
+    { headers } = { headers: false }
+  ) {
     const {
       error,
-    } = CompanyProfileValidator.createCompanyBrandMapping().validate(
+    } = CompanyProfilePlatformValidator.createCompanyBrandMapping().validate(
       {
         body,
       },
@@ -159,7 +182,7 @@ class CompanyProfile {
     // Showing warrnings if extra unknown parameters are found
     const {
       error: warrning,
-    } = CompanyProfileValidator.createCompanyBrandMapping().validate(
+    } = CompanyProfilePlatformValidator.createCompanyBrandMapping().validate(
       {
         body,
       },
@@ -168,9 +191,8 @@ class CompanyProfile {
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for createCompanyBrandMapping",
+        message: `Parameter Validation warrnings for platform > CompanyProfile > createCompanyBrandMapping \n ${warrning}`,
       });
-      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
@@ -183,36 +205,43 @@ class CompanyProfile {
       `/service/platform/company-profile/v1.0/company/${this.config.companyId}/company-brand`,
       query_params,
       body,
-      xHeaders
+      xHeaders,
+      { headers }
     );
 
+    let responseData = response;
+    if (headers) {
+      responseData = response[0];
+    }
+
     const {
       error: res_error,
-    } = CompanyProfileModel.ProfileSuccessResponse().validate(response, {
-      abortEarly: false,
-      allowUnknown: false,
-    });
+    } = CompanyProfilePlatformModel.ProfileSuccessResponse().validate(
+      responseData,
+      { abortEarly: false, allowUnknown: false }
+    );
 
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for createCompanyBrandMapping",
+        message: `Response Validation Warnnings for platform > CompanyProfile > createCompanyBrandMapping \n ${res_error}`,
       });
-      Logger({ level: "WARN", message: res_error });
     }
 
     return response;
   }
 
   /**
-   * @param {Object} arg - Arg object.
-   * @param {LocationSerializer} arg.body
-   * @returns {Promise<ProfileSuccessResponse>} - Success response
+   * @param {CompanyProfilePlatformValidator.CreateLocationParam} arg - Arg object
+   * @param {import("../PlatformAPIClient").Options} - Options
+   * @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
+   *   Success response
+   * @name createLocation
    * @summary: Create a location associated to a company.
-   * @description: This API allows to edit a location associated to a company.
+   * @description: This API allows to edit a location associated to a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/createLocation/).
    */
-  async createLocation({ body } = {}) {
-    const { error } = CompanyProfileValidator.createLocation().validate(
+  async createLocation({ body } = {}, { headers } = { headers: false }) {
+    const { error } = CompanyProfilePlatformValidator.createLocation().validate(
       {
         body,
       },
@@ -225,7 +254,7 @@ class CompanyProfile {
     // Showing warrnings if extra unknown parameters are found
     const {
       error: warrning,
-    } = CompanyProfileValidator.createLocation().validate(
+    } = CompanyProfilePlatformValidator.createLocation().validate(
       {
         body,
       },
@@ -234,9 +263,8 @@ class CompanyProfile {
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for createLocation",
+        message: `Parameter Validation warrnings for platform > CompanyProfile > createLocation \n ${warrning}`,
       });
-      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
@@ -249,36 +277,45 @@ class CompanyProfile {
       `/service/platform/company-profile/v1.0/company/${this.config.companyId}/location`,
       query_params,
       body,
-      xHeaders
+      xHeaders,
+      { headers }
     );
 
+    let responseData = response;
+    if (headers) {
+      responseData = response[0];
+    }
+
     const {
       error: res_error,
-    } = CompanyProfileModel.ProfileSuccessResponse().validate(response, {
-      abortEarly: false,
-      allowUnknown: false,
-    });
+    } = CompanyProfilePlatformModel.ProfileSuccessResponse().validate(
+      responseData,
+      { abortEarly: false, allowUnknown: false }
+    );
 
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for createLocation",
+        message: `Response Validation Warnnings for platform > CompanyProfile > createLocation \n ${res_error}`,
       });
-      Logger({ level: "WARN", message: res_error });
     }
 
     return response;
   }
 
   /**
-   * @param {Object} arg - Arg object.
-   * @param {BulkLocationSerializer} arg.body
-   * @returns {Promise<ProfileSuccessResponse>} - Success response
+   * @param {CompanyProfilePlatformValidator.CreateLocationBulkParam} arg - Arg object
+   * @param {import("../PlatformAPIClient").Options} - Options
+   * @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
+   *   Success response
+   * @name createLocationBulk
    * @summary: Create a location asscoiated to a company in bulk.
-   * @description: This API allows to create a location associated to a company.
+   * @description: This API allows to create a location associated to a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/createLocationBulk/).
    */
-  async createLocationBulk({ body } = {}) {
-    const { error } = CompanyProfileValidator.createLocationBulk().validate(
+  async createLocationBulk({ body } = {}, { headers } = { headers: false }) {
+    const {
+      error,
+    } = CompanyProfilePlatformValidator.createLocationBulk().validate(
       {
         body,
       },
@@ -291,7 +328,7 @@ class CompanyProfile {
     // Showing warrnings if extra unknown parameters are found
     const {
       error: warrning,
-    } = CompanyProfileValidator.createLocationBulk().validate(
+    } = CompanyProfilePlatformValidator.createLocationBulk().validate(
       {
         body,
       },
@@ -300,9 +337,8 @@ class CompanyProfile {
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for createLocationBulk",
+        message: `Parameter Validation warrnings for platform > CompanyProfile > createLocationBulk \n ${warrning}`,
       });
-      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
@@ -315,37 +351,43 @@ class CompanyProfile {
       `/service/platform/company-profile/v1.0/company/${this.config.companyId}/location/bulk`,
       query_params,
       body,
-      xHeaders
+      xHeaders,
+      { headers }
     );
 
+    let responseData = response;
+    if (headers) {
+      responseData = response[0];
+    }
+
     const {
       error: res_error,
-    } = CompanyProfileModel.ProfileSuccessResponse().validate(response, {
-      abortEarly: false,
-      allowUnknown: false,
-    });
+    } = CompanyProfilePlatformModel.ProfileSuccessResponse().validate(
+      responseData,
+      { abortEarly: false, allowUnknown: false }
+    );
 
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for createLocationBulk",
+        message: `Response Validation Warnnings for platform > CompanyProfile > createLocationBulk \n ${res_error}`,
       });
-      Logger({ level: "WARN", message: res_error });
     }
 
     return response;
   }
 
   /**
-   * @param {Object} arg - Arg object.
-   * @param {string} arg.brandId - Id of the brand to be viewed.
-   * @param {CreateUpdateBrandRequestSerializer} arg.body
-   * @returns {Promise<ProfileSuccessResponse>} - Success response
+   * @param {CompanyProfilePlatformValidator.EditBrandParam} arg - Arg object
+   * @param {import("../PlatformAPIClient").Options} - Options
+   * @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
+   *   Success response
+   * @name editBrand
    * @summary: Edit a brand.
-   * @description: This API allows to edit meta of a brand.
+   * @description: This API allows to edit meta of a brand. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/editBrand/).
    */
-  async editBrand({ brandId, body } = {}) {
-    const { error } = CompanyProfileValidator.editBrand().validate(
+  async editBrand({ brandId, body } = {}, { headers } = { headers: false }) {
+    const { error } = CompanyProfilePlatformValidator.editBrand().validate(
       {
         brandId,
         body,
@@ -357,7 +399,9 @@ class CompanyProfile {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = CompanyProfileValidator.editBrand().validate(
+    const {
+      error: warrning,
+    } = CompanyProfilePlatformValidator.editBrand().validate(
       {
         brandId,
         body,
@@ -367,9 +411,8 @@ class CompanyProfile {
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for editBrand",
+        message: `Parameter Validation warrnings for platform > CompanyProfile > editBrand \n ${warrning}`,
       });
-      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
@@ -382,36 +425,44 @@ class CompanyProfile {
       `/service/platform/company-profile/v1.0/company/${this.config.companyId}/brand/${brandId}`,
       query_params,
       body,
-      xHeaders
+      xHeaders,
+      { headers }
     );
 
+    let responseData = response;
+    if (headers) {
+      responseData = response[0];
+    }
+
     const {
       error: res_error,
-    } = CompanyProfileModel.ProfileSuccessResponse().validate(response, {
-      abortEarly: false,
-      allowUnknown: false,
-    });
+    } = CompanyProfilePlatformModel.ProfileSuccessResponse().validate(
+      responseData,
+      { abortEarly: false, allowUnknown: false }
+    );
 
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for editBrand",
+        message: `Response Validation Warnnings for platform > CompanyProfile > editBrand \n ${res_error}`,
       });
-      Logger({ level: "WARN", message: res_error });
     }
 
     return response;
   }
 
   /**
-   * @param {Object} arg - Arg object.
-   * @param {string} arg.brandId - Id of the brand to be viewed.
-   * @returns {Promise<GetBrandResponseSerializer>} - Success response
+   * @param {CompanyProfilePlatformValidator.GetBrandParam} arg - Arg object
+   * @param {import("../PlatformAPIClient").Options} - Options
+   * @returns {Promise<CompanyProfilePlatformModel.GetBrandResponseSerializer>}
+   *   - Success response
+   *
+   * @name getBrand
    * @summary: Get a single company brand.
-   * @description: This API helps to get data associated to a particular company brand.
+   * @description: This API helps to get data associated to a particular company brand. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/getBrand/).
    */
-  async getBrand({ brandId } = {}) {
-    const { error } = CompanyProfileValidator.getBrand().validate(
+  async getBrand({ brandId } = {}, { headers } = { headers: false }) {
+    const { error } = CompanyProfilePlatformValidator.getBrand().validate(
       {
         brandId,
       },
@@ -422,7 +473,9 @@ class CompanyProfile {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = CompanyProfileValidator.getBrand().validate(
+    const {
+      error: warrning,
+    } = CompanyProfilePlatformValidator.getBrand().validate(
       {
         brandId,
       },
@@ -431,9 +484,8 @@ class CompanyProfile {
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for getBrand",
+        message: `Parameter Validation warrnings for platform > CompanyProfile > getBrand \n ${warrning}`,
       });
-      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
@@ -446,40 +498,47 @@ class CompanyProfile {
       `/service/platform/company-profile/v1.0/company/${this.config.companyId}/brand/${brandId}`,
       query_params,
       undefined,
-      xHeaders
+      xHeaders,
+      { headers }
     );
 
+    let responseData = response;
+    if (headers) {
+      responseData = response[0];
+    }
+
     const {
       error: res_error,
-    } = CompanyProfileModel.GetBrandResponseSerializer().validate(response, {
-      abortEarly: false,
-      allowUnknown: false,
-    });
+    } = CompanyProfilePlatformModel.GetBrandResponseSerializer().validate(
+      responseData,
+      { abortEarly: false, allowUnknown: false }
+    );
 
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for getBrand",
+        message: `Response Validation Warnnings for platform > CompanyProfile > getBrand \n ${res_error}`,
       });
-      Logger({ level: "WARN", message: res_error });
     }
 
     return response;
   }
 
   /**
-   * @param {Object} arg - Arg object.
-   * @param {number} [arg.pageNo] - The page number to navigate through the
-   *   given set of results
-   * @param {number} [arg.pageSize] - Number of items to retrieve in each
-   *   page. Default is 10.
-   * @param {string} [arg.q] - Search term for name.
-   * @returns {Promise<CompanyBrandListSerializer>} - Success response
+   * @param {CompanyProfilePlatformValidator.GetBrandsParam} arg - Arg object
+   * @param {import("../PlatformAPIClient").Options} - Options
+   * @returns {Promise<CompanyProfilePlatformModel.CompanyBrandListSerializer>}
+   *   - Success response
+   *
+   * @name getBrands
    * @summary: Get brands associated to a company
-   * @description: This API helps to get view brands associated to a particular company.
+   * @description: This API helps to get view brands associated to a particular company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/getBrands/).
    */
-  async getBrands({ pageNo, pageSize, q } = {}) {
-    const { error } = CompanyProfileValidator.getBrands().validate(
+  async getBrands(
+    { pageNo, pageSize, q } = {},
+    { headers } = { headers: false }
+  ) {
+    const { error } = CompanyProfilePlatformValidator.getBrands().validate(
       {
         pageNo,
         pageSize,
@@ -492,7 +551,9 @@ class CompanyProfile {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = CompanyProfileValidator.getBrands().validate(
+    const {
+      error: warrning,
+    } = CompanyProfilePlatformValidator.getBrands().validate(
       {
         pageNo,
         pageSize,
@@ -503,9 +564,8 @@ class CompanyProfile {
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for getBrands",
+        message: `Parameter Validation warrnings for platform > CompanyProfile > getBrands \n ${warrning}`,
       });
-      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
@@ -521,22 +581,27 @@ class CompanyProfile {
       `/service/platform/company-profile/v1.0/company/${this.config.companyId}/company-brand`,
       query_params,
       undefined,
-      xHeaders
+      xHeaders,
+      { headers }
     );
 
+    let responseData = response;
+    if (headers) {
+      responseData = response[0];
+    }
+
     const {
       error: res_error,
-    } = CompanyProfileModel.CompanyBrandListSerializer().validate(response, {
-      abortEarly: false,
-      allowUnknown: false,
-    });
+    } = CompanyProfilePlatformModel.CompanyBrandListSerializer().validate(
+      responseData,
+      { abortEarly: false, allowUnknown: false }
+    );
 
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for getBrands",
+        message: `Response Validation Warnnings for platform > CompanyProfile > getBrands \n ${res_error}`,
       });
-      Logger({ level: "WARN", message: res_error });
     }
 
     return response;
@@ -547,6 +612,7 @@ class CompanyProfile {
    * @param {number} [arg.pageSize] - Number of items to retrieve in each
    *   page. Default is 10.
    * @param {string} [arg.q] - Search term for name.
+   * @returns {Paginator<CompanyProfilePlatformModel.CompanyBrandListSerializer>}
    * @summary: Get brands associated to a company
    * @description: This API helps to get view brands associated to a particular company.
    */
@@ -572,13 +638,18 @@ class CompanyProfile {
   }
 
   /**
-   * @param {Object} arg - Arg object.
-   * @returns {Promise<MetricsSerializer>} - Success response
+   * @param {CompanyProfilePlatformValidator.GetCompanyMetricsParam} arg - Arg object
+   * @param {import("../PlatformAPIClient").Options} - Options
+   * @returns {Promise<CompanyProfilePlatformModel.MetricsSerializer>} -
+   *   Success response
+   * @name getCompanyMetrics
    * @summary: Get company metrics
-   * @description: This API allows to view the company metrics, i.e. the status of its brand and stores. Also its allows to view the number of products, company documents & store documents which are verified and unverified.
+   * @description: This API allows to view the company metrics, i.e. the status of its brand and stores. Also its allows to view the number of products, company documents & store documents which are verified and unverified. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/getCompanyMetrics/).
    */
-  async getCompanyMetrics({} = {}) {
-    const { error } = CompanyProfileValidator.getCompanyMetrics().validate(
+  async getCompanyMetrics({ headers } = { headers: false }) {
+    const {
+      error,
+    } = CompanyProfilePlatformValidator.getCompanyMetrics().validate(
       {},
       { abortEarly: false, allowUnknown: true }
     );
@@ -589,16 +660,15 @@ class CompanyProfile {
     // Showing warrnings if extra unknown parameters are found
     const {
       error: warrning,
-    } = CompanyProfileValidator.getCompanyMetrics().validate(
+    } = CompanyProfilePlatformValidator.getCompanyMetrics().validate(
       {},
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for getCompanyMetrics",
+        message: `Parameter Validation warrnings for platform > CompanyProfile > getCompanyMetrics \n ${warrning}`,
       });
-      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
@@ -611,12 +681,18 @@ class CompanyProfile {
       `/service/platform/company-profile/v1.0/company/${this.config.companyId}/metrics`,
       query_params,
       undefined,
-      xHeaders
+      xHeaders,
+      { headers }
     );
 
+    let responseData = response;
+    if (headers) {
+      responseData = response[0];
+    }
+
     const {
       error: res_error,
-    } = CompanyProfileModel.MetricsSerializer().validate(response, {
+    } = CompanyProfilePlatformModel.MetricsSerializer().validate(responseData, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -624,23 +700,29 @@ class CompanyProfile {
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for getCompanyMetrics",
+        message: `Response Validation Warnnings for platform > CompanyProfile > getCompanyMetrics \n ${res_error}`,
       });
-      Logger({ level: "WARN", message: res_error });
     }
 
     return response;
   }
 
   /**
-   * @param {Object} arg - Arg object.
-   * @param {string} arg.locationId - Id of the location which you want to view.
-   * @returns {Promise<GetLocationSerializer>} - Success response
+   * @param {CompanyProfilePlatformValidator.GetLocationDetailParam} arg - Arg object
+   * @param {import("../PlatformAPIClient").Options} - Options
+   * @returns {Promise<CompanyProfilePlatformModel.GetLocationSerializer>} -
+   *   Success response
+   * @name getLocationDetail
    * @summary: Get details of a specific location.
-   * @description: This API helps to get data associated to a specific location.
+   * @description: This API helps to get data associated to a specific location. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/getLocationDetail/).
    */
-  async getLocationDetail({ locationId } = {}) {
-    const { error } = CompanyProfileValidator.getLocationDetail().validate(
+  async getLocationDetail(
+    { locationId } = {},
+    { headers } = { headers: false }
+  ) {
+    const {
+      error,
+    } = CompanyProfilePlatformValidator.getLocationDetail().validate(
       {
         locationId,
       },
@@ -653,7 +735,7 @@ class CompanyProfile {
     // Showing warrnings if extra unknown parameters are found
     const {
       error: warrning,
-    } = CompanyProfileValidator.getLocationDetail().validate(
+    } = CompanyProfilePlatformValidator.getLocationDetail().validate(
       {
         locationId,
       },
@@ -662,9 +744,8 @@ class CompanyProfile {
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for getLocationDetail",
+        message: `Parameter Validation warrnings for platform > CompanyProfile > getLocationDetail \n ${warrning}`,
       });
-      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
@@ -677,52 +758,46 @@ class CompanyProfile {
       `/service/platform/company-profile/v1.0/company/${this.config.companyId}/location/${locationId}`,
       query_params,
       undefined,
-      xHeaders
+      xHeaders,
+      { headers }
     );
 
+    let responseData = response;
+    if (headers) {
+      responseData = response[0];
+    }
+
     const {
       error: res_error,
-    } = CompanyProfileModel.GetLocationSerializer().validate(response, {
-      abortEarly: false,
-      allowUnknown: false,
-    });
+    } = CompanyProfilePlatformModel.GetLocationSerializer().validate(
+      responseData,
+      { abortEarly: false, allowUnknown: false }
+    );
 
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for getLocationDetail",
+        message: `Response Validation Warnnings for platform > CompanyProfile > getLocationDetail \n ${res_error}`,
       });
-      Logger({ level: "WARN", message: res_error });
     }
 
     return response;
   }
 
   /**
-   * @param {Object} arg - Arg object.
-   * @param {string} [arg.storeType] - Helps to sort the location list on the
-   *   basis of location type.
-   * @param {string} [arg.q] - Query that is to be searched.
-   * @param {string} [arg.stage] - To filter companies on basis of verified or
-   *   unverified companies.
-   * @param {number} [arg.pageNo] - The page number to navigate through the
-   *   given set of results
-   * @param {number} [arg.pageSize] - Number of items to retrieve in each
-   *   page. Default is 10.
-   * @param {number[]} [arg.locationIds] - Helps to filter stores on the basis of uids.
-   * @returns {Promise<LocationListSerializer>} - Success response
+   * @param {CompanyProfilePlatformValidator.GetLocationsParam} arg - Arg object
+   * @param {import("../PlatformAPIClient").Options} - Options
+   * @returns {Promise<CompanyProfilePlatformModel.LocationListSerializer>} -
+   *   Success response
+   * @name getLocations
    * @summary: Get list of locations
-   * @description: This API allows to view all the locations associated to a company.
+   * @description: This API allows to view all the locations associated to a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/getLocations/).
    */
-  async getLocations({
-    storeType,
-    q,
-    stage,
-    pageNo,
-    pageSize,
-    locationIds,
-  } = {}) {
-    const { error } = CompanyProfileValidator.getLocations().validate(
+  async getLocations(
+    { storeType, q, stage, pageNo, pageSize, locationIds } = {},
+    { headers } = { headers: false }
+  ) {
+    const { error } = CompanyProfilePlatformValidator.getLocations().validate(
       {
         storeType,
         q,
@@ -738,7 +813,9 @@ class CompanyProfile {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = CompanyProfileValidator.getLocations().validate(
+    const {
+      error: warrning,
+    } = CompanyProfilePlatformValidator.getLocations().validate(
       {
         storeType,
         q,
@@ -752,9 +829,8 @@ class CompanyProfile {
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for getLocations",
+        message: `Parameter Validation warrnings for platform > CompanyProfile > getLocations \n ${warrning}`,
       });
-      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
@@ -773,22 +849,27 @@ class CompanyProfile {
       `/service/platform/company-profile/v1.0/company/${this.config.companyId}/location`,
       query_params,
       undefined,
-      xHeaders
+      xHeaders,
+      { headers }
     );
 
+    let responseData = response;
+    if (headers) {
+      responseData = response[0];
+    }
+
     const {
       error: res_error,
-    } = CompanyProfileModel.LocationListSerializer().validate(response, {
-      abortEarly: false,
-      allowUnknown: false,
-    });
+    } = CompanyProfilePlatformModel.LocationListSerializer().validate(
+      responseData,
+      { abortEarly: false, allowUnknown: false }
+    );
 
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for getLocations",
+        message: `Response Validation Warnnings for platform > CompanyProfile > getLocations \n ${res_error}`,
       });
-      Logger({ level: "WARN", message: res_error });
     }
 
     return response;
@@ -804,6 +885,7 @@ class CompanyProfile {
    * @param {number} [arg.pageSize] - Number of items to retrieve in each
    *   page. Default is 10.
    * @param {number[]} [arg.locationIds] - Helps to filter stores on the basis of uids.
+   * @returns {Paginator<CompanyProfilePlatformModel.LocationListSerializer>}
    * @summary: Get list of locations
    * @description: This API allows to view all the locations associated to a company.
    */
@@ -832,14 +914,16 @@ class CompanyProfile {
   }
 
   /**
-   * @param {Object} arg - Arg object.
-   * @param {UpdateCompany} arg.body
-   * @returns {Promise<ProfileSuccessResponse>} - Success response
+   * @param {CompanyProfilePlatformValidator.UpdateCompanyParam} arg - Arg object
+   * @param {import("../PlatformAPIClient").Options} - Options
+   * @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
+   *   Success response
+   * @name updateCompany
    * @summary: Edit company profile
-   * @description: This API allows to edit the company profile of the seller account.
+   * @description: This API allows to edit the company profile of the seller account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/updateCompany/).
    */
-  async updateCompany({ body } = {}) {
-    const { error } = CompanyProfileValidator.updateCompany().validate(
+  async updateCompany({ body } = {}, { headers } = { headers: false }) {
+    const { error } = CompanyProfilePlatformValidator.updateCompany().validate(
       {
         body,
       },
@@ -852,7 +936,7 @@ class CompanyProfile {
     // Showing warrnings if extra unknown parameters are found
     const {
       error: warrning,
-    } = CompanyProfileValidator.updateCompany().validate(
+    } = CompanyProfilePlatformValidator.updateCompany().validate(
       {
         body,
       },
@@ -861,9 +945,8 @@ class CompanyProfile {
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for updateCompany",
+        message: `Parameter Validation warrnings for platform > CompanyProfile > updateCompany \n ${warrning}`,
       });
-      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
@@ -876,37 +959,46 @@ class CompanyProfile {
       `/service/platform/company-profile/v1.0/company/${this.config.companyId}`,
       query_params,
       body,
-      xHeaders
+      xHeaders,
+      { headers }
     );
 
+    let responseData = response;
+    if (headers) {
+      responseData = response[0];
+    }
+
     const {
       error: res_error,
-    } = CompanyProfileModel.ProfileSuccessResponse().validate(response, {
-      abortEarly: false,
-      allowUnknown: false,
-    });
+    } = CompanyProfilePlatformModel.ProfileSuccessResponse().validate(
+      responseData,
+      { abortEarly: false, allowUnknown: false }
+    );
 
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for updateCompany",
+        message: `Response Validation Warnnings for platform > CompanyProfile > updateCompany \n ${res_error}`,
       });
-      Logger({ level: "WARN", message: res_error });
     }
 
     return response;
   }
 
   /**
-   * @param {Object} arg - Arg object.
-   * @param {string} arg.locationId - Id of the location which you want to edit.
-   * @param {LocationSerializer} arg.body
-   * @returns {Promise<ProfileSuccessResponse>} - Success response
+   * @param {CompanyProfilePlatformValidator.UpdateLocationParam} arg - Arg object
+   * @param {import("../PlatformAPIClient").Options} - Options
+   * @returns {Promise<CompanyProfilePlatformModel.ProfileSuccessResponse>} -
+   *   Success response
+   * @name updateLocation
    * @summary: Edit a location asscoiated to a company.
-   * @description: This API allows to edit a location associated to a company.
+   * @description: This API allows to edit a location associated to a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/updateLocation/).
    */
-  async updateLocation({ locationId, body } = {}) {
-    const { error } = CompanyProfileValidator.updateLocation().validate(
+  async updateLocation(
+    { locationId, body } = {},
+    { headers } = { headers: false }
+  ) {
+    const { error } = CompanyProfilePlatformValidator.updateLocation().validate(
       {
         locationId,
         body,
@@ -920,7 +1012,7 @@ class CompanyProfile {
     // Showing warrnings if extra unknown parameters are found
     const {
       error: warrning,
-    } = CompanyProfileValidator.updateLocation().validate(
+    } = CompanyProfilePlatformValidator.updateLocation().validate(
       {
         locationId,
         body,
@@ -930,9 +1022,8 @@ class CompanyProfile {
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for updateLocation",
+        message: `Parameter Validation warrnings for platform > CompanyProfile > updateLocation \n ${warrning}`,
       });
-      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
@@ -945,22 +1036,27 @@ class CompanyProfile {
       `/service/platform/company-profile/v1.0/company/${this.config.companyId}/location/${locationId}`,
       query_params,
       body,
-      xHeaders
+      xHeaders,
+      { headers }
     );
 
+    let responseData = response;
+    if (headers) {
+      responseData = response[0];
+    }
+
     const {
       error: res_error,
-    } = CompanyProfileModel.ProfileSuccessResponse().validate(response, {
-      abortEarly: false,
-      allowUnknown: false,
-    });
+    } = CompanyProfilePlatformModel.ProfileSuccessResponse().validate(
+      responseData,
+      { abortEarly: false, allowUnknown: false }
+    );
 
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for updateLocation",
+        message: `Response Validation Warnnings for platform > CompanyProfile > updateLocation \n ${res_error}`,
       });
-      Logger({ level: "WARN", message: res_error });
     }
 
     return response;