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

package/sdk/application/Order/OrderApplicationModel.js

@@ -2,40 +2,50 @@ const Joi = require("joi");
 
 /**
  * @typedef OrderPage
- * @property {string} [type]
- * @property {number} [item_total]
- * @property {number} [current]
- * @property {number} [size]
- * @property {boolean} [has_next]
+ * @property {string} [type] - Specifies type of pagination. If it is 'cursor'
+ *   based or 'number' based.
+ * @property {number} [item_total] - Total number of items available across all
+ *   pages. It provides a count of all the items that match the query criteria,
+ *   regardless of pagination.
+ * @property {number} [current] - Specifies the current page number. It helps in
+ *   identifying the position within the paginated results.
+ * @property {number} [size] - Represents the number of items on the current
+ *   page. It indicates how many items are included in each page of the
+ *   paginated response.
+ * @property {boolean} [has_next] - Indicates whether there is a next page
+ *   available. It is true if a next page exists and false if the current page
+ *   is the last one.
  */
 
 /**
  * @typedef UserInfo
- * @property {string} [first_name]
- * @property {string} [gender]
- * @property {string} [name]
- * @property {string} [last_name]
- * @property {string} [mobile]
- * @property {string} [email]
+ * @property {string} [first_name] - First name of the user.
+ * @property {string} [gender] - Gender of the user.
+ * @property {string} [name] - Full name of the user (including first and last names).
+ * @property {string} [last_name] - Last name of the user.
+ * @property {string} [mobile] - Mobile number of the user.
+ * @property {string} [email] - Email address of the user.
  */
 
 /**
  * @typedef BreakupValues
- * @property {number} [value]
- * @property {string} [currency_symbol]
- * @property {string} [name]
- * @property {string} [display]
- * @property {string} [currency_code]
+ * @property {number} [value] - The numerical value associated with the entity.
+ * @property {string} [currency_symbol] - Symbol representing the currency used
+ *   for the value.
+ * @property {string} [name] - The official name of the entity.
+ * @property {string} [display] - The name of the entity as it should be displayed.
+ * @property {string} [currency_code] - The international currency code
+ *   representing the currency used for the value.
  */
 
 /**
  * @typedef ShipmentPayment
- * @property {string} [mop]
- * @property {string} [payment_mode]
- * @property {string} [status]
- * @property {string} [mode]
- * @property {string} [logo]
- * @property {string} [display_name]
+ * @property {string} [mop] - Abbreviation or code for the payment mode.
+ * @property {string} [payment_mode] - The specific payment mode used.
+ * @property {string} [status] - The current status of the payment.
+ * @property {string} [mode] - The payment mode.
+ * @property {string} [logo] - URL of the logo representing the payment mode.
+ * @property {string} [display_name] - The name to be displayed for the payment mode.
  */
 
 /**
@@ -43,361 +53,411 @@ const Joi = require("joi");
  * @property {string} [mop] - Stands for "Mode of Payment". This is a short code
  *   (like "COD" for Cash On Delivery) that represents the payment method used.
  * @property {string} [payment_mode] - Information about the payment mode,
- *   indicates whether COD or PREPAID
+ *   indicates whether COD or PREPAID.
  * @property {string} [status] - Indicates the current status of the payment,
- *   Paid or Unpaid
- * @property {string} [mode] - Information about the payment source. For eg, NB_ICICI
- * @property {string} [logo] - A URL to an image representing the payment method
+ *   Paid or Unpaid.
+ * @property {string} [mode] - Information about the payment source. For eg, NB_ICICI.
+ * @property {string} [logo] - A URL to an image representing the payment method.
  * @property {string} [display_name] - The name of the payment method as it
- *   should be displayed to the user
- * @property {number} [amount] - Amount paid using this payment method
+ *   should be displayed to the user.
+ * @property {number} [amount] - Amount paid using this payment method.
  */
 
 /**
  * @typedef ShipmentUserInfo
- * @property {string} [first_name]
- * @property {string} [gender]
- * @property {string} [name]
- * @property {string} [last_name]
- * @property {string} [mobile]
- * @property {string} [email]
+ * @property {string} [first_name] - The unique identifier of the store.
+ * @property {string} [gender] - A code associated with the store.
+ * @property {string} [name] - The name of the store.
+ * @property {string} [last_name] - The name of the company associated with the store.
+ * @property {string} [mobile] - The identifier of the company associated with the store.
+ * @property {string} [email] - Email address of the user.
  */
 
 /**
  * @typedef FulfillingStore
- * @property {number} [id]
- * @property {string} [code]
- * @property {string} [name]
- * @property {string} [company_name]
- * @property {number} [company_id]
+ * @property {number} [id] - The unique identifier of the store.
+ * @property {string} [code] - A code associated with the store.
+ * @property {string} [name] - The name of the store.
+ * @property {string} [company_name] - The name of the company associated with the store.
+ * @property {number} [company_id] - The identifier of the company associated
+ *   with the store.
  */
 
 /**
  * @typedef ShipmentStatus
- * @property {string} [value]
- * @property {string} [title]
- * @property {string} [hex_code]
+ * @property {string} [value] - The internal or code value representing the
+ *   shipment status.
+ * @property {string} [title] - The title or display name representing the
+ *   shipment status.
+ * @property {string} [hex_code] - The hexadecimal color code associated with
+ *   the shipment status.
  */
 
 /**
  * @typedef Invoice
- * @property {string} [invoice_url]
- * @property {string} [updated_date]
- * @property {string} [label_url]
+ * @property {string} [invoice_url] - URL providing access to the invoice.
+ * @property {string} [updated_date] - The date and time when the invoice was
+ *   last updated.
+ * @property {string} [label_url] - URL providing access to the invoice label.
  */
 
 /**
  * @typedef NestedTrackingDetails
- * @property {boolean} [is_passed]
- * @property {string} [time]
- * @property {boolean} [is_current]
- * @property {string} [status]
+ * @property {boolean} [is_passed] - Indicates whether the tracking event has
+ *   passed or occurred.
+ * @property {string} [time] - The time associated with the tracking event.
+ * @property {boolean} [is_current] - Indicates whether the tracking event is
+ *   the current or active status.
+ * @property {string} [status] - The status of the tracking event.
  */
 
 /**
  * @typedef TrackingDetails
- * @property {string} [value]
- * @property {boolean} [is_current]
- * @property {boolean} [is_passed]
- * @property {string} [status]
- * @property {string} [time]
- * @property {string} [created_ts]
- * @property {NestedTrackingDetails[]} [tracking_details]
+ * @property {string} [value] - Current value or state of the process.
+ * @property {boolean} [is_current] - Indicates whether the tracking event is
+ *   the current or active status.
+ * @property {boolean} [is_passed] - Indicates whether the tracking event has
+ *   passed or occurred.
+ * @property {string} [status] - The status of the tracking event.
+ * @property {string} [time] - The time associated with the tracking event.
+ * @property {string} [created_ts] - Timestamp when this status was created.
+ * @property {NestedTrackingDetails[]} [tracking_details] - Nested tracking details.
  */
 
 /**
  * @typedef TimeStampData
- * @property {string} [min]
- * @property {string} [max]
+ * @property {string} [min] - The minimum timestamp value.
+ * @property {string} [max] - The maximum timestamp value.
  */
 
 /**
  * @typedef Promise
- * @property {boolean} [show_promise]
+ * @property {boolean} [show_promise] - Indicates whether the promise details
+ *   should be shown.
  * @property {TimeStampData} [timestamp]
  */
 
 /**
  * @typedef ShipmentTotalDetails
- * @property {number} [pieces]
- * @property {number} [total_price]
- * @property {number} [sizes]
+ * @property {number} [pieces] - The total number of pieces included.
+ * @property {number} [total_price] - The total price of the order or item.
+ * @property {number} [sizes] - The number of different sizes included.
  */
 
 /**
  * @typedef Prices
- * @property {number} [delivery_charge]
- * @property {number} [coupon_value]
- * @property {number} [brand_calculated_amount]
- * @property {number} [value_of_good]
- * @property {number} [price_marked]
- * @property {number} [coupon_effective_discount]
- * @property {string} [currency_symbol]
- * @property {number} [discount]
- * @property {number} [gst_tax_percentage]
- * @property {number} [cod_charges]
- * @property {number} [amount_paid]
- * @property {boolean} [added_to_fynd_cash]
- * @property {number} [transfer_price]
- * @property {number} [cashback_applied]
- * @property {number} [price_effective]
- * @property {number} [cashback]
- * @property {number} [refund_credit]
- * @property {number} [amount_paid_roundoff]
- * @property {number} [promotion_effective_discount]
- * @property {number} [refund_amount]
- * @property {string} [currency_code]
- * @property {number} [fynd_credits]
- * @property {number} [amount_to_be_collected]
+ * @property {number} [delivery_charge] - The delivery charge for the order.
+ * @property {number} [coupon_value] - The value of the coupon applied.
+ * @property {number} [brand_calculated_amount] - The amount calculated by the brand.
+ * @property {number} [value_of_good] - The value of the goods before tax and
+ *   other charges.
+ * @property {number} [price_marked] - The original marked price of the item.
+ * @property {number} [coupon_effective_discount] - The effective discount from coupons.
+ * @property {string} [currency_symbol] - The symbol of the currency used.
+ * @property {number} [discount] - The discount applied to the item.
+ * @property {number} [gst_tax_percentage] - The GST tax percentage applied.
+ * @property {number} [cod_charges] - The cash on delivery charges, if applicable.
+ * @property {number} [amount_paid] - The total amount paid by the customer.
+ * @property {boolean} [added_to_fynd_cash] - Indicates if the refund amount was
+ *   added to Fynd Cash.
+ * @property {number} [transfer_price] - The transfer price of the item.
+ * @property {number} [cashback_applied] - The amount of cashback applied.
+ * @property {number} [price_effective] - The effective price after all adjustments.
+ * @property {number} [cashback] - The cashback amount earned.
+ * @property {number} [refund_credit] - The amount credited for refund .
+ * @property {number} [amount_paid_roundoff] - The rounded-off amount paid by
+ *   the customer.
+ * @property {number} [promotion_effective_discount] - The effective discount
+ *   from promotions.
+ * @property {number} [refund_amount] - The amount refunded to the customer.
+ * @property {string} [currency_code] - The code of the currency used.
+ * @property {number} [fynd_credits] - The amount of Fynd credits used.
+ * @property {number} [amount_to_be_collected] - The total amount that needs to
+ *   be collected from the customer.
  */
 
 /**
  * @typedef ItemBrand
- * @property {string} [logo]
- * @property {string} [name]
+ * @property {string} [logo] - The URL of the brand's logo.
+ * @property {string} [name] - The name of the brand.
  */
 
 /**
  * @typedef Item
- * @property {string[]} [image]
- * @property {string[]} [l1_categories]
+ * @property {string[]} [image] - An array of URLs pointing to images of the item.
+ * @property {string[]} [l1_categories] - An array of level 1 categories the item belongs.
  * @property {ItemBrand} [brand]
- * @property {string} [seller_identifier]
- * @property {string} [code]
- * @property {number} [id]
- * @property {string} [name]
- * @property {string} [l3_category_name]
- * @property {string} [slug_key]
- * @property {string[]} [l2_categories]
- * @property {string} [size]
- * @property {Object} [attributes]
+ * @property {string} [seller_identifier] - The identifier for the seller .
+ * @property {string} [code] - The code or SKU of the item.
+ * @property {number} [id] - The unique identifier of the item.
+ * @property {string} [name] - The name of the item.
+ * @property {string} [l3_category_name] - The level 3 category name.
+ * @property {string} [slug_key] - A unique key or identifier for the item slug.
+ * @property {string[]} [l2_categories] - An array of level 2 categories the
+ *   item belongs to.
+ * @property {string} [size] - The size of the item.
+ * @property {Object} [attributes] - An object containing various attributes of the item.
  */
 
 /**
  * @typedef AppliedFreeArticles
- * @property {string} [article_id]
- * @property {Object} [free_gift_item_details]
- * @property {string} [parent_item_identifier]
- * @property {number} [quantity]
+ * @property {string} [article_id] - The unique identifier for the article.
+ * @property {Object} [free_gift_item_details] - An object containing details
+ *   about the free gift item.
+ * @property {string} [parent_item_identifier] - The identifier for the parent
+ *   item to which this free article is related.
+ * @property {number} [quantity] - The quantity of the free article.
  */
 
 /**
  * @typedef AppliedPromos
- * @property {boolean} [mrp_promotion]
- * @property {string} [promotion_name]
- * @property {number} [article_quantity]
- * @property {string} [promo_id]
- * @property {number} [amount]
- * @property {string} [promotion_type]
- * @property {AppliedFreeArticles[]} [applied_free_articles]
+ * @property {boolean} [mrp_promotion] - Indicates if the promotion is applied to the MRP.
+ * @property {string} [promotion_name] - The name of the promotion .
+ * @property {number} [article_quantity] - The quantity of articles required to
+ *   qualify for the promotion.
+ * @property {string} [promo_id] - The unique identifier for the promotion.
+ * @property {number} [amount] - The discount amount provided by the promotion.
+ * @property {string} [promotion_type] - The type of promotion.
+ * @property {AppliedFreeArticles[]} [applied_free_articles] - An array
+ *   containing details of free articles applied under the promotion.
  */
 
 /**
  * @typedef Identifiers
- * @property {string} [ean]
- * @property {string} [sku_code]
+ * @property {string} [ean] - The European Article Number (EAN) of the item.
+ * @property {string} [sku_code] - The Stock Keeping Unit (SKU) code of the item.
  */
 
 /**
  * @typedef FinancialBreakup
- * @property {number} [coupon_value]
- * @property {number} [delivery_charge]
- * @property {number} [brand_calculated_amount]
- * @property {number} [value_of_good]
- * @property {number} [price_marked]
- * @property {number} [coupon_effective_discount]
- * @property {string} [hsn_code]
- * @property {number} [discount]
- * @property {number} [gst_tax_percentage]
- * @property {number} [cod_charges]
- * @property {number} [amount_paid]
- * @property {boolean} [added_to_fynd_cash]
- * @property {string} [size]
- * @property {number} [transfer_price]
- * @property {number} [cashback_applied]
- * @property {number} [price_effective]
- * @property {number} [cashback]
- * @property {number} [refund_credit]
- * @property {number} [amount_paid_roundoff]
- * @property {number} [total_units]
+ * @property {number} [coupon_value] - The value of the coupon applied.
+ * @property {number} [delivery_charge] - The delivery charge for the order.
+ * @property {number} [brand_calculated_amount] - The amount calculated by the brand.
+ * @property {number} [value_of_good] - The value of the goods before tax and
+ *   other charges.
+ * @property {number} [price_marked] - The original marked price of the item.
+ * @property {number} [coupon_effective_discount] - The effective discount from coupons.
+ * @property {string} [hsn_code] - The HSN (Harmonized System of Nomenclature)
+ *   code of the item.
+ * @property {number} [discount] - The discount applied to the item.
+ * @property {number} [gst_tax_percentage] - The GST tax percentage applied .
+ * @property {number} [cod_charges] - The cash on delivery charges, if applicable.
+ * @property {number} [amount_paid] - The total amount paid by the customer.
+ * @property {boolean} [added_to_fynd_cash] - Indicates if the refund amount was
+ *   added to Fynd Cash.
+ * @property {string} [size] - The size of the item .
+ * @property {number} [transfer_price] - The transfer price of the item.
+ * @property {number} [cashback_applied] - The amount of cashback applied.
+ * @property {number} [price_effective] - The effective price after all adjustments.
+ * @property {number} [cashback] - The cashback amount earned.
+ * @property {number} [refund_credit] - The amount credited for refund .
+ * @property {number} [amount_paid_roundoff] - The rounded-off amount paid by
+ *   the customer.
+ * @property {number} [total_units] - The total number of units purchased.
  * @property {Identifiers} [identifiers]
- * @property {string} [gst_tag]
- * @property {string} [item_name]
- * @property {number} [promotion_effective_discount]
- * @property {number} [gst_fee]
- * @property {number} [refund_amount]
- * @property {number} [fynd_credits]
- * @property {number} [amount_to_be_collected]
+ * @property {string} [gst_tag] - The GST tag indicating the type of GST applied.
+ * @property {string} [item_name] - The name of the item.
+ * @property {number} [promotion_effective_discount] - The effective discount
+ *   from promotions.
+ * @property {number} [gst_fee] - The GST fee applied to the item.
+ * @property {number} [refund_amount] - The amount refunded to the customer.
+ * @property {number} [fynd_credits] - The amount of Fynd credits used.
+ * @property {number} [amount_to_be_collected] - The total amount that needs to
+ *   be collected from the customer.
  */
 
 /**
  * @typedef CurrentStatus
- * @property {string} [updated_at]
- * @property {string} [name]
- * @property {string} [status]
- * @property {string} [journey_type]
+ * @property {string} [updated_at] - The date and time when the status was last updated.
+ * @property {string} [name] - The name or label indicating the current state or status.
+ * @property {string} [status] - The current status of the bag.
+ * @property {string} [journey_type] - The type of journey for the shipment,
+ *   indicating the direction of the shipment.
  */
 
 /**
  * @typedef Bags
- * @property {string} [delivery_date]
- * @property {number} [line_number]
- * @property {string} [currency_symbol]
+ * @property {string} [delivery_date] - The date and time when the item is
+ *   expected to be delivered .
+ * @property {number} [line_number] - The line number of the item in the order.
+ * @property {string} [currency_symbol] - The symbol of the currency used.
  * @property {Item} [item]
- * @property {AppliedPromos[]} [applied_promos]
- * @property {number} [quantity]
+ * @property {AppliedPromos[]} [applied_promos] - An array containing
+ *   information about applied promotions.
+ * @property {number} [quantity] - The quantity of the item.
  * @property {Prices} [prices]
- * @property {boolean} [can_cancel]
- * @property {boolean} [can_return]
- * @property {number} [id]
- * @property {string} [returnable_date]
- * @property {FinancialBreakup[]} [financial_breakup]
- * @property {Object} [parent_promo_bags]
- * @property {Object} [meta]
- * @property {string} [currency_code]
- * @property {string} [seller_identifier]
+ * @property {boolean} [can_cancel] - Indicates if the item can be canceled.
+ * @property {boolean} [can_return] - Indicates if the item can be returned.
+ * @property {number} [id] - The unique identifier for the order item.
+ * @property {string} [returnable_date] - The last date and time by which the
+ *   item can be returned.
+ * @property {FinancialBreakup[]} [financial_breakup] - An array containing
+ *   financial details of the item.
+ * @property {Object} [parent_promo_bags] - An object containing details of
+ *   parent promotional bags.
+ * @property {Object} [meta] - An object containing metadata for the item.
+ * @property {string} [currency_code] - The code of the currency used.
+ * @property {string} [seller_identifier] - The identifier for the seller.
  * @property {CurrentStatus} [current_status]
  * @property {Article} [article]
  */
 
 /**
  * @typedef FulfillingCompany
- * @property {number} [id]
- * @property {string} [name]
+ * @property {number} [id] - The unique identifier for the fulfilling company.
+ * @property {string} [name] - The name of the fulfilling company.
  */
 
 /**
  * @typedef Article
- * @property {string[]} [tags]
+ * @property {string[]} [tags] - An array of tags associated with the article.
  */
 
 /**
  * @typedef Address
- * @property {string} [pincode]
- * @property {string} [phone]
- * @property {number} [latitude]
- * @property {string} [address2]
- * @property {string} [landmark]
- * @property {string} [area]
- * @property {string} [city]
- * @property {string} [address]
- * @property {string} [address_type]
- * @property {number} [longitude]
- * @property {string} [country_iso_code]
- * @property {string} [state]
- * @property {string} [created_at]
- * @property {string} [address1]
- * @property {string} [display_address]
- * @property {string} [name]
- * @property {string} [contact_person]
- * @property {string} [address_category]
- * @property {string} [email]
- * @property {string} [country_phone_code]
- * @property {string} [version]
- * @property {string} [updated_at]
- * @property {string} [country]
+ * @property {string} [pincode] - The postal code of the address.
+ * @property {string} [phone] - The phone number of the person associated with
+ *   the address.
+ * @property {number} [latitude] - The latitude coordinate.
+ * @property {string} [address2] - The secondary line of the address.
+ * @property {string} [landmark] - A nearby landmark.
+ * @property {string} [area] - The area or locality.
+ * @property {string} [city] - The city of the address.
+ * @property {string} [address] - The full address.
+ * @property {string} [address_type] - The type of address.
+ * @property {number} [longitude] - The longitude coordinate.
+ * @property {string} [country_iso_code] - The ISO code for the country.
+ * @property {string} [state] - The state of the address.
+ * @property {string} [created_at] - The date and time when the address was created.
+ * @property {string} [address1] - The primary line of the address.
+ * @property {string} [display_address] - The formatted display address,
+ *   typically used for printing or displaying in user interfaces.
+ * @property {string} [name] - The name of the person associated with the address.
+ * @property {string} [contact_person] - The name of the contact person.
+ * @property {string} [address_category] - The category of the address.
+ * @property {string} [email] - The email address.
+ * @property {string} [country_phone_code] - The country phone code.
+ * @property {string} [version] - The version of the address format.
+ * @property {string} [updated_at] - The date and time when the address was last updated .
+ * @property {string} [country] - The country of the address.
  */
 
 /**
  * @typedef Shipments
  * @property {ShipmentPayment} [payment]
- * @property {ShipmentPaymentInfo[]} [payment_info] - "Array of objects
+ * @property {ShipmentPaymentInfo[]} [payment_info] - Array of objects
  *   containing payment methods used for placing an order. Each object will
- *   provide information about corresponding payment method with relevant details."
- * @property {string} [order_type]
- * @property {string} [gstin_code]
- * @property {boolean} [show_download_invoice]
- * @property {boolean} [can_cancel]
+ *   provide information about corresponding payment method with relevant details.
+ * @property {string} [order_type] - The type of order.
+ * @property {string} [gstin_code] - The GSTIN code for the shipment.
+ * @property {boolean} [show_download_invoice] - Indicates if the download
+ *   invoice option should be shown.
+ * @property {boolean} [can_cancel] - Indicates if the shipment can be canceled.
  * @property {ShipmentUserInfo} [user_info]
- * @property {string} [shipment_id]
+ * @property {string} [shipment_id] - The unique identifier for the shipment.
  * @property {FulfillingStore} [fulfilling_store]
- * @property {Object[]} [custom_meta]
+ * @property {Object[]} [custom_meta] - An object containing custom metadata for
+ *   the shipment.
  * @property {ShipmentStatus} [shipment_status]
- * @property {string} [comment]
+ * @property {string} [comment] - Any comments related to the shipment.
  * @property {Invoice} [invoice]
- * @property {boolean} [show_track_link]
- * @property {Object} [refund_details]
- * @property {BreakupValues[]} [breakup_values]
- * @property {Object} [can_break]
- * @property {string} [traking_no]
- * @property {TrackingDetails[]} [tracking_details]
+ * @property {boolean} [show_track_link] - Indicates if the track link should be shown.
+ * @property {Object} [refund_details] - An object containing details of any refunds.
+ * @property {BreakupValues[]} [breakup_values] - An array containing the
+ *   breakup of various charges and discounts.
+ * @property {Object} [can_break] - An object containing details about the
+ *   breakability of the shipment.
+ * @property {string} [traking_no] - The tracking number for the shipment.
+ * @property {TrackingDetails[]} [tracking_details] - An array containing
+ *   details of the tracking history of the shipment.
  * @property {Promise} [promise]
- * @property {number} [total_bags]
+ * @property {number} [total_bags] - The total number of bags in the shipment.
  * @property {ShipmentTotalDetails} [total_details]
  * @property {Prices} [prices]
- * @property {string} [returnable_date]
- * @property {string} [shipment_created_at]
- * @property {string} [shipment_created_ts]
- * @property {Object} [size_info]
- * @property {Bags[]} [bags]
- * @property {string} [dp_name]
- * @property {string} [awb_no]
- * @property {boolean} [beneficiary_details]
+ * @property {string} [returnable_date] - The last date by which the item can be returned.
+ * @property {string} [shipment_created_at] - The date and time when the
+ *   shipment was created.
+ * @property {string} [shipment_created_ts] - The timestamp when the shipment was created.
+ * @property {Object} [size_info] - An object containing size information for
+ *   the items in the shipment.
+ * @property {Bags[]} [bags] - An array containing details about the individual
+ *   bags in the shipment.
+ * @property {string} [dp_name] - The name of the delivery partner.
+ * @property {string} [awb_no] - The airway bill number for the shipment.
+ * @property {boolean} [beneficiary_details] - Indicates if there are any
+ *   beneficiary details.
  * @property {FulfillingCompany} [fulfilling_company]
- * @property {boolean} [can_return]
+ * @property {boolean} [can_return] - Indicates if the shipment can be returned.
  * @property {Address} [delivery_address]
  * @property {Address} [billing_address]
- * @property {string} [track_url]
- * @property {string} [order_id]
- * @property {string} [need_help_url]
- * @property {Object} [return_meta]
- * @property {string} [delivery_date]
+ * @property {string} [track_url] - The URL for tracking the shipment.
+ * @property {string} [order_id] - The unique identifier for the order.
+ * @property {string} [need_help_url] - The URL for customer support or help.
+ * @property {Object} [return_meta] - An object containing metadata about the
+ *   return process.
+ * @property {string} [delivery_date] - The expected delivery date.
  * @property {OrderRequest} [order]
  */
 
 /**
  * @typedef BagsForReorderArticleAssignment
- * @property {string} [strategy]
- * @property {string} [level]
+ * @property {string} [strategy] - The strategy used for article assignment.
+ * @property {string} [level] - The level at which the article assignment is made.
  */
 
 /**
  * @typedef BagsForReorder
- * @property {string} [item_size]
- * @property {number} [quantity]
- * @property {number} [store_id]
+ * @property {string} [item_size] - The size of the item.
+ * @property {number} [quantity] - The quantity of the item.
+ * @property {number} [store_id] - The identifier for the store.
  * @property {BagsForReorderArticleAssignment} [article_assignment]
- * @property {number} [seller_id]
- * @property {number} [item_id]
+ * @property {number} [seller_id] - The identifier for the seller.
+ * @property {number} [item_id] - The unique identifier for the item.
  */
 
 /**
  * @typedef OrderSchema
- * @property {number} [total_shipments_in_order]
- * @property {string} [gstin_code]
+ * @property {number} [total_shipments_in_order] - The total number of shipments
+ *   in the order.
+ * @property {string} [gstin_code] - The GSTIN code for the shipment.
  * @property {UserInfo} [user_info]
- * @property {BreakupValues[]} [breakup_values]
- * @property {string} [order_created_time]
- * @property {string} [order_created_ts]
- * @property {string} [order_id]
- * @property {Shipments[]} [shipments]
- * @property {BagsForReorder[]} [bags_for_reorder]
- * @property {Object} [meta]
+ * @property {BreakupValues[]} [breakup_values] - An array containing the
+ *   breakup of various charges and discounts.
+ * @property {string} [order_created_time] - The date and time when the order was created.
+ * @property {string} [order_created_ts] - The timestamp when the order was created.
+ * @property {string} [order_id] - The unique identifier for the order.
+ * @property {Shipments[]} [shipments] - An array containing details of
+ *   individual shipments within the order.
+ * @property {BagsForReorder[]} [bags_for_reorder] - An array containing details
+ *   of bags available for reorder.
+ * @property {Object} [meta] - An object containing additional metadata for the order.
  */
 
 /**
  * @typedef OrderStatuses
- * @property {number} [value]
- * @property {boolean} [is_selected]
- * @property {string} [display]
+ * @property {number} [value] - The value representing the selection.
+ * @property {boolean} [is_selected] - Indicates whether this option is
+ *   currently selected.
+ * @property {string} [display] - The text to display .
  */
 
 /**
  * @typedef OrderFilters
- * @property {OrderStatuses[]} [statuses]
+ * @property {OrderStatuses[]} [statuses] - An array containing the order statuses.
  */
 
 /**
  * @typedef OrderList
  * @property {OrderPage} [page]
- * @property {OrderSchema[]} [items]
+ * @property {OrderSchema[]} [items] - List of orders, each containing detailed
+ *   information about individual orders and their respective shipments.
  * @property {OrderFilters} [filters]
  */
 
 /**
  * @typedef ApefaceApiError
- * @property {string} [message]
- * @property {boolean} [success]
+ * @property {string} [message] - Contains any message related to the operation.
+ * @property {boolean} [success] - Indicates if the operation was successful.
  */
 
 /**
@@ -412,213 +472,227 @@ const Joi = require("joi");
 
 /**
  * @typedef ResponseGetInvoiceShipment
- * @property {string} presigned_type
- * @property {boolean} success
- * @property {string} shipment_id
- * @property {string} presigned_url
+ * @property {string} presigned_type - Type of presigned URL.
+ * @property {boolean} success - Indicates if the operation was successful .
+ * @property {string} shipment_id - Identifier for the shipment.
+ * @property {string} presigned_url - The presigned URL for accessing the
+ *   shipment data, obtained from the response data.
  */
 
 /**
  * @typedef Track
- * @property {string} [account_name]
- * @property {string} [shipment_type]
- * @property {string} [status]
- * @property {string} [last_location_recieved_at]
- * @property {string} [updated_time]
- * @property {string} [updated_at]
- * @property {string} [reason]
- * @property {string} [awb]
+ * @property {string} [account_name] - The name of the account handling the shipment.
+ * @property {string} [shipment_type] - The type of shipment.
+ * @property {string} [status] - The current status of the shipment.
+ * @property {string} [last_location_recieved_at] - The last known location of
+ *   the shipment.
+ * @property {string} [updated_time] - The timestamp of the last update.
+ * @property {string} [updated_at] - The date and time when the shipment was last updated.
+ * @property {string} [reason] - The reason or additional information about the shipment.
+ * @property {string} [awb] - The Air Waybill (AWB) number for the shipment.
  */
 
 /**
  * @typedef ShipmentTrack
- * @property {Track[]} [results]
+ * @property {Track[]} [results] - A array containing tracking details.
  */
 
 /**
  * @typedef CustomerDetailsResponse
- * @property {string} [phone]
- * @property {string} [shipment_id]
- * @property {string} [name]
- * @property {string} [order_id]
- * @property {string} [country]
+ * @property {string} [phone] - Customer's phone number.
+ * @property {string} [shipment_id] - Unique identifier of the shipment.
+ * @property {string} [name] - Customer's name.
+ * @property {string} [order_id] - Unique identifier of the order.
+ * @property {string} [country] - Country of the customer.
  */
 
 /**
  * @typedef SendOtpToCustomerResponse
- * @property {string} [request_id]
- * @property {string} [message]
- * @property {boolean} [success]
- * @property {number} [resend_timer]
+ * @property {string} [request_id] - Unique identifier for the request.
+ * @property {string} [message] - Message indicating the result of the request.
+ * @property {boolean} [success] - Indicates whether the request was successful.
+ * @property {number} [resend_timer] - Time in seconds before the OTP can be resent.
  */
 
 /**
  * @typedef VerifyOtp
- * @property {string} [otp_code]
- * @property {string} [request_id]
+ * @property {string} [otp_code] - The OTP code provided by the user for verification.
+ * @property {string} [request_id] - Unique identifier for the request.
  */
 
 /**
  * @typedef VerifyOtpResponse
- * @property {boolean} [success]
+ * @property {boolean} [success] - Indicates whether the request was successful.
  */
 
 /**
  * @typedef BagReasonMeta
- * @property {boolean} [show_text_area]
+ * @property {boolean} [show_text_area] - Indicates whether to display a text
+ *   box on the front end.
  */
 
 /**
  * @typedef QuestionSet
- * @property {number} [id]
- * @property {string} [display_name]
+ * @property {number} [id] - The unique identifier for the question.
+ * @property {string} [display_name] - The text displayed for the question.
  */
 
 /**
  * @typedef BagReasons
- * @property {string[]} [qc_type]
- * @property {number} [id]
- * @property {string} [display_name]
+ * @property {string[]} [qc_type] - A list of quality check types.
+ * @property {number} [id] - The unique identifier.
+ * @property {string} [display_name] - The text displayed.
  * @property {BagReasonMeta} [meta]
- * @property {QuestionSet[]} [question_set]
- * @property {BagReasons[]} [reasons]
+ * @property {QuestionSet[]} [question_set] - A list of questions for delivery partner.
+ * @property {BagReasons[]} [reasons] - A list of reasons.
  */
 
 /**
  * @typedef ShipmentBagReasons
- * @property {BagReasons[]} [reasons]
- * @property {boolean} [success]
+ * @property {BagReasons[]} [reasons] - A list of shipment's bag reasons.
+ * @property {boolean} [success] - Indicates if the operation was successful.
  */
 
 /**
  * @typedef ShipmentReason
- * @property {number} [priority]
- * @property {boolean} [show_text_area]
- * @property {number} [reason_id]
- * @property {string} [feedback_type]
- * @property {string} [reason_text]
- * @property {string} [flow]
+ * @property {number} [priority] - The priority level of the reason.
+ * @property {boolean} [show_text_area] - A flag indicating whether to show a
+ *   textbox on the frontend.
+ * @property {number} [reason_id] - The unique identifier for the reason.
+ * @property {string} [feedback_type] - The type of feedback.
+ * @property {string} [reason_text] - The text describing the reason.
+ * @property {string} [flow] - The process flow related to the reason.
  */
 
 /**
  * @typedef ShipmentReasons
- * @property {ShipmentReason[]} [reasons]
+ * @property {ShipmentReason[]} [reasons] - A list of shipment reasons.
  */
 
 /**
  * @typedef ProductsReasonsData
- * @property {number} [reason_id]
- * @property {string} [reason_text]
+ * @property {number} [reason_id] - The unique identifier for the reason.
+ * @property {string} [reason_text] - The text describing the reason.
  */
 
 /**
  * @typedef ProductsReasonsFilters
- * @property {number} [line_number]
- * @property {number} [quantity]
- * @property {string} [identifier]
+ * @property {number} [line_number] - The specific line item of bag.
+ * @property {number} [quantity] - The quantity of the product.
+ * @property {string} [identifier] - The unique identifier for the product.
  */
 
 /**
  * @typedef ProductsReasons
  * @property {ProductsReasonsData} [data]
- * @property {ProductsReasonsFilters[]} [filters]
+ * @property {ProductsReasonsFilters[]} [filters] - Criteria applied to filter
+ *   the products.
  */
 
 /**
  * @typedef EntityReasonData
- * @property {number} [reason_id]
- * @property {string} [reason_text]
+ * @property {number} [reason_id] - The unique identifier for the reason.
+ * @property {string} [reason_text] - The text describing the reason.
  */
 
 /**
  * @typedef EntitiesReasons
  * @property {EntityReasonData} [data]
- * @property {Object[]} [filters]
+ * @property {Object[]} [filters] - Criteria applied to filter the shipment.
  */
 
 /**
  * @typedef ReasonsData
- * @property {ProductsReasons[]} [products]
- * @property {EntitiesReasons[]} [entities]
+ * @property {ProductsReasons[]} [products] - Reasons data for bags.
+ * @property {EntitiesReasons[]} [entities] - Reasons data for shipments.
  */
 
 /**
  * @typedef Products
- * @property {number} [line_number]
- * @property {number} [quantity]
- * @property {string} [identifier]
+ * @property {number} [line_number] - The specific line item of bag.
+ * @property {number} [quantity] - The quantity of the product.
+ * @property {string} [identifier] - The unique identifier for the product.
  */
 
 /**
  * @typedef ProductsDataUpdatesFilters
- * @property {number} [line_number]
- * @property {string} [identifier]
+ * @property {number} [line_number] - The specific line item of bag.
+ * @property {string} [identifier] - The quantity of the product.
  */
 
 /**
  * @typedef ProductsDataUpdates
- * @property {Object} [data]
- * @property {ProductsDataUpdatesFilters[]} [filters]
+ * @property {Object} [data] - Information about the data to be updated.
+ * @property {ProductsDataUpdatesFilters[]} [filters] - Criteria applied to
+ *   filter the products.
  */
 
 /**
  * @typedef EntitiesDataUpdates
- * @property {Object} [data]
- * @property {Object[]} [filters]
+ * @property {Object} [data] - Information about the data to be updated.
+ * @property {Object[]} [filters] - Criteria applied to filter the shipments.
  */
 
 /**
  * @typedef DataUpdates
- * @property {ProductsDataUpdates[]} [products]
- * @property {EntitiesDataUpdates[]} [entities]
+ * @property {ProductsDataUpdates[]} [products] - Data updates for bags.
+ * @property {EntitiesDataUpdates[]} [entities] - Data updates for shipments.
  */
 
 /**
  * @typedef ShipmentsRequest
  * @property {ReasonsData} [reasons]
- * @property {Products[]} [products]
+ * @property {Products[]} [products] - Specific bag to be updated.
  * @property {DataUpdates} [data_updates]
- * @property {string} identifier
+ * @property {string} identifier - The unique identifier for request which is
+ *   the shipment_id.
  */
 
 /**
  * @typedef StatuesRequest
- * @property {ShipmentsRequest[]} [shipments]
- * @property {string} [exclude_bags_next_state]
- * @property {string} [status]
+ * @property {ShipmentsRequest[]} [shipments] - A list containing information
+ *   about shipments.
+ * @property {string} [exclude_bags_next_state] - State to be change for
+ *   Remaining Bag/Products.
+ * @property {string} [status] - The status to which the entity is to be transitioned.
  */
 
 /**
  * @typedef OrderRequest
- * @property {Object} [meta]
+ * @property {Object} [meta] - Metadata for the order.
  */
 
 /**
  * @typedef UpdateShipmentStatusRequest
- * @property {StatuesRequest[]} [statuses]
- * @property {boolean} [task]
- * @property {boolean} [lock_after_transition]
- * @property {boolean} [force_transition]
- * @property {boolean} [unlock_before_transition]
+ * @property {StatuesRequest[]} [statuses] - An array containing different status details.
+ * @property {boolean} [task] - Indicates whether the task is active or required.
+ * @property {boolean} [lock_after_transition] - Indicates whether the status
+ *   should be locked after the transition.
+ * @property {boolean} [force_transition] - Indicates whether the transition
+ *   should be forced.
+ * @property {boolean} [unlock_before_transition] - Indicates whether the status
+ *   should be unlocked before the transition.
  */
 
 /**
  * @typedef StatusesBodyResponse
- * @property {Object[]} [shipments]
+ * @property {Object[]} [shipments] - List of shipments.
  */
 
 /**
  * @typedef ShipmentApplicationStatusResponse
- * @property {StatusesBodyResponse[]} [statuses]
+ * @property {StatusesBodyResponse[]} [statuses] - An array containing different
+ *   status options of shipments.
  */
 
 /**
  * @typedef ErrorResponse
- * @property {string} [code]
- * @property {string} [message]
- * @property {number} [status]
- * @property {string} [exception]
- * @property {string} [stack_trace]
+ * @property {string} [code] - The HTTP status code of the response.
+ * @property {string} [message] - A message providing details about the response.
+ * @property {number} [status] - An additional code providing more context about
+ *   the response.
+ * @property {string} [exception] - Details of any exception that occurred.
+ * @property {string} [stack_trace] - The stack trace of any exception that occurred.
  */
 
 class OrderApplicationModel {