@talkpilot/core-db 1.3.77 → 1.3.78

package/src/talkpilot/calls/calls.statistics.types.ts

@@ -1,48 +1,48 @@
-export type ResolvedTimeBucket = "day" | "week" | "month";
-
-export type TicketStatusFilter = "opened" | "not_opened";
-export type CallRoutingFilter = "ai_only" | "transferred" | "hijacked";
-
-export type CallsStatsFilter = {
-  clientId: string;
-  startStr: string;
-  endStr: string;
-  timezone: string;
-  hourFrom?: string; // HH:mm
-  hourTo?: string; // HH:mm
-  callRouting?: CallRoutingFilter[];
-  /** @deprecated Use callSidTicketCounts instead. */
-  callSidsWithTickets?: string[];
-  callSidTicketCounts?: Map<string, number>;
-  /** @deprecated Use callSidDraftTicketCounts instead. */
-  callSidsWithDraftTickets?: string[];
-  callSidDraftTicketCounts?: Map<string, number>;
-  ticketStatusFilters?: TicketStatusFilter[];
-};
-
-export type CallsSummaryAggregation = {
-  totalCalls: number;
-  avgDurationSeconds: number;
-  openTickets: number;
-  draftTickets: number;
-  callsWithTickets?: number;
-};
-
-export type CallsTrendBucket = {
-  /** Day: YYYY-MM-DD; week: YYYY-MM-DD/YYYY-MM-DD (inclusive, clipped to filter); month: YYYY-MM-01 */
-  bucket: string;
-  totalCalls: number;
-  openTickets: number;
-};
-
-export type CallsHourlyBucket = {
-  hour: number;
-  totalCalls: number;
-  avgCalls: number;
-};
-
-export type CallsRoutingAggregation = {
-  aiHandled: number;
-  transferred: number;
-  hijacked: number;
-};
+export type ResolvedTimeBucket = "day" | "week" | "month";
+
+export type TicketStatusFilter = "opened" | "not_opened";
+export type CallRoutingFilter = "ai_only" | "transferred" | "hijacked";
+
+export type CallsStatsFilter = {
+  clientId: string;
+  startStr: string;
+  endStr: string;
+  timezone: string;
+  hourFrom?: string; // HH:mm
+  hourTo?: string; // HH:mm
+  callRouting?: CallRoutingFilter[];
+  /** @deprecated Use callSidTicketCounts instead. */
+  callSidsWithTickets?: string[];
+  callSidTicketCounts?: Map<string, number>;
+  /** @deprecated Use callSidDraftTicketCounts instead. */
+  callSidsWithDraftTickets?: string[];
+  callSidDraftTicketCounts?: Map<string, number>;
+  ticketStatusFilters?: TicketStatusFilter[];
+};
+
+export type CallsSummaryAggregation = {
+  totalCalls: number;
+  avgDurationSeconds: number;
+  openTickets: number;
+  draftTickets: number;
+  callsWithTickets?: number;
+};
+
+export type CallsTrendBucket = {
+  /** Day: YYYY-MM-DD; week: YYYY-MM-DD/YYYY-MM-DD (inclusive, clipped to filter); month: YYYY-MM-01 */
+  bucket: string;
+  totalCalls: number;
+  openTickets: number;
+};
+
+export type CallsHourlyBucket = {
+  hour: number;
+  totalCalls: number;
+  avgCalls: number;
+};
+
+export type CallsRoutingAggregation = {
+  aiHandled: number;
+  transferred: number;
+  hijacked: number;
+};

package/src/talkpilot/calls/calls.types.ts

