@gofynd/fdk-client-javascript 3.6.0 → 3.8.0

package/README.md

@@ -234,7 +234,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: 3.6.0' --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: 3.8.0' --header 'x-fp-date: 20230222T115108Z' --header 'x-fp-signature: v1.1:1e3ab3b02b5bc626e3c32a37ee844266ade02bbcbaafc28fc7a0e46a76a7a1a8'
 Active Theme: Emerge
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gofynd/fdk-client-javascript",
-  "version": "3.6.0",
+  "version": "3.8.0",
   "description": "",
   "main": "index.js",
   "scripts": {

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

@@ -861,7 +861,7 @@ declare class Catalog {
      * @description: List all product ids a user has wishlisted or is following for sales channel.
      *  - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getFollowedProducts/).
      */
-    getFollowedProducts({ userId, pageId, requestHeaders }?: CatalogPlatformApplicationValidator.GetFollowedProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.FollowedProducts>;
+    getFollowedProducts({ userId, pageId, pageSize, requestHeaders }?: CatalogPlatformApplicationValidator.GetFollowedProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.FollowedProducts>;
     /**
      * @param {CatalogPlatformApplicationValidator.GetGroupConfigurationsParam} arg
      *   - Arg object

package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js

@@ -4591,7 +4591,7 @@ class Catalog {
    *  - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getFollowedProducts/).
    */
   async getFollowedProducts(
-    { userId, pageId, requestHeaders } = { requestHeaders: {} },
+    { userId, pageId, pageSize, requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
     const {
@@ -4600,6 +4600,7 @@ class Catalog {
       {
         userId,
         pageId,
+        pageSize,
       },
       { abortEarly: false, allowUnknown: true }
     );
@@ -4614,6 +4615,7 @@ class Catalog {
       {
         userId,
         pageId,
+        pageSize,
       },
       { abortEarly: false, allowUnknown: false }
     );
@@ -4626,6 +4628,7 @@ class Catalog {
 
     const query_params = {};
     query_params["page_id"] = pageId;
+    query_params["page_size"] = pageSize;
 
     const response = await PlatformAPIClient.execute(
       this.config,

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

@@ -341,6 +341,7 @@ export = CatalogPlatformApplicationValidator;
  * @property {string} userId - User ID to fetch the followed list
  * @property {string} [pageId] - The identifier used to retrieve the next set of
  *   results. This parameter follows cursor-based pagination.
+ * @property {number} [pageSize] - Number of items per page
  */
 /**
  * @typedef GetGroupConfigurationsParam
@@ -1246,6 +1247,10 @@ type GetFollowedProductsParam = {
      * results. This parameter follows cursor-based pagination.
      */
     pageId?: string;
+    /**
+     * - Number of items per page
+     */
+    pageSize?: number;
 };
 type GetGroupConfigurationsParam = {
     /**

package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js

@@ -390,6 +390,7 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
  * @property {string} userId - User ID to fetch the followed list
  * @property {string} [pageId] - The identifier used to retrieve the next set of
  *   results. This parameter follows cursor-based pagination.
+ * @property {number} [pageSize] - Number of items per page
  */
 
 /**
@@ -935,6 +936,7 @@ class CatalogPlatformApplicationValidator {
     return Joi.object({
       userId: Joi.string().allow("").required(),
       pageId: Joi.string().allow(""),
+      pageSize: Joi.number(),
     }).required();
   }
 

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

@@ -176,7 +176,7 @@ declare class Catalog {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<CatalogPlatformModel.CreateTax>} - Success response
      * @name createTax
-     * @summary: Create a new Tax Rule and immediately generate its corresponding live version.
+     * @summary: Create Tax Rule
      * @description: Create a tax rule and its version for under a specific company. This also creates a live version of the rule - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/createTax/).
      */
     createTax({ body, requestHeaders }?: CatalogPlatformValidator.CreateTaxParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CreateTax>;
@@ -184,12 +184,16 @@ declare class Catalog {
      * @param {CatalogPlatformValidator.CreateTaxComponentNameParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<CatalogPlatformModel.TaxComponentRes>} - Success response
+     * @returns {Promise<CatalogPlatformModel.TaxComponentName>} - Success response
      * @name createTaxComponentName
-     * @summary: Create component names
-     * @description: Create component names for a product. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/createTaxComponentName/).
+     * @summary: Create tax component name
+     * @description: Tax components represent different types of taxes that may be applied to products or transactions,
+     * such as sales tax, value-added tax (VAT), goods and services tax, consumption tax,
+     * or other region-specific taxation systems. This endpoint allows companies to define and
+     * customize the names of tax components according to their local tax regulations and business requirements.
+     *  - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/createTaxComponentName/).
      */
-    createTaxComponentName({ body, requestHeaders }?: CatalogPlatformValidator.CreateTaxComponentNameParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.TaxComponentRes>;
+    createTaxComponentName({ body, requestHeaders }?: CatalogPlatformValidator.CreateTaxComponentNameParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.TaxComponentName>;
     /**
      * @param {CatalogPlatformValidator.CreateTaxVersionParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -1149,7 +1153,7 @@ declare class Catalog {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<CatalogPlatformModel.TaxRule>} - Success response
      * @name updateTaxRule
-     * @summary: Update a Tax Rule for a Product
+     * @summary: Update Tax Rule
      * @description: Update an existing tax rule under a specific company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/updateTaxRule/).
      */
     updateTaxRule({ ruleId, body, requestHeaders }?: CatalogPlatformValidator.UpdateTaxRuleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.TaxRule>;
@@ -1163,16 +1167,6 @@ declare class Catalog {
      * @description: Updates a tax rule using the provided rule_id. You can update any part of a scheduled version but only tax name of live version can be updated. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/updateTaxVersion/).
      */
     updateTaxVersion({ ruleId, versionId, body, requestHeaders }?: CatalogPlatformValidator.UpdateTaxVersionParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.TaxVersion>;
-    /**
-     * @param {CatalogPlatformValidator.UploadBulkProductsParam} arg - Arg object
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<CatalogPlatformModel.BulkResponseSchema>} - Success response
-     * @name uploadBulkProducts
-     * @summary: Upload bulk products
-     * @description: Users can create multiple products by providing the required information needed for product creation in a CSV  or Excel file format. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/uploadBulkProducts/).
-     */
-    uploadBulkProducts({ department, productType, body, requestHeaders }?: CatalogPlatformValidator.UploadBulkProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkResponseSchema>;
     /**
      * @param {CatalogPlatformValidator.ValidateProductGlobalTemplateParam} arg
      *   - Arg object

package/sdk/platform/Catalog/CatalogPlatformClient.js

@@ -1310,7 +1310,7 @@ class Catalog {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<CatalogPlatformModel.CreateTax>} - Success response
    * @name createTax
-   * @summary: Create a new Tax Rule and immediately generate its corresponding live version.
+   * @summary: Create Tax Rule
    * @description: Create a tax rule and its version for under a specific company. This also creates a live version of the rule - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/createTax/).
    */
   async createTax(
@@ -1385,10 +1385,14 @@ class Catalog {
    * @param {CatalogPlatformValidator.CreateTaxComponentNameParam} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<CatalogPlatformModel.TaxComponentRes>} - Success response
+   * @returns {Promise<CatalogPlatformModel.TaxComponentName>} - Success response
    * @name createTaxComponentName
-   * @summary: Create component names
-   * @description: Create component names for a product. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/createTaxComponentName/).
+   * @summary: Create tax component name
+   * @description: Tax components represent different types of taxes that may be applied to products or transactions,
+   * such as sales tax, value-added tax (VAT), goods and services tax, consumption tax,
+   * or other region-specific taxation systems. This endpoint allows companies to define and
+   * customize the names of tax components according to their local tax regulations and business requirements.
+   *  - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/createTaxComponentName/).
    */
   async createTaxComponentName(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -1443,7 +1447,7 @@ class Catalog {
 
     const {
       error: res_error,
-    } = CatalogPlatformModel.TaxComponentRes().validate(responseData, {
+    } = CatalogPlatformModel.TaxComponentName().validate(responseData, {
       abortEarly: false,
       allowUnknown: true,
     });
@@ -7585,7 +7589,7 @@ class Catalog {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<CatalogPlatformModel.TaxRule>} - Success response
    * @name updateTaxRule
-   * @summary: Update a Tax Rule for a Product
+   * @summary: Update Tax Rule
    * @description: Update an existing tax rule under a specific company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/updateTaxRule/).
    */
   async updateTaxRule(
@@ -7745,91 +7749,6 @@ class Catalog {
     return response;
   }
 
-  /**
-   * @param {CatalogPlatformValidator.UploadBulkProductsParam} arg - Arg object
-   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-   * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<CatalogPlatformModel.BulkResponseSchema>} - Success response
-   * @name uploadBulkProducts
-   * @summary: Upload bulk products
-   * @description: Users can create multiple products by providing the required information needed for product creation in a CSV  or Excel file format. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/uploadBulkProducts/).
-   */
-  async uploadBulkProducts(
-    { department, productType, body, requestHeaders } = { requestHeaders: {} },
-    { responseHeaders } = { responseHeaders: false }
-  ) {
-    const { error } = CatalogPlatformValidator.uploadBulkProducts().validate(
-      {
-        department,
-        productType,
-        body,
-      },
-      { abortEarly: false, allowUnknown: true }
-    );
-    if (error) {
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
-    // Showing warrnings if extra unknown parameters are found
-    const {
-      error: warrning,
-    } = CatalogPlatformValidator.uploadBulkProducts().validate(
-      {
-        department,
-        productType,
-        body,
-      },
-      { abortEarly: false, allowUnknown: false }
-    );
-    if (warrning) {
-      Logger({
-        level: "WARN",
-        message: `Parameter Validation warrnings for platform > Catalog > uploadBulkProducts \n ${warrning}`,
-      });
-    }
-
-    const query_params = {};
-    query_params["department"] = department;
-    query_params["product_type"] = productType;
-
-    const xHeaders = {};
-
-    const response = await PlatformAPIClient.execute(
-      this.config,
-      "post",
-      `/service/platform/catalog/v3.0/company/${this.config.companyId}/products/bulk`,
-      query_params,
-      body,
-      { ...xHeaders, ...requestHeaders },
-      { responseHeaders }
-    );
-
-    let responseData = response;
-    if (responseHeaders) {
-      responseData = response[0];
-    }
-
-    const {
-      error: res_error,
-    } = CatalogPlatformModel.BulkResponseSchema().validate(responseData, {
-      abortEarly: false,
-      allowUnknown: true,
-    });
-
-    if (res_error) {
-      if (this.config.options.strictResponseCheck === true) {
-        return Promise.reject(new FDKResponseValidationError(res_error));
-      } else {
-        Logger({
-          level: "WARN",
-          message: `Response Validation Warnings for platform > Catalog > uploadBulkProducts \n ${res_error}`,
-        });
-      }
-    }
-
-    return response;
-  }
-
   /**
    * @param {CatalogPlatformValidator.ValidateProductGlobalTemplateParam} arg
    *   - Arg object