@gofynd/fdk-client-javascript 1.4.14 → 1.4.15-beta.2

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

@@ -9,13 +9,15 @@ export = OrderPlatformValidator;
  */
 /**
  * @typedef BulkListingParam
- * @property {number} pageSize - Page size
- * @property {number} pageNo - Page number
- * @property {string} startDate - UTC start date in ISO format
- * @property {string} endDate - UTC end date in ISO format
- * @property {string} [status] - Status for which to fetch the jobs.
- * @property {string} [bulkActionType] - Job type.
- * @property {string} [searchKey] - Search_key.
+ * @property {number} pageSize - The number of records to return per page in the response.
+ * @property {number} pageNo - The page number to fetch from the paginated results.
+ * @property {string} startDate - The start date for filtering the jobs,
+ *   expressed in UTC format
+ * @property {string} endDate - The end date for filtering the jobs, expressed
+ *   in UTC format
+ * @property {string} [status] - The status of the jobs to filter the results.
+ * @property {string} [bulkActionType] - Pecifies the type of job action being requested.
+ * @property {string} [searchKey] - A key or keyword used to search for specific jobs.
  */
 /**
  * @typedef BulkStateTransistionParam
@@ -25,10 +27,6 @@ export = OrderPlatformValidator;
  * @typedef CheckOrderStatusParam
  * @property {OrderPlatformModel.OrderStatus} body
  */
-/**
- * @typedef CreateChannelConfigParam
- * @property {OrderPlatformModel.CreateChannelConfigData} body
- */
 /**
  * @typedef CreateOrderParam
  * @property {OrderPlatformModel.CreateOrderAPI} body
@@ -43,7 +41,7 @@ export = OrderPlatformValidator;
  */
 /**
  * @typedef DownloadLanesReportParam
- * @property {OrderPlatformModel.BulkReportsDownloadRequestSchema} body
+ * @property {OrderPlatformModel.BulkReportsDownloadRequest} body
  */
 /**
  * @typedef EInvoiceRetryParam
@@ -53,10 +51,6 @@ export = OrderPlatformValidator;
  * @typedef FailedOrderLogDetailsParam
  * @property {string} logId - Log Error ID
  */
-/**
- * @typedef FetchCreditBalanceDetailParam
- * @property {OrderPlatformModel.FetchCreditBalanceRequestPayload} body
- */
 /**
  * @typedef FetchRefundModeConfigParam
  * @property {OrderPlatformModel.RefundModeConfigRequestPayload} body
@@ -74,18 +68,18 @@ export = OrderPlatformValidator;
  */
 /**
  * @typedef GenerateProcessManifestParam
- * @property {OrderPlatformModel.ProcessManifestRequestSchema} body
+ * @property {OrderPlatformModel.ProcessManifestRequest} body
  */
 /**
  * @typedef GetAllowedStateTransitionParam
- * @property {string} orderingChannel - Ordering channel
- * @property {string} status - Current status of a shipment
+ * @property {string} orderingChannel - The channel through which orders are placed.
+ * @property {string} status - The status key indicates the current status for
+ *   which the API will provide a list of possible next state transitions.
  */
 /** @typedef GetAllowedTemplatesForBulkParam */
 /**
  * @typedef GetAnnouncementsParam
- * @property {string} [date] - Date On which the announcement is Active (Date
- *   should in ISO Datetime format IST Time)
+ * @property {string} [date] - Date On which the announcement is Active.
  */
 /**
  * @typedef GetBagByIdParam
@@ -110,8 +104,8 @@ export = OrderPlatformValidator;
  * @typedef GetBulkShipmentExcelFileParam
  * @property {string} [salesChannels] - Comma separated values of sales channel ids
  * @property {string} [dpIds] - Comma separated values of delivery partner ids
- * @property {string} [startDate] - Date time in UTC timezone as per ISO format.
- * @property {string} [endDate] - Date time in UTC timezone as per ISO format.
+ * @property {string} [startDate] - UTC start date in ISO format
+ * @property {string} [endDate] - UTC end date in ISO format
  * @property {string} [stores] - Comma separated values of store ids
  * @property {string} [tags] - Comma separated values of tags
  * @property {string} [bagStatus] - Comma separated values of bag statuses
@@ -121,13 +115,12 @@ export = OrderPlatformValidator;
  * @property {number} [pageNo]
  * @property {number} [pageSize]
  */
