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

package/sdk/partner/Lead/LeadPartnerClient.d.ts

@@ -0,0 +1,125 @@
+export = Lead;
+declare class Lead {
+    constructor(config: any);
+    config: any;
+    /**
+     * @param {LeadPartnerValidator.GetTicketsParam} arg - Arg object.
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PartnerAPIClient").Options} - Options
+     * @returns {Promise<LeadPartnerModel.TicketList>} - Success response
+     * @name getTickets
+     * @summary: Gets the list of partner level tickets and/or ticket filters depending on query params
+     * @description: Gets the list of partner level tickets and/or ticket filters - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/lead/getTickets/).
+     */
+    getTickets({ items, filters, q, status, priority, category, pageNo, pageSize, requestHeaders, }?: LeadPartnerValidator.GetTicketsParam, { responseHeaders }?: object): Promise<LeadPartnerModel.TicketList>;
+    /**
+     * @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 {LeadPartnerModel.PriorityEnum} [arg.priority] - Filter tickets on priority
+     * @param {string} [arg.category] - Filter tickets on category
+     * @param {number} [arg.pageSize] - Number of items to retrieve in each
+     *   page. Default is 12.
+     * @returns {Paginator<LeadPartnerModel.TicketList>}
+     * @summary: Gets the list of partner level tickets and/or ticket filters depending on query params
+     * @description: Gets the list of partner level tickets and/or ticket filters
+     */
+    getTicketsPaginator({ items, filters, q, status, priority, category, pageSize, }?: {
+        items?: boolean;
+        filters?: boolean;
+        q?: string;
+        status?: string;
+        priority?: LeadPartnerModel.PriorityEnum;
+        category?: string;
+        pageSize?: number;
+    }): Paginator<LeadPartnerModel.TicketList>;
+    /**
+     * @param {LeadPartnerValidator.CreateTicketParam} arg - Arg object.
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PartnerAPIClient").Options} - Options
+     * @returns {Promise<LeadPartnerModel.Ticket>} - Success response
+     * @name createTicket
+     * @summary: Creates a partner level ticket
+     * @description: Creates a partner level ticket - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/lead/createTicket/).
+     */
+    createTicket({ body, requestHeaders }?: LeadPartnerValidator.CreateTicketParam, { responseHeaders }?: object): Promise<LeadPartnerModel.Ticket>;
+    /**
+     * @param {LeadPartnerValidator.GetTicketParam} arg - Arg object.
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PartnerAPIClient").Options} - Options
+     * @returns {Promise<LeadPartnerModel.Ticket>} - Success response
+     * @name getTicket
+     * @summary: Retreives ticket details of a partner level ticket with ticket ID
+     * @description: Retreives ticket details of a partner level ticket - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/lead/getTicket/).
+     */
+    getTicket({ id, requestHeaders }?: LeadPartnerValidator.GetTicketParam, { responseHeaders }?: object): Promise<LeadPartnerModel.Ticket>;
+    /**
+     * @param {LeadPartnerValidator.EditTicketParam} arg - Arg object.
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PartnerAPIClient").Options} - Options
+     * @returns {Promise<LeadPartnerModel.Ticket>} - Success response
+     * @name editTicket
+     * @summary: Edits ticket details of a partner level ticket
+     * @description: Edits ticket details of a partner level ticket such as status, priority, category, tags, attachments, assigne & ticket content changes - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/lead/editTicket/).
+     */
+    editTicket({ id, body, requestHeaders }?: LeadPartnerValidator.EditTicketParam, { responseHeaders }?: object): Promise<LeadPartnerModel.Ticket>;
+    /**
+     * @param {LeadPartnerValidator.CreateHistoryParam} arg - Arg object.
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PartnerAPIClient").Options} - Options
+     * @returns {Promise<LeadPartnerModel.TicketHistory>} - Success response
+     * @name createHistory
+     * @summary: Create history for specific partner level ticket
+     * @description: Create history for specific partner level ticket, this history is seen on ticket detail page, this can be comment, log or rating. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/lead/createHistory/).
+     */
+    createHistory({ id, body, requestHeaders }?: LeadPartnerValidator.CreateHistoryParam, { responseHeaders }?: object): Promise<LeadPartnerModel.TicketHistory>;
+    /**
+     * @param {LeadPartnerValidator.GetTicketHistoryParam} arg - Arg object.
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PartnerAPIClient").Options} - Options
+     * @returns {Promise<LeadPartnerModel.TicketHistoryList>} - Success response
+     * @name getTicketHistory
+     * @summary: Gets history list for specific partner level ticket
+     * @description: Gets history list for specific partner level ticket, this history is seen on ticket detail page, this can be comment, log or rating. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/lead/getTicketHistory/).
+     */
+    getTicketHistory({ id, requestHeaders }?: LeadPartnerValidator.GetTicketHistoryParam, { responseHeaders }?: object): Promise<LeadPartnerModel.TicketHistoryList>;
+    /**
+     * @param {LeadPartnerValidator.GetTokenForVideoRoomParam} arg - Arg object.
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PartnerAPIClient").Options} - Options
+     * @returns {Promise<LeadPartnerModel.GetTokenForVideoRoomResponse>} -
+     *   Success response
+     * @name getTokenForVideoRoom
+     * @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. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/lead/getTokenForVideoRoom/).
+     */
+    getTokenForVideoRoom({ uniqueName, requestHeaders }?: LeadPartnerValidator.GetTokenForVideoRoomParam, { responseHeaders }?: object): Promise<LeadPartnerModel.GetTokenForVideoRoomResponse>;
+    /**
+     * @param {LeadPartnerValidator.GetVideoParticipantsParam} arg - Arg object.
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PartnerAPIClient").Options} - Options
+     * @returns {Promise<LeadPartnerModel.GetParticipantsInsideVideoRoomResponse>}
+     *   - Success response
+     *
+     * @name getVideoParticipants
+     * @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. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/lead/getVideoParticipants/).
+     */
+    getVideoParticipants({ uniqueName, requestHeaders }?: LeadPartnerValidator.GetVideoParticipantsParam, { responseHeaders }?: object): Promise<LeadPartnerModel.GetParticipantsInsideVideoRoomResponse>;
+    /**
+     * @param {LeadPartnerValidator.GetGeneralConfigParam} arg - Arg object.
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PartnerAPIClient").Options} - Options
+     * @returns {Promise<LeadPartnerModel.GeneralConfigResponse>} - Success response
+     * @name getGeneralConfig
+     * @summary: Get general support configuration.
+     * @description: Get general support configuration. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/lead/getGeneralConfig/).
+     */
+    getGeneralConfig({ requestHeaders }?: LeadPartnerValidator.GetGeneralConfigParam, { responseHeaders }?: object): Promise<LeadPartnerModel.GeneralConfigResponse>;
+}
+import LeadPartnerModel = require("./LeadPartnerModel");
+import Paginator = require("../../common/Paginator");