@gofynd/fdk-client-javascript 1.6.3 → 2.0.0

package/sdk/platform/Lead/LeadPlatformModel.d.ts

@@ -47,6 +47,7 @@ export = LeadPlatformModel;
  * @property {number} [current] - The current page number.
  * @property {string} type - The type of the page, such as 'PageType'.
  * @property {number} [size] - The number of items per page.
+ * @property {number} [page_size] - The number of items per page.
  */
 /**
  * @typedef TicketHistoryList
@@ -368,6 +369,10 @@ type Page = {
      * - The number of items per page.
      */
     size?: number;
+    /**
+     * - The number of items per page.
+     */
+    page_size?: number;
 };
 /** @returns {TicketHistoryList} */
 declare function TicketHistoryList(): TicketHistoryList;

package/sdk/platform/Lead/LeadPlatformModel.js

@@ -53,6 +53,7 @@ const Joi = require("joi");
  * @property {number} [current] - The current page number.
  * @property {string} type - The type of the page, such as 'PageType'.
  * @property {number} [size] - The number of items per page.
+ * @property {number} [page_size] - The number of items per page.
  */
 
 /**
@@ -391,6 +392,7 @@ class LeadPlatformModel {
       current: Joi.number(),
       type: Joi.string().allow("").required(),
       size: Joi.number(),
+      page_size: Joi.number(),
     });
   }
 

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

@@ -3,16 +3,6 @@ declare class Order {
     constructor(config: any, applicationId: any);
     config: any;
     applicationId: any;
-    /**
-     * @param {OrderPlatformApplicationValidator.FailedOrderLogsParam} arg - Arg object
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<OrderPlatformModel.FailedOrderLogs>} - Success response
-     * @name failedOrderLogs
-     * @summary: List failed order logs
-     * @description: Get failed order logs listing for filters based on order Id, user contact number, user email Id and sales channel Id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/failedOrderLogs/).
-     */
-    failedOrderLogs({ pageNo, pageSize, searchType, searchValue, requestHeaders }?: OrderPlatformApplicationValidator.FailedOrderLogsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.FailedOrderLogs>;
     /**
      * @param {OrderPlatformApplicationValidator.GetApplicationShipmentsParam} arg
      *   - Arg object

package/sdk/platform/Order/OrderPlatformApplicationClient.js

@@ -15,98 +15,6 @@ class Order {
     this.applicationId = applicationId;
   }
 
-  /**
-   * @param {OrderPlatformApplicationValidator.FailedOrderLogsParam} arg - Arg object
-   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-   * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<OrderPlatformModel.FailedOrderLogs>} - Success response
-   * @name failedOrderLogs
-   * @summary: List failed order logs
-   * @description: Get failed order logs listing for filters based on order Id, user contact number, user email Id and sales channel Id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/failedOrderLogs/).
-   */
-  async failedOrderLogs(
-    { pageNo, pageSize, searchType, searchValue, requestHeaders } = {
-      requestHeaders: {},
-    },
-    { responseHeaders } = { responseHeaders: false }
-  ) {
-    const {
-      error,
-    } = OrderPlatformApplicationValidator.failedOrderLogs().validate(
-      {
-        pageNo,
-        pageSize,
-        searchType,
-        searchValue,
-      },
-      { abortEarly: false, allowUnknown: true }
-    );
-    if (error) {
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
-    // Showing warrnings if extra unknown parameters are found
-    const {
-      error: warrning,
-    } = OrderPlatformApplicationValidator.failedOrderLogs().validate(
-      {
-        pageNo,
-        pageSize,
-        searchType,
-        searchValue,
-      },
-      { abortEarly: false, allowUnknown: false }
-    );
-    if (warrning) {
-      Logger({
-        level: "WARN",
-        message: `Parameter Validation warrnings for platform > Order > failedOrderLogs \n ${warrning}`,
-      });
-    }
-
-    const query_params = {};
-    query_params["application_id"] = applicationId;
-    query_params["page_no"] = pageNo;
-    query_params["page_size"] = pageSize;
-    query_params["search_type"] = searchType;
-    query_params["search_value"] = searchValue;
-
-    const response = await PlatformAPIClient.execute(
-      this.config,
-      "get",
-      `/service/platform/order-manage/v1.0/company/${this.config.companyId}/orders/failed`,
-      query_params,
-      undefined,
-      requestHeaders,
-      { responseHeaders }
-    );
-
-    let responseData = response;
-    if (responseHeaders) {
-      responseData = response[0];
-    }
-
-    const {
-      error: res_error,
-    } = OrderPlatformModel.FailedOrderLogs().validate(responseData, {
-      abortEarly: false,
-      allowUnknown: true,
-    });
-
-    if (res_error) {
-      if (this.config.options.strictResponseCheck === true) {
-        return Promise.reject(new FDKResponseValidationError(res_error));
-      } else {
-        Logger({
-          level: "WARN",
-          message: `Response Validation Warnings for platform > Order > failedOrderLogs \n ${res_error}`,
-        });
-      }
-    }
-
-    return response;
-  }
-
   /**
    * @param {OrderPlatformApplicationValidator.GetApplicationShipmentsParam} arg
    *   - Arg object

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

@@ -1,11 +1,4 @@
 export = OrderPlatformApplicationValidator;
-/**
- * @typedef FailedOrderLogsParam
- * @property {number} [pageNo] - Page Number
- * @property {number} [pageSize] - Page Size
- * @property {string} [searchType] - Search type for filter
- * @property {string} [searchValue] - Search value for filter
- */
 /**
  * @typedef GetApplicationShipmentsParam
  * @property {string} [lane] - Optional parameter to specify the lane for
@@ -51,8 +44,6 @@ export = OrderPlatformApplicationValidator;
  * @property {string} shipmentId - The unique identifier for the shipment
  */
 declare class OrderPlatformApplicationValidator {
-    /** @returns {FailedOrderLogsParam} */
-    static failedOrderLogs(): FailedOrderLogsParam;
     /** @returns {GetApplicationShipmentsParam} */
     static getApplicationShipments(): GetApplicationShipmentsParam;
     /** @returns {GetPlatformShipmentReasonsParam} */
@@ -65,26 +56,8 @@ declare class OrderPlatformApplicationValidator {
     static trackShipmentPlatform(): TrackShipmentPlatformParam;
 }
 declare namespace OrderPlatformApplicationValidator {
-    export { FailedOrderLogsParam, GetApplicationShipmentsParam, GetPlatformShipmentReasonsParam, GetRulesParam, GetShipmentBagReasonsParam, TrackShipmentPlatformParam };
+    export { GetApplicationShipmentsParam, GetPlatformShipmentReasonsParam, GetRulesParam, GetShipmentBagReasonsParam, TrackShipmentPlatformParam };
 }
-type FailedOrderLogsParam = {
-    /**
-     * - Page Number
-     */
-    pageNo?: number;
-    /**
-     * - Page Size
-     */
-    pageSize?: number;
-    /**
-     * - Search type for filter
-     */
-    searchType?: string;
-    /**
-     * - Search value for filter
-     */
-    searchValue?: string;
-};
 type GetApplicationShipmentsParam = {
     /**
      * - Optional parameter to specify the lane for

package/sdk/platform/Order/OrderPlatformApplicationValidator.js

@@ -2,14 +2,6 @@ const Joi = require("joi");
 
 const OrderPlatformModel = require("./OrderPlatformModel");
 
-/**
- * @typedef FailedOrderLogsParam
- * @property {number} [pageNo] - Page Number
- * @property {number} [pageSize] - Page Size
- * @property {string} [searchType] - Search type for filter
- * @property {string} [searchValue] - Search value for filter
- */
-
 /**
  * @typedef GetApplicationShipmentsParam
  * @property {string} [lane] - Optional parameter to specify the lane for
@@ -60,16 +52,6 @@ const OrderPlatformModel = require("./OrderPlatformModel");
  */
 
 class OrderPlatformApplicationValidator {
-  /** @returns {FailedOrderLogsParam} */
-  static failedOrderLogs() {
-    return Joi.object({
-      pageNo: Joi.number(),
-      pageSize: Joi.number(),
-      searchType: Joi.string().allow(""),
-      searchValue: Joi.string().allow(""),
-    }).required();
-  }
-
   /** @returns {GetApplicationShipmentsParam} */
   static getApplicationShipments() {
     return Joi.object({

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

@@ -131,6 +131,16 @@ declare class Order {
      * @description: Get the exact error trace from the log Id provided in the failed order list API response  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/failedOrderLogDetails/).
      */
     failedOrderLogDetails({ logId, requestHeaders }?: OrderPlatformValidator.FailedOrderLogDetailsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.FailedOrderLogDetails>;
+    /**
+     * @param {OrderPlatformValidator.FailedOrderLogsParam} arg - Arg object
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<OrderPlatformModel.FailedOrderLogs>} - Success response
+     * @name failedOrderLogs
+     * @summary: List failed order logs
+     * @description: Get failed order logs listing for filters based on order Id, user contact number, user email Id and sales channel Id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/failedOrderLogs/).
+     */
+    failedOrderLogs({ applicationId, pageNo, pageSize, searchType, searchValue, requestHeaders, }?: OrderPlatformValidator.FailedOrderLogsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.FailedOrderLogs>;
     /**
      * @param {OrderPlatformValidator.FetchRefundModeConfigParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -346,6 +356,86 @@ declare class Order {
      * @description: Get a list of orders based on the filters provided. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getOrders/).
      */
     getOrders({ lane, searchType, bagStatus, timeToDispatch, paymentMethods, tags, searchValue, fromDate, toDate, startDate, endDate, dpIds, stores, salesChannels, pageNo, pageSize, isPrioritySort, customMeta, myOrders, showCrossCompanyData, customerId, orderType, allowInactive, groupEntity, enforceDateFilter, fulfillmentType, requestHeaders, }?: OrderPlatformValidator.GetOrdersParam, { responseHeaders }?: object): Promise<OrderPlatformModel.OrderListingResponseSchema>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} [arg.lane] - Lane refers to a section where orders are
+     *   assigned, indicating its grouping.
+     * @param {string} [arg.searchType] - Search_type refers to the field that
+     *   will be used as the target for the search operation.
+     * @param {string} [arg.bagStatus] - Bag_status refers to status of the
+     *   entity. Filters orders based on the status.
+     * @param {number} [arg.timeToDispatch] - Time_to_dispatch refers to
+     *   estimated SLA time.
+     * @param {string} [arg.paymentMethods] - Comma separated values of payment
+     *   methods that were used to place order.
+     * @param {string} [arg.tags] - Tags refers to additional descriptive labels
+     *   associated with the order
+     * @param {string} [arg.searchValue] - Search_value is matched against the
+     *   field specified by the search_type
+     * @param {string} [arg.fromDate] - Date time in UTC timezone as per ISO format.
+     * @param {string} [arg.toDate] - Date time in UTC timezone as per ISO format.
+     * @param {string} [arg.startDate] - Date time in UTC timezone as per ISO format.
+     * @param {string} [arg.endDate] - Date time in UTC timezone as per ISO format.
+     * @param {string} [arg.dpIds] - Delivery Partner IDs to which shipments are assigned.
+     * @param {string} [arg.stores] - A comma-separated list of store IDs used
+     *   to filter results to only those related to specific stores.
+     * @param {string} [arg.salesChannels] - A comma-separated list of sales
+     *   channel IDs to filter results based on the sales channels involved.
+     * @param {number} [arg.pageSize] - Determines the number of results
+     *   returned per page.
+     * @param {boolean} [arg.isPrioritySort] -
+     * @param {string} [arg.customMeta] -
+     * @param {boolean} [arg.myOrders] -
+     * @param {boolean} [arg.showCrossCompanyData] - Flag to view cross &
+     *   non-cross company order
+     * @param {string} [arg.customerId] - The unique identifier for the customer
+     *   associated with the query, useful for filtering results to a specific customer.
+     * @param {string} [arg.orderType] -
+     * @param {boolean} [arg.allowInactive] - Flag indicating whether inactive
+     *   shipments are allowed
+     * @param {string} [arg.groupEntity] - Defines the grouping criterion for
+     *   retrieving shipments or orders. It specifies whether the results should
+     *   be organized based on shipment groups or order groups. For example,
+     *   using 'shipments' groups results by shipment, while an invalid value
+     *   like 'abcd' may not be recognized, leading to errors or default behavior.
+     * @param {boolean} [arg.enforceDateFilter] - Applies a date filter for
+     *   listing orders. This is useful when fetching data for a specific date
+     *   range while performing searches.
+     * @param {string} [arg.fulfillmentType] - Define the Fulfillment Type for
+     *   Listing Orders, This is use when we want to get list of shipments or
+     *   orders by cross store or cross company or fulfilling Store (by
+     *   default), this is also depends on the login user accessType and store access
+     * @returns {Paginator<OrderPlatformModel.OrderListingResponseSchema>}
+     * @summary: List orders
+     * @description: Get a list of orders based on the filters provided.
+     */
+    getOrdersPaginator({ lane, searchType, bagStatus, timeToDispatch, paymentMethods, tags, searchValue, fromDate, toDate, startDate, endDate, dpIds, stores, salesChannels, pageSize, isPrioritySort, customMeta, myOrders, showCrossCompanyData, customerId, orderType, allowInactive, groupEntity, enforceDateFilter, fulfillmentType, }?: {
+        lane?: string;
+        searchType?: string;
+        bagStatus?: string;
+        timeToDispatch?: number;
+        paymentMethods?: string;
+        tags?: string;
+        searchValue?: string;
+        fromDate?: string;
+        toDate?: string;
+        startDate?: string;
+        endDate?: string;
+        dpIds?: string;
+        stores?: string;
+        salesChannels?: string;
+        pageSize?: number;
+        isPrioritySort?: boolean;
+        customMeta?: string;
+        myOrders?: boolean;
+        showCrossCompanyData?: boolean;
+        customerId?: string;
+        orderType?: string;
+        allowInactive?: boolean;
+        groupEntity?: string;
+        enforceDateFilter?: boolean;
+        fulfillmentType?: string;
+    }): Paginator<OrderPlatformModel.OrderListingResponseSchema>;
     /**
      * @param {OrderPlatformValidator.GetRoleBasedActionsParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -402,6 +492,127 @@ declare class Order {
      * @description: Get a list of shipments based on the filters provided - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipments/).
      */
     getShipments({ lane, bagStatus, statusAssigned, statusOverrideLane, timeToDispatch, searchType, searchValue, fromDate, toDate, startDate, endDate, statusAssignedStartDate, statusAssignedEndDate, dpIds, stores, salesChannels, pageNo, pageSize, fetchActiveShipment, allowInactive, excludeLockedShipments, paymentMethods, channelShipmentId, channelOrderId, customMeta, orderingChannel, companyAffiliateTag, myOrders, platformUserId, sortType, showCrossCompanyData, tags, customerId, orderType, groupEntity, enforceDateFilter, fulfillmentType, requestHeaders, }?: OrderPlatformValidator.GetShipmentsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentInternalPlatformViewResponseSchema>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} [arg.lane] - Name of lane for which data is to be fetched
+     * @param {string} [arg.bagStatus] - Comma separated values of bag statuses.
+     * @param {string} [arg.statusAssigned] - Used to filter shipments based on
+     *   status present in shipment_status_history. For more information on
+     *   these statuses, refer to the Fynd Partners documentation.
+     * @param {boolean} [arg.statusOverrideLane] - Use this flag to fetch by
+     *   bag_status and override lane.
+     * @param {number} [arg.timeToDispatch] - Indicates the time to dispatch.
+     * @param {string} [arg.searchType] - Specifies the key used to determine
+     *   the type of search being performed.
+     * @param {string} [arg.searchValue] - The value corresponding to the search
+     *   type, such as a specific shipment ID or order ID.
+     * @param {string} [arg.fromDate] - Start Date in DD-MM-YYYY format
+     * @param {string} [arg.toDate] - End Date in DD-MM-YYYY format
+     * @param {string} [arg.startDate] - The UTC start date in ISO format
+     *   (YYYY-MM-DDTHH:MM:SSZ) for filtering results.
+     * @param {string} [arg.endDate] - The UTC end date in ISO format
+     *   (YYYY-MM-DDTHH:MM:SSZ) for filtering results.
+     * @param {string} [arg.statusAssignedStartDate] - Specifies the starting
+     *   UTC date and time (in ISO format, YYYY-MM-DDTHH:MM:SSZ) to define the
+     *   lower boundary for filtering shipments based on the `created_at`
+     *   timestamp of statuses in the shipment's status history. It allows
+     *   filtering statuses that were created within a specific time range.
+     * @param {string} [arg.statusAssignedEndDate] - Specifies the ending UTC
+     *   date and time (in ISO format, YYYY-MM-DDTHH:MM:SSZ) to define the upper
+     *   boundary for filtering shipments based on the `created_at` timestamp of
+     *   statuses in the shipment's status history.
+     * @param {string} [arg.dpIds] - A comma-separated list of delivery partner
+     *   IDs to filter results by specific delivery partners.
+     * @param {string} [arg.stores] - A comma-separated list of store IDs used
+     *   to filter results to only those related to specific stores.
+     * @param {string} [arg.salesChannels] - A comma-separated list of sales
+     *   channel IDs to filter results based on the sales channels involved.
+     * @param {number} [arg.pageSize] - Determines the number of results
+     *   returned per page.
+     * @param {boolean} [arg.fetchActiveShipment] - A boolean flag that
+     *   indicates whether to include only active shipments in the results.
+     * @param {boolean} [arg.allowInactive] - A flag indicating whether to allow
+     *   the inclusion of inactive shipments in the results.
+     * @param {boolean} [arg.excludeLockedShipments] - A flag to specify whether
+     *   to exclude shipments that are locked from the results.
+     * @param {string} [arg.paymentMethods] - A comma-separated list of payment methods.
+     * @param {string} [arg.channelShipmentId] - The shipment ID used in the
+     *   application, which can be used to reference specific shipments.
+     * @param {string} [arg.channelOrderId] - The order ID used in the application.
+     * @param {string} [arg.customMeta] - Custom metadata associated with the
+     *   query, allowing for additional filtering or information to be passed.
+     * @param {string} [arg.orderingChannel] - The channel through which the
+     *   order was placed.
+     * @param {string} [arg.companyAffiliateTag] - A tag used to identify the
+     *   company's affiliation for filtering or reporting purposes.
+     * @param {boolean} [arg.myOrders] - A boolean flag indicating whether the
+     *   query should return only the user's orders.
+     * @param {string} [arg.platformUserId] - The unique identifier of the user
+     *   on the platform, useful for filtering orders related to a specific user.
+     * @param {string} [arg.sortType] - Determines the sorting order of the
+     *   results based on specific criteria.
+     * @param {boolean} [arg.showCrossCompanyData] - A flag indicating whether
+     *   to include data from both cross-company and non-cross-company orders in
+     *   the results.
+     * @param {string} [arg.tags] - A comma-separated list of tags associated
+     *   with the orders to filter results based on specific characteristics.
+     * @param {string} [arg.customerId] - The unique identifier for the customer
+     *   associated with the query, useful for filtering results to a specific customer.
+     * @param {string} [arg.orderType] - The type of order being queried.
+     * @param {string} [arg.groupEntity] - Defines the grouping criterion for
+     *   retrieving shipments or orders. It specifies whether the results should
+     *   be organized based on shipment groups or order groups. For example,
+     *   using 'shipments' groups results by shipment, while an invalid value
+     *   like 'abcd' may not be recognized, leading to errors or default behavior.
+     * @param {boolean} [arg.enforceDateFilter] - Applies a date filter for
+     *   listing shipments. This is useful when fetching data for a specific
+     *   date range while performing searches.
+     * @param {string} [arg.fulfillmentType] - Define the Fulfillment Type for
+     *   Listing Orders, This is use when we want to get list of shipments or
+     *   orders by cross store or cross company or fulfilling Store (by
+     *   default), this is also depends on the login user accessType and store access
+     * @returns {Paginator<OrderPlatformModel.ShipmentInternalPlatformViewResponseSchema>}
+     * @summary: List shipments
+     * @description: Get a list of shipments based on the filters provided
+     */
+    getShipmentsPaginator({ lane, bagStatus, statusAssigned, statusOverrideLane, timeToDispatch, searchType, searchValue, fromDate, toDate, startDate, endDate, statusAssignedStartDate, statusAssignedEndDate, dpIds, stores, salesChannels, pageSize, fetchActiveShipment, allowInactive, excludeLockedShipments, paymentMethods, channelShipmentId, channelOrderId, customMeta, orderingChannel, companyAffiliateTag, myOrders, platformUserId, sortType, showCrossCompanyData, tags, customerId, orderType, groupEntity, enforceDateFilter, fulfillmentType, }?: {
+        lane?: string;
+        bagStatus?: string;
+        statusAssigned?: string;
+        statusOverrideLane?: boolean;
+        timeToDispatch?: number;
+        searchType?: string;
+        searchValue?: string;
+        fromDate?: string;
+        toDate?: string;
+        startDate?: string;
+        endDate?: string;
+        statusAssignedStartDate?: string;
+        statusAssignedEndDate?: string;
+        dpIds?: string;
+        stores?: string;
+        salesChannels?: string;
+        pageSize?: number;
+        fetchActiveShipment?: boolean;
+        allowInactive?: boolean;
+        excludeLockedShipments?: boolean;
+        paymentMethods?: string;
+        channelShipmentId?: string;
+        channelOrderId?: string;
+        customMeta?: string;
+        orderingChannel?: string;
+        companyAffiliateTag?: string;
+        myOrders?: boolean;
+        platformUserId?: string;
+        sortType?: string;
+        showCrossCompanyData?: boolean;
+        tags?: string;
+        customerId?: string;
+        orderType?: string;
+        groupEntity?: string;
+        enforceDateFilter?: boolean;
+        fulfillmentType?: string;
+    }): Paginator<OrderPlatformModel.ShipmentInternalPlatformViewResponseSchema>;
     /**
      * @param {OrderPlatformValidator.GetStateManagerConfigParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -622,3 +833,4 @@ declare class Order {
 }
 import OrderPlatformValidator = require("./OrderPlatformValidator");
 import OrderPlatformModel = require("./OrderPlatformModel");
+import Paginator = require("../../common/Paginator");