@gofynd/fdk-client-javascript 1.0.1 → 1.0.3

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

@@ -4,210 +4,178 @@ declare class Order {
     config: any;
     /**
      * @param {Object} arg - Arg object.
-     * @param {string} [arg.lane] -
-     * @param {string} [arg.searchType] -
-     * @param {string} [arg.searchValue] -
-     * @param {string} [arg.searchId] -
-     * @param {string} [arg.fromDate] -
-     * @param {string} [arg.toDate] -
-     * @param {string} [arg.dpIds] -
-     * @param {string} [arg.orderingCompanyId] -
-     * @param {string} [arg.stores] -
-     * @param {string} [arg.salesChannel] -
-     * @param {string} [arg.requestByExt] -
-     * @param {number} [arg.pageNo] -
-     * @param {number} [arg.pageSize] -
-     * @param {boolean} [arg.isPrioritySort] -
-     * @param {boolean} [arg.excludeLockedShipments] -
-     * @param {string} [arg.paymentMethods] -
-     * @param {string} [arg.channelShipmentId] -
-     * @param {string} [arg.channelOrderId] -
-     * @param {string} [arg.customMeta] -
+     * @param {string} arg.batchId -
+     * @returns {Promise<BulkActionDetailsResponse>} - Success response
+     * @summary: Returns failed, processing and successfully processed shipments.
+     * @description: Returns failed, processing and successfully processed shipments along with their counts and failed reasons.
+     */
+    bulkActionDetails({ batchId }?: {
+        batchId: string;
+    }): Promise<BulkActionDetailsResponse>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {BulkActionPayload} arg.body
+     * @returns {Promise<BulkActionResponse>} - Success response
+     * @summary: emits uuid to kafka topic.
+     * @description: Use this API to start processing Xlsx file.
+     */
+    bulkActionProcessXlsxFile({ body }?: {
+        body: BulkActionPayload;
+    }): Promise<BulkActionResponse>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {OrderStatus} arg.body
+     * @returns {Promise<OrderStatusResult>} - Success response
      * @summary:
      * @description:
      */
-    getShipments({ lane, searchType, searchValue, searchId, fromDate, toDate, dpIds, orderingCompanyId, stores, salesChannel, requestByExt, pageNo, pageSize, isPrioritySort, excludeLockedShipments, paymentMethods, channelShipmentId, channelOrderId, customMeta, }?: {
-        lane?: string;
-        searchType?: string;
-        searchValue?: string;
-        searchId?: string;
-        fromDate?: string;
-        toDate?: string;
-        dpIds?: string;
-        orderingCompanyId?: string;
-        stores?: string;
-        salesChannel?: string;
-        requestByExt?: string;
-        pageNo?: number;
-        pageSize?: number;
-        isPrioritySort?: boolean;
-        excludeLockedShipments?: boolean;
-        paymentMethods?: string;
-        channelShipmentId?: string;
-        channelOrderId?: string;
-        customMeta?: string;
-    }): Promise<any>;
+    checkOrderStatus({ body }?: {
+        body: OrderStatus;
+    }): Promise<OrderStatusResult>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {string} [arg.channelShipmentId] -
-     * @param {string} [arg.shipmentId] -
-     * @param {string} [arg.orderingCompanyId] -
-     * @param {string} [arg.requestByExt] -
+     * @param {string} arg.caller -
+     * @param {string} arg.receiver -
+     * @param {string} arg.bagId -
+     * @param {string} [arg.callingTo] -
+     * @param {string} [arg.callerId] -
+     * @returns {Promise<Click2CallResponse>} - Success response
      * @summary:
      * @description:
      */
-    getShipmentById({ channelShipmentId, shipmentId, orderingCompanyId, requestByExt, }?: {
-        channelShipmentId?: string;
-        shipmentId?: string;
-        orderingCompanyId?: string;
-        requestByExt?: string;
-    }): Promise<any>;
+    click2Call({ caller, receiver, bagId, callingTo, callerId }?: {
+        caller: string;
+        receiver: string;
+        bagId: string;
+        callingTo?: string;
+        callerId?: string;
+    }): Promise<Click2CallResponse>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {string} arg.orderId -
+     * @param {CreateChannelConfigData} arg.body
+     * @returns {Promise<CreateChannelConfigResponse>} - Success response
      * @summary:
-     * @description:
+     * @description: createChannelConfig
      */
-    getOrderById({ orderId }?: {
-        orderId: string;
-    }): Promise<any>;
+    createChannelConfig({ body }?: {
+        body: CreateChannelConfigData;
+    }): Promise<CreateChannelConfigResponse>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {string} [arg.superLane] -
-     * @param {string} [arg.groupEntity] -
-     * @param {string} [arg.fromDate] -
-     * @param {string} [arg.toDate] -
-     * @param {string} [arg.dpIds] -
-     * @param {string} [arg.stores] -
-     * @param {string} [arg.salesChannel] -
-     * @param {string} [arg.paymentMode] -
-     * @param {string} [arg.bagStatus] -
+     * @param {CreateOrderAPI} arg.body
+     * @returns {Promise<CreateOrderResponse>} - Success response
      * @summary:
      * @description:
      */
-    getLaneConfig({ superLane, groupEntity, fromDate, toDate, dpIds, stores, salesChannel, paymentMode, bagStatus, }?: {
-        superLane?: string;
-        groupEntity?: string;
-        fromDate?: string;
-        toDate?: string;
-        dpIds?: string;
-        stores?: string;
-        salesChannel?: string;
-        paymentMode?: string;
-        bagStatus?: string;
-    }): Promise<any>;
+    createOrder({ body }?: {
+        body: CreateOrderAPI;
+    }): Promise<CreateOrderResponse>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {string} [arg.lane] -
-     * @param {string} [arg.searchType] -
-     * @param {string} [arg.bagStatus] -
-     * @param {string} [arg.timeToDispatch] -
-     * @param {string} [arg.paymentMethods] -
-     * @param {string} [arg.tags] -
-     * @param {string} [arg.searchValue] -
      * @param {string} [arg.fromDate] -
      * @param {string} [arg.toDate] -
-     * @param {string} [arg.dpIds] -
-     * @param {string} [arg.stores] -
-     * @param {string} [arg.salesChannel] -
-     * @param {number} [arg.pageNo] -
-     * @param {number} [arg.pageSize] -
-     * @param {boolean} [arg.isPrioritySort] -
-     * @param {string} [arg.customMeta] -
+     * @returns {Promise<Success>} - Success response
      * @summary:
      * @description:
      */
-    getOrders({ lane, searchType, bagStatus, timeToDispatch, paymentMethods, tags, searchValue, fromDate, toDate, dpIds, stores, salesChannel, pageNo, pageSize, isPrioritySort, customMeta, }?: {
-        lane?: string;
-        searchType?: string;
-        bagStatus?: string;
-        timeToDispatch?: string;
-        paymentMethods?: string;
-        tags?: string;
-        searchValue?: string;
+    createShipmentReport({ fromDate, toDate }?: {
         fromDate?: string;
         toDate?: string;
-        dpIds?: string;
-        stores?: string;
-        salesChannel?: string;
-        pageNo?: number;
-        pageSize?: number;
-        isPrioritySort?: boolean;
-        customMeta?: string;
-    }): Promise<any>;
+    }): Promise<Success>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {string} [arg.fromDate] -
-     * @param {string} [arg.toDate] -
+     * @param {DispatchManifest} arg.body
+     * @returns {Promise<SuccessResponse>} - Success response
      * @summary:
      * @description:
      */
-    getMetricCount({ fromDate, toDate }?: {
-        fromDate?: string;
-        toDate?: string;
-    }): Promise<any>;
+    dispatchManifest({ body }?: {
+        body: DispatchManifest;
+    }): Promise<SuccessResponse>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {string} arg.view -
-     * @param {string} [arg.groupEntity] -
+     * @param {string} [arg.date] -
+     * @returns {Promise<AnnouncementsResponse>} - Success response
      * @summary:
      * @description:
      */
-    getfilters({ view, groupEntity }?: {
-        view: string;
-        groupEntity?: string;
-    }): Promise<any>;
+    getAnnouncements({ date }?: {
+        date?: string;
+    }): Promise<AnnouncementsResponse>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {string} [arg.fromDate] -
-     * @param {string} [arg.toDate] -
+     * @param {string} [arg.bagId] -
+     * @param {string} [arg.channelBagId] -
+     * @param {string} [arg.channelId] -
+     * @returns {Promise<BagDetailsPlatformResponse>} - Success response
      * @summary:
      * @description:
      */
-    createShipmentReport({ fromDate, toDate }?: {
-        fromDate?: string;
-        toDate?: string;
-    }): Promise<any>;
+    getBagById({ bagId, channelBagId, channelId }?: {
+        bagId?: string;
+        channelBagId?: string;
+        channelId?: string;
+    }): Promise<BagDetailsPlatformResponse>;
     /**
      * @param {Object} arg - Arg object.
+     * @param {string} [arg.bagIds] -
+     * @param {string} [arg.shipmentIds] -
+     * @param {string} [arg.orderIds] -
+     * @param {string} [arg.channelBagIds] -
+     * @param {string} [arg.channelShipmentIds] -
+     * @param {string} [arg.channelOrderIds] -
+     * @param {string} [arg.channelId] -
      * @param {number} [arg.pageNo] -
      * @param {number} [arg.pageSize] -
+     * @returns {Promise<GetBagsPlatformResponse>} - Success response
      * @summary:
      * @description:
      */
-    getReportsShipmentListing({ pageNo, pageSize }?: {
+    getBags({ bagIds, shipmentIds, orderIds, channelBagIds, channelShipmentIds, channelOrderIds, channelId, pageNo, pageSize, }?: {
+        bagIds?: string;
+        shipmentIds?: string;
+        orderIds?: string;
+        channelBagIds?: string;
+        channelShipmentIds?: string;
+        channelOrderIds?: string;
+        channelId?: string;
         pageNo?: number;
         pageSize?: number;
-    }): Promise<any>;
+    }): Promise<GetBagsPlatformResponse>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {JioCodeUpsertPayload} arg.body
+     * @param {string} arg.batchId -
+     * @param {string} [arg.reportType] -
+     * @returns {Promise<FileResponse>} - Success response
      * @summary:
      * @description:
      */
-    upsertJioCode({ body }?: {
-        body: JioCodeUpsertPayload;
-    }): Promise<any>;
+    getBulkActionFailedReport({ batchId, reportType }?: {
+        batchId: string;
+        reportType?: string;
+    }): Promise<FileResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.batchId -
      * @param {string} arg.docType -
+     * @returns {Promise<BulkInvoicingResponse>} - Success response
      * @summary:
      * @description:
      */
     getBulkInvoice({ batchId, docType }?: {
         batchId: string;
         docType: string;
-    }): Promise<any>;
+    }): Promise<BulkInvoicingResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.batchId -
+     * @returns {Promise<BulkInvoiceLabelResponse>} - Success response
      * @summary:
      * @description:
      */
     getBulkInvoiceLabel({ batchId }?: {
         batchId: string;
-    }): Promise<any>;
+    }): Promise<BulkInvoiceLabelResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} [arg.lane] -
@@ -224,10 +192,11 @@ declare class Order {
      * @param {number} [arg.pageSize] -
      * @param {string} [arg.customerId] -
      * @param {boolean} [arg.isPrioritySort] -
+     * @returns {Promise<BulkListingResponse>} - Success response
      * @summary:
      * @description:
      */
-    getBulkShipmentExcelFile({ lane, searchType, searchId, fromDate, toDate, dpIds, orderingCompanyId, stores, salesChannel, requestByExt, pageNo, pageSize, customerId, isPrioritySort, }?: {
+    getBulkList({ lane, searchType, searchId, fromDate, toDate, dpIds, orderingCompanyId, stores, salesChannel, requestByExt, pageNo, pageSize, customerId, isPrioritySort, }?: {
         lane?: string;
         searchType?: string;
         searchId?: string;
@@ -242,7 +211,7 @@ declare class Order {
         pageSize?: number;
         customerId?: string;
         isPrioritySort?: boolean;
-    }): Promise<any>;
+    }): Promise<BulkListingResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} [arg.lane] -
@@ -259,10 +228,11 @@ declare class Order {
      * @param {number} [arg.pageSize] -
      * @param {string} [arg.customerId] -
      * @param {boolean} [arg.isPrioritySort] -
+     * @returns {Promise<FileResponse>} - Success response
      * @summary:
      * @description:
      */
-    getBulkList({ lane, searchType, searchId, fromDate, toDate, dpIds, orderingCompanyId, stores, salesChannel, requestByExt, pageNo, pageSize, customerId, isPrioritySort, }?: {
+    getBulkShipmentExcelFile({ lane, searchType, searchId, fromDate, toDate, dpIds, orderingCompanyId, stores, salesChannel, requestByExt, pageNo, pageSize, customerId, isPrioritySort, }?: {
         lane?: string;
         searchType?: string;
         searchId?: string;
@@ -277,309 +247,391 @@ declare class Order {
         pageSize?: number;
         customerId?: string;
         isPrioritySort?: boolean;
-    }): Promise<any>;
+    }): Promise<FileResponse>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {string} arg.batchId -
-     * @param {string} [arg.reportType] -
+     * @returns {Promise<CreateChannelConfigData>} - Success response
      * @summary:
-     * @description:
+     * @description: getChannelConfig
      */
-    getBulkActionFailedReport({ batchId, reportType }?: {
-        batchId: string;
-        reportType?: string;
-    }): Promise<any>;
+    getChannelConfig({}?: any): Promise<CreateChannelConfigData>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {string} arg.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.
-     * @param {string} arg.bagId - ID of the bag. An order may contain multiple
-     *   items and may get divided into one or more shipment, each having its own ID.
-     * @param {string} arg.state - State for which reasons are required.
-     * @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.
+     * @param {string} [arg.superLane] -
+     * @param {string} [arg.groupEntity] -
+     * @param {string} [arg.fromDate] -
+     * @param {string} [arg.toDate] -
+     * @param {string} [arg.dpIds] -
+     * @param {string} [arg.stores] -
+     * @param {string} [arg.salesChannel] -
+     * @param {string} [arg.paymentMode] -
+     * @param {string} [arg.bagStatus] -
+     * @returns {Promise<LaneConfigResponse>} - Success response
+     * @summary:
+     * @description:
      */
-    getShipmentReasons({ shipmentId, bagId, state }?: {
-        shipmentId: string;
-        bagId: string;
-        state: string;
-    }): Promise<any>;
+    getLaneConfig({ superLane, groupEntity, fromDate, toDate, dpIds, stores, salesChannel, paymentMode, bagStatus, }?: {
+        superLane?: string;
+        groupEntity?: string;
+        fromDate?: string;
+        toDate?: string;
+        dpIds?: string;
+        stores?: string;
+        salesChannel?: string;
+        paymentMode?: string;
+        bagStatus?: string;
+    }): Promise<LaneConfigResponse>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {BulkActionPayload} arg.body
-     * @summary: emits uuid to kafka topic.
-     * @description: Use this API to start processing Xlsx file.
+     * @param {string} [arg.fromDate] -
+     * @param {string} [arg.toDate] -
+     * @returns {Promise<MetricCountResponse>} - Success response
+     * @summary:
+     * @description:
      */
-    bulkActionProcessXlsxFile({ body }?: {
-        body: BulkActionPayload;
-    }): Promise<any>;
+    getMetricCount({ fromDate, toDate }?: {
+        fromDate?: string;
+        toDate?: string;
+    }): Promise<MetricCountResponse>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {string} arg.batchId -
-     * @summary: Returns failed, processing and successfully processed shipments.
-     * @description: Returns failed, processing and successfully processed shipments along with their counts and failed reasons.
+     * @param {string} arg.orderId -
+     * @returns {Promise<ShipmentDetailsResponse>} - Success response
+     * @summary:
+     * @description:
      */
-    bulkActionDetails({ batchId }?: {
-        batchId: string;
-    }): Promise<any>;
+    getOrderById({ orderId }?: {
+        orderId: string;
+    }): Promise<ShipmentDetailsResponse>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {string} [arg.bagId] -
-     * @param {string} [arg.channelBagId] -
-     * @param {string} [arg.channelId] -
+     * @param {string} [arg.lane] -
+     * @param {string} [arg.searchType] -
+     * @param {string} [arg.bagStatus] -
+     * @param {string} [arg.timeToDispatch] -
+     * @param {string} [arg.paymentMethods] -
+     * @param {string} [arg.tags] -
+     * @param {string} [arg.searchValue] -
+     * @param {string} [arg.fromDate] -
+     * @param {string} [arg.toDate] -
+     * @param {string} [arg.dpIds] -
+     * @param {string} [arg.stores] -
+     * @param {string} [arg.salesChannel] -
+     * @param {number} [arg.pageNo] -
+     * @param {number} [arg.pageSize] -
+     * @param {boolean} [arg.isPrioritySort] -
+     * @param {string} [arg.customMeta] -
+     * @returns {Promise<OrderListingResponse>} - Success response
      * @summary:
      * @description:
      */
-    getBagById({ bagId, channelBagId, channelId }?: {
-        bagId?: string;
-        channelBagId?: string;
-        channelId?: string;
-    }): Promise<any>;
+    getOrders({ lane, searchType, bagStatus, timeToDispatch, paymentMethods, tags, searchValue, fromDate, toDate, dpIds, stores, salesChannel, pageNo, pageSize, isPrioritySort, customMeta, }?: {
+        lane?: string;
+        searchType?: string;
+        bagStatus?: string;
+        timeToDispatch?: string;
+        paymentMethods?: string;
+        tags?: string;
+        searchValue?: string;
+        fromDate?: string;
+        toDate?: string;
+        dpIds?: string;
+        stores?: string;
+        salesChannel?: string;
+        pageNo?: number;
+        pageSize?: number;
+        isPrioritySort?: boolean;
+        customMeta?: string;
+    }): Promise<OrderListingResponse>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {string} [arg.bagIds] -
-     * @param {string} [arg.shipmentIds] -
-     * @param {string} [arg.orderIds] -
-     * @param {string} [arg.channelBagIds] -
-     * @param {string} [arg.channelShipmentIds] -
-     * @param {string} [arg.channelOrderIds] -
-     * @param {string} [arg.channelId] -
      * @param {number} [arg.pageNo] -
      * @param {number} [arg.pageSize] -
+     * @returns {Promise<OmsReports>} - Success response
      * @summary:
      * @description:
      */
-    getBags({ bagIds, shipmentIds, orderIds, channelBagIds, channelShipmentIds, channelOrderIds, channelId, pageNo, pageSize, }?: {
-        bagIds?: string;
-        shipmentIds?: string;
-        orderIds?: string;
-        channelBagIds?: string;
-        channelShipmentIds?: string;
-        channelOrderIds?: string;
-        channelId?: string;
+    getReportsShipmentListing({ pageNo, pageSize }?: {
         pageNo?: number;
         pageSize?: number;
-    }): Promise<any>;
+    }): Promise<OmsReports>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {InvalidateShipmentCachePayload} arg.body
+     * @returns {Promise<GetActionsResponse>} - Success response
      * @summary:
-     * @description: Invalidate shipment Cache
+     * @description:
      */
-    invalidateShipmentCache({ body }?: {
-        body: InvalidateShipmentCachePayload;
-    }): Promise<any>;
+    getRoleBasedActions({}?: any): Promise<GetActionsResponse>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {StoreReassign} arg.body
+     * @param {string} [arg.channelShipmentId] -
+     * @param {string} [arg.shipmentId] -
+     * @param {string} [arg.orderingCompanyId] -
+     * @param {string} [arg.requestByExt] -
+     * @returns {Promise<ShipmentInfoResponse>} - Success response
      * @summary:
-     * @description: Reassign Location
+     * @description:
      */
-    reassignLocation({ body }?: {
-        body: StoreReassign;
-    }): Promise<any>;
+    getShipmentById({ channelShipmentId, shipmentId, orderingCompanyId, requestByExt, }?: {
+        channelShipmentId?: string;
+        shipmentId?: string;
+        orderingCompanyId?: string;
+        requestByExt?: string;
+    }): Promise<ShipmentInfoResponse>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {UpdateShipmentLockPayload} arg.body
+     * @param {number} [arg.shipmentId] -
+     * @param {number} [arg.bagId] -
+     * @returns {Promise<ShipmentHistoryResponse>} - Success response
      * @summary:
-     * @description: update shipment lock
+     * @description:
      */
-    updateShipmentLock({ body }?: {
-        body: UpdateShipmentLockPayload;
-    }): Promise<any>;
+    getShipmentHistory({ shipmentId, bagId }?: {
+        shipmentId?: number;
+        bagId?: number;
+    }): Promise<ShipmentHistoryResponse>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {string} [arg.date] -
-     * @summary:
-     * @description:
+     * @param {string} arg.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.
+     * @param {string} arg.bagId - ID of the bag. An order may contain multiple
+     *   items and may get divided into one or more shipment, each having its own ID.
+     * @param {string} arg.state - State for which reasons are required.
+     * @returns {Promise<PlatformShipmentReasonsResponse>} - Success response
+     * @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.
      */
-    getAnnouncements({ date }?: {
-        date?: string;
-    }): Promise<any>;
+    getShipmentReasons({ shipmentId, bagId, state }?: {
+        shipmentId: string;
+        bagId: string;
+        state: string;
+    }): Promise<PlatformShipmentReasonsResponse>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {string} arg.shipmentId -
-     * @param {string} [arg.name] -
-     * @param {string} [arg.address] -
-     * @param {string} [arg.addressType] -
-     * @param {string} [arg.pincode] -
-     * @param {string} [arg.phone] -
-     * @param {string} [arg.email] -
-     * @param {string} [arg.landmark] -
-     * @param {string} arg.addressCategory -
-     * @param {string} [arg.city] -
-     * @param {string} [arg.state] -
-     * @param {string} [arg.country] -
+     * @param {string} [arg.lane] -
+     * @param {string} [arg.bagStatus] -
+     * @param {boolean} [arg.statusOverrideLane] -
+     * @param {string} [arg.searchType] -
+     * @param {string} [arg.searchValue] -
+     * @param {string} [arg.searchId] -
+     * @param {string} [arg.fromDate] -
+     * @param {string} [arg.toDate] -
+     * @param {string} [arg.dpIds] -
+     * @param {string} [arg.orderingCompanyId] -
+     * @param {string} [arg.stores] -
+     * @param {string} [arg.salesChannel] -
+     * @param {string} [arg.requestByExt] -
+     * @param {number} [arg.pageNo] -
+     * @param {number} [arg.pageSize] -
+     * @param {boolean} [arg.isPrioritySort] -
+     * @param {boolean} [arg.fetchActiveShipment] -
+     * @param {boolean} [arg.excludeLockedShipments] -
+     * @param {string} [arg.paymentMethods] -
+     * @param {string} [arg.channelShipmentId] -
+     * @param {string} [arg.channelOrderId] -
+     * @param {string} [arg.customMeta] -
+     * @param {string} [arg.orderingChannel] -
+     * @param {string} [arg.companyAffiliateTag] -
+     * @returns {Promise<ShipmentInternalPlatformViewResponse>} - Success response
      * @summary:
      * @description:
      */
-    updateAddress({ shipmentId, addressCategory, name, address, addressType, pincode, phone, email, landmark, city, state, country, }?: {
-        shipmentId: string;
-        name?: string;
-        address?: string;
-        addressType?: string;
-        pincode?: string;
-        phone?: string;
-        email?: string;
-        landmark?: string;
-        addressCategory: string;
-        city?: string;
-        state?: string;
-        country?: string;
-    }): Promise<any>;
+    getShipments({ lane, bagStatus, statusOverrideLane, searchType, searchValue, searchId, fromDate, toDate, dpIds, orderingCompanyId, stores, salesChannel, requestByExt, pageNo, pageSize, isPrioritySort, fetchActiveShipment, excludeLockedShipments, paymentMethods, channelShipmentId, channelOrderId, customMeta, orderingChannel, companyAffiliateTag, }?: {
+        lane?: string;
+        bagStatus?: string;
+        statusOverrideLane?: boolean;
+        searchType?: string;
+        searchValue?: string;
+        searchId?: string;
+        fromDate?: string;
+        toDate?: string;
+        dpIds?: string;
+        orderingCompanyId?: string;
+        stores?: string;
+        salesChannel?: string;
+        requestByExt?: string;
+        pageNo?: number;
+        pageSize?: number;
+        isPrioritySort?: boolean;
+        fetchActiveShipment?: boolean;
+        excludeLockedShipments?: boolean;
+        paymentMethods?: string;
+        channelShipmentId?: string;
+        channelOrderId?: string;
+        customMeta?: string;
+        orderingChannel?: string;
+        companyAffiliateTag?: string;
+    }): Promise<ShipmentInternalPlatformViewResponse>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {string} arg.caller -
-     * @param {string} arg.receiver -
-     * @param {string} arg.bagId -
-     * @param {string} [arg.callingTo] -
-     * @param {string} [arg.callerId] -
+     * @param {string} arg.view -
+     * @param {string} [arg.groupEntity] -
+     * @returns {Promise<FiltersResponse>} - Success response
      * @summary:
      * @description:
      */
-    click2Call({ caller, receiver, bagId, callingTo, callerId }?: {
-        caller: string;
-        receiver: string;
-        bagId: string;
-        callingTo?: string;
-        callerId?: string;
-    }): Promise<any>;
+    getfilters({ view, groupEntity }?: {
+        view: string;
+        groupEntity?: string;
+    }): Promise<FiltersResponse>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {UpdateShipmentStatusRequest} arg.body
+     * @param {InvalidateShipmentCachePayload} arg.body
+     * @returns {Promise<InvalidateShipmentCacheResponse>} - Success response
      * @summary:
-     * @description: Update shipment status
+     * @description: Invalidate shipment Cache
      */
-    updateShipmentStatus({ body }?: {
-        body: UpdateShipmentStatusRequest;
-    }): Promise<any>;
+    invalidateShipmentCache({ body }?: {
+        body: InvalidateShipmentCachePayload;
+    }): Promise<InvalidateShipmentCacheResponse>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {CreateOrderPayload} arg.body
+     * @param {PlatformOrderUpdate} arg.body
+     * @returns {Promise<ResponseDetail>} - Success response
      * @summary:
      * @description:
      */
-    processManifest({ body }?: {
-        body: CreateOrderPayload;
-    }): Promise<any>;
+    orderUpdate({ body }?: {
+        body: PlatformOrderUpdate;
+    }): Promise<ResponseDetail>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {DispatchManifest} arg.body
+     * @param {ManualAssignDPToShipment} arg.body
+     * @returns {Promise<ManualAssignDPToShipmentResponse>} - Success response
      * @summary:
      * @description:
      */
-    dispatchManifest({ body }?: {
-        body: DispatchManifest;
-    }): Promise<any>;
+    platformManualAssignDPToShipment({ body }?: {
+        body: ManualAssignDPToShipment;
+    }): Promise<ManualAssignDPToShipmentResponse>;
     /**
      * @param {Object} arg - Arg object.
+     * @param {PostShipmentHistory} arg.body
+     * @returns {Promise<ShipmentHistoryResponse>} - Success response
      * @summary:
      * @description:
      */
-    getRoleBasedActions({}?: any): Promise<any>;
+    postShipmentHistory({ body }?: {
+        body: PostShipmentHistory;
+    }): Promise<ShipmentHistoryResponse>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {number} [arg.shipmentId] -
-     * @param {number} [arg.bagId] -
+     * @param {CreateOrderPayload} arg.body
+     * @returns {Promise<CreateOrderResponse>} - Success response
      * @summary:
      * @description:
      */
-    getShipmentHistory({ shipmentId, bagId }?: {
-        shipmentId?: number;
-        bagId?: number;
-    }): Promise<any>;
+    processManifest({ body }?: {
+        body: CreateOrderPayload;
+    }): Promise<CreateOrderResponse>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {PostShipmentHistory} arg.body
+     * @param {StoreReassign} arg.body
+     * @returns {Promise<StoreReassignResponse>} - Success response
      * @summary:
-     * @description:
+     * @description: Reassign Location
      */
-    postShipmentHistory({ body }?: {
-        body: PostShipmentHistory;
-    }): Promise<any>;
+    reassignLocation({ body }?: {
+        body: StoreReassign;
+    }): Promise<StoreReassignResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {SendSmsPayload} arg.body
+     * @returns {Promise<OrderStatusResult>} - Success response
      * @summary:
      * @description:
      */
     sendSmsNinja({ body }?: {
         body: SendSmsPayload;
-    }): Promise<any>;
+    }): Promise<OrderStatusResult>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {ManualAssignDPToShipment} arg.body
+     * @returns {Promise<OrderStatusResult>} - Success response
      * @summary:
      * @description:
      */
-    platformManualAssignDPToShipment({ body }?: {
-        body: ManualAssignDPToShipment;
-    }): Promise<any>;
+    sendSmsNinjaPlatform({}?: any): Promise<OrderStatusResult>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {CreateOrderPayload} arg.body
+     * @param {string} arg.shipmentId -
+     * @param {string} [arg.name] -
+     * @param {string} [arg.address] -
+     * @param {string} [arg.addressType] -
+     * @param {string} [arg.pincode] -
+     * @param {string} [arg.phone] -
+     * @param {string} [arg.email] -
+     * @param {string} [arg.landmark] -
+     * @param {string} arg.addressCategory -
+     * @param {string} [arg.city] -
+     * @param {string} [arg.state] -
+     * @param {string} [arg.country] -
+     * @returns {Promise<BaseResponse>} - Success response
      * @summary:
      * @description:
      */
-    updatePackagingDimensions({ body }?: {
-        body: CreateOrderPayload;
-    }): Promise<any>;
+    updateAddress({ shipmentId, addressCategory, name, address, addressType, pincode, phone, email, landmark, city, state, country, }?: {
+        shipmentId: string;
+        name?: string;
+        address?: string;
+        addressType?: string;
+        pincode?: string;
+        phone?: string;
+        email?: string;
+        landmark?: string;
+        addressCategory: string;
+        city?: string;
+        state?: string;
+        country?: string;
+    }): Promise<BaseResponse>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {CreateOrderAPI} arg.body
+     * @param {CreateOrderPayload} arg.body
+     * @returns {Promise<CreateOrderResponse>} - Success response
      * @summary:
      * @description:
      */
-    createOrder({ body }?: {
-        body: CreateOrderAPI;
-    }): Promise<any>;
+    updatePackagingDimensions({ body }?: {
+        body: CreateOrderPayload;
+    }): Promise<CreateOrderResponse>;
     /**
      * @param {Object} arg - Arg object.
+     * @param {UpdateShipmentLockPayload} arg.body
+     * @returns {Promise<UpdateShipmentLockResponse>} - Success response
      * @summary:
-     * @description: getChannelConfig
+     * @description: update shipment lock
      */
-    getChannelConfig({}?: any): Promise<any>;
+    updateShipmentLock({ body }?: {
+        body: UpdateShipmentLockPayload;
+    }): Promise<UpdateShipmentLockResponse>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {CreateChannelConfigData} arg.body
+     * @param {UpdateShipmentStatusRequest} arg.body
+     * @returns {Promise<UpdateShipmentStatusResponseBody>} - Success response
      * @summary:
-     * @description: createChannelConfig
+     * @description: Update shipment status
      */
-    createChannelConfig({ body }?: {
-        body: CreateChannelConfigData;
-    }): Promise<any>;
+    updateShipmentStatus({ body }?: {
+        body: UpdateShipmentStatusRequest;
+    }): Promise<UpdateShipmentStatusResponseBody>;
     /**
      * @param {Object} arg - Arg object.
      * @param {UploadConsent} arg.body
+     * @returns {Promise<SuccessResponse>} - Success response
      * @summary:
      * @description:
      */
     uploadConsent({ body }?: {
         body: UploadConsent;
-    }): Promise<any>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {PlatformOrderUpdate} arg.body
-     * @summary:
-     * @description:
-     */
-    orderUpdate({ body }?: {
-        body: PlatformOrderUpdate;
-    }): Promise<any>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {OrderStatus} arg.body
-     * @summary:
-     * @description:
-     */
-    checkOrderStatus({ body }?: {
-        body: OrderStatus;
-    }): Promise<any>;
+    }): Promise<SuccessResponse>;
     /**
      * @param {Object} arg - Arg object.
+     * @param {JioCodeUpsertPayload} arg.body
+     * @returns {Promise<JioCodeUpsertResponse>} - Success response
      * @summary:
      * @description:
      */
-    sendSmsNinjaPlatform({}?: any): Promise<any>;
+    upsertJioCode({ body }?: {
+        body: JioCodeUpsertPayload;
+    }): Promise<JioCodeUpsertResponse>;
 }