@gofynd/fdk-client-javascript 1.0.0 → 1.0.2

package/sdk/platform/Communication/CommunicationPlatformClient.d.ts

@@ -6,13 +6,14 @@ declare class Communication {
      * @param {Object} arg - Arg object.
      * @param {number} [arg.pageNo] -
      * @param {number} [arg.pageSize] -
+     * @returns {Promise<SystemNotifications>} - Success response
      * @summary: Get system notifications
      * @description: Get system notifications
      */
     getSystemNotifications({ pageNo, pageSize }?: {
         pageNo?: number;
         pageSize?: number;
-    }): Promise<any>;
+    }): Promise<SystemNotifications>;
     /**
      * @param {Object} arg - Arg object.
      * @param {number} [arg.pageSize] -

package/sdk/platform/Communication/CommunicationPlatformClient.js

@@ -2,6 +2,9 @@ const Paginator = require("../../common/Paginator");
 const { FDKClientValidationError } = require("../../common/FDKError");
 const PlatformAPIClient = require("../PlatformAPIClient");
 const CommunicationValidator = require("./CommunicationPlatformValidator");
+const CommunicationModel = require("./CommunicationPlatformModel");
+const { Logger } = require("./../../common/Logger");
+
 class Communication {
   constructor(config) {
     this.config = config;
@@ -11,10 +14,11 @@ class Communication {
    * @param {Object} arg - Arg object.
    * @param {number} [arg.pageNo] -
    * @param {number} [arg.pageSize] -
+   * @returns {Promise<SystemNotifications>} - Success response
    * @summary: Get system notifications
    * @description: Get system notifications
    */
-  getSystemNotifications({ pageNo, pageSize } = {}) {
+  async getSystemNotifications({ pageNo, pageSize } = {}) {
     const { error } = CommunicationValidator.getSystemNotifications().validate(
       {
         pageNo,
@@ -26,13 +30,31 @@ class Communication {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = CommunicationValidator.getSystemNotifications().validate(
+      {
+        pageNo,
+        pageSize,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getSystemNotifications",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
     query_params["page_no"] = pageNo;
     query_params["page_size"] = pageSize;
 
     const xHeaders = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "get",
       `/service/platform/communication/v1.0/company/${this.config.companyId}/notification/system-notifications/`,
@@ -40,6 +62,23 @@ class Communication {
       undefined,
       xHeaders
     );
+
+    const {
+      error: res_error,
+    } = CommunicationModel.SystemNotifications().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for getSystemNotifications",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**

package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts

@@ -4,54 +4,60 @@ declare class CompanyProfile {
     config: any;
     /**
      * @param {Object} arg - Arg object.
+     * @returns {Promise<GetCompanyProfileSerializerResponse>} - Success response
      * @summary: Get company profile
      * @description: This API allows to view the company profile of the seller account.
      */
-    cbsOnboardGet({}?: any): Promise<any>;
+    cbsOnboardGet({}?: any): Promise<GetCompanyProfileSerializerResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {UpdateCompany} arg.body
+     * @returns {Promise<ProfileSuccessResponse>} - Success response
      * @summary: Edit company profile
      * @description: This API allows to edit the company profile of the seller account.
      */
     updateCompany({ body }?: {
         body: UpdateCompany;
-    }): Promise<any>;
+    }): Promise<ProfileSuccessResponse>;
     /**
      * @param {Object} arg - Arg object.
+     * @returns {Promise<MetricsSerializer>} - Success response
      * @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.
      */
-    getCompanyMetrics({}?: any): Promise<any>;
+    getCompanyMetrics({}?: any): Promise<MetricsSerializer>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.brandId - Id of the brand to be viewed.
+     * @returns {Promise<GetBrandResponseSerializer>} - Success response
      * @summary: Get a single brand.
      * @description: This API helps to get data associated to a particular brand.
      */
     getBrand({ brandId }?: {
         brandId: string;
-    }): Promise<any>;
+    }): Promise<GetBrandResponseSerializer>;
     /**
      * @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
      * @summary: Edit a brand.
      * @description: This API allows to edit meta of a brand.
      */
     editBrand({ brandId, body }?: {
         brandId: string;
         body: CreateUpdateBrandRequestSerializer;
-    }): Promise<any>;
+    }): Promise<ProfileSuccessResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {CreateUpdateBrandRequestSerializer} arg.body
+     * @returns {Promise<ProfileSuccessResponse>} - Success response
      * @summary: Create a Brand.
      * @description: This API allows to create a brand associated to a company.
      */
     createBrand({ body }?: {
         body: CreateUpdateBrandRequestSerializer;
-    }): Promise<any>;
+    }): Promise<ProfileSuccessResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {number} [arg.pageNo] - The page number to navigate through the
@@ -59,6 +65,7 @@ declare 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 {Promise<CompanyBrandListSerializer>} - Success response
      * @summary: Get brands associated to a company
      * @description: This API helps to get view brands associated to a particular company.
      */
