@gofynd/fdk-client-javascript 1.3.11-beta.7 → 1.3.11-beta.8

package/sdk/platform/Lead/LeadPlatformApplicationValidator.js

@@ -13,11 +13,16 @@ const LeadPlatformModel = require("./LeadPlatformModel");
  */
 
 /**
- * @typedef CreateHistoryParam
+ * @typedef CreateNewHistoryParam
  * @property {string} id - Ticket ID for which history is created
  * @property {LeadPlatformModel.TicketHistoryPayload} body
  */
 
+/**
+ * @typedef DeleteCustomFormParam
+ * @property {string} slug - Slug of form whose response is getting submitted
+ */
+
 /**
  * @typedef EditCustomFormParam
  * @property {string} slug - Slug of form whose response is getting submitted
@@ -25,7 +30,7 @@ const LeadPlatformModel = require("./LeadPlatformModel");
  */
 
 /**
- * @typedef EditTicketParam
+ * @typedef EditNewTicketParam
  * @property {string} id - Ticket ID of ticket to be edited
  * @property {LeadPlatformModel.EditTicketPayload} body
  */
@@ -38,17 +43,17 @@ const LeadPlatformModel = require("./LeadPlatformModel");
 /** @typedef GetCustomFormsParam */
 
 /**
- * @typedef GetTicketParam
+ * @typedef GetNewTicketParam
  * @property {string} id - Tiket ID of the ticket to be fetched
  */
 
 /**
- * @typedef GetTicketHistoryParam
+ * @typedef GetNewTicketHistoryParam
  * @property {string} id - Ticket ID for which history is to be fetched
  */
 
 /**
- * @typedef GetTicketsParam
+ * @typedef GetNewTicketsParam
  * @property {boolean} [items] - Decides that the reponse will contain the list of tickets
  * @property {boolean} [filters] - Decides that the reponse will contain the
  *   ticket filters
@@ -59,12 +64,12 @@ const LeadPlatformModel = require("./LeadPlatformModel");
  */
 
 /**
- * @typedef GetTokenForVideoRoomParam
+ * @typedef GetNewTokenForVideoRoomParam
  * @property {string} uniqueName - Unique name of video room
  */
 
 /**
- * @typedef GetVideoParticipantsParam
+ * @typedef GetNewVideoParticipantsParam
  * @property {string} uniqueName - Unique name of Video Room
  */
 
@@ -88,14 +93,21 @@ class LeadPlatformApplicationValidator {
     }).required();
   }
 
