@routeflow/types 1.0.5 → 1.0.7

package/package.json

@@ -1 +1 @@
-{"name":"@routeflow/types","version":"1.0.5","description":"Auto-generated TypeScript types from the RouteFlow API OpenAPI specification","main":"dist/exports.js","types":"dist/exports.d.ts","exports":{".":{"types":"./dist/exports.d.ts","default":"./dist/exports.js"},"./raw":{"types":"./dist/index.d.ts","default":"./dist/index.js"}},"files":["dist","src"],"scripts":{"generate":"openapi-typescript http://localhost:3001/api/docs-json -o src/index.ts","generate:prod":"openapi-typescript https://api.routeflow.app/api/docs-json -o src/index.ts","build":"tsc","type-check":"tsc --noEmit","prepublishOnly":"npm run build"},"repository":{"type":"git","url":"git+https://github.com/souldevsoul/routeflow-types.git"},"keywords":["routeflow","api","types","typescript","openapi"],"author":"S2S Engineering","license":"MIT","devDependencies":{"openapi-typescript":"^7.4.3","typescript":"^5.7.2"},"publishConfig":{"access":"public"}}
+{"name":"@routeflow/types","version":"1.0.7","description":"Auto-generated TypeScript types from the RouteFlow API OpenAPI specification","main":"dist/exports.js","types":"dist/exports.d.ts","exports":{".":{"types":"./dist/exports.d.ts","default":"./dist/exports.js"},"./raw":{"types":"./dist/index.d.ts","default":"./dist/index.js"}},"files":["dist","src"],"scripts":{"generate":"openapi-typescript http://localhost:3001/api/docs-json -o src/index.ts","generate:prod":"openapi-typescript https://api.routeflow.app/api/docs-json -o src/index.ts","build":"tsc","type-check":"tsc --noEmit","prepublishOnly":"npm run build"},"repository":{"type":"git","url":"git+https://github.com/souldevsoul/routeflow-types.git"},"keywords":["routeflow","api","types","typescript","openapi"],"author":"S2S Engineering","license":"MIT","devDependencies":{"openapi-typescript":"^7.4.3","typescript":"^5.7.2"},"publishConfig":{"access":"public"}}

package/src/exports.ts

@@ -83,7 +83,13 @@ export type DriverDispatchStatus =
 
 export type CustomerType = 'BROKER' | 'SHIPPER' | 'CARRIER';
 
-export type StatementStatus = 'DRAFT' | 'PENDING' | 'APPROVED' | 'PAID';
+// New Driver Profile Enums
+export type EmploymentStatus = 'ACTIVE' | 'TERMINATED' | 'APPLICANT';
+export type CdlClass = 'A' | 'B' | 'C';
+export type ComplianceStatus = 'COMPLIANT' | 'WARNING' | 'EXPIRED' | 'PENDING';
+export type DriverType = 'SOLO' | 'TEAM';
+
+// export type StatementStatus = 'DRAFT' | 'PENDING' | 'APPROVED' | 'PAID';
 
 export type MessageType = 'TEXT' | 'IMAGE' | 'DOCUMENT' | 'SYSTEM';
 
@@ -93,6 +99,32 @@ export type ExtractedAssetType = 'DRIVER' | 'TRUCK' | 'TRAILER';
 
 export type ExtractedAssetStatus = 'PENDING' | 'APPROVED' | 'REJECTED' | 'MERGED';
 
+// Email-to-Run Feature Enums
+export type InboundEmailStatus =
+  | 'RECEIVED'
+  | 'PROCESSING'
+  | 'AWAITING_SIGNATURE'
+  | 'SIGNED'
+  | 'FORWARDED'
+  | 'COMPLETED'
+  | 'FAILED';
+
+export type DocumentSourceType = 'UPLOAD' | 'TELEGRAM' | 'EMAIL' | 'API';
+
+export type ExpenseType =
+  | 'FUEL'
+  | 'REPAIR'
+  | 'MAINTENANCE'
+  | 'TOLL'
+  | 'PARKING'
+  | 'SCALE'
+  | 'LUMPER'
+  | 'DETENTION'
+  | 'INSURANCE'
+  | 'OTHER';
+
+export type ExpenseStatus = 'PENDING' | 'APPROVED' | 'REJECTED' | 'PAID';
+
 // ============================================================================
 // ENTITY TYPES - WITH Response DTOs (✅ Re-exported from generated types)
 // ============================================================================