@@ -66,7 +73,7 @@ declare class CompanyProfile {
         pageNo?: number;
         pageSize?: number;
         q?: string;
-    }): Promise<any>;
+    }): Promise<CompanyBrandListSerializer>;
     /**
      * @param {Object} arg - Arg object.
      * @param {number} [arg.pageSize] - Number of items to retrieve in each
@@ -82,12 +89,13 @@ declare class CompanyProfile {
     /**
      * @param {Object} arg - Arg object.
      * @param {CompanyBrandPostRequestSerializer} arg.body
+     * @returns {Promise<ProfileSuccessResponse>} - Success response
      * @summary: Create a company brand mapping.
      * @description: This API allows to create a company brand mapping, for a already existing brand in the system.
      */
     createCompanyBrandMapping({ body }?: {
         body: CompanyBrandPostRequestSerializer;
-    }): Promise<any>;
+    }): Promise<ProfileSuccessResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} [arg.storeType] - Helps to sort the location list on the
@@ -100,17 +108,18 @@ declare 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 {Promise<LocationListSerializer>} - Success response
      * @summary: Get list of locations
      * @description: This API allows to view all the locations associated to a company.
      */
-    getLocations({ storeType, q, stage, pageNo, pageSize, locationIds }?: {
+    getLocations({ storeType, q, stage, pageNo, pageSize, locationIds, }?: {
         storeType?: string;
         q?: string;
         stage?: string;
         pageNo?: number;
         pageSize?: number;
         locationIds?: number[];
-    }): Promise<any>;
+    }): Promise<LocationListSerializer>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} [arg.storeType] - Helps to sort the location list on the
@@ -134,40 +143,44 @@ declare class CompanyProfile {
     /**
      * @param {Object} arg - Arg object.
      * @param {LocationSerializer} arg.body
+     * @returns {Promise<ProfileSuccessResponse>} - Success response
      * @summary: Create a location associated to a company.
      * @description: This API allows to edit a location associated to a company.
      */
     createLocation({ body }?: {
         body: LocationSerializer;
-    }): Promise<any>;
+    }): Promise<ProfileSuccessResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.locationId - Id of the location which you want to view.
+     * @returns {Promise<GetLocationSerializer>} - Success response
      * @summary: Get details of a specific location.
      * @description: This API helps to get data associated to a specific location.
      */
     getLocationDetail({ locationId }?: {
         locationId: string;
-    }): Promise<any>;
+    }): Promise<GetLocationSerializer>;
     /**
      * @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
      * @summary: Edit a location asscoiated to a company.
      * @description: This API allows to edit a location associated to a company.
      */
     updateLocation({ locationId, body }?: {
         locationId: string;
         body: LocationSerializer;
-    }): Promise<any>;
+    }): Promise<ProfileSuccessResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {BulkLocationSerializer} arg.body
+     * @returns {Promise<ProfileSuccessResponse>} - Success response
      * @summary: Create a location asscoiated to a company in bulk.
      * @description: This API allows to create a location associated to a company.
      */
     createLocationBulk({ body }?: {
         body: BulkLocationSerializer;
-    }): Promise<any>;
+    }): Promise<ProfileSuccessResponse>;
 }
 import Paginator = require("../../common/Paginator");