@gofynd/fdk-client-javascript 1.2.0 → 1.3.0

package/sdk/platform/Common/CommonPlatformModel.js

@@ -67,25 +67,9 @@ const Joi = require("joi");
 
 /**
  * @typedef ApplicationResponse
- * @property {Application} [application]
- */
-
-/**
- * @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 BadRequest
- * @property {string} [message] - Failure message (in a string format)
- */
-
-/**
- * @typedef Currency
  * @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
@@ -100,6 +84,18 @@ const Joi = require("joi");
  *   currency updation
  */
 
+/**
+ * @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 BadRequest
+ * @property {string} [message] - Failure message (in a string format)
+ */
+
 /**
  * @typedef Domain
  * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
@@ -149,7 +145,7 @@ const Joi = require("joi");
 
 /**
  * @typedef Locations
- * @property {Object[]} [items]
+ * @property {LocationCountry[]} [items] - Object Containing Country Locations Details
  */
 
 /**
@@ -157,17 +153,6 @@ const Joi = require("joi");
  * @property {string} [message] - Response message for not found
  */
 
-/**
- * @typedef Page
- * @property {number} [current]
- * @property {boolean} [has_next]
- * @property {boolean} [has_previous]
- * @property {number} [item_total]
- * @property {string} [next_id]
- * @property {number} [size]
- * @property {string} type
- */
-
 /**
  * @typedef SecureUrl
  * @property {string} [secure_url] - Hosted URL of the image
@@ -241,7 +226,15 @@ class CommonPlatformModel {
   /** @returns {ApplicationResponse} */
   static ApplicationResponse() {
     return Joi.object({
+      _id: Joi.string().allow(""),
       application: CommonPlatformModel.Application(),
+      code: Joi.string().allow(""),
+      created_at: Joi.string().allow(""),
+      decimal_digits: Joi.number(),
+      is_active: Joi.boolean(),
+      name: Joi.string().allow(""),
+      symbol: Joi.string().allow(""),
+      updated_at: Joi.string().allow(""),
     });
   }
 
@@ -260,20 +253,6 @@ class CommonPlatformModel {
     });
   }
 
-  /** @returns {Currency} */
-  static Currency() {
-    return Joi.object({
-      _id: Joi.string().allow(""),
-      code: Joi.string().allow(""),
-      created_at: Joi.string().allow(""),
-      decimal_digits: Joi.number(),
-      is_active: Joi.boolean(),
-      name: Joi.string().allow(""),
-      symbol: Joi.string().allow(""),
-      updated_at: Joi.string().allow(""),
-    });
-  }
-
   /** @returns {Domain} */
   static Domain() {
     return Joi.object({
@@ -329,7 +308,7 @@ class CommonPlatformModel {
   /** @returns {Locations} */
   static Locations() {
     return Joi.object({
-      items: Joi.array().items(Joi.any()),
+      items: Joi.array().items(CommonPlatformModel.LocationCountry()),
     });
   }
 
@@ -340,19 +319,6 @@ class CommonPlatformModel {
     });
   }
 
-  /** @returns {Page} */
-  static Page() {
-    return Joi.object({
-      current: Joi.number(),
-      has_next: Joi.boolean(),
-      has_previous: Joi.boolean(),
-      item_total: Joi.number(),
-      next_id: Joi.string().allow(""),
-      size: Joi.number(),
-      type: Joi.string().allow("").required(),
-    });
-  }
-
   /** @returns {SecureUrl} */
   static SecureUrl() {
     return Joi.object({

package/sdk/platform/Common/CommonPlatformValidator.d.ts

@@ -1,11 +1,10 @@
 export = CommonPlatformValidator;
 /**
  * @typedef GetLocationsParam
- * @property {string} [locationType] - Provide location type to query on.
- *   Possible values : country, state, city
+ * @property {string} [locationType]
  * @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.
+ *   querying for state, provide id of the country. If querying for city,
+ *   provide id of the state.
  */
 /**
  * @typedef SearchApplicationParam
@@ -22,15 +21,11 @@ declare namespace CommonPlatformValidator {
     export { GetLocationsParam, SearchApplicationParam };
 }
 type GetLocationsParam = {
-    /**
-     * - Provide location type to query on.
-     * Possible values : country, state, city
-     */
     locationType?: 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.
+     * querying for state, provide id of the country. If querying for city,
+     * provide id of the state.
      */
     id?: string;
 };

package/sdk/platform/Common/CommonPlatformValidator.js

@@ -4,11 +4,10 @@ const CommonPlatformModel = require("./CommonPlatformModel");
 
 /**
  * @typedef GetLocationsParam
- * @property {string} [locationType] - Provide location type to query on.
- *   Possible values : country, state, city
+ * @property {string} [locationType]
  * @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.
+ *   querying for state, provide id of the country. If querying for city,
+ *   provide id of the state.
  */
 
 /**