@gofynd/fdk-client-javascript 1.0.1 → 1.0.3

package/sdk/application/Order/OrderApplicationClient.d.ts

@@ -3,21 +3,57 @@ declare class Order {
     constructor(_conf: any);
     _conf: any;
     _relativeUrls: {
-        getOrders: string;
+        getCustomerDetailsByShipmentId: string;
+        getInvoiceByShipmentId: string;
         getOrderById: string;
+        getOrders: string;
         getPosOrderById: string;
-        getShipmentById: string;
-        getInvoiceByShipmentId: string;
-        trackShipment: string;
-        getCustomerDetailsByShipmentId: string;
-        sendOtpToShipmentCustomer: string;
-        verifyOtpShipmentCustomer: string;
         getShipmentBagReasons: string;
+        getShipmentById: string;
         getShipmentReasons: string;
+        sendOtpToShipmentCustomer: string;
+        trackShipment: string;
         updateShipmentStatus: string;
+        verifyOtpShipmentCustomer: string;
     };
     _urls: {};
     updateUrls(urls: any): void;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.orderId - 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.shipmentId - A unique number used for identifying and
+     *   tracking your orders.
+     * @returns {Promise<CustomerDetailsResponse>} - Success response
+     * @summary: Get Customer Details by Shipment Id
+     * @description: Use this API to retrieve customer details such as mobileno using Shipment ID.
+     */
+    getCustomerDetailsByShipmentId({ orderId, shipmentId }?: {
+        orderId: string;
+        shipmentId: string;
+    }): Promise<CustomerDetailsResponse>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.shipmentId - ID of the shipment.
+     * @returns {Promise<ResponseGetInvoiceShipment>} - Success response
+     * @summary: Get Invoice of a shipment
+     * @description: Use this API to retrieve shipment invoice.
+     */
+    getInvoiceByShipmentId({ shipmentId }?: {
+        shipmentId: string;
+    }): Promise<ResponseGetInvoiceShipment>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.orderId - A unique number used for identifying and
+     *   tracking your orders.
+     * @returns {Promise<OrderById>} - Success response
+     * @summary: Get details of an order
+     * @description: Use this API to retrieve order details such as tracking details, shipment, store information using Fynd Order ID.
+     */
+    getOrderById({ orderId }?: {
+        orderId: string;
+    }): Promise<OrderById>;
     /**
      * @param {Object} arg - Arg object.
      * @param {number} [arg.status] - A filter to retrieve orders by their
@@ -35,7 +71,7 @@ declare class Order {
      * @summary: Get all orders
      * @description: Use this API to retrieve all the orders.
      */
-    getOrders({ status, pageNo, pageSize, fromDate, toDate, customMeta }?: {
+    getOrders({ status, pageNo, pageSize, fromDate, toDate, customMeta, }?: {
         status?: number;
         pageNo?: number;
         pageSize?: number;
@@ -43,17 +79,6 @@ declare class Order {
         toDate?: string;
         customMeta?: string;
     }): Promise<OrderList>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.orderId - A unique number used for identifying and
-     *   tracking your orders.
-     * @returns {Promise<OrderById>} - Success response
-     * @summary: Get details of an order
-     * @description: Use this API to retrieve order details such as tracking details, shipment, store information using Fynd Order ID.
-     */
-    getOrderById({ orderId }?: {
-        orderId: string;
-    }): Promise<OrderById>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.orderId - A unique number used for identifying and
@@ -67,53 +92,43 @@ declare class Order {
     }): Promise<OrderList>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {string} arg.shipmentId - ID of the shipment. An order may contain
+     * @param {string} arg.shipmentId - ID of the bag. An order may contain
      *   multiple items and may get divided into one or more shipment, each
      *   having its own ID.
-     * @returns {Promise<ShipmentById>} - Success response
-     * @summary: Get details of a shipment
-     * @description: Use this API to retrieve shipment details such as price breakup, tracking details, store information, etc. using Shipment ID.
-     */
-    getShipmentById({ shipmentId }?: {
-        shipmentId: string;
-    }): Promise<ShipmentById>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.shipmentId - ID of the shipment.
-     * @returns {Promise<ResponseGetInvoiceShipment>} - Success response
-     * @summary: Get Invoice of a shipment
-     * @description: Use this API to retrieve shipment invoice.
+     * @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.
+     * @returns {Promise<ShipmentBagReasons>} - 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.
      */
-    getInvoiceByShipmentId({ shipmentId }?: {
+    getShipmentBagReasons({ shipmentId, bagId }?: {
         shipmentId: string;
-    }): Promise<ResponseGetInvoiceShipment>;
+        bagId: string;
+    }): Promise<ShipmentBagReasons>;
     /**
      * @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.
-     * @returns {Promise<ShipmentTrack>} - Success response
-     * @summary: Track shipment
-     * @description: Track Shipment by shipment id, for application based on application Id
+     * @returns {Promise<ShipmentById>} - Success response
+     * @summary: Get details of a shipment
+     * @description: Use this API to retrieve shipment details such as price breakup, tracking details, store information, etc. using Shipment ID.
      */
-    trackShipment({ shipmentId }?: {
+    getShipmentById({ shipmentId }?: {
         shipmentId: string;
-    }): Promise<ShipmentTrack>;
+    }): Promise<ShipmentById>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {string} arg.orderId - ID of the shipment. An order may contain
+     * @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.shipmentId - A unique number used for identifying and
-     *   tracking your orders.
-     * @returns {Promise<CustomerDetailsResponse>} - Success response
-     * @summary: Get Customer Details by Shipment Id
-     * @description: Use this API to retrieve customer details such as mobileno using Shipment ID.
+     * @returns {Promise<ShipmentReasons>} - 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.
      */
-    getCustomerDetailsByShipmentId({ orderId, shipmentId }?: {
-        orderId: string;
+    getShipmentReasons({ shipmentId }?: {
         shipmentId: string;
-    }): Promise<CustomerDetailsResponse>;
+    }): Promise<ShipmentReasons>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.orderId - A unique number used for identifying and
@@ -131,48 +146,16 @@ declare class Order {
     }): Promise<SendOtpToCustomerResponse>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {string} arg.orderId - A unique number used for identifying and
-     *   tracking your orders.
      * @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 {VerifyOtp} arg.body
-     * @returns {Promise<VerifyOtpResponse>} - Success response
-     * @summary: Verify Otp code
-     * @description: Use this API to verify OTP and create a session token with custom payload.
-     */
-    verifyOtpShipmentCustomer({ orderId, shipmentId, body }?: {
-        orderId: string;
-        shipmentId: string;
-        body: VerifyOtp;
-    }): Promise<VerifyOtpResponse>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.shipmentId - 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.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.
-     * @returns {Promise<ShipmentBagReasons>} - 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.
-     */
-    getShipmentBagReasons({ shipmentId, bagId }?: {
-        shipmentId: string;
-        bagId: string;
-    }): Promise<ShipmentBagReasons>;
-    /**
-     * @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.
-     * @returns {Promise<ShipmentReasons>} - 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.
+     * @returns {Promise<ShipmentTrack>} - Success response
+     * @summary: Track shipment
+     * @description: Track Shipment by shipment id, for application based on application Id
      */
-    getShipmentReasons({ shipmentId }?: {
+    trackShipment({ shipmentId }?: {
         shipmentId: string;
-    }): Promise<ShipmentReasons>;
+    }): Promise<ShipmentTrack>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.shipmentId - ID of the shipment. An order may contain
@@ -187,4 +170,21 @@ declare class Order {
         shipmentId: string;
         body: UpdateShipmentStatusRequest;
     }): Promise<ShipmentApplicationStatusResponse>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.orderId - A unique number used for identifying and
+     *   tracking your orders.
+     * @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 {VerifyOtp} arg.body
+     * @returns {Promise<VerifyOtpResponse>} - Success response
+     * @summary: Verify Otp code
+     * @description: Use this API to verify OTP and create a session token with custom payload.
+     */
+    verifyOtpShipmentCustomer({ orderId, shipmentId, body }?: {
+        orderId: string;
+        shipmentId: string;
+        body: VerifyOtp;
+    }): Promise<VerifyOtpResponse>;
 }