@gofynd/fdk-client-javascript 1.4.15-beta.2 → 1.4.15

package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js

@@ -20,6 +20,16 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
 
 /**
  * @typedef CreateCollectionParam
+ * @property {string} [q] - Get collection list filtered by q string,
+ * @property {string} [scheduleStatus] - Get collection list filtered by scheduled status,
+ * @property {string} [type] - Type of the collections
+ * @property {string[]} [tags] - Each response will contain next_id param, which
+ *   should be sent back to make pagination work.
+ * @property {boolean} [isActive] - Get collections filtered by active status.
+ * @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 12.
  * @property {CatalogPlatformModel.CreateCollection} body
  */
 
@@ -60,7 +70,7 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
 
 /**
  * @typedef CreateSearchConfigurationParam
- * @property {CatalogPlatformModel.CreateSearchConfigurationRequest} body
+ * @property {CatalogPlatformModel.CreateSearchConfigurationRequestSchema} body
  */
 
 /**
@@ -188,35 +198,6 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
 
 /** @typedef GetAppReturnConfigurationParam */
 
-/**
- * @typedef GetAppicationProductsParam
- * @property {string} [q] - The search query. This can be a partial or complete
- *   name of a either a product, brand or category
- * @property {string} [f] - The search filter parameters. All the parameter
- *   filtered from filter parameters will be passed in **f** parameter in this
- *   format. **?f=brand:voi-jeans||and:::category:t-shirts||shirts**
- * @property {string} [c] - The search filter parameters for collection items.
- *   All the parameter filtered from filter parameters will be passed in **c**
- *   parameter in this format.
- *   **?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts**
- * @property {boolean} [filters] - Pass `filters` parameter to fetch the filter
- *   details. This flag is used to fetch all filters
- * @property {boolean} [isDependent] - This query parameter is used to get the
- *   dependent products in the listing.
- * @property {string} [sortOn] - The order to sort the list of products on. The
- *   supported sort parameters are popularity, price, redemption and discount in
- *   either ascending or descending order. See the supported values below.
- * @property {string} [pageId] - Each response will contain **page_id** param,
- *   which should be sent back to make pagination work.
- * @property {number} [pageSize] - Number of items to retrieve in each page.
- *   Default is 12.
- * @property {number} [pageNo] - If page_type is number then pass it to fetch
- *   page items. Default is 1.
- * @property {string} [pageType] - For pagination type should be cursor or
- *   number. Default is cursor.
- * @property {number[]} [itemIds] - Item Ids of product
- */
-
 /**
  * @typedef GetApplicationBrandListingParam
  * @property {number} [pageNo] - The page number to navigate through the given
@@ -268,26 +249,56 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
 /**
  * @typedef GetApplicationFilterKeysParam
  * @property {string} [c] - The search filter parameters for collection items.
- *   All the parameter filtered from filter parameters will be passed in **c**
- *   parameter in this format.
- *   **?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts**
+ *   All the parameter filtered from filter parameters will be passed in "c"
+ *   parameter in this format. "?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts"
  */
 
 /**
  * @typedef GetApplicationFilterValuesParam
- * @property {string} filterKey - A `filter_key` is a filter key for a for which
- *   all the available filter values will returned. channel.
+ * @property {string} filterKey - A `filter_key` is a filter key which returns
+ *   all the available filter values.
  * @property {string} [c] - The search filter parameters for collection items.
- *   All the parameter filtered from filter parameters will be passed in **c**
- *   parameter in this format.
- *   **?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts**
+ *   All the parameter filtered from filter parameters will be passed in "c"
+ *   parameter in this format. "?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts"
  * @property {string} [collectionId] - A `collection_id` is a unique identifier
- *   for a particular collection. channel.
+ *   for a particular collection.
  * @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 {string} [q] - Get Values filtered by q string
+ * @property {string} [q] - The `q` parameter allows you to search and filter
+ *   specific data within the filter options. It acts as a query keyword that
+ *   can refine the results by matching relevant filter values, such as a
+ *   category name or any other applicable filter criteria.
+ */
+
+/**
+ * @typedef GetApplicationProductsParam
+ * @property {string} [q] - The search query. This can be a partial or complete
+ *   name of a either a product, brand or category
+ * @property {string} [f] - The search filter parameters. All the parameter
+ *   filtered from filter parameters will be passed in **f** parameter in this
+ *   format. **?f=brand:voi-jeans||and:::category:t-shirts||shirts**
+ * @property {string} [c] - The search filter parameters for collection items.
+ *   All the parameter filtered from filter parameters will be passed in **c**
+ *   parameter in this format.
+ *   **?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts**
+ * @property {boolean} [filters] - Pass `filters` parameter to fetch the filter
+ *   details. This flag is used to fetch all filters
+ * @property {boolean} [isDependent] - This query parameter is used to get the
+ *   dependent products in the listing.
+ * @property {string} [sortOn] - The order to sort the list of products on. The
+ *   supported sort parameters are popularity, price, redemption and discount in
+ *   either ascending or descending order. See the supported values below.
+ * @property {string} [pageId] - Each response will contain **page_id** param,
+ *   which should be sent back to make pagination work.
+ * @property {number} [pageSize] - Number of items to retrieve in each page.
+ *   Default is 12.
+ * @property {number} [pageNo] - If page_type is number then pass it to fetch
+ *   page items. Default is 1.
+ * @property {string} [pageType] - For pagination type should be cursor or
+ *   number. Default is cursor.
+ * @property {string[]} [itemIds] - Item Ids of product
  */
 
 /** @typedef GetAutocompleteConfigParam */
