@gofynd/fdk-client-javascript 1.4.2-beta.1 → 1.4.2-beta.3

package/sdk/platform/Common/CommonPlatformModel.js

@@ -1,47 +1,42 @@
 const Joi = require("joi");
 
 /**
- * @typedef Application
- * @property {number} [__v] - Version key for tracking revisions. Default value is zero.
+ * @typedef ApplicationResponse
+ * @property {Application} [application]
  * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
- *   of the sales channel
- * @property {string} [app_type] - It shows whether application is live or in
- *   development mode
- * @property {ApplicationAuth} [auth]
- * @property {SecureUrl} [banner]
- * @property {number} [cache_ttl] - An integer value that specifies the number
- *   of seconds until the key expires
- * @property {string} [channel_type] - It indicates different channel types like
- *   store, website-and-mobile-apps. Default value is store.
- * @property {number} [company_id] - Numeric ID allotted to a business account
- *   where the sales channel exists
- * @property {ApplicationCors} [cors]
- * @property {string} [created_at] - ISO 8601 timestamp of sales channel creation
- * @property {string} [description] - It contains detailed information about the
+ *   of the current sales channel supported currency
+ * @property {boolean} [is_active] - Shows currency is enabled or not in current
  *   sales channel
- * @property {Domain} [domain]
- * @property {Domain[]} [domains]
- * @property {SecureUrl} [favicon]
- * @property {boolean} [is_active] - Indicates whether a sales channel is active
- *   or not active
- * @property {boolean} [is_internal] - Indicates whether a sales channel is
- *   internal or not
- * @property {SecureUrl} [logo]
- * @property {ApplicationMeta[]} [meta]
- * @property {SecureUrl} [mobile_logo]
- * @property {string} [name] - Name of the sales channel, e.g. Zenz Fashion
- * @property {string} [owner] - The unique identifier (24-digit Mongo Object ID)
- *   of owner who owns the application
- * @property {ApplicationRedirections[]} [redirections]
- * @property {string} [token] - Randomly generated fixed-length string for sales
- *   channel. It is required and auto-generated.
- * @property {string} [updated_at] - ISO 8601 timestamp of sales channel updation
- * @property {ApplicationWebsite} [website]
+ * @property {string} [name] - Name of the currency, e.g. Indian Rupee
+ * @property {string} [code] - 3-character currency code, e.g. INR, USD, EUR.
+ * @property {string} [created_at] - ISO 8601 timestamp of sales channel support
+ *   currency creation
+ * @property {string} [updated_at] - ISO 8601 timestamp of sales channel support
+ *   currency updation
+ * @property {number} [decimal_digits] - Acceptable decimal limits for a given
+ *   currency, e.g. 1.05$ means upto 2 decimal digits can be accepted as a valid
+ *   value of a currency.
+ * @property {string} [symbol] - Unique symbol for identifying the currency, e.g. ₹
  */
 
 /**
- * @typedef ApplicationAuth
- * @property {boolean} [enabled] - Shows sales channel auth is enabled or not enabled.
+ * @typedef Domain
+ * @property {boolean} [verified] - Indicates domain is verified or not. TXT and
+ *   A records should propagate correctly.
+ * @property {boolean} [is_primary] - Indicates domain is primary or not.
+ *   Primary domain is the default/main domain.
+ * @property {boolean} [is_shortlink] - Shortlink is present or not for the domain
+ * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
+ *   of the domain
+ * @property {string} [name]
+ * @property {boolean} [is_predefined] - Domain is hosting domain or not
+ */
+
+/**
+ * @typedef ApplicationWebsite
+ * @property {boolean} [enabled] - Shows whether sales channel website URL is
+ *   enabled or not
+ * @property {string} [basepath] - Base path for the current sales channel website
  */
 
 /**
@@ -50,9 +45,8 @@ const Joi = require("joi");
  */
 
 /**
- * @typedef ApplicationMeta
- * @property {string} [name] - Indicates the name of application meta
- * @property {string} [value] - Value related to application meta name
+ * @typedef ApplicationAuth
+ * @property {boolean} [enabled] - Shows sales channel auth is enabled or not enabled.
  */
 
 /**
@@ -66,29 +60,58 @@ const Joi = require("joi");
  */
 
 /**
- * @typedef ApplicationResponse
- * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
- *   of the current sales channel supported currency
- * @property {Application} [application]
- * @property {string} [code] - 3-character currency code, e.g. INR, USD, EUR.
- * @property {string} [created_at] - ISO 8601 timestamp of sales channel support
- *   currency creation
- * @property {number} [decimal_digits] - Acceptable decimal limits for a given
- *   currency, e.g. 1.05$ means upto 2 decimal digits can be accepted as a valid
- *   value of a currency.
- * @property {boolean} [is_active] - Shows currency is enabled or not in current
+ * @typedef ApplicationMeta
+ * @property {string} [name] - Indicates the name of application meta
+ * @property {string} [value] - Value related to application meta name
+ */
+
+/**
+ * @typedef SecureUrl
+ * @property {string} [secure_url] - Hosted URL of the image
+ */
+
+/**
+ * @typedef Application
+ * @property {ApplicationWebsite} [website]
+ * @property {ApplicationCors} [cors]
+ * @property {ApplicationAuth} [auth]
+ * @property {string} [description] - It contains detailed information about the
  *   sales channel
- * @property {string} [name] - Name of the currency, e.g. Indian Rupee
- * @property {string} [symbol] - Unique symbol for identifying the currency, e.g. ₹
- * @property {string} [updated_at] - ISO 8601 timestamp of sales channel support
- *   currency updation
+ * @property {string} [channel_type] - It indicates different channel types like
+ *   store, website-and-mobile-apps. Default value is store.
+ * @property {number} [cache_ttl] - An integer value that specifies the number
+ *   of seconds until the key expires
+ * @property {boolean} [is_internal] - Indicates whether a sales channel is
+ *   internal or not
+ * @property {boolean} [is_active] - Indicates whether a sales channel is active
+ *   or not active
+ * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
+ *   of the sales channel
+ * @property {string} [name] - Name of the sales channel, e.g. Zenz Fashion
+ * @property {string} [owner] - The unique identifier (24-digit Mongo Object ID)
+ *   of owner who owns the application
+ * @property {number} [company_id] - Numeric ID allotted to a business account
+ *   where the sales channel exists
+ * @property {string} [token] - Randomly generated fixed-length string for sales
+ *   channel. It is required and auto-generated.
+ * @property {ApplicationRedirections[]} [redirections]
+ * @property {ApplicationMeta[]} [meta]
+ * @property {string} [created_at] - ISO 8601 timestamp of sales channel creation
+ * @property {string} [updated_at] - ISO 8601 timestamp of sales channel updation
+ * @property {number} [__v] - Version key for tracking revisions. Default value is zero.
+ * @property {SecureUrl} [banner]
+ * @property {SecureUrl} [logo]
+ * @property {SecureUrl} [favicon]
+ * @property {Domain[]} [domains]
+ * @property {string} [app_type] - It shows whether application is live or in
+ *   development mode
+ * @property {SecureUrl} [mobile_logo]
+ * @property {Domain} [domain]
  */
 
 /**
- * @typedef ApplicationWebsite
- * @property {string} [basepath] - Base path for the current sales channel website
- * @property {boolean} [enabled] - Shows whether sales channel website URL is
- *   enabled or not
+ * @typedef NotFound
+ * @property {string} [message] - Response message for not found
  */
 
 /**
@@ -97,50 +120,37 @@ const Joi = require("joi");
  */
 
 /**
- * @typedef Domain
- * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
- *   of the domain
- * @property {boolean} [is_predefined] - Domain is hosting domain or not
- * @property {boolean} [is_primary] - Indicates domain is primary or not.
- *   Primary domain is the default/main domain.
- * @property {boolean} [is_shortlink] - Shortlink is present or not for the domain
+ * @typedef LocationDefaultLanguage
  * @property {string} [name]
- * @property {boolean} [verified] - Indicates domain is verified or not. TXT and
- *   A records should propagate correctly.
+ * @property {string} [code]
+ */
+
+/**
+ * @typedef LocationDefaultCurrency
+ * @property {string} [name]
+ * @property {string} [symbol]
+ * @property {string} [code]
  */
 
 /**
  * @typedef LocationCountry
- * @property {number} [__v]
- * @property {string} [_id]
  * @property {string} [capital]
- * @property {string} [country_code]
  * @property {string} [currency]
- * @property {LocationDefaultCurrency} [default_currency]
- * @property {LocationDefaultLanguage} [default_language]
  * @property {string} [iso2]
  * @property {string} [iso3]
- * @property {string} [latitude]
- * @property {string} [longitude]
  * @property {string} [name]
  * @property {string} [parent]
  * @property {string} [phone_code]
- * @property {string} [state_code]
  * @property {string} [type]
  * @property {number} [uid]
- */
-
-/**
- * @typedef LocationDefaultCurrency
- * @property {string} [code]
- * @property {string} [name]
- * @property {string} [symbol]
- */
-
-/**
- * @typedef LocationDefaultLanguage
- * @property {string} [code]
- * @property {string} [name]
+ * @property {number} [__v]
+ * @property {string} [_id]
+ * @property {LocationDefaultCurrency} [default_currency]
+ * @property {LocationDefaultLanguage} [default_language]
+ * @property {string} [state_code]
+ * @property {string} [country_code]
+ * @property {string} [latitude]
+ * @property {string} [longitude]
  */
 
 /**
@@ -148,54 +158,39 @@ const Joi = require("joi");
  * @property {LocationCountry[]} [items] - Object Containing Country Locations Details
  */
 
