@gofynd/fdk-client-javascript 1.4.1 → 1.4.2-beta.10

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

@@ -77,6 +77,13 @@ export = CatalogPlatformValidator;
  * @typedef DeleteBulkInventoryJobParam
  * @property {string} batchId - Batch Id of the bulk delete job.
  */
+/**
+ * @typedef DeleteInventoryParam
+ * @property {string} size - Size that is to be deleted.
+ * @property {number} itemId - Id of the product associated with Inventory to be deleted.
+ * @property {number} locationId - Location ID of store of which inventory is to
+ *   be deleted.
+ */
 /**
  * @typedef DeleteProductParam
  * @property {number} itemId - Id of the product to be updated.
@@ -200,7 +207,6 @@ export = CatalogPlatformValidator;
  */
 /** @typedef GetInventoryExportParam */
 /** @typedef GetMarketplaceOptinDetailParam */
-/** @typedef GetMarketplacesParam */
 /**
  * @typedef GetOptimalLocationsParam
  * @property {CatalogPlatformModel.AssignStore} body
@@ -298,7 +304,6 @@ export = CatalogPlatformValidator;
  *   set of results
  * @property {number} [pageSize] - Number of items to retrieve in each page.
  *   Default is 10.
- * @property {number} [brandId] - Brand id that is to be searched.
  */
 /**
  * @typedef GetStoreDetailParam
@@ -319,14 +324,12 @@ export = CatalogPlatformValidator;
 /**
  * @typedef ListCategoriesParam
  * @property {string} [level] - Get category for multiple levels
- * @property {number} [department] - Get category for multiple departments filtered
+ * @property {string} [departments] - Get category for multiple departments filtered
  * @property {string} [q] - Get multiple categories filtered by search string
  * @property {number} [pageNo] - The page number to navigate through the given
  *   set of results
  * @property {number} [pageSize] - Number of items to retrieve in each page.
  *   Default is 10.
- * @property {number[]} [uids] - Get multiple categories filtered by category uids.
- * @property {string} [slug] - Get category by slug
  */
 /**
  * @typedef ListDepartmentsDataParam
@@ -341,7 +344,6 @@ export = CatalogPlatformValidator;
  *   department in search parameter.
  * @property {boolean} [isActive] - Can query for departments based on whether
  *   they are active or inactive.
- * @property {string} [slug] - Can filter by slug
  */
 /** @typedef ListHSNCodesParam */
 /**
@@ -392,11 +394,6 @@ export = CatalogPlatformValidator;
  * @typedef UpdateInventoriesParam
  * @property {CatalogPlatformModel.InventoryRequestSchemaV2} body
  */
-/**
- * @typedef UpdateMarketplaceOptinParam
- * @property {string} marketplaceSlug - Slug of the marketplace .
- * @property {CatalogPlatformModel.UpdateMarketplaceOptinRequest} body
- */
 /**
  * @typedef UpdateProductBundleParam
  * @property {string} id - A `id` is a unique identifier for a particular
@@ -474,6 +471,8 @@ declare class CatalogPlatformValidator {
     static createSizeGuide(): CreateSizeGuideParam;
     /** @returns {DeleteBulkInventoryJobParam} */
     static deleteBulkInventoryJob(): DeleteBulkInventoryJobParam;
+    /** @returns {DeleteInventoryParam} */
+    static deleteInventory(): DeleteInventoryParam;
     /** @returns {DeleteProductParam} */
     static deleteProduct(): DeleteProductParam;
     /** @returns {DeleteProductBulkJobParam} */
