@dakkitor/api-contracts 1.1.9 → 1.1.11

package/dist/call-history/call-history.contract.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"call-history.contract.d.ts","sourceRoot":"","sources":["../../contracts/call-history/call-history.contract.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AASxB,oBAAY,UAAU;IACpB,SAAS,IAAI;IACb,cAAc,IAAI;IAClB,uBAAuB,IAAI;IAC3B,kBAAkB,IAAI;IACtB,WAAW,IAAI;IACf,UAAU,IAAI;IACd,cAAc,IAAI;IAClB,oBAAoB,IAAI;IACxB,uBAAuB,IAAI;IAC3B,sBAAsB,IAAI;IAC1B,YAAY,KAAK;CAClB;AAED,oBAAY,QAAQ;IAClB,UAAU,eAAe;IACzB,eAAe,oBAAoB;IACnC,aAAa,kBAAkB;CAChC;AAED,oBAAY,yBAAyB;IACnC,UAAU,cAAc;IACxB,SAAS,aAAa;IACtB,MAAM,WAAW;IACjB,aAAa,iBAAiB;CAC/B;AAED,eAAO,MAAM,gBAAgB,oCAG3B,CAAC;AAEH,eAAO,MAAM,cAAc,kCAGzB,CAAC;AAEH,eAAO,MAAM,+BAA+B,mDAIxC,CAAC;AAGL,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAqDM,CAAC;AAErC,eAAO,MAAM,kCAAkC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAI7C,CAAC;AAEH,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;EAcM,CAAC;AAE3C,eAAO,MAAM,uBAAuB;;;;;;;;;;;;EAcM,CAAC;AAE3C,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA6BM,CAAC;AAE3C,eAAO,MAAM,sBAAsB;;;;;;;;;;;;EAQM,CAAC;AAI1C,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAC5D,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAChD,OAAO,kCAAkC,CAC1C,CAAC;AACF,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC;AACxE,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC;AACxE,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC;AACxE,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAEtE,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA+E/B,CAAC"}

package/dist/call-history/call-history.contract.js