-/** @typedef GetChannelConfigParam */
 /**
  * @typedef GetFileByStatusParam
- * @property {string} batchId
- * @property {string} status
- * @property {string} fileType - It contains the type of file.
- * @property {string} [reportType]
+ * @property {string} batchId - Batch Id to identify the bulk operation request.
+ * @property {string} status - The status of the jobs to filter the results.
+ * @property {string} fileType - The type of file to be downloaded.
+ * @property {string} [reportType] - The type of report to be downloaded.
  */
 /**
  * @typedef GetLaneConfigParam
@@ -142,44 +135,38 @@ export = OrderPlatformValidator;
  * @property {string} [salesChannels]
  * @property {string} [paymentMode] - Comma separated values of payment modes
  * @property {string} [bagStatus] - Comma separated values of bag statuses
- * @property {string} [searchType] - Search_type refers to the field that will
- *   be used as the target for the search operation
+ * @property {string} [searchType]
  * @property {string} [searchValue]
  * @property {string} [tags]
- * @property {number} [timeToDispatch] - Time_to_dispatch refers to estimated SLA time.
+ * @property {number} [timeToDispatch]
  * @property {string} [paymentMethods]
  * @property {boolean} [myOrders]
  * @property {boolean} [showCrossCompanyData] - Flag to view cross & non-cross
  *   company order
- * @property {string} [orderType] - Defines the specific journey a shipment will
- *   follow based on the application's operational needs and customer
- *   preferences. This field categorizes orders into distinct types, each
- *   associated with a unique processing flow. For example:
- *
- *   - "HomeDelivery": The order undergoes all state transitions typical for a
- *       delivery, from processing the shipment to final delivery at the
- *       customer's address.
- *   - "PickAtStore": The order is prepared for pickup and moved to a state where it
- *       is ready to be handed over directly to the customer at the store. This
- *       type streamlines the process by bypassing traditional shipping stages
- *       and facilitating a quicker transition to the final handover stage.
+ * @property {string} [orderType]
  */
 /**
  * @typedef GetManifestDetailsParam
- * @property {string} manifestId
+ * @property {string} manifestId - The unique identifier assigned to the manifest.
+ * @property {string} [dpIds] - Filter shipments with the specific Courier
+ *   partner Ids which is a combination of courier partner extension and scheme Ids.
+ * @property {string} [endDate] - End date for the shipment search range in manifest.
+ * @property {string} [startDate] - Start date for the shipment search range in manifest.
+ * @property {number} [pageNo] - Page number for pagination.
+ * @property {number} [pageSize] - Number of records per page for pagination.
  */
 /**
  * @typedef GetManifestShipmentsParam
  * @property {string} dpIds - Filter shipments with the specific Courier partner
  *   Ids which is a combination of courier partner extension and scheme Ids.
- * @property {number} stores - Filter with the specific store.
+ * @property {number} stores - Filter results based on specific store IDs.
  * @property {string} toDate - End date for the shipment search range.
  * @property {string} fromDate - Start date for the shipment search range.
- * @property {string} [dpName] - Filter with the specific courier partner name.
- * @property {string} [salesChannels] - Comma-separated list of sales channels.
- * @property {string} [searchType] - Type of search (e.g., by shipment ID, order
- *   ID, AWB number).
- * @property {string} [searchValue] - Value to search for based on the search type.
+ * @property {string} [dpName] - Filter results based on specific courier partner name.
+ * @property {string} [salesChannels] - Filter results based on comma-separated
+ *   list of sales channels.
+ * @property {string} [searchType] - Filter results based on search type.
+ * @property {string} [searchValue] - Filter results based on the search value.
  * @property {number} [pageNo] - Page number for pagination.
  * @property {number} [pageSize] - Number of records per page for pagination.
  */
