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

package/sdk/application/Order/OrderApplicationClient.js

@@ -6,6 +6,7 @@ const {
 const ApplicationAPIClient = require("../ApplicationAPIClient");
 const constructUrl = require("../constructUrl");
 const Paginator = require("../../common/Paginator");
+const { validateRequiredParams } = require("../../common/Validator");
 
 class Order {
   constructor(_conf) {
@@ -19,16 +20,12 @@ 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:
@@ -57,33 +54,24 @@ class Order {
   /**
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<CustomerDetailsResponse>} - Success response
+   * @returns {Promise<CustomerDetailsResponseSchema>} - Success response
    * @name getCustomerDetailsByShipmentId
-   * @summary: Retrieves shipment customer.
+   * @summary: Get shipment's 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(
     { orderId, shipmentId, requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
-    let invalidInput = [];
-
-    if (!orderId) {
-      invalidInput.push({
-        message: `The 'orderId' field is required.`,
-        path: ["orderId"],
-      });
-    }
-    if (!shipmentId) {
-      invalidInput.push({
-        message: `The 'shipmentId' field is required.`,
-        path: ["shipmentId"],
+    const errors = validateRequiredParams(arguments[0], [
+      "orderId",
+      "shipmentId",
+    ]);
+    if (errors.length > 0) {
+      const error = new FDKClientValidationError({
+        message: "Missing required field",
+        details: errors,
       });
-    }
-    if (invalidInput.length) {
-      const error = new Error();
-      error.message = "Missing required field";
-      error.details = invalidInput;
       return Promise.reject(new FDKClientValidationError(error));
     }
 
@@ -117,25 +105,19 @@ 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(
     { shipmentId, requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
-    let invalidInput = [];
-
-    if (!shipmentId) {
-      invalidInput.push({
-        message: `The 'shipmentId' field is required.`,
-        path: ["shipmentId"],
+    const errors = validateRequiredParams(arguments[0], ["shipmentId"]);
+    if (errors.length > 0) {
+      const error = new FDKClientValidationError({
+        message: "Missing required field",
+        details: errors,
       });
-    }
-    if (invalidInput.length) {
-      const error = new Error();
-      error.message = "Missing required field";
-      error.details = invalidInput;
       return Promise.reject(new FDKClientValidationError(error));
     }
 
@@ -169,25 +151,19 @@ class Order {
    * @param {import("../ApplicationAPIClient").Options} - Options
    * @returns {Promise<OrderById>} - Success response
    * @name getOrderById
-   * @summary: Fetches order by ID.
+   * @summary: Get an order
    * @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(
     { orderId, allowInactive, requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
-    let invalidInput = [];
-
-    if (!orderId) {
-      invalidInput.push({
-        message: `The 'orderId' field is required.`,
-        path: ["orderId"],
+    const errors = validateRequiredParams(arguments[0], ["orderId"]);
+    if (errors.length > 0) {
+      const error = new FDKClientValidationError({
+        message: "Missing required field",
+        details: errors,
       });
-    }
-    if (invalidInput.length) {
-      const error = new Error();
-      error.message = "Missing required field";
-      error.details = invalidInput;
       return Promise.reject(new FDKClientValidationError(error));
     }
 
@@ -222,7 +198,7 @@ class Order {
    * @param {import("../ApplicationAPIClient").Options} - Options
    * @returns {Promise<OrderList>} - Success response
    * @name getOrders
-   * @summary: Lists customer orders.
+   * @summary: List 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(
@@ -235,18 +211,11 @@ class Order {
       startDate,
       endDate,
       customMeta,
+      allowInactive,
       requestHeaders,
     } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
-    let invalidInput = [];
-    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["status"] = status;
     query_params["page_no"] = pageNo;
@@ -256,6 +225,7 @@ class Order {
     query_params["start_date"] = startDate;
     query_params["end_date"] = endDate;
     query_params["custom_meta"] = customMeta;
+    query_params["allow_inactive"] = allowInactive;
 
     const xHeaders = {};
 
@@ -285,25 +255,19 @@ 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(
     { orderId, requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
-    let invalidInput = [];
-
-    if (!orderId) {
-      invalidInput.push({
-        message: `The 'orderId' field is required.`,
-        path: ["orderId"],
+    const errors = validateRequiredParams(arguments[0], ["orderId"]);
+    if (errors.length > 0) {
+      const error = new FDKClientValidationError({
+        message: "Missing required field",
+        details: errors,
       });
-    }
-    if (invalidInput.length) {
-      const error = new Error();
-      error.message = "Missing required field";
-      error.details = invalidInput;
       return Promise.reject(new FDKClientValidationError(error));
     }
 
@@ -332,101 +296,27 @@ 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: 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/).
+   * @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/).
    */
   async getShipmentBagReasons(
     { shipmentId, bagId, requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
-    let invalidInput = [];
-
-    if (!shipmentId) {
-      invalidInput.push({
-        message: `The 'shipmentId' field is required.`,
-        path: ["shipmentId"],
+    const errors = validateRequiredParams(arguments[0], [
+      "shipmentId",
+      "bagId",
+    ]);
+    if (errors.length > 0) {
+      const error = new FDKClientValidationError({
+        message: "Missing required field",
+        details: errors,
       });
-    }
-    if (!bagId) {
-      invalidInput.push({
-        message: `The 'bagId' field is required.`,
-        path: ["bagId"],
-      });
-    }
-    if (invalidInput.length) {
-      const error = new Error();
-      error.message = "Missing required field";
-      error.details = invalidInput;
       return Promise.reject(new FDKClientValidationError(error));
     }
 
@@ -460,25 +350,19 @@ class Order {
    * @param {import("../ApplicationAPIClient").Options} - Options
    * @returns {Promise<ShipmentById>} - Success response
    * @name getShipmentById
-   * @summary: Fetches shipment by ID.
+   * @summary: Get a Shipment
    * @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(
     { shipmentId, allowInactive, requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
-    let invalidInput = [];
-
-    if (!shipmentId) {
-      invalidInput.push({
-        message: `The 'shipmentId' field is required.`,
-        path: ["shipmentId"],
+    const errors = validateRequiredParams(arguments[0], ["shipmentId"]);
+    if (errors.length > 0) {
+      const error = new FDKClientValidationError({
+        message: "Missing required field",
+        details: errors,
       });
-    }
-    if (invalidInput.length) {
-      const error = new Error();
-      error.message = "Missing required field";
-      error.details = invalidInput;
       return Promise.reject(new FDKClientValidationError(error));
     }
 
@@ -513,25 +397,19 @@ class Order {
    * @param {import("../ApplicationAPIClient").Options} - Options
    * @returns {Promise<ShipmentReasons>} - Success response
    * @name getShipmentReasons
-   * @summary: Lists shipment reasons.
+   * @summary: List shipment cancellation 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(
     { shipmentId, requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
-    let invalidInput = [];
-
-    if (!shipmentId) {
-      invalidInput.push({
-        message: `The 'shipmentId' field is required.`,
-        path: ["shipmentId"],
+    const errors = validateRequiredParams(arguments[0], ["shipmentId"]);
+    if (errors.length > 0) {
+      const error = new FDKClientValidationError({
+        message: "Missing required field",
+        details: errors,
       });
-    }
-    if (invalidInput.length) {
-      const error = new Error();
-      error.message = "Missing required field";
-      error.details = invalidInput;
       return Promise.reject(new FDKClientValidationError(error));
     }
 
@@ -563,85 +441,24 @@ class Order {
   /**
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
-   * @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
+   * @returns {Promise<SendOtpToCustomerResponseSchema>} - Success response
    * @name sendOtpToShipmentCustomer
-   * @summary: Sends OTP to customer.
+   * @summary: Send 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(
     { orderId, shipmentId, requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
-    let invalidInput = [];
-
-    if (!orderId) {
-      invalidInput.push({
-        message: `The 'orderId' field is required.`,
-        path: ["orderId"],
+    const errors = validateRequiredParams(arguments[0], [
+      "orderId",
+      "shipmentId",
+    ]);
+    if (errors.length > 0) {
+      const error = new FDKClientValidationError({
+        message: "Missing required field",
+        details: errors,
       });
-    }
-    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));
     }
 
@@ -675,25 +492,19 @@ class Order {
    * @param {import("../ApplicationAPIClient").Options} - Options
    * @returns {Promise<ShipmentTrack>} - Success response
    * @name trackShipment
-   * @summary: Tracks shipment status.
+   * @summary: Track 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(
     { shipmentId, requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
-    let invalidInput = [];
-
-    if (!shipmentId) {
-      invalidInput.push({
-        message: `The 'shipmentId' field is required.`,
-        path: ["shipmentId"],
+    const errors = validateRequiredParams(arguments[0], ["shipmentId"]);
+    if (errors.length > 0) {
+      const error = new FDKClientValidationError({
+        message: "Missing required field",
+        details: errors,
       });
-    }
-    if (invalidInput.length) {
-      const error = new Error();
-      error.message = "Missing required field";
-      error.details = invalidInput;
       return Promise.reject(new FDKClientValidationError(error));
     }
 
@@ -725,27 +536,21 @@ class Order {
   /**
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<ShipmentApplicationStatusResponse>} - Success response
+   * @returns {Promise<ShipmentApplicationStatusResponseSchema>} - Success response
    * @name 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/).
+   * @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/).
    */
   async updateShipmentStatus(
     { shipmentId, body, requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
-    let invalidInput = [];
-
-    if (!shipmentId) {
-      invalidInput.push({
-        message: `The 'shipmentId' field is required.`,
-        path: ["shipmentId"],
+    const errors = validateRequiredParams(arguments[0], ["shipmentId"]);
+    if (errors.length > 0) {
+      const error = new FDKClientValidationError({
+        message: "Missing required field",
+        details: errors,
       });
-    }
-    if (invalidInput.length) {
-      const error = new Error();
-      error.message = "Missing required field";
-      error.details = invalidInput;
       return Promise.reject(new FDKClientValidationError(error));
     }
 
@@ -777,33 +582,24 @@ class Order {
   /**
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<VerifyOtpResponse>} - Success response
+   * @returns {Promise<VerifyOtpResponseSchema>} - Success response
    * @name verifyOtpShipmentCustomer
-   * @summary: Verifies OTP.
-   * @description: Verify OTP sent by customer. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/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/).
    */
   async verifyOtpShipmentCustomer(
     { orderId, shipmentId, body, requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
-    let invalidInput = [];
-
-    if (!orderId) {
-      invalidInput.push({
-        message: `The 'orderId' field is required.`,
-        path: ["orderId"],
+    const errors = validateRequiredParams(arguments[0], [
+      "orderId",
+      "shipmentId",
+    ]);
+    if (errors.length > 0) {
+      const error = new FDKClientValidationError({
+        message: "Missing required field",
+        details: errors,
       });
-    }
-    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));
     }