@@ -106,8 +138,8 @@ export type Message = components['schemas']['MessageResponseDto'];
 export type MessageList = components['schemas']['MessageListResponseDto'];
 
 // Statement (has ResponseDto in API)
-export type DriverStatement = components['schemas']['StatementResponseDto'];
-export type StatementList = components['schemas']['StatementListResponseDto'];
+// export type DriverStatement = components['schemas']['StatementResponseDto'];
+// export type StatementList = components['schemas']['StatementListResponseDto'];
 
 // Referral (has ResponseDto in API)
 export type Referral = components['schemas']['ReferralResponseDto'];
@@ -167,6 +199,51 @@ export interface Driver {
   createdAt: string;
   updatedAt: string;
   user?: User;
+
+  // Address
+  streetAddress?: string | null;
+  city?: string | null;
+  state?: string | null;
+  zipCode?: string | null;
+  country?: string | null;
+
+  // Emergency Contact
+  emergencyName?: string | null;
+  emergencyPhone?: string | null;
+
+  // Employment
+  employmentStatus?: EmploymentStatus;
+  hireDate?: string | null;
+  terminationDate?: string | null;
+
+  // Compliance - CDL
+  cdlNumber?: string | null;
+  cdlState?: string | null;
+  cdlClass?: CdlClass | null;
+  cdlExpiry?: string | null;
+  cdlEndorsements?: string[];
+
+  // Compliance - Medical
+  medicalCardNumber?: string | null;
+  medicalCardExpiry?: string | null;
+  medicalExamDate?: string | null;
+  medicalExaminer?: string | null;
+
+  // Computed compliance status
+  complianceStatus?: ComplianceStatus;
+  complianceNotes?: string | null;
+
+  // Team driver
+  teamDriverId?: string | null;
+  teamDriver?: Driver | null;
+  teamPartner?: Driver | null;
+  isTeamLead?: boolean;
+  teamStartDate?: string | null;
+  driverType?: DriverType;
+
+  // Dispatcher
+  assignedDispatcherId?: string | null;
+  assignedDispatcher?: User | null;
 }
 
 export interface Run {
@@ -339,20 +416,171 @@ export interface ParsedDocument {
   orgId: string;
   createdAt: string;
   updatedAt: string;
+  // Signing workflow fields
+  needsSignature: boolean;
+  signatureData: string | null;
+  signedAt: string | null;
+  signedByName: string | null;
+  signedByEmail: string | null;
+  signingToken: string | null;
+  signingTokenExp: string | null;
+  sourceType: DocumentSourceType;
+  sourceEmailId: string | null;
+}
+
+// ============================================================================
+// EMAIL-TO-RUN FEATURE ENTITIES
+// ============================================================================
+
+export interface UserSignature {
+  id: string;
+  signatureData: string;
+  userId: string;
+  createdAt: string;
+  updatedAt: string;
+}
+
+export interface ClientEmail {
+  id: string;
+  localPart: string;
+  isActive: boolean;
+  forwardTo: string[];
+  orgId: string;
+  customerId: string | null;
+  createdAt: string;
+  updatedAt: string;
+  // Extended response fields
+  fullEmail?: string;
+  customerName?: string;
+  emailCount?: number;
+  lastEmailAt?: string | null;
 }
 
-export interface StatementLineItem {
-  description: string;
-  type: 'EARNING' | 'DEDUCTION';
+export interface InboundEmail {
+  id: string;
+  messageId: string;
+  fromEmail: string;
+  fromName: string | null;
+  subject: string | null;
+  textBody: string | null;
+  htmlBody: string | null;
+  receivedAt: string;
+  processedAt: string | null;
+  status: InboundEmailStatus;
+  errorMessage: string | null;
+  clientEmailId: string;
+  attachments?: EmailAttachment[];
+  clientEmailLocalPart?: string;
+}
+
+export interface EmailAttachment {
+  id: string;
+  fileName: string;
+  mimeType: string;
+  fileSize: number;
+  fileUrl: string;
+  inboundEmailId: string;
+  parsedDocumentId: string | null;
+}
+
+export interface Expense {
+  id: string;
+  type: ExpenseType;
   amount: number;
+  description: string | null;
+  date: string;
+  vendor: string | null;
+  receiptUrl: string | null;
+  status: ExpenseStatus;
+  aiConfidence: number | null;
+  aiMatchNotes: string | null;
+  sourceEmailId: string | null;
+  approvedById: string | null;
+  approvedAt: string | null;
+  rejectedById: string | null;
+  rejectedAt: string | null;
+  rejectionReason: string | null;
+  orgId: string;
+  runId: string | null;
+  driverId: string | null;
+  truckId: string | null;
+  trailerId: string | null;
+  createdAt: string;
+  updatedAt: string;
+  // Extended response fields
+  driverName?: string;
+  truckNumber?: string;
+  trailerNumber?: string;
+  runName?: string;
+  aiSuggestion?: ExpenseAISuggestion;
+}
+
+export interface ExpenseAISuggestion {
+  driverId?: string;
+  driverName?: string;
+  truckId?: string;
+  truckNumber?: string;
+  trailerId?: string;
+  trailerNumber?: string;
   runId?: string;
+  runName?: string;
+  confidence: number;
+}
+
+export interface ExpenseStats {
+  totalPending: number;
+  totalApproved: number;
+  pendingAmount: number;
+  approvedAmount: number;
+  byType: Record<ExpenseType, number>;
+}
+
+// Document signing response
+export interface DocumentToSign {
+  id: string;
+  documentUrl: string;
+  fileName: string | null;
+  mimeType: string | null;
+  isSigned: boolean;
+  signedAt: string | null;
+  isExpired: boolean;
+  expiresAt: string | null;
+  // Parsed data
+  brokerName?: string;
   loadNumber?: string;
+  rate?: number;
+  pickupLocation?: string;
+  deliveryLocation?: string;
+  pickupDate?: string;
+  deliveryDate?: string;
+  equipmentType?: string;
+  commodity?: string;
+  weight?: number;
+  organizationName: string;
+  hasSavedSignature?: boolean;
+  savedSignaturePreview?: string;
 }
 
-// ============================================================================
-// AUTH RESPONSE TYPES
-// ============================================================================
+export interface SignDocumentResponse {
+  success: boolean;
+  message: string;
+  createdRunId?: string;
+  forwarded?: boolean;
+  forwardedTo?: string[];
+}
 
+// export interface StatementLineItem {
+//   description: string;
+//   type: 'EARNING' | 'DEDUCTION';
+//   amount: number;
+//   runId?: string;
+//   loadNumber?: string;
+// }
+// 
+// // ============================================================================
+// // AUTH RESPONSE TYPES
+// // ============================================================================
+// 
 export interface AuthResponse {
   accessToken: string;
   refreshToken: string;
@@ -467,9 +695,9 @@ export type CreateMessageDto = components['schemas']['CreateMessageDto'];
 export type MarkReadDto = components['schemas']['MarkReadDto'];
 
 // Statement DTOs
-export type CreateStatementDto = components['schemas']['CreateStatementDto'];
-export type UpdateStatementDto = components['schemas']['UpdateStatementDto'];
-export type GenerateStatementDto = components['schemas']['GenerateStatementDto'];
+// export type CreateStatementDto = components['schemas']['CreateStatementDto'];
+// export type UpdateStatementDto = components['schemas']['UpdateStatementDto'];
+// export type GenerateStatementDto = components['schemas']['GenerateStatementDto'];
 
 // Referral DTOs
 export type CreateReferralDto = components['schemas']['CreateReferralDto'];
@@ -484,6 +712,134 @@ export type MergeExtractionDto = components['schemas']['MergeExtractionDto'];
 export type BulkApproveDto = components['schemas']['BulkApproveDto'];
 export type BulkRejectDto = components['schemas']['BulkRejectDto'];
 
+// Driver Management DTOs (new)
+export type UpdateDriverDto = components['schemas']['UpdateDriverDto'];
+export type UpdateComplianceDto = components['schemas']['UpdateComplianceDto'];
+export type AssignDispatcherDto = components['schemas']['AssignDispatcherDto'];
+export type LinkTeamDriverDto = components['schemas']['LinkTeamDriverDto'];
+export type ReactivateRunDto = components['schemas']['ReactivateRunDto'];
+export type CancelRunDto = components['schemas']['CancelRunDto'];
+
+// Compliance Warning Response
+export interface ComplianceWarning {
+  driverId: string;
+  driverName: string;
+  type: 'CDL' | 'MEDICAL';
+  expiryDate: string;
+  daysUntilExpiry: number;
+  status: ComplianceStatus;
+}
+
+// Dispatcher Assignment History
+export interface DispatcherAssignmentHistory {
+  id: string;
+  driverId: string;
+  dispatcherId: string | null;
+  dispatcher?: User | null;
+  assignedById: string;
+  assignedBy?: User;
+  reason?: string | null;
+  createdAt: string;
+}
+
+// ============================================================================
+// EMAIL-TO-RUN REQUEST DTOs (manual until OpenAPI regeneration)
+// ============================================================================
+
+// Signature DTOs
+export interface SaveSignatureRequest {
+  signatureData: string;
+}
+
+// Client Email DTOs
+export interface CreateClientEmailRequest {
+  localPart: string;
+  customerId?: string;
+  forwardTo?: string[];
+}
+
+export interface UpdateClientEmailRequest {
+  localPart?: string;
+  customerId?: string;
+  forwardTo?: string[];
+  isActive?: boolean;
+}
+
+export interface SendInvitationRequest {
+  recipientEmail: string;
+  customMessage?: string;
+}
+
+// Expense DTOs
+export interface CreateExpenseRequest {
+  type: ExpenseType;
+  amount: number;
+  description?: string;
+  date: string;
+  vendor?: string;
+  receiptUrl?: string;
+  driverId?: string;
+  truckId?: string;
+  trailerId?: string;
+  runId?: string;
+}
+
+export interface UpdateExpenseRequest {
+  type?: ExpenseType;
+  amount?: number;
+  description?: string;
+  date?: string;
+  vendor?: string;
+  receiptUrl?: string;
+  driverId?: string;
+  truckId?: string;
+  trailerId?: string;
+  runId?: string;
+}
+
+export interface AssociateExpenseRequest {
+  driverId?: string;
+  truckId?: string;
+  trailerId?: string;
+  runId?: string;
+}
+
+export interface RejectExpenseRequest {
+  reason: string;
+}
+
+export interface ExpenseFilters {
+  type?: ExpenseType;
+  status?: ExpenseStatus;
+  driverId?: string;
+  truckId?: string;
+  runId?: string;
+  fromDate?: string;
+  toDate?: string;
+  search?: string;
+  page?: number;
+  limit?: number;
+}
+
+// Signing DTOs
+export interface SignDocumentRequest {
+  signatureData: string;
+  signedByName?: string;
+  signedByEmail?: string;
+  useSavedSignature?: boolean;
+}
+
+// Inbound Email Filters
+export interface InboundEmailFilters {
+  status?: InboundEmailStatus;
+  clientEmailId?: string;
+  fromDate?: string;
+  toDate?: string;
+  search?: string;
+  page?: number;
+  limit?: number;
+}
+
 // ============================================================================
 // REQUEST TYPE ALIASES (for SDK compatibility)
 // ============================================================================
@@ -504,8 +860,8 @@ export type UpdateCustomerRequest = UpdateCustomerDto;
 
 export type CreateMessageRequest = CreateMessageDto;
 
-export type CreateStatementRequest = CreateStatementDto;
-export type UpdateStatementRequest = UpdateStatementDto;
+// export type CreateStatementRequest = CreateStatementDto;
+// export type UpdateStatementRequest = UpdateStatementDto;
 
 export type CreateReferralRequest = CreateReferralDto;
 export type UpdateReferralRequest = UpdateReferralDto;
@@ -532,8 +888,31 @@ export type PaginatedDrivers = PaginatedResponse<User>;
 export type PaginatedTrucks = PaginatedResponse<Truck>;
 export type PaginatedTrailers = PaginatedResponse<Trailer>;
 export type PaginatedCustomers = PaginatedResponse<Customer>;
-export type PaginatedStatements = PaginatedResponse<DriverStatement>;
+// export type PaginatedStatements = PaginatedResponse<DriverStatement>;
 export type PaginatedMessages = PaginatedResponse<Message>;
+export type PaginatedExpenses = PaginatedResponse<Expense>;
+export type PaginatedInboundEmails = PaginatedResponse<InboundEmail>;
+
+// List response types for Email-to-Run feature
+export interface ClientEmailListResponse {
+  data: ClientEmail[];
+  total: number;
+}
+
+export interface InboundEmailListResponse {
+  data: InboundEmail[];
+  total: number;
+  page: number;
+  limit: number;
+}
+
+export interface ExpenseListResponse {
+  data: Expense[];
+  total: number;
+  page: number;
+  limit: number;
+  pendingCount?: number;
+}
 
 // ============================================================================
 // TYPE HELPERS