@gofynd/fdk-client-javascript 1.1.6 → 1.2.0

package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js

@@ -1,71 +1,488 @@
 const Joi = require("joi");
 
-const CatalogModel = require("./CatalogPlatformModel");
-class CatalogValidator {
+const CatalogPlatformModel = require("./CatalogPlatformModel");
+
+/**
+ * @typedef AddCollectionItemsParam
+ * @property {string} id - A `id` is a unique identifier of a collection.
+ * @property {CatalogPlatformModel.CollectionItemUpdate} body
+ */
+
+/**
+ * @typedef CreateCollectionParam
+ * @property {CatalogPlatformModel.CreateCollection} body
+ */
+
+/**
+ * @typedef CreateConfigurationByTypeParam
+ * @property {string} type - Type can be brands, categories etc.
+ * @property {CatalogPlatformModel.AppConfiguration} body
+ */
+
+/**
+ * @typedef CreateConfigurationProductListingParam
+ * @property {CatalogPlatformModel.AppConfiguration} body
+ */
+
+/**
+ * @typedef CreateCustomAutocompleteRuleParam
+ * @property {CatalogPlatformModel.CreateAutocompleteKeyword} body
+ */
+
+/**
+ * @typedef CreateCustomKeywordParam
+ * @property {CatalogPlatformModel.CreateSearchKeyword} body
+ */
+
+/**
+ * @typedef CreateGroupConfigurationParam
+ * @property {string} configType - A `config_type` is a unique identifier for a
+ *   particular group configuration type.
+ * @property {CatalogPlatformModel.AppConfigurationDetail} body
+ */
+
+/**
+ * @typedef CreateListingConfigurationParam
+ * @property {string} configType - A `config_type` is a unique identifier for a
+ *   particular listing configuration type.
+ * @property {CatalogPlatformModel.AppConfigurationsSort} body
+ */
+
+/**
+ * @typedef DeleteAutocompleteKeywordParam
+ * @property {string} id - A `id` is a unique identifier for a particular
+ *   detail. Pass the `id` of the keywords which you want to delete.
+ */
+
+/**
+ * @typedef DeleteCollectionParam
+ * @property {string} id - A `id` is a unique identifier of a collection.
+ */
+
+/**
+ * @typedef DeleteGroupConfigurationParam
+ * @property {string} configType - A `config_type` is a unique identifier for a
+ *   particular group configuration type.
+ * @property {string} groupSlug - A `group_slug` is a unique identifier of a
+ *   particular configuration.
+ */
+
+/**
+ * @typedef DeleteListingConfigurationParam
+ * @property {string} configType - A `config_type` is a unique identifier for a
+ *   particular listing configuration type.
+ * @property {string} configId - A `config_id` is a unique identifier of a
+ *   particular configuration.
+ */
+
+/**
+ * @typedef DeleteSearchKeywordsParam
+ * @property {string} id - A `id` is a unique identifier for a particular
+ *   detail. Pass the `id` of the keywords which you want to delete.
+ */
+
+/**
+ * @typedef GetAllCollectionsParam
+ * @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.
+ */
+
+/** @typedef GetAllSearchKeywordParam */
+
+/**
+ * @typedef GetAppInventoryParam
+ * @property {number[]} [itemIds] - The Item Id of the product.
+ * @property {number[]} [storeIds] - The Store Id of products to fetch inventory.
+ * @property {number[]} [brandIds] - The Brand Id of products to fetch inventory.
+ * @property {string[]} [sellerIdentifiers] - Unique seller_identifier of the product.
+ * @property {string} [timestamp] - Timestamp in UTC format (2020-07-23T10:27:50Z)
+ * @property {number} [pageSize] - The number of items to retrieve in each page.
+ * @property {string} [pageId] - Page ID to retrieve next set of results.
+ */
+
+/**
+ * @typedef GetAppLocationsParam
+ * @property {string} [storeType] - Helps to sort the location list on the basis
+ *   of location type.
+ * @property {number[]} [uid] - Helps to sort the location list on the basis of uid list.
+ * @property {string} [q] - Query that is to be searched.
+ * @property {string} [stage] - To filter companies on basis of verified or
+ *   unverified companies.
+ * @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 20.
+ */
+
+/**
+ * @typedef GetAppProductParam
+ * @property {string} itemId - Product id for a particular product.
+ */
+
+/**
+ * @typedef GetAppProductsParam
+ * @property {number[]} [brandIds] - Get multiple products filtered by Brand Ids
+ * @property {number[]} [categoryIds] - Get multiple products filtered by Category Ids
+ * @property {number[]} [departmentIds] - Get multiple products filtered by Department Ids
+ * @property {string[]} [tags] - Get multiple products filtered by tags
+ * @property {number[]} [itemIds] - Get multiple products filtered by Item Ids
+ * @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] - Search with Item Code, Name, Slug or Identifier.
+ */
+
+/**
+ * @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
+ *   set of results
+ * @property {number} [pageSize] - Number of items to retrieve in each page.
+ *   Default is 12.
+ * @property {string} [q] - Search query with brand name.Use this parameter to
+ *   search brands by brand name.
+ */
+
+/**
+ * @typedef GetApplicationBrandsParam
+ * @property {string} [department] - The name of the department. Use this
+ *   parameter to filter products by a particular department. See below the list
+ *   of available departments. You can retrieve available departments from the
+ *   **v1.0/departments/** API
+ * @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 query with brand name.Use this parameter to
+ *   search brands by brand name.
+ * @property {number[]} [brandId] - Helps to sort the brands list on the basis
+ *   of uid list.
+ */
+
+/**
+ * @typedef GetApplicationCategoryListingParam
+ * @property {number} [departmentId] - A `department_id` is a unique identifier
+ *   for a particular department.
+ * @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 query with brand name.Use this parameter to
+ *   search brands by brand name.
+ */
+
+/**
+ * @typedef GetApplicationDepartmentListingParam
+ * @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 query with brand name.Use this parameter to
+ *   search department by name.
+ */
+
+/** @typedef GetAutocompleteConfigParam */
+
+/**
+ * @typedef GetAutocompleteKeywordDetailParam
+ * @property {string} id - A `id` is a unique identifier for a particular
+ *   detail. Pass the `id` of the keywords which you want to retrieve.
+ */
+
+/** @typedef GetCatalogConfigurationParam */
+
+/**
+ * @typedef GetCatalogInsightsParam
+ * @property {string} [brand] - Brand slug
+ */
+
+/**
+ * @typedef GetCategoriesParam
+ * @property {string} [department] - The name of the department. Use this
+ *   parameter to filter products by a particular department. See below the list
+ *   of available departments. You can retrieve available departments from the
+ *   **v1.0/departments/** API
+ */
+
+/**
+ * @typedef GetCollectionDetailParam
+ * @property {string} slug - A `slug` is a human readable, URL friendly unique
+ *   identifier of an object. Pass the `slug` of the collection which you want
+ *   to retrieve.
+ */
+
+/**
+ * @typedef GetCollectionItemsParam
+ * @property {string} id - A `id` is a unique identifier of a collection.
+ * @property {string} [sortOn] - Each response will contain sort_on param, which
+ *   should be sent back to make pagination work.
+ * @property {string} [pageId] - Each response will contain next_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.
+ */
+
+/**
+ * @typedef GetConfigurationByTypeParam
+ * @property {string} type - Type can be brands, categories etc.
+ */
+
+/**
+ * @typedef GetConfigurationMetadataParam
+ * @property {string} configType - A `config_type` is an identifier that defines
+ *   a specific type of configuration.
+ * @property {string} [templateSlug] - Get configuration list filtered by
+ *   `template_slug` string. This is for the details and comparision groups.
+ */
+
+/** @typedef GetConfigurationsParam */
+
+/** @typedef GetDepartmentsParam */
+
+/**
+ * @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} [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.
+ */
+
+/**
+ * @typedef GetGroupConfigurationsParam
+ * @property {string} configType - A `config_type` is an identifier that defines
+ *   a specific type of configuration.
+ * @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} [search] - Get configuration list filtered by `search` string.
+ * @property {string} [templateSlug] - Get configuration list filtered by
+ *   `template_slug` string. This is for the details and comparision groups.
+ */
+
+/**
+ * @typedef GetListingConfigurationsParam
+ * @property {string} configType - A `config_type` is an identifier that defines
+ *   a specific type of configuration.
+ * @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} [search] - Get configuration list filtered by `search` string.
+ */
+
+/**
+ * @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/**
+ */
+
+/** @typedef GetQueryFiltersParam */
+
+/**
+ * @typedef GetSearchKeywordsParam
+ * @property {string} id - A `id` is a unique identifier for a particular
+ *   detail. Pass the `id` of the keywords which you want to retrieve.
+ */
+
+/**
+ * @typedef UpdateAllowSingleParam
+ * @property {CatalogPlatformModel.AllowSingleRequest} body
+ */
+
+/**
+ * @typedef UpdateAppBrandParam
+ * @property {string} brandUid - Brand id for which the custom_json is associated.
+ * @property {CatalogPlatformModel.ApplicationBrandJson} body
+ */
+
+/**
+ * @typedef UpdateAppCategoryParam
+ * @property {string} categoryUid - Category id for which the custom_json is associated.
+ * @property {CatalogPlatformModel.ApplicationCategoryJson} body
+ */
+
+/**
+ * @typedef UpdateAppDepartmentParam
+ * @property {string} departmentUid - Department id for which the custom_json is
+ *   associated.
+ * @property {CatalogPlatformModel.ApplicationDepartmentJson} body
+ */
+
+/**
+ * @typedef UpdateAppLocationParam
+ * @property {string} 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 {CatalogPlatformModel.ApplicationItemMeta} body
+ */
+
+/**
+ * @typedef UpdateAutocompleteKeywordParam
+ * @property {string} id - A `id` is a unique identifier for a particular
+ *   detail. Pass the `id` of the keywords which you want to delete.
+ * @property {CatalogPlatformModel.CreateAutocompleteKeyword} body
+ */
+
+/**
+ * @typedef UpdateCollectionParam
+ * @property {string} id - A `id` is a unique identifier of a collection.
+ * @property {CatalogPlatformModel.UpdateCollection} body
+ */
+
+/**
+ * @typedef UpdateDefaultSortParam
+ * @property {CatalogPlatformModel.DefaultKeyRequest} body
+ */
+
+/**
+ * @typedef UpdateGroupConfigurationParam
+ * @property {string} configType - A `config_type` is a unique identifier for a
+ *   particular group configuration type.
+ * @property {string} groupSlug - A `group_slug` is a unique identifier of a
+ *   particular configuration.
+ * @property {CatalogPlatformModel.AppConfigurationDetail} body
+ */
+
+/**
+ * @typedef UpdateListingConfigurationParam
+ * @property {string} configType - A `config_type` is a unique identifier for a
+ *   particular listing configuration type.
+ * @property {string} configId - A `config_id` is a unique identifier of a
+ *   particular configuration.
+ * @property {CatalogPlatformModel.AppConfigurationsSort} body
+ */
+
+/**
+ * @typedef UpdateSearchKeywordsParam
+ * @property {string} id - A `id` is a unique identifier for a particular
+ *   detail. Pass the `id` of the keywords which you want to delete.
+ * @property {CatalogPlatformModel.CreateSearchKeyword} body
+ */
+
+class CatalogPlatformApplicationValidator {
+  /** @returns {AddCollectionItemsParam} */
   static addCollectionItems() {
     return Joi.object({
       id: Joi.string().allow("").required(),
-      body: CatalogModel.CollectionItemUpdate().required(),
+      body: CatalogPlatformModel.CollectionItemUpdate().required(),
     }).required();
   }
 
+  /** @returns {CreateCollectionParam} */
   static createCollection() {
     return Joi.object({
-      body: CatalogModel.CreateCollection().required(),
+      body: CatalogPlatformModel.CreateCollection().required(),
     }).required();
   }
 
+  /** @returns {CreateConfigurationByTypeParam} */
   static createConfigurationByType() {
     return Joi.object({
       type: Joi.string().allow("").required(),
-      body: CatalogModel.AppConfiguration().required(),
+      body: CatalogPlatformModel.AppConfiguration().required(),
     }).required();
   }
 
+  /** @returns {CreateConfigurationProductListingParam} */
   static createConfigurationProductListing() {
     return Joi.object({
-      body: CatalogModel.AppConfiguration().required(),
+      body: CatalogPlatformModel.AppConfiguration().required(),
     }).required();
   }
 
+  /** @returns {CreateCustomAutocompleteRuleParam} */
   static createCustomAutocompleteRule() {
     return Joi.object({
-      body: CatalogModel.CreateAutocompleteKeyword().required(),
+      body: CatalogPlatformModel.CreateAutocompleteKeyword().required(),
     }).required();
   }
 
+  /** @returns {CreateCustomKeywordParam} */
   static createCustomKeyword() {
     return Joi.object({
-      body: CatalogModel.CreateSearchKeyword().required(),
+      body: CatalogPlatformModel.CreateSearchKeyword().required(),
     }).required();
   }
 
+  /** @returns {CreateGroupConfigurationParam} */
   static createGroupConfiguration() {
     return Joi.object({
       configType: Joi.string().allow("").required(),
-      body: CatalogModel.AppConfigurationDetail().required(),
+      body: CatalogPlatformModel.AppConfigurationDetail().required(),
     }).required();
   }
 
+  /** @returns {CreateListingConfigurationParam} */
   static createListingConfiguration() {
     return Joi.object({
       configType: Joi.string().allow("").required(),
-      body: CatalogModel.AppConfigurationsSort().required(),
+      body: CatalogPlatformModel.AppConfigurationsSort().required(),
     }).required();
   }
 
+  /** @returns {DeleteAutocompleteKeywordParam} */
   static deleteAutocompleteKeyword() {
     return Joi.object({
       id: Joi.string().allow("").required(),
     }).required();
   }
 
+  /** @returns {DeleteCollectionParam} */
   static deleteCollection() {
     return Joi.object({
       id: Joi.string().allow("").required(),
     }).required();
   }
 
+  /** @returns {DeleteGroupConfigurationParam} */
   static deleteGroupConfiguration() {
     return Joi.object({
       configType: Joi.string().allow("").required(),
@@ -73,6 +490,7 @@ class CatalogValidator {
     }).required();
   }
 
+  /** @returns {DeleteListingConfigurationParam} */
   static deleteListingConfiguration() {
     return Joi.object({
       configType: Joi.string().allow("").required(),
@@ -80,12 +498,14 @@ class CatalogValidator {
     }).required();
   }
 
+  /** @returns {DeleteSearchKeywordsParam} */
   static deleteSearchKeywords() {
     return Joi.object({
       id: Joi.string().allow("").required(),
     }).required();
   }
 
+  /** @returns {GetAllCollectionsParam} */
   static getAllCollections() {
     return Joi.object({
       q: Joi.string().allow(""),
@@ -98,10 +518,12 @@ class CatalogValidator {
     }).required();
   }
 
+  /** @returns {GetAllSearchKeywordParam} */
   static getAllSearchKeyword() {
     return Joi.object({}).required();
   }
 
+  /** @returns {GetAppInventoryParam} */
   static getAppInventory() {
     return Joi.object({
       itemIds: Joi.array().items(Joi.number()),
@@ -114,6 +536,7 @@ class CatalogValidator {
     }).required();
   }
 
+  /** @returns {GetAppLocationsParam} */
   static getAppLocations() {
     return Joi.object({
       storeType: Joi.string().allow(""),
@@ -125,12 +548,14 @@ class CatalogValidator {
     }).required();
   }
 
+  /** @returns {GetAppProductParam} */
   static getAppProduct() {
     return Joi.object({
       itemId: Joi.string().allow("").required(),
     }).required();
   }
 
+  /** @returns {GetAppProductsParam} */
   static getAppProducts() {
     return Joi.object({
       brandIds: Joi.array().items(Joi.number()),
@@ -144,6 +569,7 @@ class CatalogValidator {
     }).required();
   }
 
+  /** @returns {GetAppicationProductsParam} */
   static getAppicationProducts() {
     return Joi.object({
       q: Joi.string().allow(""),
@@ -160,6 +586,7 @@ class CatalogValidator {
     }).required();
   }
 
+  /** @returns {GetApplicationBrandListingParam} */
   static getApplicationBrandListing() {
     return Joi.object({
       pageNo: Joi.number(),
@@ -168,6 +595,7 @@ class CatalogValidator {
     }).required();
   }
 
+  /** @returns {GetApplicationBrandsParam} */
   static getApplicationBrands() {
     return Joi.object({
       department: Joi.string().allow(""),
@@ -178,6 +606,7 @@ class CatalogValidator {
     }).required();
   }
 
+  /** @returns {GetApplicationCategoryListingParam} */
   static getApplicationCategoryListing() {
     return Joi.object({
       departmentId: Joi.number(),
@@ -187,6 +616,7 @@ class CatalogValidator {
     }).required();
   }
 
+  /** @returns {GetApplicationDepartmentListingParam} */
   static getApplicationDepartmentListing() {
     return Joi.object({
       pageNo: Joi.number(),
@@ -195,38 +625,45 @@ class CatalogValidator {
     }).required();
   }
 
+  /** @returns {GetAutocompleteConfigParam} */
   static getAutocompleteConfig() {
     return Joi.object({}).required();
   }
 
+  /** @returns {GetAutocompleteKeywordDetailParam} */
   static getAutocompleteKeywordDetail() {
     return Joi.object({
       id: Joi.string().allow("").required(),
     }).required();
   }
 
+  /** @returns {GetCatalogConfigurationParam} */
   static getCatalogConfiguration() {
     return Joi.object({}).required();
   }
 
+  /** @returns {GetCatalogInsightsParam} */
   static getCatalogInsights() {
     return Joi.object({
       brand: Joi.string().allow(""),
     }).required();
   }
 
+  /** @returns {GetCategoriesParam} */
   static getCategories() {
     return Joi.object({
       department: Joi.string().allow(""),
     }).required();
   }
 
+  /** @returns {GetCollectionDetailParam} */
   static getCollectionDetail() {
     return Joi.object({
       slug: Joi.string().allow("").required(),
     }).required();
   }
 
+  /** @returns {GetCollectionItemsParam} */
   static getCollectionItems() {
     return Joi.object({
       id: Joi.string().allow("").required(),
@@ -236,12 +673,14 @@ class CatalogValidator {
     }).required();
   }
 
+  /** @returns {GetConfigurationByTypeParam} */
   static getConfigurationByType() {
     return Joi.object({
       type: Joi.string().allow("").required(),
     }).required();
   }
 
+  /** @returns {GetConfigurationMetadataParam} */
   static getConfigurationMetadata() {
     return Joi.object({
       configType: Joi.string().allow("").required(),
@@ -249,14 +688,17 @@ class CatalogValidator {
     }).required();
   }
 
+  /** @returns {GetConfigurationsParam} */
   static getConfigurations() {
     return Joi.object({}).required();
   }
 
+  /** @returns {GetDepartmentsParam} */
   static getDepartments() {
     return Joi.object({}).required();
   }
 
+  /** @returns {GetDiscountedInventoryBySizeIdentifierParam} */
   static getDiscountedInventoryBySizeIdentifier() {
     return Joi.object({
       itemId: Joi.number().required(),
@@ -268,6 +710,7 @@ class CatalogValidator {
     }).required();
   }
 
+  /** @returns {GetGroupConfigurationsParam} */
   static getGroupConfigurations() {
     return Joi.object({
       configType: Joi.string().allow("").required(),
@@ -278,6 +721,7 @@ class CatalogValidator {
     }).required();
   }
 
+  /** @returns {GetListingConfigurationsParam} */
   static getListingConfigurations() {
     return Joi.object({
       configType: Joi.string().allow("").required(),
@@ -287,105 +731,120 @@ class CatalogValidator {
     }).required();
   }
 
+  /** @returns {GetProductDetailBySlugParam} */
   static getProductDetailBySlug() {
     return Joi.object({
       slug: Joi.string().allow("").required(),
     }).required();
   }
 
+  /** @returns {GetQueryFiltersParam} */
   static getQueryFilters() {
     return Joi.object({}).required();
   }
 
+  /** @returns {GetSearchKeywordsParam} */
   static getSearchKeywords() {
     return Joi.object({
       id: Joi.string().allow("").required(),
     }).required();
   }
 
+  /** @returns {UpdateAllowSingleParam} */
   static updateAllowSingle() {
     return Joi.object({
-      body: CatalogModel.AllowSingleRequest().required(),
+      body: CatalogPlatformModel.AllowSingleRequest().required(),
     }).required();
   }
 
+  /** @returns {UpdateAppBrandParam} */
   static updateAppBrand() {
     return Joi.object({
       brandUid: Joi.string().allow("").required(),
-      body: CatalogModel.ApplicationBrandJson().required(),
+      body: CatalogPlatformModel.ApplicationBrandJson().required(),
     }).required();
   }
 
+  /** @returns {UpdateAppCategoryParam} */
   static updateAppCategory() {
     return Joi.object({
       categoryUid: Joi.string().allow("").required(),
-      body: CatalogModel.ApplicationCategoryJson().required(),
+      body: CatalogPlatformModel.ApplicationCategoryJson().required(),
     }).required();
   }
 
+  /** @returns {UpdateAppDepartmentParam} */
   static updateAppDepartment() {
     return Joi.object({
       departmentUid: Joi.string().allow("").required(),
-      body: CatalogModel.ApplicationDepartmentJson().required(),
+      body: CatalogPlatformModel.ApplicationDepartmentJson().required(),
     }).required();
   }
 
+  /** @returns {UpdateAppLocationParam} */
   static updateAppLocation() {
     return Joi.object({
       storeUid: Joi.string().allow("").required(),
-      body: CatalogModel.ApplicationStoreJson().required(),
+      body: CatalogPlatformModel.ApplicationStoreJson().required(),
     }).required();
   }
 
+  /** @returns {UpdateAppProductParam} */
   static updateAppProduct() {
     return Joi.object({
       itemId: Joi.string().allow("").required(),
-      body: CatalogModel.ApplicationItemMeta().required(),
+      body: CatalogPlatformModel.ApplicationItemMeta().required(),
     }).required();
   }
 
+  /** @returns {UpdateAutocompleteKeywordParam} */
   static updateAutocompleteKeyword() {
     return Joi.object({
       id: Joi.string().allow("").required(),
-      body: CatalogModel.CreateAutocompleteKeyword().required(),
+      body: CatalogPlatformModel.CreateAutocompleteKeyword().required(),
     }).required();
   }
 
+  /** @returns {UpdateCollectionParam} */
   static updateCollection() {
     return Joi.object({
       id: Joi.string().allow("").required(),
-      body: CatalogModel.UpdateCollection().required(),
+      body: CatalogPlatformModel.UpdateCollection().required(),
     }).required();
   }
 
+  /** @returns {UpdateDefaultSortParam} */
   static updateDefaultSort() {
     return Joi.object({
-      body: CatalogModel.DefaultKeyRequest().required(),
+      body: CatalogPlatformModel.DefaultKeyRequest().required(),
     }).required();
   }
 
+  /** @returns {UpdateGroupConfigurationParam} */
   static updateGroupConfiguration() {
     return Joi.object({
       configType: Joi.string().allow("").required(),
       groupSlug: Joi.string().allow("").required(),
-      body: CatalogModel.AppConfigurationDetail().required(),
+      body: CatalogPlatformModel.AppConfigurationDetail().required(),
     }).required();
   }
 
+  /** @returns {UpdateListingConfigurationParam} */
   static updateListingConfiguration() {
     return Joi.object({
       configType: Joi.string().allow("").required(),
       configId: Joi.string().allow("").required(),
-      body: CatalogModel.AppConfigurationsSort().required(),
+      body: CatalogPlatformModel.AppConfigurationsSort().required(),
     }).required();
   }
 
+  /** @returns {UpdateSearchKeywordsParam} */
   static updateSearchKeywords() {
     return Joi.object({
       id: Joi.string().allow("").required(),
-      body: CatalogModel.CreateSearchKeyword().required(),
+      body: CatalogPlatformModel.CreateSearchKeyword().required(),
     }).required();
   }
 }
 
-module.exports = CatalogValidator;
+module.exports = CatalogPlatformApplicationValidator;