@gofynd/fdk-client-javascript 0.1.37 → 1.0.1

package/sdk/platform/{models/CatalogValidator.js → Catalog/CatalogPlatformValidator.js}

@@ -1,12 +1,7 @@
 const Joi = require("joi");
-const Validator = require("../PlatformModels");
-class CatalogValidator {
-  static createProductBundle() {
-    return Joi.object({
-      body: Validator.ProductBundleRequest().required(),
-    }).required();
-  }
 
+const CatalogModel = require("./CatalogPlatformModel");
+class CatalogValidator {
   static getProductBundle() {
     return Joi.object({
       q: Joi.string().allow(""),
@@ -14,10 +9,9 @@ class CatalogValidator {
     }).required();
   }
 
-  static updateProductBundle() {
+  static createProductBundle() {
     return Joi.object({
-      id: Joi.string().allow("").required(),
-      body: Validator.ProductBundleUpdateRequest().required(),
+      body: CatalogModel.ProductBundleRequest().required(),
     }).required();
   }
 
@@ -27,9 +21,10 @@ class CatalogValidator {
     }).required();
   }
 
-  static createSizeGuide() {
+  static updateProductBundle() {
     return Joi.object({
-      body: Validator.ValidateSizeGuide().required(),
+      id: Joi.string().allow("").required(),
+      body: CatalogModel.ProductBundleUpdateRequest().required(),
     }).required();
   }
 
@@ -43,10 +38,9 @@ class CatalogValidator {
     }).required();
   }
 
-  static updateSizeGuide() {
+  static createSizeGuide() {
     return Joi.object({
-      id: Joi.string().allow("").required(),
-      body: Validator.ValidateSizeGuide().required(),
+      body: CatalogModel.ValidateSizeGuide().required(),
     }).required();
   }
 
@@ -56,6 +50,13 @@ class CatalogValidator {
     }).required();
   }
 
