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

package/sdk/platform/Order/OrderPlatformValidator.js

@@ -3,8 +3,8 @@ const Joi = require("joi");
 const OrderPlatformModel = require("./OrderPlatformModel");
 
 /**
- * @typedef AddUserViewsParam
- * @property {OrderPlatformModel.UserViewsResponse} body
+ * @typedef AddStateManagerConfigParam
+ * @property {OrderPlatformModel.TransitionConfigPayload} body
  */
 
 /**
@@ -14,18 +14,20 @@ const OrderPlatformModel = require("./OrderPlatformModel");
 
 /**
  * @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
  */
 
 /**
@@ -34,12 +36,8 @@ const OrderPlatformModel = require("./OrderPlatformModel");
  */
 
 /**
- * @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
  */
 
 /**
@@ -48,8 +46,8 @@ const OrderPlatformModel = require("./OrderPlatformModel");
  */
 
 /**
- * @typedef DeleteUserViewsParam
- * @property {string} viewId - Comma separated values of view ids
+ * @typedef DispatchManifestsParam
+ * @property {OrderPlatformModel.DispatchManifest} body
  */
 
 /**
@@ -59,7 +57,7 @@ const OrderPlatformModel = require("./OrderPlatformModel");
 
 /**
  * @typedef DownloadLanesReportParam
- * @property {OrderPlatformModel.BulkReportsDownloadRequest} body
+ * @property {OrderPlatformModel.BulkReportsDownloadRequestSchema} body
  */
 
 /**
@@ -73,8 +71,12 @@ const OrderPlatformModel = require("./OrderPlatformModel");
  */
 
 /**
- * @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
  */
 
 /**
@@ -82,6 +84,12 @@ const OrderPlatformModel = require("./OrderPlatformModel");
  * @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
@@ -89,23 +97,28 @@ const OrderPlatformModel = require("./OrderPlatformModel");
  * @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
  */
@@ -129,8 +142,8 @@ const OrderPlatformModel = require("./OrderPlatformModel");
  * @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
@@ -141,25 +154,14 @@ const OrderPlatformModel = require("./OrderPlatformModel");
  * @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.
  */
 
 /**
@@ -167,7 +169,7 @@ const OrderPlatformModel = require("./OrderPlatformModel");
  * @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
@@ -175,15 +177,54 @@ const OrderPlatformModel = require("./OrderPlatformModel");
  * @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.
  */
 
 /**
@@ -191,9 +232,27 @@ const OrderPlatformModel = require("./OrderPlatformModel");
  * @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
  */
@@ -201,99 +260,70 @@ const OrderPlatformModel = require("./OrderPlatformModel");
 /**
  * @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.
  */
 
 /**
@@ -309,58 +339,87 @@ const OrderPlatformModel = require("./OrderPlatformModel");
 /**
  * @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 */
@@ -370,11 +429,6 @@ const OrderPlatformModel = require("./OrderPlatformModel");
  * @property {string} templateName
  */
 
