@dakkitor/api-contracts 1.1.10 → 1.1.11

package/dist/leads/leads.contract.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"leads.contract.d.ts","sourceRoot":"","sources":["../../contracts/leads/leads.contract.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAaxB;;GAEG;AACH,eAAO,MAAM,gBAAgB,qDAEM,CAAC;AAEpC;;GAEG;AACH,eAAO,MAAM,wBAAwB,kIAYM,CAAC;AAE5C;;GAEG;AACH,eAAO,MAAM,iBAAiB,kDAEM,CAAC;AAErC,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAC1D,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAC1E,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAE5D;;GAEG;AACH,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAuCM,CAAC;AAE9B;;GAEG;AACH,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;EAaM,CAAC;AAEpC;;GAEG;AACH,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;EAQM,CAAC;AAEpC;;GAEG;AACH,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAwD3B,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,6BAA6B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAuBM,CAAC;AAEjD;;GAEG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;EAOM,CAAC;AAE1C,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAYM,CAAC;AAExC,eAAO,MAAM,2BAA2B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAIO,CAAC;AAEhD,MAAM,MAAM,IAAI,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,UAAU,CAAC,CAAC;AAC9C,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAC1D,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAC1D,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAC1D,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAC3C,OAAO,6BAA6B,CACrC,CAAC;AACF,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AACtE,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAClE,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC,CAAC;AAIhF,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAuG/B,CAAC"}

package/dist/leads/leads.contract.js

