@gofynd/fdk-client-javascript 1.0.0 → 1.0.2

package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts

@@ -1,13 +1,13 @@
 export = CatalogValidator;
 declare class CatalogValidator {
-    static getProductBundle(): any;
     static createProductBundle(): any;
-    static updateProductBundle(): any;
+    static getProductBundle(): any;
     static getProductBundleDetail(): any;
-    static getSizeGuides(): any;
+    static updateProductBundle(): any;
     static createSizeGuide(): any;
-    static updateSizeGuide(): any;
+    static getSizeGuides(): any;
     static getSizeGuide(): any;
+    static updateSizeGuide(): any;
     static getSellerInsights(): any;
     static createMarketplaceOptin(): any;
     static getMarketplaceOptinDetail(): any;
@@ -17,10 +17,10 @@ declare class CatalogValidator {
     static getStoreDetail(): any;
     static getGenderAttribute(): any;
     static listProductTemplateCategories(): any;
-    static listDepartmentsData(): any;
     static createDepartments(): any;
-    static updateDepartment(): any;
+    static listDepartmentsData(): any;
     static getDepartmentData(): any;
+    static updateDepartment(): any;
     static listProductTemplate(): any;
     static validateProductTemplate(): any;
     static downloadProductTemplateViews(): any;
@@ -28,49 +28,51 @@ declare class CatalogValidator {
     static validateProductTemplateSchema(): any;
     static listHSNCodes(): any;
     static listProductTemplateExportDetails(): any;
+    static createProductExportJob(): any;
+    static getProductExportJobs(): any;
     static listTemplateBrandTypeValues(): any;
-    static listCategories(): any;
     static createCategories(): any;
-    static updateCategory(): any;
+    static listCategories(): any;
     static getCategoryData(): any;
-    static getProducts(): any;
+    static updateCategory(): any;
     static createProduct(): any;
+    static getProducts(): any;
     static getVariantsOfProducts(): any;
     static getProductAttributes(): any;
-    static editProduct(): any;
     static getProduct(): any;
+    static editProduct(): any;
     static deleteProduct(): any;
     static allSizes(): any;
     static getProductValidation(): any;
     static getProductSize(): any;
-    static getProductBulkUploadHistory(): any;
     static createBulkProductUploadJob(): any;
+    static getProductBulkUploadHistory(): any;
     static uploadBulkProducts(): any;
-    static deleteProductBulkJob(): any;
     static createProductsInBulk(): any;
+    static deleteProductBulkJob(): any;
     static getProductTags(): any;
-    static getProductAssetsInBulk(): any;
     static createProductAssetsInBulk(): any;
+    static getProductAssetsInBulk(): any;
     static deleteSize(): any;
-    static getInventoryBySize(): any;
     static addInventory(): any;
+    static getInventoryBySize(): any;
     static getInventoryBySizeIdentifier(): any;
     static getInventories(): any;
     static deleteInventory(): any;
-    static getInventoryBulkUploadHistory(): any;
     static createBulkInventoryJob(): any;
-    static deleteBulkInventoryJob(): any;
+    static getInventoryBulkUploadHistory(): any;
     static createBulkInventory(): any;
-    static getInventoryExport(): any;
+    static deleteBulkInventoryJob(): any;
     static createInventoryExportJob(): any;
+    static getInventoryExport(): any;
+    static createInventoryExport(): any;
+    static listInventoryExport(): any;
     static exportInventoryConfig(): any;
-    static deleteRealtimeInventory(): any;
     static updateRealtimeInventory(): any;
+    static deleteRealtimeInventory(): any;
     static updateInventories(): any;
-    static getAllHsnCodes(): any;
-    static createHsnCode(): any;
-    static updateHsnCode(): any;
     static getHsnCode(): any;
+    static updateHsnCode(): any;
     static bulkHsnCode(): any;
     static getAllProductHsnCodes(): any;
     static getSingleProductHSNCode(): any;

package/sdk/platform/Catalog/CatalogPlatformValidator.js

@@ -2,6 +2,12 @@ const Joi = require("joi");
 
 const CatalogModel = require("./CatalogPlatformModel");
 class CatalogValidator {
+  static createProductBundle() {
+    return Joi.object({
+      body: CatalogModel.ProductBundleRequest().required(),
+    }).required();
+  }
+
   static getProductBundle() {
     return Joi.object({
       q: Joi.string().allow(""),
@@ -9,9 +15,9 @@ class CatalogValidator {
     }).required();
   }
 
-  static createProductBundle() {
+  static getProductBundleDetail() {
     return Joi.object({
-      body: CatalogModel.ProductBundleRequest().required(),
+      id: Joi.string().allow("").required(),
     }).required();
   }
 
@@ -22,9 +28,9 @@ class CatalogValidator {
     }).required();
   }
 
-  static getProductBundleDetail() {
+  static createSizeGuide() {
     return Joi.object({
-      id: Joi.string().allow("").required(),
+      body: CatalogModel.ValidateSizeGuide().required(),
     }).required();
   }
 
@@ -38,9 +44,9 @@ class CatalogValidator {
     }).required();
   }
 
-  static createSizeGuide() {
+  static getSizeGuide() {
     return Joi.object({
-      body: CatalogModel.ValidateSizeGuide().required(),
+      id: Joi.string().allow("").required(),
     }).required();
   }
 
@@ -51,12 +57,6 @@ class CatalogValidator {
     }).required();
   }
 
-  static getSizeGuide() {
-    return Joi.object({
-      id: Joi.string().allow("").required(),
-    }).required();
-  }
-
   static getSellerInsights() {
     return Joi.object({
       sellerAppId: Joi.string().allow("").required(),
@@ -113,9 +113,16 @@ class CatalogValidator {
     }).required();
   }
 
+  static createDepartments() {
+    return Joi.object({
+      body: CatalogModel.DepartmentCreateUpdate().required(),
+    }).required();
+  }
+
   static listDepartmentsData() {
     return Joi.object({
       pageNo: Joi.number(),
+      itemType: Joi.string().allow(""),
       pageSize: Joi.number(),
       name: Joi.string().allow(""),
       search: Joi.string().allow(""),
@@ -123,9 +130,9 @@ class CatalogValidator {
     }).required();
   }
 
-  static createDepartments() {
+  static getDepartmentData() {
     return Joi.object({
-      body: CatalogModel.DepartmentCreateUpdate().required(),
+      uid: Joi.string().allow("").required(),
     }).required();
   }
 
@@ -136,12 +143,6 @@ class CatalogValidator {
     }).required();
   }
 
-  static getDepartmentData() {
-    return Joi.object({
-      uid: Joi.string().allow("").required(),
-    }).required();
-  }
-
   static listProductTemplate() {
     return Joi.object({
       department: Joi.string().allow("").required(),
@@ -180,9 +181,32 @@ class CatalogValidator {
     return Joi.object({}).required();
   }
 
+  static createProductExportJob() {
+    return Joi.object({
+      body: CatalogModel.ProductTemplateDownloadsExport().required(),
+    }).required();
+  }
+
+  static getProductExportJobs() {
+    return Joi.object({
+      status: Joi.string().allow(""),
+      fromDate: Joi.string().allow(""),
+      toDate: Joi.string().allow(""),
+      q: Joi.string().allow(""),
+    }).required();
+  }
+
   static listTemplateBrandTypeValues() {
     return Joi.object({
       filter: Joi.string().allow("").required(),
+      templateTag: Joi.string().allow(""),
+      itemType: Joi.string().allow(""),
+    }).required();
+  }
+
+  static createCategories() {
+    return Joi.object({
+      body: CatalogModel.CategoryRequestBody().required(),
     }).required();
   }
 
@@ -196,9 +220,9 @@ class CatalogValidator {
     }).required();
   }
 
-  static createCategories() {
+  static getCategoryData() {
     return Joi.object({
-      body: CatalogModel.CategoryRequestBody().required(),
+      uid: Joi.string().allow("").required(),
     }).required();
   }
 
@@ -209,9 +233,9 @@ class CatalogValidator {
     }).required();
   }
 
-  static getCategoryData() {
+  static createProduct() {
     return Joi.object({
-      uid: Joi.string().allow("").required(),
+      body: CatalogModel.ProductCreateUpdateSchemaV2().required(),
     }).required();
   }
 
@@ -229,12 +253,6 @@ class CatalogValidator {
     }).required();
   }
 
-  static createProduct() {
-    return Joi.object({
-      body: CatalogModel.ProductCreateUpdateSchemaV2().required(),
-    }).required();
-  }
-
   static getVariantsOfProducts() {
     return Joi.object({
       itemId: Joi.number().required(),
@@ -251,18 +269,18 @@ class CatalogValidator {
     }).required();
   }
 
-  static editProduct() {
+  static getProduct() {
     return Joi.object({
       itemId: Joi.number().required(),
-      body: CatalogModel.ProductCreateUpdateSchemaV2().required(),
+      brandUid: Joi.number(),
+      itemCode: Joi.string().allow(""),
     }).required();
   }
 
-  static getProduct() {
+  static editProduct() {
     return Joi.object({
       itemId: Joi.number().required(),
-      brandUid: Joi.number(),
-      itemCode: Joi.string().allow(""),
+      body: CatalogModel.ProductCreateUpdateSchemaV2().required(),
     }).required();
   }
 
@@ -291,17 +309,17 @@ class CatalogValidator {
     }).required();
   }
 
-  static getProductBulkUploadHistory() {
+  static createBulkProductUploadJob() {
     return Joi.object({
-      search: Joi.string().allow(""),
-      pageNo: Joi.number(),
-      pageSize: Joi.number(),
+      body: CatalogModel.BulkJob().required(),
     }).required();
   }
 
-  static createBulkProductUploadJob() {
+  static getProductBulkUploadHistory() {
     return Joi.object({
-      body: CatalogModel.BulkJob().required(),
+      search: Joi.string().allow(""),
+      pageNo: Joi.number(),
+      pageSize: Joi.number(),
     }).required();
   }
 
@@ -313,16 +331,16 @@ class CatalogValidator {
     }).required();
   }
 
-  static deleteProductBulkJob() {
+  static createProductsInBulk() {
     return Joi.object({
-      batchId: Joi.number().required(),
+      batchId: Joi.string().allow("").required(),
+      body: CatalogModel.BulkProductRequest().required(),
     }).required();
   }
 
-  static createProductsInBulk() {
+  static deleteProductBulkJob() {
     return Joi.object({
-      batchId: Joi.string().allow("").required(),
-      body: CatalogModel.BulkProductRequest().required(),
+      batchId: Joi.number().required(),
     }).required();
   }
 
@@ -330,6 +348,12 @@ class CatalogValidator {
     return Joi.object({}).required();
   }
 
+  static createProductAssetsInBulk() {
+    return Joi.object({
+      body: CatalogModel.ProductBulkAssets().required(),
+    }).required();
+  }
+
   static getProductAssetsInBulk() {
     return Joi.object({
       pageNo: Joi.number(),
@@ -337,22 +361,24 @@ class CatalogValidator {
     }).required();
   }
 
-  static createProductAssetsInBulk() {
+  static deleteSize() {
     return Joi.object({
-      body: CatalogModel.ProductBulkAssets().required(),
+      itemId: Joi.number().required(),
+      size: Joi.string().allow("").required(),
     }).required();
   }
 
-  static deleteSize() {
+  static addInventory() {
     return Joi.object({
       itemId: Joi.number().required(),
       size: Joi.string().allow("").required(),
+      body: CatalogModel.InventoryRequest().required(),
     }).required();
   }
 
   static getInventoryBySize() {
     return Joi.object({
-      itemId: Joi.string().allow("").required(),
+      itemId: Joi.number().required(),
       size: Joi.string().allow("").required(),
       pageNo: Joi.number(),
       pageSize: Joi.number(),
@@ -361,17 +387,9 @@ class CatalogValidator {
     }).required();
   }
 
-  static addInventory() {
-    return Joi.object({
-      itemId: Joi.number().required(),
-      size: Joi.string().allow("").required(),
-      body: CatalogModel.InventoryRequest().required(),
-    }).required();
-  }
-
   static getInventoryBySizeIdentifier() {
     return Joi.object({
-      itemId: Joi.string().allow("").required(),
+      itemId: Joi.number().required(),
       sizeIdentifier: Joi.string().allow("").required(),
       pageNo: Joi.number(),
       pageSize: Joi.number(),
@@ -401,6 +419,12 @@ class CatalogValidator {
     }).required();
   }
 
+  static createBulkInventoryJob() {
+    return Joi.object({
+      body: CatalogModel.BulkJob().required(),
+    }).required();
+  }
+
   static getInventoryBulkUploadHistory() {
     return Joi.object({
       pageNo: Joi.number(),
@@ -408,9 +432,10 @@ class CatalogValidator {
     }).required();
   }
 
-  static createBulkInventoryJob() {
+  static createBulkInventory() {
     return Joi.object({
-      body: CatalogModel.BulkJob().required(),
+      batchId: Joi.string().allow("").required(),
+      body: CatalogModel.InventoryBulkRequest().required(),
     }).required();
   }
 
@@ -420,10 +445,9 @@ class CatalogValidator {
     }).required();
   }
 
-  static createBulkInventory() {
+  static createInventoryExportJob() {
     return Joi.object({
-      batchId: Joi.string().allow("").required(),
-      body: CatalogModel.InventoryBulkRequest().required(),
+      body: CatalogModel.InventoryExportRequest().required(),
     }).required();
   }
 
@@ -431,9 +455,18 @@ class CatalogValidator {
     return Joi.object({}).required();
   }
 
-  static createInventoryExportJob() {
+  static createInventoryExport() {
     return Joi.object({
-      body: CatalogModel.InventoryExportRequest().required(),
+      body: CatalogModel.InventoryCreateRequest().required(),
+    }).required();
+  }
+
+  static listInventoryExport() {
+    return Joi.object({
+      status: Joi.string().allow(""),
+      fromDate: Joi.string().allow(""),
+      toDate: Joi.string().allow(""),
+      q: Joi.string().allow(""),
     }).required();
   }
 
@@ -443,7 +476,7 @@ class CatalogValidator {
     }).required();
   }
 
-  static deleteRealtimeInventory() {
+  static updateRealtimeInventory() {
     return Joi.object({
       itemId: Joi.number().required(),
       sellerIdentifier: Joi.string().allow("").required(),
@@ -451,7 +484,7 @@ class CatalogValidator {
     }).required();
   }
 
-  static updateRealtimeInventory() {
+  static deleteRealtimeInventory() {
     return Joi.object({
       itemId: Joi.number().required(),
       sellerIdentifier: Joi.string().allow("").required(),
@@ -465,17 +498,9 @@ class CatalogValidator {
     }).required();
   }
 
-  static getAllHsnCodes() {
-    return Joi.object({
-      pageNo: Joi.number(),
-      pageSize: Joi.number(),
-      q: Joi.string().allow(""),
-    }).required();
-  }
-
-  static createHsnCode() {
+  static getHsnCode() {
     return Joi.object({
-      body: CatalogModel.HsnUpsert().required(),
+      id: Joi.string().allow("").required(),
     }).required();
   }
 
@@ -486,12 +511,6 @@ class CatalogValidator {
     }).required();
   }
 
-  static getHsnCode() {
-    return Joi.object({
-      id: Joi.string().allow("").required(),
-    }).required();
-  }
-
   static bulkHsnCode() {
     return Joi.object({
       body: CatalogModel.BulkHsnUpsert().required(),

package/sdk/platform/Common/CommonPlatformClient.d.ts

@@ -6,13 +6,14 @@ declare class Common {
      * @param {Object} arg - Arg object.
      * @param {string} [arg.authorization] -
      * @param {string} [arg.query] - Provide application name
+     * @returns {Promise<ApplicationResponse>} - Success response
      * @summary: Search Application
      * @description: Provide application name or domain url
      */
     searchApplication({ authorization, query }?: {
         authorization?: string;
         query?: string;
-    }): Promise<any>;
+    }): Promise<ApplicationResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} [arg.locationType] - Provide location type to query on.
@@ -20,11 +21,12 @@ declare class Common {
      * @param {string} [arg.id] - Field is optional when location_type is
      *   country. If querying for state, provide id of country. If querying for
      *   city, provide id of state.
+     * @returns {Promise<Locations>} - Success response
      * @summary: Get countries, states, cities
      * @description:
      */
     getLocations({ locationType, id }?: {
         locationType?: string;
         id?: string;
-    }): Promise<any>;
+    }): Promise<Locations>;
 }

package/sdk/platform/Common/CommonPlatformClient.js

@@ -2,6 +2,9 @@ const Paginator = require("../../common/Paginator");
 const { FDKClientValidationError } = require("../../common/FDKError");
 const PlatformAPIClient = require("../PlatformAPIClient");
 const CommonValidator = require("./CommonPlatformValidator");
+const CommonModel = require("./CommonPlatformModel");
+const { Logger } = require("./../../common/Logger");
+
 class Common {
   constructor(config) {
     this.config = config;
@@ -11,10 +14,11 @@ class Common {
    * @param {Object} arg - Arg object.
    * @param {string} [arg.authorization] -
    * @param {string} [arg.query] - Provide application name
+   * @returns {Promise<ApplicationResponse>} - Success response
    * @summary: Search Application
    * @description: Provide application name or domain url
    */
-  searchApplication({ authorization, query } = {}) {
+  async searchApplication({ authorization, query } = {}) {
     const { error } = CommonValidator.searchApplication().validate(
       {
         authorization,
@@ -26,13 +30,29 @@ class Common {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = CommonValidator.searchApplication().validate(
+      {
+        authorization,
+        query,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for searchApplication",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
     query_params["query"] = query;
 
     const xHeaders = {};
     xHeaders["authorization"] = authorization;
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "get",
       `/service/common/configuration/v1.0/application/search-application`,
@@ -40,6 +60,23 @@ class Common {
       undefined,
       xHeaders
     );
+
+    const {
+      error: res_error,
+    } = CommonModel.ApplicationResponse().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for searchApplication",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
@@ -49,10 +86,11 @@ class Common {
    * @param {string} [arg.id] - Field is optional when location_type is
    *   country. If querying for state, provide id of country. If querying for
    *   city, provide id of state.
+   * @returns {Promise<Locations>} - Success response
    * @summary: Get countries, states, cities
    * @description:
    */
-  getLocations({ locationType, id } = {}) {
+  async getLocations({ locationType, id } = {}) {
     const { error } = CommonValidator.getLocations().validate(
       {
         locationType,
@@ -64,13 +102,29 @@ class Common {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = CommonValidator.getLocations().validate(
+      {
+        locationType,
+        id,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getLocations",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
     query_params["location_type"] = locationType;
     query_params["id"] = id;
 
     const xHeaders = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "get",
       `/service/common/configuration/v1.0/location`,
@@ -78,6 +132,21 @@ class Common {
       undefined,
       xHeaders
     );
+
+    const { error: res_error } = CommonModel.Locations().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for getLocations",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 }