@gofynd/fdk-client-javascript 1.4.12 → 1.4.14

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

@@ -47,7 +47,7 @@ export = CatalogPlatformApplicationValidator;
  */
 /**
  * @typedef CreateSearchConfigurationParam
- * @property {CatalogPlatformModel.CreateSearchConfigurationRequest} body
+ * @property {CatalogPlatformModel.CreateSearchConfigurationRequestSchema} body
  */
 /**
  * @typedef DeleteAppCategoryReturnConfigurationParam
@@ -159,34 +159,6 @@ export = CatalogPlatformApplicationValidator;
  * @property {string} [q] - Search with Item Code, Name, Slug or Identifier.
  */
 /** @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
@@ -254,6 +226,34 @@ export = CatalogPlatformApplicationValidator;
  *   Default is 10.
  * @property {string} [q] - Get Values filtered by q string
  */
+/**
+ * @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 {number[]} [itemIds] - Item Ids of product
+ */
 /** @typedef GetAutocompleteConfigParam */
 /**
  * @typedef GetAutocompleteKeywordDetailParam
@@ -354,7 +354,7 @@ export = CatalogPlatformApplicationValidator;
  */
 /**
  * @typedef UpdateAllowSingleParam
- * @property {CatalogPlatformModel.AllowSingleRequest} body
+ * @property {CatalogPlatformModel.AllowSingleRequestSchema} body
  */
 /**
  * @typedef UpdateAppBrandParam
@@ -403,7 +403,7 @@ export = CatalogPlatformApplicationValidator;
  */
 /**
  * @typedef UpdateDefaultSortParam
- * @property {CatalogPlatformModel.DefaultKeyRequest} body
+ * @property {CatalogPlatformModel.DefaultKeyRequestSchema} body
  */
 /**
  * @typedef UpdateGroupConfigurationParam
@@ -423,7 +423,7 @@ export = CatalogPlatformApplicationValidator;
  */
 /**
  * @typedef UpdateSearchConfigurationParam
- * @property {CatalogPlatformModel.UpdateSearchConfigurationRequest} body
+ * @property {CatalogPlatformModel.UpdateSearchConfigurationRequestSchema} body
  */
 /**
  * @typedef UpdateSearchKeywordsParam
@@ -484,8 +484,6 @@ declare class CatalogPlatformApplicationValidator {
     static getAppProducts(): GetAppProductsParam;
     /** @returns {GetAppReturnConfigurationParam} */
     static getAppReturnConfiguration(): any;
-    /** @returns {GetAppicationProductsParam} */
-    static getAppicationProducts(): GetAppicationProductsParam;
     /** @returns {GetApplicationBrandListingParam} */
     static getApplicationBrandListing(): GetApplicationBrandListingParam;
     /** @returns {GetApplicationBrandsParam} */
