@gofynd/fdk-client-javascript 1.1.6 → 1.2.0

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

@@ -1,15 +1,171 @@
-export = InventoryValidator;
-declare class InventoryValidator {
-    static createJob(): any;
-    static disable(): any;
+export = InventoryPlatformValidator;
+/**
+ * @typedef CreateJobParam
+ * @property {InventoryPlatformModel.JobConfigDTO} body
+ */
+/**
+ * @typedef DisableParam
+ * @property {string} integrationId - IntegrationId
+ */
+/** @typedef GetConfigByCompanyParam */
+/**
+ * @typedef GetJobByCodeParam
+ * @property {string} code - Job Code
+ */
+/**
+ * @typedef GetJobByCompanyAndIntegrationParam
+ * @property {string} integrationId - Integration Id
+ * @property {number} [pageNo] - Page Number
+ * @property {number} [pageSize] - Page Size
+ */
+/**
+ * @typedef GetJobCodeMetricsParam
+ * @property {string} code - Code
+ * @property {number} [pageNo] - Page Number
+ * @property {number} [pageSize] - Page Size
+ * @property {string} [status] - Status
+ * @property {string} [date] - From Date
+ */
+/**
+ * @typedef GetJobCodesByCompanyAndIntegrationParam
+ * @property {string} integrationId - Integration Id
+ * @property {number} [pageNo] - Page Number
+ * @property {number} [pageSize] - Page Size
+ */
+/** @typedef GetJobConfigDefaultsParam */
+/**
+ * @typedef GetJobStepsParam
+ * @property {number} jobId - Job Id
+ */
+/**
+ * @typedef GetJobsByCompanyParam
+ * @property {number} [pageNo] - Page Number
+ * @property {number} [pageSize] - Page Size
+ */
+/**
+ * @typedef SuppressStoresParam
+ * @property {InventoryPlatformModel.SuppressStorePayload} body
+ */
+/**
+ * @typedef UpdateJobParam
+ * @property {InventoryPlatformModel.JobConfigDTO} body
+ */
+declare class InventoryPlatformValidator {
+    /** @returns {CreateJobParam} */
+    static createJob(): CreateJobParam;
+    /** @returns {DisableParam} */
+    static disable(): DisableParam;
+    /** @returns {GetConfigByCompanyParam} */
     static getConfigByCompany(): any;
-    static getJobByCode(): any;
-    static getJobByCompanyAndIntegration(): any;
-    static getJobCodeMetrics(): any;
-    static getJobCodesByCompanyAndIntegration(): any;
+    /** @returns {GetJobByCodeParam} */
+    static getJobByCode(): GetJobByCodeParam;
+    /** @returns {GetJobByCompanyAndIntegrationParam} */
+    static getJobByCompanyAndIntegration(): GetJobByCompanyAndIntegrationParam;
+    /** @returns {GetJobCodeMetricsParam} */
+    static getJobCodeMetrics(): GetJobCodeMetricsParam;
+    /** @returns {GetJobCodesByCompanyAndIntegrationParam} */
+    static getJobCodesByCompanyAndIntegration(): GetJobCodesByCompanyAndIntegrationParam;
+    /** @returns {GetJobConfigDefaultsParam} */
     static getJobConfigDefaults(): any;
-    static getJobSteps(): any;
-    static getJobsByCompany(): any;
-    static suppressStores(): any;
-    static updateJob(): any;
+    /** @returns {GetJobStepsParam} */
+    static getJobSteps(): GetJobStepsParam;
+    /** @returns {GetJobsByCompanyParam} */
+    static getJobsByCompany(): GetJobsByCompanyParam;
+    /** @returns {SuppressStoresParam} */
+    static suppressStores(): SuppressStoresParam;
+    /** @returns {UpdateJobParam} */
+    static updateJob(): UpdateJobParam;
 }
+declare namespace InventoryPlatformValidator {
+    export { CreateJobParam, DisableParam, GetConfigByCompanyParam, GetJobByCodeParam, GetJobByCompanyAndIntegrationParam, GetJobCodeMetricsParam, GetJobCodesByCompanyAndIntegrationParam, GetJobConfigDefaultsParam, GetJobStepsParam, GetJobsByCompanyParam, SuppressStoresParam, UpdateJobParam };
+}
+type CreateJobParam = {
+    body: InventoryPlatformModel.JobConfigDTO;
+};
+type DisableParam = {
+    /**
+     * - IntegrationId
+     */
+    integrationId: string;
+};
+type GetJobByCodeParam = {
+    /**
+     * - Job Code
+     */
+    code: string;
+};
+type GetJobByCompanyAndIntegrationParam = {
+    /**
+     * - Integration Id
+     */
+    integrationId: string;
+    /**
+     * - Page Number
+     */
+    pageNo?: number;
+    /**
+     * - Page Size
+     */
+    pageSize?: number;
+};
+type GetJobCodeMetricsParam = {
+    /**
+     * - Code
+     */
+    code: string;
+    /**
+     * - Page Number
+     */
+    pageNo?: number;
+    /**
+     * - Page Size
+     */
+    pageSize?: number;
+    /**
+     * - Status
+     */
+    status?: string;
+    /**
+     * - From Date
+     */
+    date?: string;
+};
+type GetJobCodesByCompanyAndIntegrationParam = {
+    /**
+     * - Integration Id
+     */
+    integrationId: string;
+    /**
+     * - Page Number
+     */
+    pageNo?: number;
+    /**
+     * - Page Size
+     */
+    pageSize?: number;
+};
+type GetJobStepsParam = {
+    /**
+     * - Job Id
+     */
+    jobId: number;
+};
+type GetJobsByCompanyParam = {
+    /**
+     * - Page Number
+     */
+    pageNo?: number;
+    /**
+     * - Page Size
+     */
+    pageSize?: number;
+};
+type SuppressStoresParam = {
+    body: InventoryPlatformModel.SuppressStorePayload;
+};
+type UpdateJobParam = {
+    body: InventoryPlatformModel.JobConfigDTO;
+};
+type GetConfigByCompanyParam = any;
+type GetJobConfigDefaultsParam = any;
+import InventoryPlatformModel = require("./InventoryPlatformModel");

package/sdk/platform/Inventory/InventoryPlatformValidator.js

@@ -1,29 +1,98 @@
 const Joi = require("joi");
 
-const InventoryModel = require("./InventoryPlatformModel");
-class InventoryValidator {
+const InventoryPlatformModel = require("./InventoryPlatformModel");
+
+/**
+ * @typedef CreateJobParam
+ * @property {InventoryPlatformModel.JobConfigDTO} body
+ */
+
+/**
+ * @typedef DisableParam
+ * @property {string} integrationId - IntegrationId
+ */
+
+/** @typedef GetConfigByCompanyParam */
+
+/**
+ * @typedef GetJobByCodeParam
+ * @property {string} code - Job Code
+ */
+
+/**
+ * @typedef GetJobByCompanyAndIntegrationParam
+ * @property {string} integrationId - Integration Id
+ * @property {number} [pageNo] - Page Number
+ * @property {number} [pageSize] - Page Size
+ */
+
+/**
+ * @typedef GetJobCodeMetricsParam
+ * @property {string} code - Code
+ * @property {number} [pageNo] - Page Number
+ * @property {number} [pageSize] - Page Size
+ * @property {string} [status] - Status
+ * @property {string} [date] - From Date
+ */
+
+/**
+ * @typedef GetJobCodesByCompanyAndIntegrationParam
+ * @property {string} integrationId - Integration Id
+ * @property {number} [pageNo] - Page Number
+ * @property {number} [pageSize] - Page Size
+ */
+
+/** @typedef GetJobConfigDefaultsParam */
+
+/**
+ * @typedef GetJobStepsParam
+ * @property {number} jobId - Job Id
+ */
+
+/**
+ * @typedef GetJobsByCompanyParam
+ * @property {number} [pageNo] - Page Number
+ * @property {number} [pageSize] - Page Size
+ */
+
+/**
+ * @typedef SuppressStoresParam
+ * @property {InventoryPlatformModel.SuppressStorePayload} body
+ */
+
+/**
+ * @typedef UpdateJobParam
+ * @property {InventoryPlatformModel.JobConfigDTO} body
+ */
+
+class InventoryPlatformValidator {
+  /** @returns {CreateJobParam} */
   static createJob() {
     return Joi.object({
-      body: InventoryModel.JobConfigDTO().required(),
+      body: InventoryPlatformModel.JobConfigDTO().required(),
     }).required();
   }
 
+  /** @returns {DisableParam} */
   static disable() {
     return Joi.object({
       integrationId: Joi.string().allow("").required(),
     }).required();
   }
 
+  /** @returns {GetConfigByCompanyParam} */
   static getConfigByCompany() {
     return Joi.object({}).required();
   }
 
+  /** @returns {GetJobByCodeParam} */
   static getJobByCode() {
     return Joi.object({
       code: Joi.string().allow("").required(),
     }).required();
   }
 
+  /** @returns {GetJobByCompanyAndIntegrationParam} */
   static getJobByCompanyAndIntegration() {
     return Joi.object({
       integrationId: Joi.string().allow("").required(),
@@ -32,6 +101,7 @@ class InventoryValidator {
     }).required();
   }
 
+  /** @returns {GetJobCodeMetricsParam} */
   static getJobCodeMetrics() {
     return Joi.object({
       code: Joi.string().allow("").required(),
@@ -42,6 +112,7 @@ class InventoryValidator {
     }).required();
   }
 
+  /** @returns {GetJobCodesByCompanyAndIntegrationParam} */
   static getJobCodesByCompanyAndIntegration() {
     return Joi.object({
       integrationId: Joi.string().allow("").required(),
@@ -50,16 +121,19 @@ class InventoryValidator {
     }).required();
   }
 
+  /** @returns {GetJobConfigDefaultsParam} */
   static getJobConfigDefaults() {
     return Joi.object({}).required();
   }
 
+  /** @returns {GetJobStepsParam} */
   static getJobSteps() {
     return Joi.object({
       jobId: Joi.number().required(),
     }).required();
   }
 
+  /** @returns {GetJobsByCompanyParam} */
   static getJobsByCompany() {
     return Joi.object({
       pageNo: Joi.number(),
@@ -67,17 +141,19 @@ class InventoryValidator {
     }).required();
   }
 
+  /** @returns {SuppressStoresParam} */
   static suppressStores() {
     return Joi.object({
-      body: InventoryModel.SuppressStorePayload().required(),
+      body: InventoryPlatformModel.SuppressStorePayload().required(),
     }).required();
   }
 
+  /** @returns {UpdateJobParam} */
   static updateJob() {
     return Joi.object({
-      body: InventoryModel.JobConfigDTO().required(),
+      body: InventoryPlatformModel.JobConfigDTO().required(),
     }).required();
   }
 }
 
-module.exports = InventoryValidator;
+module.exports = InventoryPlatformValidator;

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

@@ -4,148 +4,128 @@ declare class Lead {
     config: any;
     applicationId: any;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.uniqueName - Unique name of Video Room
-     * @returns {Promise<CloseVideoRoomResponse>} - Success response
+     * @param {LeadPlatformApplicationValidator.CloseVideoRoomParam} arg - Arg object
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<LeadPlatformModel.CloseVideoRoomResponse>} - Success response
+     * @name closeVideoRoom
      * @summary: Close the video room and force all participants to leave.
-     * @description: Close the video room and force all participants to leave.
+     * @description: Close the video room and force all participants to leave. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/closeVideoRoom/).
      */
-    closeVideoRoom({ uniqueName }?: {
-        uniqueName: string;
-    }): Promise<CloseVideoRoomResponse>;
+    closeVideoRoom({ uniqueName }?: LeadPlatformApplicationValidator.CloseVideoRoomParam, { headers }?: import("../PlatformAPIClient").Options): Promise<LeadPlatformModel.CloseVideoRoomResponse>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {CreateCustomFormPayload} arg.body
-     * @returns {Promise<CustomForm>} - Success response
+     * @param {LeadPlatformApplicationValidator.CreateCustomFormParam} arg - Arg object
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<LeadPlatformModel.CustomForm>} - Success response
+     * @name createCustomForm
      * @summary: Creates a new custom form
-     * @description: Creates a new custom form for given application
+     * @description: Creates a new custom form for given application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/createCustomForm/).
      */
-    createCustomForm({ body }?: {
-        body: CreateCustomFormPayload;
-    }): Promise<CustomForm>;
+    createCustomForm({ body }?: LeadPlatformApplicationValidator.CreateCustomFormParam, { headers }?: import("../PlatformAPIClient").Options): Promise<LeadPlatformModel.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
+     * @param {LeadPlatformApplicationValidator.CreateHistoryParam} arg - Arg object
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<LeadPlatformModel.TicketHistory>} - Success response
+     * @name createHistory
      * @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.
+     * @description: Create history for specific application 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/platform/lead/createHistory/).
      */
-    createHistory({ id, body }?: {
-        id: string;
-        body: TicketHistoryPayload;
-    }): Promise<TicketHistory>;
+    createHistory({ id, body }?: LeadPlatformApplicationValidator.CreateHistoryParam, { headers }?: import("../PlatformAPIClient").Options): Promise<LeadPlatformModel.TicketHistory>;
     /**
-     * @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
+     * @param {LeadPlatformApplicationValidator.EditCustomFormParam} arg - Arg object
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<LeadPlatformModel.CustomForm>} - Success response
+     * @name editCustomForm
      * @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.
+     * @description: Edit the given custom form field such as adding or deleting input, assignee, title, decription, notification and polling information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/editCustomForm/).
      */
-    editCustomForm({ slug, body }?: {
-        slug: string;
-        body: EditCustomFormPayload;
-    }): Promise<CustomForm>;
+    editCustomForm({ slug, body }?: LeadPlatformApplicationValidator.EditCustomFormParam, { headers }?: import("../PlatformAPIClient").Options): Promise<LeadPlatformModel.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
+     * @param {LeadPlatformApplicationValidator.EditTicketParam} arg - Arg object
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<LeadPlatformModel.Ticket>} - Success response
+     * @name editTicket
      * @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
