@gofynd/fdk-client-javascript 0.1.35

package/sdk/application/client/LogisticApplicationClient.js

@@ -0,0 +1,128 @@
+const APIClient = require("../ApplicationAPIClient");
+const Paginator = require("../../common/Paginator");
+const constructUrl = require("../constructUrl");
+const { FDKClientValidationError } = require("../../common/FDKError");
+const LogisticValidator = require("../models/LogisticValidator");
+
+class Logistic {
+  constructor(_conf) {
+    this._conf = _conf;
+    this._relativeUrls = {
+      getTatProduct: "/service/application/logistics/v1.0",
+      getPincodeZones: "/service/application/logistics/v1.0/pincode/zones",
+      getPincodeCity: "/service/application/logistics/v1.0/pincode/{pincode}",
+    };
+    this._urls = Object.entries(this._relativeUrls).reduce(
+      (urls, [method, relativeUrl]) => {
+        urls[method] = `${_conf.domain}${relativeUrl}`;
+        return urls;
+      },
+      {}
+    );
+  }
+
+  updateUrls(urls) {
+    this._urls = {
+      ...this._urls,
+      ...urls,
+    };
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {GetTatProductReqBody} arg.body
+   * @returns {Promise<GetTatProductResponse>} - Success response
+   * @summary: Get TAT of a product
+   * @description: Use this API to know the delivery turnaround time (TAT) by entering the product details along with the PIN Code of the location.
+   */
+  getTatProduct({ body } = {}) {
+    const { error } = LogisticValidator.getTatProduct().validate(
+      { body },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+    const query_params = {};
+
+    const xHeaders = {};
+
+    return APIClient.execute(
+      this._conf,
+      "post",
+      constructUrl({
+        url: this._urls["getTatProduct"],
+        params: {},
+      }),
+      query_params,
+      body,
+      xHeaders
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {GetPincodeZonesReqBody} arg.body
+   * @returns {Promise<GetPincodeZonesResponse>} - Success response
+   * @summary: Get Pincode Zones
+   * @description: Get to know the zones of a specefic pincode
+   */
+  getPincodeZones({ body } = {}) {
+    const { error } = LogisticValidator.getPincodeZones().validate(
+      { body },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+    const query_params = {};
+
+    const xHeaders = {};
+
+    return APIClient.execute(
+      this._conf,
+      "post",
+      constructUrl({
+        url: this._urls["getPincodeZones"],
+        params: {},
+      }),
+      query_params,
+      body,
+      xHeaders
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.pincode - The PIN Code of the area, e.g. 400059
+   * @returns {Promise<GetPincodeCityResponse>} - Success response
+   * @summary: Get city from PIN Code
+   * @description: Use this API to retrieve a city by its PIN Code.
+   */
+  getPincodeCity({ pincode } = {}) {
+    const { error } = LogisticValidator.getPincodeCity().validate(
+      { pincode },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+    const query_params = {};
+
+    const xHeaders = {};
+
+    return APIClient.execute(
+      this._conf,
+      "get",
+      constructUrl({
+        url: this._urls["getPincodeCity"],
+        params: { pincode },
+      }),
+      query_params,
+      undefined,
+      xHeaders
+    );
+  }
+}
+
+module.exports = Logistic;

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

@@ -0,0 +1,190 @@
+export = Order;
+declare class Order {
+    constructor(_conf: any);
+    _conf: any;
+    _relativeUrls: {
+        getOrders: string;
+        getOrderById: string;
+        getPosOrderById: string;
+        getShipmentById: string;
+        getInvoiceByShipmentId: string;
+        trackShipment: string;
+        getCustomerDetailsByShipmentId: string;
+        sendOtpToShipmentCustomer: string;
+        verifyOtpShipmentCustomer: string;
+        getShipmentBagReasons: string;
+        getShipmentReasons: string;
+        updateShipmentStatus: string;
+    };
+    _urls: {};
+    updateUrls(urls: any): void;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {number} [arg.status] - A filter to retrieve orders by their
+     *   current status such as *placed*, *delivered*, etc.
+     * @param {number} [arg.pageNo] - The page number to navigate through the
+     *   given set of results. Default value is 1.
+     * @param {number} [arg.pageSize] - The number of items to retrieve in each
+     *   page. Default value is 10.
+     * @param {string} [arg.fromDate] - The date from which the orders should be
+     *   retrieved.
+     * @param {string} [arg.toDate] - The date till which the orders should be retrieved.
+     * @param {string} [arg.customMeta] - A filter and retrieve data using
+     *   special fields included for special use-cases
+     * @returns {Promise<OrderList>} - Success response
+     * @summary: Get all orders
+     * @description: Use this API to retrieve all the orders.
+     */
+    getOrders({ status, pageNo, pageSize, fromDate, toDate, customMeta }?: {
+        status?: number;
+        pageNo?: number;
+        pageSize?: number;
+        fromDate?: string;
+        toDate?: string;
+        customMeta?: string;
+    }): Promise<any>;
+    /**
+     * @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<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.orderId - A unique number used for identifying and
+     *   tracking your orders.
+     * @returns {Promise<OrderList>} - Success response
+     * @summary: Get POS Order
+     * @description: Use this API to retrieve a POS order and all its details such as tracking details, shipment, store information using Fynd Order ID.
+     */
+    getPosOrderById({ orderId }?: {
+        orderId: string;
+    }): Promise<any>;
+    /**
+     * @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<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<any>;
+    /**
+     * @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<any>;
+    /**
+     * @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
+     */
+    trackShipment({ shipmentId }?: {
+        shipmentId: string;
+    }): Promise<any>;
+    /**
+     * @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<any>;
+    /**
+     * @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.
+     * @returns {Promise<SendOtpToCustomerResponse>} - Success response
+     * @summary: Send and Resend Otp code to Order-Shipment customer
+     * @description: Use this API to send OTP to the customer of the mapped Shipment.
+     */
+    sendOtpToShipmentCustomer({ orderId, shipmentId }?: {
+        orderId: string;
+        shipmentId: string;
+    }): Promise<any>;
+    /**
+     * @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: any;
+    }): Promise<any>;
+    /**
+     * @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<any>;
+    /**
+     * @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.
+     */
+    getShipmentReasons({ shipmentId }?: {
+        shipmentId: string;
+    }): Promise<any>;
+    /**
+     * @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 {UpdateShipmentStatusRequest} arg.body
+     * @returns {Promise<ShipmentApplicationStatusResponse>} - Success response
+     * @summary: Update the shipment status
+     * @description: Use this API to update the status of a shipment using its shipment ID.
+     */
+    updateShipmentStatus({ shipmentId, body }?: {
+        shipmentId: string;
+        body: any;
+    }): Promise<any>;
+}