@gofynd/fdk-client-javascript 1.0.1 → 1.0.3

package/sdk/platform/Inventory/InventoryPlatformValidator.d.ts

@@ -1,15 +1,15 @@
 export = InventoryValidator;
 declare class InventoryValidator {
-    static getJobsByCompany(): any;
-    static updateJob(): any;
     static createJob(): any;
-    static suppressStores(): any;
-    static getConfigByCompany(): any;
-    static getJobSteps(): any;
-    static getJobByCompanyAndIntegration(): any;
     static disable(): any;
-    static getJobConfigDefaults(): any;
+    static getConfigByCompany(): any;
     static getJobByCode(): any;
+    static getJobByCompanyAndIntegration(): any;
     static getJobCodeMetrics(): any;
     static getJobCodesByCompanyAndIntegration(): any;
+    static getJobConfigDefaults(): any;
+    static getJobSteps(): any;
+    static getJobsByCompany(): any;
+    static suppressStores(): any;
+    static updateJob(): any;
 }

package/sdk/platform/Inventory/InventoryPlatformValidator.js

@@ -2,28 +2,15 @@ const Joi = require("joi");
 
 const InventoryModel = require("./InventoryPlatformModel");
 class InventoryValidator {
-  static getJobsByCompany() {
-    return Joi.object({
-      pageNo: Joi.number(),
-      pageSize: Joi.number(),
-    }).required();
-  }
-
-  static updateJob() {
-    return Joi.object({
-      body: InventoryModel.JobConfigDTO().required(),
-    }).required();
-  }
-
   static createJob() {
     return Joi.object({
       body: InventoryModel.JobConfigDTO().required(),
     }).required();
   }
 
-  static suppressStores() {
+  static disable() {
     return Joi.object({
-      body: InventoryModel.SuppressStorePayload().required(),
+      integrationId: Joi.string().allow("").required(),
     }).required();
   }
 
@@ -31,9 +18,9 @@ class InventoryValidator {
     return Joi.object({}).required();
   }
 
-  static getJobSteps() {
+  static getJobByCode() {
     return Joi.object({
-      jobId: Joi.number().required(),
+      code: Joi.string().allow("").required(),
     }).required();
   }
 
@@ -45,9 +32,21 @@ class InventoryValidator {
     }).required();
   }
 
-  static disable() {
+  static getJobCodeMetrics() {
+    return Joi.object({
+      code: Joi.string().allow("").required(),
+      pageNo: Joi.number(),
+      pageSize: Joi.number(),
+      status: Joi.string().allow(""),
+      date: Joi.string().allow(""),
+    }).required();
+  }
+
+  static getJobCodesByCompanyAndIntegration() {
     return Joi.object({
       integrationId: Joi.string().allow("").required(),
+      pageNo: Joi.number(),
+      pageSize: Joi.number(),
     }).required();
   }
 
@@ -55,27 +54,28 @@ class InventoryValidator {
     return Joi.object({}).required();
   }
 
-  static getJobByCode() {
+  static getJobSteps() {
     return Joi.object({
-      code: Joi.string().allow("").required(),
+      jobId: Joi.number().required(),
     }).required();
   }
 
-  static getJobCodeMetrics() {
+  static getJobsByCompany() {
     return Joi.object({
-      code: Joi.string().allow("").required(),
       pageNo: Joi.number(),
       pageSize: Joi.number(),
-      status: Joi.string().allow(""),
-      date: Joi.string().allow(""),
     }).required();
   }
 
-  static getJobCodesByCompanyAndIntegration() {
+  static suppressStores() {
     return Joi.object({
-      integrationId: Joi.string().allow("").required(),
-      pageNo: Joi.number(),
-      pageSize: Joi.number(),
+      body: InventoryModel.SuppressStorePayload().required(),
+    }).required();
+  }
+
+  static updateJob() {
+    return Joi.object({
+      body: InventoryModel.JobConfigDTO().required(),
     }).required();
   }
 }

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

@@ -5,134 +5,147 @@ declare class Lead {
     applicationId: any;
     /**
      * @param {Object} arg - Arg object.
-     * @param {boolean} [arg.items] - Decides that the reponse will contain the
-     *   list of tickets
-     * @param {boolean} [arg.filters] - Decides that the reponse will contain
-     *   the ticket filters
-     * @param {string} [arg.q] - Search through ticket titles and description
-     * @param {string} [arg.status] - Filter tickets on status
-     * @param {PriorityEnum} [arg.priority] - Filter tickets on priority
-     * @param {string} [arg.category] - Filter tickets on category
-     * @summary: Gets the list of Application level Tickets and/or ticket filters depending on query params
-     * @description: Gets the list of Application level Tickets and/or ticket filters
-     */
-    getTickets({ items, filters, q, status, priority, category }?: {
-        items?: boolean;
-        filters?: boolean;
-        q?: string;
-        status?: string;
-        priority?: PriorityEnum;
-        category?: string;
-    }): 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 application level ticket
-     * @description: Retreives ticket details of a application level ticket with ticket ID
+     * @param {string} arg.uniqueName - Unique name of Video Room
+     * @returns {Promise<CloseVideoRoomResponse>} - Success response
+     * @summary: Close the video room and force all participants to leave.
+     * @description: Close the video room and force all participants to leave.
      */
-    getTicket({ id }?: {
-        id: string;
-    }): Promise<any>;
+    closeVideoRoom({ uniqueName }?: {
+        uniqueName: string;
+    }): Promise<CloseVideoRoomResponse>;
     /**
      * @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 application level ticket
-     * @description: Edits ticket details of a application level ticket such as status, priority, category, tags, attachments, assigne & ticket content changes
+     * @param {CreateCustomFormPayload} arg.body
+     * @returns {Promise<CustomForm>} - Success response
+     * @summary: Creates a new custom form
+     * @description: Creates a new custom form for given application
      */
-    editTicket({ id, body }?: {
-        id: string;
-        body: EditTicketPayload;
-    }): Promise<any>;
+    createCustomForm({ body }?: {
+        body: CreateCustomFormPayload;
+    }): Promise<CustomForm>;
     /**
      * @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 application level ticket
      * @description: Create history for specific application 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>;
+    }): Promise<TicketHistory>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {string} arg.id - Ticket ID for which history is to be fetched
-     * @summary: Gets history list for specific application level ticket
-     * @description: Gets history list for specific application level ticket, this history is seen on ticket detail page, this can be comment, log or rating.
+     * @param {string} arg.slug - Slug of form whose response is getting submitted
+     * @param {EditCustomFormPayload} arg.body
+     * @returns {Promise<CustomForm>} - Success response
+     * @summary: Edit the given custom form
+     * @description: Edit the given custom form field such as adding or deleting input, assignee, title, decription, notification and polling information.
      */
-    getTicketHistory({ id }?: {
+    editCustomForm({ slug, body }?: {
+        slug: string;
+        body: EditCustomFormPayload;
+    }): Promise<CustomForm>;
+    /**
+     * @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 application level ticket
+     * @description: Edits ticket details of a application level ticket such as status, priority, category, tags, attachments, assigne & ticket content changes
+     */
+    editTicket({ id, body }?: {
         id: string;
-    }): Promise<any>;
+        body: EditTicketPayload;
+    }): Promise<Ticket>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.slug - Slug of form whose response is getting submitted
+     * @returns {Promise<CustomForm>} - Success response
      * @summary: Get specific custom form using it's slug
      * @description: Get specific custom form using it's slug, this is used to view the form.
      */
     getCustomForm({ slug }?: {
         slug: string;
-    }): Promise<any>;
+    }): Promise<CustomForm>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {string} arg.slug - Slug of form whose response is getting submitted
-     * @param {EditCustomFormPayload} arg.body
-     * @summary: Edit the given custom form
-     * @description: Edit the given custom form field such as adding or deleting input, assignee, title, decription, notification and polling information.
+     * @returns {Promise<CustomFormList>} - Success response
+     * @summary: Get list of custom form
+     * @description: Get list of custom form for given application
      */
-    editCustomForm({ slug, body }?: {
-        slug: string;
-        body: EditCustomFormPayload;
-    }): Promise<any>;
+    getCustomForms({}?: any): Promise<CustomFormList>;
     /**
      * @param {Object} arg - Arg object.
-     * @summary: Get list of custom form
-     * @description: Get list of custom form for given application
+     * @param {string} arg.id - Tiket ID of the ticket to be fetched
+     * @returns {Promise<Ticket>} - Success response
+     * @summary: Retreives ticket details of a application level ticket
+     * @description: Retreives ticket details of a application level ticket with ticket ID
      */
-    getCustomForms({}?: any): Promise<any>;
+    getTicket({ id }?: {
+        id: string;
+    }): Promise<Ticket>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {CreateCustomFormPayload} arg.body
-     * @summary: Creates a new custom form
-     * @description: Creates a new custom form for given application
+     * @param {string} arg.id - Ticket ID for which history is to be fetched
+     * @returns {Promise<TicketHistoryList>} - Success response
+     * @summary: Gets history list for specific application level ticket
+     * @description: Gets history list for specific application level ticket, this history is seen on ticket detail page, this can be comment, log or rating.
      */
-    createCustomForm({ body }?: {
-        body: CreateCustomFormPayload;
-    }): Promise<any>;
+    getTicketHistory({ id }?: {
+        id: string;
+    }): Promise<TicketHistoryList>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {boolean} [arg.items] - Decides that the reponse will contain the
+     *   list of tickets
+     * @param {boolean} [arg.filters] - Decides that the reponse will contain
+     *   the ticket filters
+     * @param {string} [arg.q] - Search through ticket titles and description
+     * @param {string} [arg.status] - Filter tickets on status
+     * @param {PriorityEnum} [arg.priority] - Filter tickets on priority
+     * @param {string} [arg.category] - Filter tickets on category
+     * @returns {Promise<TicketList>} - Success response
+     * @summary: Gets the list of Application level Tickets and/or ticket filters depending on query params
+     * @description: Gets the list of Application level Tickets and/or ticket filters
+     */
+    getTickets({ items, filters, q, status, priority, category }?: {
+        items?: boolean;
+        filters?: boolean;
+        q?: string;
+        status?: string;
+        priority?: PriorityEnum;
+        category?: string;
+    }): Promise<TicketList>;
     /**
      * @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.
      * @param {CreateVideoRoomPayload} arg.body
+     * @returns {Promise<CreateVideoRoomResponse>} - Success response
      * @summary: Open a video room.
      * @description: Open a video room.
      */
     openVideoRoom({ body }?: {
         body: CreateVideoRoomPayload;
-    }): Promise<any>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.uniqueName - Unique name of Video Room
-     * @summary: Close the video room and force all participants to leave.
-     * @description: Close the video room and force all participants to leave.
-     */
-    closeVideoRoom({ uniqueName }?: {
-        uniqueName: string;
-    }): Promise<any>;
+    }): Promise<CreateVideoRoomResponse>;
 }