@gofynd/fdk-client-javascript 1.3.11-beta.6 → 1.3.11-beta.8

package/sdk/application/Logistic/LogisticApplicationModel.js

@@ -13,6 +13,12 @@ const Joi = require("joi");
  * @property {string} [uid]
  */
 
+/**
+ * @typedef CountryHierarchy
+ * @property {string} [name]
+ * @property {string} [slug]
+ */
+
 /**
  * @typedef CountryListResponse
  * @property {CountryEntityResponse[]} [results]
@@ -24,6 +30,29 @@ const Joi = require("joi");
  * @property {string} [isd_code]
  */
 
+/**
+ * @typedef CountryObject
+ * @property {CurrencyObject} [currency]
+ * @property {string} [display_name]
+ * @property {CountryHierarchy[]} [hierarchy]
+ * @property {string} [id]
+ * @property {string} [iso2]
+ * @property {string} [iso3]
+ * @property {string} [latitude]
+ * @property {string} [longitude]
+ * @property {string} [name]
+ * @property {string} [phone_code]
+ * @property {string[]} [timezones]
+ * @property {string} [type]
+ */
+
+/**
+ * @typedef CurrencyObject
+ * @property {string} [code]
+ * @property {string} [name]
+ * @property {string} [symbol]
+ */
+
 /**
  * @typedef DP
  * @property {string} [area_code]
@@ -38,6 +67,126 @@ const Joi = require("joi");
  * @property {string} [transport_mode]
  */
 
+/**
+ * @typedef ErrorResponse
+ * @property {string} [error]
+ */
+
+/**
+ * @typedef FieldValidation
+ * @property {FieldValidationRegex} [regex]
+ * @property {string} [type]
+ */
+
+/**
+ * @typedef FieldValidationRegex
+ * @property {LengthValidation} [length]
+ * @property {string} [value]
+ */
+
+/**
+ * @typedef GetCountries
+ * @property {CountryObject[]} [items]
+ * @property {Page} [page]
+ */
+
+/**
+ * @typedef GetCountry
+ * @property {CurrencyObject} [currency]
+ * @property {string} [display_name]
+ * @property {GetCountryFields} [fields]
+ * @property {CountryHierarchy[]} [hierarchy]
+ * @property {string} [id]
+ * @property {string} [iso2]
+ * @property {string} [iso3]
+ * @property {string} [latitude]
+ * @property {string} [longitude]
+ * @property {string} [name]
+ * @property {string} [phone_code]
+ * @property {string[]} [timezones]
+ * @property {string} [type]
+ */
+
+/**
+ * @typedef GetCountryFields
+ * @property {GetCountryFieldsAddress[]} address
+ * @property {GetCountryFieldsAddressTemplate} address_template
+ * @property {string[]} serviceability_fields
+ */
+
+/**
+ * @typedef GetCountryFieldsAddress
+ * @property {string} display_name
+ * @property {boolean} [edit]
+ * @property {string} [error_text]
+ * @property {string} input
+ * @property {boolean} required
+ * @property {string} slug
+ * @property {FieldValidation} [validation]
+ * @property {GetCountryFieldsAddressValues} [values]
+ */
+
+/**
+ * @typedef GetCountryFieldsAddressTemplate
+ * @property {string} checkout_form
+ * @property {string} default_display
+ * @property {string} store_os_form
+ */
+
+/**
+ * @typedef GetCountryFieldsAddressValues
+ * @property {GetOneOrAll} [get_all]
+ * @property {GetOneOrAll} [get_one]
+ */
+
+/**
+ * @typedef GetLocalities
+ * @property {Localities[]} [items]
+ * @property {Page} [page]
+ */
+
+/**
+ * @typedef GetLocality
+ * @property {string} [display_name]
+ * @property {string} [id]
+ * @property {LocalityParent[]} [localities]
+ * @property {string} [name]
+ * @property {string[]} [parent_ids]
+ * @property {string} [type]
+ */
+
+/**
+ * @typedef GetOneOrAll
+ * @property {string} [operation_id]
+ * @property {GetOneOrAllParams} [params]
+ */
+
+/**
+ * @typedef GetOneOrAllParams
+ * @property {GetOneOrAllPath} [path]
+ * @property {GetOneOrAllQuery} [query]
+ */
+
+/**
+ * @typedef GetOneOrAllPath
+ * @property {string} [locality_type]
+ * @property {string} [locality_value]
+ */
+
+/**
+ * @typedef GetOneOrAllQuery
+ * @property {string} [city]
+ * @property {string} [country]
+ * @property {string} [sector]
+ * @property {string} [state]
+ */
+
+/**
+ * @typedef GetStoreResponse
+ * @property {StoreItemResponse[]} [items]
+ * @property {Page} [page]
+ */
+
 /**
  * @typedef GetZoneFromPincodeViewRequest
  * @property {string} country
@@ -50,11 +199,46 @@ const Joi = require("joi");
  * @property {string[]} zones
  */
 