@@ -518,8 +517,6 @@ declare class CatalogPlatformValidator {
     static getInventoryExport(): any;
     /** @returns {GetMarketplaceOptinDetailParam} */
     static getMarketplaceOptinDetail(): any;
-    /** @returns {GetMarketplacesParam} */
-    static getMarketplaces(): any;
     /** @returns {GetOptimalLocationsParam} */
     static getOptimalLocations(): GetOptimalLocationsParam;
     /** @returns {GetProductParam} */
@@ -580,8 +577,6 @@ declare class CatalogPlatformValidator {
     static updateHsnCode(): UpdateHsnCodeParam;
     /** @returns {UpdateInventoriesParam} */
     static updateInventories(): UpdateInventoriesParam;
-    /** @returns {UpdateMarketplaceOptinParam} */
-    static updateMarketplaceOptin(): UpdateMarketplaceOptinParam;
     /** @returns {UpdateProductBundleParam} */
     static updateProductBundle(): UpdateProductBundleParam;
     /** @returns {UpdateRealtimeInventoryParam} */
@@ -596,7 +591,7 @@ declare class CatalogPlatformValidator {
     static validateProductTemplateSchema(): ValidateProductTemplateSchemaParam;
 }
 declare namespace CatalogPlatformValidator {
-    export { AddInventoryParam, AllSizesParam, BulkHsnCodeParam, CreateBulkInventoryParam, CreateBulkInventoryJobParam, CreateBulkProductUploadJobParam, CreateCategoriesParam, CreateDepartmentsParam, CreateInventoryExportParam, CreateInventoryExportJobParam, CreateMarketplaceOptinParam, CreateProductParam, CreateProductAssetsInBulkParam, CreateProductBundleParam, CreateProductExportJobParam, CreateProductsInBulkParam, CreateSizeGuideParam, DeleteBulkInventoryJobParam, DeleteProductParam, DeleteProductBulkJobParam, DeleteRealtimeInventoryParam, DeleteSizeParam, DownloadInventoryTemplateViewParam, DownloadProductTemplateViewsParam, EditProductParam, ExportInventoryConfigParam, GetAllProductHsnCodesParam, GetCategoryDataParam, GetCompanyBrandDetailParam, GetCompanyDetailParam, GetCompanyMetricsParam, GetDepartmentDataParam, GetGenderAttributeParam, GetHsnCodeParam, GetInventoriesParam, GetInventoryBulkUploadHistoryParam, GetInventoryBySizeParam, GetInventoryBySizeIdentifierParam, GetInventoryExportParam, GetMarketplaceOptinDetailParam, GetMarketplacesParam, GetOptimalLocationsParam, GetProductParam, GetProductAssetsInBulkParam, GetProductAttributesParam, GetProductBulkUploadHistoryParam, GetProductBundleParam, GetProductBundleDetailParam, GetProductExportJobsParam, GetProductSizeParam, GetProductTagsParam, GetProductValidationParam, GetProductsParam, GetSellerInsightsParam, GetSingleProductHSNCodeParam, GetSizeGuideParam, GetSizeGuidesParam, GetStoreDetailParam, GetVariantsOfProductsParam, ListCategoriesParam, ListDepartmentsDataParam, ListHSNCodesParam, ListInventoryExportParam, ListProductTemplateParam, ListProductTemplateCategoriesParam, ListProductTemplateExportDetailsParam, ListTemplateBrandTypeValuesParam, UpdateCategoryParam, UpdateDepartmentParam, UpdateHsnCodeParam, UpdateInventoriesParam, UpdateMarketplaceOptinParam, UpdateProductBundleParam, UpdateRealtimeInventoryParam, UpdateSizeGuideParam, UploadBulkProductsParam, ValidateProductTemplateParam, ValidateProductTemplateSchemaParam };
+    export { AddInventoryParam, AllSizesParam, BulkHsnCodeParam, CreateBulkInventoryParam, CreateBulkInventoryJobParam, CreateBulkProductUploadJobParam, CreateCategoriesParam, CreateDepartmentsParam, CreateInventoryExportParam, CreateInventoryExportJobParam, CreateMarketplaceOptinParam, CreateProductParam, CreateProductAssetsInBulkParam, CreateProductBundleParam, CreateProductExportJobParam, CreateProductsInBulkParam, CreateSizeGuideParam, DeleteBulkInventoryJobParam, DeleteInventoryParam, DeleteProductParam, DeleteProductBulkJobParam, DeleteRealtimeInventoryParam, DeleteSizeParam, DownloadInventoryTemplateViewParam, DownloadProductTemplateViewsParam, EditProductParam, ExportInventoryConfigParam, GetAllProductHsnCodesParam, GetCategoryDataParam, GetCompanyBrandDetailParam, GetCompanyDetailParam, GetCompanyMetricsParam, GetDepartmentDataParam, GetGenderAttributeParam, GetHsnCodeParam, GetInventoriesParam, GetInventoryBulkUploadHistoryParam, GetInventoryBySizeParam, GetInventoryBySizeIdentifierParam, GetInventoryExportParam, GetMarketplaceOptinDetailParam, GetOptimalLocationsParam, GetProductParam, GetProductAssetsInBulkParam, GetProductAttributesParam, GetProductBulkUploadHistoryParam, GetProductBundleParam, GetProductBundleDetailParam, GetProductExportJobsParam, GetProductSizeParam, GetProductTagsParam, GetProductValidationParam, GetProductsParam, GetSellerInsightsParam, GetSingleProductHSNCodeParam, GetSizeGuideParam, GetSizeGuidesParam, GetStoreDetailParam, GetVariantsOfProductsParam, ListCategoriesParam, ListDepartmentsDataParam, ListHSNCodesParam, ListInventoryExportParam, ListProductTemplateParam, ListProductTemplateCategoriesParam, ListProductTemplateExportDetailsParam, ListTemplateBrandTypeValuesParam, UpdateCategoryParam, UpdateDepartmentParam, UpdateHsnCodeParam, UpdateInventoriesParam, UpdateProductBundleParam, UpdateRealtimeInventoryParam, UpdateSizeGuideParam, UploadBulkProductsParam, ValidateProductTemplateParam, ValidateProductTemplateSchemaParam };
 }
 type AddInventoryParam = {
     /**
@@ -679,6 +674,21 @@ type DeleteBulkInventoryJobParam = {
      */
     batchId: string;
 };
+type DeleteInventoryParam = {
+    /**
+     * - Size that is to be deleted.
+     */
+    size: string;
+    /**
+     * - Id of the product associated with Inventory to be deleted.
+     */
+    itemId: number;
+    /**
+     * - Location ID of store of which inventory is to
+     * be deleted.
+     */
+    locationId: number;
+};
 type DeleteProductParam = {
     /**
      * - Id of the product to be updated.
@@ -1116,10 +1126,6 @@ type GetSizeGuidesParam = {
      * Default is 10.
      */
     pageSize?: number;
-    /**
-     * - Brand id that is to be searched.
-     */
-    brandId?: number;
 };
 type GetStoreDetailParam = {
     /**
@@ -1164,7 +1170,7 @@ type ListCategoriesParam = {
     /**
      * - Get category for multiple departments filtered
      */
-    department?: number;
+    departments?: string;
     /**
      * - Get multiple categories filtered by search string
      */
@@ -1179,14 +1185,6 @@ type ListCategoriesParam = {
      * Default is 10.
      */
     pageSize?: number;
-    /**
-     * - Get multiple categories filtered by category uids.
-     */
-    uids?: number[];
-    /**
-     * - Get category by slug
-     */
-    slug?: string;
 };
 type ListDepartmentsDataParam = {
     /**
@@ -1218,10 +1216,6 @@ type ListDepartmentsDataParam = {
      * they are active or inactive.
      */
     isActive?: boolean;
-    /**
-     * - Can filter by slug
-     */
-    slug?: string;
 };
 type ListInventoryExportParam = {
     /**
@@ -1301,13 +1295,6 @@ type UpdateHsnCodeParam = {
 type UpdateInventoriesParam = {
     body: CatalogPlatformModel.InventoryRequestSchemaV2;
 };
-type UpdateMarketplaceOptinParam = {
-    /**
-     * - Slug of the marketplace .
-     */
-    marketplaceSlug: string;
-    body: CatalogPlatformModel.UpdateMarketplaceOptinRequest;
-};
 type UpdateProductBundleParam = {
     /**
      * - A `id` is a unique identifier for a particular
@@ -1376,7 +1363,6 @@ type GetCompanyDetailParam = any;
 type GetCompanyMetricsParam = any;
 type GetInventoryExportParam = any;
 type GetMarketplaceOptinDetailParam = any;
-type GetMarketplacesParam = any;
 type GetProductTagsParam = any;
 type GetProductValidationParam = any;
 type ListHSNCodesParam = any;

package/sdk/platform/Catalog/CatalogPlatformValidator.js

@@ -98,6 +98,14 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
  * @property {string} batchId - Batch Id of the bulk delete job.
  */
 
+/**
+ * @typedef DeleteInventoryParam
+ * @property {string} size - Size that is to be deleted.
+ * @property {number} itemId - Id of the product associated with Inventory to be deleted.
+ * @property {number} locationId - Location ID of store of which inventory is to
+ *   be deleted.
+ */
+
 /**
  * @typedef DeleteProductParam
  * @property {number} itemId - Id of the product to be updated.
@@ -243,8 +251,6 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
 
 /** @typedef GetMarketplaceOptinDetailParam */
 
-/** @typedef GetMarketplacesParam */
-
 /**
  * @typedef GetOptimalLocationsParam
  * @property {CatalogPlatformModel.AssignStore} body
@@ -357,7 +363,6 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
  *   set of results
  * @property {number} [pageSize] - Number of items to retrieve in each page.
  *   Default is 10.
- * @property {number} [brandId] - Brand id that is to be searched.
  */
 
 /**
@@ -381,14 +386,12 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
 /**
  * @typedef ListCategoriesParam
  * @property {string} [level] - Get category for multiple levels
- * @property {number} [department] - Get category for multiple departments filtered
+ * @property {string} [departments] - Get category for multiple departments filtered
  * @property {string} [q] - Get multiple categories filtered by search string
  * @property {number} [pageNo] - The page number to navigate through the given
  *   set of results
  * @property {number} [pageSize] - Number of items to retrieve in each page.
  *   Default is 10.
- * @property {number[]} [uids] - Get multiple categories filtered by category uids.
- * @property {string} [slug] - Get category by slug
  */
 
 /**
@@ -404,7 +407,6 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
  *   department in search parameter.
  * @property {boolean} [isActive] - Can query for departments based on whether
  *   they are active or inactive.
- * @property {string} [slug] - Can filter by slug
  */
 
 /** @typedef ListHSNCodesParam */
@@ -466,12 +468,6 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
  * @property {CatalogPlatformModel.InventoryRequestSchemaV2} body
  */
 
-/**
- * @typedef UpdateMarketplaceOptinParam
- * @property {string} marketplaceSlug - Slug of the marketplace .
- * @property {CatalogPlatformModel.UpdateMarketplaceOptinRequest} body
- */
-
 /**
  * @typedef UpdateProductBundleParam
  * @property {string} id - A `id` is a unique identifier for a particular
@@ -650,6 +646,15 @@ class CatalogPlatformValidator {
     }).required();
   }
 
+  /** @returns {DeleteInventoryParam} */
+  static deleteInventory() {
+    return Joi.object({
+      size: Joi.string().allow("").required(),
+      itemId: Joi.number().required(),
+      locationId: Joi.number().required(),
+    }).required();
+  }
+
   /** @returns {DeleteProductParam} */
   static deleteProduct() {
     return Joi.object({
@@ -827,11 +832,6 @@ class CatalogPlatformValidator {
     return Joi.object({}).required();
   }
 
-  /** @returns {GetMarketplacesParam} */
-  static getMarketplaces() {
-    return Joi.object({}).required();
-  }
-
   /** @returns {GetOptimalLocationsParam} */
   static getOptimalLocations() {
     return Joi.object({
@@ -962,7 +962,6 @@ class CatalogPlatformValidator {
       tag: Joi.string().allow(""),
       pageNo: Joi.number(),
       pageSize: Joi.number(),
-      brandId: Joi.number(),
     }).required();
   }
 
@@ -989,12 +988,10 @@ class CatalogPlatformValidator {
   static listCategories() {
     return Joi.object({
       level: Joi.string().allow(""),
-      department: Joi.number(),
+      departments: Joi.string().allow(""),
       q: Joi.string().allow(""),
       pageNo: Joi.number(),
       pageSize: Joi.number(),
-      uids: Joi.array().items(Joi.number()),
-      slug: Joi.string().allow(""),
     }).required();
   }
 
@@ -1007,7 +1004,6 @@ class CatalogPlatformValidator {
       name: Joi.string().allow(""),
       search: Joi.string().allow(""),
       isActive: Joi.boolean(),
-      slug: Joi.string().allow(""),
     }).required();
   }
 
@@ -1086,14 +1082,6 @@ class CatalogPlatformValidator {
     }).required();
   }
 
-  /** @returns {UpdateMarketplaceOptinParam} */
-  static updateMarketplaceOptin() {
-    return Joi.object({
-      marketplaceSlug: Joi.string().allow("").required(),
-      body: CatalogPlatformModel.UpdateMarketplaceOptinRequest().required(),
-    }).required();
-  }
-
   /** @returns {UpdateProductBundleParam} */
   static updateProductBundle() {
     return Joi.object({