Services

The LeadSmart API implements a service-layer architecture where business logic is encapsulated in service modules. This document outlines the key services and their responsibilities.

Core Services

Authentication Service

Handles user authentication, token management, and security-related operations.

Key functionalities:

User login and token generation

Token validation and refresh

Password reset and recovery

User registration and activation

Implementation files:

src/services/auth.service.ts

User Service

Manages user accounts and profiles.

Key functionalities:

User CRUD operations

User profile management

User role assignment

Password management

Implementation files:

src/services/user.service.ts

Company Service

Manages company information and settings.

Key functionalities:

Company CRUD operations

Company settings management

Member management within companies

Company subscription management

Implementation files:

src/services/company.service.ts

Member Service

Manages user memberships within companies.

Key functionalities:

Member CRUD operations

Role assignment within companies

Member invitations and onboarding

Member permissions management

Implementation files:

src/services/member.service.ts

Client Management

Client Service

Manages client information and interactions.

Key functionalities:

Client CRUD operations

Client data management

Client categorization and tagging

Client history tracking

Implementation files:

src/services/client.service.ts

Thread Service

Manages conversation threads with clients.

Key functionalities:

Thread CRUD operations

Message history management

Thread status tracking

Unread message counting

Implementation files:

src/services/clientThread.service.ts

Appointment Management

Agenda Service

Manages appointment calendars and availability.

Key functionalities:

Agenda CRUD operations

Availability management

Calendar synchronization

Agenda sharing and permissions

Implementation files:

src/services/agenda.service.ts

Appointment Service

Manages scheduled appointments and meetings.

Key functionalities:

Appointment CRUD operations

Appointment scheduling and rescheduling

Appointment reminders and notifications

Appointment status management

Implementation files:

src/services/appointment.service.ts

Messaging Services

Messaging Service

Manages WhatsApp messaging instances and message sending.

Key functionalities:

WhatsApp connection management

Message sending and receiving

QR code generation for WhatsApp Web

Connection status monitoring

Implementation files:

src/messaging/whatsapp.service.ts

Integration Services

Google Calendar Integration

Manages integration with Google Calendar for appointment synchronization.

Key functionalities:

Google Calendar authentication

Calendar event synchronization

Webhook registration and handling

Event creation and updates

Implementation files:

src/integrations/google/calendar.service.ts

OpenAI Integration

Manages integration with OpenAI for AI-powered conversations.

Key functionalities:

OpenAI API authentication

Model selection and configuration

Prompt management

Response handling

Implementation files:

src/services/openai.service.ts

src/services/openaiBot.service.ts

Chatwoot Integration

Manages integration with Chatwoot for customer support.

Key functionalities:

Chatwoot API authentication

Conversation synchronization

Agent assignment

Status tracking

Implementation files:

src/services/chatwootAccount.service.ts

Subscription and Billing

Plan Service

Manages subscription plans and features.

Key functionalities:

Plan CRUD operations

Feature management

Price configuration

Plan comparison

Implementation files:

src/services/plan.service.ts

src/services/planDuration.service.ts

Utility Services

Vector Service

Manages vector embeddings for AI applications.

Key functionalities:

Vector creation and storage

Vector search and retrieval

Vector indexing

Similarity calculations

Implementation files:

src/services/vector.service.ts

Service Architecture

Services in LeadSmart API follow these design principles:

Separation of Concerns: Each service is responsible for a specific domain area

Dependency Injection: Services receive dependencies through constructor injection

Error Handling: Services use custom exception classes for error cases

Validation: Input validation is performed using Zod schemas

Transactions: Database operations use transactions for data integrity

Services typically follow this pattern:

Services are used by controllers to handle business logic, keeping controllers focused on request/response handling rather than implementation details.

Core Services#

Authentication Service#

User Service#

Company Service#

Member Service#

Client Management#

Client Service#

Thread Service#

Appointment Management#

Agenda Service#

Appointment Service#

Messaging Services#

Messaging Service#

Integration Services#

Google Calendar Integration#

OpenAI Integration#

Chatwoot Integration#

Subscription and Billing#

Plan Service#

Utility Services#

Vector Service#

Service Architecture#

Core Services

Authentication Service

User Service

Company Service

Member Service

Client Management

Client Service

Thread Service

Appointment Management

Agenda Service

Appointment Service

Messaging Services

Messaging Service

Integration Services

Google Calendar Integration

OpenAI Integration

Chatwoot Integration

Subscription and Billing

Plan Service

Utility Services

Vector Service

Service Architecture