+/**
+ * @typedef LengthValidation
+ * @property {number} [max]
+ * @property {number} [min]
+ */
+
+/**
+ * @typedef Localities
+ * @property {string} [display_name]
+ * @property {string} [id]
+ * @property {string} [name]
+ * @property {string[]} [parent_ids]
+ * @property {string} [type]
+ */
+
+/**
+ * @typedef LocalityParent
+ * @property {string} [display_name]
+ * @property {string} [id]
+ * @property {string} [name]
+ * @property {string[]} [parent_ids]
+ * @property {string} [type]
+ */
+
 /**
  * @typedef LogisticsResponse
  * @property {Object} [dp]
  */
 
+/**
+ * @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 PincodeApiResponse
  * @property {PincodeDataResponse[]} [data]
@@ -120,6 +304,18 @@ const Joi = require("joi");
  * @property {string} to_pincode
  */
 
+/**
+ * @typedef StoreItemResponse
+ * @property {number} [company_id]
+ * @property {string} [fulfillment_type]
+ * @property {number} [id]
+ * @property {number} [latitude]
+ * @property {number} [longitude]
+ * @property {number} [processing_time]
+ * @property {string} [store_type]
+ * @property {string[]} [tags]
+ */
+
 /**
  * @typedef TATArticlesRequest
  * @property {TATCategoryRequest} [category]
@@ -210,6 +406,32 @@ const Joi = require("joi");
  * @property {string} [to_pincode]
  */
 
+/**
+ * @typedef ValidateAddressRequest
+ * @property {string} [address] - A string representing the complete address,
+ *   combining address line 1, address line 2, area, landmark, sector, city,
+ *   state, and pincode. This provides a comprehensive view of the address details.
+ * @property {string} [address1] - A string representing the first line of the
+ *   address, typically containing street or building information.
+ * @property {string} [address2] - A string representing the second line of the
+ *   address, which can be used for additional address details if needed.
+ * @property {string} [area] - A string specifying the locality or area
+ *   associated with the address.
+ * @property {string} [city] - A string denoting the city or municipality of the address.
+ * @property {string} [email] - A string containing the recipient's email address.
+ * @property {string} [landmark] - A string representing a prominent nearby
+ *   landmark that aids in locating the address.
+ * @property {string} [name] - A string representing the recipient's name or the
+ *   organization name associated with the address.
+ * @property {string} [phone] - An integer representing the recipient's contact
+ *   phone number.
+ * @property {string} [pincode] - A string indicating the postal code or PIN
+ *   code of the address area.
+ * @property {string} [sector] - A string specifying the sector or district of
+ *   the address if applicable.
+ * @property {string} [state] - A string indicating the state or province of the address.
+ */
+
 class LogisticApplicationModel {
   /** @returns {CountryEntityResponse} */
   static CountryEntityResponse() {
@@ -226,6 +448,14 @@ class LogisticApplicationModel {
     });
   }
 
