@gofynd/fdk-client-javascript 1.4.7 → 1.4.8-beta.3

package/sdk/platform/Lead/LeadPlatformClient.js

@@ -336,7 +336,7 @@ class Lead {
    * @param {LeadPlatformValidator.GetGeneralConfigParam} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<LeadPlatformModel.CloseVideoRoomResponse>} - Success response
+   * @returns {Promise<LeadPlatformModel.GeneralConfigResponse>} - Success response
    * @name getGeneralConfig
    * @summary: Get general configuration
    * @description: Get general configuration settings related to support system for company tickets - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getGeneralConfig/).
@@ -388,7 +388,7 @@ class Lead {
 
     const {
       error: res_error,
-    } = LeadPlatformModel.CloseVideoRoomResponse().validate(responseData, {
+    } = LeadPlatformModel.GeneralConfigResponse().validate(responseData, {
       abortEarly: false,
       allowUnknown: true,
     });
@@ -676,171 +676,6 @@ class Lead {
     return response;
   }
 
-  /**
-   * @param {LeadPlatformValidator.GetPlatformVideoParticipantsParam} arg - Arg object
-   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-   * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<LeadPlatformModel.GetParticipantsInsideVideoRoomResponse>}
-   *   - Success response
-   *
-   * @name getPlatformVideoParticipants
-   * @summary: List video Room Participants
-   * @description: Get a list of participants in a platform video room - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getPlatformVideoParticipants/).
-   */
-  async getPlatformVideoParticipants(
-    { uniqueName, requestHeaders } = { requestHeaders: {} },
-    { responseHeaders } = { responseHeaders: false }
-  ) {
-    const {
-      error,
-    } = LeadPlatformValidator.getPlatformVideoParticipants().validate(
-      {
-        uniqueName,
-      },
-      { abortEarly: false, allowUnknown: true }
-    );
-    if (error) {
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
-    // Showing warrnings if extra unknown parameters are found
-    const {
-      error: warrning,
-    } = LeadPlatformValidator.getPlatformVideoParticipants().validate(
-      {
-        uniqueName,
-      },
-      { abortEarly: false, allowUnknown: false }
-    );
-    if (warrning) {
-      Logger({
-        level: "WARN",
-        message: `Parameter Validation warrnings for platform > Lead > getPlatformVideoParticipants \n ${warrning}`,
-      });
-    }
-
-    const query_params = {};
-
-    const xHeaders = {};
-
-    const response = await PlatformAPIClient.execute(
-      this.config,
-      "get",
-      `/service/platform/lead/v1.0/company/${this.config.companyId}/video/room/${uniqueName}/participants`,
-      query_params,
-      undefined,
-      { ...xHeaders, ...requestHeaders },
-      { responseHeaders }
-    );
-
-    let responseData = response;
-    if (responseHeaders) {
-      responseData = response[0];
-    }
-
-    const {
-      error: res_error,
-    } = LeadPlatformModel.GetParticipantsInsideVideoRoomResponse().validate(
-      responseData,
-      { abortEarly: false, allowUnknown: true }
-    );
-
-    if (res_error) {
-      if (this.config.options.strictResponseCheck === true) {
-        return Promise.reject(new FDKResponseValidationError(res_error));
-      } else {
-        Logger({
-          level: "WARN",
-          message: `Response Validation Warnings for platform > Lead > getPlatformVideoParticipants \n ${res_error}`,
-        });
-      }
-    }
-
-    return response;
-  }
-
-  /**
-   * @param {LeadPlatformValidator.GetTokenForPlatformVideoRoomParam} arg - Arg object
-   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-   * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<LeadPlatformModel.GetTokenForVideoRoomResponse>} -
-   *   Success response
-   * @name getTokenForPlatformVideoRoom
-   * @summary: Get video Room Token
-   * @description: Get an access token for a platform video room. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getTokenForPlatformVideoRoom/).
-   */
-  async getTokenForPlatformVideoRoom(
-    { uniqueName, requestHeaders } = { requestHeaders: {} },
-    { responseHeaders } = { responseHeaders: false }
-  ) {
-    const {
-      error,
-    } = LeadPlatformValidator.getTokenForPlatformVideoRoom().validate(
-      {
-        uniqueName,
-      },
-      { abortEarly: false, allowUnknown: true }
-    );
-    if (error) {
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
-    // Showing warrnings if extra unknown parameters are found
-    const {
-      error: warrning,
-    } = LeadPlatformValidator.getTokenForPlatformVideoRoom().validate(
-      {
-        uniqueName,
-      },
-      { abortEarly: false, allowUnknown: false }
-    );
-    if (warrning) {
-      Logger({
-        level: "WARN",
-        message: `Parameter Validation warrnings for platform > Lead > getTokenForPlatformVideoRoom \n ${warrning}`,
-      });
-    }
-
-    const query_params = {};
-
-    const xHeaders = {};
-
-    const response = await PlatformAPIClient.execute(
-      this.config,
-      "get",
-      `/service/platform/lead/v1.0/company/${this.config.companyId}/video/room/${uniqueName}/token`,
-      query_params,
-      undefined,
-      { ...xHeaders, ...requestHeaders },
-      { responseHeaders }
-    );
-
-    let responseData = response;
-    if (responseHeaders) {
-      responseData = response[0];
-    }
-
-    const {
-      error: res_error,
-    } = LeadPlatformModel.GetTokenForVideoRoomResponse().validate(
-      responseData,
-      { abortEarly: false, allowUnknown: true }
-    );
-
-    if (res_error) {
-      if (this.config.options.strictResponseCheck === true) {
-        return Promise.reject(new FDKResponseValidationError(res_error));
-      } else {
-        Logger({
-          level: "WARN",
-          message: `Response Validation Warnings for platform > Lead > getTokenForPlatformVideoRoom \n ${res_error}`,
-        });
-      }
-    }
-
-    return response;
-  }
-
   /**
    * @param {LeadPlatformValidator.SubmitFeedbackParam} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`

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

@@ -1,4 +1,37 @@
 export = LeadPlatformModel;
+/**
+ * @typedef GeneralConfigResponse
+ * @property {string} [_id]
+ * @property {SupportCommunicationSchema[]} [support_communication]
+ * @property {boolean} [show_communication_info]
+ * @property {boolean} [show_support_dris]
+ * @property {string} [type]
+ * @property {GeneralConfigIntegrationSchema} [integration]
+ * @property {boolean} [allow_ticket_creation]
+ * @property {boolean} [show_listing]
+ * @property {string[]} [available_integration]
+ * @property {boolean} [enable_dris]
+ * @property {SupportSchema} [support_email]
+ * @property {SupportSchema} [support_phone]
+ * @property {SupportSchema} [support_faq]
+ */
+/**
+ * @typedef SupportCommunicationSchema
+ * @property {string} [type]
+ * @property {string} [title]
+ * @property {string} [description]
+ * @property {boolean} [enabled]
+ */
+/**
+ * @typedef SupportSchema
+ * @property {string} [value]
+ * @property {string} [description]
+ * @property {boolean} [enabled]
+ */
+/**
+ * @typedef GeneralConfigIntegrationSchema
+ * @property {string} [type]
+ */
 /**
  * @typedef TicketList
  * @property {Ticket[]} [items] - List of tickets
@@ -68,24 +101,6 @@ export = LeadPlatformModel;
  * @typedef AgentChangePayload
  * @property {string} agent_id - Agent's unique ID
  */
-/**
- * @typedef CreateVideoRoomResponse
- * @property {string} unique_name - Video Room's unique name
- */
-/**
- * @typedef CloseVideoRoomResponse
- * @property {boolean} success - Denotes if operation was successfully
- */
-/**
- * @typedef CreateVideoRoomPayload
- * @property {string} unique_name - Ticket id
- * @property {NotifyUser[]} [notify] - List of people to be notified
- */
-/**
- * @typedef NotifyUser
- * @property {string} country_code - Country code
- * @property {string} phone_number - Phone number
- */
 /**
  * @typedef Filter
  * @property {Priority[]} priorities - List of possible priorities for tickets
@@ -98,41 +113,6 @@ export = LeadPlatformModel;
  * @property {Object} value - Details of history event
  * @property {HistoryTypeEnum} type
  */
-/**
- * @typedef GetTokenForVideoRoomResponse
- * @property {string} access_token - Access token to be used for video room
- */
-/**
- * @typedef GetParticipantsInsideVideoRoomResponse
- * @property {Participant[]} participants - List of participants of the video room
- */
-/**
- * @typedef Participant
- * @property {UserSchema} [user]
- * @property {string} [identity] - Unique identifier of participant
- * @property {string} [status] - Status of participant
- */
-/**
- * @typedef UserSchema
- * @property {string} [application_id]
- * @property {string} [user_id]
- * @property {string} [first_name]
- * @property {Object} [meta]
- * @property {string} [last_name]
- * @property {PhoneNumber[]} [phone_numbers]
- * @property {Email[]} [emails]
- * @property {string} [gender]
- * @property {string} [dob]
- * @property {boolean} [active]
- * @property {string} [profile_pic_url]
- * @property {string} [username]
- * @property {string} [account_type]
- * @property {string} [_id]
- * @property {string} [created_at]
- * @property {string} [updated_at]
- * @property {string} [external_id]
- * @property {string} [rr_id]
- */
 /**
  * @typedef TicketContext
  * @property {string} [application_id] - Application ID related to the ticket
@@ -169,6 +149,10 @@ export = LeadPlatformModel;
  * @property {string} display - Display text for priority
  * @property {string} color - Color for priority
  */
+/**
+ * @typedef SLA
+ * @property {string} resolution_time
+ */
 /**
  * @typedef Status
  * @property {string} key - Key for status
@@ -271,6 +255,7 @@ export = LeadPlatformModel;
  * @property {TicketSourceEnum} source
  * @property {Status} status
  * @property {Priority} priority
+ * @property {SLA} [sla]
  * @property {Object} [created_by] - User details of ticket creator
  * @property {Object} [assigned_to] - Details of support staff to whom ticket is assigned
  * @property {string[]} [tags] - Tags relevant to ticket
@@ -286,21 +271,6 @@ export = LeadPlatformModel;
  * @typedef ErrorMessage
  * @property {string} [message]
  */
-/**
- * @typedef PhoneNumber
- * @property {string} [phone] - Phone number
- * @property {number} [country_code] - Country code
- * @property {boolean} [active] - Is the phone number active
- * @property {boolean} [primary] - Is it a primary phone number
- * @property {boolean} [verified] - Is the phone number verified
- */
-/**
- * @typedef Email
- * @property {string} [email] - Email address
- * @property {boolean} [active] - Is the email active
- * @property {boolean} [primary] - Is it a primary email
- * @property {boolean} [verified] - Is the email verified
- */
 /** @typedef {"low" | "medium" | "high" | "urgent"} PriorityEnum */
 /** @typedef {"rating" | "log" | "comment" | "thread"} HistoryTypeEnum */
 /**
@@ -318,8 +288,45 @@ export = LeadPlatformModel;
 declare class LeadPlatformModel {
 }
 declare namespace LeadPlatformModel {
-    export { TicketList, Page, TicketHistoryList, CustomFormList, CreateCustomFormPayload, EditCustomFormPayload, EditTicketPayload, AgentChangePayload, CreateVideoRoomResponse, CloseVideoRoomResponse, CreateVideoRoomPayload, NotifyUser, Filter, TicketHistoryPayload, GetTokenForVideoRoomResponse, GetParticipantsInsideVideoRoomResponse, Participant, UserSchema, TicketContext, CreatedOn, TicketAsset, TicketContent, AddTicketPayload, Priority, Status, TicketFeedbackList, TicketFeedbackPayload, SubmitButton, PollForAssignment, CustomForm, FeedbackForm, TicketCategory, FeedbackResponseItem, TicketFeedback, TicketHistory, Ticket, ErrorMessage, PhoneNumber, Email, PriorityEnum, HistoryTypeEnum, TicketAssetTypeEnum, TicketSourceEnum };
+    export { GeneralConfigResponse, SupportCommunicationSchema, SupportSchema, GeneralConfigIntegrationSchema, TicketList, Page, TicketHistoryList, CustomFormList, CreateCustomFormPayload, EditCustomFormPayload, EditTicketPayload, AgentChangePayload, Filter, TicketHistoryPayload, TicketContext, CreatedOn, TicketAsset, TicketContent, AddTicketPayload, Priority, SLA, Status, TicketFeedbackList, TicketFeedbackPayload, SubmitButton, PollForAssignment, CustomForm, FeedbackForm, TicketCategory, FeedbackResponseItem, TicketFeedback, TicketHistory, Ticket, ErrorMessage, PriorityEnum, HistoryTypeEnum, TicketAssetTypeEnum, TicketSourceEnum };
 }
+/** @returns {GeneralConfigResponse} */
+declare function GeneralConfigResponse(): GeneralConfigResponse;
+type GeneralConfigResponse = {
+    _id?: string;
+    support_communication?: SupportCommunicationSchema[];
+    show_communication_info?: boolean;
+    show_support_dris?: boolean;
+    type?: string;
+    integration?: GeneralConfigIntegrationSchema;
+    allow_ticket_creation?: boolean;
+    show_listing?: boolean;
+    available_integration?: string[];
+    enable_dris?: boolean;
+    support_email?: SupportSchema;
+    support_phone?: SupportSchema;
+    support_faq?: SupportSchema;
+};
+/** @returns {SupportCommunicationSchema} */
+declare function SupportCommunicationSchema(): SupportCommunicationSchema;
+type SupportCommunicationSchema = {
+    type?: string;
+    title?: string;
+    description?: string;
+    enabled?: boolean;
+};
+/** @returns {SupportSchema} */
+declare function SupportSchema(): SupportSchema;
+type SupportSchema = {
+    value?: string;
+    description?: string;
+    enabled?: boolean;
+};
+/** @returns {GeneralConfigIntegrationSchema} */
+declare function GeneralConfigIntegrationSchema(): GeneralConfigIntegrationSchema;
+type GeneralConfigIntegrationSchema = {
+    type?: string;
+};
 /** @returns {TicketList} */
 declare function TicketList(): TicketList;
 type TicketList = {
@@ -466,46 +473,6 @@ type AgentChangePayload = {
      */
     agent_id: string;
 };
-/** @returns {CreateVideoRoomResponse} */
-declare function CreateVideoRoomResponse(): CreateVideoRoomResponse;
-type CreateVideoRoomResponse = {
-    /**
-     * - Video Room's unique name
-     */
-    unique_name: string;
-};
-/** @returns {CloseVideoRoomResponse} */
-declare function CloseVideoRoomResponse(): CloseVideoRoomResponse;
-type CloseVideoRoomResponse = {
-    /**
-     * - Denotes if operation was successfully
-     */
-    success: boolean;
-};
-/** @returns {CreateVideoRoomPayload} */
-declare function CreateVideoRoomPayload(): CreateVideoRoomPayload;
-type CreateVideoRoomPayload = {
-    /**
-     * - Ticket id
-     */
-    unique_name: string;
-    /**
-     * - List of people to be notified
-     */
-    notify?: NotifyUser[];
-};
-/** @returns {NotifyUser} */
-declare function NotifyUser(): NotifyUser;
-type NotifyUser = {
-    /**
-     * - Country code
-     */
-    country_code: string;
-    /**
-     * - Phone number
-     */
-    phone_number: string;
-};
 /** @returns {Filter} */
 declare function Filter(): Filter;
 type Filter = {
@@ -535,57 +502,6 @@ type TicketHistoryPayload = {
     value: any;
     type: HistoryTypeEnum;
 };
-/** @returns {GetTokenForVideoRoomResponse} */
-declare function GetTokenForVideoRoomResponse(): GetTokenForVideoRoomResponse;
-type GetTokenForVideoRoomResponse = {
-    /**
-     * - Access token to be used for video room
-     */
-    access_token: string;
-};
-/** @returns {GetParticipantsInsideVideoRoomResponse} */
-declare function GetParticipantsInsideVideoRoomResponse(): GetParticipantsInsideVideoRoomResponse;
-type GetParticipantsInsideVideoRoomResponse = {
-    /**
-     * - List of participants of the video room
-     */
-    participants: Participant[];
-};
-/** @returns {Participant} */
-declare function Participant(): Participant;
-type Participant = {
-    user?: UserSchema;
-    /**
-     * - Unique identifier of participant
-     */
-    identity?: string;
-    /**
-     * - Status of participant
-     */
-    status?: string;
-};
-/** @returns {UserSchema} */
-declare function UserSchema(): UserSchema;
-type UserSchema = {
-    application_id?: string;
-    user_id?: string;
-    first_name?: string;
-    meta?: any;
-    last_name?: string;
-    phone_numbers?: PhoneNumber[];
-    emails?: Email[];
-    gender?: string;
-    dob?: string;
-    active?: boolean;
-    profile_pic_url?: string;
-    username?: string;
-    account_type?: string;
-    _id?: string;
-    created_at?: string;
-    updated_at?: string;
-    external_id?: string;
-    rr_id?: string;
-};
 /** @returns {TicketContext} */
 declare function TicketContext(): TicketContext;
 type TicketContext = {
@@ -670,6 +586,11 @@ type Priority = {
      */
     color: string;
 };
+/** @returns {SLA} */
+declare function SLA(): SLA;
+type SLA = {
+    resolution_time: string;
+};
 /** @returns {Status} */
 declare function Status(): Status;
 type Status = {
@@ -925,6 +846,7 @@ type Ticket = {
     source: TicketSourceEnum;
     status: Status;
     priority: Priority;
+    sla?: SLA;
     /**
      * - User details of ticket creator
      */
@@ -968,50 +890,6 @@ declare function ErrorMessage(): ErrorMessage;
 type ErrorMessage = {
     message?: string;
 };
-/** @returns {PhoneNumber} */
-declare function PhoneNumber(): PhoneNumber;
-type PhoneNumber = {
-    /**
-     * - Phone number
-     */
-    phone?: string;
-    /**
-     * - Country code
-     */
-    country_code?: number;
-    /**
-     * - Is the phone number active
-     */
-    active?: boolean;
-    /**
-     * - Is it a primary phone number
-     */
-    primary?: boolean;
-    /**
-     * - Is the phone number verified
-     */
-    verified?: boolean;
-};
-/** @returns {Email} */
-declare function Email(): Email;
-type Email = {
-    /**
-     * - Email address
-     */
-    email?: string;
-    /**
-     * - Is the email active
-     */
-    active?: boolean;
-    /**
-     * - Is it a primary email
-     */
-    primary?: boolean;
-    /**
-     * - Is the email verified
-     */
-    verified?: boolean;
-};
 /**
  * Enum: PriorityEnum Used By: Lead
  *