export = OrderPlatformApplicationValidator; /** * @typedef GetApplicationShipmentsParam * @property {string} [lane] - Optional parameter to specify the lane for * filtering results. * @property {string} [searchType] - Search_type refers to the field that will * be used as the target for the search operation * @property {string} [searchId] - Identifier used for the search operation * based on the selected search type. * @property {string} [fromDate] - Date time in UTC timezone as per ISO format. * @property {string} [toDate] - Date time in UTC timezone as per ISO format. * @property {string} [dpIds] - Comma-separated list of delivery partner IDs to * filter results. * @property {string} [orderingCompanyId] - ID of the company placing the order, * used for filtering results. * @property {string} [stores] - Comma-separated list of store IDs to filter results. * @property {string} [salesChannel] - The sales channel to filter results. * @property {string} [requestByExt] - Identifier for external requests. * @property {number} [pageNo] - The page number for pagination of results. * @property {number} [pageSize] - The number of results to return per page for * pagination. * @property {string} [customerId] - ID of the customer to filter results * related to specific customer. * @property {boolean} [isPrioritySort] - Flag to determine if results should be * sorted by priority. Defaults to true. * @property {boolean} [excludeLockedShipments] - Flag to exclude shipments that * are currently locked from the results. */ /** * @typedef GetOrderingSourceConfigBySlugParam * @property {string} slug */ /** * @typedef GetPlatformShipmentReasonsParam * @property {string} action */ /** * @typedef GetRulesParam * @property {OrderPlatformModel.RuleListRequestSchema} body */ /** * @typedef GetShipmentBagReasonsParam * @property {string} shipmentId - The unique identifier for the shipment * @property {number} lineNumber - A unique identifier of the bag's line number. */ /** * @typedef ListOrderingSourcesParam * @property {string} [type] * @property {number} [pageNo] * @property {number} [pageSize] */ /** * @typedef TrackShipmentPlatformParam * @property {string} shipmentId - The unique identifier for the shipment */ /** * @typedef UpdateOrderingSourceConfigBySlugParam * @property {string} slug * @property {OrderPlatformModel.OrderingSourceConfig} body */ declare class OrderPlatformApplicationValidator { /** @returns {GetApplicationShipmentsParam} */ static getApplicationShipments(): GetApplicationShipmentsParam; /** @returns {GetOrderingSourceConfigBySlugParam} */ static getOrderingSourceConfigBySlug(): GetOrderingSourceConfigBySlugParam; /** @returns {GetPlatformShipmentReasonsParam} */ static getPlatformShipmentReasons(): GetPlatformShipmentReasonsParam; /** @returns {GetRulesParam} */ static getRules(): GetRulesParam; /** @returns {GetShipmentBagReasonsParam} */ static getShipmentBagReasons(): GetShipmentBagReasonsParam; /** @returns {ListOrderingSourcesParam} */ static listOrderingSources(): ListOrderingSourcesParam; /** @returns {TrackShipmentPlatformParam} */ static trackShipmentPlatform(): TrackShipmentPlatformParam; /** @returns {UpdateOrderingSourceConfigBySlugParam} */ static updateOrderingSourceConfigBySlug(): UpdateOrderingSourceConfigBySlugParam; } declare namespace OrderPlatformApplicationValidator { export { GetApplicationShipmentsParam, GetOrderingSourceConfigBySlugParam, GetPlatformShipmentReasonsParam, GetRulesParam, GetShipmentBagReasonsParam, ListOrderingSourcesParam, TrackShipmentPlatformParam, UpdateOrderingSourceConfigBySlugParam }; } type GetApplicationShipmentsParam = { /** * - Optional parameter to specify the lane for * filtering results. */ lane?: string; /** * - Search_type refers to the field that will * be used as the target for the search operation */ searchType?: string; /** * - Identifier used for the search operation * based on the selected search type. */ searchId?: string; /** * - Date time in UTC timezone as per ISO format. */ fromDate?: string; /** * - Date time in UTC timezone as per ISO format. */ toDate?: string; /** * - Comma-separated list of delivery partner IDs to * filter results. */ dpIds?: string; /** * - ID of the company placing the order, * used for filtering results. */ orderingCompanyId?: string; /** * - Comma-separated list of store IDs to filter results. */ stores?: string; /** * - The sales channel to filter results. */ salesChannel?: string; /** * - Identifier for external requests. */ requestByExt?: string; /** * - The page number for pagination of results. */ pageNo?: number; /** * - The number of results to return per page for * pagination. */ pageSize?: number; /** * - ID of the customer to filter results * related to specific customer. */ customerId?: string; /** * - Flag to determine if results should be * sorted by priority. Defaults to true. */ isPrioritySort?: boolean; /** * - Flag to exclude shipments that * are currently locked from the results. */ excludeLockedShipments?: boolean; }; type GetOrderingSourceConfigBySlugParam = { slug: string; }; type GetPlatformShipmentReasonsParam = { action: string; }; type GetRulesParam = { body: OrderPlatformModel.RuleListRequestSchema; }; type GetShipmentBagReasonsParam = { /** * - The unique identifier for the shipment */ shipmentId: string; /** * - A unique identifier of the bag's line number. */ lineNumber: number; }; type ListOrderingSourcesParam = { type?: string; pageNo?: number; pageSize?: number; }; type TrackShipmentPlatformParam = { /** * - The unique identifier for the shipment */ shipmentId: string; }; type UpdateOrderingSourceConfigBySlugParam = { slug: string; body: OrderPlatformModel.OrderingSourceConfig; }; import OrderPlatformModel = require("./OrderPlatformModel");