@gofynd/fdk-client-javascript 1.6.3 → 3.0.0-beta.1

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

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

package/sdk/platform/Configuration/ConfigurationPlatformValidator.js

@@ -4,7 +4,12 @@ const ConfigurationPlatformModel = require("./ConfigurationPlatformModel");
 
 /**
  * @typedef CreateApplicationParam
- * @property {ConfigurationPlatformModel.CreateApplicationRequestSchema} body
+ * @property {ConfigurationPlatformModel.CreateApplicationRequest} body
+ */
+
+/**
+ * @typedef CreateCurrencyParam
+ * @property {ConfigurationPlatformModel.Currency} body
  */
 
 /**
@@ -25,29 +30,35 @@ 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.CompanyByBrandsRequestSchema} body
+ * @property {ConfigurationPlatformModel.CompanyByBrandsRequest} body
  */
 
 /** @typedef GetCurrenciesParam */
 
 /**
- * @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 GetCurrencyParam
+ * @property {string} id - Unique object Id of the curreny
  */
 
 /**
  * @typedef GetDomainAvailibilityParam
- * @property {ConfigurationPlatformModel.DomainSuggestionsRequestSchema} body
+ * @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.
  */
 
 /**
  * @typedef GetOtherSellerApplicationByIdParam
- * @property {string} id - Application Id
+ * @property {string} appId - Application Id
  */
 
 /**
@@ -64,21 +75,39 @@ 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.StoreByBrandsRequestSchema} body
+ * @property {ConfigurationPlatformModel.StoreByBrandsRequest} body
+ */
+
+/**
+ * @typedef GetStoresForACompanyParam
+ * @property {number} company - Numeric ID allotted to a business account on Fynd Platform
  */
 
 /**
  * @typedef OptOutFromApplicationParam
- * @property {string} id - Alphanumeric ID allotted to an application (sales
+ * @property {string} appId - 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.CreateApplicationRequestSchema().required(),
+      body: ConfigurationPlatformModel.CreateApplicationRequest().required(),
+    }).required();
+  }
+
+  /** @returns {CreateCurrencyParam} */
+  static createCurrency() {
+    return Joi.object({
+      body: ConfigurationPlatformModel.Currency().required(),
     }).required();
   }
 
@@ -103,7 +132,7 @@ class ConfigurationPlatformValidator {
     return Joi.object({
       pageNo: Joi.number(),
       pageSize: Joi.number(),
-      body: ConfigurationPlatformModel.CompanyByBrandsRequestSchema().required(),
+      body: ConfigurationPlatformModel.CompanyByBrandsRequest().required(),
     }).required();
   }
 
@@ -112,26 +141,37 @@ class ConfigurationPlatformValidator {
     return Joi.object({}).required();
   }
 
-  /** @returns {GetCurrencyExchangeRatesParam} */
-  static getCurrencyExchangeRates() {
+  /** @returns {GetCurrencyParam} */
+  static getCurrency() {
     return Joi.object({
-      currencyCode: Joi.string().allow(""),
-      exchangeCurrencyCode: Joi.string().allow(""),
-      exchangeCountryCode: Joi.string().allow(""),
+      id: Joi.string().allow("").required(),
     }).required();
   }
 
   /** @returns {GetDomainAvailibilityParam} */
   static getDomainAvailibility() {
     return Joi.object({
-      body: ConfigurationPlatformModel.DomainSuggestionsRequestSchema().required(),
+      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(""),
     }).required();
   }
 
   /** @returns {GetOtherSellerApplicationByIdParam} */
   static getOtherSellerApplicationById() {
     return Joi.object({
-      id: Joi.string().allow("").required(),
+      appId: Joi.string().allow("").required(),
     }).required();
   }
 
@@ -148,17 +188,32 @@ class ConfigurationPlatformValidator {
     return Joi.object({
       pageNo: Joi.number(),
       pageSize: Joi.number(),
-      body: ConfigurationPlatformModel.StoreByBrandsRequestSchema().required(),
+      body: ConfigurationPlatformModel.StoreByBrandsRequest().required(),
+    }).required();
+  }
+
+  /** @returns {GetStoresForACompanyParam} */
+  static getStoresForACompany() {
+    return Joi.object({
+      company: Joi.number().required(),
     }).required();
   }
 
   /** @returns {OptOutFromApplicationParam} */
   static optOutFromApplication() {
     return Joi.object({
-      id: Joi.string().allow("").required(),
+      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(),
+    }).required();
+  }
 }
 
 module.exports = ConfigurationPlatformValidator;