@gofynd/fdk-client-javascript 3.1.0-beta.1 → 3.2.0

package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts

@@ -1,11 +1,7 @@
 export = ConfigurationPlatformValidator;
 /**
  * @typedef CreateApplicationParam
- * @property {ConfigurationPlatformModel.CreateApplicationRequest} body
- */
-/**
- * @typedef CreateCurrencyParam
- * @property {ConfigurationPlatformModel.Currency} body
+ * @property {ConfigurationPlatformModel.CreateApplicationRequestSchema} body
  */
 /**
  * @typedef GetApplicationsParam
@@ -23,29 +19,25 @@ export = ConfigurationPlatformValidator;
  *   set of results. Default value is 1.
  * @property {number} [pageSize] - The number of items to retrieve in each page.
  *   Default value is 10.
- * @property {ConfigurationPlatformModel.CompanyByBrandsRequest} body
+ * @property {ConfigurationPlatformModel.CompanyByBrandsRequestSchema} body
  */
 /** @typedef GetCurrenciesParam */
 /**
- * @typedef GetCurrencyParam
- * @property {string} id - Unique object Id of the curreny
+ * @typedef GetCurrencyExchangeRatesParam
+ * @property {string} [currencyCode] - The 3-letter ISO 4217 code representing
+ *   the base currency for the exchange rates. Defaults to "INR" if not specified.
+ * @property {string} [exchangeCurrencyCode] - A 3-letter ISO 4217 currency code
+ *   for which exchange rates against the base currency are requested.
+ * @property {string} [exchangeCountryCode] - The country code for which
+ *   exchange rates against the base currency are requested.
  */
 /**
  * @typedef GetDomainAvailibilityParam
- * @property {ConfigurationPlatformModel.DomainSuggestionsRequest} body
- */
-/** @typedef GetDomainOptionsParam */
-/**
- * @typedef GetLocationsParam
- * @property {string} [locationType] - Provide location type to query on.
- *   Possible values : country, state, city
- * @property {string} [id] - Field is optional when location_type is country. If
- *   querying for state, provide id of country. If querying for city, provide id
- *   of state.
+ * @property {ConfigurationPlatformModel.DomainSuggestionsRequestSchema} body
  */
 /**
  * @typedef GetOtherSellerApplicationByIdParam
- * @property {string} appId - Application Id
+ * @property {string} id - Application Id
  */
 /**
  * @typedef GetOtherSellerApplicationsParam
@@ -60,28 +52,17 @@ export = ConfigurationPlatformValidator;
  *   set of results. Default value is 1.
  * @property {number} [pageSize] - The number of items to retrieve in each page.
  *   Default value is 10.
- * @property {ConfigurationPlatformModel.StoreByBrandsRequest} body
- */
-/**
- * @typedef GetStoresForACompanyParam
- * @property {number} company - Numeric ID allotted to a business account on Fynd Platform
+ * @property {ConfigurationPlatformModel.StoreByBrandsRequestSchema} body
  */
 /**
  * @typedef OptOutFromApplicationParam
- * @property {string} appId - Alphanumeric ID allotted to an application (sales
+ * @property {string} id - Alphanumeric ID allotted to an application (sales
  *   channel website) created within a business account.
  * @property {ConfigurationPlatformModel.OptOutInventory} body
  */
