@gofynd/fdk-client-javascript 1.6.4 → 3.1.0-beta.1

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

@@ -8,9 +8,11 @@ declare class Order {
         getOrderById: string;
         getOrders: string;
         getPosOrderById: string;
+        getRefundOptions: string;
         getShipmentBagReasons: string;
         getShipmentById: string;
         getShipmentReasons: string;
+        getShipmentRefundSummary: string;
         sendOtpToShipmentCustomer: string;
         trackShipment: string;
         updateShipmentStatus: string;
@@ -21,18 +23,18 @@ declare class Order {
     /**
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../ApplicationAPIClient").Options} - Options
-     * @returns {Promise<CustomerDetailsResponseSchema>} - Success response
+     * @returns {Promise<CustomerDetailsResponse>} - Success response
      * @name getCustomerDetailsByShipmentId
-     * @summary: Get shipment's customer
+     * @summary: Retrieves shipment customer.
      * @description: Get customer details such as mobile number using Shipment ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getCustomerDetailsByShipmentId/).
      */
-    getCustomerDetailsByShipmentId({ orderId, shipmentId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<CustomerDetailsResponseSchema>;
+    getCustomerDetailsByShipmentId({ orderId, shipmentId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<CustomerDetailsResponse>;
     /**
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../ApplicationAPIClient").Options} - Options
      * @returns {Promise<ResponseGetInvoiceShipment>} - Success response
      * @name getInvoiceByShipmentId
-     * @summary: Retrieves invoice for shipment
+     * @summary: Retrieves invoice for shipment.
      * @description: Get invoice corresponding to a specific shipment ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getInvoiceByShipmentId/).
      */
     getInvoiceByShipmentId({ shipmentId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ResponseGetInvoiceShipment>;
@@ -41,7 +43,7 @@ declare class Order {
      * @param {import("../ApplicationAPIClient").Options} - Options
      * @returns {Promise<OrderById>} - Success response
      * @name getOrderById
-     * @summary: Get an order
+     * @summary: Fetches order by ID.
      * @description: Get order details such as tracking details, shipment, store information using Fynd Order ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getOrderById/).
      */
     getOrderById({ orderId, allowInactive, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<OrderById>;
@@ -50,26 +52,35 @@ declare class Order {
      * @param {import("../ApplicationAPIClient").Options} - Options
      * @returns {Promise<OrderList>} - Success response
      * @name getOrders
-     * @summary: List customer orders
+     * @summary: Lists customer orders.
      * @description: Get all orders associated with a customer account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getOrders/).
      */
-    getOrders({ status, pageNo, pageSize, fromDate, toDate, startDate, endDate, customMeta, allowInactive, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<OrderList>;
+    getOrders({ status, pageNo, pageSize, fromDate, toDate, startDate, endDate, customMeta, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<OrderList>;
     /**
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../ApplicationAPIClient").Options} - Options
      * @returns {Promise<OrderById>} - Success response
      * @name getPosOrderById
-     * @summary: Retrieves POS order details
+     * @summary: Retrieves POS order details.
      * @description: Retrieve a POS order and all its details such as tracking details, shipment, store information using Fynd Order ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getPosOrderById/).
      */
     getPosOrderById({ orderId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<OrderById>;
+    /**
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../ApplicationAPIClient").Options} - Options
+     * @returns {Promise<RefundOptionsSchemaResponse>} - Success response
+     * @name getRefundOptions
+     * @summary: Retrieve refund options with amount breakup for  specific shipment and bags.
+     * @description: This API can be used for giving the refund amount with available option of MOPs. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getRefundOptions/).
+     */
+    getRefundOptions({ shipmentId, bagIds, state, optinAppId, optinCompanyId, status, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<RefundOptionsSchemaResponse>;
     /**
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../ApplicationAPIClient").Options} - Options
      * @returns {Promise<ShipmentBagReasons>} - Success response
      * @name getShipmentBagReasons
-     * @summary: Retrieve Reasons for Cancellation and Return journey
-     * @description: Allows users to retrieve a comprehensive list of reasons for cancellation  or returning a shipment. It provides both cancellation and return reasons, with an emphasis  on Quality Control (QC) evaluations. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getShipmentBagReasons/).
+     * @summary: Lists bag reasons.
+     * @description: Get reasons to perform full or partial cancellation of a bag. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getShipmentBagReasons/).
      */
     getShipmentBagReasons({ shipmentId, bagId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ShipmentBagReasons>;
     /**
@@ -77,7 +88,7 @@ declare class Order {
      * @param {import("../ApplicationAPIClient").Options} - Options
      * @returns {Promise<ShipmentById>} - Success response
      * @name getShipmentById
-     * @summary: Get a Shipment
+     * @summary: Fetches shipment by ID.
      * @description: Get shipment details such as price breakup, tracking details, store information, etc. using Shipment ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getShipmentById/).
      */
     getShipmentById({ shipmentId, allowInactive, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ShipmentById>;
@@ -86,44 +97,53 @@ declare class Order {
      * @param {import("../ApplicationAPIClient").Options} - Options
      * @returns {Promise<ShipmentReasons>} - Success response
      * @name getShipmentReasons
-     * @summary: List shipment cancellation reasons
+     * @summary: Lists shipment reasons.
      * @description: Get reasons to perform full or partial cancellation of a shipment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getShipmentReasons/).
      */
     getShipmentReasons({ shipmentId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ShipmentReasons>;
     /**
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../ApplicationAPIClient").Options} - Options
-     * @returns {Promise<SendOtpToCustomerResponseSchema>} - Success response
+     * @returns {Promise<ShipmentRefundSummaryResponse>} - Success response
+     * @name getShipmentRefundSummary
+     * @summary: Retreives shipment's refund summary.
+     * @description: Retreives shipment's refund summary using its shipment ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getShipmentRefundSummary/).
+     */
+    getShipmentRefundSummary({ shipmentId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ShipmentRefundSummaryResponse>;
+    /**
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../ApplicationAPIClient").Options} - Options
+     * @returns {Promise<SendOtpToCustomerResponse>} - Success response
      * @name sendOtpToShipmentCustomer
-     * @summary: Send OTP to customer
+     * @summary: Sends OTP to customer.
      * @description: Send OTP to the customer for shipment verification. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/sendOtpToShipmentCustomer/).
      */
-    sendOtpToShipmentCustomer({ orderId, shipmentId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<SendOtpToCustomerResponseSchema>;
+    sendOtpToShipmentCustomer({ orderId, shipmentId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<SendOtpToCustomerResponse>;
     /**
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../ApplicationAPIClient").Options} - Options
      * @returns {Promise<ShipmentTrack>} - Success response
      * @name trackShipment
-     * @summary: Track shipment status
+     * @summary: Tracks shipment status.
      * @description: Track Shipment by shipment id, for application based on application Id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/trackShipment/).
      */
     trackShipment({ shipmentId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ShipmentTrack>;
     /**
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../ApplicationAPIClient").Options} - Options
-     * @returns {Promise<ShipmentApplicationStatusResponseSchema>} - Success response
+     * @returns {Promise<ShipmentApplicationStatusResponse>} - Success response
      * @name updateShipmentStatus
-     * @summary: Updates shipment status
-     * @description: This operation allows for updating the status and properties of a shipment.  For example, it allows users to initiate a return by providing reasons and  uploading quality check images. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/updateShipmentStatus/).
+     * @summary: Updates shipment status.
+     * @description: Update current status of a specific shipment using its shipment ID. Supports both partial and full transition as per the configured settings. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/updateShipmentStatus/).
      */
-    updateShipmentStatus({ shipmentId, body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ShipmentApplicationStatusResponseSchema>;
+    updateShipmentStatus({ shipmentId, body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ShipmentApplicationStatusResponse>;
     /**
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../ApplicationAPIClient").Options} - Options
-     * @returns {Promise<VerifyOtpResponseSchema>} - Success response
+     * @returns {Promise<VerifyOtpResponse>} - Success response
      * @name verifyOtpShipmentCustomer
-     * @summary: Verifies OTP
-     * @description: Verify OTP for getting shipment details - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/verifyOtpShipmentCustomer/).
+     * @summary: Verifies OTP.
+     * @description: Verify OTP sent by customer. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/verifyOtpShipmentCustomer/).
      */
-    verifyOtpShipmentCustomer({ orderId, shipmentId, body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<VerifyOtpResponseSchema>;
+    verifyOtpShipmentCustomer({ orderId, shipmentId, body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<VerifyOtpResponse>;
 }

package/sdk/application/Order/OrderApplicationClient.js

@@ -19,12 +19,16 @@ class Order {
       getOrders: "/service/application/order/v1.0/orders",
       getPosOrderById:
         "/service/application/order/v1.0/orders/pos-order/{order_id}",
+      getRefundOptions:
+        "/service/application/order-manage/v1.0/shipment/{shipment_id}/refund-options",
       getShipmentBagReasons:
         "/service/application/order/v1.0/orders/shipments/{shipment_id}/bags/{bag_id}/reasons",
       getShipmentById:
         "/service/application/order/v1.0/orders/shipments/{shipment_id}",
       getShipmentReasons:
         "/service/application/order/v1.0/orders/shipments/{shipment_id}/reasons",
+      getShipmentRefundSummary:
+        "/service/application/order-manage/v1.0/shipment/{shipment_id}/refund-summary",
       sendOtpToShipmentCustomer:
         "/service/application/order/v1.0/orders/{order_id}/shipments/{shipment_id}/otp/send/",
       trackShipment:
@@ -53,9 +57,9 @@ class Order {
   /**
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<CustomerDetailsResponseSchema>} - Success response
+   * @returns {Promise<CustomerDetailsResponse>} - Success response
    * @name getCustomerDetailsByShipmentId
-   * @summary: Get shipment's customer
+   * @summary: Retrieves shipment customer.
    * @description: Get customer details such as mobile number using Shipment ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getCustomerDetailsByShipmentId/).
    */
   async getCustomerDetailsByShipmentId(
@@ -113,7 +117,7 @@ class Order {
    * @param {import("../ApplicationAPIClient").Options} - Options
    * @returns {Promise<ResponseGetInvoiceShipment>} - Success response
    * @name getInvoiceByShipmentId
-   * @summary: Retrieves invoice for shipment
+   * @summary: Retrieves invoice for shipment.
    * @description: Get invoice corresponding to a specific shipment ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getInvoiceByShipmentId/).
    */
   async getInvoiceByShipmentId(
@@ -165,7 +169,7 @@ class Order {
    * @param {import("../ApplicationAPIClient").Options} - Options
    * @returns {Promise<OrderById>} - Success response
    * @name getOrderById
-   * @summary: Get an order
+   * @summary: Fetches order by ID.
    * @description: Get order details such as tracking details, shipment, store information using Fynd Order ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getOrderById/).
    */
   async getOrderById(
@@ -218,7 +222,7 @@ class Order {
    * @param {import("../ApplicationAPIClient").Options} - Options
    * @returns {Promise<OrderList>} - Success response
    * @name getOrders
-   * @summary: List customer orders
+   * @summary: Lists customer orders.
    * @description: Get all orders associated with a customer account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getOrders/).
    */
   async getOrders(
@@ -231,7 +235,6 @@ class Order {
       startDate,
       endDate,
       customMeta,
-      allowInactive,
       requestHeaders,
     } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
@@ -253,7 +256,6 @@ class Order {
     query_params["start_date"] = startDate;
     query_params["end_date"] = endDate;
     query_params["custom_meta"] = customMeta;
-    query_params["allow_inactive"] = allowInactive;
 
     const xHeaders = {};
 
@@ -283,7 +285,7 @@ class Order {
    * @param {import("../ApplicationAPIClient").Options} - Options
    * @returns {Promise<OrderById>} - Success response
    * @name getPosOrderById
-   * @summary: Retrieves POS order details
+   * @summary: Retrieves POS order details.
    * @description: Retrieve a POS order and all its details such as tracking details, shipment, store information using Fynd Order ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getPosOrderById/).
    */
   async getPosOrderById(
@@ -330,13 +332,78 @@ class Order {
     return response;
   }
 
+  /**
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../ApplicationAPIClient").Options} - Options
+   * @returns {Promise<RefundOptionsSchemaResponse>} - Success response
+   * @name getRefundOptions
+   * @summary: Retrieve refund options with amount breakup for  specific shipment and bags.
+   * @description: This API can be used for giving the refund amount with available option of MOPs. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getRefundOptions/).
+   */
+  async getRefundOptions(
+    {
+      shipmentId,
+      bagIds,
+      state,
+      optinAppId,
+      optinCompanyId,
+      status,
+      requestHeaders,
+    } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    let invalidInput = [];
+
+    if (!shipmentId) {
+      invalidInput.push({
+        message: `The 'shipmentId' field is required.`,
+        path: ["shipmentId"],
+      });
+    }
+    if (invalidInput.length) {
+      const error = new Error();
+      error.message = "Missing required field";
+      error.details = invalidInput;
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+    query_params["bag_ids"] = bagIds;
+    query_params["state"] = state;
+    query_params["optin_app_id"] = optinAppId;
+    query_params["optin_company_id"] = optinCompanyId;
+    query_params["status"] = status;
+
+    const xHeaders = {};
+
+    const response = await ApplicationAPIClient.execute(
+      this._conf,
+      "get",
+      constructUrl({
+        url: this._urls["getRefundOptions"],
+        params: { shipmentId },
+      }),
+      query_params,
+      undefined,
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    return response;
+  }
+
   /**
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
    * @returns {Promise<ShipmentBagReasons>} - Success response
    * @name getShipmentBagReasons
-   * @summary: Retrieve Reasons for Cancellation and Return journey
-   * @description: Allows users to retrieve a comprehensive list of reasons for cancellation  or returning a shipment. It provides both cancellation and return reasons, with an emphasis  on Quality Control (QC) evaluations. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getShipmentBagReasons/).
+   * @summary: Lists bag reasons.
+   * @description: Get reasons to perform full or partial cancellation of a bag. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getShipmentBagReasons/).
    */
   async getShipmentBagReasons(
     { shipmentId, bagId, requestHeaders } = { requestHeaders: {} },
@@ -393,7 +460,7 @@ class Order {
    * @param {import("../ApplicationAPIClient").Options} - Options
    * @returns {Promise<ShipmentById>} - Success response
    * @name getShipmentById
-   * @summary: Get a Shipment
+   * @summary: Fetches shipment by ID.
    * @description: Get shipment details such as price breakup, tracking details, store information, etc. using Shipment ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getShipmentById/).
    */
   async getShipmentById(
@@ -446,7 +513,7 @@ class Order {
    * @param {import("../ApplicationAPIClient").Options} - Options
    * @returns {Promise<ShipmentReasons>} - Success response
    * @name getShipmentReasons
-   * @summary: List shipment cancellation reasons
+   * @summary: Lists shipment reasons.
    * @description: Get reasons to perform full or partial cancellation of a shipment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getShipmentReasons/).
    */
   async getShipmentReasons(
@@ -496,9 +563,61 @@ class Order {
   /**
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<SendOtpToCustomerResponseSchema>} - Success response
+   * @returns {Promise<ShipmentRefundSummaryResponse>} - Success response
+   * @name getShipmentRefundSummary
+   * @summary: Retreives shipment's refund summary.
+   * @description: Retreives shipment's refund summary using its shipment ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getShipmentRefundSummary/).
+   */
+  async getShipmentRefundSummary(
+    { shipmentId, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    let invalidInput = [];
+
+    if (!shipmentId) {
+      invalidInput.push({
+        message: `The 'shipmentId' field is required.`,
+        path: ["shipmentId"],
+      });
+    }
+    if (invalidInput.length) {
+      const error = new Error();
+      error.message = "Missing required field";
+      error.details = invalidInput;
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+
+    const xHeaders = {};
+
+    const response = await ApplicationAPIClient.execute(
+      this._conf,
+      "get",
+      constructUrl({
+        url: this._urls["getShipmentRefundSummary"],
+        params: { shipmentId },
+      }),
+      query_params,
+      undefined,
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    return response;
+  }
+
+  /**
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../ApplicationAPIClient").Options} - Options
+   * @returns {Promise<SendOtpToCustomerResponse>} - Success response
    * @name sendOtpToShipmentCustomer
-   * @summary: Send OTP to customer
+   * @summary: Sends OTP to customer.
    * @description: Send OTP to the customer for shipment verification. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/sendOtpToShipmentCustomer/).
    */
   async sendOtpToShipmentCustomer(
@@ -556,7 +675,7 @@ class Order {
    * @param {import("../ApplicationAPIClient").Options} - Options
    * @returns {Promise<ShipmentTrack>} - Success response
    * @name trackShipment
-   * @summary: Track shipment status
+   * @summary: Tracks shipment status.
    * @description: Track Shipment by shipment id, for application based on application Id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/trackShipment/).
    */
   async trackShipment(
@@ -606,10 +725,10 @@ class Order {
   /**
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<ShipmentApplicationStatusResponseSchema>} - Success response
+   * @returns {Promise<ShipmentApplicationStatusResponse>} - Success response
    * @name updateShipmentStatus
-   * @summary: Updates shipment status
-   * @description: This operation allows for updating the status and properties of a shipment.  For example, it allows users to initiate a return by providing reasons and  uploading quality check images. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/updateShipmentStatus/).
+   * @summary: Updates shipment status.
+   * @description: Update current status of a specific shipment using its shipment ID. Supports both partial and full transition as per the configured settings. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/updateShipmentStatus/).
    */
   async updateShipmentStatus(
     { shipmentId, body, requestHeaders } = { requestHeaders: {} },
@@ -658,10 +777,10 @@ class Order {
   /**
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<VerifyOtpResponseSchema>} - Success response
+   * @returns {Promise<VerifyOtpResponse>} - Success response
    * @name verifyOtpShipmentCustomer
-   * @summary: Verifies OTP
-   * @description: Verify OTP for getting shipment details - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/verifyOtpShipmentCustomer/).
+   * @summary: Verifies OTP.
+   * @description: Verify OTP sent by customer. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/verifyOtpShipmentCustomer/).
    */
   async verifyOtpShipmentCustomer(
     { orderId, shipmentId, body, requestHeaders } = { requestHeaders: {} },