@@ -189,16 +176,20 @@ export = OrderPlatformValidator;
  */
 /**
  * @typedef GetManifestsParam
- * @property {string} [status] - Possible Status [ active, closed ]
- * @property {string} [startDate] - UTC Start Date in ISO format
- * @property {string} [endDate] - UTC End Date in ISO format
- * @property {string} [searchType] - Search type options [ fynd_order_id,
- *   shipment_id, manifest_id, dp_name, awb_no ]
- * @property {number} [storeId] - Fetch manifests for a Store.
- * @property {string} [searchValue] - Search value for selected search type
- * @property {string} [dpIds] - DP Ids separated by ',' (comma)
- * @property {number} [pageNo]
- * @property {number} [pageSize]
+ * @property {string} [status] - Filter for the status of manifests.
+ * @property {string} [startDate] - The starting date for filtering manifests in
+ *   ISO format
+ * @property {string} [endDate] - The end date for filtering manifests in ISO format
+ * @property {string} [searchType] - Specifies the type of search to perform.
+ * @property {number} [storeId] - Filter to fetch manifests for a specific store
+ *   by its ID.
+ * @property {string} [searchValue] - The value to search for based on the
+ *   selected search type.
+ * @property {string} [dpIds] - A comma-separated list of courier partner IDs
+ *   (DP IDs) to filter the manifests.
+ * @property {number} [pageNo] - The number of the page to fetch data.
+ * @property {number} [pageSize] - The number of records to return per page for
+ *   pagination.
  */
 /**
  * @typedef GetOrderByIdParam
@@ -220,10 +211,10 @@ export = OrderPlatformValidator;
  *   associated with the order
  * @property {string} [searchValue] - Search_value is matched against the field
  *   specified by the search_type
- * @property {string} [fromDate] - Date time in UTC timezone as per ISO format.
- * @property {string} [toDate] - Date time in UTC timezone as per ISO format.
- * @property {string} [startDate] - Date time in UTC timezone as per ISO format.
- * @property {string} [endDate] - Date time in UTC timezone as per ISO format.
+ * @property {string} [fromDate]
+ * @property {string} [toDate]
+ * @property {string} [startDate]
+ * @property {string} [endDate]
  * @property {string} [dpIds] - Delivery Partner IDs to which shipments are assigned.
  * @property {string} [stores]
  * @property {string} [salesChannels]
@@ -238,11 +229,9 @@ export = OrderPlatformValidator;
  * @property {string} [orderType]
  * @property {boolean} [allowInactive] - Flag indicating whether inactive
  *   shipments are allowed
- * @property {string} [groupEntity] - Defines the grouping criterion for
- *   retrieving shipments or orders. It specifies whether the results should be
- *   organized based on shipment groups or order groups. For example, using
- *   'shipments' groups results by shipment, while an invalid value like 'abcd'
- *   may not be recognized, leading to errors or default behavior.
+ * @property {boolean} [enforceDateFilter] - Applies a date filter for listing
+ *   orders. This is useful when fetching data for a specific date range while
+ *   performing searches.
  */
 /** @typedef GetRoleBasedActionsParam */
 /**
@@ -256,8 +245,8 @@ export = OrderPlatformValidator;
  */
 /**
  * @typedef GetShipmentHistoryParam
- * @property {string} [shipmentId] - Shipment Id
- * @property {number} [bagId] - Bag/Product Id
+ * @property {string} [shipmentId] - Identifier for the shipment
+ * @property {number} [bagId] - Identifier for a bag or product.
  */
 /**
  * @typedef GetShipmentReasonsParam
@@ -274,9 +263,8 @@ export = OrderPlatformValidator;
  * @property {string} [bagStatus] - Comma separated values of bag statuses
  * @property {boolean} [statusOverrideLane] - Use this flag to fetch by
  *   bag_status and override lane
- * @property {number} [timeToDispatch] - Time_to_dispatch refers to estimated SLA time.
- * @property {string} [searchType] - Search_type refers to the field that will
- *   be used as the target for the search operation
+ * @property {number} [timeToDispatch]
+ * @property {string} [searchType] - Search type key
  * @property {string} [searchValue] - Search type value
  * @property {string} [fromDate] - Start Date in DD-MM-YYYY format
  * @property {string} [toDate] - End Date in DD-MM-YYYY format
@@ -303,24 +291,10 @@ export = OrderPlatformValidator;
  *   company order
  * @property {string} [tags] - Comma separated values of tags
  * @property {string} [customerId]
- * @property {string} [orderType] - Defines the specific journey a shipment will
- *   follow based on the application's operational needs and customer
- *   preferences. This field categorizes orders into distinct types, each
- *   associated with a unique processing flow. For example:
- *
- *   - "HomeDelivery": The order undergoes all state transitions typical for a
- *       delivery, from processing the shipment to final delivery at the
- *       customer's address.
- *   - "PickAtStore": The order is prepared for pickup and moved to a state where it
- *       is ready to be handed over directly to the customer at the store. This
- *       type streamlines the process by bypassing traditional shipping stages
- *       and facilitating a quicker transition to the final handover stage.
- *
- * @property {string} [groupEntity] - Defines the grouping criterion for
- *   retrieving shipments or orders. It specifies whether the results should be
- *   organized based on shipment groups or order groups. For example, using
- *   'shipments' groups results by shipment, while an invalid value like 'abcd'
- *   may not be recognized, leading to errors or default behavior.
+ * @property {string} [orderType]
+ * @property {boolean} [enforceDateFilter] - Applies a date filter for listing
+ *   shipments. This is useful when fetching data for a specific date range
+ *   while performing searches.
  */
 /**
  * @typedef GetStateManagerConfigParam
@@ -344,7 +318,8 @@ export = OrderPlatformValidator;
  */
 /**
  * @typedef JobDetailsParam
- * @property {string} batchId
+ * @property {string} batchId - A unique identifier for the batch associated
+ *   with this bulk action.
  */
 /**
  * @typedef OrderUpdateParam
@@ -354,10 +329,6 @@ export = OrderPlatformValidator;
  * @typedef PostShipmentHistoryParam
  * @property {OrderPlatformModel.PostShipmentHistory} body
  */
