@routeflow/types 1.0.19 → 1.0.21

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1 +1 @@
1
- {"name":"@routeflow/types","version":"1.0.19","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"}}
1
+ {"name":"@routeflow/types","version":"1.0.21","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 CHANGED
@@ -364,6 +364,14 @@ export interface TelegramSessionData {
364
364
  // Email-to-Run session data
365
365
  pendingSignDocumentToken?: string;
366
366
  awaitingSignature?: boolean;
367
+ // Fee reporting session data
368
+ pendingFee?: {
369
+ runId: string;
370
+ feeType: string;
371
+ step: 'amount' | 'description';
372
+ amount?: number;
373
+ description?: string;
374
+ };
367
375
  }
368
376
 
369
377
  // Notification payloads for Email-to-Run Telegram notifications
package/src/index.ts CHANGED
@@ -225,6 +225,40 @@ export interface paths {
225
225
  patch?: never;
226
226
  trace?: never;
227
227
  };
228
+ "/api/auth/e2e/verification-code": {
229
+ parameters: {
230
+ query?: never;
231
+ header?: never;
232
+ path?: never;
233
+ cookie?: never;
234
+ };
235
+ /** [E2E Test] Get verification code for email */
236
+ get: operations["AuthController_getVerificationCodeForE2E"];
237
+ put?: never;
238
+ post?: never;
239
+ delete?: never;
240
+ options?: never;
241
+ head?: never;
242
+ patch?: never;
243
+ trace?: never;
244
+ };
245
+ "/api/auth/e2e/user": {
246
+ parameters: {
247
+ query?: never;
248
+ header?: never;
249
+ path?: never;
250
+ cookie?: never;
251
+ };
252
+ get?: never;
253
+ put?: never;
254
+ post?: never;
255
+ /** [E2E Test] Delete test user and their organization */
256
+ delete: operations["AuthController_deleteUserForE2E"];
257
+ options?: never;
258
+ head?: never;
259
+ patch?: never;
260
+ trace?: never;
261
+ };
228
262
  "/api/users": {
229
263
  parameters: {
230
264
  query?: never;
@@ -932,6 +966,23 @@ export interface paths {
932
966
  patch?: never;
933
967
  trace?: never;
934
968
  };
969
+ "/api/runs/{id}/stops/{stopId}/revert": {
970
+ parameters: {
971
+ query?: never;
972
+ header?: never;
973
+ path?: never;
974
+ cookie?: never;
975
+ };
976
+ get?: never;
977
+ put?: never;
978
+ /** Revert stop status to previous status (undo) */
979
+ post: operations["RunsController_revertStopStatus"];
980
+ delete?: never;
981
+ options?: never;
982
+ head?: never;
983
+ patch?: never;
984
+ trace?: never;
985
+ };
935
986
  "/api/runs/{id}/geocode-stops": {
936
987
  parameters: {
937
988
  query?: never;
@@ -2952,6 +3003,23 @@ export interface paths {
2952
3003
  patch?: never;
2953
3004
  trace?: never;
2954
3005
  };
3006
+ "/api/search": {
3007
+ parameters: {
3008
+ query?: never;
3009
+ header?: never;
3010
+ path?: never;
3011
+ cookie?: never;
3012
+ };
3013
+ /** Global search across runs, drivers, trucks, trailers, and customers */
3014
+ get: operations["SearchController_search"];
3015
+ put?: never;
3016
+ post?: never;
3017
+ delete?: never;
3018
+ options?: never;
3019
+ head?: never;
3020
+ patch?: never;
3021
+ trace?: never;
3022
+ };
2955
3023
  }
2956
3024
  export type webhooks = Record<string, never>;
2957
3025
  export interface components {
@@ -3510,6 +3578,16 @@ export interface components {
3510
3578
  * @example uuid
3511
3579
  */
3512
3580
  commissionUserId?: string;
3581
+ /**
3582
+ * @description Empty miles from driver location to first pickup
3583
+ * @example 150
3584
+ */
3585
+ emptyMiles?: number;
3586
+ /**
3587
+ * @description Starting location for empty miles calculation
3588
+ * @example Chicago, IL
3589
+ */
3590
+ emptyMilesLocation?: string;
3513
3591
  };
3514
3592
  AssignDriverDto: {
3515
3593
  /** @example clxxx... */
@@ -3657,7 +3735,7 @@ export interface components {
3657
3735
  * @example ARRIVED
3658
3736
  * @enum {string}
3659
3737
  */
3660
- status: "PENDING" | "EN_ROUTE" | "ARRIVED" | "LOADING" | "LOADED" | "DELIVERING" | "DELIVERED" | "EXCEPTION" | "SKIPPED";
3738
+ status: "PENDING" | "EN_ROUTE" | "ARRIVED" | "LOADING" | "LOADED" | "DELIVERING" | "DELIVERED" | "EXCEPTION" | "SKIPPED" | "CANCELLED";
3661
3739
  /** @example 40.7128 */
3662
3740
  lat?: number;
3663
3741
  /** @example -74.006 */
@@ -3665,6 +3743,10 @@ export interface components {
3665
3743
  /** @example Customer not available, left at door */
3666
3744
  notes?: string;
3667
3745
  };
3746
+ RevertStopStatusDto: {
3747
+ /** @example Driver marked arrived by mistake */
3748
+ reason?: string;
3749
+ };
3668
3750
  RunChargeCreatedByDto: {
3669
3751
  id: string;
3670
3752
  name: string;
@@ -4219,6 +4301,52 @@ export interface components {
4219
4301
  lastServiceDate?: string;
4220
4302
  /** @example New tires installed */
4221
4303
  notes?: string;
4304
+ /**
4305
+ * @description License plate state
4306
+ * @example TX
4307
+ */
4308
+ licenseState?: string;
4309
+ /**
4310
+ * @description Truck color
4311
+ * @example White
4312
+ */
4313
+ color?: string;
4314
+ /**
4315
+ * @description Registration expiry date
4316
+ * @example 2025-12-31
4317
+ */
4318
+ registrationExpiry?: string;
4319
+ /**
4320
+ * @description URL to registration document
4321
+ * @example https://storage.example.com/registration.pdf
4322
+ */
4323
+ registrationFileUrl?: string;
4324
+ /**
4325
+ * @description Annual inspection expiry date
4326
+ * @example 2025-06-30
4327
+ */
4328
+ annualInspectionExpiry?: string;
4329
+ /**
4330
+ * @description URL to annual inspection document
4331
+ * @example https://storage.example.com/inspection.pdf
4332
+ */
4333
+ annualInspectionFileUrl?: string;
4334
+ /**
4335
+ * @description Fleet status
4336
+ * @example AVAILABLE
4337
+ * @enum {string}
4338
+ */
4339
+ fleetStatus?: "AVAILABLE" | "UNASSIGNED" | "SHOP" | "SOLD";
4340
+ /**
4341
+ * @description Ownership type
4342
+ * @example COMPANY
4343
+ * @enum {string}
4344
+ */
4345
+ ownershipType?: "COMPANY" | "OWNER_OPERATOR";
4346
+ /** @description Owner ID for owner operator trucks */
4347
+ ownerId?: string;
4348
+ /** @description Notes about ownership */
4349
+ ownerNotes?: string;
4222
4350
  };
4223
4351
  TruckListResponseDto: {
4224
4352
  items: components["schemas"]["TruckResponseDto"][];
@@ -4258,6 +4386,52 @@ export interface components {
4258
4386
  lastServiceDate?: string;
4259
4387
  /** @example New tires installed */
4260
4388
  notes?: string;
4389
+ /**
4390
+ * @description License plate state
4391
+ * @example TX
4392
+ */
4393
+ licenseState?: string;
4394
+ /**
4395
+ * @description Truck color
4396
+ * @example White
4397
+ */
4398
+ color?: string;
4399
+ /**
4400
+ * @description Registration expiry date
4401
+ * @example 2025-12-31
4402
+ */
4403
+ registrationExpiry?: string;
4404
+ /**
4405
+ * @description URL to registration document
4406
+ * @example https://storage.example.com/registration.pdf
4407
+ */
4408
+ registrationFileUrl?: string;
4409
+ /**
4410
+ * @description Annual inspection expiry date
4411
+ * @example 2025-06-30
4412
+ */
4413
+ annualInspectionExpiry?: string;
4414
+ /**
4415
+ * @description URL to annual inspection document
4416
+ * @example https://storage.example.com/inspection.pdf
4417
+ */
4418
+ annualInspectionFileUrl?: string;
4419
+ /**
4420
+ * @description Fleet status
4421
+ * @example AVAILABLE
4422
+ * @enum {string}
4423
+ */
4424
+ fleetStatus?: "AVAILABLE" | "UNASSIGNED" | "SHOP" | "SOLD";
4425
+ /**
4426
+ * @description Ownership type
4427
+ * @example COMPANY
4428
+ * @enum {string}
4429
+ */
4430
+ ownershipType?: "COMPANY" | "OWNER_OPERATOR";
4431
+ /** @description Owner ID for owner operator trucks */
4432
+ ownerId?: string;
4433
+ /** @description Notes about ownership */
4434
+ ownerNotes?: string;
4261
4435
  };
4262
4436
  AssignAssetDto: {
4263
4437
  /** @example driver-cuid-123 */
@@ -4290,6 +4464,42 @@ export interface components {
4290
4464
  lastInspectionDate?: string;
4291
4465
  /** @example New brakes installed */
4292
4466
  notes?: string;
4467
+ /**
4468
+ * @description License plate state
4469
+ * @example TX
4470
+ */
4471
+ licenseState?: string;
4472
+ /**
4473
+ * @description URL to registration document
4474
+ * @example https://storage.example.com/registration.pdf
4475
+ */
4476
+ registrationFileUrl?: string;
4477
+ /**
4478
+ * @description Annual inspection expiry date
4479
+ * @example 2025-06-30
4480
+ */
4481
+ annualInspectionExpiry?: string;
4482
+ /**
4483
+ * @description URL to annual inspection document
4484
+ * @example https://storage.example.com/inspection.pdf
4485
+ */
4486
+ annualInspectionFileUrl?: string;
4487
+ /**
4488
+ * @description Fleet status
4489
+ * @example AVAILABLE
4490
+ * @enum {string}
4491
+ */
4492
+ fleetStatus?: "AVAILABLE" | "UNASSIGNED" | "SHOP" | "SOLD";
4493
+ /**
4494
+ * @description Ownership type
4495
+ * @example COMPANY
4496
+ * @enum {string}
4497
+ */
4498
+ ownershipType?: "COMPANY" | "OWNER_OPERATOR";
4499
+ /** @description Owner ID for owner operator trailers */
4500
+ ownerId?: string;
4501
+ /** @description Notes about ownership */
4502
+ ownerNotes?: string;
4293
4503
  };
4294
4504
  TrailerListResponseDto: {
4295
4505
  items: components["schemas"]["TrailerResponseDto"][];
@@ -4325,6 +4535,42 @@ export interface components {
4325
4535
  lastInspectionDate?: string;
4326
4536
  /** @example New brakes installed */
4327
4537
  notes?: string;
4538
+ /**
4539
+ * @description License plate state
4540
+ * @example TX
4541
+ */
4542
+ licenseState?: string;
4543
+ /**
4544
+ * @description URL to registration document
4545
+ * @example https://storage.example.com/registration.pdf
4546
+ */
4547
+ registrationFileUrl?: string;
4548
+ /**
4549
+ * @description Annual inspection expiry date
4550
+ * @example 2025-06-30
4551
+ */
4552
+ annualInspectionExpiry?: string;
4553
+ /**
4554
+ * @description URL to annual inspection document
4555
+ * @example https://storage.example.com/inspection.pdf
4556
+ */
4557
+ annualInspectionFileUrl?: string;
4558
+ /**
4559
+ * @description Fleet status
4560
+ * @example AVAILABLE
4561
+ * @enum {string}
4562
+ */
4563
+ fleetStatus?: "AVAILABLE" | "UNASSIGNED" | "SHOP" | "SOLD";
4564
+ /**
4565
+ * @description Ownership type
4566
+ * @example COMPANY
4567
+ * @enum {string}
4568
+ */
4569
+ ownershipType?: "COMPANY" | "OWNER_OPERATOR";
4570
+ /** @description Owner ID for owner operator trailers */
4571
+ ownerId?: string;
4572
+ /** @description Notes about ownership */
4573
+ ownerNotes?: string;
4328
4574
  };
4329
4575
  AssignedRunSummaryResponseDto: {
4330
4576
  id: string;
@@ -4637,6 +4883,31 @@ export interface components {
4637
4883
  messages: components["schemas"]["ChatHistoryMessageDto"][];
4638
4884
  sessionId?: string;
4639
4885
  };
4886
+ CustomerContactDto: {
4887
+ /** @description Contact ID (for updates) */
4888
+ id?: string;
4889
+ /** @example John Smith */
4890
+ name: string;
4891
+ /**
4892
+ * Format: email
4893
+ * @example john@example.com
4894
+ */
4895
+ email?: string;
4896
+ /** @example +1-555-123-4567 */
4897
+ phone?: string;
4898
+ /**
4899
+ * @description Role/department of the contact
4900
+ * @example Dispatch
4901
+ */
4902
+ role?: string;
4903
+ /**
4904
+ * @description Whether this is the primary contact
4905
+ * @example true
4906
+ */
4907
+ isPrimary?: boolean;
4908
+ /** @description Notes about this contact */
4909
+ notes?: string;
4910
+ };
4640
4911
  CreateCustomerDto: {
4641
4912
  /**
4642
4913
  * @default BROKER
@@ -4669,6 +4940,8 @@ export interface components {
4669
4940
  /** @example US */
4670
4941
  country?: string;
4671
4942
  notes?: string;
4943
+ /** @description Array of contacts for this customer */
4944
+ contacts?: components["schemas"]["CustomerContactDto"][];
4672
4945
  };
4673
4946
  CustomerResponseDto: {
4674
4947
  id: string;
@@ -4736,6 +5009,8 @@ export interface components {
4736
5009
  /** @example US */
4737
5010
  country?: string;
4738
5011
  notes?: string;
5012
+ /** @description Array of contacts for this customer */
5013
+ contacts?: components["schemas"]["CustomerContactDto"][];
4739
5014
  isActive?: boolean;
4740
5015
  };
4741
5016
  CreateMessageDto: {
@@ -4987,6 +5262,8 @@ export interface components {
4987
5262
  truckId?: string;
4988
5263
  trailerId?: string;
4989
5264
  runId?: string;
5265
+ /** @description Stop ID for stop-specific fees (lumper, escort, etc.) */
5266
+ stopId?: string;
4990
5267
  };
4991
5268
  ExpenseResponseDto: {
4992
5269
  id: string;
@@ -5059,6 +5336,8 @@ export interface components {
5059
5336
  truckId?: string;
5060
5337
  trailerId?: string;
5061
5338
  runId?: string;
5339
+ /** @description Stop ID for stop-specific fees (lumper, escort, etc.) */
5340
+ stopId?: string;
5062
5341
  };
5063
5342
  AssociateExpenseDto: {
5064
5343
  driverId?: string;
@@ -5274,6 +5553,33 @@ export interface components {
5274
5553
  forwardedTo?: string[];
5275
5554
  signedPdfUrl?: string;
5276
5555
  };
5556
+ SearchResultItemDto: {
5557
+ /** @description Entity ID */
5558
+ id: string;
5559
+ /**
5560
+ * @description Entity type
5561
+ * @enum {string}
5562
+ */
5563
+ type: "run" | "driver" | "truck" | "trailer" | "customer";
5564
+ /** @description Display title */
5565
+ title: string;
5566
+ /** @description Secondary display text */
5567
+ subtitle?: string;
5568
+ /** @description Navigation URL */
5569
+ url: string;
5570
+ };
5571
+ SearchResultDto: {
5572
+ /** @description Matching runs */
5573
+ runs: components["schemas"]["SearchResultItemDto"][];
5574
+ /** @description Matching drivers */
5575
+ drivers: components["schemas"]["SearchResultItemDto"][];
5576
+ /** @description Matching trucks */
5577
+ trucks: components["schemas"]["SearchResultItemDto"][];
5578
+ /** @description Matching trailers */
5579
+ trailers: components["schemas"]["SearchResultItemDto"][];
5580
+ /** @description Matching customers */
5581
+ customers: components["schemas"]["SearchResultItemDto"][];
5582
+ };
5277
5583
  };
5278
5584
  responses: never;
5279
5585
  parameters: never;
@@ -5591,6 +5897,62 @@ export interface operations {
5591
5897
  };
5592
5898
  };
5593
5899
  };
5900
+ AuthController_getVerificationCodeForE2E: {
5901
+ parameters: {
5902
+ query: {
5903
+ email: string;
5904
+ secret: string;
5905
+ };
5906
+ header?: never;
5907
+ path?: never;
5908
+ cookie?: never;
5909
+ };
5910
+ requestBody?: never;
5911
+ responses: {
5912
+ /** @description Verification code returned */
5913
+ 200: {
5914
+ headers: {
5915
+ [name: string]: unknown;
5916
+ };
5917
+ content?: never;
5918
+ };
5919
+ /** @description Invalid E2E test secret */
5920
+ 401: {
5921
+ headers: {
5922
+ [name: string]: unknown;
5923
+ };
5924
+ content?: never;
5925
+ };
5926
+ };
5927
+ };
5928
+ AuthController_deleteUserForE2E: {
5929
+ parameters: {
5930
+ query: {
5931
+ email: string;
5932
+ secret: string;
5933
+ };
5934
+ header?: never;
5935
+ path?: never;
5936
+ cookie?: never;
5937
+ };
5938
+ requestBody?: never;
5939
+ responses: {
5940
+ /** @description User deleted */
5941
+ 200: {
5942
+ headers: {
5943
+ [name: string]: unknown;
5944
+ };
5945
+ content?: never;
5946
+ };
5947
+ /** @description Invalid E2E test secret */
5948
+ 401: {
5949
+ headers: {
5950
+ [name: string]: unknown;
5951
+ };
5952
+ content?: never;
5953
+ };
5954
+ };
5955
+ };
5594
5956
  UsersController_findAll: {
5595
5957
  parameters: {
5596
5958
  query: {
@@ -6755,6 +7117,37 @@ export interface operations {
6755
7117
  };
6756
7118
  };
6757
7119
  };
7120
+ RunsController_revertStopStatus: {
7121
+ parameters: {
7122
+ query?: never;
7123
+ header?: never;
7124
+ path: {
7125
+ id: string;
7126
+ stopId: string;
7127
+ };
7128
+ cookie?: never;
7129
+ };
7130
+ requestBody: {
7131
+ content: {
7132
+ "application/json": components["schemas"]["RevertStopStatusDto"];
7133
+ };
7134
+ };
7135
+ responses: {
7136
+ /** @description Stop status reverted successfully */
7137
+ 200: {
7138
+ headers: {
7139
+ [name: string]: unknown;
7140
+ };
7141
+ content?: never;
7142
+ };
7143
+ 201: {
7144
+ headers: {
7145
+ [name: string]: unknown;
7146
+ };
7147
+ content?: never;
7148
+ };
7149
+ };
7150
+ };
6758
7151
  RunsController_geocodeStops: {
6759
7152
  parameters: {
6760
7153
  query?: never;
@@ -9971,7 +10364,14 @@ export interface operations {
9971
10364
  };
9972
10365
  ClientEmailController_findAll: {
9973
10366
  parameters: {
9974
- query?: never;
10367
+ query?: {
10368
+ /** @description Filter by active status */
10369
+ isActive?: boolean;
10370
+ /** @description Filter by associated run status (DISPATCHED, IN_PROGRESS, COMPLETED, etc.) */
10371
+ runStatus?: string;
10372
+ /** @description Search by local part or customer name */
10373
+ search?: string;
10374
+ };
9975
10375
  header?: never;
9976
10376
  path?: never;
9977
10377
  cookie?: never;
@@ -10295,4 +10695,29 @@ export interface operations {
10295
10695
  };
10296
10696
  };
10297
10697
  };
10698
+ SearchController_search: {
10699
+ parameters: {
10700
+ query: {
10701
+ /** @description Search term (min 2 characters) */
10702
+ q: string;
10703
+ /** @description Max results per category (default: 10) */
10704
+ limit?: number;
10705
+ };
10706
+ header?: never;
10707
+ path?: never;
10708
+ cookie?: never;
10709
+ };
10710
+ requestBody?: never;
10711
+ responses: {
10712
+ /** @description Search results grouped by entity type */
10713
+ 200: {
10714
+ headers: {
10715
+ [name: string]: unknown;
10716
+ };
10717
+ content: {
10718
+ "application/json": components["schemas"]["SearchResultDto"];
10719
+ };
10720
+ };
10721
+ };
10722
+ };
10298
10723
  }