@gofynd/fdk-client-javascript 1.4.15-beta.13 → 1.4.15-beta.15

package/sdk/platform/Configuration/ConfigurationPlatformClient.js

@@ -18,10 +18,11 @@ class Configuration {
    * @param {ConfigurationPlatformValidator.CreateApplicationParam} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<ConfigurationPlatformModel.CreateAppResponse>} - Success response
+   * @returns {Promise<ConfigurationPlatformModel.CreateAppResponseSchema>} -
+   *   Success response
    * @name createApplication
    * @summary: Create sales channel
-   * @description: Generate and add a new sales channel. sales channels are sales channel websites which can be configured, personalized and customized. Use this API to create a new sales channel in the current company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/createApplication/).
+   * @description: Generate and add a new sales channel. sales channels are sales channel websites which can be configured, personalized and customized. Use this API to create a new sales channel in the current company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/createApplication/).
    */
   async createApplication(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -76,10 +77,10 @@ class Configuration {
 
     const {
       error: res_error,
-    } = ConfigurationPlatformModel.CreateAppResponse().validate(responseData, {
-      abortEarly: false,
-      allowUnknown: true,
-    });
+    } = ConfigurationPlatformModel.CreateAppResponseSchema().validate(
+      responseData,
+      { abortEarly: false, allowUnknown: true }
+    );
 
     if (res_error) {
       if (this.config.options.strictResponseCheck === true) {
@@ -99,11 +100,12 @@ class Configuration {
    * @param {ConfigurationPlatformValidator.GetApplicationsParam} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<ConfigurationPlatformModel.ApplicationsResponse>} -
-   *   Success response
+   * @returns {Promise<ConfigurationPlatformModel.ApplicationsResponseSchema>}
+   *   - Success response
+   *
    * @name getApplications
    * @summary: List sales channel stores
-   * @description: Retrieve a list of available sales channels. sales channels are sales channel websites which can be configured, personalized and customised. Use this API to fetch a list of sales channels created within a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getApplications/).
+   * @description: Retrieve a list of available sales channels. sales channels are sales channel websites which can be configured, personalized and customised. Use this API to fetch a list of sales channels created within a company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/getApplications/).
    */
   async getApplications(
     { pageNo, pageSize, q, requestHeaders } = { requestHeaders: {} },
@@ -163,7 +165,7 @@ class Configuration {
 
     const {
       error: res_error,
-    } = ConfigurationPlatformModel.ApplicationsResponse().validate(
+    } = ConfigurationPlatformModel.ApplicationsResponseSchema().validate(
       responseData,
       { abortEarly: false, allowUnknown: true }
     );
@@ -182,15 +184,45 @@ class Configuration {
     return response;
   }
 
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {number} [arg.pageSize] -
+   * @param {string} [arg.q] - Search param by name or domain
+   * @returns {Paginator<ConfigurationPlatformModel.ApplicationsResponseSchema>}
+   * @summary: List sales channel stores
+   * @description: Retrieve a list of available sales channels. sales channels are sales channel websites which can be configured, personalized and customised. Use this API to fetch a list of sales channels created within a company.
+   */
+  getApplicationsPaginator({ pageSize, q } = {}) {
+    const paginator = new Paginator();
+    const callback = async () => {
+      const pageId = paginator.nextId;
+      const pageNo = paginator.pageNo;
+      const pageType = "number";
+      const data = await this.getApplications({
+        pageNo: pageNo,
+        pageSize: pageSize,
+        q: q,
+      });
+      paginator.setPaginator({
+        hasNext: data.page.has_next ? true : false,
+        nextId: data.page.next_id,
+      });
+      return data;
+    };
+    paginator.setCallback(callback.bind(this));
+    return paginator;
+  }
+
   /**
    * @param {ConfigurationPlatformValidator.GetBrandsByCompanyParam} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<ConfigurationPlatformModel.BrandsByCompanyResponse>} -
-   *   Success response
+   * @returns {Promise<ConfigurationPlatformModel.BrandsByCompanyResponseSchema>}
+   *   - Success response
+   *
    * @name getBrandsByCompany
    * @summary: List brands by company
-   * @description: Retrieve all the brands added in a company. Get all the brand names, along with URLs of their logo, banner, and portrait image. can be searched on brand_name. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getBrandsByCompany/).
+   * @description: Retrieve all the brands added in a company. Get all the brand names, along with URLs of their logo, banner, and portrait image. can be searched on brand_name. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/getBrandsByCompany/).
    */
   async getBrandsByCompany(
     { q, requestHeaders } = { requestHeaders: {} },
@@ -246,7 +278,7 @@ class Configuration {
 
     const {
       error: res_error,
-    } = ConfigurationPlatformModel.BrandsByCompanyResponse().validate(
+    } = ConfigurationPlatformModel.BrandsByCompanyResponseSchema().validate(
       responseData,
       { abortEarly: false, allowUnknown: true }
     );
@@ -269,11 +301,12 @@ class Configuration {
    * @param {ConfigurationPlatformValidator.GetCompanyByBrandsParam} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<ConfigurationPlatformModel.CompanyByBrandsResponse>} -
-   *   Success response
+   * @returns {Promise<ConfigurationPlatformModel.CompanyByBrandsResponseSchema>}
+   *   - Success response
+   *
    * @name getCompanyByBrands
    * @summary: List companies by brand
-   * @description: Retrieve a paginated list of companies associated with specific brands. Can be searched using the brand ID and company name - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getCompanyByBrands/).
+   * @description: Retrieve a paginated list of companies associated with specific brands. Can be searched using the brand ID and company name - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/getCompanyByBrands/).
    */
   async getCompanyByBrands(
     { body, pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
@@ -334,7 +367,7 @@ class Configuration {
 
     const {
       error: res_error,
-    } = ConfigurationPlatformModel.CompanyByBrandsResponse().validate(
+    } = ConfigurationPlatformModel.CompanyByBrandsResponseSchema().validate(
       responseData,
       { abortEarly: false, allowUnknown: true }
     );
@@ -357,11 +390,12 @@ class Configuration {
    * @param {ConfigurationPlatformValidator.GetCurrenciesParam} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<ConfigurationPlatformModel.CurrenciesResponse>} -
-   *   Success response
+   * @returns {Promise<ConfigurationPlatformModel.CurrenciesResponseSchema>}
+   *   - Success response
+   *
    * @name getCurrencies
    * @summary: List currencies
-   * @description: Retrieve a list of available currencies. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getCurrencies/).
+   * @description: Retrieve a list of available currencies. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/getCurrencies/).
    */
   async getCurrencies(
     { requestHeaders } = { requestHeaders: {} },
@@ -410,10 +444,10 @@ class Configuration {
 
     const {
       error: res_error,
-    } = ConfigurationPlatformModel.CurrenciesResponse().validate(responseData, {
-      abortEarly: false,
-      allowUnknown: true,
-    });
+    } = ConfigurationPlatformModel.CurrenciesResponseSchema().validate(
+      responseData,
+      { abortEarly: false, allowUnknown: true }
+    );
 
     if (res_error) {
       if (this.config.options.strictResponseCheck === true) {
@@ -429,16 +463,113 @@ class Configuration {
     return response;
   }
 
+  /**
+   * @param {ConfigurationPlatformValidator.GetCurrencyExchangeRatesParam} arg
+   *   - Arg object
+   *
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../PlatformAPIClient").Options} - Options
+   * @returns {Promise<ConfigurationPlatformModel.CurrencyExchangeResponseV2>}
+   *   - Success response
+   *
+   * @name getCurrencyExchangeRates
+   * @summary: Get currency exchange rates
+   * @description: Retrieve a list of currency exchange rates, relative to a provided currency. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/getCurrencyExchangeRates/).
+   */
+  async getCurrencyExchangeRates(
+    {
+      currencyCode,
+      exchangeCurrencyCode,
+      exchangeCountryCode,
+      requestHeaders,
+    } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const {
+      error,
+    } = ConfigurationPlatformValidator.getCurrencyExchangeRates().validate(
+      {
+        currencyCode,
+        exchangeCurrencyCode,
+        exchangeCountryCode,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = ConfigurationPlatformValidator.getCurrencyExchangeRates().validate(
+      {
+        currencyCode,
+        exchangeCurrencyCode,
+        exchangeCountryCode,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: `Parameter Validation warrnings for platform > Configuration > getCurrencyExchangeRates \n ${warrning}`,
+      });
+    }
+
+    const query_params = {};
+    query_params["currency_code"] = currencyCode;
+    query_params["exchange_currency_code"] = exchangeCurrencyCode;
+    query_params["exchange_country_code"] = exchangeCountryCode;
+
+    const xHeaders = {};
+
+    const response = await PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/configuration/v2.0/company/${this.config.companyId}/currency-exchange`,
+      query_params,
+      undefined,
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = ConfigurationPlatformModel.CurrencyExchangeResponseV2().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 > Configuration > getCurrencyExchangeRates \n ${res_error}`,
+        });
+      }
+    }
+
+    return response;
+  }
+
   /**
    * @param {ConfigurationPlatformValidator.GetDomainAvailibilityParam} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<ConfigurationPlatformModel.DomainSuggestionsResponse>}
+   * @returns {Promise<ConfigurationPlatformModel.DomainSuggestionsResponseSchema>}
    *   - Success response
    *
    * @name getDomainAvailibility
    * @summary: List suggestion domain
-   * @description: Check the availability of a specific domain. Use this API to check the domain availability before linking it to sales channel. Also sends domain suggestions that are similar to the queried domain. Note - Custom domain search is currently powered by GoDaddy provider. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getDomainAvailibility/).
+   * @description: Check the availability of a specific domain. Use this API to check the domain availability before linking it to sales channel. Also sends domain suggestions that are similar to the queried domain. Note - Custom domain search is currently powered by GoDaddy provider. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/getDomainAvailibility/).
    */
   async getDomainAvailibility(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -493,7 +624,7 @@ class Configuration {
 
     const {
       error: res_error,
-    } = ConfigurationPlatformModel.DomainSuggestionsResponse().validate(
+    } = ConfigurationPlatformModel.DomainSuggestionsResponseSchema().validate(
       responseData,
       { abortEarly: false, allowUnknown: true }
     );
@@ -518,12 +649,12 @@ class Configuration {
    *
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<ConfigurationPlatformModel.OptedApplicationResponse>}
+   * @returns {Promise<ConfigurationPlatformModel.OptedApplicationResponseSchema>}
    *   - Success response
    *
    * @name getOtherSellerApplicationById
    * @summary: Get others sales. channel
-   * @description: Retrieve details of a seller sales channel that was not created within the current company but has opted for the current company's inventory and searched via the sales channel ID of another sales channel - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getOtherSellerApplicationById/).
+   * @description: Retrieve details of a seller sales channel that was not created within the current company but has opted for the current company's inventory and searched via the sales channel ID of another sales channel - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/getOtherSellerApplicationById/).
    */
   async getOtherSellerApplicationById(
     { id, requestHeaders } = { requestHeaders: {} },
@@ -578,7 +709,7 @@ class Configuration {
 
     const {
       error: res_error,
-    } = ConfigurationPlatformModel.OptedApplicationResponse().validate(
+    } = ConfigurationPlatformModel.OptedApplicationResponseSchema().validate(
       responseData,
       { abortEarly: false, allowUnknown: true }
     );
@@ -607,7 +738,7 @@ class Configuration {
    *   Success response
    * @name getOtherSellerApplications
    * @summary: Get other sales channel
-   * @description: Retrieve sales channels of  other sellers. Retrieve all other seller sales channels that were not created within the current company. but have opted for the current company's inventory. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getOtherSellerApplications/).
+   * @description: Retrieve sales channels of  other sellers. Retrieve all other seller sales channels that were not created within the current company. but have opted for the current company's inventory. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/getOtherSellerApplications/).
    */
   async getOtherSellerApplications(
     { pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
@@ -689,11 +820,12 @@ class Configuration {
    * @param {ConfigurationPlatformValidator.GetStoreByBrandsParam} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<ConfigurationPlatformModel.StoreByBrandsResponse>} -
-   *   Success response
+   * @returns {Promise<ConfigurationPlatformModel.StoreByBrandsResponseSchema>}
+   *   - Success response
+   *
    * @name getStoreByBrands
    * @summary: Get store by brands
-   * @description: Retrieve stores associated with specific brands. Retrieve a list of selling locations (stores) by the brands they deal. Store has information about store name, store type, store code, store address, and company detail. filtering can be done on brand id and brand names - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getStoreByBrands/).
+   * @description: Retrieve stores associated with specific brands. Retrieve a list of selling locations (stores) by the brands they deal. Store has information about store name, store type, store code, store address, and company detail. filtering can be done on brand id and brand names - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/getStoreByBrands/).
    */
   async getStoreByBrands(
     { body, pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
@@ -740,7 +872,7 @@ class Configuration {
     const response = await PlatformAPIClient.execute(
       this.config,
       "post",
-      `/service/platform/configuration/v1.0/company/${this.config.companyId}/inventory/stores-by-brands`,
+      `/service/platform/configuration/v2.0/company/${this.config.companyId}/inventory/stores-by-brands`,
       query_params,
       body,
       { ...xHeaders, ...requestHeaders },
@@ -754,7 +886,7 @@ class Configuration {
 
     const {
       error: res_error,
-    } = ConfigurationPlatformModel.StoreByBrandsResponse().validate(
+    } = ConfigurationPlatformModel.StoreByBrandsResponseSchema().validate(
       responseData,
       { abortEarly: false, allowUnknown: true }
     );
@@ -777,11 +909,12 @@ class Configuration {
    * @param {ConfigurationPlatformValidator.OptOutFromApplicationParam} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<ConfigurationPlatformModel.SuccessMessageResponse>} -
-   *   Success response
+   * @returns {Promise<ConfigurationPlatformModel.SuccessMessageResponseSchema>}
+   *   - Success response
+   *
    * @name optOutFromApplication
    * @summary: opt out of marketplaces
-   * @description: This API allows businesses to opt out of sharing their inventory with external seller sales channels. By using this API, companies or stores can prevent specific seller sales channels from fetching their inventory data. This feature is useful for businesses that want to control who  can access their product listings and other inventory information. It helps maintain privacy and control over data distribution, ensuring that sensitive information is only shared with authorized partners. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/optOutFromApplication/).
+   * @description: This API allows businesses to opt out of sharing their inventory with external seller sales channels. By using this API, companies or stores can prevent specific seller sales channels from fetching their inventory data. This feature is useful for businesses that want to control who  can access their product listings and other inventory information. It helps maintain privacy and control over data distribution, ensuring that sensitive information is only shared with authorized partners. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/optOutFromApplication/).
    */
   async optOutFromApplication(
     { id, body, requestHeaders } = { requestHeaders: {} },
@@ -838,7 +971,7 @@ class Configuration {
 
     const {
       error: res_error,
-    } = ConfigurationPlatformModel.SuccessMessageResponse().validate(
+    } = ConfigurationPlatformModel.SuccessMessageResponseSchema().validate(
       responseData,
       { abortEarly: false, allowUnknown: true }
     );