@gofynd/fdk-client-javascript 1.4.2-beta.4 → 1.4.2-beta.6

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

@@ -8,8 +8,8 @@ declare class Order {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<OrderPlatformModel.AttachOrderUserResponse>} - Success response
      * @name attachOrderUser
-     * @summary:
-     * @description: Attach Order User - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/attachOrderUser/).
+     * @summary: Attach order user.
+     * @description: Attach order User - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/attachOrderUser/).
      */
     attachOrderUser({ body, requestHeaders }?: OrderPlatformValidator.AttachOrderUserParam, { responseHeaders }?: object): Promise<OrderPlatformModel.AttachOrderUserResponse>;
     /**
@@ -40,8 +40,8 @@ declare class Order {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<OrderPlatformModel.OrderStatusResult>} - Success response
      * @name checkOrderStatus
-     * @summary:
-     * @description: Check order status - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/checkOrderStatus/).
+     * @summary: Check order status.
+     * @description: Verify the current status of an order. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/checkOrderStatus/).
      */
     checkOrderStatus({ body, requestHeaders }?: OrderPlatformValidator.CheckOrderStatusParam, { responseHeaders }?: object): Promise<OrderPlatformModel.OrderStatusResult>;
     /**
@@ -50,8 +50,8 @@ declare class Order {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<OrderPlatformModel.Click2CallResponse>} - Success response
      * @name click2Call
-     * @summary:
-     * @description: Click to Call - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/click2Call/).
+     * @summary: Click to call.
+     * @description: Click to call.  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/click2Call/).
      */
     click2Call({ caller, receiver, bagId, callerId, method, requestHeaders }?: OrderPlatformValidator.Click2CallParam, { responseHeaders }?: object): Promise<OrderPlatformModel.Click2CallResponse>;
     /**
@@ -61,8 +61,8 @@ declare class Order {
      * @returns {Promise<OrderPlatformModel.CreateChannelConfigResponse>} -
      *   Success response
      * @name createChannelConfig
-     * @summary:
-     * @description: createChannelConfig - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/createChannelConfig/).
+     * @summary: Create channel configuration.
+     * @description: Set up configuration for a channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/createChannelConfig/).
      */
     createChannelConfig({ body, requestHeaders }?: OrderPlatformValidator.CreateChannelConfigParam, { responseHeaders }?: object): Promise<OrderPlatformModel.CreateChannelConfigResponse>;
     /**
@@ -71,8 +71,8 @@ declare class Order {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<OrderPlatformModel.CreateOrderResponse>} - Success response
      * @name createOrder
-     * @summary:
-     * @description: Create Order - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/createOrder/).
+     * @summary: Create order.
+     * @description: Create order. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/createOrder/).
      */
     createOrder({ body, requestHeaders }?: OrderPlatformValidator.CreateOrderParam, { responseHeaders }?: object): Promise<OrderPlatformModel.CreateOrderResponse>;
     /**
@@ -91,7 +91,7 @@ declare class Order {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<OrderPlatformModel.FileResponse>} - Success response
      * @name downloadBulkActionTemplate
-     * @summary:
+     * @summary: Download bulk action template.
      * @description: Download bulk actions seller templates. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/downloadBulkActionTemplate/).
      */
     downloadBulkActionTemplate({ templateSlug, requestHeaders }?: OrderPlatformValidator.DownloadBulkActionTemplateParam, { responseHeaders }?: object): Promise<OrderPlatformModel.FileResponse>;
