@gofynd/fdk-client-javascript 3.0.0-beta.1 → 3.0.0

package/sdk/platform/Lead/LeadPlatformValidator.js

@@ -19,6 +19,11 @@ const LeadPlatformModel = require("./LeadPlatformModel");
  * @property {LeadPlatformModel.EditTicketPayload} body
  */
 
+/**
+ * @typedef GetFeedbacksParam
+ * @property {string} id - Ticket ID for which feedbacks are to be fetched
+ */
+
 /** @typedef GetGeneralConfigParam */
 
 /**
@@ -38,7 +43,7 @@ const LeadPlatformModel = require("./LeadPlatformModel");
  *   ticket filters
  * @property {string} [q] - Search through ticket titles and description
  * @property {string} [status] - Filter tickets on status
- * @property {string} [priority] - Filter tickets on priority
+ * @property {LeadPlatformModel.PriorityEnum} [priority] - Filter tickets on priority
  * @property {string} [category] - Filter tickets on category
  * @property {number} [pageNo] - The page number to navigate through the given
  *   set of results.
@@ -46,6 +51,12 @@ const LeadPlatformModel = require("./LeadPlatformModel");
  *   Default is 12.
  */
 
+/**
+ * @typedef SubmitFeedbackParam
+ * @property {string} id - Ticket ID for which feedback is to be submitted
+ * @property {LeadPlatformModel.TicketFeedbackPayload} body
+ */
+
 class LeadPlatformValidator {
   /** @returns {CreatePlatformTicketHistoryParam} */
   static createPlatformTicketHistory() {
@@ -70,6 +81,13 @@ class LeadPlatformValidator {
     }).required();
   }
 
+  /** @returns {GetFeedbacksParam} */
+  static getFeedbacks() {
+    return Joi.object({
+      id: Joi.string().allow("").required(),
+    }).required();
+  }
+
   /** @returns {GetGeneralConfigParam} */
   static getGeneralConfig() {
     return Joi.object({}).required();
@@ -96,12 +114,20 @@ class LeadPlatformValidator {
       filters: Joi.boolean(),
       q: Joi.string().allow(""),
       status: Joi.string().allow(""),
-      priority: Joi.string().allow(""),
+      priority: LeadPlatformModel.PriorityEnum(),
       category: Joi.string().allow(""),
       pageNo: Joi.number(),
       pageSize: Joi.number(),
     }).required();
   }
+
+  /** @returns {SubmitFeedbackParam} */
+  static submitFeedback() {
+    return Joi.object({
+      id: Joi.string().allow("").required(),
+      body: LeadPlatformModel.TicketFeedbackPayload().required(),
+    }).required();
+  }
 }
 
 module.exports = LeadPlatformValidator;

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

