@gofynd/fdk-client-javascript 1.4.14 → 1.4.15-beta.1

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

@@ -47,7 +47,7 @@ export = CatalogPlatformApplicationValidator;
  */
 /**
  * @typedef CreateSearchConfigurationParam
- * @property {CatalogPlatformModel.CreateSearchConfigurationRequestSchema} body
+ * @property {CatalogPlatformModel.CreateSearchConfigurationRequest} body
  */
 /**
  * @typedef DeleteAppCategoryReturnConfigurationParam
@@ -159,13 +159,41 @@ 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
  *   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
+ * @property {string} [q] - Search query with brand name. Use this parameter to
  *   search brands by brand name.
  */
 /**
@@ -173,12 +201,12 @@ export = CatalogPlatformApplicationValidator;
  * @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
+ *   "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
+ * @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.
@@ -191,8 +219,8 @@ export = CatalogPlatformApplicationValidator;
  *   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 {string} [q] - A search query string. Use this parameter to filter
+ *   results based on a keyword or specific value.
  */
 /**
  * @typedef GetApplicationDepartmentListingParam
@@ -200,8 +228,8 @@ export = CatalogPlatformApplicationValidator;
  *   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.
+ * @property {string} [q] - A search query string. Use this parameter to filter
+ *   results based on a keyword or specific value.
  */
 /**
  * @typedef GetApplicationFilterKeysParam
@@ -226,34 +254,6 @@ 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
@@ -263,14 +263,14 @@ export = CatalogPlatformApplicationValidator;
 /** @typedef GetCatalogConfigurationParam */
 /**
  * @typedef GetCatalogInsightsParam
- * @property {string} [brand] - Brand slug
+ * @property {string} [brand] - Brand slug that is to be searched.
  */
 /**
  * @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
+ *   "v1.0/departments/" API
  */
 /**
  * @typedef GetCollectionDetailParam
@@ -354,16 +354,18 @@ export = CatalogPlatformApplicationValidator;
  */
 /**
  * @typedef UpdateAllowSingleParam
- * @property {CatalogPlatformModel.AllowSingleRequestSchema} body
+ * @property {CatalogPlatformModel.AllowSingleRequest} body
  */
 /**
  * @typedef UpdateAppBrandParam
- * @property {string} brandUid - Brand id for which the custom_json is associated.
+ * @property {number} brandUid - A `brand id` is a unique identifier for a
+ *   particular brand.
  * @property {CatalogPlatformModel.ApplicationBrandJson} body
  */
 /**
  * @typedef UpdateAppCategoryParam
- * @property {string} categoryUid - Category id for which the custom_json is associated.
+ * @property {string} categoryUid - A `category id` is a unique identifier for a
+ *   particular category.
  * @property {CatalogPlatformModel.ApplicationCategoryJson} body
  */
 /**
@@ -403,7 +405,7 @@ export = CatalogPlatformApplicationValidator;
  */
 /**
  * @typedef UpdateDefaultSortParam
- * @property {CatalogPlatformModel.DefaultKeyRequestSchema} body
+ * @property {CatalogPlatformModel.DefaultKeyRequest} body
  */
 /**
  * @typedef UpdateGroupConfigurationParam
@@ -423,7 +425,7 @@ export = CatalogPlatformApplicationValidator;
  */
 /**
  * @typedef UpdateSearchConfigurationParam
- * @property {CatalogPlatformModel.UpdateSearchConfigurationRequestSchema} body
+ * @property {CatalogPlatformModel.UpdateSearchConfigurationRequest} body
  */
 /**
  * @typedef UpdateSearchKeywordsParam
@@ -484,6 +486,8 @@ declare class CatalogPlatformApplicationValidator {
     static getAppProducts(): GetAppProductsParam;
     /** @returns {GetAppReturnConfigurationParam} */
     static getAppReturnConfiguration(): any;
+    /** @returns {GetAppicationProductsParam} */
+    static getAppicationProducts(): GetAppicationProductsParam;
     /** @returns {GetApplicationBrandListingParam} */
     static getApplicationBrandListing(): GetApplicationBrandListingParam;
     /** @returns {GetApplicationBrandsParam} */