@@ -329,6 +340,7 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
  *   should be sent back to make pagination work.
  * @property {number} [pageSize] - Number of items to retrieve in each page.
  *   Default is 12.
+ * @property {number} [pageNo] - Identifies the specific page of results being requested.
  */
 
 /**
@@ -354,14 +366,13 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
 
 /**
  * @typedef GetDiscountedInventoryBySizeIdentifierParam
- * @property {number} itemId - Item code of the product of which size is to be get.
- * @property {string} sizeIdentifier - Size Identifier (Seller Identifier or
- *   Primary Identifier) of which inventory is to get.
+ * @property {number} itemId - A `item_id` is a unique identifier for a specific product.
+ * @property {number} sizeIdentifier - Size Identifier (Seller Identifier or
+ *   Primary Identifier).
  * @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 12.
- * @property {string} [q] - Search with help of store code.
  * @property {number[]} [locationIds] - Search by store ids.
  */
 
@@ -393,7 +404,7 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
  * @typedef GetProductDetailBySlugParam
  * @property {string} slug - The unique identifier of a product. i.e; `slug` of
  *   a product. You can retrieve these from the APIs that list products like
- *   **v1.0/products/**
+ *   "v1.0/products/"
  */
 
 /** @typedef GetQueryFiltersParam */
@@ -408,7 +419,7 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
 
 /**
  * @typedef UpdateAllowSingleParam
- * @property {CatalogPlatformModel.AllowSingleRequest} body
+ * @property {CatalogPlatformModel.AllowSingleRequestSchema} body
  */
 
 /**
@@ -432,20 +443,20 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
 
 /**
  * @typedef UpdateAppDepartmentParam
- * @property {string} departmentUid - Department id for which the custom_json is
- *   associated.
+ * @property {number} departmentUid - A `department id` is a unique identifier
+ *   for a particular department.
  * @property {CatalogPlatformModel.ApplicationDepartmentJson} body
  */
 
 /**
  * @typedef UpdateAppLocationParam
- * @property {string} storeUid - Store id for which the custom_json is associated.
+ * @property {number} storeUid - Store id for which the custom_json is associated.
  * @property {CatalogPlatformModel.ApplicationStoreJson} body
  */
 
 /**
  * @typedef UpdateAppProductParam
- * @property {string} itemId - Product id for which the custom_meta is associated.
+ * @property {number} itemId - A `item_id` is a unique identifier for a particular item.
  * @property {CatalogPlatformModel.ApplicationItemMeta} body
  */
 
@@ -469,7 +480,7 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
 
 /**
  * @typedef UpdateDefaultSortParam
- * @property {CatalogPlatformModel.DefaultKeyRequest} body
+ * @property {CatalogPlatformModel.DefaultKeyRequestSchema} body
  */
 
 /**
@@ -492,7 +503,7 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
 
 /**
  * @typedef UpdateSearchConfigurationParam
- * @property {CatalogPlatformModel.UpdateSearchConfigurationRequest} body
+ * @property {CatalogPlatformModel.UpdateSearchConfigurationRequestSchema} body
  */
 
 /**
@@ -528,6 +539,13 @@ class CatalogPlatformApplicationValidator {
   /** @returns {CreateCollectionParam} */
   static createCollection() {
     return Joi.object({
+      q: Joi.string().allow(""),
+      scheduleStatus: Joi.string().allow(""),
+      type: Joi.string().allow(""),
+      tags: Joi.array().items(Joi.string().allow("")),
+      isActive: Joi.boolean(),
+      pageNo: Joi.number(),
+      pageSize: Joi.number(),
       body: CatalogPlatformModel.CreateCollection().required(),
     }).required();
   }
