@gofynd/fdk-client-javascript 1.0.1 → 1.0.3

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

@@ -1,16 +1,16 @@
 export = LeadValidator;
 declare class LeadValidator {
-    static getTickets(): any;
-    static getTicket(): any;
-    static editTicket(): any;
+    static closeVideoRoom(): any;
+    static createCustomForm(): any;
     static createHistory(): any;
-    static getTicketHistory(): any;
-    static getCustomForm(): any;
     static editCustomForm(): any;
+    static editTicket(): any;
+    static getCustomForm(): any;
     static getCustomForms(): any;
-    static createCustomForm(): any;
+    static getTicket(): any;
+    static getTicketHistory(): any;
+    static getTickets(): any;
     static getTokenForVideoRoom(): any;
     static getVideoParticipants(): any;
     static openVideoRoom(): any;
-    static closeVideoRoom(): any;
 }

package/sdk/platform/Lead/LeadPlatformApplicationValidator.js

@@ -2,40 +2,36 @@ const Joi = require("joi");
 const LeadModel = require("./LeadPlatformModel");
 
 class LeadValidator {
-  static getTickets() {
+  static closeVideoRoom() {
     return Joi.object({
-      items: Joi.boolean(),
-      filters: Joi.boolean(),
-      q: Joi.string().allow(""),
-      status: Joi.string().allow(""),
-      priority: LeadModel.PriorityEnum(),
-      category: Joi.string().allow(""),
+      uniqueName: Joi.string().allow("").required(),
     }).required();
   }
 
-  static getTicket() {
+  static createCustomForm() {
     return Joi.object({
-      id: Joi.string().allow("").required(),
+      body: LeadModel.CreateCustomFormPayload().required(),
     }).required();
   }
 
-  static editTicket() {
+  static createHistory() {
     return Joi.object({
       id: Joi.string().allow("").required(),
-      body: LeadModel.EditTicketPayload().required(),
+      body: LeadModel.TicketHistoryPayload().required(),
     }).required();
   }
 
-  static createHistory() {
+  static editCustomForm() {
     return Joi.object({
-      id: Joi.string().allow("").required(),
-      body: LeadModel.TicketHistoryPayload().required(),
+      slug: Joi.string().allow("").required(),
+      body: LeadModel.EditCustomFormPayload().required(),
     }).required();
   }
 
-  static getTicketHistory() {
+  static editTicket() {
     return Joi.object({
       id: Joi.string().allow("").required(),
+      body: LeadModel.EditTicketPayload().required(),
     }).required();
   }
 
@@ -45,20 +41,30 @@ class LeadValidator {
     }).required();
   }
 
-  static editCustomForm() {
+  static getCustomForms() {
+    return Joi.object({}).required();
+  }
+
+  static getTicket() {
     return Joi.object({
-      slug: Joi.string().allow("").required(),
-      body: LeadModel.EditCustomFormPayload().required(),
+      id: Joi.string().allow("").required(),
     }).required();
   }
 
-  static getCustomForms() {
-    return Joi.object({}).required();
+  static getTicketHistory() {
+    return Joi.object({
+      id: Joi.string().allow("").required(),
+    }).required();
   }
 
-  static createCustomForm() {
+  static getTickets() {
     return Joi.object({
-      body: LeadModel.CreateCustomFormPayload().required(),
+      items: Joi.boolean(),
+      filters: Joi.boolean(),
+      q: Joi.string().allow(""),
+      status: Joi.string().allow(""),
+      priority: LeadModel.PriorityEnum(),
+      category: Joi.string().allow(""),
     }).required();
   }
 
@@ -79,12 +85,6 @@ class LeadValidator {
       body: LeadModel.CreateVideoRoomPayload().required(),
     }).required();
   }
-
-  static closeVideoRoom() {
-    return Joi.object({
-      uniqueName: Joi.string().allow("").required(),
-    }).required();
-  }
 }
 
 module.exports = LeadValidator;

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

@@ -2,6 +2,77 @@ export = Lead;
 declare class Lead {
     constructor(config: any);
     config: any;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.id - Ticket ID for which history is created
+     * @param {TicketHistoryPayload} arg.body
+     * @returns {Promise<TicketHistory>} - Success response
+     * @summary: Create history for specific company level ticket
+     * @description: Create history for specific company level ticket, this history is seen on ticket detail page, this can be comment, log or rating.
+     */
+    createHistory({ id, body }?: {
+        id: string;
+        body: TicketHistoryPayload;
+    }): Promise<TicketHistory>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {AddTicketPayload} arg.body
+     * @returns {Promise<Ticket>} - Success response
+     * @summary: Creates a company level ticket
+     * @description: Creates a company level ticket
+     */
+    createTicket({ body }?: {
+        body: AddTicketPayload;
+    }): Promise<Ticket>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.id - Ticket ID of ticket to be edited
+     * @param {EditTicketPayload} arg.body
+     * @returns {Promise<Ticket>} - Success response
+     * @summary: Edits ticket details of a company level ticket
+     * @description: Edits ticket details of a company level ticket such as status, priority, category, tags, attachments, assigne & ticket content changes
+     */
+    editTicket({ id, body }?: {
+        id: string;
+        body: EditTicketPayload;
+    }): Promise<Ticket>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.id - Ticket ID for which feedbacks are to be fetched
+     * @returns {Promise<TicketFeedbackList>} - Success response
+     * @summary: Gets a list of feedback submitted against that ticket
+     * @description: Gets a list of feedback submitted against that ticket
+     */
+    getFeedbacks({ id }?: {
+        id: string;
+    }): Promise<TicketFeedbackList>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @returns {Promise<CloseVideoRoomResponse>} - Success response
+     * @summary: Get general support configuration.
+     * @description: Get general support configuration.
+     */
+    getGeneralConfig({}?: any): Promise<CloseVideoRoomResponse>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.id - Tiket ID of the ticket to be fetched
+     * @returns {Promise<Ticket>} - Success response
+     * @summary: Retreives ticket details of a company level ticket with ticket ID
+     * @description: Retreives ticket details of a company level ticket
+     */
+    getTicket({ id }?: {
+        id: string;
+    }): Promise<Ticket>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.id - Ticket ID for which history is to be fetched
+     * @returns {Promise<TicketHistoryList>} - Success response
+     * @summary: Gets history list for specific company level ticket
+     * @description: Gets history list for specific company level ticket, this history is seen on ticket detail page, this can be comment, log or rating.
+     */
+    getTicketHistory({ id }?: {
+        id: string;
+    }): Promise<TicketHistoryList>;
     /**
      * @param {Object} arg - Arg object.
      * @param {boolean} [arg.items] - Decides that the reponse will contain the
@@ -16,6 +87,7 @@ declare class Lead {
      *   given set of results.
      * @param {number} [arg.pageSize] - Number of items to retrieve in each
      *   page. Default is 12.
+     * @returns {Promise<TicketList>} - Success response
      * @summary: Gets the list of company level tickets and/or ticket filters depending on query params
      * @description: Gets the list of company level tickets and/or ticket filters
      */
@@ -28,7 +100,7 @@ declare class Lead {
         category?: string;
         pageNo?: number;
         pageSize?: number;
-    }): Promise<any>;
+    }): Promise<TicketList>;
     /**
      * @param {Object} arg - Arg object.
      * @param {boolean} [arg.items] - Decides that the reponse will contain the
@@ -53,98 +125,37 @@ declare class Lead {
         category?: string;
         pageSize?: number;
     }): Paginator;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {AddTicketPayload} arg.body
-     * @summary: Creates a company level ticket
-     * @description: Creates a company level ticket
-     */
-    createTicket({ body }?: {
-        body: AddTicketPayload;
-    }): Promise<any>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.id - Tiket ID of the ticket to be fetched
-     * @summary: Retreives ticket details of a company level ticket with ticket ID
-     * @description: Retreives ticket details of a company level ticket
-     */
-    getTicket({ id }?: {
-        id: string;
-    }): Promise<any>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.id - Ticket ID of ticket to be edited
-     * @param {EditTicketPayload} arg.body
-     * @summary: Edits ticket details of a company level ticket
-     * @description: Edits ticket details of a company level ticket such as status, priority, category, tags, attachments, assigne & ticket content changes
-     */
-    editTicket({ id, body }?: {
-        id: string;
-        body: EditTicketPayload;
-    }): Promise<any>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.id - Ticket ID for which history is created
-     * @param {TicketHistoryPayload} arg.body
-     * @summary: Create history for specific company level ticket
-     * @description: Create history for specific company level ticket, this history is seen on ticket detail page, this can be comment, log or rating.
-     */
-    createHistory({ id, body }?: {
-        id: string;
-        body: TicketHistoryPayload;
-    }): Promise<any>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.id - Ticket ID for which history is to be fetched
-     * @summary: Gets history list for specific company level ticket
-     * @description: Gets history list for specific company level ticket, this history is seen on ticket detail page, this can be comment, log or rating.
-     */
-    getTicketHistory({ id }?: {
-        id: string;
-    }): Promise<any>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.id - Ticket ID for which feedbacks are to be fetched
-     * @summary: Gets a list of feedback submitted against that ticket
-     * @description: Gets a list of feedback submitted against that ticket
-     */
-    getFeedbacks({ id }?: {
-        id: string;
-    }): Promise<any>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.id - Ticket ID for which feedback is to be submitted
-     * @param {TicketFeedbackPayload} arg.body
-     * @summary: Submit a response for feeback form against that ticket
-     * @description: Submit a response for feeback form against that ticket
-     */
-    submitFeedback({ id, body }?: {
-        id: string;
-        body: TicketFeedbackPayload;
-    }): Promise<any>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.uniqueName - Unique name of video room
+     * @returns {Promise<GetTokenForVideoRoomResponse>} - Success response
      * @summary: Get Token to join a specific Video Room using it's unqiue name
      * @description: Get Token to join a specific Video Room using it's unqiue name, this Token is your ticket to Room and also creates your identity there.
      */
     getTokenForVideoRoom({ uniqueName }?: {
         uniqueName: string;
-    }): Promise<any>;
+    }): Promise<GetTokenForVideoRoomResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.uniqueName - Unique name of Video Room
+     * @returns {Promise<GetParticipantsInsideVideoRoomResponse>} - Success response
      * @summary: Get participants of a specific Video Room using it's unique name
      * @description: Get participants of a specific Video Room using it's unique name, this can be used to check if people are already there in the room and also to show their names.
      */
     getVideoParticipants({ uniqueName }?: {
         uniqueName: string;
-    }): Promise<any>;
+    }): Promise<GetParticipantsInsideVideoRoomResponse>;
     /**
      * @param {Object} arg - Arg object.
-     * @summary: Get general support configuration.
-     * @description: Get general support configuration.
+     * @param {string} arg.id - Ticket ID for which feedback is to be submitted
+     * @param {TicketFeedbackPayload} arg.body
+     * @returns {Promise<TicketFeedback>} - Success response
+     * @summary: Submit a response for feeback form against that ticket
+     * @description: Submit a response for feeback form against that ticket
      */
-    getGeneralConfig({}?: any): Promise<any>;
+    submitFeedback({ id, body }?: {
+        id: string;
+        body: TicketFeedbackPayload;
+    }): Promise<TicketFeedback>;
 }
 import Paginator = require("../../common/Paginator");