-/**
- * @typedef NotFound
- * @property {string} [message] - Response message for not found
- */
-
-/**
- * @typedef SecureUrl
- * @property {string} [secure_url] - Hosted URL of the image
- */
-
 class CommonPlatformModel {
-  /** @returns {Application} */
-  static Application() {
+  /** @returns {ApplicationResponse} */
+  static ApplicationResponse() {
     return Joi.object({
-      __v: Joi.number(),
+      application: CommonPlatformModel.Application(),
       _id: Joi.string().allow(""),
-      app_type: Joi.string().allow(""),
-      auth: CommonPlatformModel.ApplicationAuth(),
-      banner: CommonPlatformModel.SecureUrl(),
-      cache_ttl: Joi.number(),
-      channel_type: Joi.string().allow(""),
-      company_id: Joi.number(),
-      cors: CommonPlatformModel.ApplicationCors(),
-      created_at: Joi.string().allow(""),
-      description: Joi.string().allow(""),
-      domain: CommonPlatformModel.Domain(),
-      domains: Joi.array().items(CommonPlatformModel.Domain()),
-      favicon: CommonPlatformModel.SecureUrl(),
       is_active: Joi.boolean(),
-      is_internal: Joi.boolean(),
-      logo: CommonPlatformModel.SecureUrl(),
-      meta: Joi.array().items(CommonPlatformModel.ApplicationMeta()),
-      mobile_logo: CommonPlatformModel.SecureUrl(),
       name: Joi.string().allow(""),
-      owner: Joi.string().allow(""),
-      redirections: Joi.array().items(
-        CommonPlatformModel.ApplicationRedirections()
-      ),
-      token: Joi.string().allow(""),
+      code: Joi.string().allow(""),
+      created_at: Joi.string().allow(""),
       updated_at: Joi.string().allow(""),
-      website: CommonPlatformModel.ApplicationWebsite(),
+      decimal_digits: Joi.number(),
+      symbol: Joi.string().allow(""),
     });
   }
 
-  /** @returns {ApplicationAuth} */
-  static ApplicationAuth() {
+  /** @returns {Domain} */
+  static Domain() {
+    return Joi.object({
+      verified: Joi.boolean(),
+      is_primary: Joi.boolean(),
+      is_shortlink: Joi.boolean(),
+      _id: Joi.string().allow(""),
+      name: Joi.string().allow(""),
+      is_predefined: Joi.boolean(),
+    });
+  }
+
+  /** @returns {ApplicationWebsite} */
+  static ApplicationWebsite() {
     return Joi.object({
       enabled: Joi.boolean(),
+      basepath: Joi.string().allow(""),
     });
   }
 
@@ -206,11 +201,10 @@ class CommonPlatformModel {
     });
   }
 
-  /** @returns {ApplicationMeta} */
-  static ApplicationMeta() {
+  /** @returns {ApplicationAuth} */
+  static ApplicationAuth() {
     return Joi.object({
-      name: Joi.string().allow(""),
-      value: Joi.string().allow(""),
+      enabled: Joi.boolean(),
     });
   }
 
@@ -223,26 +217,58 @@ class CommonPlatformModel {
     });
   }
 