+     * @description: Edits ticket details of a application level ticket such as status, priority, category, tags, attachments, assigne & ticket content changes - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/editTicket/).
      */
-    editTicket({ id, body }?: {
-        id: string;
-        body: EditTicketPayload;
-    }): Promise<Ticket>;
+    editTicket({ id, body }?: LeadPlatformApplicationValidator.EditTicketParam, { headers }?: import("../PlatformAPIClient").Options): Promise<LeadPlatformModel.Ticket>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.slug - Slug of form whose response is getting submitted
-     * @returns {Promise<CustomForm>} - Success response
+     * @param {LeadPlatformApplicationValidator.GetCustomFormParam} arg - Arg object
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<LeadPlatformModel.CustomForm>} - Success response
+     * @name getCustomForm
      * @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.
+     * @description: Get specific custom form using it's slug, this is used to view the form. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getCustomForm/).
      */
-    getCustomForm({ slug }?: {
-        slug: string;
-    }): Promise<CustomForm>;
+    getCustomForm({ slug }?: LeadPlatformApplicationValidator.GetCustomFormParam, { headers }?: import("../PlatformAPIClient").Options): Promise<LeadPlatformModel.CustomForm>;
     /**
-     * @param {Object} arg - Arg object.
-     * @returns {Promise<CustomFormList>} - Success response
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<LeadPlatformModel.CustomFormList>} - Success response
+     * @name getCustomForms
      * @summary: Get list of custom form
-     * @description: Get list of custom form for given application
+     * @description: Get list of custom form for given application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getCustomForms/).
      */
