@gofynd/fdk-client-javascript 1.1.6 → 1.3.0

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

@@ -1,21 +1,334 @@
-export = ConfigurationValidator;
-declare class ConfigurationValidator {
-    static createApplication(): any;
-    static getApplications(): any;
-    static getAvailableOptIns(): any;
-    static getBrandsByCompany(): any;
-    static getCompanyByBrands(): any;
+export = ConfigurationPlatformValidator;
+/**
+ * @typedef CreateApplicationParam
+ * @property {ConfigurationPlatformModel.CreateApplicationRequest} body
+ */
+/**
+ * @typedef GetApplicationsParam
+ * @property {number} [pageNo]
+ * @property {number} [pageSize]
+ * @property {string} [q] - Search param by name or domain
+ */
+/**
+ * @typedef GetAvailableOptInsParam
+ * @property {number} [pageNo] - The page number to navigate through the given
+ *   set of results. Default value is 1.
+ * @property {number} [pageSize] - The number of items to retrieve in each page.
+ *   Default value is 10.
+ */
+/**
+ * @typedef GetBrandsByCompanyParam
+ * @property {string} [q] - Search text for brand name
+ */
+/**
+ * @typedef GetCompanyByBrandsParam
+ * @property {number} [pageNo] - The page number to navigate through the given
+ *   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
+ */
+/** @typedef GetCurrenciesParam */
+/**
+ * @typedef GetDomainAvailibilityParam
+ * @property {ConfigurationPlatformModel.DomainSuggestionsRequest} body
+ */
+/**
+ * @typedef GetIntegrationByIdParam
+ * @property {number} id - Integration id
+ */
+/**
+ * @typedef GetIntegrationByLevelIdParam
+ * @property {string} id - Integration ID (24-digit Mongo Object ID)
+ * @property {string} level - Integration level, `store` or `company`
+ * @property {number} uid - Unique identifier of integration level (store/company)
+ */
+/**
+ * @typedef GetIntegrationLevelConfigParam
+ * @property {string} id - Integration ID (24-digit Mongo Object ID)
+ * @property {string} level - Store or company
+ * @property {boolean} [opted] - True means get the opted stores. False means
+ *   get the stores that aren't opted.
+ * @property {boolean} [checkPermission] - Filter on if permissions (for
+ *   inventory/order) are present
+ */
+/**
+ * @typedef GetLevelActiveIntegrationsParam
+ * @property {string} id - Integration ID (24-digit Mongo Object ID)
+ * @property {string} level - Integration level, `store` or `company`
+ * @property {number} uid - Unique identifier of integration level (store/company)
+ */
+/**
+ * @typedef GetOtherSellerApplicationByIdParam
+ * @property {string} id - Application Id
+ */
+/**
+ * @typedef GetOtherSellerApplicationsParam
+ * @property {number} [pageNo] - The page number to navigate through the given
+ *   set of results. Default value is 1.
+ * @property {number} [pageSize] - The number of items to retrieve in each page.
+ *   Default value is 10.
+ */
+/**
+ * @typedef GetSelectedOptInsParam
+ * @property {string} level - Store or company
+ * @property {number} uid - Unique identifier of the selected integration level.
+ * @property {number} [pageNo] - The page number to navigate through the given
+ *   set of results. Default value is 1.
+ * @property {number} [pageSize] - The number of items to retrieve in each page.
+ *   Default value is 10.
+ */
+/**
+ * @typedef GetStoreByBrandsParam
+ * @property {number} [pageNo] - The page number to navigate through the given
+ *   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 OptOutFromApplicationParam
+ * @property {string} id - Alphanumeric ID allotted to an application (sales
+ *   channel website) created within a business account.
+ * @property {ConfigurationPlatformModel.OptOutInventory} body
+ */
+/**
+ * @typedef UpdateLevelIntegrationParam
+ * @property {string} id - Integration ID (24-digit Mongo Object ID)
+ * @property {string} level - Integration level, `store` or `company`
+ * @property {ConfigurationPlatformModel.UpdateIntegrationLevelRequest} body
+ */
+/**
+ * @typedef UpdateLevelUidIntegrationParam
+ * @property {string} id - Integration ID (24-digit Mongo Object ID)
+ * @property {string} level - Integration level, `store` or `company`
+ * @property {number} uid - Unique identifier of integration level (store/company)
+ * @property {ConfigurationPlatformModel.IntegrationLevel} body
+ */
+declare class ConfigurationPlatformValidator {
+    /** @returns {CreateApplicationParam} */
+    static createApplication(): CreateApplicationParam;
+    /** @returns {GetApplicationsParam} */
+    static getApplications(): GetApplicationsParam;
+    /** @returns {GetAvailableOptInsParam} */
+    static getAvailableOptIns(): GetAvailableOptInsParam;
+    /** @returns {GetBrandsByCompanyParam} */
+    static getBrandsByCompany(): GetBrandsByCompanyParam;
+    /** @returns {GetCompanyByBrandsParam} */
+    static getCompanyByBrands(): GetCompanyByBrandsParam;
+    /** @returns {GetCurrenciesParam} */
     static getCurrencies(): any;
-    static getDomainAvailibility(): any;
-    static getIntegrationById(): any;
-    static getIntegrationByLevelId(): any;
-    static getIntegrationLevelConfig(): any;
-    static getLevelActiveIntegrations(): any;
-    static getOtherSellerApplicationById(): any;
-    static getOtherSellerApplications(): any;
-    static getSelectedOptIns(): any;
-    static getStoreByBrands(): any;
-    static optOutFromApplication(): any;
-    static updateLevelIntegration(): any;
-    static updateLevelUidIntegration(): any;
+    /** @returns {GetDomainAvailibilityParam} */
+    static getDomainAvailibility(): GetDomainAvailibilityParam;
+    /** @returns {GetIntegrationByIdParam} */
+    static getIntegrationById(): GetIntegrationByIdParam;
+    /** @returns {GetIntegrationByLevelIdParam} */
+    static getIntegrationByLevelId(): GetIntegrationByLevelIdParam;
+    /** @returns {GetIntegrationLevelConfigParam} */
+    static getIntegrationLevelConfig(): GetIntegrationLevelConfigParam;
+    /** @returns {GetLevelActiveIntegrationsParam} */
+    static getLevelActiveIntegrations(): GetLevelActiveIntegrationsParam;
+    /** @returns {GetOtherSellerApplicationByIdParam} */
+    static getOtherSellerApplicationById(): GetOtherSellerApplicationByIdParam;
+    /** @returns {GetOtherSellerApplicationsParam} */
+    static getOtherSellerApplications(): GetOtherSellerApplicationsParam;
+    /** @returns {GetSelectedOptInsParam} */
+    static getSelectedOptIns(): GetSelectedOptInsParam;
+    /** @returns {GetStoreByBrandsParam} */
+    static getStoreByBrands(): GetStoreByBrandsParam;
+    /** @returns {OptOutFromApplicationParam} */
+    static optOutFromApplication(): OptOutFromApplicationParam;
+    /** @returns {UpdateLevelIntegrationParam} */
+    static updateLevelIntegration(): UpdateLevelIntegrationParam;
+    /** @returns {UpdateLevelUidIntegrationParam} */
+    static updateLevelUidIntegration(): UpdateLevelUidIntegrationParam;
 }
+declare namespace ConfigurationPlatformValidator {
+    export { CreateApplicationParam, GetApplicationsParam, GetAvailableOptInsParam, GetBrandsByCompanyParam, GetCompanyByBrandsParam, GetCurrenciesParam, GetDomainAvailibilityParam, GetIntegrationByIdParam, GetIntegrationByLevelIdParam, GetIntegrationLevelConfigParam, GetLevelActiveIntegrationsParam, GetOtherSellerApplicationByIdParam, GetOtherSellerApplicationsParam, GetSelectedOptInsParam, GetStoreByBrandsParam, OptOutFromApplicationParam, UpdateLevelIntegrationParam, UpdateLevelUidIntegrationParam };
+}
+type CreateApplicationParam = {
+    body: ConfigurationPlatformModel.CreateApplicationRequest;
+};
+type GetApplicationsParam = {
+    pageNo?: number;
+    pageSize?: number;
+    /**
+     * - Search param by name or domain
+     */
+    q?: string;
+};
+type GetAvailableOptInsParam = {
+    /**
+     * - The page number to navigate through the given
+     * set of results. Default value is 1.
+     */
+    pageNo?: number;
+    /**
+     * - The number of items to retrieve in each page.
+     * Default value is 10.
+     */
+    pageSize?: number;
+};
+type GetBrandsByCompanyParam = {
+    /**
+     * - Search text for brand name
+     */
+    q?: string;
+};
+type GetCompanyByBrandsParam = {
+    /**
+     * - The page number to navigate through the given
+     * set of results. Default value is 1.
+     */
+    pageNo?: number;
+    /**
+     * - The number of items to retrieve in each page.
+     * Default value is 10.
+     */
+    pageSize?: number;
+    body: ConfigurationPlatformModel.CompanyByBrandsRequest;
+};
+type GetDomainAvailibilityParam = {
+    body: ConfigurationPlatformModel.DomainSuggestionsRequest;
+};
+type GetIntegrationByIdParam = {
+    /**
+     * - Integration id
+     */
+    id: number;
+};
+type GetIntegrationByLevelIdParam = {
+    /**
+     * - Integration ID (24-digit Mongo Object ID)
+     */
+    id: string;
+    /**
+     * - Integration level, `store` or `company`
+     */
+    level: string;
+    /**
+     * - Unique identifier of integration level (store/company)
+     */
+    uid: number;
+};
+type GetIntegrationLevelConfigParam = {
+    /**
+     * - Integration ID (24-digit Mongo Object ID)
+     */
+    id: string;
+    /**
+     * - Store or company
+     */
+    level: string;
+    /**
+     * - True means get the opted stores. False means
+     * get the stores that aren't opted.
+     */
+    opted?: boolean;
+    /**
+     * - Filter on if permissions (for
+     * inventory/order) are present
+     */
+    checkPermission?: boolean;
+};
+type GetLevelActiveIntegrationsParam = {
+    /**
+     * - Integration ID (24-digit Mongo Object ID)
+     */
+    id: string;
+    /**
+     * - Integration level, `store` or `company`
+     */
+    level: string;
+    /**
+     * - Unique identifier of integration level (store/company)
+     */
+    uid: number;
+};
+type GetOtherSellerApplicationByIdParam = {
+    /**
+     * - Application Id
+     */
+    id: string;
+};
+type GetOtherSellerApplicationsParam = {
+    /**
+     * - The page number to navigate through the given
+     * set of results. Default value is 1.
+     */
+    pageNo?: number;
+    /**
+     * - The number of items to retrieve in each page.
+     * Default value is 10.
+     */
+    pageSize?: number;
+};
+type GetSelectedOptInsParam = {
+    /**
+     * - Store or company
+     */
+    level: string;
+    /**
+     * - Unique identifier of the selected integration level.
+     */
+    uid: number;
+    /**
+     * - The page number to navigate through the given
+     * set of results. Default value is 1.
+     */
+    pageNo?: number;
+    /**
+     * - The number of items to retrieve in each page.
+     * Default value is 10.
+     */
+    pageSize?: number;
+};
+type GetStoreByBrandsParam = {
+    /**
+     * - The page number to navigate through the given
+     * set of results. Default value is 1.
+     */
+    pageNo?: number;
+    /**
+     * - The number of items to retrieve in each page.
+     * Default value is 10.
+     */
+    pageSize?: number;
+    body: ConfigurationPlatformModel.StoreByBrandsRequest;
+};
+type OptOutFromApplicationParam = {
+    /**
+     * - Alphanumeric ID allotted to an application (sales
+     * channel website) created within a business account.
+     */
+    id: string;
+    body: ConfigurationPlatformModel.OptOutInventory;
+};
+type UpdateLevelIntegrationParam = {
+    /**
+     * - Integration ID (24-digit Mongo Object ID)
+     */
+    id: string;
+    /**
+     * - Integration level, `store` or `company`
+     */
+    level: string;
+    body: ConfigurationPlatformModel.UpdateIntegrationLevelRequest;
+};
+type UpdateLevelUidIntegrationParam = {
+    /**
+     * - Integration ID (24-digit Mongo Object ID)
+     */
+    id: string;
+    /**
+     * - Integration level, `store` or `company`
+     */
+    level: string;
+    /**
+     * - Unique identifier of integration level (store/company)
+     */
+    uid: number;
+    body: ConfigurationPlatformModel.IntegrationLevel;
+};
+type GetCurrenciesParam = any;
+import ConfigurationPlatformModel = require("./ConfigurationPlatformModel");

package/sdk/platform/Configuration/ConfigurationPlatformValidator.js

@@ -1,13 +1,140 @@
 const Joi = require("joi");
 
-const ConfigurationModel = require("./ConfigurationPlatformModel");
-class ConfigurationValidator {
+const ConfigurationPlatformModel = require("./ConfigurationPlatformModel");
+
+/**
+ * @typedef CreateApplicationParam
+ * @property {ConfigurationPlatformModel.CreateApplicationRequest} body
+ */
+
+/**
+ * @typedef GetApplicationsParam
+ * @property {number} [pageNo]
+ * @property {number} [pageSize]
+ * @property {string} [q] - Search param by name or domain
+ */
+
+/**
+ * @typedef GetAvailableOptInsParam
+ * @property {number} [pageNo] - The page number to navigate through the given
+ *   set of results. Default value is 1.
+ * @property {number} [pageSize] - The number of items to retrieve in each page.
+ *   Default value is 10.
+ */
+
+/**
+ * @typedef GetBrandsByCompanyParam
+ * @property {string} [q] - Search text for brand name
+ */
+
+/**
+ * @typedef GetCompanyByBrandsParam
+ * @property {number} [pageNo] - The page number to navigate through the given
+ *   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
+ */
+
+/** @typedef GetCurrenciesParam */
+
+/**
+ * @typedef GetDomainAvailibilityParam
+ * @property {ConfigurationPlatformModel.DomainSuggestionsRequest} body
+ */
+
+/**
+ * @typedef GetIntegrationByIdParam
+ * @property {number} id - Integration id
+ */
+
+/**
+ * @typedef GetIntegrationByLevelIdParam
+ * @property {string} id - Integration ID (24-digit Mongo Object ID)
+ * @property {string} level - Integration level, `store` or `company`
+ * @property {number} uid - Unique identifier of integration level (store/company)
+ */
+
+/**
+ * @typedef GetIntegrationLevelConfigParam
+ * @property {string} id - Integration ID (24-digit Mongo Object ID)
+ * @property {string} level - Store or company
+ * @property {boolean} [opted] - True means get the opted stores. False means
+ *   get the stores that aren't opted.
+ * @property {boolean} [checkPermission] - Filter on if permissions (for
+ *   inventory/order) are present
+ */
+
+/**
+ * @typedef GetLevelActiveIntegrationsParam
+ * @property {string} id - Integration ID (24-digit Mongo Object ID)
+ * @property {string} level - Integration level, `store` or `company`
+ * @property {number} uid - Unique identifier of integration level (store/company)
+ */
+
+/**
+ * @typedef GetOtherSellerApplicationByIdParam
+ * @property {string} id - Application Id
+ */
+
+/**
+ * @typedef GetOtherSellerApplicationsParam
+ * @property {number} [pageNo] - The page number to navigate through the given
+ *   set of results. Default value is 1.
+ * @property {number} [pageSize] - The number of items to retrieve in each page.
+ *   Default value is 10.
+ */
+
+/**
+ * @typedef GetSelectedOptInsParam
+ * @property {string} level - Store or company
+ * @property {number} uid - Unique identifier of the selected integration level.
+ * @property {number} [pageNo] - The page number to navigate through the given
+ *   set of results. Default value is 1.
+ * @property {number} [pageSize] - The number of items to retrieve in each page.
+ *   Default value is 10.
+ */
+
+/**
+ * @typedef GetStoreByBrandsParam
+ * @property {number} [pageNo] - The page number to navigate through the given
+ *   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 OptOutFromApplicationParam
+ * @property {string} id - Alphanumeric ID allotted to an application (sales
+ *   channel website) created within a business account.
+ * @property {ConfigurationPlatformModel.OptOutInventory} body
+ */
+
+/**
+ * @typedef UpdateLevelIntegrationParam
+ * @property {string} id - Integration ID (24-digit Mongo Object ID)
+ * @property {string} level - Integration level, `store` or `company`
+ * @property {ConfigurationPlatformModel.UpdateIntegrationLevelRequest} body
+ */
+
+/**
+ * @typedef UpdateLevelUidIntegrationParam
+ * @property {string} id - Integration ID (24-digit Mongo Object ID)
+ * @property {string} level - Integration level, `store` or `company`
+ * @property {number} uid - Unique identifier of integration level (store/company)
+ * @property {ConfigurationPlatformModel.IntegrationLevel} body
+ */
+
+class ConfigurationPlatformValidator {
+  /** @returns {CreateApplicationParam} */
   static createApplication() {
     return Joi.object({
-      body: ConfigurationModel.CreateApplicationRequest().required(),
+      body: ConfigurationPlatformModel.CreateApplicationRequest().required(),
     }).required();
   }
 
+  /** @returns {GetApplicationsParam} */
   static getApplications() {
     return Joi.object({
       pageNo: Joi.number(),
@@ -16,6 +143,7 @@ class ConfigurationValidator {
     }).required();
   }
 
+  /** @returns {GetAvailableOptInsParam} */
   static getAvailableOptIns() {
     return Joi.object({
       pageNo: Joi.number(),
@@ -23,36 +151,42 @@ class ConfigurationValidator {
     }).required();
   }
 
+  /** @returns {GetBrandsByCompanyParam} */
   static getBrandsByCompany() {
     return Joi.object({
       q: Joi.string().allow(""),
     }).required();
   }
 
+  /** @returns {GetCompanyByBrandsParam} */
   static getCompanyByBrands() {
     return Joi.object({
       pageNo: Joi.number(),
       pageSize: Joi.number(),
-      body: ConfigurationModel.CompanyByBrandsRequest().required(),
+      body: ConfigurationPlatformModel.CompanyByBrandsRequest().required(),
     }).required();
   }
 
+  /** @returns {GetCurrenciesParam} */
   static getCurrencies() {
     return Joi.object({}).required();
   }
 
+  /** @returns {GetDomainAvailibilityParam} */
   static getDomainAvailibility() {
     return Joi.object({
-      body: ConfigurationModel.DomainSuggestionsRequest().required(),
+      body: ConfigurationPlatformModel.DomainSuggestionsRequest().required(),
     }).required();
   }
 
+  /** @returns {GetIntegrationByIdParam} */
   static getIntegrationById() {
     return Joi.object({
       id: Joi.number().required(),
     }).required();
   }
 
+  /** @returns {GetIntegrationByLevelIdParam} */
   static getIntegrationByLevelId() {
     return Joi.object({
       id: Joi.string().allow("").required(),
@@ -61,6 +195,7 @@ class ConfigurationValidator {
     }).required();
   }
 
+  /** @returns {GetIntegrationLevelConfigParam} */
   static getIntegrationLevelConfig() {
     return Joi.object({
       id: Joi.string().allow("").required(),
@@ -70,6 +205,7 @@ class ConfigurationValidator {
     }).required();
   }
 
+  /** @returns {GetLevelActiveIntegrationsParam} */
   static getLevelActiveIntegrations() {
     return Joi.object({
       id: Joi.string().allow("").required(),
@@ -78,12 +214,14 @@ class ConfigurationValidator {
     }).required();
   }
 
+  /** @returns {GetOtherSellerApplicationByIdParam} */
   static getOtherSellerApplicationById() {
     return Joi.object({
       id: Joi.string().allow("").required(),
     }).required();
   }
 
+  /** @returns {GetOtherSellerApplicationsParam} */
   static getOtherSellerApplications() {
     return Joi.object({
       pageNo: Joi.number(),
@@ -91,6 +229,7 @@ class ConfigurationValidator {
     }).required();
   }
 
+  /** @returns {GetSelectedOptInsParam} */
   static getSelectedOptIns() {
     return Joi.object({
       level: Joi.string().allow("").required(),
@@ -100,37 +239,41 @@ class ConfigurationValidator {
     }).required();
   }
 
+  /** @returns {GetStoreByBrandsParam} */
   static getStoreByBrands() {
     return Joi.object({
       pageNo: Joi.number(),
       pageSize: Joi.number(),
-      body: ConfigurationModel.StoreByBrandsRequest().required(),
+      body: ConfigurationPlatformModel.StoreByBrandsRequest().required(),
     }).required();
   }
 
+  /** @returns {OptOutFromApplicationParam} */
   static optOutFromApplication() {
     return Joi.object({
       id: Joi.string().allow("").required(),
-      body: ConfigurationModel.OptOutInventory().required(),
+      body: ConfigurationPlatformModel.OptOutInventory().required(),
     }).required();
   }
 
+  /** @returns {UpdateLevelIntegrationParam} */
   static updateLevelIntegration() {
     return Joi.object({
       id: Joi.string().allow("").required(),
       level: Joi.string().allow("").required(),
-      body: ConfigurationModel.UpdateIntegrationLevelRequest().required(),
+      body: ConfigurationPlatformModel.UpdateIntegrationLevelRequest().required(),
     }).required();
   }
 
+  /** @returns {UpdateLevelUidIntegrationParam} */
   static updateLevelUidIntegration() {
     return Joi.object({
       id: Joi.string().allow("").required(),
       level: Joi.string().allow("").required(),
       uid: Joi.number().required(),
-      body: ConfigurationModel.IntegrationLevel().required(),
+      body: ConfigurationPlatformModel.IntegrationLevel().required(),
     }).required();
   }
 }
 
-module.exports = ConfigurationValidator;
+module.exports = ConfigurationPlatformValidator;