@@ -496,8 +500,6 @@ 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 +568,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, 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 };
+    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 };
 }
 type AddCollectionItemsParam = {
     /**
@@ -617,7 +619,7 @@ type CreateListingConfigurationParam = {
     body: CatalogPlatformModel.AppConfigurationsSort;
 };
 type CreateSearchConfigurationParam = {
-    body: CatalogPlatformModel.CreateSearchConfigurationRequestSchema;
+    body: CatalogPlatformModel.CreateSearchConfigurationRequest;
 };
 type DeleteAppCategoryReturnConfigurationParam = {
     body: CatalogPlatformModel.DeleteAppCategoryReturnConfig;
@@ -852,6 +854,66 @@ 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
@@ -864,7 +926,7 @@ type GetApplicationBrandListingParam = {
      */
     pageSize?: number;
     /**
-     * - Search query with brand name.Use this parameter to
+     * - Search query with brand name. Use this parameter to
      * search brands by brand name.
      */
     q?: string;
@@ -874,7 +936,7 @@ type GetApplicationBrandsParam = {
      * - 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
+     * "v1.0/departments/" API
      */
     department?: string;
     /**
@@ -888,7 +950,7 @@ type GetApplicationBrandsParam = {
      */
     pageSize?: number;
     /**
-     * - Search query with brand name.Use this parameter to
+     * - Search query with brand name. Use this parameter to
      * search brands by brand name.
      */
     q?: string;
@@ -915,8 +977,8 @@ type GetApplicationCategoryListingParam = {
      */
     pageSize?: number;
     /**
-     * - Search query with brand name.Use this parameter to
-     * search brands by brand name.
+     * - A search query string. Use this parameter to filter
+     * results based on a keyword or specific value.
      */
     q?: string;
 };
@@ -932,8 +994,8 @@ type GetApplicationDepartmentListingParam = {
      */
     pageSize?: number;
     /**
-     * - Search query with brand name.Use this parameter to
-     * search department by name.
+     * - A search query string. Use this parameter to filter
+     * results based on a keyword or specific value.
      */
     q?: string;
 };
@@ -979,66 +1041,6 @@ 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
@@ -1048,7 +1050,7 @@ type GetAutocompleteKeywordDetailParam = {
 };
 type GetCatalogInsightsParam = {
     /**
-     * - Brand slug
+     * - Brand slug that is to be searched.
      */
     brand?: string;
 };
@@ -1057,7 +1059,7 @@ type GetCategoriesParam = {
      * - 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
+     * "v1.0/departments/" API
      */
     department?: string;
 };
@@ -1213,18 +1215,20 @@ type GetSearchKeywordsParam = {
     id: string;
 };
 type UpdateAllowSingleParam = {
-    body: CatalogPlatformModel.AllowSingleRequestSchema;
+    body: CatalogPlatformModel.AllowSingleRequest;
 };
 type UpdateAppBrandParam = {
     /**
-     * - Brand id for which the custom_json is associated.
+     * - A `brand id` is a unique identifier for a
+     * particular brand.
      */
-    brandUid: string;
+    brandUid: number;
     body: CatalogPlatformModel.ApplicationBrandJson;
 };
 type UpdateAppCategoryParam = {
     /**
-     * - Category id for which the custom_json is associated.
+     * - A `category id` is a unique identifier for a
+     * particular category.
      */
     categoryUid: string;
     body: CatalogPlatformModel.ApplicationCategoryJson;
@@ -1273,7 +1277,7 @@ type UpdateCollectionParam = {
     body: CatalogPlatformModel.UpdateCollection;
 };
 type UpdateDefaultSortParam = {
-    body: CatalogPlatformModel.DefaultKeyRequestSchema;
+    body: CatalogPlatformModel.DefaultKeyRequest;
 };
 type UpdateGroupConfigurationParam = {
     /**
@@ -1302,7 +1306,7 @@ type UpdateListingConfigurationParam = {
     body: CatalogPlatformModel.AppConfigurationsSort;
 };
 type UpdateSearchConfigurationParam = {
-    body: CatalogPlatformModel.UpdateSearchConfigurationRequestSchema;
+    body: CatalogPlatformModel.UpdateSearchConfigurationRequest;
 };
 type UpdateSearchKeywordsParam = {
     /**