+  static updateSizeGuide() {
+    return Joi.object({
+      id: Joi.string().allow("").required(),
+      body: CatalogModel.ValidateSizeGuide().required(),
+    }).required();
+  }
+
   static getSellerInsights() {
     return Joi.object({
       sellerAppId: Joi.string().allow("").required(),
@@ -65,7 +66,7 @@ class CatalogValidator {
   static createMarketplaceOptin() {
     return Joi.object({
       marketplace: Joi.string().allow("").required(),
-      body: Validator.OptInPostRequest().required(),
+      body: CatalogModel.OptInPostRequest().required(),
     }).required();
   }
 
@@ -112,12 +113,6 @@ class CatalogValidator {
     }).required();
   }
 
-  static createDepartments() {
-    return Joi.object({
-      body: Validator.DepartmentCreateUpdate().required(),
-    }).required();
-  }
-
   static listDepartmentsData() {
     return Joi.object({
       pageNo: Joi.number(),
@@ -128,10 +123,9 @@ class CatalogValidator {
     }).required();
   }
 
-  static updateDepartment() {
+  static createDepartments() {
     return Joi.object({
-      uid: Joi.string().allow("").required(),
-      body: Validator.DepartmentCreateUpdate().required(),
+      body: CatalogModel.DepartmentCreateUpdate().required(),
     }).required();
   }
 
@@ -141,6 +135,13 @@ class CatalogValidator {
     }).required();
   }
 
+  static updateDepartment() {
+    return Joi.object({
+      uid: Joi.string().allow("").required(),
+      body: CatalogModel.DepartmentCreateUpdate().required(),
+    }).required();
+  }
+
   static listProductTemplate() {
     return Joi.object({
       department: Joi.string().allow("").required(),
@@ -185,12 +186,6 @@ class CatalogValidator {
     }).required();
   }
 
-  static createCategories() {
-    return Joi.object({
-      body: Validator.CategoryRequestBody().required(),
-    }).required();
-  }
-
   static listCategories() {
     return Joi.object({
       level: Joi.string().allow(""),
@@ -201,10 +196,9 @@ class CatalogValidator {
     }).required();
   }
 
-  static updateCategory() {
+  static createCategories() {
     return Joi.object({
-      uid: Joi.string().allow("").required(),
-      body: Validator.CategoryRequestBody().required(),
+      body: CatalogModel.CategoryRequestBody().required(),
     }).required();
   }
 
@@ -214,9 +208,10 @@ class CatalogValidator {
     }).required();
   }
 
-  static createProduct() {
+  static updateCategory() {
     return Joi.object({
-      body: Validator.ProductCreateUpdateSchemaV2().required(),
+      uid: Joi.string().allow("").required(),
+      body: CatalogModel.CategoryRequestBody().required(),
     }).required();
   }
 
@@ -234,6 +229,12 @@ class CatalogValidator {
     }).required();
   }
 
+  static createProduct() {
+    return Joi.object({
+      body: CatalogModel.ProductCreateUpdateSchemaV2().required(),
+    }).required();
+  }
+
   static getVariantsOfProducts() {
     return Joi.object({
       itemId: Joi.number().required(),
@@ -250,24 +251,24 @@ class CatalogValidator {
     }).required();
   }
 
-  static deleteProduct() {
+  static getProduct() {
     return Joi.object({
       itemId: Joi.number().required(),
+      brandUid: Joi.number(),
+      itemCode: Joi.string().allow(""),
     }).required();
   }
 
   static editProduct() {
     return Joi.object({
       itemId: Joi.number().required(),
-      body: Validator.ProductCreateUpdateSchemaV2().required(),
+      body: CatalogModel.ProductCreateUpdateSchemaV2().required(),
     }).required();
   }
 
-  static getProduct() {
+  static deleteProduct() {
     return Joi.object({
       itemId: Joi.number().required(),
-      brandUid: Joi.number(),
-      itemCode: Joi.string().allow(""),
     }).required();
   }
 
@@ -290,12 +291,6 @@ class CatalogValidator {
     }).required();
   }
 
-  static createBulkProductUploadJob() {
-    return Joi.object({
-      body: Validator.BulkJob().required(),
-    }).required();
-  }
-
   static getProductBulkUploadHistory() {
     return Joi.object({
       search: Joi.string().allow(""),
@@ -304,24 +299,30 @@ class CatalogValidator {
     }).required();
   }
 
+  static createBulkProductUploadJob() {
+    return Joi.object({
+      body: CatalogModel.BulkJob().required(),
+    }).required();
+  }
+
   static uploadBulkProducts() {
     return Joi.object({
       department: Joi.string().allow("").required(),
       productType: Joi.string().allow("").required(),
-      body: Validator.BulkJob().required(),
+      body: CatalogModel.BulkJob().required(),
     }).required();
   }
 
-  static createProductsInBulk() {
+  static deleteProductBulkJob() {
     return Joi.object({
-      batchId: Joi.string().allow("").required(),
-      body: Validator.BulkProductRequest().required(),
+      batchId: Joi.number().required(),
     }).required();
   }
 
-  static deleteProductBulkJob() {
+  static createProductsInBulk() {
     return Joi.object({
-      batchId: Joi.number().required(),
+      batchId: Joi.string().allow("").required(),
+      body: CatalogModel.BulkProductRequest().required(),
     }).required();
   }
 
@@ -329,12 +330,6 @@ class CatalogValidator {
     return Joi.object({}).required();
   }
 
-  static createProductAssetsInBulk() {
-    return Joi.object({
-      body: Validator.ProductBulkAssets().required(),
-    }).required();
-  }
-
   static getProductAssetsInBulk() {
     return Joi.object({
       pageNo: Joi.number(),
@@ -342,18 +337,16 @@ class CatalogValidator {
     }).required();
   }
 
-  static deleteSize() {
+  static createProductAssetsInBulk() {
     return Joi.object({
-      itemId: Joi.number().required(),
-      size: Joi.string().allow("").required(),
+      body: CatalogModel.ProductBulkAssets().required(),
     }).required();
   }
 
-  static addInventory() {
+  static deleteSize() {
     return Joi.object({
       itemId: Joi.number().required(),
       size: Joi.string().allow("").required(),
-      body: Validator.InventoryRequest().required(),
     }).required();
   }
 
@@ -368,6 +361,14 @@ 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(),
@@ -400,12 +401,6 @@ class CatalogValidator {
     }).required();
   }
 
-  static createBulkInventoryJob() {
-    return Joi.object({
-      body: Validator.BulkJob().required(),
-    }).required();
-  }
-
   static getInventoryBulkUploadHistory() {
     return Joi.object({
       pageNo: Joi.number(),
@@ -413,10 +408,9 @@ class CatalogValidator {
     }).required();
   }
 
-  static createBulkInventory() {
+  static createBulkInventoryJob() {
     return Joi.object({
-      batchId: Joi.string().allow("").required(),
-      body: Validator.InventoryBulkRequest().required(),
+      body: CatalogModel.BulkJob().required(),
     }).required();
   }
 
@@ -426,9 +420,10 @@ class CatalogValidator {
     }).required();
   }
 
-  static createInventoryExportJob() {
+  static createBulkInventory() {
     return Joi.object({
-      body: Validator.InventoryExportRequest().required(),
+      batchId: Joi.string().allow("").required(),
+      body: CatalogModel.InventoryBulkRequest().required(),
     }).required();
   }
 
@@ -436,17 +431,15 @@ class CatalogValidator {
     return Joi.object({}).required();
   }
 
-  static exportInventoryConfig() {
+  static createInventoryExportJob() {
     return Joi.object({
-      filterType: Joi.string().allow(""),
+      body: CatalogModel.InventoryExportRequest().required(),
     }).required();
   }
 
-  static updateRealtimeInventory() {
+  static exportInventoryConfig() {
     return Joi.object({
-      itemId: Joi.number().required(),
-      sellerIdentifier: Joi.string().allow("").required(),
-      body: Validator.InventoryRequestSchemaV2().required(),
+      filterType: Joi.string().allow(""),
     }).required();
   }
 
@@ -454,19 +447,21 @@ class CatalogValidator {
     return Joi.object({
       itemId: Joi.number().required(),
       sellerIdentifier: Joi.string().allow("").required(),
-      body: Validator.InventoryRequestSchemaV2().required(),
+      body: CatalogModel.InventoryRequestSchemaV2().required(),
     }).required();
   }
 
-  static updateInventories() {
+  static updateRealtimeInventory() {
     return Joi.object({
-      body: Validator.InventoryRequestSchemaV2().required(),
+      itemId: Joi.number().required(),
+      sellerIdentifier: Joi.string().allow("").required(),
+      body: CatalogModel.InventoryRequestSchemaV2().required(),
     }).required();
   }
 
-  static createHsnCode() {
+  static updateInventories() {
     return Joi.object({
-      body: Validator.HsnUpsert().required(),
+      body: CatalogModel.InventoryRequestSchemaV2().required(),
     }).required();
   }
 
@@ -478,10 +473,9 @@ class CatalogValidator {
     }).required();
   }
 
-  static updateHsnCode() {
+  static createHsnCode() {
     return Joi.object({
-      id: Joi.string().allow("").required(),
-      body: Validator.HsnUpsert().required(),
+      body: CatalogModel.HsnUpsert().required(),
     }).required();
   }
 
@@ -491,9 +485,16 @@ class CatalogValidator {
     }).required();
   }
 
+  static updateHsnCode() {
+    return Joi.object({
+      id: Joi.string().allow("").required(),
+      body: CatalogModel.HsnUpsert().required(),
+    }).required();
+  }
+
   static bulkHsnCode() {
     return Joi.object({
-      body: Validator.BulkHsnUpsert().required(),
+      body: CatalogModel.BulkHsnUpsert().required(),
     }).required();
   }
 
@@ -514,7 +515,7 @@ class CatalogValidator {
 
   static getOptimalLocations() {
     return Joi.object({
-      body: Validator.AssignStore().required(),
+      body: CatalogModel.AssignStore().required(),
     }).required();
   }
 }

package/sdk/platform/{client → Common}/CommonPlatformClient.js

@@ -1,7 +1,7 @@
 const Paginator = require("../../common/Paginator");
-const PlatformAPIClient = require("../PlatformAPIClient");
 const { FDKClientValidationError } = require("../../common/FDKError");
-const CommonValidator = require("../models/CommonValidator");
+const PlatformAPIClient = require("../PlatformAPIClient");
+const CommonValidator = require("./CommonPlatformValidator");
 class Common {
   constructor(config) {
     this.config = config;
@@ -26,6 +26,19 @@ 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) {
+      console.log("Parameter Validation warrnings for searchApplication");
+      console.log(warrning);
+    }
+
     const query_params = {};
     query_params["query"] = query;
 
@@ -64,6 +77,19 @@ 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) {
+      console.log("Parameter Validation warrnings for getLocations");
+      console.log(warrning);
+    }
+
     const query_params = {};
     query_params["location_type"] = locationType;
     query_params["id"] = id;

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

@@ -0,0 +1,20 @@
+export = CommonModel;
+declare class CommonModel {
+    static ApplicationResponse(): any;
+    static Currency(): any;
+    static Domain(): any;
+    static ApplicationWebsite(): any;
+    static ApplicationCors(): any;
+    static ApplicationAuth(): any;
+    static ApplicationRedirections(): any;
+    static ApplicationMeta(): any;
+    static SecureUrl(): any;
+    static Application(): any;
+    static NotFound(): any;
+    static BadRequest(): any;
+    static Page(): any;
+    static LocationDefaultLanguage(): any;
+    static LocationDefaultCurrency(): any;
+    static LocationCountry(): any;
+    static Locations(): any;
+}

package/sdk/platform/Common/CommonPlatformModel.js

@@ -0,0 +1,228 @@
+const Joi = require("joi");
+
+class CommonModel {
+  static ApplicationResponse() {
+    return Joi.object({
+      application: CommonModel.Application(),
+    });
+  }
+
+  static Currency() {
+    return Joi.object({
+      _id: Joi.string().allow(""),
+
+      is_active: Joi.boolean(),
+
+      name: Joi.string().allow(""),
+
+      code: Joi.string().allow(""),
+
+      created_at: Joi.string().allow(""),
+
+      updated_at: Joi.string().allow(""),
+
+      decimal_digits: Joi.number(),
+
+      symbol: Joi.string().allow(""),
+    });
+  }
+
+  static Domain() {
+    return Joi.object({
+      verified: Joi.boolean(),
+
+      is_primary: Joi.boolean(),
+
+      is_shortlink: Joi.boolean(),
+
+      _id: Joi.string().allow(""),
+
+      name: Joi.string().allow(""),
+
+      is_predefined: Joi.boolean(),
+    });
+  }
+
+  static ApplicationWebsite() {
+    return Joi.object({
+      enabled: Joi.boolean(),
+
+      basepath: Joi.string().allow(""),
+    });
+  }
+
+  static ApplicationCors() {
+    return Joi.object({
+      domains: Joi.array().items(Joi.string().allow("")),
+    });
+  }
+
+  static ApplicationAuth() {
+    return Joi.object({
+      enabled: Joi.boolean(),
+    });
+  }
+
+  static ApplicationRedirections() {
+    return Joi.object({
+      redirect_from: Joi.string().allow(""),
+
+      redirect_to: Joi.string().allow(""),
+
+      type: Joi.string().allow(""),
+    });
+  }
+
+  static ApplicationMeta() {
+    return Joi.object({
+      name: Joi.string().allow(""),
+
+      value: Joi.string().allow(""),
+    });
+  }
+
+  static SecureUrl() {
+    return Joi.object({
+      secure_url: Joi.string().allow(""),
+    });
+  }
+
+  static Application() {
+    return Joi.object({
+      website: CommonModel.ApplicationWebsite(),
+
+      cors: CommonModel.ApplicationCors(),
+
+      auth: CommonModel.ApplicationAuth(),
+
+      description: Joi.string().allow(""),
+
+      channel_type: Joi.string().allow(""),
+
+      cache_ttl: Joi.number(),
+
+      is_internal: Joi.boolean(),
+
+      is_active: Joi.boolean(),
+
+      _id: Joi.string().allow(""),
+
+      name: Joi.string().allow(""),
+
+      owner: Joi.string().allow(""),
+
+      company_id: Joi.number(),
+
+      token: Joi.string().allow(""),
+
+      redirections: Joi.array().items(CommonModel.ApplicationRedirections()),
+
+      meta: Joi.array().items(CommonModel.ApplicationMeta()),
+
+      created_at: Joi.string().allow(""),
+
+      updated_at: Joi.string().allow(""),
+
+      __v: Joi.number(),
+
+      banner: CommonModel.SecureUrl(),
+
+      logo: CommonModel.SecureUrl(),
+
+      favicon: CommonModel.SecureUrl(),
+
+      domains: Joi.array().items(CommonModel.Domain()),
+
+      app_type: Joi.string().allow(""),
+
+      mobile_logo: CommonModel.SecureUrl(),
+
+      domain: CommonModel.Domain(),
+    });
+  }
+
+  static NotFound() {
+    return Joi.object({
+      message: Joi.string().allow(""),
+    });
+  }
+
+  static BadRequest() {
+    return Joi.object({
+      message: Joi.string().allow(""),
+    });
+  }
+
+  static Page() {
+    return Joi.object({
+      item_total: Joi.number(),
+
+      next_id: Joi.string().allow(""),
+
+      has_previous: Joi.boolean(),
+
+      has_next: Joi.boolean(),
+
+      current: Joi.number(),
+
+      type: Joi.string().allow("").required(),
+
+      size: Joi.number(),
+    });
+  }
+
+  static LocationDefaultLanguage() {
+    return Joi.object({
+      name: Joi.string().allow(""),
+
+      code: Joi.string().allow(""),
+    });
+  }
+
+  static LocationDefaultCurrency() {
+    return Joi.object({
+      name: Joi.string().allow(""),
+
+      symbol: Joi.string().allow(""),
+
+      code: Joi.string().allow(""),
+    });
+  }
+
+  static LocationCountry() {
+    return Joi.object({
+      capital: Joi.string().allow(""),
+
+      currency: Joi.string().allow(""),
+
+      iso2: Joi.string().allow(""),
+
+      iso3: Joi.string().allow(""),
+
+      name: Joi.string().allow(""),
+
+      parent: Joi.string().allow(""),
+
+      phone_code: Joi.string().allow(""),
+
+      type: Joi.string().allow(""),
+
+      uid: Joi.number(),
+
+      __v: Joi.number(),
+
+      _id: Joi.string().allow(""),
+
+      default_currency: CommonModel.LocationDefaultCurrency(),
+
+      default_language: CommonModel.LocationDefaultLanguage(),
+    });
+  }
+
+  static Locations() {
+    return Joi.object({
+      items: Joi.array().items(Joi.any()),
+    });
+  }
+}
+module.exports = CommonModel;