@managemint-solutions/entities 1.26.0 → 1.27.0

package/dist/additional-details/enum/index.d.ts

@@ -1,4 +1,5 @@
 export declare enum AdditionalDetailsEntityTypes {
+    LEAD = "leads",
     CLIENT = "clients",
     PROJECT = "projects",
     BUDGET_EXPENSE = "budget_expenses",

package/dist/additional-details/enum/index.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.AdditionalDetailsTypes = exports.AdditionalDetailsEntityTypes = void 0;
 var AdditionalDetailsEntityTypes;
 (function (AdditionalDetailsEntityTypes) {
+    AdditionalDetailsEntityTypes["LEAD"] = "leads";
     AdditionalDetailsEntityTypes["CLIENT"] = "clients";
     AdditionalDetailsEntityTypes["PROJECT"] = "projects";
     AdditionalDetailsEntityTypes["BUDGET_EXPENSE"] = "budget_expenses";

package/dist/audit-trail/enum/index.d.ts

@@ -15,6 +15,7 @@ export declare enum AuditTrailEntityType {
     ADDITIONAL_DETAILS = "additional_details",
     SUPPORTING_FILES = "supporting_files",
     NOTES = "notes",
+    LEADS = "leads",
     CLIENTS = "clients",
     PROJECTS = "projects",
     TASKS = "tasks",

package/dist/audit-trail/enum/index.js

@@ -20,6 +20,7 @@ var AuditTrailEntityType;
     AuditTrailEntityType["ADDITIONAL_DETAILS"] = "additional_details";
     AuditTrailEntityType["SUPPORTING_FILES"] = "supporting_files";
     AuditTrailEntityType["NOTES"] = "notes";
+    AuditTrailEntityType["LEADS"] = "leads";
     AuditTrailEntityType["CLIENTS"] = "clients";
     AuditTrailEntityType["PROJECTS"] = "projects";
     AuditTrailEntityType["TASKS"] = "tasks";

package/dist/leads/dto/index.d.ts

@@ -0,0 +1,32 @@
+import { UUID } from "crypto";
+import { LeadSource } from "../enum";
+export type GetLeadsDto = {
+    search?: string | null;
+    page: number;
+    page_size: number;
+    created_after?: string | null;
+    created_before?: string | null;
+    status_id_in?: string | null;
+    assigned_to_id?: string | null;
+    completed?: boolean | null;
+    archive: boolean;
+};
+export type LeadIdDto = {
+    leadId: string;
+};
+export type CreateLeadDto = {
+    name: string;
+    contact_person?: string | null;
+    email?: string | null;
+    phone?: string | null;
+    status_id?: UUID | null;
+    assigned_to_id?: string | null;
+    source?: LeadSource | null;
+    estimated_value_minor?: number | null;
+    follow_up_date?: string | null;
+    lost_reason?: string | null;
+};
+export type UpdateLeadDto = CreateLeadDto;
+export type ConvertLeadDto = {
+    client_status_id: string | null;
+};

package/dist/leads/dto/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/leads/enum/index.d.ts

@@ -0,0 +1,10 @@
+/** Where a lead came from. Stored as plain text; the sdk DTO validates it against this list. */
+export declare enum LeadSource {
+    REFERRAL = "referral",
+    WEBSITE = "website",
+    SOCIAL_MEDIA = "social_media",
+    EVENT = "event",
+    COLD_OUTREACH = "cold_outreach",
+    EXISTING_CLIENT = "existing_client",
+    OTHER = "other"
+}

package/dist/leads/enum/index.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LeadSource = void 0;
+/** Where a lead came from. Stored as plain text; the sdk DTO validates it against this list. */
+var LeadSource;
+(function (LeadSource) {
+    LeadSource["REFERRAL"] = "referral";
+    LeadSource["WEBSITE"] = "website";
+    LeadSource["SOCIAL_MEDIA"] = "social_media";
+    LeadSource["EVENT"] = "event";
+    LeadSource["COLD_OUTREACH"] = "cold_outreach";
+    LeadSource["EXISTING_CLIENT"] = "existing_client";
+    LeadSource["OTHER"] = "other";
+})(LeadSource || (exports.LeadSource = LeadSource = {}));
+;

package/dist/leads/index.d.ts

@@ -0,0 +1,61 @@
+import type { UUID } from 'crypto';
+import { ClientIdentity } from '../clients';
+import { StatusEntity } from '../status';
+import { UserIdentity } from '../users';
+import { LeadSource } from './enum';
+export type LeadIdentity = {
+    mms_id: UUID;
+    name: string;
+};
+export type LeadSummary = {
+    mms_id: UUID;
+    created_at: Date;
+    name: string;
+    /** The person at the business the lead is about; null when the lead is a person. */
+    contact_person: string | null;
+    email: string;
+    status: StatusEntity | null;
+    assigned_to: UserIdentity | null;
+    /** Minor units in the organization's currency; null when not estimated. */
+    estimated_value_minor: number | null;
+    /** A date (YYYY-MM-DD) to follow the lead up; null when none is set. */
+    follow_up_date: string | null;
+    created_by: UserIdentity;
+};
+/**
+ * A prospective client. Converting it creates a client from its data, moves its notes,
+ * additional details and files to that client, moves the lead itself to the organization's Won
+ * status and sets `converted_client`. Won is reached only by converting - it cannot be created
+ * or set directly. The lead is not deleted, stays as a record of the deal, and the list hides
+ * Won leads by default.
+ */
+export type LeadEntity = {
+    mms_id: UUID;
+    created_at: Date;
+    name: string;
+    contact_person: string | null;
+    email: string;
+    phone: string;
+    status: StatusEntity | null;
+    assigned_to: UserIdentity | null;
+    source: LeadSource | null;
+    estimated_value_minor: number | null;
+    follow_up_date: string | null;
+    /** Why the lead was lost; set only while its status is a fail status. */
+    lost_reason: string | null;
+    converted_client: ClientIdentity | null;
+    converted_at: Date | null;
+    updated_at: Date | null;
+    last_updated_by: UserIdentity | null;
+    created_by: UserIdentity;
+    archived: boolean;
+    archived_at: Date | null;
+    archived_by: UserIdentity | null;
+    unarchived_at: Date | null;
+    unarchived_by: UserIdentity | null;
+    deleted: boolean;
+    deleted_at: Date | null;
+    deleted_by: UserIdentity | null;
+    restored_at: Date | null;
+    restored_by: UserIdentity | null;
+};

package/dist/leads/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/notes/enum/index.d.ts

@@ -1,4 +1,5 @@
 export declare enum NotesEntityTypes {
+    LEAD = "leads",
     CLIENT = "clients",
     PROJECT = "projects",
     BUDGET_EXPENSE = "budget_expenses",

package/dist/notes/enum/index.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.NotesEntityTypes = void 0;
 var NotesEntityTypes;
 (function (NotesEntityTypes) {
+    NotesEntityTypes["LEAD"] = "leads";
     NotesEntityTypes["CLIENT"] = "clients";
     NotesEntityTypes["PROJECT"] = "projects";
     NotesEntityTypes["BUDGET_EXPENSE"] = "budget_expenses";

package/dist/status/enum/index.d.ts

@@ -1,4 +1,5 @@
 export declare enum StatusEntityTypes {
+    LEAD = "leads",
     CLIENT = "clients",
     PROJECT = "projects",
     TASK = "tasks"

package/dist/status/enum/index.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.StatusEntityTypes = void 0;
 var StatusEntityTypes;
 (function (StatusEntityTypes) {
+    StatusEntityTypes["LEAD"] = "leads";
     StatusEntityTypes["CLIENT"] = "clients";
     StatusEntityTypes["PROJECT"] = "projects";
     StatusEntityTypes["TASK"] = "tasks";

package/dist/status/index.d.ts

@@ -6,4 +6,5 @@ export type StatusEntity = {
     is_complete: boolean;
     is_fail: boolean;
     is_triage: boolean;
+    is_won: boolean;
 };

package/dist/supporting-files/enum/index.d.ts

@@ -1,4 +1,5 @@
 export declare enum SupportingFilesEntityTypes {
+    LEAD = "leads",
     CLIENT = "clients",
     PROJECT = "projects",
     BUDGET_EXPENSE = "budget_expenses",

package/dist/supporting-files/enum/index.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.SupportingFilesExtensions = exports.SupportingFilesEntityTypes = void 0;
 var SupportingFilesEntityTypes;
 (function (SupportingFilesEntityTypes) {
+    SupportingFilesEntityTypes["LEAD"] = "leads";
     SupportingFilesEntityTypes["CLIENT"] = "clients";
     SupportingFilesEntityTypes["PROJECT"] = "projects";
     SupportingFilesEntityTypes["BUDGET_EXPENSE"] = "budget_expenses";

package/dist/users/index.d.ts

@@ -63,6 +63,10 @@ export interface PermissionsEntity {
     is_admin: boolean;
     is_owner: boolean;
     view_dashboard: boolean;
+    create_leads: boolean;
+    read_leads: boolean;
+    update_leads: boolean;
+    delete_leads: boolean;
     create_clients: boolean;
     read_clients: boolean;
     update_clients: boolean;
@@ -135,6 +139,7 @@ export interface PermissionsEntity {
 export interface Permissions {
     permissions: {
         dashboard: Omit<CrudPermission, 'create' | 'update' | 'delete'>;
+        leads: CrudPermission;
         clients: CrudPermission;
         projects: CrudPermission;
         project_budgets: CrudPermission;

package/dist/users/permissions/dto/index.d.ts

@@ -1,4 +1,8 @@
 export type UpdatePermissionsDto = {
+    create_leads: boolean;
+    read_leads: boolean;
+    update_leads: boolean;
+    delete_leads: boolean;
     create_clients: boolean;
     read_clients: boolean;
     update_clients: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@managemint-solutions/entities",
-  "version": "1.26.0",
+  "version": "1.27.0",
   "description": "Entity types used by both the api and portal",
   "homepage": "https://github.com/ManageMint-Solutions/managemint-solutions-entities#readme",
   "bugs": {