@gofynd/fdk-client-javascript 1.4.8-beta.2 → 1.4.8

package/sdk/application/Lead/LeadApplicationModel.js

@@ -2,158 +2,179 @@ const Joi = require("joi");
 
 /**
  * @typedef TicketHistoryPayload
- * @property {Object} value - Details of history event
+ * @property {Object} value - Details of history event.
  * @property {HistoryTypeEnum} type
  */
 
 /**
  * @typedef CustomFormSubmissionPayload
- * @property {Object[]} response - Form response
- * @property {TicketAsset[]} [attachments] - List of all attachments related to the form
+ * @property {Object[]} response - Custom form response.
+ * @property {TicketAsset[]} [attachments] - List of all attachments related to the form.
  */
 
 /**
  * @typedef SubmitCustomFormResponse
- * @property {string} message - Success message for form submission
+ * @property {string} message - Success message for form submission.
  * @property {Ticket} [ticket]
+ * @property {FormFieldResponse} [response]
+ */
+
+/**
+ * @typedef FormFieldResponse
+ * @property {string} [_id] - Unique identifier for a custom form response.
+ * @property {number} [__v] - Version of the form.
+ * @property {string} [application_id] - Unique identifier for a Sales channel.
+ * @property {string} [form_slug] - A short, human-readable, URL-friendly unique
+ *   identifier for a custom form.
+ * @property {CreatedOn} [created_on]
+ * @property {FormFieldResponseValues[]} [response] - Data related to
+ *   acknowledgement on submission of custom form.
+ */
+
+/**
+ * @typedef FormFieldResponseValues
+ * @property {string} [key] - Keyname of field against which the input was
+ *   filled in custom form.
  */
 
 /**
  * @typedef TicketContext
- * @property {string} [application_id] - Application ID related to the ticket
- * @property {string} company_id - Company ID related to the ticket
+ * @property {string} [application_id] - Unique identifier for a Sales channel.
+ * @property {string} company_id - Company ID related to the ticket.
  */
 
 /**
  * @typedef CreatedOn
- * @property {string} user_agent - Useragent details
+ * @property {string} user_agent - Useragent details.
  */
 
 /**
  * @typedef TicketAsset
- * @property {string} [display] - Display text for asset
- * @property {string} value - To be used for details
+ * @property {string} [display] - Display text for asset.
+ * @property {string} value - To be used for details.
  * @property {TicketAssetTypeEnum} type
  */
 
 /**
  * @typedef TicketContent
- * @property {string} title - Title for ticket
- * @property {string} [description] - Long description of issue
- * @property {TicketAsset[]} [attachments] - List of all attachments related to the ticket
+ * @property {string} title - Title for ticket.
+ * @property {string} [description] - Long description of issue.
+ * @property {TicketAsset[]} [attachments] - List of all attachments related to
+ *   the ticket.
  */
 
 /**
  * @typedef AddTicketPayload
- * @property {Object} [created_by] - Creator of the ticket
- * @property {string} [status] - Status of the ticket
+ * @property {Object} [created_by] - Creator of the ticket.
+ * @property {string} [status] - Status of the ticket.
  * @property {PriorityEnum} [priority]
- * @property {string} category - Category of the ticket
+ * @property {string} category - Category of the ticket.
  * @property {TicketContent} content
- * @property {Object} [_custom_json] - Optional custom data that needs to be sent
- * @property {string[]} [subscribers]
+ * @property {Object} [_custom_json] - Optional custom data that needs to be sent.
+ * @property {string[]} [subscribers] - List of emails to be informed for ticket updates.
  */
 
 /**
  * @typedef Priority
  * @property {PriorityEnum} key
- * @property {string} display - Display text for priority
- * @property {string} color - Color for priority
+ * @property {string} display - Display text for priority.
+ * @property {string} color - Color for priority.
  */
 
 /**
  * @typedef Status
- * @property {string} key - Key for status
- * @property {string} display - Display text for status
- * @property {string} color - Color for status
+ * @property {string} key - Key for status.
+ * @property {string} display - Display text for status.
+ * @property {string} color - Color for status.
  */
 
 /**
  * @typedef SubmitButton
- * @property {string} title - Title for submit button
- * @property {string} title_color - Title color submit button
- * @property {string} background_color - Color for submit button
+ * @property {string} title - Title for submit button.
+ * @property {string} title_color - Title color submit button.
+ * @property {string} background_color - Color for submit button.
  */
 
 /**
  * @typedef PollForAssignment
- * @property {number} duration - Duration for polling of staff
- * @property {string} message - Message for polling
- * @property {string} success_message - Message for successful polling
- * @property {string} failure_message - Message if polling failed
+ * @property {number} duration - Duration for polling of staff.
+ * @property {string} message - Message for polling.
+ * @property {string} success_message - Message for successful polling.
+ * @property {string} failure_message - Message if polling failed.
  */
 
 /**
  * @typedef CustomForm
- * @property {string} application_id - Application ID for form
- * @property {string} slug - Slug for the form, which is to be used for accessing the form
- * @property {string} [header_image] - Form header image that will be shown to the user
- * @property {string} title - Form title that will be shown to the user
- * @property {string} [description] - Form description that will be shown to the user
+ * @property {string} application_id - Application ID - Identifier for a Sales channel.
+ * @property {string} slug - Slug for the form, which is to be used for
+ *   accessing the form.
+ * @property {string} [header_image] - Form header image that will be shown to the user.
+ * @property {string} title - Form title that will be shown to the user.
+ * @property {string} [description] - Form description that will be shown to the user.
  * @property {Priority} priority
- * @property {boolean} login_required - Denotes if login is required to make a
- *   form response submission
- * @property {boolean} should_notify - Denotes if new response submission for
- *   the form should be notified to the assignees
+ * @property {boolean} login_required - If login is required to make a form
+ *   response submission.
+ * @property {boolean} should_notify - If new response submission for the form
+ *   should be notified to the assignees.
  * @property {string} [success_message] - Message that is to be shown on
- *   succesfull form response submission
+ *   successful form response submission.
  * @property {SubmitButton} [submit_button]
- * @property {Object[]} inputs - List of all the form fields
+ * @property {Object[]} inputs - List of all the form fields.
  * @property {CreatedOn} [created_on]
  * @property {PollForAssignment} [poll_for_assignment]
- * @property {string} _id - Unique identifier for the form
+ * @property {string} _id - Unique identifier for the form.
  */
 
 /**
  * @typedef FeedbackForm
- * @property {Object} [inputs] - Input details for the feed back form
- * @property {string} [title] - Title for the feed back form
- * @property {Object} [timestamps] - Gives details of category releted data
+ * @property {Object} [inputs] - Input details for the feedback form.
+ * @property {string} [title] - Title for the feedback form.
+ * @property {Object} [timestamps] - Timestamp details of feedback form.
  */
 
 /**
  * @typedef TicketCategory
- * @property {string} display - Category display value identifier
- * @property {string} key - Category key value identifier
+ * @property {string} display - Category display value identifier.
+ * @property {string} key - Category key value identifier.
  * @property {TicketCategory} [sub_categories]
- * @property {number} [group_id] - Group id of category releted data
+ * @property {number} [group_id] - Group id of category related data.
  * @property {FeedbackForm} [feedback_form]
  */
 
 /**
  * @typedef TicketHistory
- * @property {string} type - Type of the history event
- * @property {Object} value - Data of the history event
- * @property {string} ticket_id - Readable ticket number
+ * @property {string} type - Type of the history event.
+ * @property {Object} value - Data of the history event.
+ * @property {string} ticket_id - Readable ticket number.
  * @property {CreatedOn} [created_on]
- * @property {Object} [created_by] - User who created the history event
- * @property {string} _id - Unique identifier of the history event
- * @property {string} [updated_at] - Time of last update of the history event
- * @property {string} [created_at] - Time of creation of the history event
+ * @property {Object} [created_by] - User who created the history event.
+ * @property {string} _id - Unique identifier of the history event.
+ * @property {string} [updated_at] - Time of last update of the history event.
+ * @property {string} [created_at] - Time of creation of the history event.
  */
 
 /**
  * @typedef Ticket
  * @property {TicketContext} [context]
  * @property {CreatedOn} [created_on]
- * @property {string} [response_id] - Details of company and application
- *   realated to the ticket
+ * @property {string} [response_id] - Details of company and application related
+ *   to the ticket.
  * @property {TicketContent} [content]
  * @property {TicketCategory} category
- * @property {string} [sub_category] - Sub-category assigned to the ticket
+ * @property {string} [sub_category] - Sub-category assigned to the ticket.
  * @property {TicketSourceEnum} source
  * @property {Status} status
  * @property {Priority} priority
- * @property {Object} [created_by] - User details of ticket creator
- * @property {Object} [assigned_to] - Details of support staff to whom ticket is assigned
- * @property {string[]} [tags] - Tags relevant to ticket
- * @property {Object} [_custom_json] - Custom json relevant to the ticket
- * @property {boolean} [is_feedback_pending] - Denotes if feedback submission is
- *   pending for the ticket
- * @property {Object} [integration] - Integration type and its details of the ticket
- * @property {string} _id - Unique identifier for the ticket
- * @property {string} [updated_at] - Time when the ticket was last updated
- * @property {string} [created_at] - Time when the ticket was created
+ * @property {Object} [created_by] - User details of ticket creator.
+ * @property {Object} [assigned_to] - Details of support staff to whom ticket is assigned.
+ * @property {string[]} [tags] - Tags relevant to ticket.
+ * @property {Object} [_custom_json] - Custom json relevant to the ticket.
+ * @property {boolean} [is_feedback_pending] - If feedback submission is pending
+ *   for the ticket.
+ * @property {Object} [integration] - Integration type and its details of the ticket.
+ * @property {string} _id - Unique identifier for the ticket.
+ * @property {string} [updated_at] - Time when the ticket was last updated.
+ * @property {string} [created_at] - Time when the ticket was created.
  */
 
 /** @typedef {"low" | "medium" | "high" | "urgent"} PriorityEnum */