@@ -0,0 +1,254 @@
+"use strict";
+/**
+ * Project: Internal Recruitment Platform API
+ * File: call-history.contract.ts
+ *
+ * Description: Contract definition for Call History V2 API.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.callHistoryContract = exports.CallHistoryStatsSchema = exports.FilterCallHistorySchema = exports.UpdateCallHistorySchema = exports.CreateCallHistorySchema = exports.PaginatedCallHistoryResponseSchema = exports.CallHistorySchema = exports.CallHistorySortableFieldsSchema = exports.CallTypeSchema = exports.CallRatingSchema = exports.CallHistorySortableFields = exports.CallType = exports.CallRating = void 0;
+const core_1 = require("@ts-rest/core");
+const zod_1 = require("zod");
+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");
+const c = (0, core_1.initContract)();
+// Enums
+var CallRating;
+(function (CallRating) {
+    CallRating[CallRating["NO_ANSWER"] = 0] = "NO_ANSWER";
+    CallRating[CallRating["INVALID_NUMBER"] = 1] = "INVALID_NUMBER";
+    CallRating[CallRating["STRONGLY_NOT_INTERESTED"] = 2] = "STRONGLY_NOT_INTERESTED";
+    CallRating[CallRating["NOT_INTERESTED_NOW"] = 3] = "NOT_INTERESTED_NOW";
+    CallRating[CallRating["BRUSHED_OFF"] = 4] = "BRUSHED_OFF";
+    CallRating[CallRating["INTERESTED"] = 5] = "INTERESTED";
+    CallRating[CallRating["REQUESTED_INFO"] = 6] = "REQUESTED_INFO";
+    CallRating[CallRating["WANTS_TO_COLLABORATE"] = 7] = "WANTS_TO_COLLABORATE";
+    CallRating[CallRating["FUTURE_NEEDS_IDENTIFIED"] = 8] = "FUTURE_NEEDS_IDENTIFIED";
+    CallRating[CallRating["COLLABORATION_ACCEPTED"] = 9] = "COLLABORATION_ACCEPTED";
+    CallRating[CallRating["JOB_RECEIVED"] = 10] = "JOB_RECEIVED";
+})(CallRating || (exports.CallRating = CallRating = {}));
+var CallType;
+(function (CallType) {
+    CallType["ASSIGNMENT"] = "assignment";
+    CallType["AGENT_FOLLOW_UP"] = "agent_follow_up";
+    CallType["LEAD_CALLBACK"] = "lead_callback";
+})(CallType || (exports.CallType = CallType = {}));
+var CallHistorySortableFields;
+(function (CallHistorySortableFields) {
+    CallHistorySortableFields["CREATED_AT"] = "createdAt";
+    CallHistorySortableFields["CALL_DATE"] = "callDate";
+    CallHistorySortableFields["RATING"] = "rating";
+    CallHistorySortableFields["RATING_WEIGHT"] = "ratingWeight";
+})(CallHistorySortableFields || (exports.CallHistorySortableFields = CallHistorySortableFields = {}));
+exports.CallRatingSchema = zod_1.z.nativeEnum(CallRating).openapi({
+    title: 'CallRating',
+    description: 'Rating of the call outcome (0-10)',
+});
+exports.CallTypeSchema = zod_1.z.nativeEnum(CallType).openapi({
+    title: 'CallType',
+    description: 'Type of the call',
+});
+exports.CallHistorySortableFieldsSchema = zod_1.z
+    .nativeEnum(CallHistorySortableFields)
+    .openapi({
+    title: 'CallHistorySortableFields',
+});
+// Schemas
+exports.CallHistorySchema = zod_1.z
+    .object({
+    id: zod_1.z.string().uuid().describe('The unique identifier of the call record'),
+    assignmentId: zod_1.z
+        .string()
+        .uuid()
+        .describe('The ID of the assignment that generated this call record'),
+    // leadId and agentId are derived from assignment usually, but existing DTO has them?
+    // Looking at CallHistoryResponseDto, it exposes leadId and agentId.
+    // However, the entity CallHistory only has assignmentId.
+    // The Service probably populates leadId and agentId from assignment.
+    // We should verify if we need to include them in the schema.
+    // The V1 controller returns CallHistoryResponseDto which has leadId and agentId.
+    // However, they are not on the entity and might be missing if assignment is not loaded.
+    leadId: zod_1.z
+        .string()
+        .uuid()
+        .describe('The ID of the lead that was called')
+        .optional(),
+    agentId: zod_1.z
+        .string()
+        .uuid()
+        .describe('The ID of the agent who made the call')
+        .optional(),
+    assignment: zod_1.z
+        .any() // We can refine this if we import LeadAssignmentSchema later, for now usage any or object
+        .describe('The assignment that generated this call record')
+        .optional()
+        .nullable(),
+    callDate: zod_1.z
+        .union([zod_1.z.string().datetime(), zod_1.z.date()])
+        .transform((val) => (val instanceof Date ? val.toISOString() : val))
+        .describe('The date and time when the call was made'),
+    callType: exports.CallTypeSchema,
+    rating: exports.CallRatingSchema,
+    ratingWeight: zod_1.z
+        .number()
+        .describe('The weight associated with the call rating for performance calculations'),
+    notes: zod_1.z
+        .string()
+        .describe('Optional notes about the call conversation')
+        .nullable(),
+    createdAt: zod_1.z
+        .union([zod_1.z.string().datetime(), zod_1.z.date()])
+        .transform((val) => (val instanceof Date ? val.toISOString() : val))
+        .describe('The timestamp when the call record was created'),
+    updatedAt: zod_1.z
+        .union([zod_1.z.string().datetime(), zod_1.z.date()])
+        .transform((val) => (val instanceof Date ? val.toISOString() : val))
+        .describe('The timestamp when the call record was last updated'),
+})
+    .openapi({ title: 'CallHistory' });
+exports.PaginatedCallHistoryResponseSchema = (0, pagination_schema_1.createPaginatedResponseSchema)(exports.CallHistorySchema).openapi({
+    title: 'PaginatedCallHistoryResponse',
+});
+exports.CreateCallHistorySchema = zod_1.z
+    .object({
+    assignmentId: zod_1.z
+        .string()
+        .uuid()
+        .describe('The ID of the assignment that generated this call record'),
+    rating: exports.CallRatingSchema,
+    notes: zod_1.z
+        .string()
+        .max(1000)
+        .describe('Optional notes about the call conversation')
+        .optional(),
+    callType: exports.CallTypeSchema,
+})
+    .openapi({ title: 'CreateCallHistory' });
+exports.UpdateCallHistorySchema = zod_1.z
+    .object({
+    callDate: zod_1.z
+        .string() // IsDateString in DTO
+        .datetime()
+        .describe('The date and time when the call was made')
+        .optional(),
+    rating: exports.CallRatingSchema.optional(),
+    notes: zod_1.z
+        .string()
+        .max(1000)
+        .describe('Optional notes about the call conversation')
+        .optional(),
+})
+    .openapi({ title: 'UpdateCallHistory' });
+exports.FilterCallHistorySchema = pagination_query_schema_1.PaginationQuerySchema.extend({
+    assignmentId: zod_1.z
+        .string()
+        .uuid()
+        .describe('Filter by assignment ID')
+        .optional(),
+    rating: zod_1.z.preprocess((val) => (val ? Number(val) : undefined), exports.CallRatingSchema.optional()),
+    callType: exports.CallTypeSchema.optional(),
+    callDateFrom: zod_1.z
+        .string()
+        .datetime()
+        .describe('Filter calls from this date onwards')
+        .optional(),
+    callDateTo: zod_1.z
+        .string()
+        .datetime()
+        .describe('Filter calls up to this date')
+        .optional(),
+    sortBy: exports.CallHistorySortableFieldsSchema.default(CallHistorySortableFields.CREATED_AT)
+        .describe('The field to sort the results by')
+        .optional(),
+    sortOrder: common_schemas_1.SortOrderSchema.default('DESC')
+        .describe('The order to sort the results by')
+        .optional(),
+}).openapi({ title: 'FilterCallHistory' });
+exports.CallHistoryStatsSchema = zod_1.z
+    .object({
+    totalCalls: zod_1.z.number().describe('Total number of calls made'),
+    averageRatingWeight: zod_1.z.number().describe('Average rating weight of calls'),
+    callsByRating: zod_1.z
+        .record(zod_1.z.string(), zod_1.z.number())
+        .describe('Distribution of calls by rating'),
+})
+    .openapi({ title: 'CallHistoryStats' });
+exports.callHistoryContract = c.router({
+    create: {
+        method: 'POST',
+        path: '/call-history',
+        body: exports.CreateCallHistorySchema,
+        responses: {
+            201: exports.CallHistorySchema,
+            409: error_schemas_1.ErrorResponseSchema,
+        },
+        summary: 'Create a new call history record',
+        metadata: {
+            tags: ['Call History'],
+        },
+    },
+    findAll: {
+        method: 'GET',
+        path: '/call-history',
+        query: exports.FilterCallHistorySchema,
+        responses: {
+            200: exports.PaginatedCallHistoryResponseSchema,
+        },
+        summary: 'Get call history records',
+        metadata: {
+            tags: ['Call History'],
+        },
+    },
+    findOne: {
+        method: 'GET',
+        path: '/call-history/:id',
+        pathParams: zod_1.z.object({
+            id: zod_1.z.string().uuid(),
+        }),
+        responses: {
+            200: exports.CallHistorySchema,
+            404: error_schemas_1.ErrorResponseSchema,
+        },
+        summary: 'Get a specific call history record',
+        metadata: {
+            tags: ['Call History'],
+        },
+    },
+    update: {
+        method: 'PATCH',
+        path: '/call-history/:id',
+        pathParams: zod_1.z.object({
+            id: zod_1.z.string().uuid(),
+        }),
+        body: exports.UpdateCallHistorySchema,
+        responses: {
+            200: exports.CallHistorySchema,
+            404: error_schemas_1.ErrorResponseSchema,
+        },
+        summary: 'Update call history notes',
+        metadata: {
+            tags: ['Call History'],
+        },
+    },
+    getAgentStats: {
+        method: 'GET',
+        path: '/call-history/stats/agent',
+        responses: {
+            200: exports.CallHistoryStatsSchema,
+        },
+        summary: 'Get agent performance statistics',
+        metadata: {
+            tags: ['Call History'],
+        },
+    },
+}, {
+    pathPrefix: '/v2',
+    commonResponses: {
+        400: error_schemas_1.ErrorResponseSchema,
+        401: error_schemas_1.ErrorResponseSchema,
+        403: error_schemas_1.ErrorResponseSchema,
+        500: error_schemas_1.ErrorResponseSchema,
+    },
+});