-    getCustomForms({}?: any): Promise<CustomFormList>;
+    getCustomForms({ headers }?: import("../PlatformAPIClient").Options): Promise<LeadPlatformModel.CustomFormList>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.id - Tiket ID of the ticket to be fetched
-     * @returns {Promise<Ticket>} - Success response
+     * @param {LeadPlatformApplicationValidator.GetTicketParam} arg - Arg object
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<LeadPlatformModel.Ticket>} - Success response
+     * @name getTicket
      * @summary: Retreives ticket details of a application level ticket
-     * @description: Retreives ticket details of a application level ticket with ticket ID
+     * @description: Retreives ticket details of a application level ticket with ticket ID - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getTicket/).
      */
-    getTicket({ id }?: {
-        id: string;
-    }): Promise<Ticket>;
+    getTicket({ id }?: LeadPlatformApplicationValidator.GetTicketParam, { headers }?: import("../PlatformAPIClient").Options): Promise<LeadPlatformModel.Ticket>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.id - Ticket ID for which history is to be fetched
-     * @returns {Promise<TicketHistoryList>} - Success response
+     * @param {LeadPlatformApplicationValidator.GetTicketHistoryParam} arg - Arg object
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<LeadPlatformModel.TicketHistoryList>} - Success response
+     * @name getTicketHistory
      * @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.
