@gofynd/fdk-client-javascript 1.3.3-beta.2 → 1.3.3

package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js

@@ -639,6 +639,85 @@ class Catalog {
     return response;
   }
 
+  /**
+   * @param {CatalogPlatformApplicationValidator.CreateSearchConfigurationParam} arg
+   *   - Arg object
+   *
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../PlatformAPIClient").Options} - Options
+   * @returns {Promise<CatalogPlatformModel.CreateSearchConfigurationResponse>}
+   *   - Success response
+   *
+   * @name createSearchConfiguration
+   * @summary: Update search configuration for an application
+   * @description: This view allows you to modify searchable attributes for an application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createSearchConfiguration/).
+   */
+  async createSearchConfiguration(
+    { body, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const {
+      error,
+    } = CatalogPlatformApplicationValidator.createSearchConfiguration().validate(
+      {
+        body,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = CatalogPlatformApplicationValidator.createSearchConfiguration().validate(
+      {
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: `Parameter Validation warrnings for platform > Catalog > createSearchConfiguration \n ${warrning}`,
+      });
+    }
+
+    const query_params = {};
+
+    const response = await PlatformAPIClient.execute(
+      this.config,
+      "post",
+      `/service/platform/catalog/v1.0/company/${this.config.companyId}/application/${this.applicationId}/search/configuration/`,
+      query_params,
+      body,
+      requestHeaders,
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = CatalogPlatformModel.CreateSearchConfigurationResponse().validate(
+      responseData,
+      { abortEarly: false, allowUnknown: false }
+    );
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: `Response Validation Warnnings for platform > Catalog > createSearchConfiguration \n ${res_error}`,
+      });
+    }
+
+    return response;
+  }
+
   /**
    * @param {CatalogPlatformApplicationValidator.DeleteAutocompleteKeywordParam} arg
    *   - Arg object
@@ -949,6 +1028,81 @@ class Catalog {
     return response;
   }
 
+  /**
+   * @param {CatalogPlatformApplicationValidator.DeleteSearchConfigurationParam} arg
+   *   - Arg object
+   *
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../PlatformAPIClient").Options} - Options
+   * @returns {Promise<CatalogPlatformModel.DeleteSearchConfigurationResponse>}
+   *   - Success response
+   *
+   * @name deleteSearchConfiguration
+   * @summary: Delete search configuration for an application
+   * @description: This view allows you to reset search config for an application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteSearchConfiguration/).
+   */
+  async deleteSearchConfiguration(
+    { requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const {
+      error,
+    } = CatalogPlatformApplicationValidator.deleteSearchConfiguration().validate(
+      {},
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = CatalogPlatformApplicationValidator.deleteSearchConfiguration().validate(
+      {},
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: `Parameter Validation warrnings for platform > Catalog > deleteSearchConfiguration \n ${warrning}`,
+      });
+    }
+
+    const query_params = {};
+
+    const response = await PlatformAPIClient.execute(
+      this.config,
+      "delete",
+      `/service/platform/catalog/v1.0/company/${this.config.companyId}/application/${this.applicationId}/search/configuration/`,
+      query_params,
+      undefined,
+      requestHeaders,
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = CatalogPlatformModel.DeleteSearchConfigurationResponse().validate(
+      responseData,
+      { abortEarly: false, allowUnknown: false }
+    );
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: `Response Validation Warnnings for platform > Catalog > deleteSearchConfiguration \n ${res_error}`,
+      });
+    }
+
+    return response;
+  }
+
   /**
    * @param {CatalogPlatformApplicationValidator.DeleteSearchKeywordsParam} arg
    *   - Arg object
@@ -3645,6 +3799,81 @@ class Catalog {
     return response;
   }
 
+  /**
+   * @param {CatalogPlatformApplicationValidator.GetSearchConfigurationParam} arg
+   *   - Arg object
+   *
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../PlatformAPIClient").Options} - Options
+   * @returns {Promise<CatalogPlatformModel.GetSearchConfigurationResponse>}
+   *   - Success response
+   *
+   * @name getSearchConfiguration
+   * @summary: List search configuration for an application
+   * @description: This view allows you to add/modify searchable attributes for an application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getSearchConfiguration/).
+   */
+  async getSearchConfiguration(
+    { requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const {
+      error,
+    } = CatalogPlatformApplicationValidator.getSearchConfiguration().validate(
+      {},
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = CatalogPlatformApplicationValidator.getSearchConfiguration().validate(
+      {},
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: `Parameter Validation warrnings for platform > Catalog > getSearchConfiguration \n ${warrning}`,
+      });
+    }
+
+    const query_params = {};
+
+    const response = await PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/catalog/v1.0/company/${this.config.companyId}/application/${this.applicationId}/search/configuration/`,
+      query_params,
+      undefined,
+      requestHeaders,
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = CatalogPlatformModel.GetSearchConfigurationResponse().validate(
+      responseData,
+      { abortEarly: false, allowUnknown: false }
+    );
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: `Response Validation Warnnings for platform > Catalog > getSearchConfiguration \n ${res_error}`,
+      });
+    }
+
+    return response;
+  }
+
   /**
    * @param {CatalogPlatformApplicationValidator.GetSearchKeywordsParam} arg
    *   - Arg object
@@ -4587,6 +4816,85 @@ class Catalog {
     return response;
   }
 
+  /**
+   * @param {CatalogPlatformApplicationValidator.UpdateSearchConfigurationParam} arg
+   *   - Arg object
+   *
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../PlatformAPIClient").Options} - Options
+   * @returns {Promise<CatalogPlatformModel.UpdateSearchConfigurationResponse>}
+   *   - Success response
+   *
+   * @name updateSearchConfiguration
+   * @summary: Update search configuration for an application
+   * @description: This view allows you to modify searchable attributes for an application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateSearchConfiguration/).
+   */
+  async updateSearchConfiguration(
+    { body, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const {
+      error,
+    } = CatalogPlatformApplicationValidator.updateSearchConfiguration().validate(
+      {
+        body,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = CatalogPlatformApplicationValidator.updateSearchConfiguration().validate(
+      {
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: `Parameter Validation warrnings for platform > Catalog > updateSearchConfiguration \n ${warrning}`,
+      });
+    }
+
+    const query_params = {};
+
+    const response = await PlatformAPIClient.execute(
+      this.config,
+      "put",
+      `/service/platform/catalog/v1.0/company/${this.config.companyId}/application/${this.applicationId}/search/configuration/`,
+      query_params,
+      body,
+      requestHeaders,
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = CatalogPlatformModel.UpdateSearchConfigurationResponse().validate(
+      responseData,
+      { abortEarly: false, allowUnknown: false }
+    );
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: `Response Validation Warnnings for platform > Catalog > updateSearchConfiguration \n ${res_error}`,
+      });
+    }
+
+    return response;
+  }
+
   /**
    * @param {CatalogPlatformApplicationValidator.UpdateSearchKeywordsParam} arg
    *   - Arg object

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

@@ -37,6 +37,10 @@ export = CatalogPlatformApplicationValidator;
  *   particular listing configuration type.
  * @property {CatalogPlatformModel.AppConfigurationsSort} body
  */
+/**
+ * @typedef CreateSearchConfigurationParam
+ * @property {CatalogPlatformModel.CreateSearchConfigurationRequest} body
+ */
 /**
  * @typedef DeleteAutocompleteKeywordParam
  * @property {string} id - A `id` is a unique identifier for a particular
@@ -60,6 +64,7 @@ export = CatalogPlatformApplicationValidator;
  * @property {string} configId - A `config_id` is a unique identifier of a
  *   particular configuration.
  */
+/** @typedef DeleteSearchConfigurationParam */
 /**
  * @typedef DeleteSearchKeywordsParam
  * @property {string} id - A `id` is a unique identifier for a particular
@@ -279,6 +284,7 @@ export = CatalogPlatformApplicationValidator;
  *   **v1.0/products/**
  */
 /** @typedef GetQueryFiltersParam */
+/** @typedef GetSearchConfigurationParam */
 /**
  * @typedef GetSearchKeywordsParam
  * @property {string} id - A `id` is a unique identifier for a particular
@@ -345,6 +351,10 @@ export = CatalogPlatformApplicationValidator;
  *   particular configuration.
  * @property {CatalogPlatformModel.AppConfigurationsSort} body
  */
+/**
+ * @typedef UpdateSearchConfigurationParam
+ * @property {CatalogPlatformModel.UpdateSearchConfigurationRequest} body
+ */
 /**
  * @typedef UpdateSearchKeywordsParam
  * @property {string} id - A `id` is a unique identifier for a particular
@@ -368,6 +378,8 @@ declare class CatalogPlatformApplicationValidator {
     static createGroupConfiguration(): CreateGroupConfigurationParam;
     /** @returns {CreateListingConfigurationParam} */
     static createListingConfiguration(): CreateListingConfigurationParam;
+    /** @returns {CreateSearchConfigurationParam} */
+    static createSearchConfiguration(): CreateSearchConfigurationParam;
     /** @returns {DeleteAutocompleteKeywordParam} */
     static deleteAutocompleteKeyword(): DeleteAutocompleteKeywordParam;
     /** @returns {DeleteCollectionParam} */
@@ -376,6 +388,8 @@ declare class CatalogPlatformApplicationValidator {
     static deleteGroupConfiguration(): DeleteGroupConfigurationParam;
     /** @returns {DeleteListingConfigurationParam} */
     static deleteListingConfiguration(): DeleteListingConfigurationParam;
+    /** @returns {DeleteSearchConfigurationParam} */
+    static deleteSearchConfiguration(): any;
     /** @returns {DeleteSearchKeywordsParam} */
     static deleteSearchKeywords(): DeleteSearchKeywordsParam;
     /** @returns {GetAllCollectionsParam} */
@@ -432,6 +446,8 @@ declare class CatalogPlatformApplicationValidator {
     static getProductDetailBySlug(): GetProductDetailBySlugParam;
     /** @returns {GetQueryFiltersParam} */
     static getQueryFilters(): any;
+    /** @returns {GetSearchConfigurationParam} */
+    static getSearchConfiguration(): any;
     /** @returns {GetSearchKeywordsParam} */
     static getSearchKeywords(): GetSearchKeywordsParam;
     /** @returns {UpdateAllowSingleParam} */
@@ -456,11 +472,13 @@ declare class CatalogPlatformApplicationValidator {
     static updateGroupConfiguration(): UpdateGroupConfigurationParam;
     /** @returns {UpdateListingConfigurationParam} */
     static updateListingConfiguration(): UpdateListingConfigurationParam;
+    /** @returns {UpdateSearchConfigurationParam} */
+    static updateSearchConfiguration(): UpdateSearchConfigurationParam;
     /** @returns {UpdateSearchKeywordsParam} */
     static updateSearchKeywords(): UpdateSearchKeywordsParam;
 }
 declare namespace CatalogPlatformApplicationValidator {
-    export { AddCollectionItemsParam, CreateCollectionParam, CreateConfigurationByTypeParam, CreateConfigurationProductListingParam, CreateCustomAutocompleteRuleParam, CreateCustomKeywordParam, CreateGroupConfigurationParam, CreateListingConfigurationParam, DeleteAutocompleteKeywordParam, DeleteCollectionParam, DeleteGroupConfigurationParam, DeleteListingConfigurationParam, DeleteSearchKeywordsParam, GetAllCollectionsParam, GetAllSearchKeywordParam, GetAppInventoryParam, GetAppLocationsParam, GetAppProductParam, GetAppProductsParam, GetAppicationProductsParam, GetApplicationBrandListingParam, GetApplicationBrandsParam, GetApplicationCategoryListingParam, GetApplicationDepartmentListingParam, GetAutocompleteConfigParam, GetAutocompleteKeywordDetailParam, GetCatalogConfigurationParam, GetCatalogInsightsParam, GetCategoriesParam, GetCollectionDetailParam, GetCollectionItemsParam, GetConfigurationByTypeParam, GetConfigurationMetadataParam, GetConfigurationsParam, GetDepartmentsParam, GetDiscountedInventoryBySizeIdentifierParam, GetGroupConfigurationsParam, GetListingConfigurationsParam, GetProductDetailBySlugParam, GetQueryFiltersParam, GetSearchKeywordsParam, UpdateAllowSingleParam, UpdateAppBrandParam, UpdateAppCategoryParam, UpdateAppDepartmentParam, UpdateAppLocationParam, UpdateAppProductParam, UpdateAutocompleteKeywordParam, UpdateCollectionParam, UpdateDefaultSortParam, UpdateGroupConfigurationParam, UpdateListingConfigurationParam, UpdateSearchKeywordsParam };
+    export { AddCollectionItemsParam, CreateCollectionParam, CreateConfigurationByTypeParam, CreateConfigurationProductListingParam, CreateCustomAutocompleteRuleParam, CreateCustomKeywordParam, CreateGroupConfigurationParam, CreateListingConfigurationParam, CreateSearchConfigurationParam, DeleteAutocompleteKeywordParam, DeleteCollectionParam, DeleteGroupConfigurationParam, DeleteListingConfigurationParam, DeleteSearchConfigurationParam, DeleteSearchKeywordsParam, GetAllCollectionsParam, GetAllSearchKeywordParam, GetAppInventoryParam, GetAppLocationsParam, GetAppProductParam, GetAppProductsParam, GetAppicationProductsParam, GetApplicationBrandListingParam, GetApplicationBrandsParam, GetApplicationCategoryListingParam, GetApplicationDepartmentListingParam, GetAutocompleteConfigParam, GetAutocompleteKeywordDetailParam, GetCatalogConfigurationParam, GetCatalogInsightsParam, GetCategoriesParam, GetCollectionDetailParam, GetCollectionItemsParam, GetConfigurationByTypeParam, GetConfigurationMetadataParam, GetConfigurationsParam, GetDepartmentsParam, GetDiscountedInventoryBySizeIdentifierParam, GetGroupConfigurationsParam, GetListingConfigurationsParam, GetProductDetailBySlugParam, GetQueryFiltersParam, GetSearchConfigurationParam, GetSearchKeywordsParam, UpdateAllowSingleParam, UpdateAppBrandParam, UpdateAppCategoryParam, UpdateAppDepartmentParam, UpdateAppLocationParam, UpdateAppProductParam, UpdateAutocompleteKeywordParam, UpdateCollectionParam, UpdateDefaultSortParam, UpdateGroupConfigurationParam, UpdateListingConfigurationParam, UpdateSearchConfigurationParam, UpdateSearchKeywordsParam };
 }
 type AddCollectionItemsParam = {
     /**
@@ -504,6 +522,9 @@ type CreateListingConfigurationParam = {
     configType: string;
     body: CatalogPlatformModel.AppConfigurationsSort;
 };
+type CreateSearchConfigurationParam = {
+    body: CatalogPlatformModel.CreateSearchConfigurationRequest;
+};
 type DeleteAutocompleteKeywordParam = {
     /**
      * - A `id` is a unique identifier for a particular
@@ -1071,6 +1092,9 @@ type UpdateListingConfigurationParam = {
     configId: string;
     body: CatalogPlatformModel.AppConfigurationsSort;
 };
+type UpdateSearchConfigurationParam = {
+    body: CatalogPlatformModel.UpdateSearchConfigurationRequest;
+};
 type UpdateSearchKeywordsParam = {
     /**
      * - A `id` is a unique identifier for a particular
@@ -1079,10 +1103,12 @@ type UpdateSearchKeywordsParam = {
     id: string;
     body: CatalogPlatformModel.CreateSearchKeyword;
 };
+type DeleteSearchConfigurationParam = any;
 type GetAllSearchKeywordParam = any;
 type GetAutocompleteConfigParam = any;
 type GetCatalogConfigurationParam = any;
 type GetConfigurationsParam = any;
 type GetDepartmentsParam = any;
 type GetQueryFiltersParam = any;
+type GetSearchConfigurationParam = any;
 import CatalogPlatformModel = require("./CatalogPlatformModel");

package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js

@@ -48,6 +48,11 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
  * @property {CatalogPlatformModel.AppConfigurationsSort} body
  */
 
+/**
+ * @typedef CreateSearchConfigurationParam
+ * @property {CatalogPlatformModel.CreateSearchConfigurationRequest} body
+ */
+
 /**
  * @typedef DeleteAutocompleteKeywordParam
  * @property {string} id - A `id` is a unique identifier for a particular
@@ -75,6 +80,8 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
  *   particular configuration.
  */
 
+/** @typedef DeleteSearchConfigurationParam */
+
 /**
  * @typedef DeleteSearchKeywordsParam
  * @property {string} id - A `id` is a unique identifier for a particular
@@ -322,6 +329,8 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
 
 /** @typedef GetQueryFiltersParam */
 
+/** @typedef GetSearchConfigurationParam */
+
 /**
  * @typedef GetSearchKeywordsParam
  * @property {string} id - A `id` is a unique identifier for a particular
@@ -400,6 +409,11 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
  * @property {CatalogPlatformModel.AppConfigurationsSort} body
  */
 
+/**
+ * @typedef UpdateSearchConfigurationParam
+ * @property {CatalogPlatformModel.UpdateSearchConfigurationRequest} body
+ */
+
 /**
  * @typedef UpdateSearchKeywordsParam
  * @property {string} id - A `id` is a unique identifier for a particular
@@ -468,6 +482,13 @@ class CatalogPlatformApplicationValidator {
     }).required();
   }
 
+  /** @returns {CreateSearchConfigurationParam} */
+  static createSearchConfiguration() {
+    return Joi.object({
+      body: CatalogPlatformModel.CreateSearchConfigurationRequest().required(),
+    }).required();
+  }
+
   /** @returns {DeleteAutocompleteKeywordParam} */
   static deleteAutocompleteKeyword() {
     return Joi.object({
@@ -498,6 +519,11 @@ class CatalogPlatformApplicationValidator {
     }).required();
   }
 
+  /** @returns {DeleteSearchConfigurationParam} */
+  static deleteSearchConfiguration() {
+    return Joi.object({}).required();
+  }
+
   /** @returns {DeleteSearchKeywordsParam} */
   static deleteSearchKeywords() {
     return Joi.object({
@@ -743,6 +769,11 @@ class CatalogPlatformApplicationValidator {
     return Joi.object({}).required();
   }
 
+  /** @returns {GetSearchConfigurationParam} */
+  static getSearchConfiguration() {
+    return Joi.object({}).required();
+  }
+
   /** @returns {GetSearchKeywordsParam} */
   static getSearchKeywords() {
     return Joi.object({
@@ -838,6 +869,13 @@ class CatalogPlatformApplicationValidator {
     }).required();
   }
 
+  /** @returns {UpdateSearchConfigurationParam} */
+  static updateSearchConfiguration() {
+    return Joi.object({
+      body: CatalogPlatformModel.UpdateSearchConfigurationRequest().required(),
+    }).required();
+  }
+
   /** @returns {UpdateSearchKeywordsParam} */
   static updateSearchKeywords() {
     return Joi.object({

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

@@ -438,7 +438,7 @@ declare class Catalog {
      * @returns {Promise<CatalogPlatformModel.StoreAssignResponse>} - Success response
      * @name getOptimalLocations
      * @summary: Location Reassignment
-     * @description: Location Reassignment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getOptimalLocations/).
+     * @description: - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getOptimalLocations/).
      */
     getOptimalLocations({ body, requestHeaders }?: CatalogPlatformValidator.GetOptimalLocationsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.StoreAssignResponse>;
     /**

package/sdk/platform/Catalog/CatalogPlatformClient.js

@@ -3235,7 +3235,7 @@ class Catalog {
    * @returns {Promise<CatalogPlatformModel.StoreAssignResponse>} - Success response
    * @name getOptimalLocations
    * @summary: Location Reassignment
-   * @description: Location Reassignment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getOptimalLocations/).
+   * @description: - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getOptimalLocations/).
    */
   async getOptimalLocations(
     { body, requestHeaders } = { requestHeaders: {} },