@gofynd/fdk-client-javascript 0.1.37 → 1.0.1

package/sdk/platform/Lead/LeadPlatformApplicationClient.js

@@ -0,0 +1,559 @@
+const Paginator = require("../../common/Paginator");
+const PlatformAPIClient = require("../PlatformAPIClient");
+const { FDKClientValidationError } = require("../../common/FDKError");
+const LeadValidator = require("./LeadPlatformApplicationValidator");
+
+class Lead {
+  constructor(config, applicationId) {
+    this.config = config;
+    this.applicationId = applicationId;
+  }
+
+  /**
+   * @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 } = {}) {
+    const { error } = LeadValidator.getTickets().validate(
+      {
+        items,
+        filters,
+        q,
+        status,
+        priority,
+        category,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = LeadValidator.getTickets().validate(
+      {
+        items,
+        filters,
+        q,
+        status,
+        priority,
+        category,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      console.log("Parameter Validation warrnings for getTickets");
+      console.log(warrning);
+    }
+
+    const query_params = {};
+    query_params["items"] = items;
+    query_params["filters"] = filters;
+    query_params["q"] = q;
+    query_params["status"] = status;
+    query_params["priority"] = priority;
+    query_params["category"] = category;
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/lead/v1.0/company/${this.config.companyId}/application/${this.applicationId}/ticket`,
+      query_params,
+      undefined
+    );
+  }
+
+  /**
+   * @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
+   */
+  getTicket({ id } = {}) {
+    const { error } = LeadValidator.getTicket().validate(
+      {
+        id,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = LeadValidator.getTicket().validate(
+      {
+        id,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      console.log("Parameter Validation warrnings for getTicket");
+      console.log(warrning);
+    }
+
+    const query_params = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/lead/v1.0/company/${this.config.companyId}/application/${this.applicationId}/ticket/${id}`,
+      query_params,
+      undefined
+    );
+  }
+
+  /**
+   * @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
+   */
+  editTicket({ id, body } = {}) {
+    const { error } = LeadValidator.editTicket().validate(
+      {
+        id,
+        body,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = LeadValidator.editTicket().validate(
+      {
+        id,
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      console.log("Parameter Validation warrnings for editTicket");
+      console.log(warrning);
+    }
+
+    const query_params = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "put",
+      `/service/platform/lead/v1.0/company/${this.config.companyId}/application/${this.applicationId}/ticket/${id}`,
+      query_params,
+      body
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.id - Ticket ID for which history is created
+   * @param {TicketHistoryPayload} arg.body
+   * @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 } = {}) {
+    const { error } = LeadValidator.createHistory().validate(
+      {
+        id,
+        body,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = LeadValidator.createHistory().validate(
+      {
+        id,
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      console.log("Parameter Validation warrnings for createHistory");
+      console.log(warrning);
+    }
+
+    const query_params = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "post",
+      `/service/platform/lead/v1.0/company/${this.config.companyId}/application/${this.applicationId}/ticket/${id}/history`,
+      query_params,
+      body
+    );
+  }
+
+  /**
+   * @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.
+   */
+  getTicketHistory({ id } = {}) {
+    const { error } = LeadValidator.getTicketHistory().validate(
+      {
+        id,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = LeadValidator.getTicketHistory().validate(
+      {
+        id,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      console.log("Parameter Validation warrnings for getTicketHistory");
+      console.log(warrning);
+    }
+
+    const query_params = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/lead/v1.0/company/${this.config.companyId}/application/${this.applicationId}/ticket/${id}/history`,
+      query_params,
+      undefined
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.slug - Slug of form whose response is getting submitted
+   * @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 } = {}) {
+    const { error } = LeadValidator.getCustomForm().validate(
+      {
+        slug,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = LeadValidator.getCustomForm().validate(
+      {
+        slug,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      console.log("Parameter Validation warrnings for getCustomForm");
+      console.log(warrning);
+    }
+
+    const query_params = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/lead/v1.0/company/${this.config.companyId}/application/${this.applicationId}/form/${slug}`,
+      query_params,
+      undefined
+    );
+  }
+
+  /**
+   * @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.
+   */
+  editCustomForm({ slug, body } = {}) {
+    const { error } = LeadValidator.editCustomForm().validate(
+      {
+        slug,
+        body,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = LeadValidator.editCustomForm().validate(
+      {
+        slug,
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      console.log("Parameter Validation warrnings for editCustomForm");
+      console.log(warrning);
+    }
+
+    const query_params = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "put",
+      `/service/platform/lead/v1.0/company/${this.config.companyId}/application/${this.applicationId}/form/${slug}`,
+      query_params,
+      body
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @summary: Get list of custom form
+   * @description: Get list of custom form for given application
+   */
+  getCustomForms({} = {}) {
+    const { error } = LeadValidator.getCustomForms().validate(
+      {},
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = LeadValidator.getCustomForms().validate(
+      {},
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      console.log("Parameter Validation warrnings for getCustomForms");
+      console.log(warrning);
+    }
+
+    const query_params = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/lead/v1.0/company/${this.config.companyId}/application/${this.applicationId}/form`,
+      query_params,
+      undefined
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {CreateCustomFormPayload} arg.body
+   * @summary: Creates a new custom form
+   * @description: Creates a new custom form for given application
+   */
+  createCustomForm({ body } = {}) {
+    const { error } = LeadValidator.createCustomForm().validate(
+      {
+        body,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = LeadValidator.createCustomForm().validate(
+      {
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      console.log("Parameter Validation warrnings for createCustomForm");
+      console.log(warrning);
+    }
+
+    const query_params = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "post",
+      `/service/platform/lead/v1.0/company/${this.config.companyId}/application/${this.applicationId}/form`,
+      query_params,
+      body
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.uniqueName - Unique name of video room
+   * @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 } = {}) {
+    const { error } = LeadValidator.getTokenForVideoRoom().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 } = LeadValidator.getTokenForVideoRoom().validate(
+      {
+        uniqueName,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      console.log("Parameter Validation warrnings for getTokenForVideoRoom");
+      console.log(warrning);
+    }
+
+    const query_params = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/lead/v1.0/company/${this.config.companyId}/application/${this.applicationId}/video/room/${uniqueName}/token`,
+      query_params,
+      undefined
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.uniqueName - Unique name of Video Room
+   * @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 } = {}) {
+    const { error } = LeadValidator.getVideoParticipants().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 } = LeadValidator.getVideoParticipants().validate(
+      {
+        uniqueName,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      console.log("Parameter Validation warrnings for getVideoParticipants");
+      console.log(warrning);
+    }
+
+    const query_params = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/lead/v1.0/company/${this.config.companyId}/application/${this.applicationId}/video/room/${uniqueName}/participants`,
+      query_params,
+      undefined
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {CreateVideoRoomPayload} arg.body
+   * @summary: Open a video room.
+   * @description: Open a video room.
+   */
+  openVideoRoom({ body } = {}) {
+    const { error } = LeadValidator.openVideoRoom().validate(
+      {
+        body,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = LeadValidator.openVideoRoom().validate(
+      {
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      console.log("Parameter Validation warrnings for openVideoRoom");
+      console.log(warrning);
+    }
+
+    const query_params = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "post",
+      `/service/platform/lead/v1.0/company/${this.config.companyId}/application/${this.applicationId}/video/room`,
+      query_params,
+      body
+    );
+  }
+
+  /**
+   * @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 } = {}) {
+    const { error } = LeadValidator.closeVideoRoom().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 } = LeadValidator.closeVideoRoom().validate(
+      {
+        uniqueName,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      console.log("Parameter Validation warrnings for closeVideoRoom");
+      console.log(warrning);
+    }
+
+    const query_params = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "delete",
+      `/service/platform/lead/v1.0/company/${this.config.companyId}/application/${this.applicationId}/video/room/${uniqueName}`,
+      query_params,
+      undefined
+    );
+  }
+}
+module.exports = Lead;

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

@@ -0,0 +1,16 @@
+export = LeadValidator;
+declare class LeadValidator {
+    static getTickets(): any;
+    static getTicket(): any;
+    static editTicket(): any;
+    static createHistory(): any;
+    static getTicketHistory(): any;
+    static getCustomForm(): any;
+    static editCustomForm(): any;
+    static getCustomForms(): any;
+    static createCustomForm(): any;
+    static getTokenForVideoRoom(): any;
+    static getVideoParticipants(): any;
+    static openVideoRoom(): any;
+    static closeVideoRoom(): any;
+}

package/sdk/platform/Lead/LeadPlatformApplicationValidator.js

@@ -0,0 +1,90 @@
+const Joi = require("joi");
+const LeadModel = require("./LeadPlatformModel");
+
+class LeadValidator {
+  static getTickets() {
+    return Joi.object({
+      items: Joi.boolean(),
+      filters: Joi.boolean(),
+      q: Joi.string().allow(""),
+      status: Joi.string().allow(""),
+      priority: LeadModel.PriorityEnum(),
+      category: Joi.string().allow(""),
+    }).required();
+  }
+
+  static getTicket() {
+    return Joi.object({
+      id: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  static editTicket() {
+    return Joi.object({
+      id: Joi.string().allow("").required(),
+      body: LeadModel.EditTicketPayload().required(),
+    }).required();
+  }
+
+  static createHistory() {
+    return Joi.object({
+      id: Joi.string().allow("").required(),
+      body: LeadModel.TicketHistoryPayload().required(),
+    }).required();
+  }
+
+  static getTicketHistory() {
+    return Joi.object({
+      id: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  static getCustomForm() {
+    return Joi.object({
+      slug: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  static editCustomForm() {
+    return Joi.object({
+      slug: Joi.string().allow("").required(),
+      body: LeadModel.EditCustomFormPayload().required(),
+    }).required();
+  }
+
+  static getCustomForms() {
+    return Joi.object({}).required();
+  }
+
+  static createCustomForm() {
+    return Joi.object({
+      body: LeadModel.CreateCustomFormPayload().required(),
+    }).required();
+  }
+
+  static getTokenForVideoRoom() {
+    return Joi.object({
+      uniqueName: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  static getVideoParticipants() {
+    return Joi.object({
+      uniqueName: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  static openVideoRoom() {
+    return Joi.object({
+      body: LeadModel.CreateVideoRoomPayload().required(),
+    }).required();
+  }
+
+  static closeVideoRoom() {
+    return Joi.object({
+      uniqueName: Joi.string().allow("").required(),
+    }).required();
+  }
+}
+
+module.exports = LeadValidator;