+     * @description: Gets history list for specific application 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/platform/lead/getTicketHistory/).
      */
-    getTicketHistory({ id }?: {
-        id: string;
-    }): Promise<TicketHistoryList>;
+    getTicketHistory({ id }?: LeadPlatformApplicationValidator.GetTicketHistoryParam, { headers }?: import("../PlatformAPIClient").Options): Promise<LeadPlatformModel.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
+     * @param {LeadPlatformApplicationValidator.GetTicketsParam} arg - Arg object
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<LeadPlatformModel.TicketList>} - Success response
+     * @name getTickets
      * @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
+     * @description: Gets the list of Application level Tickets and/or ticket filters - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getTickets/).
      */
-    getTickets({ items, filters, q, status, priority, category }?: {
-        items?: boolean;
-        filters?: boolean;
-        q?: string;
-        status?: string;
-        priority?: PriorityEnum;
-        category?: string;
-    }): Promise<TicketList>;
+    getTickets({ items, filters, q, status, priority, category }?: LeadPlatformApplicationValidator.GetTicketsParam, { headers }?: import("../PlatformAPIClient").Options): Promise<LeadPlatformModel.TicketList>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.uniqueName - Unique name of video room
-     * @returns {Promise<GetTokenForVideoRoomResponse>} - Success response
+     * @param {LeadPlatformApplicationValidator.GetTokenForVideoRoomParam} arg
+     *   - Arg object
+     *
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<LeadPlatformModel.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.
+     * @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/platform/lead/getTokenForVideoRoom/).
      */