-/**
- * @typedef ProcessManifestsParam
- * @property {OrderPlatformModel.ProcessManifest} body
- */
 /**
  * @typedef ReassignLocationParam
  * @property {OrderPlatformModel.StoreReassign} body
@@ -372,24 +343,30 @@ export = OrderPlatformValidator;
  */
 /**
  * @typedef TrackShipmentParam
- * @property {string} [shipmentId] - Shipment ID
+ * @property {string} [shipmentId] - Unique identifier of a shipment on the platform.
  * @property {string} [awb] - AWB number
- * @property {number} [pageNo] - Page number
- * @property {number} [pageSize] - Page size
+ * @property {number} [pageNo] - Page number for pagination.
+ * @property {number} [pageSize] - Number of records per page for pagination.
  */
 /**
  * @typedef UpdateAddressParam
- * @property {string} shipmentId - Unique shipment no. that is auto-generated
- * @property {OrderPlatformModel.UpdateAddressRequestBody} body
+ * @property {string} shipmentId
+ * @property {string} [name]
+ * @property {string} [address]
+ * @property {string} [addressType]
+ * @property {string} [pincode]
+ * @property {string} [phone]
+ * @property {string} [email]
+ * @property {string} [landmark]
+ * @property {string} addressCategory
+ * @property {string} [city]
+ * @property {string} [state]
+ * @property {string} [country]
  */
 /**
  * @typedef UpdatePackagingDimensionsParam
  * @property {OrderPlatformModel.UpdatePackagingDimensionsPayload} body
  */
-/**
- * @typedef UpdatePaymentInfoParam
- * @property {OrderPlatformModel.UpdateShipmentPaymentMode} body
- */
 /**
  * @typedef UpdateShipmentLockParam
  * @property {OrderPlatformModel.UpdateShipmentLockPayload} body
@@ -404,8 +381,7 @@ export = OrderPlatformValidator;
  */
 /**
  * @typedef UploadConsentsParam
- * @property {string} manifestId
- * @property {OrderPlatformModel.UploadConsent} body
+ * @property {OrderPlatformModel.UploadManifestConsent} body
  */
 /**
  * @typedef VerifyMobileOTPParam
@@ -422,8 +398,6 @@ declare class OrderPlatformValidator {
     static bulkStateTransistion(): BulkStateTransistionParam;
     /** @returns {CheckOrderStatusParam} */
     static checkOrderStatus(): CheckOrderStatusParam;
-    /** @returns {CreateChannelConfigParam} */
-    static createChannelConfig(): CreateChannelConfigParam;
     /** @returns {CreateOrderParam} */
     static createOrder(): CreateOrderParam;
     /** @returns {DispatchManifestsParam} */
