@gofynd/fdk-client-javascript 1.1.2 → 1.1.4

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

@@ -2,6 +2,16 @@ export = Order;
 declare class Order {
     constructor(config: any);
     config: any;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {AttachOrderUser} arg.body
+     * @returns {Promise<AttachOrderUserResponse>} - Success response
+     * @summary:
+     * @description:
+     */
+    attachOrderUser({ body }?: {
+        body: AttachOrderUser;
+    }): Promise<AttachOrderUserResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {OrderStatus} arg.body
@@ -70,6 +80,40 @@ declare class Order {
     downloadBulkActionTemplate({ templateSlug }?: {
         templateSlug?: string;
     }): Promise<FileResponse>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {FetchCreditBalanceRequestPayload} arg.body
+     * @returns {Promise<FetchCreditBalanceResponsePayload>} - Success response
+     * @summary:
+     * @description:
+     */
+    fetchCreditBalanceDetail({ body }?: {
+        body: FetchCreditBalanceRequestPayload;
+    }): Promise<FetchCreditBalanceResponsePayload>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {RefundModeConfigRequestPayload} arg.body
+     * @returns {Promise<RefundModeConfigResponsePayload>} - Success response
+     * @summary:
+     * @description:
+     */
+    fetchRefundModeConfig({ body }?: {
+        body: RefundModeConfigRequestPayload;
+    }): Promise<RefundModeConfigResponsePayload>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.orderId -
+     * @param {string} [arg.shipmentId] -
+     * @param {string} [arg.documentType] -
+     * @returns {Promise<GeneratePosOrderReceiptResponse>} - Success response
+     * @summary:
+     * @description:
+     */
+    generatePOSReceiptByOrderId({ orderId, shipmentId, documentType, }?: {
+        orderId: string;
+        shipmentId?: string;
+        documentType?: string;
+    }): Promise<GeneratePosOrderReceiptResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} [arg.date] - Date On which the announcement is Active
@@ -83,9 +127,9 @@ declare class Order {
     }): Promise<AnnouncementsResponse>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {string} [arg.bagId] -
-     * @param {string} [arg.channelBagId] -
-     * @param {string} [arg.channelId] -
+     * @param {string} [arg.bagId] - Id of bag
+     * @param {string} [arg.channelBagId] - Id of application bag
+     * @param {string} [arg.channelId] - Id of application
      * @returns {Promise<BagDetailsPlatformResponse>} - Success response
      * @summary:
      * @description:
@@ -97,15 +141,16 @@ declare class Order {
     }): 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] -
+     * @param {string} [arg.bagIds] - Comma separated values of bag ids
+     * @param {string} [arg.shipmentIds] - Comma separated values of shipment ids
+     * @param {string} [arg.orderIds] - Comma separated values of order ids
+     * @param {string} [arg.channelBagIds] - Comma separated values of app bag ids
+     * @param {string} [arg.channelShipmentIds] - Comma separated values of app
+     *   shipment ids
+     * @param {string} [arg.channelOrderIds] - Comma separated values of app order ids
+     * @param {string} [arg.channelId] - Comma separated values of app ids
+     * @param {number} [arg.pageNo] - Page number for paginated data
+     * @param {number} [arg.pageSize] - Page size of data received per page
      * @returns {Promise<GetBagsPlatformResponse>} - Success response
      * @summary:
      * @description:
@@ -130,14 +175,14 @@ declare class Order {
     getBulkActionTemplate({}?: any): Promise<BulkActionTemplateResponse>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {string} [arg.salesChannels] - Comma seperated values of sales channel ids
-     * @param {string} [arg.dpIds] - Comma seperated values of delivery partner ids
+     * @param {string} [arg.salesChannels] - Comma separated values of sales channel ids
+     * @param {string} [arg.dpIds] - Comma separated values of delivery partner ids
      * @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.stores] - Comma seperated values of store ids
-     * @param {string} [arg.tags] - Comma seperated values of tags
-     * @param {string} [arg.bagStatus] - Comma seperated values of bag statuses
-     * @param {string} [arg.paymentMethods] - Comma seperated values of payment methods
+     * @param {string} [arg.stores] - Comma separated values of store ids
+     * @param {string} [arg.tags] - Comma separated values of tags
+     * @param {string} [arg.bagStatus] - Comma separated values of bag statuses
+     * @param {string} [arg.paymentMethods] - Comma separated values of payment methods
      * @param {string} [arg.fileType] - File type to be downloaded
      * @param {number} [arg.timeToDispatch] - Sla breached or not breached
      * @param {number} [arg.pageNo] -
