@gofynd/fdk-client-javascript 1.2.0 → 1.3.0

package/sdk/platform/Lead/LeadPlatformValidator.js

@@ -3,7 +3,7 @@ const Joi = require("joi");
 const LeadPlatformModel = require("./LeadPlatformModel");
 
 /**
- * @typedef CreateHistoryParam
+ * @typedef CreatePlatformTicketHistoryParam
  * @property {string} id - Ticket ID for which history is created
  * @property {LeadPlatformModel.TicketHistoryPayload} body
  */
@@ -14,7 +14,7 @@ const LeadPlatformModel = require("./LeadPlatformModel");
  */
 
 /**
- * @typedef EditTicketParam
+ * @typedef EditPlatformTicketParam
  * @property {string} id - Ticket ID of ticket to be edited
  * @property {LeadPlatformModel.EditTicketPayload} body
  */
@@ -27,17 +27,17 @@ const LeadPlatformModel = require("./LeadPlatformModel");
 /** @typedef GetGeneralConfigParam */
 
 /**
- * @typedef GetTicketParam
+ * @typedef GetPlatformTicketParam
  * @property {string} id - Tiket ID of the ticket to be fetched
  */
 
 /**
- * @typedef GetTicketHistoryParam
+ * @typedef GetPlatformTicketHistoryParam
  * @property {string} id - Ticket ID for which history is to be fetched
  */
 
 /**
- * @typedef GetTicketsParam
+ * @typedef GetPlatformTicketsParam
  * @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
@@ -52,13 +52,13 @@ const LeadPlatformModel = require("./LeadPlatformModel");
  */
 
 /**
- * @typedef GetTokenForVideoRoomParam
- * @property {string} uniqueName - Unique name of video room
+ * @typedef GetPlatformVideoParticipantsParam
+ * @property {string} uniqueName - Unique name of Video Room
  */
 
 /**
- * @typedef GetVideoParticipantsParam
- * @property {string} uniqueName - Unique name of Video Room
+ * @typedef GetTokenForPlatformVideoRoomParam
+ * @property {string} uniqueName - Unique name of video room
  */
 
 /**
@@ -68,8 +68,8 @@ const LeadPlatformModel = require("./LeadPlatformModel");
  */
 
 class LeadPlatformValidator {
-  /** @returns {CreateHistoryParam} */
-  static createHistory() {
+  /** @returns {CreatePlatformTicketHistoryParam} */
+  static createPlatformTicketHistory() {
     return Joi.object({
       id: Joi.string().allow("").required(),
       body: LeadPlatformModel.TicketHistoryPayload().required(),
@@ -83,8 +83,8 @@ class LeadPlatformValidator {
     }).required();
   }
 
-  /** @returns {EditTicketParam} */
-  static editTicket() {
+  /** @returns {EditPlatformTicketParam} */
+  static editPlatformTicket() {
     return Joi.object({
       id: Joi.string().allow("").required(),
       body: LeadPlatformModel.EditTicketPayload().required(),
@@ -103,22 +103,22 @@ class LeadPlatformValidator {
     return Joi.object({}).required();
   }
 
-  /** @returns {GetTicketParam} */
-  static getTicket() {
+  /** @returns {GetPlatformTicketParam} */
+  static getPlatformTicket() {
     return Joi.object({
       id: Joi.string().allow("").required(),
     }).required();
   }
 
-  /** @returns {GetTicketHistoryParam} */
-  static getTicketHistory() {
+  /** @returns {GetPlatformTicketHistoryParam} */
+  static getPlatformTicketHistory() {
     return Joi.object({
       id: Joi.string().allow("").required(),
     }).required();
   }
 
-  /** @returns {GetTicketsParam} */
-  static getTickets() {
+  /** @returns {GetPlatformTicketsParam} */
+  static getPlatformTickets() {
     return Joi.object({
       items: Joi.boolean(),
       filters: Joi.boolean(),
@@ -131,15 +131,15 @@ class LeadPlatformValidator {
     }).required();
   }
 
-  /** @returns {GetTokenForVideoRoomParam} */
-  static getTokenForVideoRoom() {
+  /** @returns {GetPlatformVideoParticipantsParam} */
+  static getPlatformVideoParticipants() {
     return Joi.object({
       uniqueName: Joi.string().allow("").required(),
     }).required();
   }
 
-  /** @returns {GetVideoParticipantsParam} */
-  static getVideoParticipants() {
+  /** @returns {GetTokenForPlatformVideoRoomParam} */
+  static getTokenForPlatformVideoRoom() {
     return Joi.object({
       uniqueName: Joi.string().allow("").required(),
     }).required();

package/sdk/platform/OAuthClient.js

@@ -3,7 +3,7 @@ const { fdkAxios } = require("../common/AxiosHelper");
 const { sign } = require("../common/RequestSigner");
 const { FDKTokenIssueError, FDKOAuthCodeError } = require("../common/FDKError");
 const { Logger } = require("../common/Logger");
-const { btoa } = require("isomorphic-base64");
+const { convertStringToBase64 } = require("../common/utils");
 
 const refreshTokenRequestCache = {};
 class OAuthClient {
@@ -159,7 +159,11 @@ class OAuthClient {
     } else if (grant_type === "authorization_code") {
       reqData = { ...reqData, code };
     }
-    const token = btoa(`${this.config.apiKey}:${this.config.apiSecret}`);
+
+    const token = convertStringToBase64(
+      `${this.config.apiKey}:${this.config.apiSecret}`
+    );
+
     let url = `${this.config.domain}/service/panel/authentication/v1.0/company/${this.config.companyId}/oauth/token`;
     const rawRequest = {
       method: "post",

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

@@ -7,24 +7,26 @@ declare class Order {
      * @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
      * @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 }?: OrderPlatformApplicationValidator.GetPlatformShipmentReasonsParam, { headers }?: import("../PlatformAPIClient").Options): Promise<OrderPlatformModel.ShipmentReasonsResponse>;
+    getPlatformShipmentReasons({ action, requestHeaders }?: OrderPlatformApplicationValidator.GetPlatformShipmentReasonsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentReasonsResponse>;
     /**
      * @param {OrderPlatformApplicationValidator.TrackShipmentPlatformParam} arg
      *   - Arg object
      *
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
      * @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/).
      */
-    trackShipmentPlatform({ shipmentId }?: OrderPlatformApplicationValidator.TrackShipmentPlatformParam, { headers }?: import("../PlatformAPIClient").Options): Promise<OrderPlatformModel.PlatformShipmentTrack>;
+    trackShipmentPlatform({ shipmentId, requestHeaders }?: OrderPlatformApplicationValidator.TrackShipmentPlatformParam, { responseHeaders }?: object): Promise<OrderPlatformModel.PlatformShipmentTrack>;
 }
 import OrderPlatformApplicationValidator = require("./OrderPlatformApplicationValidator");
 import OrderPlatformModel = require("./OrderPlatformModel");

package/sdk/platform/Order/OrderPlatformApplicationClient.js

@@ -16,6 +16,7 @@ class Order {
    * @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
    * @name getPlatformShipmentReasons
@@ -23,8 +24,8 @@ class Order {
    * @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/).
    */
   async getPlatformShipmentReasons(
-    { action } = {},
-    { headers } = { headers: false }
+    { action, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
   ) {
     const {
       error,
@@ -62,12 +63,12 @@ class Order {
       `/service/platform/order/v1.0/company/${this.config.companyId}/application/${this.applicationId}/orders/shipments/reasons/${action}`,
       query_params,
       undefined,
-      undefined,
-      { headers }
+      requestHeaders,
+      { responseHeaders }
     );
 
     let responseData = response;
-    if (headers) {
+    if (responseHeaders) {
       responseData = response[0];
     }
 
@@ -92,6 +93,7 @@ class Order {
    * @param {OrderPlatformApplicationValidator.TrackShipmentPlatformParam} arg
    *   - Arg object
    *
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<OrderPlatformModel.PlatformShipmentTrack>} - Success response
    * @name trackShipmentPlatform
@@ -99,8 +101,8 @@ class Order {
    * @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/).
    */
   async trackShipmentPlatform(
-    { shipmentId } = {},
-    { headers } = { headers: false }
+    { shipmentId, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
   ) {
     const {
       error,
@@ -138,12 +140,12 @@ class Order {
       `/service/platform/order/v1.0/company/${this.config.companyId}/application/${this.applicationId}/orders/shipments/${shipmentId}/track`,
       query_params,
       undefined,
-      undefined,
-      { headers }
+      requestHeaders,
+      { responseHeaders }
     );
 
     let responseData = response;
-    if (headers) {
+    if (responseHeaders) {
       responseData = response[0];
     }