@@ -436,8 +410,6 @@ declare class OrderPlatformValidator {
     static eInvoiceRetry(): EInvoiceRetryParam;
     /** @returns {FailedOrderLogDetailsParam} */
     static failedOrderLogDetails(): FailedOrderLogDetailsParam;
-    /** @returns {FetchCreditBalanceDetailParam} */
-    static fetchCreditBalanceDetail(): FetchCreditBalanceDetailParam;
     /** @returns {FetchRefundModeConfigParam} */
     static fetchRefundModeConfig(): FetchRefundModeConfigParam;
     /** @returns {GenerateInvoiceIDParam} */
@@ -460,8 +432,6 @@ declare class OrderPlatformValidator {
     static getBulkActionTemplate(): any;
     /** @returns {GetBulkShipmentExcelFileParam} */
     static getBulkShipmentExcelFile(): GetBulkShipmentExcelFileParam;
-    /** @returns {GetChannelConfigParam} */
-    static getChannelConfig(): any;
     /** @returns {GetFileByStatusParam} */
     static getFileByStatus(): GetFileByStatusParam;
     /** @returns {GetLaneConfigParam} */
@@ -504,8 +474,6 @@ declare class OrderPlatformValidator {
     static orderUpdate(): OrderUpdateParam;
     /** @returns {PostShipmentHistoryParam} */
     static postShipmentHistory(): PostShipmentHistoryParam;
-    /** @returns {ProcessManifestsParam} */
-    static processManifests(): ProcessManifestsParam;
     /** @returns {ReassignLocationParam} */
     static reassignLocation(): ReassignLocationParam;
     /** @returns {SendSmsNinjaParam} */
@@ -518,8 +486,6 @@ declare class OrderPlatformValidator {
     static updateAddress(): UpdateAddressParam;
     /** @returns {UpdatePackagingDimensionsParam} */
     static updatePackagingDimensions(): UpdatePackagingDimensionsParam;
-    /** @returns {UpdatePaymentInfoParam} */
-    static updatePaymentInfo(): UpdatePaymentInfoParam;
     /** @returns {UpdateShipmentLockParam} */
     static updateShipmentLock(): UpdateShipmentLockParam;
     /** @returns {UpdateShipmentStatusParam} */
@@ -532,7 +498,7 @@ declare class OrderPlatformValidator {
     static verifyMobileOTP(): VerifyMobileOTPParam;
 }
 declare namespace OrderPlatformValidator {
-    export { AddStateManagerConfigParam, AttachOrderUserParam, BulkListingParam, BulkStateTransistionParam, CheckOrderStatusParam, CreateChannelConfigParam, CreateOrderParam, DispatchManifestsParam, DownloadBulkActionTemplateParam, DownloadLanesReportParam, EInvoiceRetryParam, FailedOrderLogDetailsParam, FetchCreditBalanceDetailParam, FetchRefundModeConfigParam, GenerateInvoiceIDParam, GeneratePOSReceiptByOrderIdParam, GenerateProcessManifestParam, GetAllowedStateTransitionParam, GetAllowedTemplatesForBulkParam, GetAnnouncementsParam, GetBagByIdParam, GetBagsParam, GetBulkActionTemplateParam, GetBulkShipmentExcelFileParam, GetChannelConfigParam, GetFileByStatusParam, GetLaneConfigParam, GetManifestDetailsParam, GetManifestShipmentsParam, GetManifestfiltersParam, GetManifestsParam, GetOrderByIdParam, GetOrdersParam, GetRoleBasedActionsParam, GetShipmentByIdParam, GetShipmentHistoryParam, GetShipmentReasonsParam, GetShipmentsParam, GetStateManagerConfigParam, GetStateTransitionMapParam, GetTemplateParam, GetfiltersParam, InvalidateShipmentCacheParam, JobDetailsParam, OrderUpdateParam, PostShipmentHistoryParam, ProcessManifestsParam, ReassignLocationParam, SendSmsNinjaParam, SendUserMobileOTPParam, TrackShipmentParam, UpdateAddressParam, UpdatePackagingDimensionsParam, UpdatePaymentInfoParam, UpdateShipmentLockParam, UpdateShipmentStatusParam, UpdateShipmentTrackingParam, UploadConsentsParam, VerifyMobileOTPParam };
+    export { AddStateManagerConfigParam, AttachOrderUserParam, BulkListingParam, BulkStateTransistionParam, CheckOrderStatusParam, CreateOrderParam, DispatchManifestsParam, DownloadBulkActionTemplateParam, DownloadLanesReportParam, EInvoiceRetryParam, FailedOrderLogDetailsParam, FetchRefundModeConfigParam, GenerateInvoiceIDParam, GeneratePOSReceiptByOrderIdParam, GenerateProcessManifestParam, GetAllowedStateTransitionParam, GetAllowedTemplatesForBulkParam, GetAnnouncementsParam, GetBagByIdParam, GetBagsParam, GetBulkActionTemplateParam, GetBulkShipmentExcelFileParam, GetFileByStatusParam, GetLaneConfigParam, GetManifestDetailsParam, GetManifestShipmentsParam, GetManifestfiltersParam, GetManifestsParam, GetOrderByIdParam, GetOrdersParam, GetRoleBasedActionsParam, GetShipmentByIdParam, GetShipmentHistoryParam, GetShipmentReasonsParam, GetShipmentsParam, GetStateManagerConfigParam, GetStateTransitionMapParam, GetTemplateParam, GetfiltersParam, InvalidateShipmentCacheParam, JobDetailsParam, OrderUpdateParam, PostShipmentHistoryParam, ReassignLocationParam, SendSmsNinjaParam, SendUserMobileOTPParam, TrackShipmentParam, UpdateAddressParam, UpdatePackagingDimensionsParam, UpdateShipmentLockParam, UpdateShipmentStatusParam, UpdateShipmentTrackingParam, UploadConsentsParam, VerifyMobileOTPParam };
 }
 type AddStateManagerConfigParam = {
     body: OrderPlatformModel.TransitionConfigPayload;
@@ -542,31 +508,33 @@ type AttachOrderUserParam = {
 };
 type BulkListingParam = {
     /**
-     * - Page size
+     * - The number of records to return per page in the response.
      */
     pageSize: number;
     /**
-     * - Page number
+     * - The page number to fetch from the paginated results.
      */
     pageNo: number;
     /**
-     * - UTC start date in ISO format
+     * - The start date for filtering the jobs,
+     * expressed in UTC format
      */
     startDate: string;
     /**
-     * - UTC end date in ISO format
+     * - The end date for filtering the jobs, expressed
+     * in UTC format
      */
     endDate: string;
     /**
-     * - Status for which to fetch the jobs.
+     * - The status of the jobs to filter the results.
      */
     status?: string;
     /**
-     * - Job type.
+     * - Pecifies the type of job action being requested.
      */
     bulkActionType?: string;
     /**
-     * - Search_key.
+     * - A key or keyword used to search for specific jobs.
      */
     searchKey?: string;
 };
@@ -576,9 +544,6 @@ type BulkStateTransistionParam = {
 type CheckOrderStatusParam = {
     body: OrderPlatformModel.OrderStatus;
 };
-type CreateChannelConfigParam = {
-    body: OrderPlatformModel.CreateChannelConfigData;
-};
 type CreateOrderParam = {
     body: OrderPlatformModel.CreateOrderAPI;
 };
@@ -592,7 +557,7 @@ type DownloadBulkActionTemplateParam = {
     templateSlug?: string;
 };
 type DownloadLanesReportParam = {
-    body: OrderPlatformModel.BulkReportsDownloadRequestSchema;
+    body: OrderPlatformModel.BulkReportsDownloadRequest;
 };
 type EInvoiceRetryParam = {
     body: OrderPlatformModel.EInvoiceRetry;
@@ -603,9 +568,6 @@ type FailedOrderLogDetailsParam = {
      */
     logId: string;
 };
-type FetchCreditBalanceDetailParam = {
-    body: OrderPlatformModel.FetchCreditBalanceRequestPayload;
-};
 type FetchRefundModeConfigParam = {
     body: OrderPlatformModel.RefundModeConfigRequestPayload;
 };
@@ -622,22 +584,22 @@ type GeneratePOSReceiptByOrderIdParam = {
     documentType?: string;
 };
 type GenerateProcessManifestParam = {
-    body: OrderPlatformModel.ProcessManifestRequestSchema;
+    body: OrderPlatformModel.ProcessManifestRequest;
 };
 type GetAllowedStateTransitionParam = {
     /**
-     * - Ordering channel
+     * - The channel through which orders are placed.
      */
     orderingChannel: string;
     /**
-     * - Current status of a shipment
+     * - The status key indicates the current status for
+     * which the API will provide a list of possible next state transitions.
      */
     status: string;
 };
 type GetAnnouncementsParam = {
     /**
-     * - Date On which the announcement is Active (Date
-     * should in ISO Datetime format IST Time)
+     * - Date On which the announcement is Active.
      */
     date?: string;
 };
@@ -703,11 +665,11 @@ type GetBulkShipmentExcelFileParam = {
      */
     dpIds?: string;
     /**
-     * - Date time in UTC timezone as per ISO format.
+     * - UTC start date in ISO format
      */
     startDate?: string;
     /**
-     * - Date time in UTC timezone as per ISO format.
+     * - UTC end date in ISO format
      */
     endDate?: string;
     /**
@@ -738,12 +700,21 @@ type GetBulkShipmentExcelFileParam = {
     pageSize?: number;
 };
 type GetFileByStatusParam = {
+    /**
+     * - Batch Id to identify the bulk operation request.
+     */
     batchId: string;
+    /**
+     * - The status of the jobs to filter the results.
+     */
     status: string;
     /**
-     * - It contains the type of file.
+     * - The type of file to be downloaded.
      */
     fileType: string;
+    /**
+     * - The type of report to be downloaded.
+     */
     reportType?: string;
 };
 type GetLaneConfigParam = {
@@ -788,16 +759,9 @@ type GetLaneConfigParam = {
      * - Comma separated values of bag statuses
      */
     bagStatus?: string;
-    /**
-     * - Search_type refers to the field that will
-     * be used as the target for the search operation
-     */
     searchType?: string;
     searchValue?: string;
     tags?: string;
-    /**
-     * - Time_to_dispatch refers to estimated SLA time.
-     */
     timeToDispatch?: number;
     paymentMethods?: string;
     myOrders?: boolean;
@@ -806,24 +770,34 @@ type GetLaneConfigParam = {
      * company order
      */
     showCrossCompanyData?: boolean;
-    /**
-     * - Defines the specific journey a shipment will
-     * follow based on the application's operational needs and customer
-     * preferences. This field categorizes orders into distinct types, each
-     * associated with a unique processing flow. For example:
-     *
-     * - "HomeDelivery": The order undergoes all state transitions typical for a
-     * delivery, from processing the shipment to final delivery at the
-     * customer's address.
-     * - "PickAtStore": The order is prepared for pickup and moved to a state where it
-     * is ready to be handed over directly to the customer at the store. This
-     * type streamlines the process by bypassing traditional shipping stages
-     * and facilitating a quicker transition to the final handover stage.
-     */
     orderType?: string;
 };
 type GetManifestDetailsParam = {
+    /**
+     * - The unique identifier assigned to the manifest.
+     */
     manifestId: string;
+    /**
+     * - Filter shipments with the specific Courier
+     * partner Ids which is a combination of courier partner extension and scheme Ids.
+     */
+    dpIds?: string;
+    /**
+     * - End date for the shipment search range in manifest.
+     */
+    endDate?: string;
+    /**
+     * - Start date for the shipment search range in manifest.
+     */
+    startDate?: string;
+    /**
+     * - Page number for pagination.
+     */
+    pageNo?: number;
+    /**
+     * - Number of records per page for pagination.
+     */
+    pageSize?: number;
 };
 type GetManifestShipmentsParam = {
     /**
@@ -832,7 +806,7 @@ type GetManifestShipmentsParam = {
      */
     dpIds: string;
     /**
-     * - Filter with the specific store.
+     * - Filter results based on specific store IDs.
      */
     stores: number;
     /**
@@ -844,20 +818,20 @@ type GetManifestShipmentsParam = {
      */
     fromDate: string;
     /**
-     * - Filter with the specific courier partner name.
+     * - Filter results based on specific courier partner name.
      */
     dpName?: string;
     /**
-     * - Comma-separated list of sales channels.
+     * - Filter results based on comma-separated
+     * list of sales channels.
      */
     salesChannels?: string;
     /**
-     * - Type of search (e.g., by shipment ID, order
-     * ID, AWB number).
+     * - Filter results based on search type.
      */
     searchType?: string;
     /**
-     * - Value to search for based on the search type.
+     * - Filter results based on the search value.
      */
     searchValue?: string;
     /**
@@ -877,35 +851,45 @@ type GetManifestfiltersParam = {
 };
 type GetManifestsParam = {
     /**
-     * - Possible Status [ active, closed ]
+     * - Filter for the status of manifests.
      */
     status?: string;
     /**
-     * - UTC Start Date in ISO format
+     * - The starting date for filtering manifests in
+     * ISO format
      */
     startDate?: string;
     /**
-     * - UTC End Date in ISO format
+     * - The end date for filtering manifests in ISO format
      */
     endDate?: string;
     /**
-     * - Search type options [ fynd_order_id,
-     * shipment_id, manifest_id, dp_name, awb_no ]
+     * - Specifies the type of search to perform.
      */
     searchType?: string;
     /**
-     * - Fetch manifests for a Store.
+     * - Filter to fetch manifests for a specific store
+     * by its ID.
      */
     storeId?: number;
     /**
-     * - Search value for selected search type
+     * - The value to search for based on the
+     * selected search type.
      */
     searchValue?: string;
     /**
-     * - DP Ids separated by ',' (comma)
+     * - A comma-separated list of courier partner IDs
+     * (DP IDs) to filter the manifests.
      */
     dpIds?: string;
+    /**
+     * - The number of the page to fetch data.
+     */
     pageNo?: number;
+    /**
+     * - The number of records to return per page for
+     * pagination.
+     */
     pageSize?: number;
 };
 type GetOrderByIdParam = {
@@ -947,21 +931,9 @@ type GetOrdersParam = {
      * specified by the search_type
      */
     searchValue?: string;
-    /**
-     * - Date time in UTC timezone as per ISO format.
-     */
     fromDate?: string;
-    /**
-     * - Date time in UTC timezone as per ISO format.
-     */
     toDate?: string;
-    /**
-     * - Date time in UTC timezone as per ISO format.
-     */
     startDate?: string;
-    /**
-     * - Date time in UTC timezone as per ISO format.
-     */
     endDate?: string;
     /**
      * - Delivery Partner IDs to which shipments are assigned.
@@ -987,13 +959,11 @@ type GetOrdersParam = {
      */
     allowInactive?: boolean;
     /**
-     * - Defines the grouping criterion for
-     * retrieving shipments or orders. It specifies whether the results should be
-     * organized based on shipment groups or order groups. For example, using
-     * 'shipments' groups results by shipment, while an invalid value like 'abcd'
-     * may not be recognized, leading to errors or default behavior.
+     * - Applies a date filter for listing
+     * orders. This is useful when fetching data for a specific date range while
+     * performing searches.
      */
-    groupEntity?: string;
+    enforceDateFilter?: boolean;
 };
 type GetShipmentByIdParam = {
     /**
@@ -1017,11 +987,11 @@ type GetShipmentByIdParam = {
 };
 type GetShipmentHistoryParam = {
     /**
-     * - Shipment Id
+     * - Identifier for the shipment
      */
     shipmentId?: string;
     /**
-     * - Bag/Product Id
+     * - Identifier for a bag or product.
      */
     bagId?: number;
 };
@@ -1056,13 +1026,9 @@ type GetShipmentsParam = {
      * bag_status and override lane
      */
     statusOverrideLane?: boolean;
-    /**
-     * - Time_to_dispatch refers to estimated SLA time.
-     */
     timeToDispatch?: number;
     /**
-     * - Search_type refers to the field that will
-     * be used as the target for the search operation
+     * - Search type key
      */
     searchType?: string;
     /**
@@ -1148,29 +1114,13 @@ type GetShipmentsParam = {
      */
     tags?: string;
     customerId?: string;
-    /**
-     * - Defines the specific journey a shipment will
-     * follow based on the application's operational needs and customer
-     * preferences. This field categorizes orders into distinct types, each
-     * associated with a unique processing flow. For example:
-     *
-     * - "HomeDelivery": The order undergoes all state transitions typical for a
-     * delivery, from processing the shipment to final delivery at the
-     * customer's address.
-     * - "PickAtStore": The order is prepared for pickup and moved to a state where it
-     * is ready to be handed over directly to the customer at the store. This
-     * type streamlines the process by bypassing traditional shipping stages
-     * and facilitating a quicker transition to the final handover stage.
-     */
     orderType?: string;
     /**
-     * - Defines the grouping criterion for
-     * retrieving shipments or orders. It specifies whether the results should be
-     * organized based on shipment groups or order groups. For example, using
-     * 'shipments' groups results by shipment, while an invalid value like 'abcd'
-     * may not be recognized, leading to errors or default behavior.
+     * - Applies a date filter for listing
+     * shipments. This is useful when fetching data for a specific date range
+     * while performing searches.
      */
-    groupEntity?: string;
+    enforceDateFilter?: boolean;
 };
 type GetStateManagerConfigParam = {
     /**
@@ -1203,6 +1153,10 @@ type InvalidateShipmentCacheParam = {
     body: OrderPlatformModel.InvalidateShipmentCachePayload;
 };
 type JobDetailsParam = {
+    /**
+     * - A unique identifier for the batch associated
+     * with this bulk action.
+     */
     batchId: string;
 };
 type OrderUpdateParam = {
@@ -1211,9 +1165,6 @@ type OrderUpdateParam = {
 type PostShipmentHistoryParam = {
     body: OrderPlatformModel.PostShipmentHistory;
 };
-type ProcessManifestsParam = {
-    body: OrderPlatformModel.ProcessManifest;
-};
 type ReassignLocationParam = {
     body: OrderPlatformModel.StoreReassign;
 };
@@ -1225,7 +1176,7 @@ type SendUserMobileOTPParam = {
 };
 type TrackShipmentParam = {
     /**
-     * - Shipment ID
+     * - Unique identifier of a shipment on the platform.
      */
     shipmentId?: string;
     /**
@@ -1233,27 +1184,31 @@ type TrackShipmentParam = {
      */
     awb?: string;
     /**
-     * - Page number
+     * - Page number for pagination.
      */
     pageNo?: number;
     /**
-     * - Page size
+     * - Number of records per page for pagination.
      */
     pageSize?: number;
 };
 type UpdateAddressParam = {
-    /**
-     * - Unique shipment no. that is auto-generated
-     */
     shipmentId: string;
-    body: OrderPlatformModel.UpdateAddressRequestBody;
+    name?: string;
+    address?: string;
+    addressType?: string;
+    pincode?: string;
+    phone?: string;
+    email?: string;
+    landmark?: string;
+    addressCategory: string;
+    city?: string;
+    state?: string;
+    country?: string;
 };
 type UpdatePackagingDimensionsParam = {
     body: OrderPlatformModel.UpdatePackagingDimensionsPayload;
 };
-type UpdatePaymentInfoParam = {
-    body: OrderPlatformModel.UpdateShipmentPaymentMode;
-};
 type UpdateShipmentLockParam = {
     body: OrderPlatformModel.UpdateShipmentLockPayload;
 };
@@ -1264,15 +1219,13 @@ type UpdateShipmentTrackingParam = {
     body: OrderPlatformModel.CourierPartnerTrackingDetails;
 };
 type UploadConsentsParam = {
-    manifestId: string;
-    body: OrderPlatformModel.UploadConsent;
+    body: OrderPlatformModel.UploadManifestConsent;
 };
 type VerifyMobileOTPParam = {
     body: OrderPlatformModel.VerifyMobileOTP;
 };
 type GetAllowedTemplatesForBulkParam = any;
 type GetBulkActionTemplateParam = any;
-type GetChannelConfigParam = any;
 type GetRoleBasedActionsParam = any;
 type GetStateTransitionMapParam = any;
 import OrderPlatformModel = require("./OrderPlatformModel");