@gofynd/fdk-client-javascript 3.0.0-beta.1 → 3.0.0

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

@@ -1,7 +1,7 @@
 export = OrderPlatformValidator;
 /**
- * @typedef AddUserViewsParam
- * @property {OrderPlatformModel.UserViewsResponse} body
+ * @typedef AddStateManagerConfigParam
+ * @property {OrderPlatformModel.TransitionConfigPayload} body
  */
 /**
  * @typedef AttachOrderUserParam
@@ -9,37 +9,35 @@ 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
- * @property {OrderPlatformModel.BulkStateTransistionRequest} body
+ * @property {OrderPlatformModel.BulkStateTransistionRequestSchema} body
  */
 /**
  * @typedef CheckOrderStatusParam
  * @property {OrderPlatformModel.OrderStatus} body
  */
 /**
- * @typedef Click2CallParam
- * @property {string} caller - Call Number
- * @property {string} receiver - Receiver Number
- * @property {string} bagId - Bag Id for the query
- * @property {string} [callerId] - Caller Id
- * @property {string} [method] - Provider Method to Call
+ * @typedef CreateChannelConfigParam
+ * @property {OrderPlatformModel.CreateChannelConfigData} body
  */
 /**
  * @typedef CreateOrderParam
  * @property {OrderPlatformModel.CreateOrderAPI} body
  */
 /**
- * @typedef DeleteUserViewsParam
- * @property {string} viewId - Comma separated values of view ids
+ * @typedef DispatchManifestsParam
+ * @property {OrderPlatformModel.DispatchManifest} body
  */
 /**
  * @typedef DownloadBulkActionTemplateParam
@@ -47,7 +45,7 @@ export = OrderPlatformValidator;
  */
 /**
  * @typedef DownloadLanesReportParam
- * @property {OrderPlatformModel.BulkReportsDownloadRequest} body
+ * @property {OrderPlatformModel.BulkReportsDownloadRequestSchema} body
  */
 /**
  * @typedef EInvoiceRetryParam
@@ -58,33 +56,46 @@ export = OrderPlatformValidator;
  * @property {string} logId - Log Error ID
  */
 /**
- * @typedef FetchCreditBalanceDetailParam
- * @property {OrderPlatformModel.FetchCreditBalanceRequestPayload} body
+ * @typedef FailedOrderLogsParam
+ * @property {string} [applicationId] - Application ID
+ * @property {number} [pageNo] - Page Number
+ * @property {number} [pageSize] - Page Size
+ * @property {string} [searchType] - Search type for filter
+ * @property {string} [searchValue] - Search value for filter
  */
 /**
  * @typedef FetchRefundModeConfigParam
  * @property {OrderPlatformModel.RefundModeConfigRequestPayload} body
  */
+/**
+ * @typedef GenerateInvoiceIDParam
+ * @property {string} invoiceType - Mention the type of invoice id to generate
+ * @property {OrderPlatformModel.GenerateInvoiceIDRequestSchema} body
+ */
 /**
  * @typedef GeneratePOSReceiptByOrderIdParam
  * @property {string} orderId
  * @property {string} [shipmentId]
  * @property {string} [documentType]
  */
+/**
+ * @typedef GenerateProcessManifestParam
+ * @property {OrderPlatformModel.ProcessManifestRequestSchema} 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
- * @property {string} [bagId] - Id of bag
+ * @property {string} [bagId] - Unique identifier of a bag
  * @property {string} [channelBagId] - Id of application bag
  * @property {string} [channelId] - Id of application
  */
@@ -105,8 +116,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] - UTC start date in ISO format
- * @property {string} [endDate] - UTC end date in 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} [stores] - Comma separated values of store ids
  * @property {string} [tags] - Comma separated values of tags
  * @property {string} [bagStatus] - Comma separated values of bag statuses
@@ -116,30 +127,20 @@ export = OrderPlatformValidator;
  * @property {number} [pageNo]
  * @property {number} [pageSize]
  */
-/**
- * @typedef GetFailedOrderLogsParam
- * @property {number} [pageNo] - Page Number
- * @property {number} [pageSize] - Page Size
- * @property {string} [searchType] - Search type for filter
- * @property {string} [searchValue] - Search value for filter
- */
+/** @typedef GetChannelConfigParam */
 /**
  * @typedef GetFileByStatusParam
- * @property {string} batchId
- * @property {string} status
+ * @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
- * @property {string} [reportType]
- */
-/**
- * @typedef GetGlobalFiltersParam
- * @property {string} showIn - Name of view to get filters for
+ * @property {string} [reportType] - The type of report to be downloaded.
  */
 /**
  * @typedef GetLaneConfigParam
  * @property {string} [superLane] - Name of lane for which data is to be fetched
  * @property {string} [groupEntity] - Name of group entity
  * @property {string} [fromDate] - Start Date in DD-MM-YYYY format
- * @property {string} [toDate]
+ * @property {string} [toDate] - End Date in DD-MM-YYYY format
  * @property {string} [startDate] - UTC Start Date in ISO format
  * @property {string} [endDate] - UTC End Date in ISO format
  * @property {string} [dpIds] - Comma separated values of delivery partner ids
@@ -147,115 +148,144 @@ 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]
+ * @property {string} [searchType] - Search_type refers to the field that will
+ *   be used as the target for the search operation
  * @property {string} [searchValue]
  * @property {string} [tags]
- * @property {number} [timeToDispatch]
+ * @property {number} [timeToDispatch] - Time_to_dispatch refers to estimated SLA time.
  * @property {string} [paymentMethods]
  * @property {boolean} [myOrders]
  * @property {boolean} [showCrossCompanyData] - Flag to view cross & non-cross
  *   company order
- * @property {string} [orderType]
+ * @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 goes through all the steps needed for delivery,
+ *       from being packed to arriving at the customer’s address.
+ *   - "PickAtStore": The order is prepared for pickup at the store, skipping
+ *       shipping steps to make it ready faster for the customer to collect in person.
+ *   - "Digital": This order type likely refers to orders that involve digital goods
+ *       or services, such as software, digital subscriptions, e-books, online
+ *       courses, or any other item that can be delivered electronically.
+ */
+/**
+ * @typedef GetManifestDetailsParam
+ * @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 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 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.
  */
 /**
  * @typedef GetManifestfiltersParam
  * @property {string} view - Name of View
  */
