@gofynd/fdk-client-javascript 0.1.36 → 1.0.0

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

@@ -0,0 +1,59 @@
+export = Order;
+declare class Order {
+    constructor(config: any, applicationId: any);
+    config: any;
+    applicationId: any;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} [arg.lane] -
+     * @param {string} [arg.searchType] -
+     * @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 {string} [arg.customerId] -
+     * @param {boolean} [arg.isPrioritySort] -
+     * @summary:
+     * @description:
+     */
+    getApplicationShipments({ lane, searchType, searchId, fromDate, toDate, dpIds, orderingCompanyId, stores, salesChannel, requestByExt, pageNo, pageSize, customerId, isPrioritySort, }?: {
+        lane?: string;
+        searchType?: string;
+        searchId?: string;
+        fromDate?: string;
+        toDate?: string;
+        dpIds?: string;
+        orderingCompanyId?: string;
+        stores?: string;
+        salesChannel?: string;
+        requestByExt?: string;
+        pageNo?: number;
+        pageSize?: number;
+        customerId?: string;
+        isPrioritySort?: boolean;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.orderId -
+     * @summary:
+     * @description:
+     */
+    getAppOrderShipmentDetails({ orderId }?: {
+        orderId: string;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.shipmentId -
+     * @summary: Track shipment
+     * @description: Track Shipment by shipment id, for application based on application Id
+     */
+    trackPlatformShipment({ shipmentId }?: {
+        shipmentId: string;
+    }): Promise<any>;
+}

package/sdk/platform/Order/OrderPlatformApplicationClient.js

@@ -0,0 +1,152 @@
+const Paginator = require("../../common/Paginator");
+const PlatformAPIClient = require("../PlatformAPIClient");
+const { FDKClientValidationError } = require("../../common/FDKError");
+const OrderValidator = require("./OrderPlatformApplicationValidator");
+
+class Order {
+  constructor(config, applicationId) {
+    this.config = config;
+    this.applicationId = applicationId;
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} [arg.lane] -
+   * @param {string} [arg.searchType] -
+   * @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 {string} [arg.customerId] -
+   * @param {boolean} [arg.isPrioritySort] -
+   * @summary:
+   * @description:
+   */
+  getApplicationShipments({
+    lane,
+    searchType,
+    searchId,
+    fromDate,
+    toDate,
+    dpIds,
+    orderingCompanyId,
+    stores,
+    salesChannel,
+    requestByExt,
+    pageNo,
+    pageSize,
+    customerId,
+    isPrioritySort,
+  } = {}) {
+    const { error } = OrderValidator.getApplicationShipments().validate(
+      {
+        lane,
+        searchType,
+        searchId,
+        fromDate,
+        toDate,
+        dpIds,
+        orderingCompanyId,
+        stores,
+        salesChannel,
+        requestByExt,
+        pageNo,
+        pageSize,
+        customerId,
+        isPrioritySort,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+    query_params["lane"] = lane;
+    query_params["search_type"] = searchType;
+    query_params["search_id"] = searchId;
+    query_params["from_date"] = fromDate;
+    query_params["to_date"] = toDate;
+    query_params["dp_ids"] = dpIds;
+    query_params["ordering_company_id"] = orderingCompanyId;
+    query_params["stores"] = stores;
+    query_params["sales_channel"] = salesChannel;
+    query_params["request_by_ext"] = requestByExt;
+    query_params["page_no"] = pageNo;
+    query_params["page_size"] = pageSize;
+    query_params["customer_id"] = customerId;
+    query_params["is_priority_sort"] = isPrioritySort;
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/orders/v1.0/company/${this.config.companyId}/application/${this.applicationId}/shipments/`,
+      query_params,
+      undefined
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.orderId -
+   * @summary:
+   * @description:
+   */
+  getAppOrderShipmentDetails({ orderId } = {}) {
+    const { error } = OrderValidator.getAppOrderShipmentDetails().validate(
+      {
+        orderId,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+    query_params["order_id"] = orderId;
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/orders/v1.0/company/${this.config.companyId}/application/${this.applicationId}/order-details`,
+      query_params,
+      undefined
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.shipmentId -
+   * @summary: Track shipment
+   * @description: Track Shipment by shipment id, for application based on application Id
+   */
+  trackPlatformShipment({ shipmentId } = {}) {
+    const { error } = OrderValidator.trackPlatformShipment().validate(
+      {
+        shipmentId,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/orders/v1.0/company/${this.config.companyId}/application/${this.applicationId}/orders/shipments/${shipmentId}/track`,
+      query_params,
+      undefined
+    );
+  }
+}
+module.exports = Order;

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

@@ -0,0 +1,6 @@
+export = OrderValidator;
+declare class OrderValidator {
+    static getApplicationShipments(): any;
+    static getAppOrderShipmentDetails(): any;
+    static trackPlatformShipment(): any;
+}

package/sdk/platform/Order/OrderPlatformApplicationValidator.js

@@ -0,0 +1,37 @@
+const Joi = require("joi");
+const OrderModel = require("./OrderPlatformModel");
+
+class OrderValidator {
+  static getApplicationShipments() {
+    return Joi.object({
+      lane: Joi.string().allow(""),
+      searchType: Joi.string().allow(""),
+      searchId: Joi.string().allow(""),
+      fromDate: Joi.string().allow(""),
+      toDate: Joi.string().allow(""),
+      dpIds: Joi.string().allow(""),
+      orderingCompanyId: Joi.string().allow(""),
+      stores: Joi.string().allow(""),
+      salesChannel: Joi.string().allow(""),
+      requestByExt: Joi.string().allow(""),
+      pageNo: Joi.number(),
+      pageSize: Joi.number(),
+      customerId: Joi.string().allow(""),
+      isPrioritySort: Joi.boolean(),
+    }).required();
+  }
+
+  static getAppOrderShipmentDetails() {
+    return Joi.object({
+      orderId: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  static trackPlatformShipment() {
+    return Joi.object({
+      shipmentId: Joi.string().allow("").required(),
+    }).required();
+  }
+}
+
+module.exports = OrderValidator;

package/sdk/platform/{client → Order}/OrderPlatformClient.d.ts

@@ -100,6 +100,10 @@ declare class Order {
      * @param {Object} arg - Arg object.
      * @param {string} [arg.lane] -
      * @param {string} [arg.searchType] -
+     * @param {string} [arg.bagStatus] -
+     * @param {string} [arg.timeToDispatch] -
+     * @param {string} [arg.paymentMethods] -
+     * @param {string} [arg.tags] -
      * @param {string} [arg.searchValue] -
      * @param {string} [arg.fromDate] -
      * @param {string} [arg.toDate] -
@@ -113,9 +117,13 @@ declare class Order {
      * @summary:
      * @description:
      */
-    getOrders({ lane, searchType, searchValue, fromDate, toDate, dpIds, stores, salesChannel, pageNo, pageSize, isPrioritySort, customMeta, }?: {
+    getOrders({ lane, searchType, bagStatus, timeToDispatch, paymentMethods, tags, searchValue, fromDate, toDate, dpIds, stores, salesChannel, pageNo, pageSize, isPrioritySort, customMeta, }?: {
         lane?: string;
         searchType?: string;
+        bagStatus?: string;
+        timeToDispatch?: string;
+        paymentMethods?: string;
+        tags?: string;
         searchValue?: string;
         fromDate?: string;
         toDate?: string;
@@ -270,54 +278,6 @@ declare class Order {
         customerId?: string;
         isPrioritySort?: boolean;
     }): Promise<any>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {string} [arg.status] -
-     * @param {number} [arg.storeId] -
-     * @param {number} [arg.pageNo] -
-     * @param {number} [arg.pageSize] -
-     * @param {string} [arg.searchValue] -
-     * @param {string} [arg.fromDate] -
-     * @param {string} [arg.toDate] -
-     * @summary:
-     * @description:
-     */
-    getManifestList({ status, storeId, pageNo, pageSize, searchValue, fromDate, toDate, }?: {
-        status?: string;
-        storeId?: number;
-        pageNo?: number;
-        pageSize?: number;
-        searchValue?: string;
-        fromDate?: string;
-        toDate?: string;
-    }): Promise<any>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.manifestId -
-     * @param {string} [arg.fromDate] -
-     * @param {string} [arg.toDate] -
-     * @param {number} arg.storeId -
-     * @param {number} [arg.page] -
-     * @param {number} [arg.pageSize] -
-     * @param {string} [arg.lane] -
-     * @param {number} [arg.dpIds] -
-     * @param {string} [arg.searchType] -
-     * @param {string} [arg.searchValue] -
-     * @summary:
-     * @description:
-     */
-    getManifestDetailsWithShipments({ manifestId, storeId, fromDate, toDate, page, pageSize, lane, dpIds, searchType, searchValue, }?: {
-        manifestId: string;
-        fromDate?: string;
-        toDate?: string;
-        storeId: number;
-        page?: number;
-        pageSize?: number;
-        lane?: string;
-        dpIds?: number;
-        searchType?: string;
-        searchValue?: string;
-    }): Promise<any>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.batchId -

package/sdk/platform/{client → Order}/OrderPlatformClient.js

@@ -1,7 +1,7 @@
 const Paginator = require("../../common/Paginator");
-const PlatformAPIClient = require("../PlatformAPIClient");
 const { FDKClientValidationError } = require("../../common/FDKError");
-const OrderValidator = require("../models/OrderValidator");
+const PlatformAPIClient = require("../PlatformAPIClient");
+const OrderValidator = require("./OrderPlatformValidator");
 class Order {
   constructor(config) {
     this.config = config;
@@ -261,6 +261,10 @@ class Order {
    * @param {Object} arg - Arg object.
    * @param {string} [arg.lane] -
    * @param {string} [arg.searchType] -
+   * @param {string} [arg.bagStatus] -
+   * @param {string} [arg.timeToDispatch] -
+   * @param {string} [arg.paymentMethods] -
+   * @param {string} [arg.tags] -
    * @param {string} [arg.searchValue] -
    * @param {string} [arg.fromDate] -
    * @param {string} [arg.toDate] -
@@ -277,6 +281,10 @@ class Order {
   getOrders({
     lane,
     searchType,
+    bagStatus,
+    timeToDispatch,
+    paymentMethods,
+    tags,
     searchValue,
     fromDate,
     toDate,
@@ -292,6 +300,10 @@ class Order {
       {
         lane,
         searchType,
+        bagStatus,
+        timeToDispatch,
+        paymentMethods,
+        tags,
         searchValue,
         fromDate,
         toDate,
@@ -312,6 +324,10 @@ class Order {
     const query_params = {};
     query_params["lane"] = lane;
     query_params["search_type"] = searchType;
+    query_params["bag_status"] = bagStatus;
+    query_params["time_to_dispatch"] = timeToDispatch;
+    query_params["payment_methods"] = paymentMethods;
+    query_params["tags"] = tags;
     query_params["search_value"] = searchValue;
     query_params["from_date"] = fromDate;
     query_params["to_date"] = toDate;
@@ -745,134 +761,6 @@ class Order {
     );
   }
 
-  /**
-   * @param {Object} arg - Arg object.
-   * @param {string} [arg.status] -
-   * @param {number} [arg.storeId] -
-   * @param {number} [arg.pageNo] -
-   * @param {number} [arg.pageSize] -
-   * @param {string} [arg.searchValue] -
-   * @param {string} [arg.fromDate] -
-   * @param {string} [arg.toDate] -
-   * @summary:
-   * @description:
-   */
-  getManifestList({
-    status,
-    storeId,
-    pageNo,
-    pageSize,
-    searchValue,
-    fromDate,
-    toDate,
-  } = {}) {
-    const { error } = OrderValidator.getManifestList().validate(
-      {
-        status,
-        storeId,
-        pageNo,
-        pageSize,
-        searchValue,
-        fromDate,
-        toDate,
-      },
-      { abortEarly: false, allowUnknown: true }
-    );
-    if (error) {
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
-    const query_params = {};
-    query_params["status"] = status;
-    query_params["store_id"] = storeId;
-    query_params["page_no"] = pageNo;
-    query_params["page_size"] = pageSize;
-    query_params["search_value"] = searchValue;
-    query_params["from_date"] = fromDate;
-    query_params["to_date"] = toDate;
-
-    const xHeaders = {};
-
-    return PlatformAPIClient.execute(
-      this.config,
-      "get",
-      `/service/platform/orders/v1.0/company/${this.config.companyId}/generated-manifests`,
-      query_params,
-      undefined,
-      xHeaders
-    );
-  }
-
-  /**
-   * @param {Object} arg - Arg object.
-   * @param {string} arg.manifestId -
-   * @param {string} [arg.fromDate] -
-   * @param {string} [arg.toDate] -
-   * @param {number} arg.storeId -
-   * @param {number} [arg.page] -
-   * @param {number} [arg.pageSize] -
-   * @param {string} [arg.lane] -
-   * @param {number} [arg.dpIds] -
-   * @param {string} [arg.searchType] -
-   * @param {string} [arg.searchValue] -
-   * @summary:
-   * @description:
-   */
-  getManifestDetailsWithShipments({
-    manifestId,
-    storeId,
-    fromDate,
-    toDate,
-    page,
-    pageSize,
-    lane,
-    dpIds,
-    searchType,
-    searchValue,
-  } = {}) {
-    const { error } = OrderValidator.getManifestDetailsWithShipments().validate(
-      {
-        manifestId,
-        storeId,
-        fromDate,
-        toDate,
-        page,
-        pageSize,
-        lane,
-        dpIds,
-        searchType,
-        searchValue,
-      },
-      { abortEarly: false, allowUnknown: true }
-    );
-    if (error) {
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
-    const query_params = {};
-    query_params["manifest_id"] = manifestId;
-    query_params["from_date"] = fromDate;
-    query_params["to_date"] = toDate;
-    query_params["store_id"] = storeId;
-    query_params["page"] = page;
-    query_params["page_size"] = pageSize;
-    query_params["lane"] = lane;
-    query_params["dp_ids"] = dpIds;
-    query_params["search_type"] = searchType;
-    query_params["search_value"] = searchValue;
-
-    const xHeaders = {};
-
-    return PlatformAPIClient.execute(
-      this.config,
-      "get",
-      `/service/platform/orders/v1.0/company/${this.config.companyId}/manifest-details`,
-      query_params,
-      undefined,
-      xHeaders
-    );
-  }
-
   /**
    * @param {Object} arg - Arg object.
    * @param {string} arg.batchId -