@@ -3,102 +3,43 @@ declare class Order {
     constructor(config: any, applicationId: any);
     config: any;
     applicationId: any;
-    /**
-     * @param {OrderPlatformApplicationValidator.CreateRuleParam} arg - Arg object
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<OrderPlatformModel.RuleSuccessResponse>} - Success response
-     * @name createRule
-     * @summary: Create a new rule
-     * @description: Create a new rule - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/createRule/).
-     */
-    createRule({ body, requestHeaders }?: OrderPlatformApplicationValidator.CreateRuleParam, { responseHeaders }?: object): Promise<OrderPlatformModel.RuleSuccessResponse>;
-    /**
-     * @param {OrderPlatformApplicationValidator.DeleteRuleParam} arg - Arg object
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<OrderPlatformModel.RuleSuccessResponse>} - Success response
-     * @name deleteRule
-     * @summary: Delete a specific rule by ID
-     * @description: Delete a specific rule by ID - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/deleteRule/).
-     */
-    deleteRule({ ruleId, requestHeaders }?: OrderPlatformApplicationValidator.DeleteRuleParam, { responseHeaders }?: object): Promise<OrderPlatformModel.RuleSuccessResponse>;
     /**
      * @param {OrderPlatformApplicationValidator.GetApplicationShipmentsParam} arg
      *   - Arg object
      *
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<OrderPlatformModel.ShipmentInternalPlatformViewResponse>}
+     * @returns {Promise<OrderPlatformModel.ShipmentInternalPlatformViewResponseSchema>}
      *   - Success response
      *
      * @name getApplicationShipments
-     * @summary: Get cross selling platform shipments
-     * @description: Get cross selling platform shipments - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getApplicationShipments/).
+     * @summary: List sales channel shipments
+     * @description: Get shipments of a particular sales channel based on the filters provided - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getApplicationShipments/).
      */
-    getApplicationShipments({ lane, searchType, searchId, searchValue, fromDate, toDate, dpIds, orderingCompanyId, stores, salesChannel, requestByExt, pageNo, pageSize, customerId, isPrioritySort, excludeLockedShipments, requestHeaders, }?: OrderPlatformApplicationValidator.GetApplicationShipmentsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentInternalPlatformViewResponse>;
+    getApplicationShipments({ lane, searchType, searchId, fromDate, toDate, dpIds, orderingCompanyId, stores, salesChannel, requestByExt, pageNo, pageSize, customerId, isPrioritySort, excludeLockedShipments, requestHeaders, }?: OrderPlatformApplicationValidator.GetApplicationShipmentsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentInternalPlatformViewResponseSchema>;
     /**
      * @param {OrderPlatformApplicationValidator.GetPlatformShipmentReasonsParam} arg
      *   - Arg object
      *
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<OrderPlatformModel.ShipmentReasonsResponse>} - Success response
+     * @returns {Promise<OrderPlatformModel.ShipmentReasonsResponseSchema>} -
+     *   Success response
      * @name getPlatformShipmentReasons
-     * @summary: Use this API to retrieve the issues that led to the cancellation of bags within a shipment.
-     * @description: Using action, get reasons behind full or partial cancellation of a shipment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getPlatformShipmentReasons/).
-     */
-    getPlatformShipmentReasons({ action, requestHeaders }?: OrderPlatformApplicationValidator.GetPlatformShipmentReasonsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentReasonsResponse>;
-    /**
-     * @param {OrderPlatformApplicationValidator.GetQuestionsParam} arg - Arg object
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<Object>} - Success response
-     * @name getQuestions
-     * @summary: Get all questions of that cluster
-     * @description: Get all questions of that cluster - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getQuestions/).
-     */
-    getQuestions({ pageNo, pageSize, q, isActive, requestHeaders }?: OrderPlatformApplicationValidator.GetQuestionsParam, { responseHeaders }?: object): Promise<any>;
-    /**
-     * @param {OrderPlatformApplicationValidator.GetRuleByIdParam} arg - Arg object
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<OrderPlatformModel.RuleResponse>} - Success response
-     * @name getRuleById
-     * @summary: Get a specific rule by ID
-     * @description: Get a specific rule by ID - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getRuleById/).
+     * @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/platform/order/getPlatformShipmentReasons/).
      */
-    getRuleById({ ruleId, requestHeaders }?: OrderPlatformApplicationValidator.GetRuleByIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.RuleResponse>;
+    getPlatformShipmentReasons({ action, requestHeaders }?: OrderPlatformApplicationValidator.GetPlatformShipmentReasonsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentReasonsResponseSchema>;
     /**
-     * @param {OrderPlatformApplicationValidator.GetRuleLaneConfigParam} arg - Arg object
+     * @param {OrderPlatformApplicationValidator.GetRulesParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<OrderPlatformModel.RuleLaneConfigResponse>} - Success response
-     * @name getRuleLaneConfig
-     * @summary: Retrieve rule lane configurations
-     * @description: Retrieve rule lane configurations - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getRuleLaneConfig/).
+     * @returns {Promise<OrderPlatformModel.RuleListResponseSchema>} - Success response
+     * @name getRules
+     * @summary: List of RMA rules based on the given input conditions.
+     * @description: Retrieves a comprehensive list of RMA (Return Merchandise Authorization) rules associated with  a specific company and application. These rules dictate the processes for handling returns,  including actions, reasons, quality control (QC) types, and associated questions.  The endpoint allows for filtering and pagination based on input conditions, providing a tailored set of rules that match the criteria specified. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getRules/).
      */
-    getRuleLaneConfig({ searchValue, requestHeaders }?: OrderPlatformApplicationValidator.GetRuleLaneConfigParam, { responseHeaders }?: object): Promise<OrderPlatformModel.RuleLaneConfigResponse>;
-    /**
-     * @param {OrderPlatformApplicationValidator.GetRuleListParam} arg - Arg object
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<OrderPlatformModel.RuleListResponse>} - Success response
-     * @name getRuleList
-     * @summary: Get a list of rules
-     * @description: Get a list of rules - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getRuleList/).
-     */
-    getRuleList({ body, requestHeaders }?: OrderPlatformApplicationValidator.GetRuleListParam, { responseHeaders }?: object): Promise<OrderPlatformModel.RuleListResponse>;
-    /**
-     * @param {OrderPlatformApplicationValidator.GetRuleParametersParam} arg - Arg object
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<OrderPlatformModel.RuleParametersResponse>} - Success response
-     * @name getRuleParameters
-     * @summary: Get available rule parameters
-     * @description: Get available rule parameters - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getRuleParameters/).
-     */
-    getRuleParameters({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.RuleParametersResponse>;
+    getRules({ body, requestHeaders }?: OrderPlatformApplicationValidator.GetRulesParam, { responseHeaders }?: object): Promise<OrderPlatformModel.RuleListResponseSchema>;
     /**
      * @param {OrderPlatformApplicationValidator.GetShipmentBagReasonsParam} arg
      *   - Arg object
@@ -107,10 +48,10 @@ declare class Order {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<OrderPlatformModel.ShipmentBagReasons>} - Success response
      * @name getShipmentBagReasons
-     * @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. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/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/platform/order/getShipmentBagReasons/).
      */
-    getShipmentBagReasons({ shipmentId, lineNumber, bagId, requestHeaders }?: OrderPlatformApplicationValidator.GetShipmentBagReasonsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentBagReasons>;
+    getShipmentBagReasons({ shipmentId, lineNumber, requestHeaders }?: OrderPlatformApplicationValidator.GetShipmentBagReasonsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentBagReasons>;
     /**
      * @param {OrderPlatformApplicationValidator.TrackShipmentPlatformParam} arg
      *   - Arg object
@@ -120,29 +61,9 @@ declare class Order {
      * @returns {Promise<OrderPlatformModel.PlatformShipmentTrack>} - Success response
      * @name trackShipmentPlatform
      * @summary: Track shipment
-     * @description: Track Shipment by shipment id, for application based on application Id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/trackShipmentPlatform/).
+     * @description: Track shipment by shipment Id for an application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/trackShipmentPlatform/).
      */
     trackShipmentPlatform({ shipmentId, requestHeaders }?: OrderPlatformApplicationValidator.TrackShipmentPlatformParam, { responseHeaders }?: object): Promise<OrderPlatformModel.PlatformShipmentTrack>;
-    /**
-     * @param {OrderPlatformApplicationValidator.UpdateRuleParam} arg - Arg object
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<OrderPlatformModel.RuleSuccessResponse>} - Success response
-     * @name updateRule
-     * @summary: Update a specific rule by ID
-     * @description: Update a specific rule by ID - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updateRule/).
-     */
-    updateRule({ ruleId, body, requestHeaders }?: OrderPlatformApplicationValidator.UpdateRuleParam, { responseHeaders }?: object): Promise<OrderPlatformModel.RuleSuccessResponse>;
-    /**
-     * @param {OrderPlatformApplicationValidator.UpdateRulePositionParam} arg - Arg object
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<OrderPlatformModel.RuleListResponse>} - Success response
-     * @name updateRulePosition
-     * @summary: Update the position of a rule
-     * @description: Update the position of a rule - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updateRulePosition/).
-     */
-    updateRulePosition({ body, requestHeaders }?: OrderPlatformApplicationValidator.UpdateRulePositionParam, { responseHeaders }?: object): Promise<OrderPlatformModel.RuleListResponse>;
 }
 import OrderPlatformApplicationValidator = require("./OrderPlatformApplicationValidator");
 import OrderPlatformModel = require("./OrderPlatformModel");