@@ -498,6 +496,8 @@ declare class CatalogPlatformApplicationValidator {
     static getApplicationFilterKeys(): GetApplicationFilterKeysParam;
     /** @returns {GetApplicationFilterValuesParam} */
     static getApplicationFilterValues(): GetApplicationFilterValuesParam;
+    /** @returns {GetApplicationProductsParam} */
+    static getApplicationProducts(): GetApplicationProductsParam;
     /** @returns {GetAutocompleteConfigParam} */
     static getAutocompleteConfig(): any;
     /** @returns {GetAutocompleteKeywordDetailParam} */
@@ -566,7 +566,7 @@ declare class CatalogPlatformApplicationValidator {
     static updateSearchKeywords(): UpdateSearchKeywordsParam;
 }
 declare namespace CatalogPlatformApplicationValidator {
-    export { AddCollectionItemsParam, CreateAppCategoryReturnConfigurationParam, CreateAppReturnConfigurationParam, CreateCollectionParam, CreateConfigurationByTypeParam, CreateConfigurationProductListingParam, CreateCustomAutocompleteRuleParam, CreateCustomKeywordParam, CreateGroupConfigurationParam, CreateListingConfigurationParam, CreateSearchConfigurationParam, DeleteAppCategoryReturnConfigurationParam, DeleteAutocompleteKeywordParam, DeleteCollectionParam, DeleteGroupConfigurationParam, DeleteListingConfigurationParam, DeleteSearchConfigurationParam, DeleteSearchKeywordsParam, GetAllCollectionsParam, GetAllSearchKeywordParam, GetAppCategoryReturnConfigParam, GetAppInventoryParam, GetAppLocationsParam, GetAppProductParam, GetAppProductsParam, GetAppReturnConfigurationParam, GetAppicationProductsParam, GetApplicationBrandListingParam, GetApplicationBrandsParam, GetApplicationCategoryListingParam, GetApplicationDepartmentListingParam, GetApplicationFilterKeysParam, GetApplicationFilterValuesParam, GetAutocompleteConfigParam, GetAutocompleteKeywordDetailParam, GetCatalogConfigurationParam, GetCatalogInsightsParam, GetCategoriesParam, GetCollectionDetailParam, GetCollectionItemsParam, GetConfigurationByTypeParam, GetConfigurationMetadataParam, GetConfigurationsParam, GetDepartmentsParam, GetDiscountedInventoryBySizeIdentifierParam, GetGroupConfigurationsParam, GetListingConfigurationsParam, GetProductDetailBySlugParam, GetQueryFiltersParam, GetSearchConfigurationParam, GetSearchKeywordsParam, UpdateAllowSingleParam, UpdateAppBrandParam, UpdateAppCategoryParam, UpdateAppCategoryReturnConfigurationParam, UpdateAppDepartmentParam, UpdateAppLocationParam, UpdateAppProductParam, UpdateAppReturnConfigurationParam, UpdateAutocompleteKeywordParam, UpdateCollectionParam, UpdateDefaultSortParam, UpdateGroupConfigurationParam, UpdateListingConfigurationParam, UpdateSearchConfigurationParam, UpdateSearchKeywordsParam };
+    export { AddCollectionItemsParam, CreateAppCategoryReturnConfigurationParam, CreateAppReturnConfigurationParam, CreateCollectionParam, CreateConfigurationByTypeParam, CreateConfigurationProductListingParam, CreateCustomAutocompleteRuleParam, CreateCustomKeywordParam, CreateGroupConfigurationParam, CreateListingConfigurationParam, CreateSearchConfigurationParam, DeleteAppCategoryReturnConfigurationParam, DeleteAutocompleteKeywordParam, DeleteCollectionParam, DeleteGroupConfigurationParam, DeleteListingConfigurationParam, DeleteSearchConfigurationParam, DeleteSearchKeywordsParam, GetAllCollectionsParam, GetAllSearchKeywordParam, GetAppCategoryReturnConfigParam, GetAppInventoryParam, GetAppLocationsParam, GetAppProductParam, GetAppProductsParam, GetAppReturnConfigurationParam, GetApplicationBrandListingParam, GetApplicationBrandsParam, GetApplicationCategoryListingParam, GetApplicationDepartmentListingParam, GetApplicationFilterKeysParam, GetApplicationFilterValuesParam, GetApplicationProductsParam, GetAutocompleteConfigParam, GetAutocompleteKeywordDetailParam, GetCatalogConfigurationParam, GetCatalogInsightsParam, GetCategoriesParam, GetCollectionDetailParam, GetCollectionItemsParam, GetConfigurationByTypeParam, GetConfigurationMetadataParam, GetConfigurationsParam, GetDepartmentsParam, GetDiscountedInventoryBySizeIdentifierParam, GetGroupConfigurationsParam, GetListingConfigurationsParam, GetProductDetailBySlugParam, GetQueryFiltersParam, GetSearchConfigurationParam, GetSearchKeywordsParam, UpdateAllowSingleParam, UpdateAppBrandParam, UpdateAppCategoryParam, UpdateAppCategoryReturnConfigurationParam, UpdateAppDepartmentParam, UpdateAppLocationParam, UpdateAppProductParam, UpdateAppReturnConfigurationParam, UpdateAutocompleteKeywordParam, UpdateCollectionParam, UpdateDefaultSortParam, UpdateGroupConfigurationParam, UpdateListingConfigurationParam, UpdateSearchConfigurationParam, UpdateSearchKeywordsParam };
 }
 type AddCollectionItemsParam = {
     /**
@@ -617,7 +617,7 @@ type CreateListingConfigurationParam = {
     body: CatalogPlatformModel.AppConfigurationsSort;
 };
 type CreateSearchConfigurationParam = {
-    body: CatalogPlatformModel.CreateSearchConfigurationRequest;
+    body: CatalogPlatformModel.CreateSearchConfigurationRequestSchema;
 };
 type DeleteAppCategoryReturnConfigurationParam = {
     body: CatalogPlatformModel.DeleteAppCategoryReturnConfig;
@@ -852,66 +852,6 @@ type GetAppProductsParam = {
      */
     q?: string;
 };
-type GetAppicationProductsParam = {
-    /**
-     * - The search query. This can be a partial or complete
-     * name of a either a product, brand or category
-     */
-    q?: string;
-    /**
-     * - 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**
-     */
-    f?: string;
-    /**
-     * - 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**
-     */
-    c?: string;
-    /**
-     * - Pass `filters` parameter to fetch the filter
-     * details. This flag is used to fetch all filters
-     */
-    filters?: boolean;
-    /**
-     * - This query parameter is used to get the
-     * dependent products in the listing.
-     */
-    isDependent?: boolean;
-    /**
-     * - 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.
-     */
-    sortOn?: string;
-    /**
-     * - Each response will contain **page_id** param,
-     * which should be sent back to make pagination work.
-     */
-    pageId?: string;
-    /**
-     * - Number of items to retrieve in each page.
-     * Default is 12.
-     */
-    pageSize?: number;
-    /**
-     * - If page_type is number then pass it to fetch
-     * page items. Default is 1.
-     */
-    pageNo?: number;
-    /**
-     * - For pagination type should be cursor or
-     * number. Default is cursor.
-     */
-    pageType?: string;
-    /**
-     * - Item Ids of product
-     */
-    itemIds?: number[];
-};
 type GetApplicationBrandListingParam = {
     /**
      * - The page number to navigate through the given
@@ -1039,6 +979,66 @@ type GetApplicationFilterValuesParam = {
      */
     q?: string;
 };
+type GetApplicationProductsParam = {
+    /**
+     * - The search query. This can be a partial or complete
+     * name of a either a product, brand or category
+     */
+    q?: string;
+    /**
+     * - 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**
+     */
+    f?: string;
+    /**
+     * - 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**
+     */
+    c?: string;
+    /**
+     * - Pass `filters` parameter to fetch the filter
+     * details. This flag is used to fetch all filters
+     */
+    filters?: boolean;
+    /**
+     * - This query parameter is used to get the
+     * dependent products in the listing.
+     */
+    isDependent?: boolean;
+    /**
+     * - 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.
+     */
+    sortOn?: string;
+    /**
+     * - Each response will contain **page_id** param,
+     * which should be sent back to make pagination work.
+     */
+    pageId?: string;
+    /**
+     * - Number of items to retrieve in each page.
+     * Default is 12.
+     */
+    pageSize?: number;
+    /**
+     * - If page_type is number then pass it to fetch
+     * page items. Default is 1.
+     */
+    pageNo?: number;
+    /**
+     * - For pagination type should be cursor or
+     * number. Default is cursor.
+     */
+    pageType?: string;
+    /**
+     * - Item Ids of product
+     */
+    itemIds?: number[];
+};
 type GetAutocompleteKeywordDetailParam = {
     /**
      * - A `id` is a unique identifier for a particular
@@ -1213,7 +1213,7 @@ type GetSearchKeywordsParam = {
     id: string;
 };
 type UpdateAllowSingleParam = {
-    body: CatalogPlatformModel.AllowSingleRequest;
+    body: CatalogPlatformModel.AllowSingleRequestSchema;
 };
 type UpdateAppBrandParam = {
     /**
@@ -1273,7 +1273,7 @@ type UpdateCollectionParam = {
     body: CatalogPlatformModel.UpdateCollection;
 };
 type UpdateDefaultSortParam = {
-    body: CatalogPlatformModel.DefaultKeyRequest;
+    body: CatalogPlatformModel.DefaultKeyRequestSchema;
 };
 type UpdateGroupConfigurationParam = {
     /**
@@ -1302,7 +1302,7 @@ type UpdateListingConfigurationParam = {
     body: CatalogPlatformModel.AppConfigurationsSort;
 };
 type UpdateSearchConfigurationParam = {
-    body: CatalogPlatformModel.UpdateSearchConfigurationRequest;
+    body: CatalogPlatformModel.UpdateSearchConfigurationRequestSchema;
 };
 type UpdateSearchKeywordsParam = {
     /**

package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js

@@ -60,7 +60,7 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
 
 /**
  * @typedef CreateSearchConfigurationParam
- * @property {CatalogPlatformModel.CreateSearchConfigurationRequest} body
+ * @property {CatalogPlatformModel.CreateSearchConfigurationRequestSchema} body
  */
 
 /**
@@ -188,35 +188,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
@@ -290,6 +261,35 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
  * @property {string} [q] - Get Values filtered by q string
  */
 
+/**
+ * @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 {number[]} [itemIds] - Item Ids of product
+ */
+
 /** @typedef GetAutocompleteConfigParam */
 
 /**
@@ -408,7 +408,7 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
 
 /**
  * @typedef UpdateAllowSingleParam
- * @property {CatalogPlatformModel.AllowSingleRequest} body
+ * @property {CatalogPlatformModel.AllowSingleRequestSchema} body
  */
 
 /**
@@ -467,7 +467,7 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
 
 /**
  * @typedef UpdateDefaultSortParam
- * @property {CatalogPlatformModel.DefaultKeyRequest} body
+ * @property {CatalogPlatformModel.DefaultKeyRequestSchema} body
  */
 
 /**
@@ -490,7 +490,7 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
 
 /**
  * @typedef UpdateSearchConfigurationParam
- * @property {CatalogPlatformModel.UpdateSearchConfigurationRequest} body
+ * @property {CatalogPlatformModel.UpdateSearchConfigurationRequestSchema} body
  */
 
 /**
@@ -578,7 +578,7 @@ class CatalogPlatformApplicationValidator {
   /** @returns {CreateSearchConfigurationParam} */
   static createSearchConfiguration() {
     return Joi.object({
-      body: CatalogPlatformModel.CreateSearchConfigurationRequest().required(),
+      body: CatalogPlatformModel.CreateSearchConfigurationRequestSchema().required(),
     }).required();
   }
 
@@ -716,23 +716,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({
@@ -791,6 +774,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.number()),
+    }).required();
+  }
+
   /** @returns {GetAutocompleteConfigParam} */
   static getAutocompleteConfig() {
     return Joi.object({}).required();
@@ -927,7 +927,7 @@ class CatalogPlatformApplicationValidator {
   /** @returns {UpdateAllowSingleParam} */
   static updateAllowSingle() {
     return Joi.object({
-      body: CatalogPlatformModel.AllowSingleRequest().required(),
+      body: CatalogPlatformModel.AllowSingleRequestSchema().required(),
     }).required();
   }
 
@@ -1004,7 +1004,7 @@ class CatalogPlatformApplicationValidator {
   /** @returns {UpdateDefaultSortParam} */
   static updateDefaultSort() {
     return Joi.object({
-      body: CatalogPlatformModel.DefaultKeyRequest().required(),
+      body: CatalogPlatformModel.DefaultKeyRequestSchema().required(),
     }).required();
   }
 
@@ -1029,7 +1029,7 @@ class CatalogPlatformApplicationValidator {
   /** @returns {UpdateSearchConfigurationParam} */
   static updateSearchConfiguration() {
     return Joi.object({
-      body: CatalogPlatformModel.UpdateSearchConfigurationRequest().required(),
+      body: CatalogPlatformModel.UpdateSearchConfigurationRequestSchema().required(),
     }).required();
   }