-  /** @returns {ApplicationResponse} */
-  static ApplicationResponse() {
+  /** @returns {ApplicationMeta} */
+  static ApplicationMeta() {
     return Joi.object({
-      _id: Joi.string().allow(""),
-      application: CommonPlatformModel.Application(),
-      code: Joi.string().allow(""),
-      created_at: Joi.string().allow(""),
-      decimal_digits: Joi.number(),
+      name: Joi.string().allow(""),
+      value: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {SecureUrl} */
+  static SecureUrl() {
+    return Joi.object({
+      secure_url: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {Application} */
+  static Application() {
+    return Joi.object({
+      website: CommonPlatformModel.ApplicationWebsite(),
+      cors: CommonPlatformModel.ApplicationCors(),
+      auth: CommonPlatformModel.ApplicationAuth(),
+      description: Joi.string().allow(""),
+      channel_type: Joi.string().allow(""),
+      cache_ttl: Joi.number(),
+      is_internal: Joi.boolean(),
       is_active: Joi.boolean(),
+      _id: Joi.string().allow(""),
       name: Joi.string().allow(""),
-      symbol: Joi.string().allow(""),
+      owner: Joi.string().allow(""),
+      company_id: Joi.number(),
+      token: Joi.string().allow(""),
+      redirections: Joi.array().items(
+        CommonPlatformModel.ApplicationRedirections()
+      ),
+      meta: Joi.array().items(CommonPlatformModel.ApplicationMeta()),
+      created_at: Joi.string().allow(""),
       updated_at: Joi.string().allow(""),
+      __v: Joi.number(),
+      banner: CommonPlatformModel.SecureUrl(),
+      logo: CommonPlatformModel.SecureUrl(),
+      favicon: CommonPlatformModel.SecureUrl(),
+      domains: Joi.array().items(CommonPlatformModel.Domain()),
+      app_type: Joi.string().allow(""),
+      mobile_logo: CommonPlatformModel.SecureUrl(),
+      domain: CommonPlatformModel.Domain(),
     });
   }
 
-  /** @returns {ApplicationWebsite} */
-  static ApplicationWebsite() {
+  /** @returns {NotFound} */
+  static NotFound() {
     return Joi.object({
-      basepath: Joi.string().allow(""),
-      enabled: Joi.boolean(),
+      message: Joi.string().allow(""),
     });
   }
 
@@ -253,55 +279,43 @@ class CommonPlatformModel {
     });
   }
 
-  /** @returns {Domain} */
-  static Domain() {
+  /** @returns {LocationDefaultLanguage} */
+  static LocationDefaultLanguage() {
     return Joi.object({
-      _id: Joi.string().allow(""),
-      is_predefined: Joi.boolean(),
-      is_primary: Joi.boolean(),
-      is_shortlink: Joi.boolean(),
       name: Joi.string().allow(""),
-      verified: Joi.boolean(),
+      code: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {LocationDefaultCurrency} */
+  static LocationDefaultCurrency() {
+    return Joi.object({
+      name: Joi.string().allow(""),
+      symbol: Joi.string().allow(""),
+      code: Joi.string().allow(""),
     });
   }
 
   /** @returns {LocationCountry} */
   static LocationCountry() {
     return Joi.object({
-      __v: Joi.number(),
-      _id: Joi.string().allow(""),
       capital: Joi.string().allow(""),
-      country_code: Joi.string().allow(""),
       currency: Joi.string().allow(""),
-      default_currency: CommonPlatformModel.LocationDefaultCurrency(),
-      default_language: CommonPlatformModel.LocationDefaultLanguage(),
       iso2: Joi.string().allow(""),
       iso3: Joi.string().allow(""),
-      latitude: Joi.string().allow(""),
-      longitude: Joi.string().allow(""),
       name: Joi.string().allow(""),
       parent: Joi.string().allow(""),
       phone_code: Joi.string().allow(""),
-      state_code: Joi.string().allow(""),
       type: Joi.string().allow(""),
       uid: Joi.number(),
-    });
-  }
-
-  /** @returns {LocationDefaultCurrency} */
-  static LocationDefaultCurrency() {
-    return Joi.object({
-      code: Joi.string().allow(""),
-      name: Joi.string().allow(""),
-      symbol: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {LocationDefaultLanguage} */
-  static LocationDefaultLanguage() {
-    return Joi.object({
-      code: Joi.string().allow(""),
-      name: Joi.string().allow(""),
+      __v: Joi.number(),
+      _id: Joi.string().allow(""),
+      default_currency: CommonPlatformModel.LocationDefaultCurrency(),
+      default_language: CommonPlatformModel.LocationDefaultLanguage(),
+      state_code: Joi.string().allow(""),
+      country_code: Joi.string().allow(""),
+      latitude: Joi.string().allow(""),
+      longitude: Joi.string().allow(""),
     });
   }
 
@@ -311,19 +325,5 @@ class CommonPlatformModel {
       items: Joi.array().items(CommonPlatformModel.LocationCountry()),
     });
   }
-
-  /** @returns {NotFound} */
-  static NotFound() {
-    return Joi.object({
-      message: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {SecureUrl} */
-  static SecureUrl() {
-    return Joi.object({
-      secure_url: Joi.string().allow(""),
-    });
-  }
 }
 module.exports = CommonPlatformModel;