@@ -1,151 +1,164 @@
-import { ObjectId, Sort, WithId } from "mongodb";
-import { TranscriptionSegment } from "../results";
-import { LeadProperty } from "../leads";
-
-import {
-  CallStatusValues,
-  CONFERENCE_ROLE_CUSTOMER,
-  CONFERENCE_ROLE_SUPERVISOR,
-} from "./calls.constants";
-
-export type ConferenceRole =
-  | typeof CONFERENCE_ROLE_CUSTOMER
-  | typeof CONFERENCE_ROLE_SUPERVISOR
-  | null;
-
-export type CallStatus = (typeof CallStatusValues)[keyof typeof CallStatusValues];
-
-export type Call = {
-  callSid: string;
-  flowId: ObjectId;
-  clientId: string;
-  sessionId: ObjectId | null;
-  runId?: string;
-  resultId: ObjectId;
-  customerPhoneNumber: string;
-  agentPhoneNumber: string;
-  isIncomingCall: boolean;
-  isOutgoingCall: boolean;
-  callLength: number;
-  transcription?: TranscriptionSegment[];
-  status?: CallStatus;
-  leads?: LeadProperty[];
-  summary?: string;
-  recordingUrl?: string;
-  env: string;
-  updatedAt: Date;
-  createdAt: Date;
-  isAnsweredByAnsweringMachine?: boolean;
-  agentHungUp?: boolean;
-  endReason?: string;
-  conferenceName?: string | null;
-  conferenceSid?: string | null;
-  conferenceParticipantSid?: string | null;
-  isConferenceCall?: boolean;
-  conferenceRole?: ConferenceRole;
-  redirectedCall?: boolean;
-  /** Present only on redirected calls: what the dialled leg did. */
-  redirectCallLog?: RedirectCallLog;
-  toolExecutions?: ToolExecution[];
-  transcriptionComparison?: Record<string, TranscriptionSegment[]>;
-  /** The AI provider's id for the call, if it has one */
-  aiProviderConversationId?: string;
-};
-
-/**
- * The outcome of the <Dial> that transferred a call, reported by Twilio when the
- * dialled leg ends. `durationSeconds` is the bridged time, which is 0 when the
- * destination never answered.
- */
-export type RedirectCallLog = {
-  childCallSid?: string;
-  to?: string;
-  status: CallStatus;
-  durationSeconds: number;
-  endedAt: Date;
-};
-
-export type ToolExecution = {
-  toolName: string;
-  executedAt: Date;
-  durationMs: number;
-  args: Record<string, unknown> | { _redacted: true };
-  meta: ToolExecutionMeta;
-  status: "success" | "error";
-  httpStatus?: number;
-  response?: Record<string, unknown>;
-  steps?: ToolExecutionStep[];
-};
-
-export type ToolExecutionStepLevel = "info" | "warn" | "error";
-
-export type ToolExecutionStep = {
-  timestamp: Date;
-  label: string;
-  level: ToolExecutionStepLevel;
-  data?: Record<string, unknown> | string;
-  payload?: Record<string, unknown>;
-};
-
-export type ToolExecutionMeta =
-  | {
-      kind: "http";
-      url: string;
-      method: string;
-      flowToolId?: string;
-      runInBackground?: boolean;
-      sensitive?: boolean;
-    }
-  | { kind: "internal" };
-
-export type CallQueryOptions = {
-  sort?: Sort;
-  skip?: number;
-  limit?: number;
-};
-
-export type CallsFilterParams = {
-  clientId: string;
-  callSid?: string;
-  startDate?: Date;
-  endDate?: Date;
-  status?: CallStatus;
-  customerPhoneNumber?: string;
-  agentPhoneNumber?: string;
-  flowId?: string;
-  runId?: string;
-  sessionId?: string;
-  isIncoming?: boolean;
-  search?: string;
-};
-
-export type ImmutableCallFields =
-  | "customerPhoneNumber"
-  | "agentPhoneNumber"
-  | "isIncomingCall"
-  | "isOutgoingCall"
-  | "sessionId"
-  | "callSid"
-  | "flowId"
-  | "clientId"
-  | "runId"
-  | "resultId"
-  | "env"
-  | "createdAt";
-
-export type CallUpdateParams = Partial<Omit<Call, ImmutableCallFields>>;
-
-export type CallDoc = WithId<Call>;
-
-/** @deprecated use DashboardHeatmapMetric instead */
-export type CallsByHour = { hour: number; calls: number };
-
-export type CountOpts = {
-  isOutgoingCall?: boolean;
-  isIncomingCall?: boolean;
-};
-
-export type DateRange = {
-  since?: Date;
-  until?: Date;
-};
+import { ObjectId, Sort, WithId } from "mongodb";
+import { TranscriptionSegment } from "../results";
+import { LeadProperty } from "../leads";
+
+import {
+  CallStatusValues,
+  CONFERENCE_ROLE_CUSTOMER,
+  CONFERENCE_ROLE_SUPERVISOR,
+} from "./calls.constants";
+
+export type ConferenceRole =
+  | typeof CONFERENCE_ROLE_CUSTOMER
+  | typeof CONFERENCE_ROLE_SUPERVISOR
+  | null;
+
+export type CallStatus = (typeof CallStatusValues)[keyof typeof CallStatusValues];
+
+/**
+ * Represents the call usage information with details about charging segments and quota impact.
+ */
+export type CallUsage = {
+  /** Length in minutes of a segment the call is charged by. */
+  minutesPerSegment: number;
+  /** Segments the call adds to the customer's quota. */
+  segments: number;
+};
+
+export type Call = {
+  callSid: string;
+  flowId: ObjectId;
+  clientId: string;
+  sessionId: ObjectId | null;
+  runId?: string;
+  resultId: ObjectId;
+  customerPhoneNumber: string;
+  agentPhoneNumber: string;
+  isIncomingCall: boolean;
+  isOutgoingCall: boolean;
+  callLength: number;
+  usage?: CallUsage;
+  transcription?: TranscriptionSegment[];
+  status?: CallStatus;
+  leads?: LeadProperty[];
+  summary?: string;
+  recordingUrl?: string;
+  env: string;
+  updatedAt: Date;
+  createdAt: Date;
+  isAnsweredByAnsweringMachine?: boolean;
+  agentHungUp?: boolean;
+  endReason?: string;
+  conferenceName?: string | null;
+  conferenceSid?: string | null;
+  conferenceParticipantSid?: string | null;
+  isConferenceCall?: boolean;
+  conferenceRole?: ConferenceRole;
+  redirectedCall?: boolean;
+  /** Present only on redirected calls: what the dialled leg did. */
+  redirectCallLog?: RedirectCallLog;
+  toolExecutions?: ToolExecution[];
+  transcriptionComparison?: Record<string, TranscriptionSegment[]>;
+  /** The AI provider's id for the call, if it has one */
+  aiProviderConversationId?: string;
+};
+
+/**
+ * The outcome of the <Dial> that transferred a call, reported by Twilio when the
+ * dialled leg ends. `durationSeconds` is the bridged time, which is 0 when the
+ * destination never answered.
+ */
+export type RedirectCallLog = {
+  childCallSid?: string;
+  to?: string;
+  status: CallStatus;
+  durationSeconds: number;
+  endedAt: Date;
+};
+
+export type ToolExecution = {
+  toolName: string;
+  executedAt: Date;
+  durationMs: number;
+  args: Record<string, unknown> | { _redacted: true };
+  meta: ToolExecutionMeta;
+  status: "success" | "error";
+  httpStatus?: number;
+  response?: Record<string, unknown>;
+  steps?: ToolExecutionStep[];
+};
+
+export type ToolExecutionStepLevel = "info" | "warn" | "error";
+
+export type ToolExecutionStep = {
+  timestamp: Date;
+  label: string;
+  level: ToolExecutionStepLevel;
+  data?: Record<string, unknown> | string;
+  payload?: Record<string, unknown>;
+};
+
+export type ToolExecutionMeta =
+  | {
+      kind: "http";
+      url: string;
+      method: string;
+      flowToolId?: string;
+      runInBackground?: boolean;
+      sensitive?: boolean;
+    }
+  | { kind: "internal" };
+
+export type CallQueryOptions = {
+  sort?: Sort;
+  skip?: number;
+  limit?: number;
+};
+
+export type CallsFilterParams = {
+  clientId: string;
+  callSid?: string;
+  startDate?: Date;
+  endDate?: Date;
+  status?: CallStatus;
+  customerPhoneNumber?: string;
+  agentPhoneNumber?: string;
+  flowId?: string;
+  runId?: string;
+  sessionId?: string;
+  isIncoming?: boolean;
+  billableCallsFrom?: number;
+  billableCallsTo?: number;
+  search?: string;
+};
+
+export type ImmutableCallFields =
+  | "customerPhoneNumber"
+  | "agentPhoneNumber"
+  | "isIncomingCall"
+  | "isOutgoingCall"
+  | "sessionId"
+  | "callSid"
+  | "flowId"
+  | "clientId"
+  | "runId"
+  | "resultId"
+  | "env"
+  | "createdAt";
+
+export type CallUpdateParams = Partial<Omit<Call, ImmutableCallFields>>;
+
+export type CallDoc = WithId<Call>;
+
+/** @deprecated use DashboardHeatmapMetric instead */
+export type CallsByHour = { hour: number; calls: number };
+
+export type CountOpts = {
+  isOutgoingCall?: boolean;
+  isIncomingCall?: boolean;
+};
+
+export type DateRange = {
+  since?: Date;
+  until?: Date;
+};