+/**
+ * @typedef GetManifestsParam
+ * @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
- * @property {string} orderId - Flag for order id
+ * @property {string} orderId
  * @property {boolean} [myOrders]
  * @property {boolean} [allowInactive] - Flag to allow inactive shipments
  */
 /**
  * @typedef GetOrdersParam
  * @property {string} [lane] - Lane refers to a section where orders are
- *   assigned, indicating its grouping
+ *   assigned, indicating its grouping.
  * @property {string} [searchType] - Search_type refers to the field that will
- *   be used as the target for the search operation
- * @property {string} [bagStatus] - Bag_status refers to the status of the
- *   entity. Filters orders based on the status.
- * @property {number} [timeToDispatch] - Time_to_dispatch refers to the
- *   estimated SLA time.
- * @property {string} [paymentMethods]
- * @property {string} [tags] - Tags refer to additional descriptive labels
+ *   be used as the target for the search operation.
+ * @property {string} [bagStatus] - Bag_status refers to status of the entity.
+ *   Filters orders based on the status.
+ * @property {number} [timeToDispatch] - Time_to_dispatch refers to estimated SLA time.
+ * @property {string} [paymentMethods] - Comma separated values of payment
+ *   methods that were used to place order.
+ * @property {string} [tags] - Tags refers to additional descriptive labels
  *   associated with the order
  * @property {string} [searchValue] - Search_value is matched against the field
  *   specified by the search_type
- * @property {string} [fromDate]
- * @property {string} [toDate]
- * @property {string} [startDate]
- * @property {string} [endDate]
+ * @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} [dpIds] - Delivery Partner IDs to which shipments are assigned.
- * @property {string} [stores]
- * @property {string} [salesChannels]
- * @property {number} [pageNo]
- * @property {number} [pageSize]
+ * @property {string} [stores] - A comma-separated list of store IDs used to
+ *   filter results to only those related to specific stores.
+ * @property {string} [salesChannels] - A comma-separated list of sales channel
+ *   IDs to filter results based on the sales channels involved.
+ * @property {number} [pageNo] - Specifies the page number for paginated results.
+ * @property {number} [pageSize] - Determines the number of results returned per page.
  * @property {boolean} [isPrioritySort]
- * @property {Object[]} [customMeta]
+ * @property {string} [customMeta]
  * @property {boolean} [myOrders]
  * @property {boolean} [showCrossCompanyData] - Flag to view cross & non-cross
  *   company order
- * @property {string} [customerId]
+ * @property {string} [customerId] - The unique identifier for the customer
+ *   associated with the query, useful for filtering results to a specific customer.
  * @property {string} [orderType]
- * @property {string} [operationalStatus] - Statuses relating to shipment
- *   transition in order processing journey. Comma separated values of
- *   operational statuses.
- * @property {string} [financialStatus] - Statuses relating to finance related
- *   operations in the order processing journey. Comma separated values of
- *   financial statuses.
- * @property {string} [logisticsStatus] - Statuses relating to delivery and
- *   pickup related operations in the order processing journey. Comma separated
- *   values of logistics statuses.
- * @property {string} [parentViewSlug] - Parent view is used for grouping of
- *   child views. Slug of parent view.
- * @property {string} [childViewSlug] - Child view is user configured view,
- *   which has filters added by the user on which shipments/orders are fetched.
- *   Slug of child view.
+ * @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.
- */
-/**
- * @typedef GetRefundConfigurationParam
- * @property {string} appId
- */
-/** @typedef GetRefundEnableStateListParam */
-/**
- * @typedef GetRefundOptionsParam
- * @property {string} shipmentId - ID of the shipment. An order may contain
- *   multiple items and may get divided into one or more shipment, each having
- *   its own ID.
- * @property {string} [bagIds] - It is the bag_id of the bags with comma separated.
- * @property {string} [state] - It is the desired state at which refund amount
- *   needs to be calculated.
- * @property {string} [optinAppId] - It is affiliate id of the order in case of
- *   cross selling.
- * @property {number} [optinCompanyId] - It is company id of the order in case
- *   of cross selling.
- * @property {string} [status] - It specifies the desired status to which the
- *   shipment should be updated. It represents the next step in the shipment's
- *   lifecycle, such as being cancelled by the customer or moved to another
- *   status in the shipping process.
- */
-/**
- * @typedef GetRefundStateConfigurationParam
- * @property {string} appId
+ * @property {boolean} [enforceDateFilter] - Applies a date filter for listing
+ *   orders. This is useful when fetching data for a specific date range while
+ *   performing searches.
+ * @property {string} [fulfillmentType] - Define the Fulfillment Type for
+ *   Listing Orders, This is use when we want to get list of shipments or orders
+ *   by cross store or cross company or fulfilling Store (by default), this is
+ *   also depends on the login user accessType and store access
  */
 /** @typedef GetRoleBasedActionsParam */
 /**
  * @typedef GetShipmentByIdParam
- * @property {string} [channelShipmentId] - App Shipment Id
- * @property {string} [shipmentId] - Shipment Id
+ * @property {string} [channelShipmentId] - The shipment ID used in the
+ *   application, which can be used to reference specific shipments.
+ * @property {string} [shipmentId] - The unique identifier for a shipment.
  * @property {boolean} [fetchActiveShipment] - Flag to fetch active or
  *   deactivated shipments
+ * @property {boolean} [allowInactive] - Flag indicating whether inactive
+ *   shipments are allowed
  */
 /**
  * @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
@@ -269,68 +299,92 @@ export = OrderPlatformValidator;
 /**
  * @typedef GetShipmentsParam
  * @property {string} [lane] - Name of lane for which data is to be fetched
- * @property {string} [bagStatus] - Comma separated values of bag statuses
+ * @property {string} [bagStatus] - Comma separated values of bag statuses.
+ * @property {string} [statusAssigned] - Used to filter shipments based on
+ *   status present in shipment_status_history. For more information on these
+ *   statuses, refer to the Fynd Partners documentation.
  * @property {boolean} [statusOverrideLane] - Use this flag to fetch by
- *   bag_status and override lane
- * @property {number} [timeToDispatch]
- * @property {string} [searchType] - Search type key
- * @property {string} [searchValue] - Search type value
+ *   bag_status and override lane.
+ * @property {number} [timeToDispatch] - Indicates the time to dispatch.
+ * @property {string} [searchType] - Specifies the key used to determine the
+ *   type of search being performed.
+ * @property {string} [searchValue] - The value corresponding to the search
+ *   type, such as a specific shipment ID or order ID.
  * @property {string} [fromDate] - Start Date in DD-MM-YYYY format
  * @property {string} [toDate] - End Date in DD-MM-YYYY format
- * @property {string} [startDate] - UTC Start Date in ISO format
- * @property {string} [endDate] - UTC End Date in ISO format
- * @property {string} [dpIds] - Comma separated values of delivery partner ids
- * @property {string} [stores] - Comma separated values of store ids
- * @property {string} [salesChannels] - Comma separated values of sales channel ids
- * @property {number} [pageNo] - Page number for paginated data
- * @property {number} [pageSize] - Page size of data received per page
- * @property {boolean} [fetchActiveShipment] - Flag to fetch active shipments
- * @property {boolean} [allowInactive] - Flag to allow inactive shipments
- * @property {boolean} [excludeLockedShipments] - Flag to fetch locked shipments
- * @property {string} [paymentMethods] - Comma separated values of payment methods
- * @property {string} [channelShipmentId] - App Shipment Id
- * @property {string} [channelOrderId] - App Order Id
- * @property {string} [customMeta]
- * @property {string} [orderingChannel]
- * @property {string} [companyAffiliateTag]
- * @property {boolean} [myOrders]
- * @property {string} [platformUserId]
- * @property {string} [sortType] - Sort the result data on basis of input
- * @property {boolean} [showCrossCompanyData] - Flag to view cross & non-cross
- *   company order
- * @property {string} [tags] - Comma separated values of tags
- * @property {string} [customerId]
- * @property {string} [orderType]
- * @property {string} [operationalStatus] - Statuses relating to shipment
- *   transition in order processing journey. Comma separated values of
- *   operational statuses.
- * @property {string} [financialStatus] - Statuses relating to finance related
- *   operations in the order processing journey. Comma separated values of
- *   financial statuses.
- * @property {string} [logisticsStatus] - Statuses relating to delivery and
- *   pickup related operations in the order processing journey. Comma separated
- *   values of logistics statuses.
- * @property {string} [parentViewSlug] - Parent view is used for grouping of
- *   child views. Slug of parent view.
- * @property {string} [childViewSlug] - Child view is user configured view which
- *   has filters added by the user on which shipments/orders are fetched. Slug
- *   of child view.
- * @property {string} [lockStatus] - Flag to identify if a shipment is locked or not.
+ * @property {string} [startDate] - The UTC start date in ISO format
+ *   (YYYY-MM-DDTHH:MM:SSZ) for filtering results.
+ * @property {string} [endDate] - The UTC end date in ISO format
+ *   (YYYY-MM-DDTHH:MM:SSZ) for filtering results.
+ * @property {string} [statusAssignedStartDate] - Specifies the starting UTC
+ *   date and time (in ISO format, YYYY-MM-DDTHH:MM:SSZ) to define the lower
+ *   boundary for filtering shipments based on the `created_at` timestamp of
+ *   statuses in the shipment's status history. It allows filtering statuses
+ *   that were created within a specific time range.
+ * @property {string} [statusAssignedEndDate] - Specifies the ending UTC date
+ *   and time (in ISO format, YYYY-MM-DDTHH:MM:SSZ) to define the upper boundary
+ *   for filtering shipments based on the `created_at` timestamp of statuses in
+ *   the shipment's status history.
+ * @property {string} [dpIds] - A comma-separated list of delivery partner IDs
+ *   to filter results by specific delivery partners.
+ * @property {string} [stores] - A comma-separated list of store IDs used to
+ *   filter results to only those related to specific stores.
+ * @property {string} [salesChannels] - A comma-separated list of sales channel
+ *   IDs to filter results based on the sales channels involved.
+ * @property {number} [pageNo] - Specifies the page number for paginated results.
+ * @property {number} [pageSize] - Determines the number of results returned per page.
+ * @property {boolean} [fetchActiveShipment] - A boolean flag that indicates
+ *   whether to include only active shipments in the results.
+ * @property {boolean} [allowInactive] - A flag indicating whether to allow the
+ *   inclusion of inactive shipments in the results.
+ * @property {boolean} [excludeLockedShipments] - A flag to specify whether to
+ *   exclude shipments that are locked from the results.
+ * @property {string} [paymentMethods] - A comma-separated list of payment methods.
+ * @property {string} [channelShipmentId] - The shipment ID used in the
+ *   application, which can be used to reference specific shipments.
+ * @property {string} [channelOrderId] - The order ID used in the application.
+ * @property {string} [customMeta] - Custom metadata associated with the query,
+ *   allowing for additional filtering or information to be passed.
+ * @property {string} [orderingChannel] - The channel through which the order was placed.
+ * @property {string} [companyAffiliateTag] - A tag used to identify the
+ *   company's affiliation for filtering or reporting purposes.
+ * @property {boolean} [myOrders] - A boolean flag indicating whether the query
+ *   should return only the user's orders.
+ * @property {string} [platformUserId] - The unique identifier of the user on
+ *   the platform, useful for filtering orders related to a specific user.
+ * @property {string} [sortType] - Determines the sorting order of the results
+ *   based on specific criteria.
+ * @property {boolean} [showCrossCompanyData] - A flag indicating whether to
+ *   include data from both cross-company and non-cross-company orders in the results.
+ * @property {string} [tags] - A comma-separated list of tags associated with
+ *   the orders to filter results based on specific characteristics.
+ * @property {string} [customerId] - The unique identifier for the customer
+ *   associated with the query, useful for filtering results to a specific customer.
+ * @property {string} [orderType] - The type of order being queried.
  * @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
+ *   shipments. This is useful when fetching data for a specific date range
+ *   while performing searches.
+ * @property {string} [fulfillmentType] - Define the Fulfillment Type for
+ *   Listing Orders, This is use when we want to get list of shipments or orders
+ *   by cross store or cross company or fulfilling Store (by default), this is
+ *   also depends on the login user accessType and store access
+ */
+/**
+ * @typedef GetStateManagerConfigParam
+ * @property {string} [appId] - The unique identifier of the application.
+ * @property {string} [orderingChannel] - The channel through which orders are placed.
+ * @property {string} [entity] - The entity for which the configuration is applied.
  */
 /** @typedef GetStateTransitionMapParam */
 /**
  * @typedef GetTemplateParam
  * @property {string} templateName
  */
