@gofynd/fdk-client-javascript 2.0.2 → 3.0.0

package/sdk/platform/Catalog/CatalogPlatformModel.js

@@ -9,7 +9,7 @@ const Joi = require("joi");
 
 /**
  * @typedef ValidationErrors
- * @property {ValidationError[]} errors
+ * @property {ValidationError[]} errors - A list of validation errors in the request.
  */
 
 /**
@@ -1253,15 +1253,6 @@ const Joi = require("joi");
  * @property {number[]} category_ids - List of category_ids to be deleted.
  */
 
-/**
- * @typedef DeleteProductRequestBody
- * @property {number} [brand_uid] - The brand identifier for the product.
- * @property {string} [item_code] - The code of the item to be deleted.
- * @property {string} [company_id] - The ID of the company. (Optional if already
- *   provided in the path)
- * @property {number} [item_id] - The ID of the product.
- */
-
 /**
  * @typedef DeleteResponseSchema
  * @property {string} [message]
@@ -3235,7 +3226,7 @@ const Joi = require("joi");
  */
 
 /**
- * @typedef ProductCreateUpdateSchemaV2
+ * @typedef ProductUpdateSchemaV2
  * @property {Object} [_custom_json] - Custom JSON data that can be used for
  *   additional product properties.
  * @property {string} [action] - The action to perform wrt to the product (e.g.,
@@ -3292,6 +3283,63 @@ const Joi = require("joi");
  * @property {Object} [variants] - Variants information for the product.
  */
 