-    getTokenForVideoRoom({ uniqueName }?: {
-        uniqueName: string;
-    }): Promise<GetTokenForVideoRoomResponse>;
+    getTokenForVideoRoom({ uniqueName }?: LeadPlatformApplicationValidator.GetTokenForVideoRoomParam, { headers }?: import("../PlatformAPIClient").Options): Promise<LeadPlatformModel.GetTokenForVideoRoomResponse>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.uniqueName - Unique name of Video Room
-     * @returns {Promise<GetParticipantsInsideVideoRoomResponse>} - Success response
+     * @param {LeadPlatformApplicationValidator.GetVideoParticipantsParam} arg
+     *   - Arg object
+     *
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<LeadPlatformModel.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.
+     * @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/platform/lead/getVideoParticipants/).
      */
-    getVideoParticipants({ uniqueName }?: {
-        uniqueName: string;
-    }): Promise<GetParticipantsInsideVideoRoomResponse>;
+    getVideoParticipants({ uniqueName }?: LeadPlatformApplicationValidator.GetVideoParticipantsParam, { headers }?: import("../PlatformAPIClient").Options): Promise<LeadPlatformModel.GetParticipantsInsideVideoRoomResponse>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {CreateVideoRoomPayload} arg.body
-     * @returns {Promise<CreateVideoRoomResponse>} - Success response
+     * @param {LeadPlatformApplicationValidator.OpenVideoRoomParam} arg - Arg object
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<LeadPlatformModel.CreateVideoRoomResponse>} - Success response
+     * @name openVideoRoom
      * @summary: Open a video room.
-     * @description: Open a video room.
+     * @description: Open a video room. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/openVideoRoom/).
      */
-    openVideoRoom({ body }?: {
-        body: CreateVideoRoomPayload;
-    }): Promise<CreateVideoRoomResponse>;
+    openVideoRoom({ body }?: LeadPlatformApplicationValidator.OpenVideoRoomParam, { headers }?: import("../PlatformAPIClient").Options): Promise<LeadPlatformModel.CreateVideoRoomResponse>;
 }
+import LeadPlatformApplicationValidator = require("./LeadPlatformApplicationValidator");
+import LeadPlatformModel = require("./LeadPlatformModel");