@gofynd/fdk-client-javascript 0.1.36 → 1.0.0

package/sdk/application/Lead/LeadApplicationModel.js

@@ -0,0 +1,690 @@
+const Joi = require("joi");
+
+class LeadModel {
+  static TicketList() {
+    return Joi.object({
+      items: Joi.array().items(LeadModel.Ticket()),
+
+      filters: LeadModel.Filter(),
+
+      page: LeadModel.Page(),
+    });
+  }
+
+  static Page() {
+    return Joi.object({
+      item_total: Joi.number(),
+
+      next_id: Joi.string().allow(""),
+
+      has_previous: Joi.boolean(),
+
+      has_next: Joi.boolean(),
+
+      current: Joi.number(),
+
+      type: Joi.string().allow("").required(),
+
+      size: Joi.number(),
+    });
+  }
+
+  static TicketHistoryList() {
+    return Joi.object({
+      items: Joi.array().items(LeadModel.TicketHistory()),
+
+      page: LeadModel.Page(),
+    });
+  }
+
+  static CustomFormList() {
+    return Joi.object({
+      items: Joi.array().items(LeadModel.CustomForm()),
+
+      page: LeadModel.Page(),
+    });
+  }
+
+  static CreateCustomFormPayload() {
+    return Joi.object({
+      slug: Joi.string().allow("").required(),
+
+      title: Joi.string().allow("").required(),
+
+      inputs: Joi.array().items(Joi.any()).required(),
+
+      description: Joi.string().allow(""),
+
+      header_image: Joi.string().allow(""),
+
+      priority: LeadModel.PriorityEnum().required(),
+
+      should_notify: Joi.boolean(),
+
+      success_message: Joi.string().allow(""),
+
+      poll_for_assignment: LeadModel.PollForAssignment(),
+    });
+  }
+
+  static EditCustomFormPayload() {
+    return Joi.object({
+      title: Joi.string().allow("").required(),
+
+      inputs: Joi.array().items(Joi.any()).required(),
+
+      description: Joi.string().allow(""),
+
+      priority: LeadModel.PriorityEnum().required(),
+
+      header_image: Joi.string().allow(""),
+
+      should_notify: Joi.boolean(),
+
+      login_required: Joi.boolean(),
+
+      success_message: Joi.string().allow(""),
+
+      poll_for_assignment: LeadModel.PollForAssignment(),
+    });
+  }
+
+  static EditTicketPayload() {
+    return Joi.object({
+      content: LeadModel.TicketContent(),
+
+      category: Joi.string().allow(""),
+
+      sub_category: Joi.string().allow(""),
+
+      source: Joi.string().allow(""),
+
+      status: Joi.string().allow(""),
+
+      priority: LeadModel.PriorityEnum(),
+
+      assigned_to: LeadModel.AgentChangePayload(),
+
+      tags: Joi.array().items(Joi.string().allow("")),
+    });
+  }
+
+  static AgentChangePayload() {
+    return Joi.object({
+      agent_id: Joi.string().allow("").required(),
+    });
+  }
+
+  static CreateVideoRoomResponse() {
+    return Joi.object({
+      unique_name: Joi.string().allow("").required(),
+    });
+  }
+
+  static CloseVideoRoomResponse() {
+    return Joi.object({
+      success: Joi.boolean().required(),
+    });
+  }
+
+  static CreateVideoRoomPayload() {
+    return Joi.object({
+      unique_name: Joi.string().allow("").required(),
+
+      notify: Joi.array().items(LeadModel.NotifyUser()),
+    });
+  }
+
+  static NotifyUser() {
+    return Joi.object({
+      country_code: Joi.string().allow("").required(),
+
+      phone_number: Joi.string().allow("").required(),
+    });
+  }
+
+  static Filter() {
+    return Joi.object({
+      priorities: Joi.array().items(LeadModel.Priority()).required(),
+
+      categories: Joi.array().items(LeadModel.TicketCategory()),
+
+      statuses: Joi.array().items(LeadModel.Status()).required(),
+
+      assignees: Joi.array().items(Joi.any()).required(),
+    });
+  }
+
+  static TicketHistoryPayload() {
+    return Joi.object({
+      value: Joi.any().required(),
+
+      type: LeadModel.HistoryTypeEnum().required(),
+    });
+  }
+
+  static CustomFormSubmissionPayload() {
+    return Joi.object({
+      response: Joi.array().items(Joi.any()).required(),
+
+      attachments: Joi.array().items(LeadModel.TicketAsset()),
+    });
+  }
+
+  static GetTokenForVideoRoomResponse() {
+    return Joi.object({
+      access_token: Joi.string().allow("").required(),
+    });
+  }
+
+  static GetParticipantsInsideVideoRoomResponse() {
+    return Joi.object({
+      participants: Joi.array().items(LeadModel.Participant()).required(),
+    });
+  }
+
+  static Participant() {
+    return Joi.object({
+      user: LeadModel.UserSchema(),
+
+      identity: Joi.string().allow(""),
+
+      status: Joi.string().allow(""),
+    });
+  }
+
+  static UserSchema() {
+    return Joi.object({
+      application_id: Joi.string().allow(""),
+
+      user_id: Joi.string().allow(""),
+
+      first_name: Joi.string().allow(""),
+
+      meta: Joi.any(),
+
+      last_name: Joi.string().allow(""),
+
+      phone_numbers: Joi.array().items(LeadModel.PhoneNumber()),
+
+      emails: Joi.array().items(LeadModel.Email()),
+
+      gender: Joi.string().allow(""),
+
+      dob: Joi.string().allow(""),
+
+      active: Joi.boolean(),
+
+      profile_pic_url: Joi.string().allow(""),
+
+      username: Joi.string().allow(""),
+
+      account_type: Joi.string().allow(""),
+
+      _id: Joi.string().allow(""),
+
+      created_at: Joi.string().allow(""),
+
+      updated_at: Joi.string().allow(""),
+    });
+  }
+
+  static PhoneNumber() {
+    return Joi.object({
+      active: Joi.boolean(),
+
+      primary: Joi.boolean(),
+
+      verified: Joi.boolean(),
+
+      phone: Joi.string().allow(""),
+
+      country_code: Joi.number(),
+    });
+  }
+
+  static Email() {
+    return Joi.object({
+      primary: Joi.boolean(),
+
+      verified: Joi.boolean(),
+
+      email: Joi.string().allow(""),
+
+      active: Joi.boolean(),
+    });
+  }
+
+  static Debug() {
+    return Joi.object({
+      source: Joi.string().allow(""),
+
+      platform: Joi.string().allow(""),
+    });
+  }
+
+  static SubmitCustomFormResponse() {
+    return Joi.object({
+      message: Joi.string().allow("").required(),
+
+      ticket: LeadModel.Ticket(),
+    });
+  }
+
+  static TicketContext() {
+    return Joi.object({
+      application_id: Joi.string().allow(""),
+
+      company_id: Joi.string().allow("").required(),
+    });
+  }
+
+  static CreatedOn() {
+    return Joi.object({
+      user_agent: Joi.string().allow("").required(),
+    });
+  }
+
+  static TicketAsset() {
+    return Joi.object({
+      display: Joi.string().allow(""),
+
+      value: Joi.string().allow("").required(),
+
+      type: LeadModel.TicketAssetTypeEnum().required(),
+    });
+  }
+
+  static TicketContent() {
+    return Joi.object({
+      title: Joi.string().allow("").required(),
+
+      description: Joi.string().allow(""),
+
+      attachments: Joi.array().items(LeadModel.TicketAsset()),
+    });
+  }
+
+  static AddTicketPayload() {
+    return Joi.object({
+      created_by: Joi.any(),
+
+      status: Joi.string().allow(""),
+
+      priority: LeadModel.PriorityEnum(),
+
+      category: Joi.string().allow("").required(),
+
+      content: LeadModel.TicketContent().required(),
+
+      _custom_json: Joi.any(),
+    });
+  }
+
+  static Priority() {
+    return Joi.object({
+      key: LeadModel.PriorityEnum().required(),
+
+      display: Joi.string().allow("").required(),
+
+      color: Joi.string().allow("").required(),
+    });
+  }
+
+  static Status() {
+    return Joi.object({
+      key: Joi.string().allow("").required(),
+
+      display: Joi.string().allow("").required(),
+
+      color: Joi.string().allow("").required(),
+    });
+  }
+
+  static TicketFeedbackForm() {
+    return Joi.object({
+      title: Joi.string().allow("").required(),
+
+      display: Joi.array().items(Joi.any()),
+    });
+  }
+
+  static TicketFeedbackList() {
+    return Joi.object({
+      items: Joi.array().items(LeadModel.TicketFeedback()),
+    });
+  }
+
+  static TicketFeedbackPayload() {
+    return Joi.object({
+      form_response: Joi.any(),
+    });
+  }
+
+  static SubmitButton() {
+    return Joi.object({
+      title: Joi.string().allow("").required(),
+
+      title_color: Joi.string().allow("").required(),
+
+      background_color: Joi.string().allow("").required(),
+    });
+  }
+
+  static PollForAssignment() {
+    return Joi.object({
+      duration: Joi.number().required(),
+
+      message: Joi.string().allow("").required(),
+
+      success_message: Joi.string().allow("").required(),
+
+      failure_message: Joi.string().allow("").required(),
+    });
+  }
+
+  static CustomForm() {
+    return Joi.object({
+      application_id: Joi.string().allow("").required(),
+
+      slug: Joi.string().allow("").required(),
+
+      header_image: Joi.string().allow(""),
+
+      title: Joi.string().allow("").required(),
+
+      description: Joi.string().allow(""),
+
+      priority: LeadModel.Priority().required(),
+
+      login_required: Joi.boolean().required(),
+
+      should_notify: Joi.boolean().required(),
+
+      success_message: Joi.string().allow(""),
+
+      submit_button: LeadModel.SubmitButton(),
+
+      inputs: Joi.array().items(Joi.any()).required(),
+
+      created_on: LeadModel.CreatedOn(),
+
+      poll_for_assignment: LeadModel.PollForAssignment(),
+
+      _id: Joi.string().allow("").required(),
+    });
+  }
+
+  static CommunicationDetails() {
+    return Joi.object({
+      type: Joi.string().allow(""),
+
+      title: Joi.string().allow(""),
+
+      value: Joi.string().allow(""),
+
+      description: Joi.string().allow(""),
+
+      enabled: Joi.boolean(),
+    });
+  }
+
+  static SupportGeneralConfig() {
+    return Joi.object({
+      _id: Joi.string().allow(""),
+
+      support_email: LeadModel.CommunicationDetails(),
+
+      support_phone: LeadModel.CommunicationDetails(),
+
+      support_faq: LeadModel.CommunicationDetails(),
+
+      show_communication_info: Joi.boolean(),
+
+      support_communication: LeadModel.CommunicationDetails(),
+
+      show_support_dris: Joi.boolean(),
+
+      integration: Joi.any(),
+    });
+  }
+
+  static FeedbackForm() {
+    return Joi.object({
+      inputs: Joi.any(),
+
+      title: Joi.string().allow(""),
+
+      timestamps: Joi.any(),
+    });
+  }
+
+  static TicketSubCategory() {
+    return Joi.object({
+      key: Joi.string().allow("").required(),
+
+      display: Joi.string().allow("").required(),
+
+      sub_categories: LeadModel.TicketSubCategory(),
+    });
+  }
+
+  static TicketCategory() {
+    return Joi.object({
+      display: Joi.string().allow("").required(),
+
+      key: Joi.string().allow("").required(),
+
+      sub_categories: LeadModel.TicketCategory(),
+
+      group_id: Joi.number(),
+
+      feedback_form: LeadModel.FeedbackForm(),
+    });
+  }
+
+  static CategoryData() {
+    return Joi.object({
+      list: LeadModel.TicketCategory(),
+    });
+  }
+
+  static IntegrationConfig() {
+    return Joi.object({
+      _id: Joi.string().allow(""),
+
+      integration_type: Joi.string().allow("").required(),
+
+      base_url: Joi.string().allow(""),
+
+      create_ticket_apikey: Joi.string().allow(""),
+
+      update_ticket_apikey: Joi.string().allow(""),
+
+      category_sync_apikey: Joi.string().allow(""),
+
+      category_data: LeadModel.CategoryData(),
+
+      webhook_apikey: Joi.string().allow(""),
+
+      config_completed: Joi.boolean(),
+
+      allow_ticket_creation: Joi.boolean().required(),
+
+      show_listing: Joi.boolean().required(),
+    });
+  }
+
+  static FeedbackResponseItem() {
+    return Joi.object({
+      display: Joi.string().allow("").required(),
+
+      key: Joi.string().allow("").required(),
+
+      value: Joi.string().allow("").required(),
+    });
+  }
+
+  static TicketFeedback() {
+    return Joi.object({
+      _id: Joi.string().allow("").required(),
+
+      ticket_id: Joi.string().allow("").required(),
+
+      company_id: Joi.string().allow("").required(),
+
+      response: Joi.array().items(LeadModel.FeedbackResponseItem()).required(),
+
+      category: Joi.string().allow(""),
+
+      user: Joi.any(),
+
+      updated_at: Joi.string().allow(""),
+
+      created_at: Joi.string().allow(""),
+    });
+  }
+
+  static TicketHistory() {
+    return Joi.object({
+      type: Joi.string().allow("").required(),
+
+      value: Joi.any().required(),
+
+      ticket_id: Joi.string().allow("").required(),
+
+      created_on: LeadModel.CreatedOn(),
+
+      created_by: Joi.any(),
+
+      _id: Joi.string().allow("").required(),
+
+      updated_at: Joi.string().allow(""),
+
+      created_at: Joi.string().allow(""),
+    });
+  }
+
+  static Ticket() {
+    return Joi.object({
+      context: LeadModel.TicketContext(),
+
+      created_on: LeadModel.CreatedOn(),
+
+      response_id: Joi.string().allow(""),
+
+      content: LeadModel.TicketContent(),
+
+      category: LeadModel.TicketCategory().required(),
+
+      sub_category: Joi.string().allow(""),
+
+      source: LeadModel.TicketSourceEnum().required(),
+
+      status: LeadModel.Status().required(),
+
+      priority: LeadModel.Priority().required(),
+
+      created_by: Joi.any(),
+
+      assigned_to: Joi.any(),
+
+      tags: Joi.array().items(Joi.string().allow("")),
+
+      _custom_json: Joi.any(),
+
+      is_feedback_pending: Joi.boolean(),
+
+      integration: Joi.any(),
+
+      _id: Joi.string().allow("").required(),
+
+      updated_at: Joi.string().allow(""),
+
+      created_at: Joi.string().allow(""),
+    });
+  }
+
+  /*
+        Enum: PriorityEnum
+        Used By: Lead
+    */
+  static PriorityEnum() {
+    return Joi.string().valid(
+      "low",
+
+      "medium",
+
+      "high",
+
+      "urgent"
+    );
+  }
+
+  /*
+        Enum: HistoryTypeEnum
+        Used By: Lead
+    */
+  static HistoryTypeEnum() {
+    return Joi.string().valid(
+      "rating",
+
+      "log",
+
+      "comment"
+    );
+  }
+
+  /*
+        Enum: TicketAssetTypeEnum
+        Used By: Lead
+    */
+  static TicketAssetTypeEnum() {
+    return Joi.string().valid(
+      "image",
+
+      "video",
+
+      "file",
+
+      "youtube",
+
+      "product",
+
+      "collection",
+
+      "brand",
+
+      "shipment",
+
+      "order"
+    );
+  }
+
+  /*
+        Enum: TicketSourceEnum
+        Used By: Lead
+    */
+  static TicketSourceEnum() {
+    return Joi.string().valid(
+      "platform_panel",
+
+      "sales_channel"
+    );
+  }
+
+  /*
+        Enum: TicketIntegrationDetails
+        Used By: Lead
+    */
+  static TicketIntegrationDetails() {
+    return Joi.string().valid(
+      "default",
+
+      "freshdesk",
+
+      "kapture"
+    );
+  }
+}
+module.exports = LeadModel;

package/sdk/application/{models/LeadValidator.js → Lead/LeadApplicationValidator.js}

@@ -1,5 +1,6 @@
 const Joi = require("joi");
-const { Validator } = require("../ApplicationModels");
+
+const LeadModel = require("./LeadApplicationModel");
 class LeadValidator {
   static getTicket() {
     return Joi.object({
@@ -10,13 +11,13 @@ class LeadValidator {
   static createHistory() {
     return Joi.object({
       id: Joi.string().allow("").required(),
-      body: Validator.TicketHistoryPayload().required(),
+      body: LeadModel.TicketHistoryPayload().required(),
     }).required();
   }
 
   static createTicket() {
     return Joi.object({
-      body: Validator.AddTicketPayload().required(),
+      body: LeadModel.AddTicketPayload().required(),
     }).required();
   }
 
@@ -29,7 +30,7 @@ class LeadValidator {
   static submitCustomForm() {
     return Joi.object({
       slug: Joi.string().allow("").required(),
-      body: Validator.CustomFormSubmissionPayload().required(),
+      body: LeadModel.CustomFormSubmissionPayload().required(),
     }).required();
   }