+/**
+ * @typedef ProductCreateSchemaV2
+ * @property {Object} [_custom_json] - Custom JSON data that can be used for
+ *   additional product properties.
+ * @property {string} [action] - The action to perform wrt to the product (e.g.,
+ *   upsert, update, delete).
+ * @property {Object} [attributes] - Additional attributes related to the product.
+ * @property {number} brand_uid - Unique identifier for the product's brand.
+ * @property {string} [bulk_job_id] - Job ID associated with bulk operations.
+ * @property {string} category_slug - The category to which the product belongs.
+ * @property {string} [change_request_id] - Change request identifier for product updates.
+ * @property {number} company_id - Unique identifier for the company associated
+ *   with the product.
+ * @property {string} country_of_origin - The country where the product was
+ *   manufactured or sourced.
+ * @property {string} currency - The currency in which the product's price is listed.
+ * @property {CustomOrder} [custom_order]
+ * @property {number[]} departments - List of department IDs associated with the product.
+ * @property {string} [description] - A detailed description of the product.
+ * @property {string[]} [highlights] - Product highlights or key features.
+ * @property {boolean} [is_active] - Flag to indicate if the product is active.
+ * @property {boolean} [is_dependent] - Flag to indicate if the product is
+ *   dependent on other products.
+ * @property {boolean} [is_image_less_product] - Flag to indicate if the product
+ *   does not have associated images.
+ * @property {boolean} [is_set] - Flag to indicate if the product is part of a set.
+ * @property {string} item_code - Unique item code or SKU of the product.
+ * @property {string} item_type - Type of the product (e.g., standard, set,
+ *   composite, digital).
+ * @property {Media[]} [media] - List of media URLs (images, videos) associated
+ *   with the product.
+ * @property {boolean} [multi_size] - Indicates if the product supports multiple sizes.
+ * @property {string} name - The name of the product.
+ * @property {NetQuantity} [net_quantity]
+ * @property {number} [no_of_boxes] - Number of boxes required to package the product.
+ * @property {string[]} [product_group_tag] - Tags to group products together
+ *   for classification.
+ * @property {ProductPublish} [product_publish]
+ * @property {string} [requester] - The role requesting the product operation
+ *   (admin or user).
+ * @property {ReturnConfig} return_config
+ * @property {string} [short_description] - A short description of the product,
+ *   up to 50 characters.
+ * @property {string} [size_guide] - Identifier for the product's size guide.
+ * @property {Object[]} sizes - List of sizes available for the product.
+ * @property {string} slug - URL-friendly identifier for the product.
+ * @property {string[]} [tags] - List of tags associated with the product.
+ * @property {TaxIdentifier} tax_identifier
+ * @property {TeaserTag} [teaser_tag]
+ * @property {string} template_tag - Template tag for the product, used for
+ *   classification.
+ * @property {Trader[]} trader - List of traders associated with the product.
+ * @property {Object} [variant_group] - Variant group information for the product.
+ * @property {Object} [variant_media] - Media related to product variants.
+ * @property {Object} [variants] - Variants information for the product.
+ */
+
 /**
  * @typedef ProductDetail
  * @property {Object} [attributes] - Key-value pairs representing various
@@ -6105,16 +6153,6 @@ class CatalogPlatformModel {
     });
   }
 
-  /** @returns {DeleteProductRequestBody} */
-  static DeleteProductRequestBody() {
-    return Joi.object({
-      brand_uid: Joi.number(),
-      item_code: Joi.string().allow(""),
-      company_id: Joi.string().allow(""),
-      item_id: Joi.number(),
-    });
-  }
-
   /** @returns {DeleteResponseSchema} */
   static DeleteResponseSchema() {
     return Joi.object({
@@ -8224,8 +8262,8 @@ class CatalogPlatformModel {
     });
   }
 
-  /** @returns {ProductCreateUpdateSchemaV2} */
-  static ProductCreateUpdateSchemaV2() {
+  /** @returns {ProductUpdateSchemaV2} */
+  static ProductUpdateSchemaV2() {
     return Joi.object({
       _custom_json: Joi.object().pattern(/\S/, Joi.any()),
       action: Joi.string().allow(""),
@@ -8274,6 +8312,55 @@ class CatalogPlatformModel {
     });
   }
 
+  /** @returns {ProductCreateSchemaV2} */
+  static ProductCreateSchemaV2() {
+    return Joi.object({
+      _custom_json: Joi.object().pattern(/\S/, Joi.any()),
+      action: Joi.string().allow(""),
+      attributes: Joi.object().pattern(/\S/, Joi.any()),
+      brand_uid: Joi.number().required(),
+      bulk_job_id: Joi.string().allow(""),
+      category_slug: Joi.string().allow("").required(),
+      change_request_id: Joi.string().allow("").allow(null),
+      company_id: Joi.number().required(),
+      country_of_origin: Joi.string().allow("").required(),
+      currency: Joi.string().allow("").required(),
+      custom_order: CatalogPlatformModel.CustomOrder(),
+      departments: Joi.array().items(Joi.number()).required(),
+      description: Joi.string().allow(""),
+      highlights: Joi.array().items(Joi.string().allow("")).allow(null, ""),
+      is_active: Joi.boolean(),
+      is_dependent: Joi.boolean(),
+      is_image_less_product: Joi.boolean(),
+      is_set: Joi.boolean(),
+      item_code: Joi.string().allow("").required(),
+      item_type: Joi.string().allow("").required(),
+      media: Joi.array().items(CatalogPlatformModel.Media()).allow(null, ""),
+      multi_size: Joi.boolean(),
+      name: Joi.string().allow("").required(),
+      net_quantity: CatalogPlatformModel.NetQuantity(),
+      no_of_boxes: Joi.number(),
+      product_group_tag: Joi.array().items(Joi.string().allow("")),
+      product_publish: CatalogPlatformModel.ProductPublish(),
+      requester: Joi.string().allow(""),
+      return_config: CatalogPlatformModel.ReturnConfig().required(),
+      short_description: Joi.string().allow(""),
+      size_guide: Joi.string().allow(""),
+      sizes: Joi.array()
+        .items(Joi.object().pattern(/\S/, Joi.any()))
+        .required(),
+      slug: Joi.string().allow("").required(),
+      tags: Joi.array().items(Joi.string().allow("")),
+      tax_identifier: CatalogPlatformModel.TaxIdentifier().required(),
+      teaser_tag: CatalogPlatformModel.TeaserTag(),
+      template_tag: Joi.string().allow("").required(),
+      trader: Joi.array().items(CatalogPlatformModel.Trader()).required(),
+      variant_group: Joi.object().pattern(/\S/, Joi.any()),
+      variant_media: Joi.object().pattern(/\S/, Joi.any()),
+      variants: Joi.object().pattern(/\S/, Joi.any()),
+    });
+  }
+
   /** @returns {ProductDetail} */
   static ProductDetail() {
     return Joi.object({

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

@@ -42,7 +42,7 @@ export = CatalogPlatformValidator;
  */
 /**
  * @typedef CreateProductParam
- * @property {CatalogPlatformModel.ProductCreateUpdateSchemaV2} body
+ * @property {CatalogPlatformModel.ProductCreateSchemaV2} body
  */
 /**
  * @typedef CreateProductAssetsInBulkParam
@@ -72,7 +72,6 @@ export = CatalogPlatformValidator;
 /**
  * @typedef DeleteProductParam
  * @property {number} itemId - Id of the product to be deleted.
- * @property {CatalogPlatformModel.DeleteProductRequestBody} body
  */
 /**
  * @typedef DeleteProductBulkJobParam
@@ -104,7 +103,7 @@ export = CatalogPlatformValidator;
 /**
  * @typedef EditProductParam
  * @property {number} itemId - Id of the product to be updated.
- * @property {CatalogPlatformModel.ProductCreateUpdateSchemaV2} body
+ * @property {CatalogPlatformModel.ProductUpdateSchemaV2} body
  */
 /**
  * @typedef ExportInventoryConfigParam
@@ -450,7 +449,7 @@ export = CatalogPlatformValidator;
  */
 /**
  * @typedef UpdateSizeGuideParam
- * @property {string} id - Mongo id of the size guide to be edited
+ * @property {string} id - Identifier of the size guide to be edited
  * @property {CatalogPlatformModel.ValidateSizeGuide} body
  */
 /**
@@ -691,7 +690,7 @@ type CreateMarketplaceOptinParam = {
     body: CatalogPlatformModel.OptInPostRequestSchema;
 };
 type CreateProductParam = {
-    body: CatalogPlatformModel.ProductCreateUpdateSchemaV2;
+    body: CatalogPlatformModel.ProductCreateSchemaV2;
 };
 type CreateProductAssetsInBulkParam = {
     body: CatalogPlatformModel.ProductBulkAssets;
@@ -723,7 +722,6 @@ type DeleteProductParam = {
      * - Id of the product to be deleted.
      */
     itemId: number;
-    body: CatalogPlatformModel.DeleteProductRequestBody;
 };
 type DeleteProductBulkJobParam = {
     /**
@@ -779,7 +777,7 @@ type EditProductParam = {
      * - Id of the product to be updated.
      */
     itemId: number;
-    body: CatalogPlatformModel.ProductCreateUpdateSchemaV2;
+    body: CatalogPlatformModel.ProductUpdateSchemaV2;
 };
 type ExportInventoryConfigParam = {
     /**
@@ -1487,7 +1485,7 @@ type UpdateRealtimeInventoryParam = {
 };
 type UpdateSizeGuideParam = {
     /**
-     * - Mongo id of the size guide to be edited
+     * - Identifier of the size guide to be edited
      */
     id: string;
     body: CatalogPlatformModel.ValidateSizeGuide;

package/sdk/platform/Catalog/CatalogPlatformValidator.js

@@ -54,7 +54,7 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
 
 /**
  * @typedef CreateProductParam
- * @property {CatalogPlatformModel.ProductCreateUpdateSchemaV2} body
+ * @property {CatalogPlatformModel.ProductCreateSchemaV2} body
  */
 
 /**
@@ -91,7 +91,6 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
 /**
  * @typedef DeleteProductParam
  * @property {number} itemId - Id of the product to be deleted.
- * @property {CatalogPlatformModel.DeleteProductRequestBody} body
  */
 
 /**
@@ -129,7 +128,7 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
 /**
  * @typedef EditProductParam
  * @property {number} itemId - Id of the product to be updated.
- * @property {CatalogPlatformModel.ProductCreateUpdateSchemaV2} body
+ * @property {CatalogPlatformModel.ProductUpdateSchemaV2} body
  */
 
 /**
@@ -525,7 +524,7 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
 
 /**
  * @typedef UpdateSizeGuideParam
- * @property {string} id - Mongo id of the size guide to be edited
+ * @property {string} id - Identifier of the size guide to be edited
  * @property {CatalogPlatformModel.ValidateSizeGuide} body
  */
 
@@ -635,7 +634,7 @@ class CatalogPlatformValidator {
   /** @returns {CreateProductParam} */
   static createProduct() {
     return Joi.object({
-      body: CatalogPlatformModel.ProductCreateUpdateSchemaV2().required(),
+      body: CatalogPlatformModel.ProductCreateSchemaV2().required(),
     }).required();
   }
 
@@ -686,7 +685,6 @@ class CatalogPlatformValidator {
   static deleteProduct() {
     return Joi.object({
       itemId: Joi.number().required(),
-      body: CatalogPlatformModel.DeleteProductRequestBody().required(),
     }).required();
   }
 
@@ -734,7 +732,7 @@ class CatalogPlatformValidator {
   static editProduct() {
     return Joi.object({
       itemId: Joi.number().required(),
-      body: CatalogPlatformModel.ProductCreateUpdateSchemaV2().required(),
+      body: CatalogPlatformModel.ProductUpdateSchemaV2().required(),
     }).required();
   }
 

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

@@ -2,8 +2,8 @@ export = CommonPlatformModel;
 /**
  * @typedef ApplicationResponseSchema
  * @property {Application} [application]
- * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
- *   of the current sales channel supported currency
+ * @property {string} [_id] - The unique identifier of the current sales channel
+ *   supported currency
  * @property {boolean} [is_active] - Shows currency is enabled or not in current
  *   sales channel
  * @property {string} [name] - Name of the currency, e.g. Indian Rupee
@@ -24,8 +24,7 @@ export = CommonPlatformModel;
  * @property {boolean} [is_primary] - Indicates domain is primary or not.
  *   Primary domain is the default/main domain.
  * @property {boolean} [is_shortlink] - Shortlink is present or not for the domain
- * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
- *   of the domain
+ * @property {string} [_id] - The unique identifier of the domain
  * @property {string} [name]
  * @property {boolean} [is_predefined] - Domain is hosting domain or not
  */
@@ -76,11 +75,9 @@ export = CommonPlatformModel;
  *   internal or not
  * @property {boolean} [is_active] - Indicates whether a sales channel is active
  *   or not active
- * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
- *   of the sales channel
+ * @property {string} [_id] - The unique identifier of the sales channel
  * @property {string} [name] - Name of the sales channel, e.g. Zenz Fashion
- * @property {string} [owner] - The unique identifier (24-digit Mongo Object ID)
- *   of owner who owns the application
+ * @property {string} [owner] - The unique identifier of owner who owns the application
  * @property {number} [company_id] - Numeric ID allotted to a business account
  *   where the sales channel exists
  * @property {string} [token] - Randomly generated fixed-length string for sales
@@ -152,8 +149,8 @@ declare function ApplicationResponseSchema(): ApplicationResponseSchema;
 type ApplicationResponseSchema = {
     application?: Application;
     /**
-     * - The unique identifier (24-digit Mongo Object ID)
-     * of the current sales channel supported currency
+     * - The unique identifier of the current sales channel
+     * supported currency
      */
     _id?: string;
     /**
@@ -208,8 +205,7 @@ type Domain = {
      */
     is_shortlink?: boolean;
     /**
-     * - The unique identifier (24-digit Mongo Object ID)
-     * of the domain
+     * - The unique identifier of the domain
      */
     _id?: string;
     name?: string;
@@ -315,8 +311,7 @@ type Application = {
      */
     is_active?: boolean;
     /**
-     * - The unique identifier (24-digit Mongo Object ID)
-     * of the sales channel
+     * - The unique identifier of the sales channel
      */
     _id?: string;
     /**
@@ -324,8 +319,7 @@ type Application = {
      */
     name?: string;
     /**
-     * - The unique identifier (24-digit Mongo Object ID)
-     * of owner who owns the application
+     * - The unique identifier of owner who owns the application
      */
     owner?: string;
     /**

package/sdk/platform/Common/CommonPlatformModel.js

@@ -3,8 +3,8 @@ const Joi = require("joi");
 /**
  * @typedef ApplicationResponseSchema
  * @property {Application} [application]
- * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
- *   of the current sales channel supported currency
+ * @property {string} [_id] - The unique identifier of the current sales channel
+ *   supported currency
  * @property {boolean} [is_active] - Shows currency is enabled or not in current
  *   sales channel
  * @property {string} [name] - Name of the currency, e.g. Indian Rupee
@@ -26,8 +26,7 @@ const Joi = require("joi");
  * @property {boolean} [is_primary] - Indicates domain is primary or not.
  *   Primary domain is the default/main domain.
  * @property {boolean} [is_shortlink] - Shortlink is present or not for the domain
- * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
- *   of the domain
+ * @property {string} [_id] - The unique identifier of the domain
  * @property {string} [name]
  * @property {boolean} [is_predefined] - Domain is hosting domain or not
  */
@@ -85,11 +84,9 @@ const Joi = require("joi");
  *   internal or not
  * @property {boolean} [is_active] - Indicates whether a sales channel is active
  *   or not active
- * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
- *   of the sales channel
+ * @property {string} [_id] - The unique identifier of the sales channel
  * @property {string} [name] - Name of the sales channel, e.g. Zenz Fashion
- * @property {string} [owner] - The unique identifier (24-digit Mongo Object ID)
- *   of owner who owns the application
+ * @property {string} [owner] - The unique identifier of owner who owns the application
  * @property {number} [company_id] - Numeric ID allotted to a business account
  *   where the sales channel exists
  * @property {string} [token] - Randomly generated fixed-length string for sales

package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts

@@ -76,7 +76,7 @@ export = ConfigurationPlatformApplicationValidator;
  */
 /**
  * @typedef RemoveDomainByIdParam
- * @property {string} id - The unique identifier (24-digit Mongo Object ID) of the domain
+ * @property {string} id - The unique identifier of the domain
  */
 /** @typedef RemoveOrderingStoreCookieParam */
 /**
@@ -273,7 +273,7 @@ type PartiallyUpdateInventoryConfigParam = {
 };
 type RemoveDomainByIdParam = {
     /**
-     * - The unique identifier (24-digit Mongo Object ID) of the domain
+     * - The unique identifier of the domain
      */
     id: string;
 };

package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js

@@ -101,7 +101,7 @@ const ConfigurationPlatformModel = require("./ConfigurationPlatformModel");
 
 /**
  * @typedef RemoveDomainByIdParam
- * @property {string} id - The unique identifier (24-digit Mongo Object ID) of the domain
+ * @property {string} id - The unique identifier of the domain
  */
 
 /** @typedef RemoveOrderingStoreCookieParam */