@gofynd/fdk-client-javascript 1.0.0 → 1.0.2

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

@@ -13,6 +13,7 @@ declare class Lead {
      * @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
      */
@@ -23,116 +24,128 @@ declare class Lead {
         status?: string;
         priority?: PriorityEnum;
         category?: string;
-    }): Promise<any>;
+    }): Promise<TicketList>;
     /**
      * @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 application level ticket
      * @description: Retreives ticket details of a application level ticket with ticket ID
      */
     getTicket({ id }?: {
         id: string;
-    }): Promise<any>;
+    }): 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 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;
         body: EditTicketPayload;
-    }): Promise<any>;
+    }): Promise<Ticket>;
     /**
      * @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
+     * @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.
      */
     getTicketHistory({ id }?: {
         id: string;
-    }): Promise<any>;
+    }): Promise<TicketHistoryList>;
     /**
      * @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
+     * @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.
      */
     editCustomForm({ slug, body }?: {
         slug: string;
         body: EditCustomFormPayload;
-    }): Promise<any>;
+    }): Promise<CustomForm>;
     /**
      * @param {Object} arg - Arg object.
+     * @returns {Promise<CustomFormList>} - Success response
      * @summary: Get list of custom form
      * @description: Get list of custom form for given application
      */
-    getCustomForms({}?: any): Promise<any>;
+    getCustomForms({}?: any): Promise<CustomFormList>;
     /**
      * @param {Object} arg - Arg object.
      * @param {CreateCustomFormPayload} arg.body
+     * @returns {Promise<CustomForm>} - Success response
      * @summary: Creates a new custom form
      * @description: Creates a new custom form for given application
      */
     createCustomForm({ body }?: {
         body: CreateCustomFormPayload;
-    }): Promise<any>;
+    }): Promise<CustomForm>;
     /**
      * @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>;
+    }): Promise<CreateVideoRoomResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @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.
      */
     closeVideoRoom({ uniqueName }?: {
         uniqueName: string;
-    }): Promise<any>;
+    }): Promise<CloseVideoRoomResponse>;
 }