@gofynd/fdk-client-javascript 1.4.12-beta.1 → 1.4.13

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

@@ -193,7 +193,7 @@ 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
+ * @property {string} [q] - Search query with brand name. Use this parameter to
  *   search brands by brand name.
  */
 /**
@@ -201,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.
@@ -219,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
@@ -228,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
@@ -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
@@ -358,12 +358,14 @@ export = CatalogPlatformApplicationValidator;
  */
 /**
  * @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
  */
 /**
@@ -924,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;
@@ -934,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;
     /**
@@ -948,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;
@@ -975,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;
 };
@@ -992,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;
 };
@@ -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;
 };
@@ -1217,14 +1219,16 @@ type UpdateAllowSingleParam = {
 };
 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;

package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js

@@ -223,7 +223,7 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
  *   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.
  */
 
@@ -232,12 +232,12 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
  * @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.
@@ -251,8 +251,8 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
  *   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.
  */
 
 /**
@@ -261,8 +261,8 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
  *   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.
  */
 
 /**
@@ -302,7 +302,7 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
 
 /**
  * @typedef GetCatalogInsightsParam
- * @property {string} [brand] - Brand slug
+ * @property {string} [brand] - Brand slug that is to be searched.
  */
 
 /**
@@ -310,7 +310,7 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
  * @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
  */
 
 /**
@@ -413,13 +413,15 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
 
 /**
  * @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
  */
 
@@ -934,7 +936,7 @@ class CatalogPlatformApplicationValidator {
   /** @returns {UpdateAppBrandParam} */
   static updateAppBrand() {
     return Joi.object({
-      brandUid: Joi.string().allow("").required(),
+      brandUid: Joi.number().required(),
       body: CatalogPlatformModel.ApplicationBrandJson().required(),
     }).required();
   }

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

@@ -98,12 +98,12 @@ declare class Catalog {
      * @param {CatalogPlatformValidator.CreateProductParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
+     * @returns {Promise<CatalogPlatformModel.SuccessResponseObject>} - Success response
      * @name createProduct
      * @summary: Create product
      * @description: Users can create a product using this API, associating it with the provided company ID - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createProduct/).
      */
-    createProduct({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse1>;
+    createProduct({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseObject>;
     /**
      * @param {CatalogPlatformValidator.CreateProductAssetsInBulkParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`

package/sdk/platform/Catalog/CatalogPlatformClient.js

@@ -743,7 +743,7 @@ class Catalog {
    * @param {CatalogPlatformValidator.CreateProductParam} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
+   * @returns {Promise<CatalogPlatformModel.SuccessResponseObject>} - Success response
    * @name createProduct
    * @summary: Create product
    * @description: Users can create a product using this API, associating it with the provided company ID - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createProduct/).
@@ -799,7 +799,7 @@ class Catalog {
 
     const {
       error: res_error,
-    } = CatalogPlatformModel.SuccessResponse1().validate(responseData, {
+    } = CatalogPlatformModel.SuccessResponseObject().validate(responseData, {
       abortEarly: false,
       allowUnknown: true,
     });