@@ -196,6 +217,28 @@ class LeadApplicationModel {
     return Joi.object({
       message: Joi.string().allow("").required(),
       ticket: LeadApplicationModel.Ticket(),
+      response: LeadApplicationModel.FormFieldResponse(),
+    });
+  }
+
+  /** @returns {FormFieldResponse} */
+  static FormFieldResponse() {
+    return Joi.object({
+      _id: Joi.string().allow(""),
+      __v: Joi.number(),
+      application_id: Joi.string().allow(""),
+      form_slug: Joi.string().allow(""),
+      created_on: LeadApplicationModel.CreatedOn(),
+      response: Joi.array().items(
+        LeadApplicationModel.FormFieldResponseValues()
+      ),
+    });
+  }
+
+  /** @returns {FormFieldResponseValues} */
+  static FormFieldResponseValues() {
+    return Joi.object({
+      key: Joi.string().allow(""),
     });
   }
 

package/sdk/application/Lead/LeadApplicationValidator.d.ts

@@ -1,7 +1,7 @@
 export = LeadApplicationValidator;
 /**
  * @typedef CreateHistoryParam
- * @property {string} id - Ticket ID for which history is created
+ * @property {string} id - Ticket ID for which history is created.
  * @property {LeadApplicationModel.TicketHistoryPayload} body
  */
 /**
@@ -10,15 +10,15 @@ export = LeadApplicationValidator;
  */
 /**
  * @typedef GetCustomFormParam
- * @property {string} slug - Slug of form whose response is getting submitted
+ * @property {string} slug - Slug of form whose response is getting submitted.
  */
 /**
  * @typedef GetTicketParam
- * @property {string} id - ID of ticket to be retrieved
+ * @property {string} id - ID of ticket to be retrieved.
  */
 /**
  * @typedef SubmitCustomFormParam
- * @property {string} slug - Slug of form whose response is getting submitted
+ * @property {string} slug - Slug of form whose response is getting submitted.
  * @property {LeadApplicationModel.CustomFormSubmissionPayload} body
  */
 declare class LeadApplicationValidator {
@@ -38,7 +38,7 @@ declare namespace LeadApplicationValidator {
 }
 type CreateHistoryParam = {
     /**
-     * - Ticket ID for which history is created
+     * - Ticket ID for which history is created.
      */
     id: string;
     body: LeadApplicationModel.TicketHistoryPayload;
@@ -48,19 +48,19 @@ type CreateTicketParam = {
 };
 type GetCustomFormParam = {
     /**
-     * - Slug of form whose response is getting submitted
+     * - Slug of form whose response is getting submitted.
      */
     slug: string;
 };
 type GetTicketParam = {
     /**
-     * - ID of ticket to be retrieved
+     * - ID of ticket to be retrieved.
      */
     id: string;
 };
 type SubmitCustomFormParam = {
     /**
-     * - Slug of form whose response is getting submitted
+     * - Slug of form whose response is getting submitted.
      */
     slug: string;
     body: LeadApplicationModel.CustomFormSubmissionPayload;

package/sdk/application/Lead/LeadApplicationValidator.js

@@ -4,7 +4,7 @@ const LeadApplicationModel = require("./LeadApplicationModel");
 
 /**
  * @typedef CreateHistoryParam
- * @property {string} id - Ticket ID for which history is created
+ * @property {string} id - Ticket ID for which history is created.
  * @property {LeadApplicationModel.TicketHistoryPayload} body
  */
 
@@ -15,17 +15,17 @@ const LeadApplicationModel = require("./LeadApplicationModel");
 
 /**
  * @typedef GetCustomFormParam
- * @property {string} slug - Slug of form whose response is getting submitted
+ * @property {string} slug - Slug of form whose response is getting submitted.
  */
 
 /**
  * @typedef GetTicketParam
- * @property {string} id - ID of ticket to be retrieved
+ * @property {string} id - ID of ticket to be retrieved.
  */
 
 /**
  * @typedef SubmitCustomFormParam
- * @property {string} slug - Slug of form whose response is getting submitted
+ * @property {string} slug - Slug of form whose response is getting submitted.
  * @property {LeadApplicationModel.CustomFormSubmissionPayload} body
  */
 

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

@@ -24,7 +24,7 @@ declare class Logistic {
      * @returns {Promise<LogisticApplicationModel.CountryListResponse>} - Success response
      * @name getAllCountries
      * @summary: Get deliverable countries
-     * @description: Retrieves a list of countries within the specified delivery zones for that application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getAllCountries/).
+     * @description: Get a list of countries within the specified delivery zones for that application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getAllCountries/).
      */
     getAllCountries({ requestHeaders }?: any, { responseHeaders }?: object): Promise<LogisticApplicationModel.CountryListResponse>;
     /**
@@ -34,7 +34,7 @@ declare class Logistic {
      * @returns {Promise<LogisticApplicationModel.GetCountries>} - Success response
      * @name getCountries
      * @summary: Get countries
-     * @description: Fetch the list of supported countries. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getCountries/).
+     * @description: List of supported countries. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getCountries/).
      */
     getCountries({ onboarding, pageNo, pageSize, q, requestHeaders }?: LogisticApplicationValidator.GetCountriesParam, { responseHeaders }?: object): Promise<LogisticApplicationModel.GetCountries>;
     /**
@@ -44,7 +44,7 @@ declare class Logistic {
      * @returns {Promise<LogisticApplicationModel.GetCountry>} - Success response
      * @name getCountry
      * @summary: Get country details
-     * @description: Fetch details about a particular country and its address format customized for different business scenarios. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getCountry/).
+     * @description: Get details about a particular country and its address format customized for different business scenarios. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getCountry/).
      */
     getCountry({ countryIsoCode, requestHeaders }?: LogisticApplicationValidator.GetCountryParam, { responseHeaders }?: object): Promise<LogisticApplicationModel.GetCountry>;
     /**
@@ -54,7 +54,7 @@ declare class Logistic {
      * @returns {Promise<LogisticApplicationModel.GetLocalities>} - Success response
      * @name getLocalities
      * @summary: Get localities
-     * @description: Retrieve geographical data for a specific type of locality based on the provided filters. For instance, obtain a list of cities for a given country and state. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getLocalities/).
+     * @description: Get geographical data for a specific type of locality based on the provided filters. For instance, obtain a list of cities for a given country and state. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getLocalities/).
      */
     getLocalities({ localityType, country, state, city, pageNo, pageSize, q, requestHeaders, }?: LogisticApplicationValidator.GetLocalitiesParam, { responseHeaders }?: object): Promise<LogisticApplicationModel.GetLocalities>;
     /**
@@ -64,7 +64,7 @@ declare class Logistic {
      * @returns {Promise<LogisticApplicationModel.GetLocality>} - Success response
      * @name getLocality
      * @summary: Get locality detail
-     * @description: Retrieve detailed geographical data for a specific locality, such as a pincode. For example, for a pincode value of 400603, the service returns its parent locations, including city, state, and country details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getLocality/).
+     * @description: Get detailed geographical data for a specific locality, such as a pincode. For example, for a pincode value of 400603, the service returns its parent locations, including city, state, and country details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getLocality/).
      */
     getLocality({ localityType, localityValue, country, state, city, requestHeaders }?: LogisticApplicationValidator.GetLocalityParam, { responseHeaders }?: object): Promise<LogisticApplicationModel.GetLocality>;
     /**
@@ -74,7 +74,7 @@ declare class Logistic {
      * @returns {Promise<LogisticApplicationModel.GetStoreResponse>} - Success response
      * @name getLocations
      * @summary: Get available selling locations
-     * @description: Retrieves stores available for the application based on Delivery Zones and Order Orchestration rules. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getLocations/).
+     * @description: Get stores available for the application based on Delivery Zones and Order Orchestration rules. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getLocations/).
      */
     getLocations({ xApplicationId, xApplicationData, country, state, city, pincode, sector, pageNo, pageSize, requestHeaders, }?: LogisticApplicationValidator.GetLocationsParam, { responseHeaders }?: object): Promise<LogisticApplicationModel.GetStoreResponse>;
     /**
@@ -85,7 +85,7 @@ declare class Logistic {
      *   Success response
      * @name getOptimalLocations
      * @summary: Get selling locations
-     * @description: Determines and returns the best fulfillment center for customers by analyzing their location, product availability, and inventory levels. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getOptimalLocations/).
+     * @description: Get optimal fulfillment centre for customers by analyzing their location, product availability, and inventory levels. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getOptimalLocations/).
      */
     getOptimalLocations({ body, requestHeaders }?: LogisticApplicationValidator.GetOptimalLocationsParam, { responseHeaders }?: object): Promise<LogisticApplicationModel.ReAssignStoreResponse>;
     /**
@@ -95,7 +95,7 @@ declare class Logistic {
      * @returns {Promise<LogisticApplicationModel.PincodeApiResponse>} - Success response
      * @name getPincodeCity
      * @summary: Get pincode details
-     * @description: Retrieve details of a specific pincode, such as obtaining its city and state information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getPincodeCity/).
+     * @description: Get details of a specific pincode, such as obtaining its city and state information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getPincodeCity/).
      */
     getPincodeCity({ pincode, requestHeaders }?: LogisticApplicationValidator.GetPincodeCityParam, { responseHeaders }?: object): Promise<LogisticApplicationModel.PincodeApiResponse>;
     /**
@@ -107,7 +107,7 @@ declare class Logistic {
      *
      * @name getPincodeZones
      * @summary: Get zones
-     * @description: Retrieve the delivery zone associated with a given pincode - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getPincodeZones/).
+     * @description: Get the delivery zone associated with a given pincode. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getPincodeZones/).
      */
     getPincodeZones({ body, requestHeaders }?: LogisticApplicationValidator.GetPincodeZonesParam, { responseHeaders }?: object): Promise<LogisticApplicationModel.GetZoneFromPincodeViewResponse>;
     /**
@@ -117,7 +117,7 @@ declare class Logistic {
      * @returns {Promise<LogisticApplicationModel.TATViewResponse>} - Success response
      * @name getTatProduct
      * @summary: Get product's turnaround time
-     * @description: Retrieve the estimated delivery timeframe for a specific product from a designated store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getTatProduct/).
+     * @description: Get the estimated delivery time frame for a specific product from a designated store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getTatProduct/).
      */
     getTatProduct({ body, requestHeaders }?: LogisticApplicationValidator.GetTatProductParam, { responseHeaders }?: object): Promise<LogisticApplicationModel.TATViewResponse>;
     /**

package/sdk/application/Logistic/LogisticApplicationClient.js

@@ -54,7 +54,7 @@ class Logistic {
    * @returns {Promise<LogisticApplicationModel.CountryListResponse>} - Success response
    * @name getAllCountries
    * @summary: Get deliverable countries
-   * @description: Retrieves a list of countries within the specified delivery zones for that application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getAllCountries/).
+   * @description: Get a list of countries within the specified delivery zones for that application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getAllCountries/).
    */
   async getAllCountries(
     { requestHeaders } = { requestHeaders: {} },
@@ -132,7 +132,7 @@ class Logistic {
    * @returns {Promise<LogisticApplicationModel.GetCountries>} - Success response
    * @name getCountries
    * @summary: Get countries
-   * @description: Fetch the list of supported countries. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getCountries/).
+   * @description: List of supported countries. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getCountries/).
    */
   async getCountries(
     { onboarding, pageNo, pageSize, q, requestHeaders } = {
@@ -216,7 +216,7 @@ class Logistic {
    * @returns {Promise<LogisticApplicationModel.GetCountry>} - Success response
    * @name getCountry
    * @summary: Get country details
-   * @description: Fetch details about a particular country and its address format customized for different business scenarios. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getCountry/).
+   * @description: Get details about a particular country and its address format customized for different business scenarios. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getCountry/).
    */
   async getCountry(
     { countryIsoCode, requestHeaders } = { requestHeaders: {} },
@@ -294,7 +294,7 @@ class Logistic {
    * @returns {Promise<LogisticApplicationModel.GetLocalities>} - Success response
    * @name getLocalities
    * @summary: Get localities
-   * @description: Retrieve geographical data for a specific type of locality based on the provided filters. For instance, obtain a list of cities for a given country and state. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getLocalities/).
+   * @description: Get geographical data for a specific type of locality based on the provided filters. For instance, obtain a list of cities for a given country and state. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getLocalities/).
    */
   async getLocalities(
     {
@@ -387,7 +387,7 @@ class Logistic {
    * @returns {Promise<LogisticApplicationModel.GetLocality>} - Success response
    * @name getLocality
    * @summary: Get locality detail
-   * @description: Retrieve detailed geographical data for a specific locality, such as a pincode. For example, for a pincode value of 400603, the service returns its parent locations, including city, state, and country details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getLocality/).
+   * @description: Get detailed geographical data for a specific locality, such as a pincode. For example, for a pincode value of 400603, the service returns its parent locations, including city, state, and country details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getLocality/).
    */
   async getLocality(
     { localityType, localityValue, country, state, city, requestHeaders } = {
@@ -470,7 +470,7 @@ class Logistic {
    * @returns {Promise<LogisticApplicationModel.GetStoreResponse>} - Success response
    * @name getLocations
    * @summary: Get available selling locations
-   * @description: Retrieves stores available for the application based on Delivery Zones and Order Orchestration rules. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getLocations/).
+   * @description: Get stores available for the application based on Delivery Zones and Order Orchestration rules. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getLocations/).
    */
   async getLocations(
     {
@@ -589,7 +589,7 @@ class Logistic {
    *   Success response
    * @name getOptimalLocations
    * @summary: Get selling locations
-   * @description: Determines and returns the best fulfillment center for customers by analyzing their location, product availability, and inventory levels. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getOptimalLocations/).
+   * @description: Get optimal fulfillment centre for customers by analyzing their location, product availability, and inventory levels. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getOptimalLocations/).
    */
   async getOptimalLocations(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -669,7 +669,7 @@ class Logistic {
    * @returns {Promise<LogisticApplicationModel.PincodeApiResponse>} - Success response
    * @name getPincodeCity
    * @summary: Get pincode details
-   * @description: Retrieve details of a specific pincode, such as obtaining its city and state information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getPincodeCity/).
+   * @description: Get details of a specific pincode, such as obtaining its city and state information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getPincodeCity/).
    */
   async getPincodeCity(
     { pincode, requestHeaders } = { requestHeaders: {} },
@@ -749,7 +749,7 @@ class Logistic {
    *
    * @name getPincodeZones
    * @summary: Get zones
-   * @description: Retrieve the delivery zone associated with a given pincode - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getPincodeZones/).
+   * @description: Get the delivery zone associated with a given pincode. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getPincodeZones/).
    */
   async getPincodeZones(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -827,7 +827,7 @@ class Logistic {
    * @returns {Promise<LogisticApplicationModel.TATViewResponse>} - Success response
    * @name getTatProduct
    * @summary: Get product's turnaround time
-   * @description: Retrieve the estimated delivery timeframe for a specific product from a designated store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getTatProduct/).
+   * @description: Get the estimated delivery time frame for a specific product from a designated store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getTatProduct/).
    */
   async getTatProduct(
     { body, requestHeaders } = { requestHeaders: {} },