@gofynd/fdk-client-javascript 3.3.5 → 3.3.6

package/sdk/platform/Order/OrderPlatformClient.js

@@ -22,7 +22,7 @@ class Order {
    *   Success response
    * @name addStateManagerConfig
    * @summary: Allows esm config updation
-   * @description: Update ESM config - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/addStateManagerConfig/).
+   * @description: Update ESM config - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/addStateManagerConfig/).
    */
   async addStateManagerConfig(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -102,7 +102,7 @@ class Order {
    *   Success response
    * @name attachOrderUser
    * @summary: Attach order to a user
-   * @description: Attach an anonymous order to a customer based on OTP verification - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/attachOrderUser/).
+   * @description: Attach an anonymous order to a customer based on OTP verification - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/attachOrderUser/).
    */
   async attachOrderUser(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -181,7 +181,7 @@ class Order {
    * @returns {Promise<OrderPlatformModel.BulkListingResponseSchema>} - Success response
    * @name bulkListing
    * @summary: Lists bulk operations
-   * @description: Get list of bulk operation that is initiated and completed as per the filters provided - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/bulkListing/).
+   * @description: Get list of bulk operation that is initiated and completed as per the filters provided - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/bulkListing/).
    */
   async bulkListing(
     {
@@ -288,7 +288,7 @@ class Order {
    *
    * @name bulkStateTransistion
    * @summary: Upload bulk state transitions file
-   * @description: Performs state transisiton in bulk using the CSV or excel file for the given shipments. The bulk transition CSV or excel template can be downloaded using the seller template download method. Current supported format is excel and CSV. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/bulkStateTransistion/).
+   * @description: Performs state transisiton in bulk using the CSV or excel file for the given shipments. The bulk transition CSV or excel template can be downloaded using the seller template download method. Current supported format is excel and CSV. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/bulkStateTransistion/).
    */
   async bulkStateTransistion(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -367,7 +367,7 @@ class Order {
    * @returns {Promise<OrderPlatformModel.OrderStatusResult>} - Success response
    * @name checkOrderStatus
    * @summary: Debug order
-   * @description: Used to verify the status of order. It queries error logs, resyncs the shipments if there was an issue with sync etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/checkOrderStatus/).
+   * @description: Used to verify the status of order. It queries error logs, resyncs the shipments if there was an issue with sync etc. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/checkOrderStatus/).
    */
   async checkOrderStatus(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -448,7 +448,7 @@ class Order {
    *
    * @name createChannelConfig
    * @summary: Create channel configuration
-   * @description: Set up configuration for a channel specific to orders which has implications over how the order fulfilment happens in a channel - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/createChannelConfig/).
+   * @description: Set up configuration for a channel specific to orders which has implications over how the order fulfilment happens in a channel - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/createChannelConfig/).
    */
   async createChannelConfig(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -527,7 +527,7 @@ class Order {
    * @returns {Promise<OrderPlatformModel.CreateOrderResponseSchema>} - Success response
    * @name createOrder
    * @summary: Create order
-   * @description: Creates an order - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/createOrder/).
+   * @description: Creates an order - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/createOrder/).
    */
   async createOrder(
     { body, xOrderingSource, requestHeaders } = { requestHeaders: {} },
@@ -607,7 +607,7 @@ class Order {
    * @returns {Promise<OrderPlatformModel.SuccessResponseSchema>} - Success response
    * @name dispatchManifests
    * @summary: Dispatch manifest
-   * @description: Updates the status of the manifest to processed and change the status of the shipments in the manifest to dispatch status - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/dispatchManifests/).
+   * @description: Updates the status of the manifest to processed and change the status of the shipments in the manifest to dispatch status - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/dispatchManifests/).
    */
   async dispatchManifests(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -686,7 +686,7 @@ class Order {
    * @returns {Promise<OrderPlatformModel.FileResponseSchema>} - Success response
    * @name downloadBulkActionTemplate
    * @summary: Download bulk template
-   * @description: Download bulk seller templates which can be used to perform operations in bulk - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/downloadBulkActionTemplate/).
+   * @description: Download bulk seller templates which can be used to perform operations in bulk - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/downloadBulkActionTemplate/).
    */
   async downloadBulkActionTemplate(
     { templateSlug, requestHeaders } = { requestHeaders: {} },
@@ -770,7 +770,7 @@ class Order {
    *
    * @name downloadLanesReport
    * @summary: Download Lane report
-   * @description: Downloads shipments/orders present in the provided lane - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/downloadLanesReport/).
+   * @description: Downloads shipments/orders present in the provided lane - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/downloadLanesReport/).
    */
   async downloadLanesReport(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -850,7 +850,7 @@ class Order {
    *   Success response
    * @name eInvoiceRetry
    * @summary: Retry E-invoice
-   * @description: Reattempt the generation of an E-invoice - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/eInvoiceRetry/).
+   * @description: Reattempt the generation of an E-invoice - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/eInvoiceRetry/).
    */
   async eInvoiceRetry(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -927,7 +927,7 @@ class Order {
    * @returns {Promise<OrderPlatformModel.FailedOrderLogDetails>} - Success response
    * @name failedOrderLogDetails
    * @summary: Get failed order log
-   * @description: Get the exact error trace from the log Id provided in the failed order list API response  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/failedOrderLogDetails/).
+   * @description: Get the exact error trace from the log Id provided in the failed order list API response  - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/failedOrderLogDetails/).
    */
   async failedOrderLogDetails(
     { logId, requestHeaders } = { requestHeaders: {} },
@@ -1006,7 +1006,7 @@ class Order {
    * @returns {Promise<OrderPlatformModel.FailedOrderLogs>} - Success response
    * @name failedOrderLogs
    * @summary: List failed order logs
-   * @description: Get failed order logs listing for filters based on order Id, user contact number, user email Id and sales channel Id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/failedOrderLogs/).
+   * @description: Get failed order logs listing for filters based on order Id, user contact number, user email Id and sales channel Id. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/failedOrderLogs/).
    */
   async failedOrderLogs(
     {
@@ -1106,7 +1106,7 @@ class Order {
    *   Success response
    * @name fetchRefundModeConfig
    * @summary: List refund modes
-   * @description: Get list of refund modes to trigger refunds - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/fetchRefundModeConfig/).
+   * @description: Get list of refund modes to trigger refunds - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/fetchRefundModeConfig/).
    */
   async fetchRefundModeConfig(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -1186,7 +1186,7 @@ class Order {
    *   Success response
    * @name generateInvoiceID
    * @summary: Generate and attach invoice Id
-   * @description: Generate and attach Invoice Ids against shipments. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/generateInvoiceID/).
+   * @description: Generate and attach Invoice Ids against shipments. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/generateInvoiceID/).
    */
   async generateInvoiceID(
     { invoiceType, body, requestHeaders } = { requestHeaders: {} },
@@ -1269,7 +1269,7 @@ class Order {
    *
    * @name generatePOSReceiptByOrderId
    * @summary: Generate POS receipt by order Id
-   * @description: Create a point-of-sale (POS) receipt for a specific order by order Id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/generatePOSReceiptByOrderId/).
+   * @description: Create a point-of-sale (POS) receipt for a specific order by order Id. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/generatePOSReceiptByOrderId/).
    */
   async generatePOSReceiptByOrderId(
     { orderId, shipmentId, documentType, requestHeaders } = {
@@ -1358,7 +1358,7 @@ class Order {
    * @returns {Promise<OrderPlatformModel.ManifestResponseSchema>} - Success response
    * @name generateProcessManifest
    * @summary: Process Order Manifest
-   * @description: Endpoint to save and process order manifests. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/generateProcessManifest/).
+   * @description: Endpoint to save and process order manifests. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/generateProcessManifest/).
    */
   async generateProcessManifest(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -1438,7 +1438,7 @@ class Order {
    *   Success response
    * @name getAllowedStateTransition
    * @summary: Get allowed state transition
-   * @description: Retrieve next possible states based on logged in user's role - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getAllowedStateTransition/).
+   * @description: Retrieve next possible states based on logged in user's role - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getAllowedStateTransition/).
    */
   async getAllowedStateTransition(
     { status, orderingChannel, orderingSource, requestHeaders } = {
@@ -1529,7 +1529,7 @@ class Order {
    *   Success response
    * @name getAllowedTemplatesForBulk
    * @summary: List bulk operation templates
-   * @description: Gets all the allowed templates to perform bulk operations. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getAllowedTemplatesForBulk/).
+   * @description: Gets all the allowed templates to perform bulk operations. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getAllowedTemplatesForBulk/).
    */
   async getAllowedTemplatesForBulk(
     { requestHeaders } = { requestHeaders: {} },
@@ -1607,7 +1607,7 @@ class Order {
    *   Success response
    * @name getAnnouncements
    * @summary: List announcements
-   * @description: Retrieve announcements related to orders fulfilment configured by platform or company admin - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getAnnouncements/).
+   * @description: Retrieve announcements related to orders fulfilment configured by platform or company admin - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getAnnouncements/).
    */
   async getAnnouncements(
     { date, requestHeaders } = { requestHeaders: {} },
@@ -1689,7 +1689,7 @@ class Order {
    *
    * @name getBagById
    * @summary: Get bag
-   * @description: Retrieve detailed information about a specific bag - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getBagById/).
+   * @description: Retrieve detailed information about a specific bag - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getBagById/).
    */
   async getBagById(
     { bagId, channelBagId, channelId, requestHeaders } = { requestHeaders: {} },
@@ -1774,7 +1774,7 @@ class Order {
    *   Success response
    * @name getBags
    * @summary: List bags
-   * @description: Get paginated list of bags based on provided filters - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getBags/).
+   * @description: Get paginated list of bags based on provided filters - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getBags/).
    */
   async getBags(
     {
@@ -1889,7 +1889,7 @@ class Order {
    *
    * @name getBulkActionTemplate
    * @summary: List supported templates
-   * @description: Get list of templates so that users can download the required template - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getBulkActionTemplate/).
+   * @description: Get list of templates so that users can download the required template - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getBulkActionTemplate/).
    */
   async getBulkActionTemplate(
     { requestHeaders } = { requestHeaders: {} },
@@ -1964,7 +1964,7 @@ class Order {
    * @returns {Promise<OrderPlatformModel.FileResponseSchema>} - Success response
    * @name getBulkShipmentExcelFile
    * @summary: Generate the report
-   * @description: Generates the report which can be filled and uploaded to perform the bulk operation based on the filters provided - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getBulkShipmentExcelFile/).
+   * @description: Generates the report which can be filled and uploaded to perform the bulk operation based on the filters provided - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getBulkShipmentExcelFile/).
    */
   async getBulkShipmentExcelFile(
     {
@@ -2093,7 +2093,7 @@ class Order {
    * @returns {Promise<OrderPlatformModel.CreateChannelConfigData>} - Success response
    * @name getChannelConfig
    * @summary: Get channel configuration
-   * @description: Retrieve configuration settings specific to orders for a channel - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getChannelConfig/).
+   * @description: Retrieve configuration settings specific to orders for a channel - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getChannelConfig/).
    */
   async getChannelConfig(
     { requestHeaders } = { requestHeaders: {} },
@@ -2168,7 +2168,7 @@ class Order {
    * @returns {Promise<OrderPlatformModel.JobFailedResponseSchema>} - Success response
    * @name getFileByStatus
    * @summary: Download file used for Bulk operation
-   * @description: Get the file download URL used for performing bulk operation - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getFileByStatus/).
+   * @description: Get the file download URL used for performing bulk operation - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getFileByStatus/).
    */
   async getFileByStatus(
     { batchId, status, fileType, reportType, requestHeaders } = {
@@ -2258,7 +2258,7 @@ class Order {
    * @returns {Promise<OrderPlatformModel.LaneConfigResponseSchema>} - Success response
    * @name getLaneConfig
    * @summary: Get lane configuration
-   * @description: Get configuration settings for lanes - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getLaneConfig/).
+   * @description: Get configuration settings for lanes - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getLaneConfig/).
    */
   async getLaneConfig(
     {
@@ -2411,7 +2411,7 @@ class Order {
    * @returns {Promise<OrderPlatformModel.ManifestDetails>} - Success response
    * @name getManifestDetails
    * @summary: Get a manifest
-   * @description: Get details regarding a manifest which can be used to perform further actions on it - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getManifestDetails/).
+   * @description: Get details regarding a manifest which can be used to perform further actions on it - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getManifestDetails/).
    */
   async getManifestDetails(
     {
@@ -2514,7 +2514,7 @@ class Order {
    * @returns {Promise<OrderPlatformModel.ManifestShipmentListing>} - Success response
    * @name getManifestShipments
    * @summary: List manifest shipments
-   * @description: Get list of shipments tagged to that manifest, the user can also search the shipments on the basis of shipment Id, order Id and AWB number - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getManifestShipments/).
+   * @description: Get list of shipments tagged to that manifest, the user can also search the shipments on the basis of shipment Id, order Id and AWB number - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getManifestShipments/).
    */
   async getManifestShipments(
     {
@@ -2634,7 +2634,7 @@ class Order {
    *   Success response
    * @name getManifestfilters
    * @summary: List filters
-   * @description: Get supported filter for listing manifests - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getManifestfilters/).
+   * @description: Get supported filter for listing manifests - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getManifestfilters/).
    */
   async getManifestfilters(
     { view, requestHeaders } = { requestHeaders: {} },
@@ -2714,7 +2714,7 @@ class Order {
    * @returns {Promise<OrderPlatformModel.ManifestList>} - Success response
    * @name getManifests
    * @summary: List manifests
-   * @description: Get a list of manifest as per the filter provided - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getManifests/).
+   * @description: Get a list of manifest as per the filter provided - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getManifests/).
    */
   async getManifests(
     {
@@ -2828,7 +2828,7 @@ class Order {
    *   Success response
    * @name getOrderById
    * @summary: Get order
-   * @description: Get detailed information about a specific order - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getOrderById/).
+   * @description: Get detailed information about a specific order - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getOrderById/).
    */
   async getOrderById(
     { orderId, myOrders, allowInactive, requestHeaders } = {
@@ -2915,7 +2915,7 @@ class Order {
    *   Success response
    * @name getOrders
    * @summary: List orders
-   * @description: Get a list of orders based on the filters provided. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getOrders/).
+   * @description: Get a list of orders based on the filters provided. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getOrders/).
    */
   async getOrders(
     {
@@ -3219,7 +3219,7 @@ class Order {
    * @returns {Promise<OrderPlatformModel.GetActionsResponseSchema>} - Success response
    * @name getRoleBasedActions
    * @summary: Get role-based actions
-   * @description: Retrieve permissible actions based on user roles such as company_admin,  company_operation, customer_care, and read_only. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getRoleBasedActions/).
+   * @description: Retrieve permissible actions based on user roles such as company_admin,  company_operation, customer_care, and read_only. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getRoleBasedActions/).
    */
   async getRoleBasedActions(
     { requestHeaders } = { requestHeaders: {} },
@@ -3295,7 +3295,7 @@ class Order {
    *   Success response
    * @name getShipmentById
    * @summary: Get shipment details
-   * @description: Get detailed information about a specific shipment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipmentById/).
+   * @description: Get detailed information about a specific shipment - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getShipmentById/).
    */
   async getShipmentById(
     {
@@ -3391,7 +3391,7 @@ class Order {
    *   Success response
    * @name getShipmentHistory
    * @summary: Get a shipment's history
-   * @description: Get the history of the shipment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipmentHistory/).
+   * @description: Get the history of the shipment - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getShipmentHistory/).
    */
   async getShipmentHistory(
     { shipmentId, bagId, requestHeaders } = { requestHeaders: {} },
@@ -3476,7 +3476,7 @@ class Order {
    *
    * @name getShipmentReasons
    * @summary: List bag cancellation reasons
-   * @description: Get reasons to perform full or partial cancellation of a bag - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipmentReasons/).
+   * @description: Get reasons to perform full or partial cancellation of a bag - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getShipmentReasons/).
    */
   async getShipmentReasons(
     { shipmentId, bagId, state, requestHeaders } = { requestHeaders: {} },
@@ -3561,7 +3561,7 @@ class Order {
    *
    * @name getShipments
    * @summary: List shipments
-   * @description: Get a list of shipments based on the filters provided - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipments/).
+   * @description: Get a list of shipments based on the filters provided - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getShipments/).
    */
   async getShipments(
     {
@@ -3963,7 +3963,7 @@ class Order {
    * @summary: Retrieves Entity State Manager configuration which includes flags, hooks, and filters, for a specific application within a company's setup.
    * @description: This endpoint retrieves the ESM (Entity State Manager) configuration for a specific application within a company. The retrieval is based on parameters such as application ID, ordering channel, and entity type.
    * The ESM config stores order processing configuration. Each document in the ESM config collection of  Order Management System - OMS's database is a JSON object representing the configuration of a specific application ID. This includes filters, hooks, flags set on different state-transitions.  This configuration is picked and accordingly features are enabled.
-   *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getStateManagerConfig/).
+   *  - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getStateManagerConfig/).
    */
   async getStateManagerConfig(
     { appId, orderingChannel, orderingSource, entity, requestHeaders } = {
@@ -4052,7 +4052,7 @@ class Order {
    * @returns {Promise<OrderPlatformModel.BagStateTransitionMap>} - Success response
    * @name getStateTransitionMap
    * @summary: Get state transition map
-   * @description: Retrieve a map of state transitions for orders - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getStateTransitionMap/).
+   * @description: Retrieve a map of state transitions for orders - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getStateTransitionMap/).
    */
   async getStateTransitionMap(
     { requestHeaders } = { requestHeaders: {} },
@@ -4128,7 +4128,7 @@ class Order {
    *   Success response
    * @name getTemplate
    * @summary: Download bulk operation templates
-   * @description: Get the excel or CSV file URL for the template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getTemplate/).
+   * @description: Get the excel or CSV file URL for the template. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getTemplate/).
    */
   async getTemplate(
     { templateName, requestHeaders } = { requestHeaders: {} },
@@ -4205,7 +4205,7 @@ class Order {
    * @returns {Promise<OrderPlatformModel.FiltersResponseSchema>} - Success response
    * @name getfilters
    * @summary: List filters
-   * @description: Get supported filters for various listing operations - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getfilters/).
+   * @description: Get supported filters for various listing operations - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getfilters/).
    */
   async getfilters(
     { view, groupEntity, requestHeaders } = { requestHeaders: {} },
@@ -4288,7 +4288,7 @@ class Order {
    *
    * @name invalidateShipmentCache
    * @summary: Invalidate shipment cache
-   * @description: Clear the existing shipment cache data stored in Redis  and serialize the updated data for subsequent use. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/invalidateShipmentCache/).
+   * @description: Clear the existing shipment cache data stored in Redis  and serialize the updated data for subsequent use. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/invalidateShipmentCache/).
    */
   async invalidateShipmentCache(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -4367,7 +4367,7 @@ class Order {
    * @returns {Promise<OrderPlatformModel.JobDetailsResponseSchema>} - Success response
    * @name jobDetails
    * @summary: Get bulk operation details
-   * @description: Fetches details of the job for the provided batch Id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/jobDetails/).
+   * @description: Fetches details of the job for the provided batch Id - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/jobDetails/).
    */
   async jobDetails(
     { batchId, requestHeaders } = { requestHeaders: {} },
@@ -4444,7 +4444,7 @@ class Order {
    * @returns {Promise<OrderPlatformModel.ResponseDetail>} - Success response
    * @name orderUpdate
    * @summary: Update an order
-   * @description: Used to update an order's meta information. These meta information can be accessed via order or shipment details API. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/orderUpdate/).
+   * @description: Used to update an order's meta information. These meta information can be accessed via order or shipment details API. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/orderUpdate/).
    */
   async orderUpdate(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -4522,7 +4522,7 @@ class Order {
    *   Success response
    * @name postShipmentHistory
    * @summary: Create shipment history
-   * @description: Used to add logs in history for a bag for the provided Shipment ID - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/postShipmentHistory/).
+   * @description: Used to add logs in history for a bag for the provided Shipment ID - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/postShipmentHistory/).
    */
   async postShipmentHistory(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -4602,7 +4602,7 @@ class Order {
    *   Success response
    * @name reassignLocation
    * @summary: Reassign location
-   * @description: Reassign the shipment to a another location and update its status to 'Store Reassigned.' - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/reassignLocation/).
+   * @description: Reassign the shipment to a another location and update its status to 'Store Reassigned.' - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/reassignLocation/).
    */
   async reassignLocation(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -4681,7 +4681,7 @@ class Order {
    * @returns {Promise<OrderPlatformModel.BaseResponseSchema>} - Success response
    * @name sendSmsNinja
    * @summary: Send SMS
-   * @description: Send SMS to customer based on the template that is selected - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/sendSmsNinja/).
+   * @description: Send SMS to customer based on the template that is selected - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/sendSmsNinja/).
    */
   async sendSmsNinja(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -4759,7 +4759,7 @@ class Order {
    *   Success response
    * @name sendUserMobileOTP
    * @summary: Send user mobile OTP
-   * @description: Send a one-time OTP to a customer mobile number - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/sendUserMobileOTP/).
+   * @description: Send a one-time OTP to a customer mobile number - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/sendUserMobileOTP/).
    */
   async sendUserMobileOTP(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -4840,7 +4840,7 @@ class Order {
    *
    * @name trackShipment
    * @summary: Track shipment
-   * @description: Retrieve courier partner tracking details for a given shipment Id or AWB number - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/trackShipment/).
+   * @description: Retrieve courier partner tracking details for a given shipment Id or AWB number - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/trackShipment/).
    */
   async trackShipment(
     { shipmentId, awb, pageNo, pageSize, requestHeaders } = {
@@ -4929,7 +4929,7 @@ class Order {
    * @returns {Promise<OrderPlatformModel.BaseResponseSchema>} - Success response
    * @name updateAddress
    * @summary: Update shipment address
-   * @description: Update the address details of an existing shipment based on the provided address_category. This operation allows the modification of critical shipment details, potentially affecting delivery/billing accuracy and customer communication. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updateAddress/).
+   * @description: Update the address details of an existing shipment based on the provided address_category. This operation allows the modification of critical shipment details, potentially affecting delivery/billing accuracy and customer communication. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/updateAddress/).
    */
   async updateAddress(
     { shipmentId, body, requestHeaders } = { requestHeaders: {} },
@@ -5010,7 +5010,7 @@ class Order {
    *
    * @name updatePackagingDimensions
    * @summary: Update packaging dimensions
-   * @description: Used to modify the packaging dimension of a shipment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updatePackagingDimensions/).
+   * @description: Used to modify the packaging dimension of a shipment - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/updatePackagingDimensions/).
    */
   async updatePackagingDimensions(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -5091,7 +5091,7 @@ class Order {
    * @returns {Promise<Object>} - Success response
    * @name updatePaymentInfo
    * @summary: Update payment details for an order, its shipments and its bags.
-   * @description: Updates the payment mode for an order, its shipments and its bags. This endpoint allows for modifying payment methods, and associated details but not amount. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updatePaymentInfo/).
+   * @description: Updates the payment mode for an order, its shipments and its bags. This endpoint allows for modifying payment methods, and associated details but not amount. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/updatePaymentInfo/).
    */
   async updatePaymentInfo(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -5170,7 +5170,7 @@ class Order {
    *
    * @name updateShipmentLock
    * @summary: Update a shipment lock
-   * @description: Modify shipment/bag lock status and update lock/unlock messages. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updateShipmentLock/).
+   * @description: Modify shipment/bag lock status and update lock/unlock messages. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/updateShipmentLock/).
    */
   async updateShipmentLock(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -5251,7 +5251,7 @@ class Order {
    *
    * @name updateShipmentStatus
    * @summary: Update a shipment's status
-   * @description: Used for updating a shipment and its status. Can also be used for updating bags present in that shipment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updateShipmentStatus/).
+   * @description: Used for updating a shipment and its status. Can also be used for updating bags present in that shipment. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/updateShipmentStatus/).
    */
   async updateShipmentStatus(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -5331,7 +5331,7 @@ class Order {
    *   Success response
    * @name updateShipmentTracking
    * @summary: Update shipment tracking
-   * @description: Modify courier partner tracking details for a given shipment Id or AWB number - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updateShipmentTracking/).
+   * @description: Modify courier partner tracking details for a given shipment Id or AWB number - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/updateShipmentTracking/).
    */
   async updateShipmentTracking(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -5410,7 +5410,7 @@ class Order {
    * @returns {Promise<OrderPlatformModel.SuccessResponseSchema>} - Success response
    * @name uploadConsents
    * @summary: Upload consent
-   * @description: Uploads the consent signed by courier partner and seller to keep records - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/uploadConsents/).
+   * @description: Uploads the consent signed by courier partner and seller to keep records - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/uploadConsents/).
    */
   async uploadConsents(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -5489,7 +5489,7 @@ class Order {
    * @returns {Promise<OrderPlatformModel.VerifyOtpResponseSchema>} - Success response
    * @name verifyMobileOTP
    * @summary: Verify mobile OTP
-   * @description: Perform OTP verification to link a user to an anonymous order - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/verifyMobileOTP/).
+   * @description: Perform OTP verification to link a user to an anonymous order - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/verifyMobileOTP/).
    */
   async verifyMobileOTP(
     { body, requestHeaders } = { requestHeaders: {} },

package/sdk/platform/Order/OrderPlatformModel.d.ts

@@ -2023,8 +2023,8 @@ export = OrderPlatformModel;
  *   courier partner.
  * @property {string} dp_name - The name of the courier partner responsible for
  *   the shipment.
- * @property {string} dp_status - The current status of the shipment as updated
- *   by the courier partner.
+ * @property {string} [dp_status] - The current status of the shipment as
+ *   updated by the courier partner.
  * @property {string} dp_status_updated_at - The timestamp when the status was
  *   last updated by the courier partner.
  * @property {string} [estimated_delivery_date] - The estimated date and time
@@ -2033,7 +2033,7 @@ export = OrderPlatformModel;
  * @property {string} journey - Indicates the type of journey the shipment.
  * @property {Object} [meta] - A field to store additional metadata related to
  *   the courier partner's operations or the shipment.
- * @property {string} operational_status - The operational status of the shipment.
+ * @property {string} [operational_status] - The operational status of the shipment.
  * @property {string} [promised_delivery_date] - PThe promised date and time for
  *   delivery as provided by the courier partner.
  * @property {string} [remark] - Any additional remarks or comments from the
@@ -2558,7 +2558,7 @@ export = OrderPlatformModel;
  */
 /**
  * @typedef Page
- * @property {number} [item_total] - The total number of items on the page.
+ * @property {number} [item_total] - The total number of all items across all pages.
  * @property {string} [next_id] - The identifier for the next page.
  * @property {boolean} [has_previous] - Indicates whether there is a previous page.
  * @property {boolean} [has_next] - Indicates whether there is a next page.
@@ -9023,10 +9023,10 @@ type CourierPartnerTrackingDetails = {
      */
     dp_name: string;
     /**
-     * - The current status of the shipment as updated
-     * by the courier partner.
+     * - The current status of the shipment as
+     * updated by the courier partner.
      */
-    dp_status: string;
+    dp_status?: string;
     /**
      * - The timestamp when the status was
      * last updated by the courier partner.
@@ -9053,7 +9053,7 @@ type CourierPartnerTrackingDetails = {
     /**
      * - The operational status of the shipment.
      */
-    operational_status: string;
+    operational_status?: string;
     /**
      * - PThe promised date and time for
      * delivery as provided by the courier partner.
@@ -10061,7 +10061,7 @@ type ValidationError = {
 declare function Page(): Page;
 type Page = {
     /**
-     * - The total number of items on the page.
+     * - The total number of all items across all pages.
      */
     item_total?: number;
     /**

package/sdk/platform/Order/OrderPlatformModel.js

@@ -2210,8 +2210,8 @@ const Joi = require("joi");
  *   courier partner.
  * @property {string} dp_name - The name of the courier partner responsible for
  *   the shipment.
- * @property {string} dp_status - The current status of the shipment as updated
- *   by the courier partner.
+ * @property {string} [dp_status] - The current status of the shipment as
+ *   updated by the courier partner.
  * @property {string} dp_status_updated_at - The timestamp when the status was
  *   last updated by the courier partner.
  * @property {string} [estimated_delivery_date] - The estimated date and time
@@ -2220,7 +2220,7 @@ const Joi = require("joi");
  * @property {string} journey - Indicates the type of journey the shipment.
  * @property {Object} [meta] - A field to store additional metadata related to
  *   the courier partner's operations or the shipment.
- * @property {string} operational_status - The operational status of the shipment.
+ * @property {string} [operational_status] - The operational status of the shipment.
  * @property {string} [promised_delivery_date] - PThe promised date and time for
  *   delivery as provided by the courier partner.
  * @property {string} [remark] - Any additional remarks or comments from the
@@ -2791,7 +2791,7 @@ const Joi = require("joi");
 
 /**
  * @typedef Page
- * @property {number} [item_total] - The total number of items on the page.
+ * @property {number} [item_total] - The total number of all items across all pages.
  * @property {string} [next_id] - The identifier for the next page.
  * @property {boolean} [has_previous] - Indicates whether there is a previous page.
  * @property {boolean} [has_next] - Indicates whether there is a next page.
@@ -7412,13 +7412,13 @@ class OrderPlatformModel {
       awb: Joi.string().allow("").required(),
       dp_location: Joi.string().allow("").allow(null),
       dp_name: Joi.string().allow("").required(),
-      dp_status: Joi.string().allow("").required(),
+      dp_status: Joi.string().allow(""),
       dp_status_updated_at: Joi.string().allow("").required(),
       estimated_delivery_date: Joi.string().allow("").allow(null),
       id: Joi.number(),
       journey: Joi.string().allow("").required(),
       meta: Joi.object().pattern(/\S/, Joi.any()),
-      operational_status: Joi.string().allow("").required(),
+      operational_status: Joi.string().allow(""),
       promised_delivery_date: Joi.string().allow("").allow(null),
       remark: Joi.string().allow("").allow(null),
       shipment_id: Joi.string().allow("").required(),