[Auto Generated] v1.4.15-beta.1

gofynd · Oct 18, 2024 · 675ebe7 · 675ebe7
1 parent 2d7da1b
commit 675ebe7
Show file tree

Hide file tree

Showing 29 changed files with 25,662 additions and 4,488 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
diff --git a/README.md b/README.md
@@ -237,7 +237,7 @@ console.log("Active Theme: ", response.information.name);
 The above code will log the curl command in the console
 
 ```bash
-curl --request GET "https://api.fynd.com/service/application/theme/v1.0/applied-theme" --header 'authorization: Bearer <authorization-token>' --header 'x-fp-sdk-version: 1.4.12-beta.1' --header 'x-fp-date: 20230222T115108Z' --header 'x-fp-signature: v1.1:1e3ab3b02b5bc626e3c32a37ee844266ade02bbcbaafc28fc7a0e46a76a7a1a8'
+curl --request GET "https://api.fynd.com/service/application/theme/v1.0/applied-theme" --header 'authorization: Bearer <authorization-token>' --header 'x-fp-sdk-version: v1.4.15-beta.1' --header 'x-fp-date: 20230222T115108Z' --header 'x-fp-signature: v1.1:1e3ab3b02b5bc626e3c32a37ee844266ade02bbcbaafc28fc7a0e46a76a7a1a8'
 Active Theme: Emerge
 ```
 