@@ -169,63 +214,82 @@ declare class Order {
     getChannelConfig({}?: any): Promise<CreateChannelConfigData>;
     /**
      * @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 {string} [arg.superLane] - Name of lane for which data is to be fetched
+     * @param {string} [arg.groupEntity] - Name of group entity
+     * @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.dpIds] - Comma separated values of delivery partner ids
+     * @param {string} [arg.stores] - Comma separated values of store ids
+     * @param {string} [arg.salesChannels] -
+     * @param {string} [arg.paymentMode] - Comma separated values of payment modes
+     * @param {string} [arg.bagStatus] - Comma separated values of bag statuses
+     * @param {string} [arg.searchType] -
+     * @param {string} [arg.searchValue] -
+     * @param {string} [arg.tags] -
+     * @param {string} [arg.timeToDispatch] -
+     * @param {string} [arg.paymentMethods] -
+     * @param {boolean} [arg.myOrders] -
      * @returns {Promise<LaneConfigResponse>} - Success response
      * @summary:
      * @description:
      */
-    getLaneConfig({ superLane, groupEntity, fromDate, toDate, dpIds, stores, salesChannel, paymentMode, bagStatus, }?: {
+    getLaneConfig({ superLane, groupEntity, fromDate, toDate, dpIds, stores, salesChannels, paymentMode, bagStatus, searchType, searchValue, tags, timeToDispatch, paymentMethods, myOrders, }?: {
         superLane?: string;
         groupEntity?: string;
         fromDate?: string;
         toDate?: string;
         dpIds?: string;
         stores?: string;
-        salesChannel?: string;
+        salesChannels?: string;
         paymentMode?: string;
         bagStatus?: string;
+        searchType?: string;
+        searchValue?: string;
+        tags?: string;
+        timeToDispatch?: string;
+        paymentMethods?: string;
+        myOrders?: boolean;
     }): Promise<LaneConfigResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.orderId -
-     * @returns {Promise<ShipmentDetailsResponse>} - Success response
+     * @returns {Promise<OrderDetailsResponse>} - Success response
      * @summary:
      * @description:
      */
     getOrderById({ orderId }?: {
         orderId: string;
-    }): Promise<ShipmentDetailsResponse>;
+    }): Promise<OrderDetailsResponse>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {string} [arg.lane] -
-     * @param {string} [arg.searchType] -
-     * @param {string} [arg.bagStatus] -
-     * @param {string} [arg.timeToDispatch] -
+     * @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 {string} [arg.timeToDispatch] - Time_to_dispatch refers to
+     *   estimated SLA time.
      * @param {string} [arg.paymentMethods] -
-     * @param {string} [arg.tags] -
-     * @param {string} [arg.searchValue] -
+     * @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.dpIds] -
+     * @param {string} [arg.dpIds] - Delivery Partner IDs to which shipments are assigned.
      * @param {string} [arg.stores] -
      * @param {string} [arg.salesChannels] -
      * @param {number} [arg.pageNo] -
      * @param {number} [arg.pageSize] -
      * @param {boolean} [arg.isPrioritySort] -
      * @param {string} [arg.customMeta] -
+     * @param {boolean} [arg.myOrders] -
      * @returns {Promise<OrderListingResponse>} - Success response
      * @summary:
      * @description:
      */