-/**
- * @typedef UpdateCurrencyParam
- * @property {string} id - Unique object Id of the curreny
- * @property {ConfigurationPlatformModel.Currency} body
- */
 declare class ConfigurationPlatformValidator {
     /** @returns {CreateApplicationParam} */
     static createApplication(): CreateApplicationParam;
-    /** @returns {CreateCurrencyParam} */
-    static createCurrency(): CreateCurrencyParam;
     /** @returns {GetApplicationsParam} */
     static getApplications(): GetApplicationsParam;
     /** @returns {GetBrandsByCompanyParam} */
@@ -90,35 +71,24 @@ declare class ConfigurationPlatformValidator {
     static getCompanyByBrands(): GetCompanyByBrandsParam;
     /** @returns {GetCurrenciesParam} */
     static getCurrencies(): any;
-    /** @returns {GetCurrencyParam} */
-    static getCurrency(): GetCurrencyParam;
+    /** @returns {GetCurrencyExchangeRatesParam} */
+    static getCurrencyExchangeRates(): GetCurrencyExchangeRatesParam;
     /** @returns {GetDomainAvailibilityParam} */
     static getDomainAvailibility(): GetDomainAvailibilityParam;
-    /** @returns {GetDomainOptionsParam} */
-    static getDomainOptions(): any;
-    /** @returns {GetLocationsParam} */
-    static getLocations(): GetLocationsParam;
     /** @returns {GetOtherSellerApplicationByIdParam} */
     static getOtherSellerApplicationById(): GetOtherSellerApplicationByIdParam;
     /** @returns {GetOtherSellerApplicationsParam} */
     static getOtherSellerApplications(): GetOtherSellerApplicationsParam;
     /** @returns {GetStoreByBrandsParam} */
     static getStoreByBrands(): GetStoreByBrandsParam;
-    /** @returns {GetStoresForACompanyParam} */
-    static getStoresForACompany(): GetStoresForACompanyParam;
     /** @returns {OptOutFromApplicationParam} */
     static optOutFromApplication(): OptOutFromApplicationParam;
-    /** @returns {UpdateCurrencyParam} */
-    static updateCurrency(): UpdateCurrencyParam;
 }
 declare namespace ConfigurationPlatformValidator {
-    export { CreateApplicationParam, CreateCurrencyParam, GetApplicationsParam, GetBrandsByCompanyParam, GetCompanyByBrandsParam, GetCurrenciesParam, GetCurrencyParam, GetDomainAvailibilityParam, GetDomainOptionsParam, GetLocationsParam, GetOtherSellerApplicationByIdParam, GetOtherSellerApplicationsParam, GetStoreByBrandsParam, GetStoresForACompanyParam, OptOutFromApplicationParam, UpdateCurrencyParam };
+    export { CreateApplicationParam, GetApplicationsParam, GetBrandsByCompanyParam, GetCompanyByBrandsParam, GetCurrenciesParam, GetCurrencyExchangeRatesParam, GetDomainAvailibilityParam, GetOtherSellerApplicationByIdParam, GetOtherSellerApplicationsParam, GetStoreByBrandsParam, OptOutFromApplicationParam };
 }
 type CreateApplicationParam = {
-    body: ConfigurationPlatformModel.CreateApplicationRequest;
-};
-type CreateCurrencyParam = {
-    body: ConfigurationPlatformModel.Currency;
+    body: ConfigurationPlatformModel.CreateApplicationRequestSchema;
 };
 type GetApplicationsParam = {
     pageNo?: number;
@@ -145,35 +115,33 @@ type GetCompanyByBrandsParam = {
      * Default value is 10.
      */
     pageSize?: number;
-    body: ConfigurationPlatformModel.CompanyByBrandsRequest;
+    body: ConfigurationPlatformModel.CompanyByBrandsRequestSchema;
 };
-type GetCurrencyParam = {
+type GetCurrencyExchangeRatesParam = {
     /**
-     * - Unique object Id of the curreny
+     * - The 3-letter ISO 4217 code representing
+     * the base currency for the exchange rates. Defaults to "INR" if not specified.
      */
-    id: string;
-};
-type GetDomainAvailibilityParam = {
-    body: ConfigurationPlatformModel.DomainSuggestionsRequest;
-};
-type GetLocationsParam = {
+    currencyCode?: string;
     /**
-     * - Provide location type to query on.
-     * Possible values : country, state, city
+     * - A 3-letter ISO 4217 currency code
+     * for which exchange rates against the base currency are requested.
      */
-    locationType?: string;
+    exchangeCurrencyCode?: string;
     /**
-     * - Field is optional when location_type is country. If
-     * querying for state, provide id of country. If querying for city, provide id
-     * of state.
+     * - The country code for which
+     * exchange rates against the base currency are requested.
      */
-    id?: string;
+    exchangeCountryCode?: string;
+};
+type GetDomainAvailibilityParam = {
+    body: ConfigurationPlatformModel.DomainSuggestionsRequestSchema;
 };
 type GetOtherSellerApplicationByIdParam = {
     /**
      * - Application Id
      */
-    appId: string;
+    id: string;
 };
 type GetOtherSellerApplicationsParam = {
     /**
@@ -198,29 +166,15 @@ type GetStoreByBrandsParam = {
      * Default value is 10.
      */
     pageSize?: number;
-    body: ConfigurationPlatformModel.StoreByBrandsRequest;
-};
-type GetStoresForACompanyParam = {
-    /**
-     * - Numeric ID allotted to a business account on Fynd Platform
-     */
-    company: number;
+    body: ConfigurationPlatformModel.StoreByBrandsRequestSchema;
 };
 type OptOutFromApplicationParam = {
     /**
      * - Alphanumeric ID allotted to an application (sales
      * channel website) created within a business account.
      */
-    appId: string;
-    body: ConfigurationPlatformModel.OptOutInventory;
-};
-type UpdateCurrencyParam = {
-    /**
-     * - Unique object Id of the curreny
-     */
     id: string;
-    body: ConfigurationPlatformModel.Currency;
+    body: ConfigurationPlatformModel.OptOutInventory;
 };
 type GetCurrenciesParam = any;
-type GetDomainOptionsParam = any;
 import ConfigurationPlatformModel = require("./ConfigurationPlatformModel");

package/sdk/platform/Configuration/ConfigurationPlatformValidator.js

@@ -4,12 +4,7 @@ const ConfigurationPlatformModel = require("./ConfigurationPlatformModel");
 
 /**
  * @typedef CreateApplicationParam
- * @property {ConfigurationPlatformModel.CreateApplicationRequest} body
- */
-
-/**
- * @typedef CreateCurrencyParam
- * @property {ConfigurationPlatformModel.Currency} body
+ * @property {ConfigurationPlatformModel.CreateApplicationRequestSchema} body
  */
 
 /**
@@ -30,35 +25,29 @@ const ConfigurationPlatformModel = require("./ConfigurationPlatformModel");
  *   set of results. Default value is 1.
  * @property {number} [pageSize] - The number of items to retrieve in each page.
  *   Default value is 10.
- * @property {ConfigurationPlatformModel.CompanyByBrandsRequest} body
+ * @property {ConfigurationPlatformModel.CompanyByBrandsRequestSchema} body
  */
 
 /** @typedef GetCurrenciesParam */
 
 /**
- * @typedef GetCurrencyParam
- * @property {string} id - Unique object Id of the curreny
+ * @typedef GetCurrencyExchangeRatesParam
+ * @property {string} [currencyCode] - The 3-letter ISO 4217 code representing
+ *   the base currency for the exchange rates. Defaults to "INR" if not specified.
+ * @property {string} [exchangeCurrencyCode] - A 3-letter ISO 4217 currency code
+ *   for which exchange rates against the base currency are requested.
+ * @property {string} [exchangeCountryCode] - The country code for which
+ *   exchange rates against the base currency are requested.
  */
 
 /**
  * @typedef GetDomainAvailibilityParam
- * @property {ConfigurationPlatformModel.DomainSuggestionsRequest} body
- */
-
-/** @typedef GetDomainOptionsParam */
-
-/**
- * @typedef GetLocationsParam
- * @property {string} [locationType] - Provide location type to query on.
- *   Possible values : country, state, city
- * @property {string} [id] - Field is optional when location_type is country. If
- *   querying for state, provide id of country. If querying for city, provide id
- *   of state.
+ * @property {ConfigurationPlatformModel.DomainSuggestionsRequestSchema} body
  */
 
 /**
  * @typedef GetOtherSellerApplicationByIdParam
- * @property {string} appId - Application Id
+ * @property {string} id - Application Id
  */
 
 /**
@@ -75,39 +64,21 @@ const ConfigurationPlatformModel = require("./ConfigurationPlatformModel");
  *   set of results. Default value is 1.
  * @property {number} [pageSize] - The number of items to retrieve in each page.
  *   Default value is 10.
- * @property {ConfigurationPlatformModel.StoreByBrandsRequest} body
- */
-
-/**
- * @typedef GetStoresForACompanyParam
- * @property {number} company - Numeric ID allotted to a business account on Fynd Platform
+ * @property {ConfigurationPlatformModel.StoreByBrandsRequestSchema} body
  */
 
 /**
  * @typedef OptOutFromApplicationParam
- * @property {string} appId - Alphanumeric ID allotted to an application (sales
+ * @property {string} id - Alphanumeric ID allotted to an application (sales
  *   channel website) created within a business account.
  * @property {ConfigurationPlatformModel.OptOutInventory} body
  */
 
-/**
- * @typedef UpdateCurrencyParam
- * @property {string} id - Unique object Id of the curreny
- * @property {ConfigurationPlatformModel.Currency} body
- */
-
 class ConfigurationPlatformValidator {
   /** @returns {CreateApplicationParam} */
   static createApplication() {
     return Joi.object({
-      body: ConfigurationPlatformModel.CreateApplicationRequest().required(),
-    }).required();
-  }
-
-  /** @returns {CreateCurrencyParam} */
-  static createCurrency() {
-    return Joi.object({
-      body: ConfigurationPlatformModel.Currency().required(),
+      body: ConfigurationPlatformModel.CreateApplicationRequestSchema().required(),
     }).required();
   }
 
@@ -132,7 +103,7 @@ class ConfigurationPlatformValidator {
     return Joi.object({
       pageNo: Joi.number(),
       pageSize: Joi.number(),
-      body: ConfigurationPlatformModel.CompanyByBrandsRequest().required(),
+      body: ConfigurationPlatformModel.CompanyByBrandsRequestSchema().required(),
     }).required();
   }
 
@@ -141,37 +112,26 @@ class ConfigurationPlatformValidator {
     return Joi.object({}).required();
   }
 
-  /** @returns {GetCurrencyParam} */
-  static getCurrency() {
+  /** @returns {GetCurrencyExchangeRatesParam} */
+  static getCurrencyExchangeRates() {
     return Joi.object({
-      id: Joi.string().allow("").required(),
+      currencyCode: Joi.string().allow(""),
+      exchangeCurrencyCode: Joi.string().allow(""),
+      exchangeCountryCode: Joi.string().allow(""),
     }).required();
   }
 
   /** @returns {GetDomainAvailibilityParam} */
   static getDomainAvailibility() {
     return Joi.object({
-      body: ConfigurationPlatformModel.DomainSuggestionsRequest().required(),
-    }).required();
-  }
-
-  /** @returns {GetDomainOptionsParam} */
-  static getDomainOptions() {
-    return Joi.object({}).required();
-  }
-
-  /** @returns {GetLocationsParam} */
-  static getLocations() {
-    return Joi.object({
-      locationType: Joi.string().allow(""),
-      id: Joi.string().allow(""),
+      body: ConfigurationPlatformModel.DomainSuggestionsRequestSchema().required(),
     }).required();
   }
 
   /** @returns {GetOtherSellerApplicationByIdParam} */
   static getOtherSellerApplicationById() {
     return Joi.object({
-      appId: Joi.string().allow("").required(),
+      id: Joi.string().allow("").required(),
     }).required();
   }
 
@@ -188,30 +148,15 @@ class ConfigurationPlatformValidator {
     return Joi.object({
       pageNo: Joi.number(),
       pageSize: Joi.number(),
-      body: ConfigurationPlatformModel.StoreByBrandsRequest().required(),
-    }).required();
-  }
-
-  /** @returns {GetStoresForACompanyParam} */
-  static getStoresForACompany() {
-    return Joi.object({
-      company: Joi.number().required(),
+      body: ConfigurationPlatformModel.StoreByBrandsRequestSchema().required(),
     }).required();
   }
 
   /** @returns {OptOutFromApplicationParam} */
   static optOutFromApplication() {
-    return Joi.object({
-      appId: Joi.string().allow("").required(),
-      body: ConfigurationPlatformModel.OptOutInventory().required(),
-    }).required();
-  }
-
-  /** @returns {UpdateCurrencyParam} */
-  static updateCurrency() {
     return Joi.object({
       id: Joi.string().allow("").required(),
-      body: ConfigurationPlatformModel.Currency().required(),
+      body: ConfigurationPlatformModel.OptOutInventory().required(),
     }).required();
   }
 }