-/**
- * @typedef GetUserViewsParam
- * @property {string} showIn - Name of view to get filters for.
- */
 /**
  * @typedef GetfiltersParam
  * @property {string} view - Name of view
@@ -342,22 +396,13 @@ export = OrderPlatformValidator;
  */
 /**
  * @typedef JobDetailsParam
- * @property {string} batchId
+ * @property {string} batchId - A unique identifier for the batch associated
+ *   with this bulk action.
  */
 /**
  * @typedef OrderUpdateParam
  * @property {OrderPlatformModel.PlatformOrderUpdate} body
  */
-/**
- * @typedef PostRefundConfigurationParam
- * @property {string} appId
- * @property {OrderPlatformModel.RefundStateConfigurationManualSchema} body
- */
-/**
- * @typedef PostRefundStateConfigurationParam
- * @property {string} appId
- * @property {OrderPlatformModel.PostRefundStateConfiguration} body
- */
 /**
  * @typedef PostShipmentHistoryParam
  * @property {OrderPlatformModel.PostShipmentHistory} body
@@ -376,23 +421,23 @@ 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 UpdateOrderParam
- * @property {string} orderId
- * @property {OrderPlatformModel.OrderUpdatePayload} body
+ * @typedef UpdateAddressParam
+ * @property {string} shipmentId - Unique shipment no. that is auto-generated
+ * @property {OrderPlatformModel.UpdateAddressRequestBody} body
  */
 /**
  * @typedef UpdatePackagingDimensionsParam
  * @property {OrderPlatformModel.UpdatePackagingDimensionsPayload} body
  */
 /**
- * @typedef UpdateShipmentParam
- * @property {OrderPlatformModel.UpdateShipmentActionRequest} body
+ * @typedef UpdatePaymentInfoParam
+ * @property {OrderPlatformModel.UpdateShipmentPaymentMode} body
  */
 /**
  * @typedef UpdateShipmentLockParam
@@ -400,27 +445,23 @@ export = OrderPlatformValidator;
  */
 /**
  * @typedef UpdateShipmentStatusParam
- * @property {OrderPlatformModel.UpdateShipmentStatusRequest} body
+ * @property {OrderPlatformModel.UpdateShipmentStatusRequestSchema} body
  */
 /**
  * @typedef UpdateShipmentTrackingParam
  * @property {OrderPlatformModel.CourierPartnerTrackingDetails} body
  */
 /**
- * @typedef UpdateUserViewPositionParam
- * @property {OrderPlatformModel.UserViewPosition} body
- */
-/**
- * @typedef UpdateUserViewsParam
- * @property {OrderPlatformModel.UserViewsResponse} body
+ * @typedef UploadConsentsParam
+ * @property {OrderPlatformModel.UploadManifestConsent} body
  */
 /**
  * @typedef VerifyMobileOTPParam
  * @property {OrderPlatformModel.VerifyMobileOTP} body
  */
 declare class OrderPlatformValidator {
-    /** @returns {AddUserViewsParam} */
-    static addUserViews(): AddUserViewsParam;
+    /** @returns {AddStateManagerConfigParam} */
+    static addStateManagerConfig(): AddStateManagerConfigParam;
     /** @returns {AttachOrderUserParam} */
     static attachOrderUser(): AttachOrderUserParam;
     /** @returns {BulkListingParam} */
@@ -429,12 +470,12 @@ declare class OrderPlatformValidator {
     static bulkStateTransistion(): BulkStateTransistionParam;
     /** @returns {CheckOrderStatusParam} */
     static checkOrderStatus(): CheckOrderStatusParam;
-    /** @returns {Click2CallParam} */
-    static click2Call(): Click2CallParam;
+    /** @returns {CreateChannelConfigParam} */
+    static createChannelConfig(): CreateChannelConfigParam;
     /** @returns {CreateOrderParam} */
     static createOrder(): CreateOrderParam;
-    /** @returns {DeleteUserViewsParam} */
-    static deleteUserViews(): DeleteUserViewsParam;
+    /** @returns {DispatchManifestsParam} */
+    static dispatchManifests(): DispatchManifestsParam;
     /** @returns {DownloadBulkActionTemplateParam} */
     static downloadBulkActionTemplate(): DownloadBulkActionTemplateParam;
     /** @returns {DownloadLanesReportParam} */
@@ -443,12 +484,16 @@ declare class OrderPlatformValidator {
     static eInvoiceRetry(): EInvoiceRetryParam;
     /** @returns {FailedOrderLogDetailsParam} */
     static failedOrderLogDetails(): FailedOrderLogDetailsParam;
-    /** @returns {FetchCreditBalanceDetailParam} */
-    static fetchCreditBalanceDetail(): FetchCreditBalanceDetailParam;
+    /** @returns {FailedOrderLogsParam} */
+    static failedOrderLogs(): FailedOrderLogsParam;
     /** @returns {FetchRefundModeConfigParam} */
     static fetchRefundModeConfig(): FetchRefundModeConfigParam;
+    /** @returns {GenerateInvoiceIDParam} */
+    static generateInvoiceID(): GenerateInvoiceIDParam;
     /** @returns {GeneratePOSReceiptByOrderIdParam} */
     static generatePOSReceiptByOrderId(): GeneratePOSReceiptByOrderIdParam;
+    /** @returns {GenerateProcessManifestParam} */
+    static generateProcessManifest(): GenerateProcessManifestParam;
     /** @returns {GetAllowedStateTransitionParam} */
     static getAllowedStateTransition(): GetAllowedStateTransitionParam;
     /** @returns {GetAllowedTemplatesForBulkParam} */
@@ -463,28 +508,24 @@ declare class OrderPlatformValidator {
     static getBulkActionTemplate(): any;
     /** @returns {GetBulkShipmentExcelFileParam} */
     static getBulkShipmentExcelFile(): GetBulkShipmentExcelFileParam;
-    /** @returns {GetFailedOrderLogsParam} */
-    static getFailedOrderLogs(): GetFailedOrderLogsParam;
+    /** @returns {GetChannelConfigParam} */
+    static getChannelConfig(): any;
     /** @returns {GetFileByStatusParam} */
     static getFileByStatus(): GetFileByStatusParam;
-    /** @returns {GetGlobalFiltersParam} */
-    static getGlobalFilters(): GetGlobalFiltersParam;
     /** @returns {GetLaneConfigParam} */
     static getLaneConfig(): GetLaneConfigParam;
+    /** @returns {GetManifestDetailsParam} */
+    static getManifestDetails(): GetManifestDetailsParam;
+    /** @returns {GetManifestShipmentsParam} */
+    static getManifestShipments(): GetManifestShipmentsParam;
     /** @returns {GetManifestfiltersParam} */
     static getManifestfilters(): GetManifestfiltersParam;
+    /** @returns {GetManifestsParam} */
+    static getManifests(): GetManifestsParam;
     /** @returns {GetOrderByIdParam} */
     static getOrderById(): GetOrderByIdParam;
     /** @returns {GetOrdersParam} */
     static getOrders(): GetOrdersParam;
-    /** @returns {GetRefundConfigurationParam} */
-    static getRefundConfiguration(): GetRefundConfigurationParam;
-    /** @returns {GetRefundEnableStateListParam} */
-    static getRefundEnableStateList(): any;
-    /** @returns {GetRefundOptionsParam} */
-    static getRefundOptions(): GetRefundOptionsParam;
-    /** @returns {GetRefundStateConfigurationParam} */
-    static getRefundStateConfiguration(): GetRefundStateConfigurationParam;
     /** @returns {GetRoleBasedActionsParam} */
     static getRoleBasedActions(): any;
     /** @returns {GetShipmentByIdParam} */
@@ -495,12 +536,12 @@ declare class OrderPlatformValidator {
     static getShipmentReasons(): GetShipmentReasonsParam;
     /** @returns {GetShipmentsParam} */
     static getShipments(): GetShipmentsParam;
+    /** @returns {GetStateManagerConfigParam} */
+    static getStateManagerConfig(): GetStateManagerConfigParam;
     /** @returns {GetStateTransitionMapParam} */
     static getStateTransitionMap(): any;
     /** @returns {GetTemplateParam} */
     static getTemplate(): GetTemplateParam;
-    /** @returns {GetUserViewsParam} */
-    static getUserViews(): GetUserViewsParam;
     /** @returns {GetfiltersParam} */
     static getfilters(): GetfiltersParam;
     /** @returns {InvalidateShipmentCacheParam} */
@@ -509,10 +550,6 @@ declare class OrderPlatformValidator {
     static jobDetails(): JobDetailsParam;
     /** @returns {OrderUpdateParam} */
     static orderUpdate(): OrderUpdateParam;
-    /** @returns {PostRefundConfigurationParam} */
-    static postRefundConfiguration(): PostRefundConfigurationParam;
-    /** @returns {PostRefundStateConfigurationParam} */
-    static postRefundStateConfiguration(): PostRefundStateConfigurationParam;
     /** @returns {PostShipmentHistoryParam} */
     static postShipmentHistory(): PostShipmentHistoryParam;
     /** @returns {ReassignLocationParam} */
@@ -523,100 +560,78 @@ declare class OrderPlatformValidator {
     static sendUserMobileOTP(): SendUserMobileOTPParam;
     /** @returns {TrackShipmentParam} */
     static trackShipment(): TrackShipmentParam;
-    /** @returns {UpdateOrderParam} */
-    static updateOrder(): UpdateOrderParam;
+    /** @returns {UpdateAddressParam} */
+    static updateAddress(): UpdateAddressParam;
     /** @returns {UpdatePackagingDimensionsParam} */
     static updatePackagingDimensions(): UpdatePackagingDimensionsParam;
-    /** @returns {UpdateShipmentParam} */
-    static updateShipment(): UpdateShipmentParam;
+    /** @returns {UpdatePaymentInfoParam} */
+    static updatePaymentInfo(): UpdatePaymentInfoParam;
     /** @returns {UpdateShipmentLockParam} */
     static updateShipmentLock(): UpdateShipmentLockParam;
     /** @returns {UpdateShipmentStatusParam} */
     static updateShipmentStatus(): UpdateShipmentStatusParam;
     /** @returns {UpdateShipmentTrackingParam} */
     static updateShipmentTracking(): UpdateShipmentTrackingParam;
-    /** @returns {UpdateUserViewPositionParam} */
-    static updateUserViewPosition(): UpdateUserViewPositionParam;
-    /** @returns {UpdateUserViewsParam} */
-    static updateUserViews(): UpdateUserViewsParam;
+    /** @returns {UploadConsentsParam} */
+    static uploadConsents(): UploadConsentsParam;
     /** @returns {VerifyMobileOTPParam} */
     static verifyMobileOTP(): VerifyMobileOTPParam;
 }
 declare namespace OrderPlatformValidator {
-    export { AddUserViewsParam, AttachOrderUserParam, BulkListingParam, BulkStateTransistionParam, CheckOrderStatusParam, Click2CallParam, CreateOrderParam, DeleteUserViewsParam, DownloadBulkActionTemplateParam, DownloadLanesReportParam, EInvoiceRetryParam, FailedOrderLogDetailsParam, FetchCreditBalanceDetailParam, FetchRefundModeConfigParam, GeneratePOSReceiptByOrderIdParam, GetAllowedStateTransitionParam, GetAllowedTemplatesForBulkParam, GetAnnouncementsParam, GetBagByIdParam, GetBagsParam, GetBulkActionTemplateParam, GetBulkShipmentExcelFileParam, GetFailedOrderLogsParam, GetFileByStatusParam, GetGlobalFiltersParam, GetLaneConfigParam, GetManifestfiltersParam, GetOrderByIdParam, GetOrdersParam, GetRefundConfigurationParam, GetRefundEnableStateListParam, GetRefundOptionsParam, GetRefundStateConfigurationParam, GetRoleBasedActionsParam, GetShipmentByIdParam, GetShipmentHistoryParam, GetShipmentReasonsParam, GetShipmentsParam, GetStateTransitionMapParam, GetTemplateParam, GetUserViewsParam, GetfiltersParam, InvalidateShipmentCacheParam, JobDetailsParam, OrderUpdateParam, PostRefundConfigurationParam, PostRefundStateConfigurationParam, PostShipmentHistoryParam, ReassignLocationParam, SendSmsNinjaParam, SendUserMobileOTPParam, TrackShipmentParam, UpdateOrderParam, UpdatePackagingDimensionsParam, UpdateShipmentParam, UpdateShipmentLockParam, UpdateShipmentStatusParam, UpdateShipmentTrackingParam, UpdateUserViewPositionParam, UpdateUserViewsParam, VerifyMobileOTPParam };
+    export { AddStateManagerConfigParam, AttachOrderUserParam, BulkListingParam, BulkStateTransistionParam, CheckOrderStatusParam, CreateChannelConfigParam, CreateOrderParam, DispatchManifestsParam, DownloadBulkActionTemplateParam, DownloadLanesReportParam, EInvoiceRetryParam, FailedOrderLogDetailsParam, FailedOrderLogsParam, 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, ReassignLocationParam, SendSmsNinjaParam, SendUserMobileOTPParam, TrackShipmentParam, UpdateAddressParam, UpdatePackagingDimensionsParam, UpdatePaymentInfoParam, UpdateShipmentLockParam, UpdateShipmentStatusParam, UpdateShipmentTrackingParam, UploadConsentsParam, VerifyMobileOTPParam };
 }
-type AddUserViewsParam = {
-    body: OrderPlatformModel.UserViewsResponse;
+type AddStateManagerConfigParam = {
+    body: OrderPlatformModel.TransitionConfigPayload;
 };
 type AttachOrderUserParam = {
     body: OrderPlatformModel.AttachOrderUser;
 };
 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;
+    startDate: string;
     /**
-     * - UTC end date in ISO format
+     * - The end date for filtering the jobs, expressed
+     * in UTC format
      */
-    endDate?: string;
+    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;
 };
 type BulkStateTransistionParam = {
-    body: OrderPlatformModel.BulkStateTransistionRequest;
+    body: OrderPlatformModel.BulkStateTransistionRequestSchema;
 };
 type CheckOrderStatusParam = {
     body: OrderPlatformModel.OrderStatus;
 };
-type Click2CallParam = {
-    /**
-     * - Call Number
-     */
-    caller: string;
-    /**
-     * - Receiver Number
-     */
-    receiver: string;
-    /**
-     * - Bag Id for the query
-     */
-    bagId: string;
-    /**
-     * - Caller Id
-     */
-    callerId?: string;
-    /**
-     * - Provider Method to Call
-     */
-    method?: string;
+type CreateChannelConfigParam = {
+    body: OrderPlatformModel.CreateChannelConfigData;
 };
 type CreateOrderParam = {
     body: OrderPlatformModel.CreateOrderAPI;
 };
-type DeleteUserViewsParam = {
-    /**
-     * - Comma separated values of view ids
-     */
-    viewId: string;
+type DispatchManifestsParam = {
+    body: OrderPlatformModel.DispatchManifest;
 };
 type DownloadBulkActionTemplateParam = {
     /**
@@ -625,7 +640,7 @@ type DownloadBulkActionTemplateParam = {
     templateSlug?: string;
 };
 type DownloadLanesReportParam = {
-    body: OrderPlatformModel.BulkReportsDownloadRequest;
+    body: OrderPlatformModel.BulkReportsDownloadRequestSchema;
 };
 type EInvoiceRetryParam = {
     body: OrderPlatformModel.EInvoiceRetry;
@@ -636,37 +651,66 @@ type FailedOrderLogDetailsParam = {
      */
     logId: string;
 };
-type FetchCreditBalanceDetailParam = {
-    body: OrderPlatformModel.FetchCreditBalanceRequestPayload;
+type FailedOrderLogsParam = {
+    /**
+     * - Application ID
+     */
+    applicationId?: string;
+    /**
+     * - Page Number
+     */
+    pageNo?: number;
+    /**
+     * - Page Size
+     */
+    pageSize?: number;
+    /**
+     * - Search type for filter
+     */
+    searchType?: string;
+    /**
+     * - Search value for filter
+     */
+    searchValue?: string;
 };
 type FetchRefundModeConfigParam = {
     body: OrderPlatformModel.RefundModeConfigRequestPayload;
 };
+type GenerateInvoiceIDParam = {
+    /**
+     * - Mention the type of invoice id to generate
+     */
+    invoiceType: string;
+    body: OrderPlatformModel.GenerateInvoiceIDRequestSchema;
+};
 type GeneratePOSReceiptByOrderIdParam = {
     orderId: string;
     shipmentId?: string;
     documentType?: string;
 };
+type GenerateProcessManifestParam = {
+    body: OrderPlatformModel.ProcessManifestRequestSchema;
+};
 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;
 };
 type GetBagByIdParam = {
     /**
-     * - Id of bag
+     * - Unique identifier of a bag
      */
     bagId?: string;
     /**
@@ -726,11 +770,11 @@ type GetBulkShipmentExcelFileParam = {
      */
     dpIds?: string;
     /**
-     * - UTC start date in ISO format
+     * - Date time in UTC timezone as per ISO format.
      */
     startDate?: string;
     /**
-     * - UTC end date in ISO format
+     * - Date time in UTC timezone as per ISO format.
      */
     endDate?: string;
     /**
@@ -760,35 +804,20 @@ type GetBulkShipmentExcelFileParam = {
     pageNo?: number;
     pageSize?: number;
 };
-type GetFailedOrderLogsParam = {
-    /**
-     * - Page Number
-     */
-    pageNo?: number;
-    /**
-     * - Page Size
-     */
-    pageSize?: number;
+type GetFileByStatusParam = {
     /**
-     * - Search type for filter
+     * - Batch Id to identify the bulk operation request.
      */
-    searchType?: string;
+    batchId: string;
     /**
-     * - Search value for filter
+     * - The status of the jobs to filter the results.
      */
-    searchValue?: string;
-};
-type GetFileByStatusParam = {
-    batchId: string;
     status: string;
     fileType: string;
-    reportType?: string;
-};
-type GetGlobalFiltersParam = {
     /**
-     * - Name of view to get filters for
+     * - The type of report to be downloaded.
      */
-    showIn: string;
+    reportType?: string;
 };
 type GetLaneConfigParam = {
     /**
@@ -803,6 +832,9 @@ type GetLaneConfigParam = {
      * - Start Date in DD-MM-YYYY format
      */
     fromDate?: string;
+    /**
+     * - End Date in DD-MM-YYYY format
+     */
     toDate?: string;
     /**
      * - UTC Start Date in ISO format
@@ -829,9 +861,16 @@ 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;
@@ -840,18 +879,143 @@ 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 goes through all the steps needed for delivery,
+     * from being packed to arriving at the customer’s address.
+     * - "PickAtStore": The order is prepared for pickup at the store, skipping
+     * shipping steps to make it ready faster for the customer to collect in person.
+     * - "Digital": This order type likely refers to orders that involve digital goods
+     * or services, such as software, digital subscriptions, e-books, online
+     * courses, or any other item that can be delivered electronically.
+     */
     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 = {
+    /**
+     * - Filter shipments with the specific Courier partner
+     * Ids which is a combination of courier partner extension and scheme Ids.
+     */
+    dpIds: string;
+    /**
+     * - Filter results based on specific store IDs.
+     */
+    stores: number;
+    /**
+     * - End date for the shipment search range.
+     */
+    toDate: string;
+    /**
+     * - Start date for the shipment search range.
+     */
+    fromDate: string;
+    /**
+     * - Filter results based on specific courier partner name.
+     */
+    dpName?: string;
+    /**
+     * - Filter results based on comma-separated
+     * list of sales channels.
+     */
+    salesChannels?: string;
+    /**
+     * - Filter results based on search type.
+     */
+    searchType?: string;
+    /**
+     * - Filter results based on the search value.
+     */
+    searchValue?: string;
+    /**
+     * - Page number for pagination.
+     */
+    pageNo?: number;
+    /**
+     * - Number of records per page for pagination.
+     */
+    pageSize?: number;
+};
 type GetManifestfiltersParam = {
     /**
      * - Name of View
      */
     view: string;
 };
-type GetOrderByIdParam = {
+type GetManifestsParam = {
+    /**
+     * - Filter for the status of manifests.
+     */
+    status?: string;
+    /**
+     * - The starting date for filtering manifests in
+     * ISO format
+     */
+    startDate?: string;
+    /**
+     * - The end date for filtering manifests in ISO format
+     */
+    endDate?: string;
+    /**
+     * - Specifies the type of search to perform.
+     */
+    searchType?: string;
+    /**
+     * - Filter to fetch manifests for a specific store
+     * by its ID.
+     */
+    storeId?: number;
+    /**
+     * - The value to search for based on the
+     * selected search type.
+     */
+    searchValue?: string;
+    /**
+     * - 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;
     /**
-     * - Flag for order id
+     * - The number of records to return per page for
+     * pagination.
      */
+    pageSize?: number;
+};
+type GetOrderByIdParam = {
     orderId: string;
     myOrders?: boolean;
     /**
@@ -862,27 +1026,30 @@ type GetOrderByIdParam = {
 type GetOrdersParam = {
     /**
      * - Lane refers to a section where orders are
-     * assigned, indicating its grouping
+     * assigned, indicating its grouping.
      */
     lane?: string;
     /**
      * - Search_type refers to the field that will
-     * be used as the target for the search operation
+     * be used as the target for the search operation.
      */
     searchType?: string;
     /**
-     * - Bag_status refers to the status of the
-     * entity. Filters orders based on the status.
+     * - Bag_status refers to status of the entity.
+     * Filters orders based on the status.
      */
     bagStatus?: string;
     /**
-     * - Time_to_dispatch refers to the
-     * estimated SLA time.
+     * - Time_to_dispatch refers to estimated SLA time.
      */
     timeToDispatch?: number;
+    /**
+     * - Comma separated values of payment
+     * methods that were used to place order.
+     */
     paymentMethods?: string;
     /**
-     * - Tags refer to additional descriptive labels
+     * - Tags refers to additional descriptive labels
      * associated with the order
      */
     tags?: string;
@@ -891,57 +1058,63 @@ 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.
      */
     dpIds?: string;
+    /**
+     * - A comma-separated list of store IDs used to
+     * filter results to only those related to specific stores.
+     */
     stores?: string;
+    /**
+     * - A comma-separated list of sales channel
+     * IDs to filter results based on the sales channels involved.
+     */
     salesChannels?: string;
+    /**
+     * - Specifies the page number for paginated results.
+     */
     pageNo?: number;
+    /**
+     * - Determines the number of results returned per page.
+     */
     pageSize?: number;
     isPrioritySort?: boolean;
-    customMeta?: any[];
+    customMeta?: string;
     myOrders?: boolean;
     /**
      * - Flag to view cross & non-cross
      * company order
      */
     showCrossCompanyData?: boolean;
-    customerId?: string;
-    orderType?: string;
     /**
-     * - Statuses relating to shipment
-     * transition in order processing journey. Comma separated values of
-     * operational statuses.
+     * - The unique identifier for the customer
+     * associated with the query, useful for filtering results to a specific customer.
      */
-    operationalStatus?: string;
-    /**
-     * - Statuses relating to finance related
-     * operations in the order processing journey. Comma separated values of
-     * financial statuses.
-     */
-    financialStatus?: string;
-    /**
-     * - Statuses relating to delivery and
-     * pickup related operations in the order processing journey. Comma separated
-     * values of logistics statuses.
-     */
-    logisticsStatus?: string;
-    /**
-     * - Parent view is used for grouping of
-     * child views. Slug of parent view.
-     */
-    parentViewSlug?: string;
+    customerId?: string;
+    orderType?: string;
     /**
-     * - Child view is user configured view,
-     * which has filters added by the user on which shipments/orders are fetched.
-     * Slug of child view.
+     * - Flag indicating whether inactive
+     * shipments are allowed
      */
-    childViewSlug?: string;
+    allowInactive?: boolean;
     /**
      * - Defines the grouping criterion for
      * retrieving shipments or orders. It specifies whether the results should be
@@ -950,54 +1123,28 @@ type GetOrdersParam = {
      * may not be recognized, leading to errors or default behavior.
      */
     groupEntity?: string;
-};
-type GetRefundConfigurationParam = {
-    appId: string;
-};
-type GetRefundOptionsParam = {
-    /**
-     * - ID of the shipment. An order may contain
-     * multiple items and may get divided into one or more shipment, each having
-     * its own ID.
-     */
-    shipmentId: string;
-    /**
-     * - It is the bag_id of the bags with comma separated.
-     */
-    bagIds?: string;
     /**
-     * - It is the desired state at which refund amount
-     * needs to be calculated.
+     * - Applies a date filter for listing
+     * orders. This is useful when fetching data for a specific date range while
+     * performing searches.
      */
-    state?: string;
+    enforceDateFilter?: boolean;
     /**
-     * - It is affiliate id of the order in case of
-     * cross selling.
+     * - Define the Fulfillment Type for
+     * Listing Orders, This is use when we want to get list of shipments or orders
+     * by cross store or cross company or fulfilling Store (by default), this is
+     * also depends on the login user accessType and store access
      */
-    optinAppId?: string;
-    /**
-     * - It is company id of the order in case
-     * of cross selling.
-     */
-    optinCompanyId?: number;
-    /**
-     * - It specifies the desired status to which the
-     * shipment should be updated. It represents the next step in the shipment's
-     * lifecycle, such as being cancelled by the customer or moved to another
-     * status in the shipping process.
-     */
-    status?: string;
-};
-type GetRefundStateConfigurationParam = {
-    appId: string;
+    fulfillmentType?: string;
 };
 type GetShipmentByIdParam = {
     /**
-     * - App Shipment Id
+     * - The shipment ID used in the
+     * application, which can be used to reference specific shipments.
      */
     channelShipmentId?: string;
     /**
-     * - Shipment Id
+     * - The unique identifier for a shipment.
      */
     shipmentId?: string;
     /**
@@ -1005,14 +1152,19 @@ type GetShipmentByIdParam = {
      * deactivated shipments
      */
     fetchActiveShipment?: boolean;
+    /**
+     * - Flag indicating whether inactive
+     * shipments are allowed
+     */
+    allowInactive?: boolean;
 };
 type GetShipmentHistoryParam = {
     /**
-     * - Shipment Id
+     * - Identifier for the shipment
      */
     shipmentId?: string;
     /**
-     * - Bag/Product Id
+     * - Identifier for a bag or product.
      */
     bagId?: number;
 };
@@ -1039,21 +1191,32 @@ type GetShipmentsParam = {
      */
     lane?: string;
     /**
-     * - Comma separated values of bag statuses
+     * - Comma separated values of bag statuses.
      */
     bagStatus?: string;
+    /**
+     * - Used to filter shipments based on
+     * status present in shipment_status_history. For more information on these
+     * statuses, refer to the Fynd Partners documentation.
+     */
+    statusAssigned?: string;
     /**
      * - Use this flag to fetch by
-     * bag_status and override lane
+     * bag_status and override lane.
      */
     statusOverrideLane?: boolean;
+    /**
+     * - Indicates the time to dispatch.
+     */
     timeToDispatch?: number;
     /**
-     * - Search type key
+     * - Specifies the key used to determine the
+     * type of search being performed.
      */
     searchType?: string;
     /**
-     * - Search type value
+     * - The value corresponding to the search
+     * type, such as a specific shipment ID or order ID.
      */
     searchValue?: string;
     /**
@@ -1065,128 +1228,168 @@ type GetShipmentsParam = {
      */
     toDate?: string;
     /**
-     * - UTC Start Date in ISO format
+     * - The UTC start date in ISO format
+     * (YYYY-MM-DDTHH:MM:SSZ) for filtering results.
      */
     startDate?: string;
     /**
-     * - UTC End Date in ISO format
+     * - The UTC end date in ISO format
+     * (YYYY-MM-DDTHH:MM:SSZ) for filtering results.
      */
     endDate?: string;
     /**
-     * - Comma separated values of delivery partner ids
+     * - Specifies the starting UTC
+     * date and time (in ISO format, YYYY-MM-DDTHH:MM:SSZ) to define the lower
+     * boundary for filtering shipments based on the `created_at` timestamp of
+     * statuses in the shipment's status history. It allows filtering statuses
+     * that were created within a specific time range.
+     */
+    statusAssignedStartDate?: string;
+    /**
+     * - Specifies the ending UTC date
+     * and time (in ISO format, YYYY-MM-DDTHH:MM:SSZ) to define the upper boundary
+     * for filtering shipments based on the `created_at` timestamp of statuses in
+     * the shipment's status history.
+     */
+    statusAssignedEndDate?: string;
+    /**
+     * - A comma-separated list of delivery partner IDs
+     * to filter results by specific delivery partners.
      */
     dpIds?: string;
     /**
-     * - Comma separated values of store ids
+     * - A comma-separated list of store IDs used to
+     * filter results to only those related to specific stores.
      */
     stores?: string;
     /**
-     * - Comma separated values of sales channel ids
+     * - A comma-separated list of sales channel
+     * IDs to filter results based on the sales channels involved.
      */
     salesChannels?: string;
     /**
-     * - Page number for paginated data
+     * - Specifies the page number for paginated results.
      */
     pageNo?: number;
     /**
-     * - Page size of data received per page
+     * - Determines the number of results returned per page.
      */
     pageSize?: number;
     /**
-     * - Flag to fetch active shipments
+     * - A boolean flag that indicates
+     * whether to include only active shipments in the results.
      */
     fetchActiveShipment?: boolean;
     /**
-     * - Flag to allow inactive shipments
+     * - A flag indicating whether to allow the
+     * inclusion of inactive shipments in the results.
      */
     allowInactive?: boolean;
     /**
-     * - Flag to fetch locked shipments
+     * - A flag to specify whether to
+     * exclude shipments that are locked from the results.
      */
     excludeLockedShipments?: boolean;
     /**
-     * - Comma separated values of payment methods
+     * - A comma-separated list of payment methods.
      */
     paymentMethods?: string;
     /**
-     * - App Shipment Id
+     * - The shipment ID used in the
+     * application, which can be used to reference specific shipments.
      */
     channelShipmentId?: string;
     /**
-     * - App Order Id
+     * - The order ID used in the application.
      */
     channelOrderId?: string;
+    /**
+     * - Custom metadata associated with the query,
+     * allowing for additional filtering or information to be passed.
+     */
     customMeta?: string;
+    /**
+     * - The channel through which the order was placed.
+     */
     orderingChannel?: string;
+    /**
+     * - A tag used to identify the
+     * company's affiliation for filtering or reporting purposes.
+     */
     companyAffiliateTag?: string;
+    /**
+     * - A boolean flag indicating whether the query
+     * should return only the user's orders.
+     */
     myOrders?: boolean;
+    /**
+     * - The unique identifier of the user on
+     * the platform, useful for filtering orders related to a specific user.
+     */
     platformUserId?: string;
     /**
-     * - Sort the result data on basis of input
+     * - Determines the sorting order of the results
+     * based on specific criteria.
      */
     sortType?: string;
     /**
-     * - Flag to view cross & non-cross
-     * company order
+     * - A flag indicating whether to
+     * include data from both cross-company and non-cross-company orders in the results.
      */
     showCrossCompanyData?: boolean;
     /**
-     * - Comma separated values of tags
+     * - A comma-separated list of tags associated with
+     * the orders to filter results based on specific characteristics.
      */
     tags?: string;
+    /**
+     * - The unique identifier for the customer
+     * associated with the query, useful for filtering results to a specific customer.
+     */
     customerId?: string;
-    orderType?: string;
     /**
-     * - Statuses relating to shipment
-     * transition in order processing journey. Comma separated values of
-     * operational statuses.
+     * - The type of order being queried.
      */
-    operationalStatus?: string;
+    orderType?: string;
     /**
-     * - Statuses relating to finance related
-     * operations in the order processing journey. Comma separated values of
-     * financial statuses.
+     * - 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.
      */
-    financialStatus?: string;
+    groupEntity?: string;
     /**
-     * - Statuses relating to delivery and
-     * pickup related operations in the order processing journey. Comma separated
-     * values of logistics statuses.
+     * - Applies a date filter for listing
+     * shipments. This is useful when fetching data for a specific date range
+     * while performing searches.
      */
-    logisticsStatus?: string;
+    enforceDateFilter?: boolean;
     /**
-     * - Parent view is used for grouping of
-     * child views. Slug of parent view.
+     * - Define the Fulfillment Type for
+     * Listing Orders, This is use when we want to get list of shipments or orders
+     * by cross store or cross company or fulfilling Store (by default), this is
+     * also depends on the login user accessType and store access
      */
-    parentViewSlug?: string;
+    fulfillmentType?: string;
+};
+type GetStateManagerConfigParam = {
     /**
-     * - Child view is user configured view which
-     * has filters added by the user on which shipments/orders are fetched. Slug
-     * of child view.
+     * - The unique identifier of the application.
      */
-    childViewSlug?: string;
+    appId?: string;
     /**
-     * - Flag to identify if a shipment is locked or not.
+     * - The channel through which orders are placed.
      */
-    lockStatus?: string;
+    orderingChannel?: 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.
+     * - The entity for which the configuration is applied.
      */
-    groupEntity?: string;
+    entity?: string;
 };
 type GetTemplateParam = {
     templateName: string;
 };
-type GetUserViewsParam = {
-    /**
-     * - Name of view to get filters for.
-     */
-    showIn: string;
-};
 type GetfiltersParam = {
     /**
      * - Name of view
@@ -1201,19 +1404,15 @@ type InvalidateShipmentCacheParam = {
     body: OrderPlatformModel.InvalidateShipmentCachePayload;
 };
 type JobDetailsParam = {
+    /**
+     * - A unique identifier for the batch associated
+     * with this bulk action.
+     */
     batchId: string;
 };
 type OrderUpdateParam = {
     body: OrderPlatformModel.PlatformOrderUpdate;
 };
-type PostRefundConfigurationParam = {
-    appId: string;
-    body: OrderPlatformModel.RefundStateConfigurationManualSchema;
-};
-type PostRefundStateConfigurationParam = {
-    appId: string;
-    body: OrderPlatformModel.PostRefundStateConfiguration;
-};
 type PostShipmentHistoryParam = {
     body: OrderPlatformModel.PostShipmentHistory;
 };
@@ -1228,7 +1427,7 @@ type SendUserMobileOTPParam = {
 };
 type TrackShipmentParam = {
     /**
-     * - Shipment ID
+     * - Unique identifier of a shipment on the platform.
      */
     shipmentId?: string;
     /**
@@ -1236,45 +1435,45 @@ type TrackShipmentParam = {
      */
     awb?: string;
     /**
-     * - Page number
+     * - Page number for pagination.
      */
     pageNo?: number;
     /**
-     * - Page size
+     * - Number of records per page for pagination.
      */
     pageSize?: number;
 };
-type UpdateOrderParam = {
-    orderId: string;
-    body: OrderPlatformModel.OrderUpdatePayload;
+type UpdateAddressParam = {
+    /**
+     * - Unique shipment no. that is auto-generated
+     */
+    shipmentId: string;
+    body: OrderPlatformModel.UpdateAddressRequestBody;
 };
 type UpdatePackagingDimensionsParam = {
     body: OrderPlatformModel.UpdatePackagingDimensionsPayload;
 };
-type UpdateShipmentParam = {
-    body: OrderPlatformModel.UpdateShipmentActionRequest;
+type UpdatePaymentInfoParam = {
+    body: OrderPlatformModel.UpdateShipmentPaymentMode;
 };
 type UpdateShipmentLockParam = {
     body: OrderPlatformModel.UpdateShipmentLockPayload;
 };
 type UpdateShipmentStatusParam = {
-    body: OrderPlatformModel.UpdateShipmentStatusRequest;
+    body: OrderPlatformModel.UpdateShipmentStatusRequestSchema;
 };
 type UpdateShipmentTrackingParam = {
     body: OrderPlatformModel.CourierPartnerTrackingDetails;
 };
-type UpdateUserViewPositionParam = {
-    body: OrderPlatformModel.UserViewPosition;
-};
-type UpdateUserViewsParam = {
-    body: OrderPlatformModel.UserViewsResponse;
+type UploadConsentsParam = {
+    body: OrderPlatformModel.UploadManifestConsent;
 };
 type VerifyMobileOTPParam = {
     body: OrderPlatformModel.VerifyMobileOTP;
 };
 type GetAllowedTemplatesForBulkParam = any;
 type GetBulkActionTemplateParam = any;
-type GetRefundEnableStateListParam = any;
+type GetChannelConfigParam = any;
 type GetRoleBasedActionsParam = any;
 type GetStateTransitionMapParam = any;
 import OrderPlatformModel = require("./OrderPlatformModel");