-/**
- * @typedef GetUserViewsParam
- * @property {string} showIn - Name of view to get filters for.
- */
-
 /**
  * @typedef GetfiltersParam
  * @property {string} view - Name of view
@@ -388,7 +442,8 @@ const OrderPlatformModel = require("./OrderPlatformModel");
 
 /**
  * @typedef JobDetailsParam
- * @property {string} batchId
+ * @property {string} batchId - A unique identifier for the batch associated
+ *   with this bulk action.
  */
 
 /**
@@ -396,18 +451,6 @@ const OrderPlatformModel = require("./OrderPlatformModel");
  * @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
@@ -430,16 +473,16 @@ const OrderPlatformModel = require("./OrderPlatformModel");
 
 /**
  * @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
  */
 
 /**
@@ -448,8 +491,8 @@ const OrderPlatformModel = require("./OrderPlatformModel");
  */
 
 /**
- * @typedef UpdateShipmentParam
- * @property {OrderPlatformModel.UpdateShipmentActionRequest} body
+ * @typedef UpdatePaymentInfoParam
+ * @property {OrderPlatformModel.UpdateShipmentPaymentMode} body
  */
 
 /**
@@ -459,7 +502,7 @@ const OrderPlatformModel = require("./OrderPlatformModel");
 
 /**
  * @typedef UpdateShipmentStatusParam
- * @property {OrderPlatformModel.UpdateShipmentStatusRequest} body
+ * @property {OrderPlatformModel.UpdateShipmentStatusRequestSchema} body
  */
 
 /**
@@ -468,13 +511,8 @@ const OrderPlatformModel = require("./OrderPlatformModel");
  */
 
 /**
- * @typedef UpdateUserViewPositionParam
- * @property {OrderPlatformModel.UserViewPosition} body
- */
-
-/**
- * @typedef UpdateUserViewsParam
- * @property {OrderPlatformModel.UserViewsResponse} body
+ * @typedef UploadConsentsParam
+ * @property {OrderPlatformModel.UploadManifestConsent} body
  */
 
 /**
@@ -483,10 +521,10 @@ const OrderPlatformModel = require("./OrderPlatformModel");
  */
 
 class OrderPlatformValidator {
-  /** @returns {AddUserViewsParam} */
-  static addUserViews() {
+  /** @returns {AddStateManagerConfigParam} */
+  static addStateManagerConfig() {
     return Joi.object({
-      body: OrderPlatformModel.UserViewsResponse().required(),
+      body: OrderPlatformModel.TransitionConfigPayload().required(),
     }).required();
   }
 
@@ -502,8 +540,8 @@ class OrderPlatformValidator {
     return Joi.object({
       pageSize: Joi.number().required(),
       pageNo: Joi.number().required(),
-      startDate: Joi.string().allow(""),
-      endDate: Joi.string().allow(""),
+      startDate: Joi.string().allow("").required(),
+      endDate: Joi.string().allow("").required(),
       status: Joi.string().allow(""),
       bulkActionType: Joi.string().allow(""),
       searchKey: Joi.string().allow(""),
@@ -513,7 +551,7 @@ class OrderPlatformValidator {
   /** @returns {BulkStateTransistionParam} */
   static bulkStateTransistion() {
     return Joi.object({
-      body: OrderPlatformModel.BulkStateTransistionRequest().required(),
+      body: OrderPlatformModel.BulkStateTransistionRequestSchema().required(),
     }).required();
   }
 
@@ -524,14 +562,10 @@ class OrderPlatformValidator {
     }).required();
   }
 
-  /** @returns {Click2CallParam} */
-  static click2Call() {
+  /** @returns {CreateChannelConfigParam} */
+  static createChannelConfig() {
     return Joi.object({
-      caller: Joi.string().allow("").required(),
-      receiver: Joi.string().allow("").required(),
-      bagId: Joi.string().allow("").required(),
-      callerId: Joi.string().allow(""),
-      method: Joi.string().allow(""),
+      body: OrderPlatformModel.CreateChannelConfigData().required(),
     }).required();
   }
 
@@ -542,10 +576,10 @@ class OrderPlatformValidator {
     }).required();
   }
 
-  /** @returns {DeleteUserViewsParam} */
-  static deleteUserViews() {
+  /** @returns {DispatchManifestsParam} */
+  static dispatchManifests() {
     return Joi.object({
-      viewId: Joi.string().allow("").required(),
+      body: OrderPlatformModel.DispatchManifest().required(),
     }).required();
   }
 
@@ -559,7 +593,7 @@ class OrderPlatformValidator {
   /** @returns {DownloadLanesReportParam} */
   static downloadLanesReport() {
     return Joi.object({
-      body: OrderPlatformModel.BulkReportsDownloadRequest().required(),
+      body: OrderPlatformModel.BulkReportsDownloadRequestSchema().required(),
     }).required();
   }
 
@@ -577,10 +611,14 @@ class OrderPlatformValidator {
     }).required();
   }
 
-  /** @returns {FetchCreditBalanceDetailParam} */
-  static fetchCreditBalanceDetail() {
+  /** @returns {FailedOrderLogsParam} */
+  static failedOrderLogs() {
     return Joi.object({
-      body: OrderPlatformModel.FetchCreditBalanceRequestPayload().required(),
+      applicationId: Joi.string().allow(""),
+      pageNo: Joi.number(),
+      pageSize: Joi.number(),
+      searchType: Joi.string().allow(""),
+      searchValue: Joi.string().allow(""),
     }).required();
   }
 
@@ -591,6 +629,14 @@ class OrderPlatformValidator {
     }).required();
   }
 
+  /** @returns {GenerateInvoiceIDParam} */
+  static generateInvoiceID() {
+    return Joi.object({
+      invoiceType: Joi.string().allow("").required(),
+      body: OrderPlatformModel.GenerateInvoiceIDRequestSchema().required(),
+    }).required();
+  }
+
   /** @returns {GeneratePOSReceiptByOrderIdParam} */
   static generatePOSReceiptByOrderId() {
     return Joi.object({
@@ -600,6 +646,13 @@ class OrderPlatformValidator {
     }).required();
   }
 
+  /** @returns {GenerateProcessManifestParam} */
+  static generateProcessManifest() {
+    return Joi.object({
+      body: OrderPlatformModel.ProcessManifestRequestSchema().required(),
+    }).required();
+  }
+
   /** @returns {GetAllowedStateTransitionParam} */
   static getAllowedStateTransition() {
     return Joi.object({
@@ -667,14 +720,9 @@ class OrderPlatformValidator {
     }).required();
   }
 
-  /** @returns {GetFailedOrderLogsParam} */
-  static getFailedOrderLogs() {
-    return Joi.object({
-      pageNo: Joi.number(),
-      pageSize: Joi.number(),
-      searchType: Joi.string().allow(""),
-      searchValue: Joi.string().allow(""),
-    }).required();
+  /** @returns {GetChannelConfigParam} */
+  static getChannelConfig() {
+    return Joi.object({}).required();
   }
 
   /** @returns {GetFileByStatusParam} */
@@ -687,13 +735,6 @@ class OrderPlatformValidator {
     }).required();
   }
 
-  /** @returns {GetGlobalFiltersParam} */
-  static getGlobalFilters() {
-    return Joi.object({
-      showIn: Joi.string().allow("").required(),
-    }).required();
-  }
-
   /** @returns {GetLaneConfigParam} */
   static getLaneConfig() {
     return Joi.object({
@@ -719,6 +760,34 @@ class OrderPlatformValidator {
     }).required();
   }
 
+  /** @returns {GetManifestDetailsParam} */
+  static getManifestDetails() {
+    return Joi.object({
+      manifestId: Joi.string().allow("").required(),
+      dpIds: Joi.string().allow(""),
+      endDate: Joi.string().allow(""),
+      startDate: Joi.string().allow(""),
+      pageNo: Joi.number(),
+      pageSize: Joi.number(),
+    }).required();
+  }
+
+  /** @returns {GetManifestShipmentsParam} */
+  static getManifestShipments() {
+    return Joi.object({
+      dpIds: Joi.string().allow("").required(),
+      stores: Joi.number().required(),
+      toDate: Joi.string().allow("").required(),
+      fromDate: Joi.string().allow("").required(),
+      dpName: Joi.string().allow(""),
+      salesChannels: Joi.string().allow(""),
+      searchType: Joi.string().allow(""),
+      searchValue: Joi.string().allow(""),
+      pageNo: Joi.number(),
+      pageSize: Joi.number(),
+    }).required();
+  }
+
   /** @returns {GetManifestfiltersParam} */
   static getManifestfilters() {
     return Joi.object({
@@ -726,6 +795,21 @@ class OrderPlatformValidator {
     }).required();
   }
 
+  /** @returns {GetManifestsParam} */
+  static getManifests() {
+    return Joi.object({
+      status: Joi.string().allow(""),
+      startDate: Joi.string().allow(""),
+      endDate: Joi.string().allow(""),
+      searchType: Joi.string().allow(""),
+      storeId: Joi.number(),
+      searchValue: Joi.string().allow(""),
+      dpIds: Joi.string().allow(""),
+      pageNo: Joi.number(),
+      pageSize: Joi.number(),
+    }).required();
+  }
+
   /** @returns {GetOrderByIdParam} */
   static getOrderById() {
     return Joi.object({
@@ -755,48 +839,15 @@ class OrderPlatformValidator {
       pageNo: Joi.number(),
       pageSize: Joi.number(),
       isPrioritySort: Joi.boolean(),
-      customMeta: Joi.array().items(Joi.any()),
+      customMeta: Joi.string().allow(""),
       myOrders: Joi.boolean(),
       showCrossCompanyData: Joi.boolean(),
       customerId: Joi.string().allow(""),
       orderType: Joi.string().allow(""),
-      operationalStatus: Joi.string().allow(""),
-      financialStatus: Joi.string().allow(""),
-      logisticsStatus: Joi.string().allow(""),
-      parentViewSlug: Joi.string().allow(""),
-      childViewSlug: Joi.string().allow(""),
+      allowInactive: Joi.boolean(),
       groupEntity: Joi.string().allow(""),
-    }).required();
-  }
-
-  /** @returns {GetRefundConfigurationParam} */
-  static getRefundConfiguration() {
-    return Joi.object({
-      appId: Joi.string().allow("").required(),
-    }).required();
-  }
-
-  /** @returns {GetRefundEnableStateListParam} */
-  static getRefundEnableStateList() {
-    return Joi.object({}).required();
-  }
-
-  /** @returns {GetRefundOptionsParam} */
-  static getRefundOptions() {
-    return Joi.object({
-      shipmentId: Joi.string().allow("").required(),
-      bagIds: Joi.string().allow(""),
-      state: Joi.string().allow(""),
-      optinAppId: Joi.string().allow(""),
-      optinCompanyId: Joi.number(),
-      status: Joi.string().allow(""),
-    }).required();
-  }
-
-  /** @returns {GetRefundStateConfigurationParam} */
-  static getRefundStateConfiguration() {
-    return Joi.object({
-      appId: Joi.string().allow("").required(),
+      enforceDateFilter: Joi.boolean(),
+      fulfillmentType: Joi.string().allow(""),
     }).required();
   }
 
@@ -811,6 +862,7 @@ class OrderPlatformValidator {
       channelShipmentId: Joi.string().allow(""),
       shipmentId: Joi.string().allow(""),
       fetchActiveShipment: Joi.boolean(),
+      allowInactive: Joi.boolean(),
     }).required();
   }
 
@@ -836,6 +888,7 @@ class OrderPlatformValidator {
     return Joi.object({
       lane: Joi.string().allow(""),
       bagStatus: Joi.string().allow(""),
+      statusAssigned: Joi.string().allow(""),
       statusOverrideLane: Joi.boolean(),
       timeToDispatch: Joi.number(),
       searchType: Joi.string().allow(""),
@@ -844,6 +897,8 @@ class OrderPlatformValidator {
       toDate: Joi.string().allow(""),
       startDate: Joi.string().allow(""),
       endDate: Joi.string().allow(""),
+      statusAssignedStartDate: Joi.string().allow(""),
+      statusAssignedEndDate: Joi.string().allow(""),
       dpIds: Joi.string().allow(""),
       stores: Joi.string().allow(""),
       salesChannels: Joi.string().allow(""),
@@ -865,13 +920,18 @@ class OrderPlatformValidator {
       tags: Joi.string().allow(""),
       customerId: Joi.string().allow(""),
       orderType: Joi.string().allow(""),
-      operationalStatus: Joi.string().allow(""),
-      financialStatus: Joi.string().allow(""),
-      logisticsStatus: Joi.string().allow(""),
-      parentViewSlug: Joi.string().allow(""),
-      childViewSlug: Joi.string().allow(""),
-      lockStatus: Joi.string().allow(""),
       groupEntity: Joi.string().allow(""),
+      enforceDateFilter: Joi.boolean(),
+      fulfillmentType: Joi.string().allow(""),
+    }).required();
+  }
+
+  /** @returns {GetStateManagerConfigParam} */
+  static getStateManagerConfig() {
+    return Joi.object({
+      appId: Joi.string().allow(""),
+      orderingChannel: Joi.string().allow(""),
+      entity: Joi.string().allow(""),
     }).required();
   }
 
@@ -887,13 +947,6 @@ class OrderPlatformValidator {
     }).required();
   }
 
-  /** @returns {GetUserViewsParam} */
-  static getUserViews() {
-    return Joi.object({
-      showIn: Joi.string().allow("").required(),
-    }).required();
-  }
-
   /** @returns {GetfiltersParam} */
   static getfilters() {
     return Joi.object({
@@ -923,22 +976,6 @@ class OrderPlatformValidator {
     }).required();
   }
 
-  /** @returns {PostRefundConfigurationParam} */
-  static postRefundConfiguration() {
-    return Joi.object({
-      appId: Joi.string().allow("").required(),
-      body: OrderPlatformModel.RefundStateConfigurationManualSchema().required(),
-    }).required();
-  }
-
-  /** @returns {PostRefundStateConfigurationParam} */
-  static postRefundStateConfiguration() {
-    return Joi.object({
-      appId: Joi.string().allow("").required(),
-      body: OrderPlatformModel.PostRefundStateConfiguration().required(),
-    }).required();
-  }
-
   /** @returns {PostShipmentHistoryParam} */
   static postShipmentHistory() {
     return Joi.object({
@@ -977,11 +1014,11 @@ class OrderPlatformValidator {
     }).required();
   }
 
-  /** @returns {UpdateOrderParam} */
-  static updateOrder() {
+  /** @returns {UpdateAddressParam} */
+  static updateAddress() {
     return Joi.object({
-      orderId: Joi.string().allow("").required(),
-      body: OrderPlatformModel.OrderUpdatePayload().required(),
+      shipmentId: Joi.string().allow("").required(),
+      body: OrderPlatformModel.UpdateAddressRequestBody().required(),
     }).required();
   }
 
@@ -992,10 +1029,10 @@ class OrderPlatformValidator {
     }).required();
   }
 
-  /** @returns {UpdateShipmentParam} */
-  static updateShipment() {
+  /** @returns {UpdatePaymentInfoParam} */
+  static updatePaymentInfo() {
     return Joi.object({
-      body: OrderPlatformModel.UpdateShipmentActionRequest().required(),
+      body: OrderPlatformModel.UpdateShipmentPaymentMode().required(),
     }).required();
   }
 
@@ -1009,7 +1046,7 @@ class OrderPlatformValidator {
   /** @returns {UpdateShipmentStatusParam} */
   static updateShipmentStatus() {
     return Joi.object({
-      body: OrderPlatformModel.UpdateShipmentStatusRequest().required(),
+      body: OrderPlatformModel.UpdateShipmentStatusRequestSchema().required(),
     }).required();
   }
 
@@ -1020,17 +1057,10 @@ class OrderPlatformValidator {
     }).required();
   }
 
-  /** @returns {UpdateUserViewPositionParam} */
-  static updateUserViewPosition() {
-    return Joi.object({
-      body: OrderPlatformModel.UserViewPosition().required(),
-    }).required();
-  }
-
-  /** @returns {UpdateUserViewsParam} */
-  static updateUserViews() {
+  /** @returns {UploadConsentsParam} */
+  static uploadConsents() {
     return Joi.object({
-      body: OrderPlatformModel.UserViewsResponse().required(),
+      body: OrderPlatformModel.UploadManifestConsent().required(),
     }).required();
   }