@@ -580,7 +598,7 @@ class CatalogPlatformApplicationValidator {
   /** @returns {CreateSearchConfigurationParam} */
   static createSearchConfiguration() {
     return Joi.object({
-      body: CatalogPlatformModel.CreateSearchConfigurationRequest().required(),
+      body: CatalogPlatformModel.CreateSearchConfigurationRequestSchema().required(),
     }).required();
   }
 
@@ -718,23 +736,6 @@ class CatalogPlatformApplicationValidator {
     return Joi.object({}).required();
   }
 
-  /** @returns {GetAppicationProductsParam} */
-  static getAppicationProducts() {
-    return Joi.object({
-      q: Joi.string().allow(""),
-      f: Joi.string().allow(""),
-      c: Joi.string().allow(""),
-      filters: Joi.boolean(),
-      isDependent: Joi.boolean(),
-      sortOn: Joi.string().allow(""),
-      pageId: Joi.string().allow(""),
-      pageSize: Joi.number(),
-      pageNo: Joi.number(),
-      pageType: Joi.string().allow(""),
-      itemIds: Joi.array().items(Joi.number()),
-    }).required();
-  }
-
   /** @returns {GetApplicationBrandListingParam} */
   static getApplicationBrandListing() {
     return Joi.object({
@@ -793,6 +794,23 @@ class CatalogPlatformApplicationValidator {
     }).required();
   }
 
+  /** @returns {GetApplicationProductsParam} */
+  static getApplicationProducts() {
+    return Joi.object({
+      q: Joi.string().allow(""),
+      f: Joi.string().allow(""),
+      c: Joi.string().allow(""),
+      filters: Joi.boolean(),
+      isDependent: Joi.boolean(),
+      sortOn: Joi.string().allow(""),
+      pageId: Joi.string().allow(""),
+      pageSize: Joi.number(),
+      pageNo: Joi.number(),
+      pageType: Joi.string().allow(""),
+      itemIds: Joi.array().items(Joi.string().allow("")),
+    }).required();
+  }
+
   /** @returns {GetAutocompleteConfigParam} */
   static getAutocompleteConfig() {
     return Joi.object({}).required();
@@ -838,6 +856,7 @@ class CatalogPlatformApplicationValidator {
       sortOn: Joi.string().allow(""),
       pageId: Joi.string().allow(""),
       pageSize: Joi.number(),
+      pageNo: Joi.number(),
     }).required();
   }
 
@@ -873,10 +892,9 @@ class CatalogPlatformApplicationValidator {
   static getDiscountedInventoryBySizeIdentifier() {
     return Joi.object({
       itemId: Joi.number().required(),
-      sizeIdentifier: Joi.string().allow("").required(),
+      sizeIdentifier: Joi.number().required(),
       pageNo: Joi.number(),
       pageSize: Joi.number(),
-      q: Joi.string().allow(""),
       locationIds: Joi.array().items(Joi.number()),
     }).required();
   }
@@ -929,7 +947,7 @@ class CatalogPlatformApplicationValidator {
   /** @returns {UpdateAllowSingleParam} */
   static updateAllowSingle() {
     return Joi.object({
-      body: CatalogPlatformModel.AllowSingleRequest().required(),
+      body: CatalogPlatformModel.AllowSingleRequestSchema().required(),
     }).required();
   }
 
@@ -959,7 +977,7 @@ class CatalogPlatformApplicationValidator {
   /** @returns {UpdateAppDepartmentParam} */
   static updateAppDepartment() {
     return Joi.object({
-      departmentUid: Joi.string().allow("").required(),
+      departmentUid: Joi.number().required(),
       body: CatalogPlatformModel.ApplicationDepartmentJson().required(),
     }).required();
   }
@@ -967,7 +985,7 @@ class CatalogPlatformApplicationValidator {
   /** @returns {UpdateAppLocationParam} */
   static updateAppLocation() {
     return Joi.object({
-      storeUid: Joi.string().allow("").required(),
+      storeUid: Joi.number().required(),
       body: CatalogPlatformModel.ApplicationStoreJson().required(),
     }).required();
   }
@@ -975,7 +993,7 @@ class CatalogPlatformApplicationValidator {
   /** @returns {UpdateAppProductParam} */
   static updateAppProduct() {
     return Joi.object({
-      itemId: Joi.string().allow("").required(),
+      itemId: Joi.number().required(),
       body: CatalogPlatformModel.ApplicationItemMeta().required(),
     }).required();
   }
@@ -1006,7 +1024,7 @@ class CatalogPlatformApplicationValidator {
   /** @returns {UpdateDefaultSortParam} */
   static updateDefaultSort() {
     return Joi.object({
-      body: CatalogPlatformModel.DefaultKeyRequest().required(),
+      body: CatalogPlatformModel.DefaultKeyRequestSchema().required(),
     }).required();
   }
 
@@ -1031,7 +1049,7 @@ class CatalogPlatformApplicationValidator {
   /** @returns {UpdateSearchConfigurationParam} */
   static updateSearchConfiguration() {
     return Joi.object({
-      body: CatalogPlatformModel.UpdateSearchConfigurationRequest().required(),
+      body: CatalogPlatformModel.UpdateSearchConfigurationRequestSchema().required(),
     }).required();
   }