+  /** @returns {CountryHierarchy} */
+  static CountryHierarchy() {
+    return Joi.object({
+      name: Joi.string().allow(""),
+      slug: Joi.string().allow(""),
+    });
+  }
+
   /** @returns {CountryListResponse} */
   static CountryListResponse() {
     return Joi.object({
@@ -243,6 +473,33 @@ class LogisticApplicationModel {
     });
   }
 
+  /** @returns {CountryObject} */
+  static CountryObject() {
+    return Joi.object({
+      currency: LogisticApplicationModel.CurrencyObject(),
+      display_name: Joi.string().allow(""),
+      hierarchy: Joi.array().items(LogisticApplicationModel.CountryHierarchy()),
+      id: Joi.string().allow(""),
+      iso2: Joi.string().allow(""),
+      iso3: Joi.string().allow(""),
+      latitude: Joi.string().allow(""),
+      longitude: Joi.string().allow(""),
+      name: Joi.string().allow(""),
+      phone_code: Joi.string().allow(""),
+      timezones: Joi.array().items(Joi.string().allow("")),
+      type: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {CurrencyObject} */
+  static CurrencyObject() {
+    return Joi.object({
+      code: Joi.string().allow(""),
+      name: Joi.string().allow(""),
+      symbol: Joi.string().allow(""),
+    });
+  }
+
   /** @returns {DP} */
   static DP() {
     return Joi.object({
@@ -259,6 +516,162 @@ class LogisticApplicationModel {
     });
   }
 
+  /** @returns {ErrorResponse} */
+  static ErrorResponse() {
+    return Joi.object({
+      error: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {FieldValidation} */
+  static FieldValidation() {
+    return Joi.object({
+      regex: LogisticApplicationModel.FieldValidationRegex(),
+      type: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {FieldValidationRegex} */
+  static FieldValidationRegex() {
+    return Joi.object({
+      length: LogisticApplicationModel.LengthValidation(),
+      value: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {GetCountries} */
+  static GetCountries() {
+    return Joi.object({
+      items: Joi.array().items(LogisticApplicationModel.CountryObject()),
+      page: LogisticApplicationModel.Page(),
+    });
+  }
+
+  /** @returns {GetCountry} */
+  static GetCountry() {
+    return Joi.object({
+      currency: LogisticApplicationModel.CurrencyObject(),
+      display_name: Joi.string().allow(""),
+      fields: LogisticApplicationModel.GetCountryFields(),
+      hierarchy: Joi.array().items(LogisticApplicationModel.CountryHierarchy()),
+      id: Joi.string().allow(""),
+      iso2: Joi.string().allow(""),
+      iso3: Joi.string().allow(""),
+      latitude: Joi.string().allow(""),
+      longitude: Joi.string().allow(""),
+      name: Joi.string().allow(""),
+      phone_code: Joi.string().allow(""),
+      timezones: Joi.array().items(Joi.string().allow("")),
+      type: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {GetCountryFields} */
+  static GetCountryFields() {
+    return Joi.object({
+      address: Joi.array()
+        .items(LogisticApplicationModel.GetCountryFieldsAddress())
+        .required(),
+      address_template: LogisticApplicationModel.GetCountryFieldsAddressTemplate().required(),
+      serviceability_fields: Joi.array()
+        .items(Joi.string().allow(""))
+        .required(),
+    });
+  }
+
+  /** @returns {GetCountryFieldsAddress} */
+  static GetCountryFieldsAddress() {
+    return Joi.object({
+      display_name: Joi.string().allow("").required(),
+      edit: Joi.boolean(),
+      error_text: Joi.string().allow("").allow(null),
+      input: Joi.string().allow("").required(),
+      required: Joi.boolean().required(),
+      slug: Joi.string().allow("").required(),
+      validation: LogisticApplicationModel.FieldValidation(),
+      values: LogisticApplicationModel.GetCountryFieldsAddressValues(),
+    });
+  }
+
+  /** @returns {GetCountryFieldsAddressTemplate} */
+  static GetCountryFieldsAddressTemplate() {
+    return Joi.object({
+      checkout_form: Joi.string().allow("").required(),
+      default_display: Joi.string().allow("").required(),
+      store_os_form: Joi.string().allow("").required(),
+    });
+  }
+
+  /** @returns {GetCountryFieldsAddressValues} */
+  static GetCountryFieldsAddressValues() {
+    return Joi.object({
+      get_all: LogisticApplicationModel.GetOneOrAll(),
+      get_one: LogisticApplicationModel.GetOneOrAll(),
+    });
+  }
+
+  /** @returns {GetLocalities} */
+  static GetLocalities() {
+    return Joi.object({
+      items: Joi.array().items(LogisticApplicationModel.Localities()),
+      page: LogisticApplicationModel.Page(),
+    });
+  }
+
+  /** @returns {GetLocality} */
+  static GetLocality() {
+    return Joi.object({
+      display_name: Joi.string().allow(""),
+      id: Joi.string().allow(""),
+      localities: Joi.array().items(LogisticApplicationModel.LocalityParent()),
+      name: Joi.string().allow(""),
+      parent_ids: Joi.array().items(Joi.string().allow("")),
+      type: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {GetOneOrAll} */
+  static GetOneOrAll() {
+    return Joi.object({
+      operation_id: Joi.string().allow(""),
+      params: LogisticApplicationModel.GetOneOrAllParams(),
+    });
+  }
+
+  /** @returns {GetOneOrAllParams} */
+  static GetOneOrAllParams() {
+    return Joi.object({
+      path: LogisticApplicationModel.GetOneOrAllPath(),
+      query: LogisticApplicationModel.GetOneOrAllQuery(),
+    });
+  }
+
+  /** @returns {GetOneOrAllPath} */
+  static GetOneOrAllPath() {
+    return Joi.object({
+      locality_type: Joi.string().allow(""),
+      locality_value: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {GetOneOrAllQuery} */
+  static GetOneOrAllQuery() {
+    return Joi.object({
+      city: Joi.string().allow("").allow(null),
+      country: Joi.string().allow("").allow(null),
+      sector: Joi.string().allow("").allow(null),
+      state: Joi.string().allow("").allow(null),
+    });
+  }
+
+  /** @returns {GetStoreResponse} */
+  static GetStoreResponse() {
+    return Joi.object({
+      items: Joi.array().items(LogisticApplicationModel.StoreItemResponse()),
+      page: LogisticApplicationModel.Page(),
+    });
+  }
+
   /** @returns {GetZoneFromPincodeViewRequest} */
   static GetZoneFromPincodeViewRequest() {
     return Joi.object({
@@ -275,6 +688,36 @@ class LogisticApplicationModel {
     });
   }
 
+  /** @returns {LengthValidation} */
+  static LengthValidation() {
+    return Joi.object({
+      max: Joi.number().allow(null),
+      min: Joi.number().allow(null),
+    });
+  }
+
+  /** @returns {Localities} */
+  static Localities() {
+    return Joi.object({
+      display_name: Joi.string().allow(""),
+      id: Joi.string().allow(""),
+      name: Joi.string().allow(""),
+      parent_ids: Joi.array().items(Joi.string().allow("")),
+      type: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {LocalityParent} */
+  static LocalityParent() {
+    return Joi.object({
+      display_name: Joi.string().allow(""),
+      id: Joi.string().allow(""),
+      name: Joi.string().allow(""),
+      parent_ids: Joi.array().items(Joi.string().allow("")),
+      type: Joi.string().allow(""),
+    });
+  }
+
   /** @returns {LogisticsResponse} */
   static LogisticsResponse() {
     return Joi.object({
@@ -282,6 +725,19 @@ class LogisticApplicationModel {
     });
   }
 
+  /** @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 {PincodeApiResponse} */
   static PincodeApiResponse() {
     return Joi.object({
@@ -365,6 +821,20 @@ class LogisticApplicationModel {
     });
   }
 
+  /** @returns {StoreItemResponse} */
+  static StoreItemResponse() {
+    return Joi.object({
+      company_id: Joi.number(),
+      fulfillment_type: Joi.string().allow(""),
+      id: Joi.number(),
+      latitude: Joi.number(),
+      longitude: Joi.number(),
+      processing_time: Joi.number(),
+      store_type: Joi.string().allow(""),
+      tags: Joi.array().items(Joi.string().allow("")),
+    });
+  }
+
   /** @returns {TATArticlesRequest} */
   static TATArticlesRequest() {
     return Joi.object({
@@ -484,5 +954,23 @@ class LogisticApplicationModel {
       to_pincode: Joi.string().allow(""),
     });
   }
+
+  /** @returns {ValidateAddressRequest} */
+  static ValidateAddressRequest() {
+    return Joi.object({
+      address: Joi.string().allow(""),
+      address1: Joi.string().allow(""),
+      address2: Joi.string().allow(""),
+      area: Joi.string().allow(""),
+      city: Joi.string().allow(""),
+      email: Joi.string().allow(""),
+      landmark: Joi.string().allow(""),
+      name: Joi.string().allow(""),
+      phone: Joi.string().allow(""),
+      pincode: Joi.string().allow(""),
+      sector: Joi.string().allow(""),
+      state: Joi.string().allow(""),
+    });
+  }
 }
 module.exports = LogisticApplicationModel;