diff --git a/dist/application.js b/dist/application.js
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@gofynd/fdk-client-javascript",
-  "version": "1.4.12-beta.1",
+  "version": "v1.4.15-beta.1",
   "description": "",
   "main": "index.js",
   "scripts": {

diff --git a/sdk/application/Order/OrderApplicationModel.d.ts b/sdk/application/Order/OrderApplicationModel.d.ts
@@ -168,7 +168,12 @@ export = OrderApplicationModel;
 /**
  * @typedef Item
  * @property {string[]} [image] - An array of URLs pointing to images of the item.
- * @property {string[]} [l1_categories] - An array of level 1 categories the item belongs.
+ * @property {string[]} [l1_categories] - An array of level 1 categories to
+ *   which the item belongs.
+ * @property {string[]} [l2_category] - An array of level 2 categories to which
+ *   the item belongs.
+ * @property {number} [l2_category_id] - ID representing the level 2 category
+ *   classification of the item
  * @property {ItemBrand} [brand]
  * @property {string} [seller_identifier] - The identifier for the seller .
  * @property {string} [code] - The code or SKU of the item.
@@ -1086,9 +1091,20 @@ type Item = {
      */
     image?: string[];
     /**
-     * - An array of level 1 categories the item belongs.
+     * - An array of level 1 categories to
+     * which the item belongs.
      */
     l1_categories?: string[];
+    /**
+     * - An array of level 2 categories to which
+     * the item belongs.
+     */
+    l2_category?: string[];
+    /**
+     * - ID representing the level 2 category
+     * classification of the item
+     */
+    l2_category_id?: number;
     brand?: ItemBrand;
     /**
      * - The identifier for the seller .

diff --git a/sdk/application/Order/OrderApplicationModel.js b/sdk/application/Order/OrderApplicationModel.js
@@ -185,7 +185,12 @@ const Joi = require("joi");
 /**
  * @typedef Item
  * @property {string[]} [image] - An array of URLs pointing to images of the item.
- * @property {string[]} [l1_categories] - An array of level 1 categories the item belongs.
+ * @property {string[]} [l1_categories] - An array of level 1 categories to
+ *   which the item belongs.
+ * @property {string[]} [l2_category] - An array of level 2 categories to which
+ *   the item belongs.
+ * @property {number} [l2_category_id] - ID representing the level 2 category
+ *   classification of the item
  * @property {ItemBrand} [brand]
  * @property {string} [seller_identifier] - The identifier for the seller .
  * @property {string} [code] - The code or SKU of the item.
@@ -888,6 +893,8 @@ class OrderApplicationModel {
     return Joi.object({
       image: Joi.array().items(Joi.string().allow("")),
       l1_categories: Joi.array().items(Joi.string().allow("")),
+      l2_category: Joi.array().items(Joi.string().allow("")),
+      l2_category_id: Joi.number(),
       brand: OrderApplicationModel.ItemBrand(),
       seller_identifier: Joi.string().allow(""),
       code: Joi.string().allow(""),

diff --git a/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts b/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts
diff --git a/sdk/platform/Catalog/CatalogPlatformApplicationClient.js b/sdk/platform/Catalog/CatalogPlatformApplicationClient.js
@@ -106,7 +106,7 @@ class Catalog {
    *
    * @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 createAppCategoryReturnConfiguration
    * @summary: Create return configuration
    * @description: Create Category level sales channel Return Configuration setttings - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createAppCategoryReturnConfiguration/).
@@ -162,7 +162,7 @@ class Catalog {
 
     const {
       error: res_error,
-    } = CatalogPlatformModel.SuccessResponse1().validate(responseData, {
+    } = CatalogPlatformModel.SuccessResponseObject().validate(responseData, {
       abortEarly: false,
       allowUnknown: true,
     });
@@ -187,7 +187,7 @@ class Catalog {
    *
    * @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 createAppReturnConfiguration
    * @summary: Create product return configuration
    * @description: This allows you to configure all return-related settings, such as is_returnable and return window etc. for sales channel level - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createAppReturnConfiguration/).
@@ -243,7 +243,7 @@ class Catalog {
 
     const {
       error: res_error,
-    } = CatalogPlatformModel.SuccessResponse1().validate(responseData, {
+    } = CatalogPlatformModel.SuccessResponseObject().validate(responseData, {
       abortEarly: false,
       allowUnknown: true,
     });
@@ -2649,7 +2649,8 @@ class Catalog {
    *
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<CatalogPlatformModel.BrandListingResponse>} - Success response
+   * @returns {Promise<CatalogPlatformModel.ApplicationBrandListingSchema>} -
+   *   Success response
    * @name getApplicationBrandListing
    * @summary: List sales channel brands
    * @description: Retrieve brand listings related to the sales channel. A brand is the name under which a product is being sold - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getApplicationBrandListing/).
@@ -2712,10 +2713,10 @@ class Catalog {
 
     const {
       error: res_error,
-    } = CatalogPlatformModel.BrandListingResponse().validate(responseData, {
-      abortEarly: false,
-      allowUnknown: true,
-    });
+    } = CatalogPlatformModel.ApplicationBrandListingSchema().validate(
+      responseData,
+      { abortEarly: false, allowUnknown: true }
+    );
 
     if (res_error) {
       if (this.config.options.strictResponseCheck === true) {
@@ -2739,9 +2740,9 @@ class Catalog {
    *   identifier for a particular sale channel.
    * @param {number} [arg.pageSize] - Number of items to retrieve in each
    *   page. Default is 12.
-   * @param {string} [arg.q] - Search query with brand name.Use this parameter
-   *   to search brands by brand name.
-   * @returns {Paginator<CatalogPlatformModel.BrandListingResponse>}
+   * @param {string} [arg.q] - Search query with brand name. Use this
+   *   parameter to search brands by brand name.
+   * @returns {Paginator<CatalogPlatformModel.ApplicationBrandListingSchema>}
    * @summary: List sales channel brands
    * @description: Retrieve brand listings related to the sales channel. A brand is the name under which a product is being sold
    */
@@ -2782,7 +2783,7 @@ class Catalog {
    * @returns {Promise<CatalogPlatformModel.BrandListingResponse>} - Success response
    * @name getApplicationBrands
    * @summary: List brands
-   * @description: List all the brands, and have search capabilities on brand uid, name etc - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getApplicationBrands/).
+   * @description: List all the brands. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getApplicationBrands/).
    */
   async getApplicationBrands(
     { department, pageNo, pageSize, q, brandId, requestHeaders } = {
@@ -2878,16 +2879,16 @@ class Catalog {
    * @param {string} [arg.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
+   *   from the "v1.0/departments/" API
    * @param {number} [arg.pageSize] - Number of items to retrieve in each
    *   page. Default is 12.
-   * @param {string} [arg.q] - Search query with brand name.Use this parameter
-   *   to search brands by brand name.
+   * @param {string} [arg.q] - Search query with brand name. Use this
+   *   parameter to search brands by brand name.
    * @param {number[]} [arg.brandId] - Helps to sort the brands list on the
    *   basis of uid list.
    * @returns {Paginator<CatalogPlatformModel.BrandListingResponse>}
    * @summary: List brands
-   * @description: List all the brands, and have search capabilities on brand uid, name etc
+   * @description: List all the brands.
    */
   getApplicationBrandsPaginator({
     companyId,
@@ -2927,7 +2928,9 @@ class Catalog {
    *
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<CatalogPlatformModel.BrandListingResponse>} - Success response
+   * @returns {Promise<CatalogPlatformModel.ApplicationCategoryListingSchema>}
+   *   - Success response
+   *
    * @name getApplicationCategoryListing
    * @summary: List sales channel categories
    * @description: Retrieve category listings related to the sales channel , with the ability to filter results based on department ,category names etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getApplicationCategoryListing/).
@@ -2995,10 +2998,10 @@ class Catalog {
 
     const {
       error: res_error,
-    } = CatalogPlatformModel.BrandListingResponse().validate(responseData, {
-      abortEarly: false,
-      allowUnknown: true,
-    });
+    } = CatalogPlatformModel.ApplicationCategoryListingSchema().validate(
+      responseData,
+      { abortEarly: false, allowUnknown: true }
+    );
 
     if (res_error) {
       if (this.config.options.strictResponseCheck === true) {
@@ -3024,9 +3027,9 @@ class Catalog {
    *   identifier for a particular department.
    * @param {number} [arg.pageSize] - Number of items to retrieve in each
    *   page. Default is 12.
-   * @param {string} [arg.q] - Search query with brand name.Use this parameter
-   *   to search brands by brand name.
-   * @returns {Paginator<CatalogPlatformModel.BrandListingResponse>}
+   * @param {string} [arg.q] - A search query string. Use this parameter to
+   *   filter results based on a keyword or specific value.
+   * @returns {Paginator<CatalogPlatformModel.ApplicationCategoryListingSchema>}
    * @summary: List sales channel categories
    * @description: Retrieve category listings related to the sales channel , with the ability to filter results based on department ,category names etc.
    */
@@ -3158,8 +3161,8 @@ class Catalog {
    *   identifier for a particular sale channel.
    * @param {number} [arg.pageSize] - Number of items to retrieve in each
    *   page. Default is 12.
-   * @param {string} [arg.q] - Search query with brand name.Use this parameter
-   *   to search department by name.
+   * @param {string} [arg.q] - A search query string. Use this parameter to
+   *   filter results based on a keyword or specific value.
    * @returns {Paginator<CatalogPlatformModel.ApplicationDepartmentListingResponse>}
    * @summary: List sales channel departments
    * @description: Retrieve department listings related to the sales channel. Departments are used to categorize similar products, and you can filter the results based on department names
@@ -5025,7 +5028,7 @@ class Catalog {
    * @param {CatalogPlatformApplicationValidator.UpdateAppBrandParam} 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 updateAppBrand
    * @summary: Update sales channel brand
    * @description: Modify data associated to the brand for that particular sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppBrand/).
@@ -5083,7 +5086,7 @@ class Catalog {
 
     const {
       error: res_error,
-    } = CatalogPlatformModel.SuccessResponse1().validate(responseData, {
+    } = CatalogPlatformModel.SuccessResponseObject().validate(responseData, {
       abortEarly: false,
       allowUnknown: true,
     });
@@ -5108,7 +5111,7 @@ class Catalog {
    *
    * @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 updateAppCategory
    * @summary: Update sales channel category
    * @description: Modify category data related to the sales channel . - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppCategory/).
@@ -5166,7 +5169,7 @@ class Catalog {
 
     const {
       error: res_error,
-    } = CatalogPlatformModel.SuccessResponse1().validate(responseData, {
+    } = CatalogPlatformModel.SuccessResponseObject().validate(responseData, {
       abortEarly: false,
       allowUnknown: true,
     });
@@ -5272,7 +5275,7 @@ class Catalog {
    *
    * @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 updateAppDepartment
    * @summary: Update sales channel department
    * @description: Modify department data associated to the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppDepartment/).
@@ -5330,7 +5333,7 @@ class Catalog {
 
     const {
       error: res_error,
-    } = CatalogPlatformModel.SuccessResponse1().validate(responseData, {
+    } = CatalogPlatformModel.SuccessResponseObject().validate(responseData, {
       abortEarly: false,
       allowUnknown: true,
     });
@@ -5355,7 +5358,7 @@ class Catalog {
    *
    * @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 updateAppLocation
    * @summary: Update sales channel location
    * @description: Modify location data related to the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppLocation/).
@@ -5413,7 +5416,7 @@ class Catalog {
 
     const {
       error: res_error,
-    } = CatalogPlatformModel.SuccessResponse1().validate(responseData, {
+    } = CatalogPlatformModel.SuccessResponseObject().validate(responseData, {
       abortEarly: false,
       allowUnknown: true,
     });
@@ -5436,7 +5439,7 @@ class Catalog {
    * @param {CatalogPlatformApplicationValidator.UpdateAppProductParam} 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 updateAppProduct
    * @summary: Update sales channel product
    * @description: Allows to update data associated to a item by its item_id for an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppProduct/).
@@ -5494,7 +5497,7 @@ class Catalog {
 
     const {
       error: res_error,
-    } = CatalogPlatformModel.SuccessResponse1().validate(responseData, {
+    } = CatalogPlatformModel.SuccessResponseObject().validate(responseData, {
       abortEarly: false,
       allowUnknown: true,
     });
@@ -5519,7 +5522,7 @@ class Catalog {
    *
    * @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 updateAppReturnConfiguration
    * @summary: Update product return configuration
    * @description: Update Return configuration level set for an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppReturnConfiguration/).
@@ -5575,7 +5578,7 @@ class Catalog {
 
     const {
       error: res_error,
-    } = CatalogPlatformModel.SuccessResponse1().validate(responseData, {
+    } = CatalogPlatformModel.SuccessResponseObject().validate(responseData, {
       abortEarly: false,
       allowUnknown: true,
     });