-  /** @returns {CreateHistoryParam} */
-  static createHistory() {
+  /** @returns {CreateNewHistoryParam} */
+  static createNewHistory() {
     return Joi.object({
       id: Joi.string().allow("").required(),
       body: LeadPlatformModel.TicketHistoryPayload().required(),
     }).required();
   }
 
+  /** @returns {DeleteCustomFormParam} */
+  static deleteCustomForm() {
+    return Joi.object({
+      slug: Joi.string().allow("").required(),
+    }).required();
+  }
+
   /** @returns {EditCustomFormParam} */
   static editCustomForm() {
     return Joi.object({
@@ -104,8 +116,8 @@ class LeadPlatformApplicationValidator {
     }).required();
   }
 
-  /** @returns {EditTicketParam} */
-  static editTicket() {
+  /** @returns {EditNewTicketParam} */
+  static editNewTicket() {
     return Joi.object({
       id: Joi.string().allow("").required(),
       body: LeadPlatformModel.EditTicketPayload().required(),
@@ -124,22 +136,22 @@ class LeadPlatformApplicationValidator {
     return Joi.object({}).required();
   }
 
-  /** @returns {GetTicketParam} */
-  static getTicket() {
+  /** @returns {GetNewTicketParam} */
+  static getNewTicket() {
     return Joi.object({
       id: Joi.string().allow("").required(),
     }).required();
   }
 
-  /** @returns {GetTicketHistoryParam} */
-  static getTicketHistory() {
+  /** @returns {GetNewTicketHistoryParam} */
+  static getNewTicketHistory() {
     return Joi.object({
       id: Joi.string().allow("").required(),
     }).required();
   }
 
-  /** @returns {GetTicketsParam} */
-  static getTickets() {
+  /** @returns {GetNewTicketsParam} */
+  static getNewTickets() {
     return Joi.object({
       items: Joi.boolean(),
       filters: Joi.boolean(),
@@ -150,15 +162,15 @@ class LeadPlatformApplicationValidator {
     }).required();
   }
 
-  /** @returns {GetTokenForVideoRoomParam} */
-  static getTokenForVideoRoom() {
+  /** @returns {GetNewTokenForVideoRoomParam} */
+  static getNewTokenForVideoRoom() {
     return Joi.object({
       uniqueName: Joi.string().allow("").required(),
     }).required();
   }
 
-  /** @returns {GetVideoParticipantsParam} */
-  static getVideoParticipants() {
+  /** @returns {GetNewVideoParticipantsParam} */
+  static getNewVideoParticipants() {
     return Joi.object({
       uniqueName: Joi.string().allow("").required(),
     }).required();

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

@@ -105,6 +105,10 @@ export = LeadPlatformModel;
  * @property {boolean} [primary] - Denotes it's the primary email for the account
  * @property {boolean} [verified] - Denotes it's a verified email
  */
+/**
+ * @typedef ErrorMessage
+ * @property {string} [message]
+ */
 /**
  * @typedef FeedbackForm
  * @property {Object} [inputs] - Input details for the feed back form
@@ -301,7 +305,7 @@ export = LeadPlatformModel;
  * @property {string} [user_id]
  * @property {string} [username]
  */
-/** @typedef {"rating" | "log" | "comment"} HistoryTypeEnum */
+/** @typedef {"rating" | "log" | "comment" | "thread"} HistoryTypeEnum */
 /** @typedef {"low" | "medium" | "high" | "urgent"} PriorityEnum */
 /**
  * @typedef {| "image"
@@ -318,7 +322,7 @@ export = LeadPlatformModel;
 declare class LeadPlatformModel {
 }
 declare namespace LeadPlatformModel {
-    export { AddTicketPayload, AgentChangePayload, CloseVideoRoomResponse, CreateCustomFormPayload, CreatedOn, CreateVideoRoomPayload, CreateVideoRoomResponse, CustomForm, CustomFormList, Debug, EditCustomFormPayload, EditTicketPayload, Email, FeedbackForm, FeedbackResponseItem, Filter, GetParticipantsInsideVideoRoomResponse, GetTokenForVideoRoomResponse, NotifyUser, Page, Participant, PhoneNumber, PollForAssignment, Priority, Status, SubmitButton, Ticket, TicketAsset, TicketCategory, TicketContent, TicketContext, TicketFeedback, TicketFeedbackList, TicketFeedbackPayload, TicketHistory, TicketHistoryList, TicketHistoryPayload, TicketList, UserSchema, HistoryTypeEnum, PriorityEnum, TicketAssetTypeEnum, TicketSourceEnum };
+    export { AddTicketPayload, AgentChangePayload, CloseVideoRoomResponse, CreateCustomFormPayload, CreatedOn, CreateVideoRoomPayload, CreateVideoRoomResponse, CustomForm, CustomFormList, Debug, EditCustomFormPayload, EditTicketPayload, Email, ErrorMessage, FeedbackForm, FeedbackResponseItem, Filter, GetParticipantsInsideVideoRoomResponse, GetTokenForVideoRoomResponse, NotifyUser, Page, Participant, PhoneNumber, PollForAssignment, Priority, Status, SubmitButton, Ticket, TicketAsset, TicketCategory, TicketContent, TicketContext, TicketFeedback, TicketFeedbackList, TicketFeedbackPayload, TicketHistory, TicketHistoryList, TicketHistoryPayload, TicketList, UserSchema, HistoryTypeEnum, PriorityEnum, TicketAssetTypeEnum, TicketSourceEnum };
 }
 /** @returns {AddTicketPayload} */
 declare function AddTicketPayload(): AddTicketPayload;
@@ -577,6 +581,11 @@ type Email = {
      */
     verified?: boolean;
 };
+/** @returns {ErrorMessage} */
+declare function ErrorMessage(): ErrorMessage;
+type ErrorMessage = {
+    message?: string;
+};
 /** @returns {FeedbackForm} */
 declare function FeedbackForm(): FeedbackForm;
 type FeedbackForm = {
@@ -1024,7 +1033,7 @@ type UserSchema = {
  * @returns {HistoryTypeEnum}
  */
 declare function HistoryTypeEnum(): HistoryTypeEnum;
-type HistoryTypeEnum = "rating" | "log" | "comment";
+type HistoryTypeEnum = "rating" | "log" | "comment" | "thread";
 /**
  * Enum: PriorityEnum Used By: Lead
  *

package/sdk/platform/Lead/LeadPlatformModel.js

@@ -119,6 +119,11 @@ const Joi = require("joi");
  * @property {boolean} [verified] - Denotes it's a verified email
  */
 
+/**
+ * @typedef ErrorMessage
+ * @property {string} [message]
+ */
+
 /**
  * @typedef FeedbackForm
  * @property {Object} [inputs] - Input details for the feed back form
@@ -341,7 +346,7 @@ const Joi = require("joi");
  * @property {string} [username]
  */
 
-/** @typedef {"rating" | "log" | "comment"} HistoryTypeEnum */
+/** @typedef {"rating" | "log" | "comment" | "thread"} HistoryTypeEnum */
 
 /** @typedef {"low" | "medium" | "high" | "urgent"} PriorityEnum */
 
@@ -498,6 +503,13 @@ class LeadPlatformModel {
     });
   }
 
+  /** @returns {ErrorMessage} */
+  static ErrorMessage() {
+    return Joi.object({
+      message: Joi.string().allow(""),
+    });
+  }
+
   /** @returns {FeedbackForm} */
   static FeedbackForm() {
     return Joi.object({
@@ -784,7 +796,9 @@ class LeadPlatformModel {
 
       "log",
 
-      "comment"
+      "comment",
+
+      "thread"
     );
   }
 

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

@@ -3,6 +3,16 @@ 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: Get failed order logs according to the filter provided
+     * @description: This endpoint allows users to 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
@@ -14,7 +24,7 @@ declare class Order {
      *
      * @name getApplicationShipments
      * @summary:
-     * @description: - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getApplicationShipments/).
+     * @description: Get cross selling platform shipments - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getApplicationShipments/).
      */
     getApplicationShipments({ lane, searchType, searchId, fromDate, toDate, dpIds, orderingCompanyId, stores, salesChannel, requestByExt, pageNo, pageSize, customerId, isPrioritySort, excludeLockedShipments, requestHeaders, }?: OrderPlatformApplicationValidator.GetApplicationShipmentsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentInternalPlatformViewResponse>;
     /**
@@ -41,6 +51,18 @@ declare class Order {
      * @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/).
      */
     getShipmentBagReasons({ shipmentId, lineNumber, requestHeaders }?: OrderPlatformApplicationValidator.GetShipmentBagReasonsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentBagReasons>;
+    /**
+     * @param {OrderPlatformApplicationValidator.GetStateManagerStatesParam} arg
+     *   - Arg object
+     *
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<OrderPlatformModel.PaginatedStates>} - Success response
+     * @name getStateManagerStates
+     * @summary: Get all states for a company and channel
+     * @description: - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getStateManagerStates/).
+     */
+    getStateManagerStates({ pageNo, pageSize, requestHeaders }?: OrderPlatformApplicationValidator.GetStateManagerStatesParam, { responseHeaders }?: object): Promise<OrderPlatformModel.PaginatedStates>;
     /**
      * @param {OrderPlatformApplicationValidator.TrackShipmentPlatformParam} arg
      *   - Arg object

package/sdk/platform/Order/OrderPlatformApplicationClient.js

@@ -12,6 +12,98 @@ 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: Get failed order logs according to the filter provided
+   * @description: This endpoint allows users to 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
@@ -23,7 +115,7 @@ class Order {
    *
    * @name getApplicationShipments
    * @summary:
-   * @description: - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getApplicationShipments/).
+   * @description: Get cross selling platform shipments - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getApplicationShipments/).
    */
   async getApplicationShipments(
     {
@@ -319,6 +411,91 @@ class Order {
     return response;
   }
 
+  /**
+   * @param {OrderPlatformApplicationValidator.GetStateManagerStatesParam} arg
+   *   - Arg object
+   *
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../PlatformAPIClient").Options} - Options
+   * @returns {Promise<OrderPlatformModel.PaginatedStates>} - Success response
+   * @name getStateManagerStates
+   * @summary: Get all states for a company and channel
+   * @description: - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getStateManagerStates/).
+   */
+  async getStateManagerStates(
+    { pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const {
+      error,
+    } = OrderPlatformApplicationValidator.getStateManagerStates().validate(
+      {
+        pageNo,
+        pageSize,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = OrderPlatformApplicationValidator.getStateManagerStates().validate(
+      {
+        pageNo,
+        pageSize,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: `Parameter Validation warrnings for platform > Order > getStateManagerStates \n ${warrning}`,
+      });
+    }
+
+    const query_params = {};
+    query_params["page_no"] = pageNo;
+    query_params["page_size"] = pageSize;
+
+    const response = await PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/order-manage/v1.0/company/${this.config.companyId}/application/${this.applicationId}/states`,
+      query_params,
+      undefined,
+      requestHeaders,
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = OrderPlatformModel.PaginatedStates().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 > getStateManagerStates \n ${res_error}`,
+        });
+      }
+    }
+
+    return response;
+  }
+
   /**
    * @param {OrderPlatformApplicationValidator.TrackShipmentPlatformParam} arg
    *   - Arg object

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

@@ -1,4 +1,11 @@
 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]
@@ -27,23 +34,50 @@ export = OrderPlatformApplicationValidator;
  *   items and may get divided into one or more shipment, each having its own ID.
  * @property {number} lineNumber - Line number of bag.
  */
+/**
+ * @typedef GetStateManagerStatesParam
+ * @property {number} [pageNo]
+ * @property {number} [pageSize]
+ */
 /**
  * @typedef TrackShipmentPlatformParam
  * @property {string} shipmentId - Shipment Id
  */
 declare class OrderPlatformApplicationValidator {
+    /** @returns {FailedOrderLogsParam} */
+    static failedOrderLogs(): FailedOrderLogsParam;
     /** @returns {GetApplicationShipmentsParam} */
     static getApplicationShipments(): GetApplicationShipmentsParam;
     /** @returns {GetPlatformShipmentReasonsParam} */
     static getPlatformShipmentReasons(): GetPlatformShipmentReasonsParam;
     /** @returns {GetShipmentBagReasonsParam} */
     static getShipmentBagReasons(): GetShipmentBagReasonsParam;
+    /** @returns {GetStateManagerStatesParam} */
+    static getStateManagerStates(): GetStateManagerStatesParam;
     /** @returns {TrackShipmentPlatformParam} */
     static trackShipmentPlatform(): TrackShipmentPlatformParam;
 }
 declare namespace OrderPlatformApplicationValidator {
-    export { GetApplicationShipmentsParam, GetPlatformShipmentReasonsParam, GetShipmentBagReasonsParam, TrackShipmentPlatformParam };
+    export { FailedOrderLogsParam, GetApplicationShipmentsParam, GetPlatformShipmentReasonsParam, GetShipmentBagReasonsParam, GetStateManagerStatesParam, 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 = {
     lane?: string;
     searchType?: string;
@@ -75,6 +109,10 @@ type GetShipmentBagReasonsParam = {
      */
     lineNumber: number;
 };
+type GetStateManagerStatesParam = {
+    pageNo?: number;
+    pageSize?: number;
+};
 type TrackShipmentPlatformParam = {
     /**
      * - Shipment Id

package/sdk/platform/Order/OrderPlatformApplicationValidator.js

@@ -2,6 +2,14 @@ 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]
@@ -33,12 +41,28 @@ const OrderPlatformModel = require("./OrderPlatformModel");
  * @property {number} lineNumber - Line number of bag.
  */
 
+/**
+ * @typedef GetStateManagerStatesParam
+ * @property {number} [pageNo]
+ * @property {number} [pageSize]
+ */
+
 /**
  * @typedef TrackShipmentPlatformParam
  * @property {string} shipmentId - Shipment Id
  */
 
 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({
@@ -75,6 +99,14 @@ class OrderPlatformApplicationValidator {
     }).required();
   }
 
+  /** @returns {GetStateManagerStatesParam} */
+  static getStateManagerStates() {
+    return Joi.object({
+      pageNo: Joi.number(),
+      pageSize: Joi.number(),
+    }).required();
+  }
+
   /** @returns {TrackShipmentPlatformParam} */
   static trackShipmentPlatform() {
     return Joi.object({