@gofynd/fdk-client-javascript 1.1.6 → 1.2.0

package/sdk/application/Logistic/LogisticApplicationModel.js

@@ -1,12 +1,223 @@
 const Joi = require("joi");
 
-class LogisticModel {
+/**
+ * @typedef CountryEntityResponse
+ * @property {string} [display_name]
+ * @property {boolean} [is_active]
+ * @property {LogisticsResponse} [logistics]
+ * @property {CountryMetaResponse} [meta]
+ * @property {string} [name]
+ * @property {string} [parent_id]
+ * @property {string} [sub_type]
+ * @property {string} [type]
+ * @property {string} [uid]
+ */
+
+/**
+ * @typedef CountryListResponse
+ * @property {CountryEntityResponse[]} [results]
+ */
+
+/**
+ * @typedef CountryMetaResponse
+ * @property {string} [country_code]
+ * @property {string} [isd_code]
+ */
+
+/**
+ * @typedef DP
+ * @property {string} [area_code]
+ * @property {boolean} [assign_dp_from_sb]
+ * @property {string} [external_account_id]
+ * @property {number} fm_priority
+ * @property {string} [internal_account_id]
+ * @property {number} lm_priority
+ * @property {string[]} operations
+ * @property {string} payment_mode
+ * @property {number} rvp_priority
+ * @property {string} [transport_mode]
+ */
+
+/**
+ * @typedef GetZoneFromPincodeViewRequest
+ * @property {string} country
+ * @property {string} pincode
+ */
+
+/**
+ * @typedef GetZoneFromPincodeViewResponse
+ * @property {string} serviceability_type
+ * @property {string[]} zones
+ */
+
+/**
+ * @typedef LogisticsResponse
+ * @property {Object} [dp]
+ */
+
+/**
+ * @typedef PincodeApiResponse
+ * @property {PincodeDataResponse[]} [data]
+ * @property {PincodeErrorSchemaResponse} error
+ * @property {boolean} success
+ */
+
+/**
+ * @typedef PincodeDataResponse
+ * @property {string} [display_name]
+ * @property {PincodeErrorSchemaResponse} error
+ * @property {PincodeLatLongData} [lat_long]
+ * @property {PincodeMetaResponse} [meta]
+ * @property {CountryMetaResponse} [meta_code]
+ * @property {string} [name]
+ * @property {PincodeParentsResponse[]} [parents]
+ * @property {string} [sub_type]
+ * @property {string} [uid]
+ */
+
+/**
+ * @typedef PincodeErrorSchemaResponse
+ * @property {string} [message]
+ * @property {string} [type]
+ * @property {string} [value]
+ */
+
+/**
+ * @typedef PincodeLatLongData
+ * @property {string[]} [coordinates]
+ * @property {string} [type]
+ */
+
+/**
+ * @typedef PincodeMetaResponse
+ * @property {number} [internal_zone_id]
+ * @property {string} [zone]
+ */
+
+/**
+ * @typedef PincodeParentsResponse
+ * @property {string} [display_name]
+ * @property {string} [name]
+ * @property {string} [sub_type]
+ * @property {string} [uid]
+ */
+
+/**
+ * @typedef ReAssignStoreRequest
+ * @property {Object[]} articles
+ * @property {Object} configuration
+ * @property {string} identifier
+ * @property {number[]} ignored_locations
+ * @property {string} to_pincode
+ */
+
+/**
+ * @typedef ReAssignStoreResponse
+ * @property {Object[]} [assigned_stores]
+ * @property {Object} error
+ * @property {string} pystormbreaker_uuid
+ * @property {boolean} success
+ * @property {string} to_pincode
+ */
+
+/**
+ * @typedef TATArticlesRequest
+ * @property {TATCategoryRequest} [category]
+ * @property {number} [manufacturing_time]
+ * @property {string} [manufacturing_time_unit]
+ */
+
+/**
+ * @typedef TATArticlesResponse
+ * @property {number} [_manufacturing_time_seconds]
+ * @property {TATCategoryRequest} [category]
+ * @property {TATErrorSchemaResponse} [error]
+ * @property {boolean} [is_cod_available]
+ * @property {number} [manufacturing_time]
+ * @property {string} [manufacturing_time_unit]
+ * @property {TATPromiseResponse} [promise]
+ */
+
+/**
+ * @typedef TATCategoryRequest
+ * @property {number} [id]
+ * @property {string} [level]
+ */
+
+/**
+ * @typedef TATErrorSchemaResponse
+ * @property {string} [message]
+ * @property {string} [type]
+ * @property {string} [value]
+ */
+
+/**
+ * @typedef TATFormattedResponse
+ * @property {string} [max]
+ * @property {string} [min]
+ */
+
+/**
+ * @typedef TATLocationDetailsRequest
+ * @property {TATArticlesRequest[]} [articles]
+ * @property {string} [from_pincode]
+ * @property {number} [fulfillment_id]
+ */
+
+/**
+ * @typedef TATLocationDetailsResponse
+ * @property {TATArticlesResponse[]} [articles]
+ * @property {string} [from_pincode]
+ * @property {number} [fulfillment_id]
+ */
+
+/**
+ * @typedef TATPromiseResponse
+ * @property {TATFormattedResponse} [formatted]
+ * @property {TATTimestampResponse} [timestamp]
+ */
+
+/**
+ * @typedef TATTimestampResponse
+ * @property {number} [max]
+ * @property {number} [min]
+ */
+
+/**
+ * @typedef TATViewRequest
+ * @property {string} [action]
+ * @property {string} [identifier]
+ * @property {string} [journey]
+ * @property {TATLocationDetailsRequest[]} [location_details]
+ * @property {string} [source]
+ * @property {string} [to_pincode]
+ */
+
+/**
+ * @typedef TATViewResponse
+ * @property {string} [action]
+ * @property {TATErrorSchemaResponse} [error]
+ * @property {string} [identifier]
+ * @property {boolean} [is_cod_available]
+ * @property {string} [journey]
+ * @property {TATLocationDetailsResponse[]} [location_details]
+ * @property {string} [payment_mode]
+ * @property {string} [request_uuid]
+ * @property {string} [source]
+ * @property {string} [stormbreaker_uuid]
+ * @property {boolean} [success]
+ * @property {string} [to_city]
+ * @property {string} [to_pincode]
+ */
+
+class LogisticApplicationModel {
+  /** @returns {CountryEntityResponse} */
   static CountryEntityResponse() {
     return Joi.object({
       display_name: Joi.string().allow(""),
       is_active: Joi.boolean(),
-      logistics: LogisticModel.LogisticsResponse(),
-      meta: LogisticModel.CountryMetaResponse(),
+      logistics: LogisticApplicationModel.LogisticsResponse(),
+      meta: LogisticApplicationModel.CountryMetaResponse(),
       name: Joi.string().allow(""),
       parent_id: Joi.string().allow(""),
       sub_type: Joi.string().allow(""),
@@ -14,17 +225,25 @@ class LogisticModel {
       uid: Joi.string().allow(""),
     });
   }
+
+  /** @returns {CountryListResponse} */
   static CountryListResponse() {
     return Joi.object({
-      results: Joi.array().items(LogisticModel.CountryEntityResponse()),
+      results: Joi.array().items(
+        LogisticApplicationModel.CountryEntityResponse()
+      ),
     });
   }
+
+  /** @returns {CountryMetaResponse} */
   static CountryMetaResponse() {
     return Joi.object({
       country_code: Joi.string().allow(""),
       isd_code: Joi.string().allow(""),
     });
   }
+
+  /** @returns {DP} */
   static DP() {
     return Joi.object({
       area_code: Joi.string().allow("").allow(null),
@@ -39,43 +258,57 @@ class LogisticModel {
       transport_mode: Joi.string().allow(""),
     });
   }
+
+  /** @returns {GetZoneFromPincodeViewRequest} */
   static GetZoneFromPincodeViewRequest() {
     return Joi.object({
       country: Joi.string().allow("").required(),
       pincode: Joi.string().allow("").required(),
     });
   }
+
+  /** @returns {GetZoneFromPincodeViewResponse} */
   static GetZoneFromPincodeViewResponse() {
     return Joi.object({
       serviceability_type: Joi.string().allow("").required(),
       zones: Joi.array().items(Joi.string().allow("")).required(),
     });
   }
+
+  /** @returns {LogisticsResponse} */
   static LogisticsResponse() {
     return Joi.object({
-      dp: Joi.object().pattern(/\S/, LogisticModel.DP()),
+      dp: Joi.object().pattern(/\S/, LogisticApplicationModel.DP()),
     });
   }
+
+  /** @returns {PincodeApiResponse} */
   static PincodeApiResponse() {
     return Joi.object({
-      data: Joi.array().items(LogisticModel.PincodeDataResponse()),
-      error: LogisticModel.PincodeErrorSchemaResponse().required(),
+      data: Joi.array().items(LogisticApplicationModel.PincodeDataResponse()),
+      error: LogisticApplicationModel.PincodeErrorSchemaResponse().required(),
       success: Joi.boolean().required(),
     });
   }
+
+  /** @returns {PincodeDataResponse} */
   static PincodeDataResponse() {
     return Joi.object({
       display_name: Joi.string().allow(""),
-      error: LogisticModel.PincodeErrorSchemaResponse().required(),
-      lat_long: LogisticModel.PincodeLatLongData(),
-      meta: LogisticModel.PincodeMetaResponse(),
-      meta_code: LogisticModel.CountryMetaResponse(),
+      error: LogisticApplicationModel.PincodeErrorSchemaResponse().required(),
+      lat_long: LogisticApplicationModel.PincodeLatLongData(),
+      meta: LogisticApplicationModel.PincodeMetaResponse(),
+      meta_code: LogisticApplicationModel.CountryMetaResponse(),
       name: Joi.string().allow(""),
-      parents: Joi.array().items(LogisticModel.PincodeParentsResponse()),
+      parents: Joi.array().items(
+        LogisticApplicationModel.PincodeParentsResponse()
+      ),
       sub_type: Joi.string().allow(""),
       uid: Joi.string().allow(""),
     });
   }
+
+  /** @returns {PincodeErrorSchemaResponse} */
   static PincodeErrorSchemaResponse() {
     return Joi.object({
       message: Joi.string().allow("").allow(null),
@@ -83,18 +316,24 @@ class LogisticModel {
       value: Joi.string().allow("").allow(null),
     });
   }
+
+  /** @returns {PincodeLatLongData} */
   static PincodeLatLongData() {
     return Joi.object({
       coordinates: Joi.array().items(Joi.string().allow("")),
       type: Joi.string().allow(""),
     });
   }
+
+  /** @returns {PincodeMetaResponse} */
   static PincodeMetaResponse() {
     return Joi.object({
       internal_zone_id: Joi.number(),
       zone: Joi.string().allow(""),
     });
   }
+
+  /** @returns {PincodeParentsResponse} */
   static PincodeParentsResponse() {
     return Joi.object({
       display_name: Joi.string().allow(""),
@@ -103,6 +342,8 @@ class LogisticModel {
       uid: Joi.string().allow(""),
     });
   }
+
+  /** @returns {ReAssignStoreRequest} */
   static ReAssignStoreRequest() {
     return Joi.object({
       articles: Joi.array().items(Joi.any()).required(),
@@ -112,6 +353,8 @@ class LogisticModel {
       to_pincode: Joi.string().allow("").required(),
     });
   }
+
+  /** @returns {ReAssignStoreResponse} */
   static ReAssignStoreResponse() {
     return Joi.object({
       assigned_stores: Joi.array().items(Joi.any()),
@@ -121,30 +364,38 @@ class LogisticModel {
       to_pincode: Joi.string().allow("").required(),
     });
   }
+
+  /** @returns {TATArticlesRequest} */
   static TATArticlesRequest() {
     return Joi.object({
-      category: LogisticModel.TATCategoryRequest(),
+      category: LogisticApplicationModel.TATCategoryRequest(),
       manufacturing_time: Joi.number(),
       manufacturing_time_unit: Joi.string().allow(""),
     });
   }
+
+  /** @returns {TATArticlesResponse} */
   static TATArticlesResponse() {
     return Joi.object({
       _manufacturing_time_seconds: Joi.number(),
-      category: LogisticModel.TATCategoryRequest(),
-      error: LogisticModel.TATErrorSchemaResponse(),
+      category: LogisticApplicationModel.TATCategoryRequest(),
+      error: LogisticApplicationModel.TATErrorSchemaResponse(),
       is_cod_available: Joi.boolean(),
       manufacturing_time: Joi.number(),
       manufacturing_time_unit: Joi.string().allow(""),
-      promise: LogisticModel.TATPromiseResponse(),
+      promise: LogisticApplicationModel.TATPromiseResponse(),
     });
   }
+
+  /** @returns {TATCategoryRequest} */
   static TATCategoryRequest() {
     return Joi.object({
       id: Joi.number(),
       level: Joi.string().allow(""),
     });
   }
+
+  /** @returns {TATErrorSchemaResponse} */
   static TATErrorSchemaResponse() {
     return Joi.object({
       message: Joi.string().allow("").allow(null),
@@ -152,59 +403,77 @@ class LogisticModel {
       value: Joi.string().allow("").allow(null),
     });
   }
+
+  /** @returns {TATFormattedResponse} */
   static TATFormattedResponse() {
     return Joi.object({
       max: Joi.string().allow(""),
       min: Joi.string().allow(""),
     });
   }
+
+  /** @returns {TATLocationDetailsRequest} */
   static TATLocationDetailsRequest() {
     return Joi.object({
-      articles: Joi.array().items(LogisticModel.TATArticlesRequest()),
+      articles: Joi.array().items(
+        LogisticApplicationModel.TATArticlesRequest()
+      ),
       from_pincode: Joi.string().allow(""),
       fulfillment_id: Joi.number(),
     });
   }
+
+  /** @returns {TATLocationDetailsResponse} */
   static TATLocationDetailsResponse() {
     return Joi.object({
-      articles: Joi.array().items(LogisticModel.TATArticlesResponse()),
+      articles: Joi.array().items(
+        LogisticApplicationModel.TATArticlesResponse()
+      ),
       from_pincode: Joi.string().allow(""),
       fulfillment_id: Joi.number(),
     });
   }
+
+  /** @returns {TATPromiseResponse} */
   static TATPromiseResponse() {
     return Joi.object({
-      formatted: LogisticModel.TATFormattedResponse(),
-      timestamp: LogisticModel.TATTimestampResponse(),
+      formatted: LogisticApplicationModel.TATFormattedResponse(),
+      timestamp: LogisticApplicationModel.TATTimestampResponse(),
     });
   }
+
+  /** @returns {TATTimestampResponse} */
   static TATTimestampResponse() {
     return Joi.object({
       max: Joi.number(),
       min: Joi.number(),
     });
   }
+
+  /** @returns {TATViewRequest} */
   static TATViewRequest() {
     return Joi.object({
       action: Joi.string().allow(""),
       identifier: Joi.string().allow(""),
       journey: Joi.string().allow(""),
       location_details: Joi.array().items(
-        LogisticModel.TATLocationDetailsRequest()
+        LogisticApplicationModel.TATLocationDetailsRequest()
       ),
       source: Joi.string().allow(""),
       to_pincode: Joi.string().allow(""),
     });
   }
+
+  /** @returns {TATViewResponse} */
   static TATViewResponse() {
     return Joi.object({
       action: Joi.string().allow(""),
-      error: LogisticModel.TATErrorSchemaResponse(),
+      error: LogisticApplicationModel.TATErrorSchemaResponse(),
       identifier: Joi.string().allow(""),
       is_cod_available: Joi.boolean(),
       journey: Joi.string().allow(""),
       location_details: Joi.array().items(
-        LogisticModel.TATLocationDetailsResponse()
+        LogisticApplicationModel.TATLocationDetailsResponse()
       ),
       payment_mode: Joi.string().allow(""),
       request_uuid: Joi.string().allow(""),
@@ -216,4 +485,4 @@ class LogisticModel {
     });
   }
 }
-module.exports = LogisticModel;
+module.exports = LogisticApplicationModel;

package/sdk/application/Logistic/LogisticApplicationValidator.d.ts

@@ -1,8 +1,50 @@
-export = LogisticValidator;
-declare class LogisticValidator {
+export = LogisticApplicationValidator;
+/** @typedef GetAllCountriesParam */
+/**
+ * @typedef GetOptimalLocationsParam
+ * @property {LogisticApplicationModel.ReAssignStoreRequest} body
+ */
+/**
+ * @typedef GetPincodeCityParam
+ * @property {string} pincode - A `pincode` contains a specific address of a location.
+ */
+/**
+ * @typedef GetPincodeZonesParam
+ * @property {LogisticApplicationModel.GetZoneFromPincodeViewRequest} body
+ */
+/**
+ * @typedef GetTatProductParam
+ * @property {LogisticApplicationModel.TATViewRequest} body
+ */
+declare class LogisticApplicationValidator {
+    /** @returns {GetAllCountriesParam} */
     static getAllCountries(): any;
-    static getOptimalLocations(): any;
-    static getPincodeCity(): any;
-    static getPincodeZones(): any;
-    static getTatProduct(): any;
+    /** @returns {GetOptimalLocationsParam} */
+    static getOptimalLocations(): GetOptimalLocationsParam;
+    /** @returns {GetPincodeCityParam} */
+    static getPincodeCity(): GetPincodeCityParam;
+    /** @returns {GetPincodeZonesParam} */
+    static getPincodeZones(): GetPincodeZonesParam;
+    /** @returns {GetTatProductParam} */
+    static getTatProduct(): GetTatProductParam;
 }
+declare namespace LogisticApplicationValidator {
+    export { GetAllCountriesParam, GetOptimalLocationsParam, GetPincodeCityParam, GetPincodeZonesParam, GetTatProductParam };
+}
+type GetOptimalLocationsParam = {
+    body: LogisticApplicationModel.ReAssignStoreRequest;
+};
+type GetPincodeCityParam = {
+    /**
+     * - A `pincode` contains a specific address of a location.
+     */
+    pincode: string;
+};
+type GetPincodeZonesParam = {
+    body: LogisticApplicationModel.GetZoneFromPincodeViewRequest;
+};
+type GetTatProductParam = {
+    body: LogisticApplicationModel.TATViewRequest;
+};
+type GetAllCountriesParam = any;
+import LogisticApplicationModel = require("./LogisticApplicationModel");

package/sdk/application/Logistic/LogisticApplicationValidator.js

@@ -1,34 +1,62 @@
 const Joi = require("joi");
 
-const LogisticModel = require("./LogisticApplicationModel");
-class LogisticValidator {
+const LogisticApplicationModel = require("./LogisticApplicationModel");
+
+/** @typedef GetAllCountriesParam */
+
+/**
+ * @typedef GetOptimalLocationsParam
+ * @property {LogisticApplicationModel.ReAssignStoreRequest} body
+ */
+
+/**
+ * @typedef GetPincodeCityParam
+ * @property {string} pincode - A `pincode` contains a specific address of a location.
+ */
+
+/**
+ * @typedef GetPincodeZonesParam
+ * @property {LogisticApplicationModel.GetZoneFromPincodeViewRequest} body
+ */
+
+/**
+ * @typedef GetTatProductParam
+ * @property {LogisticApplicationModel.TATViewRequest} body
+ */
+
+class LogisticApplicationValidator {
+  /** @returns {GetAllCountriesParam} */
   static getAllCountries() {
     return Joi.object({});
   }
 
+  /** @returns {GetOptimalLocationsParam} */
   static getOptimalLocations() {
     return Joi.object({
-      body: LogisticModel.ReAssignStoreRequest().required(),
+      body: LogisticApplicationModel.ReAssignStoreRequest().required(),
     }).required();
   }
 
+  /** @returns {GetPincodeCityParam} */
   static getPincodeCity() {
     return Joi.object({
       pincode: Joi.string().allow("").required(),
     }).required();
   }
 
+  /** @returns {GetPincodeZonesParam} */
   static getPincodeZones() {
     return Joi.object({
-      body: LogisticModel.GetZoneFromPincodeViewRequest().required(),
+      body: LogisticApplicationModel.GetZoneFromPincodeViewRequest().required(),
     }).required();
   }
 
+  /** @returns {GetTatProductParam} */
   static getTatProduct() {
     return Joi.object({
-      body: LogisticModel.TATViewRequest().required(),
+      body: LogisticApplicationModel.TATViewRequest().required(),
     }).required();
   }
 }
 
-module.exports = LogisticValidator;
+module.exports = LogisticApplicationValidator;