@@ -0,0 +1,328 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.leadsContractRouter = exports.PaginatedLeadResponseSchema = exports.LeadStatisticsSchema = exports.TierDistributionSchema = exports.LeadCallHistoryResponseSchema = exports.FilterLeadSchema = exports.UpdateLeadSchema = exports.CreateLeadSchema = exports.LeadSchema = exports.QualityTierSchema = exports.LeadSortableFieldsSchema = exports.LeadStatusSchema = void 0;
+const zod_openapi_1 = require("@anatine/zod-openapi");
+const core_1 = require("@ts-rest/core");
+const zod_1 = require("zod");
+const call_history_contract_1 = require("../call-history/call-history.contract");
+const common_schemas_1 = require("../common/common-schemas");
+const error_schemas_1 = require("../common/error-schemas");
+const pagination_query_schema_1 = require("../common/pagination-query.schema");
+const pagination_schema_1 = require("../common/pagination.schema");
+(0, zod_openapi_1.extendZodWithOpenApi)(zod_1.z);
+/**
+ * Lead Status Enum
+ */
+exports.LeadStatusSchema = zod_1.z
+    .enum(['AVAILABLE', 'ASSIGNED', 'BLACKLISTED'])
+    .openapi({ title: 'LeadStatus' });
+/**
+ * Lead Sortable Fields Enum
+ */
+exports.LeadSortableFieldsSchema = zod_1.z
+    .enum([
+    'name',
+    'phoneNumber',
+    'status',
+    'source',
+    'qualityScore',
+    'conversionRate',
+    'totalCalls',
+    'createdAt',
+    'updatedAt',
+])
+    .openapi({ title: 'LeadSortableFields' });
+/**
+ * Quality Tier Enum
+ */
+exports.QualityTierSchema = zod_1.z
+    .enum(['high', 'medium', 'low', 'untested'])
+    .openapi({ title: 'QualityTier' });
+/**
+ * Main Lead Schema
+ */
+exports.LeadSchema = zod_1.z
+    .object({
+    id: zod_1.z.string().uuid().describe('Lead ID'),
+    name: zod_1.z.string().describe('Company Name'),
+    phoneNumber: zod_1.z.string().describe('Phone Number'),
+    status: exports.LeadStatusSchema.describe('Lead Status'),
+    blacklistReason: zod_1.z
+        .string()
+        .optional()
+        .nullable()
+        .describe('Reason for Blacklisting'),
+    source: zod_1.z.string().describe('Lead Source'),
+    qualityScore: zod_1.z
+        .number()
+        .min(0)
+        .max(1)
+        .optional()
+        .nullable()
+        .describe('Overall Quality Score'),
+    qualityTier: exports.QualityTierSchema.optional()
+        .nullable()
+        .describe('Quality Tier Classification'),
+    conversionRate: zod_1.z
+        .number()
+        .min(0)
+        .max(1)
+        .optional()
+        .nullable()
+        .describe('Conversion Rate'),
+    totalCalls: zod_1.z.number().int().optional().nullable().describe('Total Calls'),
+    createdAt: zod_1.z
+        .union([zod_1.z.string().datetime(), zod_1.z.date()])
+        .transform((val) => (val instanceof Date ? val.toISOString() : val))
+        .describe('Creation Date'),
+    updatedAt: zod_1.z
+        .union([zod_1.z.string().datetime(), zod_1.z.date()])
+        .transform((val) => (val instanceof Date ? val.toISOString() : val))
+        .describe('Last Update Date'),
+})
+    .openapi({ title: 'Lead' });
+/**
+ * Create Lead Schema
+ */
+exports.CreateLeadSchema = zod_1.z
+    .object({
+    name: zod_1.z.string().max(255).describe('Company Name'),
+    phoneNumber: zod_1.z.string().max(20).describe('Phone Number'),
+    status: exports.LeadStatusSchema.optional().describe('Lead Status'),
+    isBlacklisted: zod_1.z.boolean().default(false).describe('Is Blacklisted'),
+    blacklistReason: zod_1.z
+        .string()
+        .max(500)
+        .optional()
+        .describe('Reason for Blacklisting'),
+    source: zod_1.z.string().max(100).describe('Lead Source'),
+})
+    .openapi({ title: 'CreateLead' });
+/**
+ * Update Lead Schema
+ */
+exports.UpdateLeadSchema = zod_1.z
+    .object({
+    name: zod_1.z.string().max(255).optional().describe('Company Name'),
+    phoneNumber: zod_1.z.string().max(20).optional().describe('Phone Number'),
+    status: exports.LeadStatusSchema.optional().describe('Lead Status'),
+    blacklistReason: zod_1.z.string().optional().describe('Reason for Blacklisting'),
+    source: zod_1.z.string().max(100).optional().describe('Lead Source'),
+})
+    .openapi({ title: 'UpdateLead' });
+/**
+ * Filter Lead Schema
+ */
+exports.FilterLeadSchema = pagination_query_schema_1.PaginationQuerySchema.extend({
+    name: zod_1.z
+        .string()
+        .optional()
+        .nullable()
+        .describe('Filter by company name (case-insensitive, partial match)'),
+    phoneNumber: zod_1.z
+        .string()
+        .optional()
+        .nullable()
+        .describe('Filter by phone number (partial match)'),
+    status: exports.LeadStatusSchema.optional()
+        .nullable()
+        .describe('Filter by lead status'),
+    source: zod_1.z
+        .string()
+        .optional()
+        .nullable()
+        .describe('Filter by source (case-insensitive, partial match)'),
+    minQualityScore: zod_1.z
+        .number()
+        .min(0)
+        .max(1)
+        .optional()
+        .nullable()
+        .describe('Filter by minimum quality score (0-1)'),
+    maxQualityScore: zod_1.z
+        .number()
+        .min(0)
+        .max(1)
+        .optional()
+        .nullable()
+        .describe('Filter by maximum quality score (0-1)'),
+    qualityTier: exports.QualityTierSchema.optional()
+        .nullable()
+        .describe('Filter by quality tier'),
+    minConversionRate: zod_1.z
+        .number()
+        .min(0)
+        .max(1)
+        .optional()
+        .nullable()
+        .describe('Filter by minimum conversion rate (0-1)'),
+    minTotalCalls: zod_1.z
+        .number()
+        .int()
+        .min(0)
+        .optional()
+        .nullable()
+        .describe('Filter by minimum total calls'),
+    sortBy: exports.LeadSortableFieldsSchema.optional()
+        .nullable()
+        .describe('The field to sort the results by'),
+    sortOrder: common_schemas_1.SortOrderSchema.optional()
+        .nullable()
+        .describe('The order to sort the results by'),
+});
+/**
+ * Call History Response Schema for leads
+ */
+exports.LeadCallHistoryResponseSchema = zod_1.z
+    .object({
+    id: zod_1.z.string().uuid().describe('Call History ID'),
+    assignmentId: zod_1.z.string().uuid().describe('Assignment ID'),
+    leadId: zod_1.z.string().uuid().describe('Lead ID'),
+    agentId: zod_1.z.string().uuid().describe('Agent ID'),
+    callDate: zod_1.z
+        .union([zod_1.z.string().datetime(), zod_1.z.date()])
+        .transform((val) => (val instanceof Date ? val.toISOString() : val))
+        .describe('Call Date'),
+    callType: call_history_contract_1.CallTypeSchema.describe('Call Type'),
+    rating: call_history_contract_1.CallRatingSchema.describe('Call Rating'),
+    ratingWeight: zod_1.z.number().describe('Rating Weight'),
+    notes: zod_1.z.string().nullable().optional().describe('Call Notes'),
+    createdAt: zod_1.z
+        .union([zod_1.z.string().datetime(), zod_1.z.date()])
+        .transform((val) => (val instanceof Date ? val.toISOString() : val))
+        .describe('Creation Date'),
+    updatedAt: zod_1.z
+        .union([zod_1.z.string().datetime(), zod_1.z.date()])
+        .transform((val) => (val instanceof Date ? val.toISOString() : val))
+        .describe('Last Update Date'),
+})
+    .openapi({ title: 'LeadCallHistoryResponse' });
+/**
+ * Lead Statistics Schema for quality dashboard
+ */
+exports.TierDistributionSchema = zod_1.z
+    .object({
+    high: zod_1.z.number().int().describe('High Quality Leads'),
+    medium: zod_1.z.number().int().describe('Medium Quality Leads'),
+    low: zod_1.z.number().int().describe('Low Quality Leads'),
+    untested: zod_1.z.number().int().describe('Untested Leads'),
+})
+    .openapi({ title: 'TierDistribution' });
+exports.LeadStatisticsSchema = zod_1.z
+    .object({
+    totalLeads: zod_1.z.number().int().describe('Total Leads'),
+    avgQualityScore: zod_1.z.number().min(0).max(1).describe('Average Quality Score'),
+    avgConversionRate: zod_1.z
+        .number()
+        .min(0)
+        .max(1)
+        .describe('Average Conversion Rate'),
+    avgCallsPerLead: zod_1.z.number().describe('Average Calls Per Lead'),
+    tierDistribution: exports.TierDistributionSchema.describe('Tier Distribution'),
+})
+    .openapi({ title: 'LeadStatistics' });
+exports.PaginatedLeadResponseSchema = (0, pagination_schema_1.createPaginatedResponseSchema)(exports.LeadSchema)
+    .describe('Leads retrieved successfully')
+    .openapi({ title: 'LeadsPaginatedResponse' });
+const c = (0, core_1.initContract)();
+exports.leadsContractRouter = c.router({
+    create: {
+        method: 'POST',
+        path: '/v2/leads',
+        responses: {
+            201: exports.LeadSchema,
+            409: error_schemas_1.ErrorResponseSchema,
+        },
+        body: exports.CreateLeadSchema,
+        summary: 'Create a new lead',
+        metadata: { tags: ['Leads'], openApi: { operationId: 'createLead' } },
+    },
+    findAll: {
+        method: 'GET',
+        path: '/v2/leads',
+        responses: {
+            200: exports.PaginatedLeadResponseSchema,
+        },
+        query: exports.FilterLeadSchema,
+        summary: 'Get all leads',
+        metadata: { tags: ['Leads'], openApi: { operationId: 'findAllLeads' } },
+    },
+    findOne: {
+        method: 'GET',
+        path: '/v2/leads/:id',
+        responses: {
+            200: exports.LeadSchema,
+            404: error_schemas_1.ErrorResponseSchema,
+        },
+        pathParams: zod_1.z.object({
+            id: zod_1.z.string().uuid().describe('Lead ID'),
+        }),
+        summary: 'Get a lead by ID',
+        metadata: { tags: ['Leads'], openApi: { operationId: 'findLeadById' } },
+    },
+    update: {
+        method: 'PATCH',
+        path: '/v2/leads/:id',
+        responses: {
+            200: exports.LeadSchema,
+            404: error_schemas_1.ErrorResponseSchema,
+            409: error_schemas_1.ErrorResponseSchema,
+        },
+        pathParams: zod_1.z.object({
+            id: zod_1.z.string().uuid().describe('Lead ID'),
+        }),
+        body: exports.UpdateLeadSchema,
+        summary: 'Update a lead',
+        metadata: { tags: ['Leads'], openApi: { operationId: 'updateLead' } },
+    },
+    remove: {
+        method: 'DELETE',
+        path: '/v2/leads/:id',
+        responses: {
+            204: zod_1.z.undefined(),
+            404: error_schemas_1.ErrorResponseSchema,
+        },
+        pathParams: zod_1.z.object({
+            id: zod_1.z.string().uuid().describe('Lead ID'),
+        }),
+        body: c.noBody(),
+        summary: 'Delete a lead',
+        metadata: { tags: ['Leads'], openApi: { operationId: 'deleteLead' } },
+    },
+    recordCall: {
+        method: 'POST',
+        path: '/v2/leads/:id/call',
+        responses: {
+            201: exports.LeadCallHistoryResponseSchema,
+        },
+        pathParams: zod_1.z.object({
+            id: zod_1.z.string().uuid().describe('Lead ID'),
+        }),
+        body: call_history_contract_1.CreateCallHistorySchema,
+        summary: 'Record a call to a lead',
+        metadata: {
+            tags: ['Leads'],
+            openApi: { operationId: 'recordCallToLead' },
+        },
+    },
+    getQualityDashboard: {
+        method: 'GET',
+        path: '/v2/leads/analytics/quality-dashboard',
+        responses: {
+            200: exports.LeadStatisticsSchema,
+        },
+        query: zod_1.z.object({}),
+        summary: 'Get lead quality analytics dashboard',
+        metadata: {
+            tags: ['Leads'],
+            openApi: { operationId: 'getQualityDashboard' },
+        },
+    },
+}, {
+    commonResponses: {
+        400: error_schemas_1.ErrorResponseSchema,
+        401: error_schemas_1.ErrorResponseSchema,
+        403: error_schemas_1.ErrorResponseSchema,
+        500: error_schemas_1.ErrorResponseSchema,
+    },
+});