@@ -102,8 +102,8 @@ declare class Order {
      * @returns {Promise<OrderPlatformModel.BulkReportsDownloadResponse>} -
      *   Success response
      * @name downloadLanesReport
-     * @summary:
-     * @description: downloads lanes shipment/orders. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/downloadLanesReport/).
+     * @summary: Download lanes report.
+     * @description: Downloads lanes shipment/orders. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/downloadLanesReport/).
      */
     downloadLanesReport({ body, requestHeaders }?: OrderPlatformValidator.DownloadLanesReportParam, { responseHeaders }?: object): Promise<OrderPlatformModel.BulkReportsDownloadResponse>;
     /**
@@ -112,7 +112,7 @@ declare class Order {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<OrderPlatformModel.EInvoiceRetryResponse>} - Success response
      * @name eInvoiceRetry
-     * @summary:
+     * @summary: E-invoice retry.
      * @description: Retry e-invoice after failure - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/eInvoiceRetry/).
      */
     eInvoiceRetry({ body, requestHeaders }?: OrderPlatformValidator.EInvoiceRetryParam, { responseHeaders }?: object): Promise<OrderPlatformModel.EInvoiceRetryResponse>;
@@ -134,8 +134,8 @@ declare class Order {
      *   - Success response
      *
      * @name fetchCreditBalanceDetail
-     * @summary:
-     * @description: Fetch Credit Balance Detail - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/fetchCreditBalanceDetail/).
+     * @summary: Fetch credit balance detail.
+     * @description: Retrieve details about credit balance. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/fetchCreditBalanceDetail/).
      */
     fetchCreditBalanceDetail({ body, requestHeaders }?: OrderPlatformValidator.FetchCreditBalanceDetailParam, { responseHeaders }?: object): Promise<OrderPlatformModel.FetchCreditBalanceResponsePayload>;
     /**
@@ -145,8 +145,8 @@ declare class Order {
      * @returns {Promise<OrderPlatformModel.RefundModeConfigResponsePayload>} -
      *   Success response
      * @name fetchRefundModeConfig
-     * @summary:
-     * @description: Fetch Refund Mode Config - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/fetchRefundModeConfig/).
+     * @summary: Fetch refund mode config.
+     * @description: Retrieve configuration for refund modes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/fetchRefundModeConfig/).
      */
     fetchRefundModeConfig({ body, requestHeaders }?: OrderPlatformValidator.FetchRefundModeConfigParam, { responseHeaders }?: object): Promise<OrderPlatformModel.RefundModeConfigResponsePayload>;
     /**
@@ -166,8 +166,8 @@ declare class Order {
      * @returns {Promise<OrderPlatformModel.GeneratePosOrderReceiptResponse>} -
      *   Success response
      * @name generatePOSReceiptByOrderId
-     * @summary:
-     * @description: Generate POS recipt by order id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/generatePOSReceiptByOrderId/).
+     * @summary: Generate POS receipt by order ID.
+     * @description: Create a point-of-sale (POS) receipt for a specific order by order ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/generatePOSReceiptByOrderId/).
      */
     generatePOSReceiptByOrderId({ orderId, shipmentId, documentType, requestHeaders }?: OrderPlatformValidator.GeneratePOSReceiptByOrderIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.GeneratePosOrderReceiptResponse>;
     /**
@@ -177,9 +177,8 @@ declare class Order {
      * @returns {Promise<OrderPlatformModel.RoleBaseStateTransitionMapping>} -
      *   Success response
      * @name getAllowedStateTransition
-     * @summary: To fetch next state transitions.
-     * @description: This endpoint will fetch next possible states based on logged in user
-     *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getAllowedStateTransition/).
+     * @summary: Get allowed state transition.
+     * @description: Retrieve next possible states based on logged in user. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getAllowedStateTransition/).
      */
     getAllowedStateTransition({ orderingChannel, status, requestHeaders }?: OrderPlatformValidator.GetAllowedStateTransitionParam, { responseHeaders }?: object): Promise<OrderPlatformModel.RoleBaseStateTransitionMapping>;
     /**
@@ -198,8 +197,8 @@ declare class Order {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<OrderPlatformModel.AnnouncementsResponse>} - Success response
      * @name getAnnouncements
-     * @summary:
-     * @description: Get Announcements - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getAnnouncements/).
+     * @summary: Get announcements.
+     * @description: Retrieve announcements related to orders or shipments. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getAnnouncements/).
      */
     getAnnouncements({ date, requestHeaders }?: OrderPlatformValidator.GetAnnouncementsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.AnnouncementsResponse>;
     /**
@@ -209,8 +208,8 @@ declare class Order {
      * @returns {Promise<OrderPlatformModel.BagDetailsPlatformResponse>} -
      *   Success response
      * @name getBagById
-     * @summary:
-     * @description: Get Order Bag Details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getBagById/).
+     * @summary: Get bag by ID.
+     * @description: Retrieve detailed information about a specific bag. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getBagById/).
      */
     getBagById({ bagId, channelBagId, channelId, requestHeaders }?: OrderPlatformValidator.GetBagByIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.BagDetailsPlatformResponse>;
     /**
@@ -219,8 +218,8 @@ declare class Order {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<OrderPlatformModel.GetBagsPlatformResponse>} - Success response
      * @name getBags
-     * @summary:
-     * @description: Get Bags for the order - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getBags/).
+     * @summary: Get bags.
+     * @description: Retrieve Bags for the order. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getBags/).
      */
     getBags({ bagIds, shipmentIds, orderIds, channelBagIds, channelShipmentIds, channelOrderIds, channelId, pageNo, pageSize, requestHeaders, }?: OrderPlatformValidator.GetBagsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.GetBagsPlatformResponse>;
     /**
@@ -230,8 +229,8 @@ declare class Order {
      * @returns {Promise<OrderPlatformModel.BulkActionTemplateResponse>} -
      *   Success response
      * @name getBulkActionTemplate
-     * @summary:
-     * @description: Get Bulk Action seller templates. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getBulkActionTemplate/).
+     * @summary: Get bulk action template.
+     * @description: Retrieve bulk action seller templates. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getBulkActionTemplate/).
      */
     getBulkActionTemplate({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.BulkActionTemplateResponse>;
     /**
@@ -240,8 +239,8 @@ declare class Order {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<OrderPlatformModel.FileResponse>} - Success response
      * @name getBulkShipmentExcelFile
-     * @summary:
-     * @description: Generate Bulk Shipment Excel Report. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getBulkShipmentExcelFile/).
+     * @summary: Get bulk shipment Excel file.
+     * @description: Retrieve a bulk shipment Excel report. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getBulkShipmentExcelFile/).
      */
     getBulkShipmentExcelFile({ salesChannels, dpIds, startDate, endDate, stores, tags, bagStatus, paymentMethods, fileType, timeToDispatch, pageNo, pageSize, requestHeaders, }?: OrderPlatformValidator.GetBulkShipmentExcelFileParam, { responseHeaders }?: object): Promise<OrderPlatformModel.FileResponse>;
     /**
@@ -250,8 +249,8 @@ declare class Order {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<OrderPlatformModel.CreateChannelConfigData>} - Success response
      * @name getChannelConfig
-     * @summary:
-     * @description: getChannelConfig - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getChannelConfig/).
+     * @summary: Get channel configuration.
+     * @description: Retrieve configuration settings for a channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getChannelConfig/).
      */
     getChannelConfig({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.CreateChannelConfigData>;
     /**
@@ -270,8 +269,8 @@ declare class Order {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<OrderPlatformModel.LaneConfigResponse>} - Success response
      * @name getLaneConfig
-     * @summary:
-     * @description: Get lane config for the order - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getLaneConfig/).
+     * @summary: Get lane configuration.
+     * @description: Retrieve configuration settings for lanes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getLaneConfig/).
      */
     getLaneConfig({ superLane, groupEntity, fromDate, toDate, startDate, endDate, dpIds, stores, salesChannels, paymentMode, bagStatus, searchType, searchValue, tags, timeToDispatch, paymentMethods, myOrders, showCrossCompanyData, orderType, requestHeaders, }?: OrderPlatformValidator.GetLaneConfigParam, { responseHeaders }?: object): Promise<OrderPlatformModel.LaneConfigResponse>;
     /**
@@ -320,8 +319,8 @@ declare class Order {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<OrderPlatformModel.OrderDetailsResponse>} - Success response
      * @name getOrderById
-     * @summary:
-     * @description: Get Order Details by ID - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getOrderById/).
+     * @summary: Get order by ID.
+     * @description: Retrieve detailed information about a specific order. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getOrderById/).
      */
     getOrderById({ orderId, myOrders, allowInactive, requestHeaders }?: OrderPlatformValidator.GetOrderByIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.OrderDetailsResponse>;
     /**
@@ -330,75 +329,18 @@ declare class Order {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<OrderPlatformModel.OrderListingResponse>} - Success response
      * @name getOrders
-     * @summary:
-     * @description: Get Orders Listing - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getOrders/).
+     * @summary: Get orders.
+     * @description: Retrieve a list of available orders. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getOrders/).
      */
     getOrders({ lane, searchType, bagStatus, timeToDispatch, paymentMethods, tags, searchValue, fromDate, toDate, startDate, endDate, dpIds, stores, salesChannels, pageNo, pageSize, isPrioritySort, customMeta, myOrders, showCrossCompanyData, customerId, orderType, requestHeaders, }?: OrderPlatformValidator.GetOrdersParam, { responseHeaders }?: object): Promise<OrderPlatformModel.OrderListingResponse>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {string} [arg.lane] - Lane refers to a section where orders are
-     *   assigned, indicating its grouping
-     * @param {string} [arg.searchType] - Search_type refers to the field that
-     *   will be used as the target for the search operation
-     * @param {string} [arg.bagStatus] - Bag_status refers to status of the
-     *   entity. Filters orders based on the status.
-     * @param {number} [arg.timeToDispatch] - Time_to_dispatch refers to
-     *   estimated SLA time.
-     * @param {string} [arg.paymentMethods] -
-     * @param {string} [arg.tags] - Tags refers to additional descriptive labels
-     *   associated with the order
-     * @param {string} [arg.searchValue] - Search_value is matched against the
-     *   field specified by the search_type
-     * @param {string} [arg.fromDate] -
-     * @param {string} [arg.toDate] -
-     * @param {string} [arg.startDate] -
-     * @param {string} [arg.endDate] -
-     * @param {string} [arg.dpIds] - Delivery Partner IDs to which shipments are assigned.
-     * @param {string} [arg.stores] -
-     * @param {string} [arg.salesChannels] -
-     * @param {number} [arg.pageSize] -
-     * @param {boolean} [arg.isPrioritySort] -
-     * @param {string} [arg.customMeta] -
-     * @param {boolean} [arg.myOrders] -
-     * @param {boolean} [arg.showCrossCompanyData] - Flag to view cross &
-     *   non-cross company order
-     * @param {string} [arg.customerId] -
-     * @param {string} [arg.orderType] -
-     * @returns {Paginator<OrderPlatformModel.OrderListingResponse>}
-     * @summary:
-     * @description: Get Orders Listing
-     */
-    getOrdersPaginator({ lane, searchType, bagStatus, timeToDispatch, paymentMethods, tags, searchValue, fromDate, toDate, startDate, endDate, dpIds, stores, salesChannels, pageSize, isPrioritySort, customMeta, myOrders, showCrossCompanyData, customerId, orderType, }?: {
-        lane?: string;
-        searchType?: string;
-        bagStatus?: string;
-        timeToDispatch?: number;
-        paymentMethods?: string;
-        tags?: string;
-        searchValue?: string;
-        fromDate?: string;
-        toDate?: string;
-        startDate?: string;
-        endDate?: string;
-        dpIds?: string;
-        stores?: string;
-        salesChannels?: string;
-        pageSize?: number;
-        isPrioritySort?: boolean;
-        customMeta?: string;
-        myOrders?: boolean;
-        showCrossCompanyData?: boolean;
-        customerId?: string;
-        orderType?: string;
-    }): Paginator<OrderPlatformModel.OrderListingResponse>;
     /**
      * @param {OrderPlatformValidator.GetRoleBasedActionsParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<OrderPlatformModel.GetActionsResponse>} - Success response
      * @name getRoleBasedActions
-     * @summary:
-     * @description: Get Role Based Actions - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getRoleBasedActions/).
+     * @summary: Get role-based actions.
+     * @description: Retrieve role based actions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getRoleBasedActions/).
      */
     getRoleBasedActions({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.GetActionsResponse>;
     /**
@@ -407,8 +349,8 @@ declare class Order {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<OrderPlatformModel.ShipmentInfoResponse>} - Success response
      * @name getShipmentById
-     * @summary:
-     * @description: Get shipment details for the given shipment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipmentById/).
+     * @summary: Get shipment by ID.
+     * @description: Retrieve detailed information about a specific shipment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipmentById/).
      */
     getShipmentById({ channelShipmentId, shipmentId, fetchActiveShipment, requestHeaders }?: OrderPlatformValidator.GetShipmentByIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentInfoResponse>;
     /**
@@ -417,8 +359,8 @@ declare class Order {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<OrderPlatformModel.ShipmentHistoryResponse>} - Success response
      * @name getShipmentHistory
-     * @summary:
-     * @description: Get Shipment History - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipmentHistory/).
+     * @summary: Get shipment history.
+     * @description: Retrieve the shipment history. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipmentHistory/).
      */
     getShipmentHistory({ shipmentId, bagId, requestHeaders }?: OrderPlatformValidator.GetShipmentHistoryParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentHistoryResponse>;
     /**
@@ -428,8 +370,8 @@ declare class Order {
      * @returns {Promise<OrderPlatformModel.PlatformShipmentReasonsResponse>} -
      *   Success response
      * @name getShipmentReasons
-     * @summary: Get reasons behind full or partial cancellation of a shipment
-     * @description: Use this API to retrieve the issues that led to the cancellation of bags within a shipment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipmentReasons/).
+     * @summary: Get shipment reasons.
+     * @description: Retrieve the issues that led to the cancellation of bags within a shipment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipmentReasons/).
      */
     getShipmentReasons({ shipmentId, bagId, state, requestHeaders }?: OrderPlatformValidator.GetShipmentReasonsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.PlatformShipmentReasonsResponse>;
     /**
@@ -440,88 +382,18 @@ declare class Order {
      *   - Success response
      *
      * @name getShipments
-     * @summary:
-     * @description: Get Shipments Listing for the company id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipments/).
+     * @summary: Get shipments.
+     * @description: Retrieve a list of available shipments. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipments/).
      */
     getShipments({ lane, bagStatus, statusOverrideLane, timeToDispatch, searchType, searchValue, fromDate, toDate, startDate, endDate, dpIds, stores, salesChannels, pageNo, pageSize, fetchActiveShipment, allowInactive, excludeLockedShipments, paymentMethods, channelShipmentId, channelOrderId, customMeta, orderingChannel, companyAffiliateTag, myOrders, platformUserId, sortType, showCrossCompanyData, tags, customerId, orderType, requestHeaders, }?: OrderPlatformValidator.GetShipmentsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentInternalPlatformViewResponse>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {string} [arg.lane] - Name of lane for which data is to be fetched
-     * @param {string} [arg.bagStatus] - Comma separated values of bag statuses
-     * @param {boolean} [arg.statusOverrideLane] - Use this flag to fetch by
-     *   bag_status and override lane
-     * @param {number} [arg.timeToDispatch] -
-     * @param {string} [arg.searchType] - Search type key
-     * @param {string} [arg.searchValue] - Search type value
-     * @param {string} [arg.fromDate] - Start Date in DD-MM-YYYY format
-     * @param {string} [arg.toDate] - End Date in DD-MM-YYYY format
-     * @param {string} [arg.startDate] - UTC Start Date in ISO format
-     * @param {string} [arg.endDate] - UTC End Date in ISO format
-     * @param {string} [arg.dpIds] - Comma separated values of delivery partner ids
-     * @param {string} [arg.stores] - Comma separated values of store ids
-     * @param {string} [arg.salesChannels] - Comma separated values of sales channel ids
-     * @param {number} [arg.pageSize] - Page size of data received per page
-     * @param {boolean} [arg.fetchActiveShipment] - Flag to fetch active shipments
-     * @param {boolean} [arg.allowInactive] - Flag to allow inactive shipments
-     * @param {boolean} [arg.excludeLockedShipments] - Flag to fetch locked shipments
-     * @param {string} [arg.paymentMethods] - Comma separated values of payment methods
-     * @param {string} [arg.channelShipmentId] - App Shipment Id
-     * @param {string} [arg.channelOrderId] - App Order Id
-     * @param {string} [arg.customMeta] -
-     * @param {string} [arg.orderingChannel] -
-     * @param {string} [arg.companyAffiliateTag] -
-     * @param {boolean} [arg.myOrders] -
-     * @param {string} [arg.platformUserId] -
-     * @param {string} [arg.sortType] - Sort the result data on basis of input
-     * @param {boolean} [arg.showCrossCompanyData] - Flag to view cross &
-     *   non-cross company order
-     * @param {string} [arg.tags] - Comma separated values of tags
-     * @param {string} [arg.customerId] -
-     * @param {string} [arg.orderType] -
-     * @returns {Paginator<OrderPlatformModel.ShipmentInternalPlatformViewResponse>}
-     * @summary:
-     * @description: Get Shipments Listing for the company id
-     */
-    getShipmentsPaginator({ lane, bagStatus, statusOverrideLane, timeToDispatch, searchType, searchValue, fromDate, toDate, startDate, endDate, dpIds, stores, salesChannels, pageSize, fetchActiveShipment, allowInactive, excludeLockedShipments, paymentMethods, channelShipmentId, channelOrderId, customMeta, orderingChannel, companyAffiliateTag, myOrders, platformUserId, sortType, showCrossCompanyData, tags, customerId, orderType, }?: {
-        lane?: string;
-        bagStatus?: string;
-        statusOverrideLane?: boolean;
-        timeToDispatch?: number;
-        searchType?: string;
-        searchValue?: string;
-        fromDate?: string;
-        toDate?: string;
-        startDate?: string;
-        endDate?: string;
-        dpIds?: string;
-        stores?: string;
-        salesChannels?: string;
-        pageSize?: number;
-        fetchActiveShipment?: boolean;
-        allowInactive?: boolean;
-        excludeLockedShipments?: boolean;
-        paymentMethods?: string;
-        channelShipmentId?: string;
-        channelOrderId?: string;
-        customMeta?: string;
-        orderingChannel?: string;
-        companyAffiliateTag?: string;
-        myOrders?: boolean;
-        platformUserId?: string;
-        sortType?: string;
-        showCrossCompanyData?: boolean;
-        tags?: string;
-        customerId?: string;
-        orderType?: string;
-    }): Paginator<OrderPlatformModel.ShipmentInternalPlatformViewResponse>;
     /**
      * @param {OrderPlatformValidator.GetStateTransitionMapParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<OrderPlatformModel.BagStateTransitionMap>} - Success response
      * @name getStateTransitionMap
-     * @summary:
-     * @description: Get State Transition Map - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getStateTransitionMap/).
+     * @summary: Get state transition map.
+     * @description: Retrieve a map of state transitions for orders. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getStateTransitionMap/).
      */
     getStateTransitionMap({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.BagStateTransitionMap>;
     /**
@@ -540,8 +412,8 @@ declare class Order {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<OrderPlatformModel.FiltersResponse>} - Success response
      * @name getfilters
-     * @summary:
-     * @description: Get Listing Filters - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getfilters/).
+     * @summary: Get filters.
+     * @description: Retrieve listing filters. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getfilters/).
      */
     getfilters({ view, groupEntity, requestHeaders }?: OrderPlatformValidator.GetfiltersParam, { responseHeaders }?: object): Promise<OrderPlatformModel.FiltersResponse>;
     /**
@@ -551,8 +423,8 @@ declare class Order {
      * @returns {Promise<OrderPlatformModel.InvalidateShipmentCacheResponse>} -
      *   Success response
      * @name invalidateShipmentCache
-     * @summary:
-     * @description: Invalidate shipment Cache - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/invalidateShipmentCache/).
+     * @summary: Invalidate shipment cache.
+     * @description: Invalidate shipment Cache. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/invalidateShipmentCache/).
      */
     invalidateShipmentCache({ body, requestHeaders }?: OrderPlatformValidator.InvalidateShipmentCacheParam, { responseHeaders }?: object): Promise<OrderPlatformModel.InvalidateShipmentCacheResponse>;
     /**
@@ -571,8 +443,8 @@ declare class Order {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<OrderPlatformModel.ResponseDetail>} - Success response
      * @name orderUpdate
-     * @summary:
-     * @description: Update Order - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/orderUpdate/).
+     * @summary: Order update.
+     * @description: Modify the details and status of an order.  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/orderUpdate/).
      */
     orderUpdate({ body, requestHeaders }?: OrderPlatformValidator.OrderUpdateParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ResponseDetail>;
     /**
@@ -581,8 +453,8 @@ declare class Order {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<OrderPlatformModel.ShipmentHistoryResponse>} - Success response
      * @name postShipmentHistory
-     * @summary:
-     * @description: Post shipment history - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/postShipmentHistory/).
+     * @summary: Post shipment history.
+     * @description: Add history records for a shipment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/postShipmentHistory/).
      */
     postShipmentHistory({ body, requestHeaders }?: OrderPlatformValidator.PostShipmentHistoryParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentHistoryResponse>;
     /**
@@ -602,8 +474,8 @@ declare class Order {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<OrderPlatformModel.StoreReassignResponse>} - Success response
      * @name reassignLocation
-     * @summary:
-     * @description: Reassign Location - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/reassignLocation/).
+     * @summary: Reassign location.
+     * @description: Change the assigned location for an order or shipment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/reassignLocation/).
      */
     reassignLocation({ body, requestHeaders }?: OrderPlatformValidator.ReassignLocationParam, { responseHeaders }?: object): Promise<OrderPlatformModel.StoreReassignResponse>;
     /**
@@ -612,8 +484,8 @@ declare class Order {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<OrderPlatformModel.OrderStatusResult>} - Success response
      * @name sendSmsNinja
-     * @summary:
-     * @description: Send SMS Ninja Panel - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/sendSmsNinja/).
+     * @summary: Send SMS via Ninja.
+     * @description: Send SMS Ninja Panel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/sendSmsNinja/).
      */
     sendSmsNinja({ body, requestHeaders }?: OrderPlatformValidator.SendSmsNinjaParam, { responseHeaders }?: object): Promise<OrderPlatformModel.OrderStatusResult>;
     /**
@@ -622,8 +494,8 @@ declare class Order {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<OrderPlatformModel.SendUserMobileOtpResponse>} - Success response
      * @name sendUserMobileOTP
-     * @summary:
-     * @description: Send User Mobile OTP - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/sendUserMobileOTP/).
+     * @summary: Send user mobile OTP.
+     * @description: Send a one-time OTP to a users mobile device. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/sendUserMobileOTP/).
      */
     sendUserMobileOTP({ body, requestHeaders }?: OrderPlatformValidator.SendUserMobileOTPParam, { responseHeaders }?: object): Promise<OrderPlatformModel.SendUserMobileOtpResponse>;
     /**
@@ -633,8 +505,8 @@ declare class Order {
      * @returns {Promise<OrderPlatformModel.CourierPartnerTrackingResponse>} -
      *   Success response
      * @name trackShipment
-     * @summary:
-     * @description: This endpoint allows users to get courier partner tracking details for a given shipment id or awb no. The service will fetch courier partner statuses that are pushed to oms. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/trackShipment/).
+     * @summary: Track shipment.
+     * @description: Retrieve courier partner tracking details for a given shipment id or awb no. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/trackShipment/).
      */
     trackShipment({ shipmentId, awb, pageNo, pageSize, requestHeaders }?: OrderPlatformValidator.TrackShipmentParam, { responseHeaders }?: object): Promise<OrderPlatformModel.CourierPartnerTrackingResponse>;
     /**
@@ -643,8 +515,8 @@ declare class Order {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<OrderPlatformModel.BaseResponse>} - Success response
      * @name updateAddress
-     * @summary:
-     * @description: Update Address for the order - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updateAddress/).
+     * @summary: Update address.
+     * @description: Modify the shipping address for an order. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updateAddress/).
      */
     updateAddress({ shipmentId, addressCategory, name, address, addressType, pincode, phone, email, landmark, city, state, country, requestHeaders, }?: OrderPlatformValidator.UpdateAddressParam, { responseHeaders }?: object): Promise<OrderPlatformModel.BaseResponse>;
     /**
@@ -655,8 +527,8 @@ declare class Order {
      *   - Success response
      *
      * @name updatePackagingDimensions
-     * @summary:
-     * @description: Update Packaging Dimensions - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updatePackagingDimensions/).
+     * @summary: Update packaging dimensions.
+     * @description: Modify the dimensions of packaging. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updatePackagingDimensions/).
      */
     updatePackagingDimensions({ body, requestHeaders }?: OrderPlatformValidator.UpdatePackagingDimensionsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.UpdatePackagingDimensionsResponse>;
     /**
@@ -666,8 +538,8 @@ declare class Order {
      * @returns {Promise<OrderPlatformModel.UpdateShipmentLockResponse>} -
      *   Success response
      * @name updateShipmentLock
-     * @summary:
-     * @description: update shipment/bag lock and check status - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updateShipmentLock/).
+     * @summary: Update shipment lock.
+     * @description: Modify shipment/bag lock and check status. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updateShipmentLock/).
      */
     updateShipmentLock({ body, requestHeaders }?: OrderPlatformValidator.UpdateShipmentLockParam, { responseHeaders }?: object): Promise<OrderPlatformModel.UpdateShipmentLockResponse>;
     /**
@@ -678,8 +550,8 @@ declare class Order {
      *   - Success response
      *
      * @name updateShipmentStatus
-     * @summary:
-     * @description: This API is for Shipment State transition or Shipment data update or both below example is for partial state transition with data update - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updateShipmentStatus/).
+     * @summary: Update shipment status.
+     * @description: Shipment state transition or Shipment data update or both. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updateShipmentStatus/).
      */
     updateShipmentStatus({ body, requestHeaders }?: OrderPlatformValidator.UpdateShipmentStatusParam, { responseHeaders }?: object): Promise<OrderPlatformModel.UpdateShipmentStatusResponseBody>;
     /**
@@ -689,8 +561,8 @@ declare class Order {
      * @returns {Promise<OrderPlatformModel.CourierPartnerTrackingDetails>} -
      *   Success response
      * @name updateShipmentTracking
-     * @summary: Post courier partner tracking details
-     * @description: This endpoint allows users to post courier partner tracking details for a given shipment id or awb no. The service will add entry for courier partner statuses and will be saved to oms. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updateShipmentTracking/).
+     * @summary: Update shipment tracking.
+     * @description: Modify courier partner tracking details for a given shipment id or awb no. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updateShipmentTracking/).
      */
     updateShipmentTracking({ body, requestHeaders }?: OrderPlatformValidator.UpdateShipmentTrackingParam, { responseHeaders }?: object): Promise<OrderPlatformModel.CourierPartnerTrackingDetails>;
     /**
@@ -709,11 +581,10 @@ declare class Order {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<OrderPlatformModel.VerifyOtpResponse>} - Success response
      * @name verifyMobileOTP
-     * @summary:
+     * @summary: Verify mobile OTP.
      * @description: Verify Mobile OTP - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/verifyMobileOTP/).
      */
     verifyMobileOTP({ body, requestHeaders }?: OrderPlatformValidator.VerifyMobileOTPParam, { responseHeaders }?: object): Promise<OrderPlatformModel.VerifyOtpResponse>;
 }
 import OrderPlatformValidator = require("./OrderPlatformValidator");
 import OrderPlatformModel = require("./OrderPlatformModel");
-import Paginator = require("../../common/Paginator");