-    getOrders({ lane, searchType, bagStatus, timeToDispatch, paymentMethods, tags, searchValue, fromDate, toDate, dpIds, stores, salesChannels, pageNo, pageSize, isPrioritySort, customMeta, }?: {
+    getOrders({ lane, searchType, bagStatus, timeToDispatch, paymentMethods, tags, searchValue, fromDate, toDate, dpIds, stores, salesChannels, pageNo, pageSize, isPrioritySort, customMeta, myOrders, }?: {
         lane?: string;
         searchType?: string;
         bagStatus?: string;
@@ -242,6 +306,7 @@ declare class Order {
         pageSize?: number;
         isPrioritySort?: boolean;
         customMeta?: string;
+        myOrders?: boolean;
     }): Promise<OrderListingResponse>;
     /**
      * @param {Object} arg - Arg object.
@@ -252,19 +317,15 @@ declare class Order {
     getRoleBasedActions({}?: any): Promise<GetActionsResponse>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {string} [arg.channelShipmentId] -
-     * @param {string} [arg.shipmentId] -
-     * @param {string} [arg.orderingCompanyId] -
-     * @param {string} [arg.requestByExt] -
+     * @param {string} [arg.channelShipmentId] - App Shipment Id
+     * @param {string} [arg.shipmentId] - Shipment Id
      * @returns {Promise<ShipmentInfoResponse>} - Success response
      * @summary:
      * @description:
      */
-    getShipmentById({ channelShipmentId, shipmentId, orderingCompanyId, requestByExt, }?: {
+    getShipmentById({ channelShipmentId, shipmentId }?: {
         channelShipmentId?: string;
         shipmentId?: string;
-        orderingCompanyId?: string;
-        requestByExt?: string;
     }): Promise<ShipmentInfoResponse>;
     /**
      * @param {Object} arg - Arg object.
@@ -297,51 +358,49 @@ declare class Order {
     }): Promise<PlatformShipmentReasonsResponse>;
     /**
      * @param {Object} arg - Arg object.
-     * @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.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 {string} [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.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.pageNo] - Page number for paginated data
+     * @param {number} [arg.pageSize] - Page size of data received per page
+     * @param {boolean} [arg.fetchActiveShipment] - Flag to fetch active 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.tags] - Comma separated values of tags
      * @returns {Promise<ShipmentInternalPlatformViewResponse>} - Success response
      * @summary:
      * @description:
      */
-    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, }?: {
+    getShipments({ lane, bagStatus, statusOverrideLane, timeToDispatch, searchType, searchValue, fromDate, toDate, dpIds, stores, salesChannels, pageNo, pageSize, fetchActiveShipment, excludeLockedShipments, paymentMethods, channelShipmentId, channelOrderId, customMeta, orderingChannel, companyAffiliateTag, myOrders, platformUserId, tags, }?: {
         lane?: string;
         bagStatus?: string;
         statusOverrideLane?: boolean;
+        timeToDispatch?: string;
         searchType?: string;
         searchValue?: string;
-        searchId?: string;
         fromDate?: string;
         toDate?: string;
         dpIds?: string;
-        orderingCompanyId?: string;
         stores?: string;
-        salesChannel?: string;
-        requestByExt?: string;
+        salesChannels?: string;
         pageNo?: number;
         pageSize?: number;
-        isPrioritySort?: boolean;
         fetchActiveShipment?: boolean;
         excludeLockedShipments?: boolean;
         paymentMethods?: string;
@@ -350,6 +409,9 @@ declare class Order {
         customMeta?: string;
         orderingChannel?: string;
         companyAffiliateTag?: string;
+        myOrders?: boolean;
+        platformUserId?: string;
+        tags?: string;
     }): Promise<ShipmentInternalPlatformViewResponse>;
     /**
      * @param {Object} arg - Arg object.
@@ -360,8 +422,8 @@ declare class Order {
     getStateTransitionMap({}?: any): Promise<BagStateTransitionMap>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {string} arg.view -
-     * @param {string} [arg.groupEntity] -
+     * @param {string} arg.view - Name of view
+     * @param {string} [arg.groupEntity] - Name of group entity
      * @returns {Promise<FiltersResponse>} - Success response
      * @summary:
      * @description:
@@ -430,6 +492,16 @@ declare class Order {
     sendSmsNinja({ body }?: {
         body: SendSmsPayload;
     }): Promise<OrderStatusResult>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {SendUserMobileOTP} arg.body
+     * @returns {Promise<SendUserMobileOtpResponse>} - Success response
+     * @summary:
+     * @description:
+     */
+    sendUserMobileOTP({ body }?: {
+        body: SendUserMobileOTP;
+    }): Promise<SendUserMobileOtpResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.shipmentId -
@@ -464,14 +536,14 @@ declare class Order {
     }): Promise<BaseResponse>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {CreateOrderPayload} arg.body
-     * @returns {Promise<CreateOrderResponse>} - Success response
+     * @param {UpdatePackagingDimensionsPayload} arg.body
+     * @returns {Promise<UpdatePackagingDimensionsResponse>} - Success response
      * @summary:
      * @description:
      */
     updatePackagingDimensions({ body }?: {
-        body: CreateOrderPayload;
-    }): Promise<CreateOrderResponse>;
+        body: UpdatePackagingDimensionsPayload;
+    }): Promise<UpdatePackagingDimensionsResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {UpdateShipmentLockPayload} arg.body
@@ -502,4 +574,14 @@ declare class Order {
     uploadConsent({ body }?: {
         body: UploadConsent;
     }): Promise<SuccessResponse>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {VerifyMobileOTP} arg.body
+     * @returns {Promise<VerifyOtpResponse>} - Success response
+     * @summary:
+     * @description:
+     */
+    verifyMobileOTP({ body }?: {
+        body: VerifyMobileOTP;
+    }): Promise<VerifyOtpResponse>;
 }