@palmetto/dispatch-sdk 0.2.0

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.
@@ -0,0 +1,2142 @@
1
+ export interface paths {
2
+ "/api/health": {
3
+ parameters: {
4
+ query?: never;
5
+ header?: never;
6
+ path?: never;
7
+ cookie?: never;
8
+ };
9
+ get: operations["HealthController_getHealth"];
10
+ put?: never;
11
+ post?: never;
12
+ delete?: never;
13
+ options?: never;
14
+ head?: never;
15
+ patch?: never;
16
+ trace?: never;
17
+ };
18
+ "/api/projects": {
19
+ parameters: {
20
+ query?: never;
21
+ header?: never;
22
+ path?: never;
23
+ cookie?: never;
24
+ };
25
+ /** Find All Projects */
26
+ get: operations["ProjectsController_findAll"];
27
+ put?: never;
28
+ /** Create Project */
29
+ post: operations["ProjectsController_create"];
30
+ delete?: never;
31
+ options?: never;
32
+ head?: never;
33
+ patch?: never;
34
+ trace?: never;
35
+ };
36
+ "/api/projects/{id}": {
37
+ parameters: {
38
+ query?: never;
39
+ header?: never;
40
+ path?: never;
41
+ cookie?: never;
42
+ };
43
+ get?: never;
44
+ put?: never;
45
+ post?: never;
46
+ delete?: never;
47
+ options?: never;
48
+ head?: never;
49
+ /** Update Project */
50
+ patch: operations["ProjectsController_update"];
51
+ trace?: never;
52
+ };
53
+ "/api/suppliers": {
54
+ parameters: {
55
+ query?: never;
56
+ header?: never;
57
+ path?: never;
58
+ cookie?: never;
59
+ };
60
+ /** Find All Suppliers */
61
+ get: operations["SuppliersController_findAll"];
62
+ put?: never;
63
+ /** Create Supplier */
64
+ post: operations["SuppliersController_create"];
65
+ delete?: never;
66
+ options?: never;
67
+ head?: never;
68
+ patch?: never;
69
+ trace?: never;
70
+ };
71
+ "/api/suppliers/{id}": {
72
+ parameters: {
73
+ query?: never;
74
+ header?: never;
75
+ path?: never;
76
+ cookie?: never;
77
+ };
78
+ /** Find Supplier By ID */
79
+ get: operations["SuppliersController_findOne"];
80
+ put?: never;
81
+ post?: never;
82
+ delete?: never;
83
+ options?: never;
84
+ head?: never;
85
+ /** Update Supplier */
86
+ patch: operations["SuppliersController_update"];
87
+ trace?: never;
88
+ };
89
+ "/api/suppliers/{id}/status": {
90
+ parameters: {
91
+ query?: never;
92
+ header?: never;
93
+ path?: never;
94
+ cookie?: never;
95
+ };
96
+ get?: never;
97
+ put?: never;
98
+ post?: never;
99
+ delete?: never;
100
+ options?: never;
101
+ head?: never;
102
+ /** Update Supplier Status */
103
+ patch: operations["SuppliersController_updateStatus"];
104
+ trace?: never;
105
+ };
106
+ "/api/suppliers/{id}/service-areas": {
107
+ parameters: {
108
+ query?: never;
109
+ header?: never;
110
+ path?: never;
111
+ cookie?: never;
112
+ };
113
+ /** Find Service Areas for Supplier */
114
+ get: operations["SuppliersController_findServiceAreas"];
115
+ put?: never;
116
+ /** Add Service Area to Supplier */
117
+ post: operations["SuppliersController_addServiceArea"];
118
+ delete?: never;
119
+ options?: never;
120
+ head?: never;
121
+ patch?: never;
122
+ trace?: never;
123
+ };
124
+ "/api/suppliers/{id}/service-areas/{serviceAreaId}": {
125
+ parameters: {
126
+ query?: never;
127
+ header?: never;
128
+ path?: never;
129
+ cookie?: never;
130
+ };
131
+ get?: never;
132
+ put?: never;
133
+ post?: never;
134
+ /** Remove Service Area from Supplier */
135
+ delete: operations["SuppliersController_removeServiceArea"];
136
+ options?: never;
137
+ head?: never;
138
+ /** Update Service Area Radius */
139
+ patch: operations["SuppliersController_updateServiceArea"];
140
+ trace?: never;
141
+ };
142
+ "/api/suppliers/{id}/regions/{region}": {
143
+ parameters: {
144
+ query?: never;
145
+ header?: never;
146
+ path?: never;
147
+ cookie?: never;
148
+ };
149
+ get?: never;
150
+ /** Upsert Supplier Region */
151
+ put: operations["SuppliersController_upsertRegion"];
152
+ post?: never;
153
+ /** Remove Region from Supplier */
154
+ delete: operations["SuppliersController_removeRegion"];
155
+ options?: never;
156
+ head?: never;
157
+ patch?: never;
158
+ trace?: never;
159
+ };
160
+ "/api/dispatches": {
161
+ parameters: {
162
+ query?: never;
163
+ header?: never;
164
+ path?: never;
165
+ cookie?: never;
166
+ };
167
+ /** Find All Dispatches */
168
+ get: operations["DispatchesController_findAll"];
169
+ put?: never;
170
+ /** Create Dispatch */
171
+ post: operations["DispatchesController_create"];
172
+ delete?: never;
173
+ options?: never;
174
+ head?: never;
175
+ patch?: never;
176
+ trace?: never;
177
+ };
178
+ "/api/dispatches/{id}/status": {
179
+ parameters: {
180
+ query?: never;
181
+ header?: never;
182
+ path?: never;
183
+ cookie?: never;
184
+ };
185
+ get?: never;
186
+ put?: never;
187
+ post?: never;
188
+ delete?: never;
189
+ options?: never;
190
+ head?: never;
191
+ /** Update Dispatch Status */
192
+ patch: operations["DispatchesController_updateStatus"];
193
+ trace?: never;
194
+ };
195
+ }
196
+ export type webhooks = Record<string, never>;
197
+ export interface components {
198
+ schemas: {
199
+ InternalServerErrorDto: {
200
+ /**
201
+ * @example InternalServerError
202
+ * @constant
203
+ */
204
+ error: "InternalServerError";
205
+ /**
206
+ * @example 500
207
+ * @constant
208
+ */
209
+ statusCode: 500;
210
+ /** @example An unexpected service error occurred */
211
+ message: string;
212
+ /** @example Technical error description */
213
+ reason: string;
214
+ };
215
+ HealthStatusDto: {
216
+ ok: boolean;
217
+ checks: {
218
+ database: boolean;
219
+ };
220
+ };
221
+ UnauthorizedErrorDto: {
222
+ /**
223
+ * @example Unauthorized
224
+ * @constant
225
+ */
226
+ error: "Unauthorized";
227
+ /**
228
+ * @example 401
229
+ * @constant
230
+ */
231
+ statusCode: 401;
232
+ /** @example You must log in to perform that action */
233
+ message: string;
234
+ /** @example Technical error description */
235
+ reason: string;
236
+ };
237
+ PagingDto: {
238
+ /** @description Limit of records per page */
239
+ limit: number;
240
+ /** @description Current page */
241
+ page: number;
242
+ /** @description Record count this page starts on */
243
+ pageStart: number;
244
+ /** @description Record count this page ends on */
245
+ pageEnd: number;
246
+ /** @description The count of records in total */
247
+ totalRecords: number;
248
+ /** @description The count of pages in total */
249
+ totalPages: number;
250
+ };
251
+ ProjectDto: {
252
+ account: {
253
+ /** @example acc_12345 */
254
+ id: string;
255
+ /**
256
+ * @example LIGHT_REACH
257
+ * @enum {string}
258
+ */
259
+ type: "LIGHT_REACH";
260
+ };
261
+ address: {
262
+ /** @example 4 Bonnie Dr */
263
+ streetAddress: string;
264
+ /** @example Berkley */
265
+ locality: string;
266
+ /** @example MA */
267
+ region: string;
268
+ /** @example 02779 */
269
+ postalCode: string;
270
+ /** @example US */
271
+ country: string;
272
+ coordinates: {
273
+ /** @example 41.8714689 */
274
+ lat: number;
275
+ /** @example -71.0950429 */
276
+ lon: number;
277
+ };
278
+ };
279
+ customer: {
280
+ /** @example John Doe */
281
+ name: string;
282
+ /**
283
+ * Format: email
284
+ * @example john@example.com
285
+ */
286
+ email: string;
287
+ /** @example 555-123-4567 */
288
+ phone: string;
289
+ };
290
+ metrics: {
291
+ /** @example 8.5 */
292
+ systemSize: number;
293
+ /** @example 12000 */
294
+ firstYearProduction: number;
295
+ };
296
+ pricing: {
297
+ /** @example 3.2 */
298
+ ppw: number;
299
+ };
300
+ utility: {
301
+ /** @example 12345 */
302
+ id: string;
303
+ };
304
+ /**
305
+ * @example [
306
+ * "solar",
307
+ * "battery"
308
+ * ]
309
+ */
310
+ productTypes: ("solar" | "battery")[];
311
+ /** @constant */
312
+ isServiceable?: false;
313
+ meta: {
314
+ /**
315
+ * Format: date-time
316
+ * @description Created at timestamp
317
+ * @example 2022-01-21T00:15:16.000Z
318
+ */
319
+ createdAt: string;
320
+ createdBy: string;
321
+ /**
322
+ * Format: date-time
323
+ * @description Updated at timestamp
324
+ * @example 2022-01-21T00:15:16.000Z
325
+ */
326
+ updatedAt?: string;
327
+ updatedBy?: string;
328
+ /**
329
+ * Format: date-time
330
+ * @description Deleted at timestamp
331
+ * @example 2022-01-21T00:15:16.000Z
332
+ */
333
+ deletedAt?: string;
334
+ deletedBy?: string;
335
+ };
336
+ id: string;
337
+ };
338
+ BadRequestErrorDto: {
339
+ /**
340
+ * @example BadRequest
341
+ * @constant
342
+ */
343
+ error: "BadRequest";
344
+ /**
345
+ * @example 400
346
+ * @constant
347
+ */
348
+ statusCode: 400;
349
+ /** @example Request is invalid */
350
+ message: string;
351
+ /** @example Technical error description */
352
+ reason: string;
353
+ /**
354
+ * @example {
355
+ * "name": [
356
+ * "is required"
357
+ * ],
358
+ * "postalCode": [
359
+ * "must be a string of 5 numbers"
360
+ * ]
361
+ * }
362
+ */
363
+ validations: {
364
+ [key: string]: string[];
365
+ };
366
+ };
367
+ ForbiddenErrorDto: {
368
+ /**
369
+ * @example Forbidden
370
+ * @constant
371
+ */
372
+ error: "Forbidden";
373
+ /**
374
+ * @example 403
375
+ * @constant
376
+ */
377
+ statusCode: 403;
378
+ /** @example You are not allowed to perform that action */
379
+ message: string;
380
+ /** @example Technical error description */
381
+ reason: string;
382
+ };
383
+ CreateProjectDto: {
384
+ account: {
385
+ /** @example acc_12345 */
386
+ id: string;
387
+ /**
388
+ * @example LIGHT_REACH
389
+ * @enum {string}
390
+ */
391
+ type: "LIGHT_REACH";
392
+ };
393
+ address: {
394
+ /** @example 4 Bonnie Dr */
395
+ streetAddress: string;
396
+ /** @example Berkley */
397
+ locality: string;
398
+ /** @example MA */
399
+ region: string;
400
+ /** @example 02779 */
401
+ postalCode: string;
402
+ /** @example US */
403
+ country: string;
404
+ coordinates: {
405
+ /** @example 41.8714689 */
406
+ lat: number;
407
+ /** @example -71.0950429 */
408
+ lon: number;
409
+ };
410
+ };
411
+ customer: {
412
+ /** @example John Doe */
413
+ name: string;
414
+ /**
415
+ * Format: email
416
+ * @example john@example.com
417
+ */
418
+ email: string;
419
+ /** @example 555-123-4567 */
420
+ phone: string;
421
+ };
422
+ metrics: {
423
+ /** @example 8.5 */
424
+ systemSize: number;
425
+ /** @example 12000 */
426
+ firstYearProduction: number;
427
+ };
428
+ pricing: {
429
+ /** @example 3.2 */
430
+ ppw: number;
431
+ };
432
+ utility: {
433
+ /** @example 12345 */
434
+ id: string;
435
+ };
436
+ /**
437
+ * @example [
438
+ * "solar",
439
+ * "battery"
440
+ * ]
441
+ */
442
+ productTypes: ("solar" | "battery")[];
443
+ };
444
+ ConflictErrorDto: {
445
+ /**
446
+ * @example Conflict
447
+ * @constant
448
+ */
449
+ error: "Conflict";
450
+ /**
451
+ * @example 409
452
+ * @constant
453
+ */
454
+ statusCode: 409;
455
+ /** @example That action cannot be performed at this time */
456
+ message: string;
457
+ /** @example Technical error description */
458
+ reason: string;
459
+ };
460
+ UpdateProjectDto: {
461
+ address?: {
462
+ /** @example 4 Bonnie Dr */
463
+ streetAddress: string;
464
+ /** @example Berkley */
465
+ locality: string;
466
+ /** @example MA */
467
+ region: string;
468
+ /** @example 02779 */
469
+ postalCode: string;
470
+ /** @example US */
471
+ country: string;
472
+ coordinates: {
473
+ /** @example 41.8714689 */
474
+ lat: number;
475
+ /** @example -71.0950429 */
476
+ lon: number;
477
+ };
478
+ };
479
+ customer?: {
480
+ /** @example John Doe */
481
+ name: string;
482
+ /**
483
+ * Format: email
484
+ * @example john@example.com
485
+ */
486
+ email: string;
487
+ /** @example 555-123-4567 */
488
+ phone: string;
489
+ };
490
+ metrics?: {
491
+ /** @example 8.5 */
492
+ systemSize: number;
493
+ /** @example 12000 */
494
+ firstYearProduction: number;
495
+ };
496
+ pricing?: {
497
+ /** @example 3.2 */
498
+ ppw: number;
499
+ };
500
+ utility?: {
501
+ /** @example 12345 */
502
+ id: string;
503
+ };
504
+ /**
505
+ * @example [
506
+ * "solar",
507
+ * "battery"
508
+ * ]
509
+ */
510
+ productTypes?: ("solar" | "battery")[];
511
+ /** @constant */
512
+ isServiceable?: false;
513
+ };
514
+ NotFoundErrorDto: {
515
+ /**
516
+ * @example NotFound
517
+ * @constant
518
+ */
519
+ error: "NotFound";
520
+ /**
521
+ * @example 404
522
+ * @constant
523
+ */
524
+ statusCode: 404;
525
+ /** @example The requested entity was not found */
526
+ message: string;
527
+ /** @example Technical error description */
528
+ reason: string;
529
+ };
530
+ CreateSupplierDto: {
531
+ account: {
532
+ /** @example acc_12345 */
533
+ id: string;
534
+ /**
535
+ * @example LIGHT_REACH
536
+ * @enum {string}
537
+ */
538
+ type: "LIGHT_REACH";
539
+ };
540
+ name: string;
541
+ address: {
542
+ /** @example 4 Bonnie Dr */
543
+ streetAddress: string;
544
+ /** @example Berkley */
545
+ locality: string;
546
+ /** @example MA */
547
+ region: string;
548
+ /** @example 02779 */
549
+ postalCode: string;
550
+ /** @example US */
551
+ country: string;
552
+ coordinates: {
553
+ /** @example 41.8714689 */
554
+ lat: number;
555
+ /** @example -71.0950429 */
556
+ lon: number;
557
+ };
558
+ };
559
+ aspects: {
560
+ /** @default 0 */
561
+ minPpw?: number;
562
+ /**
563
+ * @example [
564
+ * "solar",
565
+ * "battery"
566
+ * ]
567
+ */
568
+ supportedProducts: ("solar" | "battery")[];
569
+ /**
570
+ * @example elite
571
+ * @enum {string}
572
+ */
573
+ tier: "platinum" | "elite" | "pro" | "certified";
574
+ };
575
+ status: {
576
+ /**
577
+ * @example active
578
+ * @constant
579
+ */
580
+ code: "active";
581
+ } | {
582
+ /**
583
+ * @example inactive
584
+ * @constant
585
+ */
586
+ code: "inactive";
587
+ };
588
+ serviceAreas: {
589
+ point: {
590
+ /**
591
+ * @example Point
592
+ * @constant
593
+ */
594
+ type: "Point";
595
+ /**
596
+ * @example [
597
+ * -71.0950429,
598
+ * 41.8714689
599
+ * ]
600
+ */
601
+ coordinates: [
602
+ number,
603
+ number
604
+ ];
605
+ };
606
+ /** @example 80467 */
607
+ radiusInMeters: number;
608
+ }[];
609
+ regions: {
610
+ /** @example MA */
611
+ region: string;
612
+ capacity: {
613
+ /** @example 6 */
614
+ month: number;
615
+ /** @example 50 */
616
+ limit: number;
617
+ }[];
618
+ }[];
619
+ };
620
+ SupplierDto: {
621
+ account: {
622
+ /** @example acc_12345 */
623
+ id: string;
624
+ /**
625
+ * @example LIGHT_REACH
626
+ * @enum {string}
627
+ */
628
+ type: "LIGHT_REACH";
629
+ };
630
+ /** @example Solar Company */
631
+ name: string;
632
+ address: {
633
+ /** @example 4 Bonnie Dr */
634
+ streetAddress: string;
635
+ /** @example Berkley */
636
+ locality: string;
637
+ /** @example MA */
638
+ region: string;
639
+ /** @example 02779 */
640
+ postalCode: string;
641
+ /** @example US */
642
+ country: string;
643
+ coordinates: {
644
+ /** @example 41.8714689 */
645
+ lat: number;
646
+ /** @example -71.0950429 */
647
+ lon: number;
648
+ };
649
+ };
650
+ aspects: {
651
+ /** @example 2.5 */
652
+ minPpw: number;
653
+ /**
654
+ * @example [
655
+ * "solar",
656
+ * "battery"
657
+ * ]
658
+ */
659
+ supportedProducts: ("solar" | "battery")[];
660
+ /**
661
+ * @example elite
662
+ * @enum {string}
663
+ */
664
+ tier: "platinum" | "elite" | "pro" | "certified";
665
+ };
666
+ status: {
667
+ /**
668
+ * @example active
669
+ * @constant
670
+ */
671
+ code: "active";
672
+ /** Format: date-time */
673
+ statusUpdatedAt: string;
674
+ } | {
675
+ /**
676
+ * @example inactive
677
+ * @constant
678
+ */
679
+ code: "inactive";
680
+ /** Format: date-time */
681
+ statusUpdatedAt: string;
682
+ };
683
+ serviceAreas: {
684
+ point: {
685
+ /**
686
+ * @example Point
687
+ * @constant
688
+ */
689
+ type: "Point";
690
+ /**
691
+ * @example [
692
+ * -71.0950429,
693
+ * 41.8714689
694
+ * ]
695
+ */
696
+ coordinates: [
697
+ number,
698
+ number
699
+ ];
700
+ };
701
+ /** @example 80467 */
702
+ radiusInMeters: number;
703
+ }[];
704
+ regions: {
705
+ /** @example MA */
706
+ region: string;
707
+ capacity: {
708
+ /** @example 6 */
709
+ month: number;
710
+ /** @example 50 */
711
+ limit: number;
712
+ }[];
713
+ }[];
714
+ meta: {
715
+ /**
716
+ * Format: date-time
717
+ * @description Created at timestamp
718
+ * @example 2022-01-21T00:15:16.000Z
719
+ */
720
+ createdAt: string;
721
+ createdBy: string;
722
+ /**
723
+ * Format: date-time
724
+ * @description Updated at timestamp
725
+ * @example 2022-01-21T00:15:16.000Z
726
+ */
727
+ updatedAt?: string;
728
+ updatedBy?: string;
729
+ /**
730
+ * Format: date-time
731
+ * @description Deleted at timestamp
732
+ * @example 2022-01-21T00:15:16.000Z
733
+ */
734
+ deletedAt?: string;
735
+ deletedBy?: string;
736
+ };
737
+ id: string;
738
+ };
739
+ UpdateSupplierDto: {
740
+ name?: string;
741
+ address?: {
742
+ /** @example 4 Bonnie Dr */
743
+ streetAddress: string;
744
+ /** @example Berkley */
745
+ locality: string;
746
+ /** @example MA */
747
+ region: string;
748
+ /** @example 02779 */
749
+ postalCode: string;
750
+ /** @example US */
751
+ country: string;
752
+ coordinates: {
753
+ /** @example 41.8714689 */
754
+ lat: number;
755
+ /** @example -71.0950429 */
756
+ lon: number;
757
+ };
758
+ };
759
+ };
760
+ UpdateSupplierStatusDto: {
761
+ status: {
762
+ /**
763
+ * @example active
764
+ * @constant
765
+ */
766
+ code: "active";
767
+ } | {
768
+ /**
769
+ * @example inactive
770
+ * @constant
771
+ */
772
+ code: "inactive";
773
+ };
774
+ };
775
+ CreateServiceAreaDto: {
776
+ point: {
777
+ /**
778
+ * @example Point
779
+ * @constant
780
+ */
781
+ type: "Point";
782
+ /**
783
+ * @example [
784
+ * -71.0950429,
785
+ * 41.8714689
786
+ * ]
787
+ */
788
+ coordinates: [
789
+ number,
790
+ number
791
+ ];
792
+ };
793
+ /** @example 80467 */
794
+ radiusInMeters: number;
795
+ };
796
+ UpdateServiceAreaDto: {
797
+ radiusInMeters: number;
798
+ };
799
+ ListDto: {
800
+ data: unknown[];
801
+ };
802
+ ServiceAreaDto: {
803
+ point: {
804
+ /**
805
+ * @example Point
806
+ * @constant
807
+ */
808
+ type: "Point";
809
+ /**
810
+ * @example [
811
+ * -71.0950429,
812
+ * 41.8714689
813
+ * ]
814
+ */
815
+ coordinates: [
816
+ number,
817
+ number
818
+ ];
819
+ };
820
+ /** @example 80467 */
821
+ radiusInMeters: number;
822
+ };
823
+ UpsertSupplierRegionDto: {
824
+ capacity: {
825
+ /** @example 6 */
826
+ month: number;
827
+ /** @example 50 */
828
+ limit: number;
829
+ }[];
830
+ };
831
+ CreateDispatchDto: {
832
+ projectId: string;
833
+ };
834
+ DispatchDto: {
835
+ /** @example 507f1f77bcf86cd799439011 */
836
+ projectId: string;
837
+ /** @example 507f1f77bcf86cd799439012 */
838
+ supplierId: string;
839
+ status: {
840
+ /**
841
+ * @example pending
842
+ * @constant
843
+ */
844
+ code: "pending";
845
+ /** Format: date-time */
846
+ statusUpdatedAt: string;
847
+ } | {
848
+ /**
849
+ * @example accepted
850
+ * @constant
851
+ */
852
+ code: "accepted";
853
+ /** Format: date-time */
854
+ statusUpdatedAt: string;
855
+ } | {
856
+ /**
857
+ * @example rejected
858
+ * @constant
859
+ */
860
+ code: "rejected";
861
+ /**
862
+ * @example capacity
863
+ * @enum {string}
864
+ */
865
+ reason: "capacity" | "equipment" | "distance" | "pricing" | "not_interested" | "other";
866
+ /** Format: date-time */
867
+ statusUpdatedAt: string;
868
+ } | {
869
+ /**
870
+ * @example withdrawn
871
+ * @constant
872
+ */
873
+ code: "withdrawn";
874
+ /** Format: date-time */
875
+ statusUpdatedAt: string;
876
+ };
877
+ /** Format: date-time */
878
+ offeredAt: string;
879
+ /** Format: date-time */
880
+ respondedAt?: string;
881
+ /** Format: date-time */
882
+ expiresAt: string;
883
+ match: {
884
+ /** @example 507f1f77bcf86cd799439011 */
885
+ supplierId: string;
886
+ /** @example 0.85 */
887
+ weight: number;
888
+ }[];
889
+ meta: {
890
+ /**
891
+ * Format: date-time
892
+ * @description Created at timestamp
893
+ * @example 2022-01-21T00:15:16.000Z
894
+ */
895
+ createdAt: string;
896
+ createdBy: string;
897
+ /**
898
+ * Format: date-time
899
+ * @description Updated at timestamp
900
+ * @example 2022-01-21T00:15:16.000Z
901
+ */
902
+ updatedAt?: string;
903
+ updatedBy?: string;
904
+ /**
905
+ * Format: date-time
906
+ * @description Deleted at timestamp
907
+ * @example 2022-01-21T00:15:16.000Z
908
+ */
909
+ deletedAt?: string;
910
+ deletedBy?: string;
911
+ };
912
+ id: string;
913
+ };
914
+ UpdateDispatchStatusDto: {
915
+ status: {
916
+ /**
917
+ * @example pending
918
+ * @constant
919
+ */
920
+ code: "pending";
921
+ } | {
922
+ /**
923
+ * @example accepted
924
+ * @constant
925
+ */
926
+ code: "accepted";
927
+ } | {
928
+ /**
929
+ * @example rejected
930
+ * @constant
931
+ */
932
+ code: "rejected";
933
+ /**
934
+ * @example capacity
935
+ * @enum {string}
936
+ */
937
+ reason: "capacity" | "equipment" | "distance" | "pricing" | "not_interested" | "other";
938
+ } | {
939
+ /**
940
+ * @example withdrawn
941
+ * @constant
942
+ */
943
+ code: "withdrawn";
944
+ };
945
+ };
946
+ };
947
+ responses: never;
948
+ parameters: never;
949
+ requestBodies: never;
950
+ headers: never;
951
+ pathItems: never;
952
+ }
953
+ export type $defs = Record<string, never>;
954
+ export interface operations {
955
+ HealthController_getHealth: {
956
+ parameters: {
957
+ query?: never;
958
+ header?: never;
959
+ path?: never;
960
+ cookie?: never;
961
+ };
962
+ requestBody?: never;
963
+ responses: {
964
+ 200: {
965
+ headers: {
966
+ [name: string]: unknown;
967
+ };
968
+ content: {
969
+ "application/json": components["schemas"]["HealthStatusDto"];
970
+ };
971
+ };
972
+ /** @description When the request is valid, but something goes wrong on the server */
973
+ 500: {
974
+ headers: {
975
+ [name: string]: unknown;
976
+ };
977
+ content: {
978
+ "application/json": components["schemas"]["InternalServerErrorDto"];
979
+ };
980
+ };
981
+ };
982
+ };
983
+ ProjectsController_findAll: {
984
+ parameters: {
985
+ query?: {
986
+ page?: number;
987
+ limit?: number;
988
+ "customer.name"?: string;
989
+ "customer.email"?: string;
990
+ "customer.phone"?: string;
991
+ };
992
+ header?: never;
993
+ path?: never;
994
+ cookie?: never;
995
+ };
996
+ requestBody?: never;
997
+ responses: {
998
+ 200: {
999
+ headers: {
1000
+ [name: string]: unknown;
1001
+ };
1002
+ content: {
1003
+ "application/json": {
1004
+ data: components["schemas"]["ProjectDto"][];
1005
+ paging: components["schemas"]["PagingDto"];
1006
+ };
1007
+ };
1008
+ };
1009
+ /** @description When the query request is invalid */
1010
+ 400: {
1011
+ headers: {
1012
+ [name: string]: unknown;
1013
+ };
1014
+ content: {
1015
+ "application/json": components["schemas"]["BadRequestErrorDto"];
1016
+ };
1017
+ };
1018
+ /** @description When authentication fails */
1019
+ 401: {
1020
+ headers: {
1021
+ [name: string]: unknown;
1022
+ };
1023
+ content: {
1024
+ "application/json": components["schemas"]["UnauthorizedErrorDto"];
1025
+ };
1026
+ };
1027
+ /** @description When the requesting user is not allowed to perform this action */
1028
+ 403: {
1029
+ headers: {
1030
+ [name: string]: unknown;
1031
+ };
1032
+ content: {
1033
+ "application/json": components["schemas"]["ForbiddenErrorDto"];
1034
+ };
1035
+ };
1036
+ /** @description When the request is valid, but something goes wrong on the server */
1037
+ 500: {
1038
+ headers: {
1039
+ [name: string]: unknown;
1040
+ };
1041
+ content: {
1042
+ "application/json": components["schemas"]["InternalServerErrorDto"];
1043
+ };
1044
+ };
1045
+ };
1046
+ };
1047
+ ProjectsController_create: {
1048
+ parameters: {
1049
+ query?: never;
1050
+ header?: never;
1051
+ path?: never;
1052
+ cookie?: never;
1053
+ };
1054
+ requestBody: {
1055
+ content: {
1056
+ "application/json": components["schemas"]["CreateProjectDto"];
1057
+ };
1058
+ };
1059
+ responses: {
1060
+ 201: {
1061
+ headers: {
1062
+ [name: string]: unknown;
1063
+ };
1064
+ content: {
1065
+ "application/json": components["schemas"]["ProjectDto"];
1066
+ };
1067
+ };
1068
+ /** @description When the request is invalid */
1069
+ 400: {
1070
+ headers: {
1071
+ [name: string]: unknown;
1072
+ };
1073
+ content: {
1074
+ "application/json": components["schemas"]["BadRequestErrorDto"];
1075
+ };
1076
+ };
1077
+ /** @description When authentication fails */
1078
+ 401: {
1079
+ headers: {
1080
+ [name: string]: unknown;
1081
+ };
1082
+ content: {
1083
+ "application/json": components["schemas"]["UnauthorizedErrorDto"];
1084
+ };
1085
+ };
1086
+ /** @description When the requesting user is not allowed to perform this action */
1087
+ 403: {
1088
+ headers: {
1089
+ [name: string]: unknown;
1090
+ };
1091
+ content: {
1092
+ "application/json": components["schemas"]["ForbiddenErrorDto"];
1093
+ };
1094
+ };
1095
+ /** @description When the project already exists */
1096
+ 409: {
1097
+ headers: {
1098
+ [name: string]: unknown;
1099
+ };
1100
+ content: {
1101
+ "application/json": components["schemas"]["ConflictErrorDto"];
1102
+ };
1103
+ };
1104
+ /** @description When the request is valid, but something goes wrong on the server */
1105
+ 500: {
1106
+ headers: {
1107
+ [name: string]: unknown;
1108
+ };
1109
+ content: {
1110
+ "application/json": components["schemas"]["InternalServerErrorDto"];
1111
+ };
1112
+ };
1113
+ };
1114
+ };
1115
+ ProjectsController_update: {
1116
+ parameters: {
1117
+ query?: never;
1118
+ header?: never;
1119
+ path: {
1120
+ id: string;
1121
+ };
1122
+ cookie?: never;
1123
+ };
1124
+ requestBody: {
1125
+ content: {
1126
+ "application/json": components["schemas"]["UpdateProjectDto"];
1127
+ };
1128
+ };
1129
+ responses: {
1130
+ 200: {
1131
+ headers: {
1132
+ [name: string]: unknown;
1133
+ };
1134
+ content: {
1135
+ "application/json": components["schemas"]["ProjectDto"];
1136
+ };
1137
+ };
1138
+ /** @description When the ID or body request is invalid */
1139
+ 400: {
1140
+ headers: {
1141
+ [name: string]: unknown;
1142
+ };
1143
+ content: {
1144
+ "application/json": components["schemas"]["BadRequestErrorDto"];
1145
+ };
1146
+ };
1147
+ /** @description When authentication fails */
1148
+ 401: {
1149
+ headers: {
1150
+ [name: string]: unknown;
1151
+ };
1152
+ content: {
1153
+ "application/json": components["schemas"]["UnauthorizedErrorDto"];
1154
+ };
1155
+ };
1156
+ /** @description When the requesting user is not allowed to perform this action */
1157
+ 403: {
1158
+ headers: {
1159
+ [name: string]: unknown;
1160
+ };
1161
+ content: {
1162
+ "application/json": components["schemas"]["ForbiddenErrorDto"];
1163
+ };
1164
+ };
1165
+ /** @description When the project is not found */
1166
+ 404: {
1167
+ headers: {
1168
+ [name: string]: unknown;
1169
+ };
1170
+ content: {
1171
+ "application/json": components["schemas"]["NotFoundErrorDto"];
1172
+ };
1173
+ };
1174
+ /** @description When the request is valid, but something goes wrong on the server */
1175
+ 500: {
1176
+ headers: {
1177
+ [name: string]: unknown;
1178
+ };
1179
+ content: {
1180
+ "application/json": components["schemas"]["InternalServerErrorDto"];
1181
+ };
1182
+ };
1183
+ };
1184
+ };
1185
+ SuppliersController_findAll: {
1186
+ parameters: {
1187
+ query?: {
1188
+ page?: number;
1189
+ limit?: number;
1190
+ "account.id"?: string;
1191
+ name?: string;
1192
+ "status.code"?: "active" | "inactive";
1193
+ "aspects.minPpw"?: number;
1194
+ "aspects.supportedProducts"?: "solar" | "battery";
1195
+ "aspects.tier"?: "platinum" | "elite" | "pro" | "certified";
1196
+ "regions.region"?: string;
1197
+ "regions.capacity"?: number;
1198
+ };
1199
+ header?: never;
1200
+ path?: never;
1201
+ cookie?: never;
1202
+ };
1203
+ requestBody?: never;
1204
+ responses: {
1205
+ 200: {
1206
+ headers: {
1207
+ [name: string]: unknown;
1208
+ };
1209
+ content: {
1210
+ "application/json": {
1211
+ data: components["schemas"]["SupplierDto"][];
1212
+ paging: components["schemas"]["PagingDto"];
1213
+ };
1214
+ };
1215
+ };
1216
+ /** @description When the query request is invalid */
1217
+ 400: {
1218
+ headers: {
1219
+ [name: string]: unknown;
1220
+ };
1221
+ content: {
1222
+ "application/json": components["schemas"]["BadRequestErrorDto"];
1223
+ };
1224
+ };
1225
+ /** @description When authentication fails */
1226
+ 401: {
1227
+ headers: {
1228
+ [name: string]: unknown;
1229
+ };
1230
+ content: {
1231
+ "application/json": components["schemas"]["UnauthorizedErrorDto"];
1232
+ };
1233
+ };
1234
+ /** @description When the requesting user is not allowed to perform this action */
1235
+ 403: {
1236
+ headers: {
1237
+ [name: string]: unknown;
1238
+ };
1239
+ content: {
1240
+ "application/json": components["schemas"]["ForbiddenErrorDto"];
1241
+ };
1242
+ };
1243
+ /** @description When the request is valid, but something goes wrong on the server */
1244
+ 500: {
1245
+ headers: {
1246
+ [name: string]: unknown;
1247
+ };
1248
+ content: {
1249
+ "application/json": components["schemas"]["InternalServerErrorDto"];
1250
+ };
1251
+ };
1252
+ };
1253
+ };
1254
+ SuppliersController_create: {
1255
+ parameters: {
1256
+ query?: never;
1257
+ header?: never;
1258
+ path?: never;
1259
+ cookie?: never;
1260
+ };
1261
+ requestBody: {
1262
+ content: {
1263
+ "application/json": components["schemas"]["CreateSupplierDto"];
1264
+ };
1265
+ };
1266
+ responses: {
1267
+ 201: {
1268
+ headers: {
1269
+ [name: string]: unknown;
1270
+ };
1271
+ content: {
1272
+ "application/json": components["schemas"]["SupplierDto"];
1273
+ };
1274
+ };
1275
+ /** @description When the request is invalid */
1276
+ 400: {
1277
+ headers: {
1278
+ [name: string]: unknown;
1279
+ };
1280
+ content: {
1281
+ "application/json": components["schemas"]["BadRequestErrorDto"];
1282
+ };
1283
+ };
1284
+ /** @description When authentication fails */
1285
+ 401: {
1286
+ headers: {
1287
+ [name: string]: unknown;
1288
+ };
1289
+ content: {
1290
+ "application/json": components["schemas"]["UnauthorizedErrorDto"];
1291
+ };
1292
+ };
1293
+ /** @description When the requesting user is not allowed to perform this action */
1294
+ 403: {
1295
+ headers: {
1296
+ [name: string]: unknown;
1297
+ };
1298
+ content: {
1299
+ "application/json": components["schemas"]["ForbiddenErrorDto"];
1300
+ };
1301
+ };
1302
+ /** @description When the supplier already exists */
1303
+ 409: {
1304
+ headers: {
1305
+ [name: string]: unknown;
1306
+ };
1307
+ content: {
1308
+ "application/json": components["schemas"]["ConflictErrorDto"];
1309
+ };
1310
+ };
1311
+ /** @description When the request is valid, but something goes wrong on the server */
1312
+ 500: {
1313
+ headers: {
1314
+ [name: string]: unknown;
1315
+ };
1316
+ content: {
1317
+ "application/json": components["schemas"]["InternalServerErrorDto"];
1318
+ };
1319
+ };
1320
+ };
1321
+ };
1322
+ SuppliersController_findOne: {
1323
+ parameters: {
1324
+ query?: never;
1325
+ header?: never;
1326
+ path: {
1327
+ id: string;
1328
+ };
1329
+ cookie?: never;
1330
+ };
1331
+ requestBody?: never;
1332
+ responses: {
1333
+ 200: {
1334
+ headers: {
1335
+ [name: string]: unknown;
1336
+ };
1337
+ content: {
1338
+ "application/json": components["schemas"]["SupplierDto"];
1339
+ };
1340
+ };
1341
+ /** @description When the ID is invalid */
1342
+ 400: {
1343
+ headers: {
1344
+ [name: string]: unknown;
1345
+ };
1346
+ content: {
1347
+ "application/json": components["schemas"]["BadRequestErrorDto"];
1348
+ };
1349
+ };
1350
+ /** @description When authentication fails */
1351
+ 401: {
1352
+ headers: {
1353
+ [name: string]: unknown;
1354
+ };
1355
+ content: {
1356
+ "application/json": components["schemas"]["UnauthorizedErrorDto"];
1357
+ };
1358
+ };
1359
+ /** @description When the requesting user is not allowed to perform this action */
1360
+ 403: {
1361
+ headers: {
1362
+ [name: string]: unknown;
1363
+ };
1364
+ content: {
1365
+ "application/json": components["schemas"]["ForbiddenErrorDto"];
1366
+ };
1367
+ };
1368
+ /** @description When the supplier is not found */
1369
+ 404: {
1370
+ headers: {
1371
+ [name: string]: unknown;
1372
+ };
1373
+ content: {
1374
+ "application/json": components["schemas"]["NotFoundErrorDto"];
1375
+ };
1376
+ };
1377
+ /** @description When the request is valid, but something goes wrong on the server */
1378
+ 500: {
1379
+ headers: {
1380
+ [name: string]: unknown;
1381
+ };
1382
+ content: {
1383
+ "application/json": components["schemas"]["InternalServerErrorDto"];
1384
+ };
1385
+ };
1386
+ };
1387
+ };
1388
+ SuppliersController_update: {
1389
+ parameters: {
1390
+ query?: never;
1391
+ header?: never;
1392
+ path: {
1393
+ id: string;
1394
+ };
1395
+ cookie?: never;
1396
+ };
1397
+ requestBody: {
1398
+ content: {
1399
+ "application/json": components["schemas"]["UpdateSupplierDto"];
1400
+ };
1401
+ };
1402
+ responses: {
1403
+ 200: {
1404
+ headers: {
1405
+ [name: string]: unknown;
1406
+ };
1407
+ content: {
1408
+ "application/json": components["schemas"]["SupplierDto"];
1409
+ };
1410
+ };
1411
+ /** @description When the ID or body request is invalid */
1412
+ 400: {
1413
+ headers: {
1414
+ [name: string]: unknown;
1415
+ };
1416
+ content: {
1417
+ "application/json": components["schemas"]["BadRequestErrorDto"];
1418
+ };
1419
+ };
1420
+ /** @description When authentication fails */
1421
+ 401: {
1422
+ headers: {
1423
+ [name: string]: unknown;
1424
+ };
1425
+ content: {
1426
+ "application/json": components["schemas"]["UnauthorizedErrorDto"];
1427
+ };
1428
+ };
1429
+ /** @description When the requesting user is not allowed to perform this action */
1430
+ 403: {
1431
+ headers: {
1432
+ [name: string]: unknown;
1433
+ };
1434
+ content: {
1435
+ "application/json": components["schemas"]["ForbiddenErrorDto"];
1436
+ };
1437
+ };
1438
+ /** @description When the supplier is not found */
1439
+ 404: {
1440
+ headers: {
1441
+ [name: string]: unknown;
1442
+ };
1443
+ content: {
1444
+ "application/json": components["schemas"]["NotFoundErrorDto"];
1445
+ };
1446
+ };
1447
+ /** @description When the request is valid, but something goes wrong on the server */
1448
+ 500: {
1449
+ headers: {
1450
+ [name: string]: unknown;
1451
+ };
1452
+ content: {
1453
+ "application/json": components["schemas"]["InternalServerErrorDto"];
1454
+ };
1455
+ };
1456
+ };
1457
+ };
1458
+ SuppliersController_updateStatus: {
1459
+ parameters: {
1460
+ query?: never;
1461
+ header?: never;
1462
+ path: {
1463
+ id: string;
1464
+ };
1465
+ cookie?: never;
1466
+ };
1467
+ requestBody: {
1468
+ content: {
1469
+ "application/json": components["schemas"]["UpdateSupplierStatusDto"];
1470
+ };
1471
+ };
1472
+ responses: {
1473
+ 200: {
1474
+ headers: {
1475
+ [name: string]: unknown;
1476
+ };
1477
+ content: {
1478
+ "application/json": components["schemas"]["SupplierDto"];
1479
+ };
1480
+ };
1481
+ /** @description When the ID or body request is invalid */
1482
+ 400: {
1483
+ headers: {
1484
+ [name: string]: unknown;
1485
+ };
1486
+ content: {
1487
+ "application/json": components["schemas"]["BadRequestErrorDto"];
1488
+ };
1489
+ };
1490
+ /** @description When authentication fails */
1491
+ 401: {
1492
+ headers: {
1493
+ [name: string]: unknown;
1494
+ };
1495
+ content: {
1496
+ "application/json": components["schemas"]["UnauthorizedErrorDto"];
1497
+ };
1498
+ };
1499
+ /** @description When the requesting user is not allowed to perform this action */
1500
+ 403: {
1501
+ headers: {
1502
+ [name: string]: unknown;
1503
+ };
1504
+ content: {
1505
+ "application/json": components["schemas"]["ForbiddenErrorDto"];
1506
+ };
1507
+ };
1508
+ /** @description When the supplier is not found */
1509
+ 404: {
1510
+ headers: {
1511
+ [name: string]: unknown;
1512
+ };
1513
+ content: {
1514
+ "application/json": components["schemas"]["NotFoundErrorDto"];
1515
+ };
1516
+ };
1517
+ /** @description When the request is valid, but something goes wrong on the server */
1518
+ 500: {
1519
+ headers: {
1520
+ [name: string]: unknown;
1521
+ };
1522
+ content: {
1523
+ "application/json": components["schemas"]["InternalServerErrorDto"];
1524
+ };
1525
+ };
1526
+ };
1527
+ };
1528
+ SuppliersController_findServiceAreas: {
1529
+ parameters: {
1530
+ query?: never;
1531
+ header?: never;
1532
+ path: {
1533
+ id: string;
1534
+ };
1535
+ cookie?: never;
1536
+ };
1537
+ requestBody?: never;
1538
+ responses: {
1539
+ 200: {
1540
+ headers: {
1541
+ [name: string]: unknown;
1542
+ };
1543
+ content: {
1544
+ "application/json": {
1545
+ data: components["schemas"]["ServiceAreaDto"][];
1546
+ };
1547
+ };
1548
+ };
1549
+ /** @description When the ID is invalid */
1550
+ 400: {
1551
+ headers: {
1552
+ [name: string]: unknown;
1553
+ };
1554
+ content: {
1555
+ "application/json": components["schemas"]["BadRequestErrorDto"];
1556
+ };
1557
+ };
1558
+ /** @description When authentication fails */
1559
+ 401: {
1560
+ headers: {
1561
+ [name: string]: unknown;
1562
+ };
1563
+ content: {
1564
+ "application/json": components["schemas"]["UnauthorizedErrorDto"];
1565
+ };
1566
+ };
1567
+ /** @description When the requesting user is not allowed to perform this action */
1568
+ 403: {
1569
+ headers: {
1570
+ [name: string]: unknown;
1571
+ };
1572
+ content: {
1573
+ "application/json": components["schemas"]["ForbiddenErrorDto"];
1574
+ };
1575
+ };
1576
+ /** @description When the supplier is not found */
1577
+ 404: {
1578
+ headers: {
1579
+ [name: string]: unknown;
1580
+ };
1581
+ content: {
1582
+ "application/json": components["schemas"]["NotFoundErrorDto"];
1583
+ };
1584
+ };
1585
+ /** @description When the request is valid, but something goes wrong on the server */
1586
+ 500: {
1587
+ headers: {
1588
+ [name: string]: unknown;
1589
+ };
1590
+ content: {
1591
+ "application/json": components["schemas"]["InternalServerErrorDto"];
1592
+ };
1593
+ };
1594
+ };
1595
+ };
1596
+ SuppliersController_addServiceArea: {
1597
+ parameters: {
1598
+ query?: never;
1599
+ header?: never;
1600
+ path: {
1601
+ id: string;
1602
+ };
1603
+ cookie?: never;
1604
+ };
1605
+ requestBody: {
1606
+ content: {
1607
+ "application/json": components["schemas"]["CreateServiceAreaDto"];
1608
+ };
1609
+ };
1610
+ responses: {
1611
+ 201: {
1612
+ headers: {
1613
+ [name: string]: unknown;
1614
+ };
1615
+ content: {
1616
+ "application/json": components["schemas"]["SupplierDto"];
1617
+ };
1618
+ };
1619
+ /** @description When the ID or body request is invalid */
1620
+ 400: {
1621
+ headers: {
1622
+ [name: string]: unknown;
1623
+ };
1624
+ content: {
1625
+ "application/json": components["schemas"]["BadRequestErrorDto"];
1626
+ };
1627
+ };
1628
+ /** @description When authentication fails */
1629
+ 401: {
1630
+ headers: {
1631
+ [name: string]: unknown;
1632
+ };
1633
+ content: {
1634
+ "application/json": components["schemas"]["UnauthorizedErrorDto"];
1635
+ };
1636
+ };
1637
+ /** @description When the requesting user is not allowed to perform this action */
1638
+ 403: {
1639
+ headers: {
1640
+ [name: string]: unknown;
1641
+ };
1642
+ content: {
1643
+ "application/json": components["schemas"]["ForbiddenErrorDto"];
1644
+ };
1645
+ };
1646
+ /** @description When the supplier is not found */
1647
+ 404: {
1648
+ headers: {
1649
+ [name: string]: unknown;
1650
+ };
1651
+ content: {
1652
+ "application/json": components["schemas"]["NotFoundErrorDto"];
1653
+ };
1654
+ };
1655
+ /** @description When the request is valid, but something goes wrong on the server */
1656
+ 500: {
1657
+ headers: {
1658
+ [name: string]: unknown;
1659
+ };
1660
+ content: {
1661
+ "application/json": components["schemas"]["InternalServerErrorDto"];
1662
+ };
1663
+ };
1664
+ };
1665
+ };
1666
+ SuppliersController_removeServiceArea: {
1667
+ parameters: {
1668
+ query?: never;
1669
+ header?: never;
1670
+ path: {
1671
+ id: string;
1672
+ serviceAreaId: string;
1673
+ };
1674
+ cookie?: never;
1675
+ };
1676
+ requestBody?: never;
1677
+ responses: {
1678
+ 200: {
1679
+ headers: {
1680
+ [name: string]: unknown;
1681
+ };
1682
+ content: {
1683
+ "application/json": components["schemas"]["SupplierDto"];
1684
+ };
1685
+ };
1686
+ /** @description When the ID or body request is invalid */
1687
+ 400: {
1688
+ headers: {
1689
+ [name: string]: unknown;
1690
+ };
1691
+ content: {
1692
+ "application/json": components["schemas"]["BadRequestErrorDto"];
1693
+ };
1694
+ };
1695
+ /** @description When authentication fails */
1696
+ 401: {
1697
+ headers: {
1698
+ [name: string]: unknown;
1699
+ };
1700
+ content: {
1701
+ "application/json": components["schemas"]["UnauthorizedErrorDto"];
1702
+ };
1703
+ };
1704
+ /** @description When the requesting user is not allowed to perform this action */
1705
+ 403: {
1706
+ headers: {
1707
+ [name: string]: unknown;
1708
+ };
1709
+ content: {
1710
+ "application/json": components["schemas"]["ForbiddenErrorDto"];
1711
+ };
1712
+ };
1713
+ /** @description When the supplier is not found */
1714
+ 404: {
1715
+ headers: {
1716
+ [name: string]: unknown;
1717
+ };
1718
+ content: {
1719
+ "application/json": components["schemas"]["NotFoundErrorDto"];
1720
+ };
1721
+ };
1722
+ /** @description When the request is valid, but something goes wrong on the server */
1723
+ 500: {
1724
+ headers: {
1725
+ [name: string]: unknown;
1726
+ };
1727
+ content: {
1728
+ "application/json": components["schemas"]["InternalServerErrorDto"];
1729
+ };
1730
+ };
1731
+ };
1732
+ };
1733
+ SuppliersController_updateServiceArea: {
1734
+ parameters: {
1735
+ query?: never;
1736
+ header?: never;
1737
+ path: {
1738
+ id: string;
1739
+ serviceAreaId: string;
1740
+ };
1741
+ cookie?: never;
1742
+ };
1743
+ requestBody: {
1744
+ content: {
1745
+ "application/json": components["schemas"]["UpdateServiceAreaDto"];
1746
+ };
1747
+ };
1748
+ responses: {
1749
+ 200: {
1750
+ headers: {
1751
+ [name: string]: unknown;
1752
+ };
1753
+ content: {
1754
+ "application/json": components["schemas"]["SupplierDto"];
1755
+ };
1756
+ };
1757
+ /** @description When the ID or body request is invalid */
1758
+ 400: {
1759
+ headers: {
1760
+ [name: string]: unknown;
1761
+ };
1762
+ content: {
1763
+ "application/json": components["schemas"]["BadRequestErrorDto"];
1764
+ };
1765
+ };
1766
+ /** @description When authentication fails */
1767
+ 401: {
1768
+ headers: {
1769
+ [name: string]: unknown;
1770
+ };
1771
+ content: {
1772
+ "application/json": components["schemas"]["UnauthorizedErrorDto"];
1773
+ };
1774
+ };
1775
+ /** @description When the requesting user is not allowed to perform this action */
1776
+ 403: {
1777
+ headers: {
1778
+ [name: string]: unknown;
1779
+ };
1780
+ content: {
1781
+ "application/json": components["schemas"]["ForbiddenErrorDto"];
1782
+ };
1783
+ };
1784
+ /** @description When the supplier is not found */
1785
+ 404: {
1786
+ headers: {
1787
+ [name: string]: unknown;
1788
+ };
1789
+ content: {
1790
+ "application/json": components["schemas"]["NotFoundErrorDto"];
1791
+ };
1792
+ };
1793
+ /** @description When the request is valid, but something goes wrong on the server */
1794
+ 500: {
1795
+ headers: {
1796
+ [name: string]: unknown;
1797
+ };
1798
+ content: {
1799
+ "application/json": components["schemas"]["InternalServerErrorDto"];
1800
+ };
1801
+ };
1802
+ };
1803
+ };
1804
+ SuppliersController_upsertRegion: {
1805
+ parameters: {
1806
+ query?: never;
1807
+ header?: never;
1808
+ path: {
1809
+ id: string;
1810
+ region: string;
1811
+ };
1812
+ cookie?: never;
1813
+ };
1814
+ requestBody: {
1815
+ content: {
1816
+ "application/json": components["schemas"]["UpsertSupplierRegionDto"];
1817
+ };
1818
+ };
1819
+ responses: {
1820
+ 200: {
1821
+ headers: {
1822
+ [name: string]: unknown;
1823
+ };
1824
+ content: {
1825
+ "application/json": components["schemas"]["SupplierDto"];
1826
+ };
1827
+ };
1828
+ /** @description When the ID or body request is invalid */
1829
+ 400: {
1830
+ headers: {
1831
+ [name: string]: unknown;
1832
+ };
1833
+ content: {
1834
+ "application/json": components["schemas"]["BadRequestErrorDto"];
1835
+ };
1836
+ };
1837
+ /** @description When authentication fails */
1838
+ 401: {
1839
+ headers: {
1840
+ [name: string]: unknown;
1841
+ };
1842
+ content: {
1843
+ "application/json": components["schemas"]["UnauthorizedErrorDto"];
1844
+ };
1845
+ };
1846
+ /** @description When the requesting user is not allowed to perform this action */
1847
+ 403: {
1848
+ headers: {
1849
+ [name: string]: unknown;
1850
+ };
1851
+ content: {
1852
+ "application/json": components["schemas"]["ForbiddenErrorDto"];
1853
+ };
1854
+ };
1855
+ /** @description When the supplier is not found */
1856
+ 404: {
1857
+ headers: {
1858
+ [name: string]: unknown;
1859
+ };
1860
+ content: {
1861
+ "application/json": components["schemas"]["NotFoundErrorDto"];
1862
+ };
1863
+ };
1864
+ /** @description When the request is valid, but something goes wrong on the server */
1865
+ 500: {
1866
+ headers: {
1867
+ [name: string]: unknown;
1868
+ };
1869
+ content: {
1870
+ "application/json": components["schemas"]["InternalServerErrorDto"];
1871
+ };
1872
+ };
1873
+ };
1874
+ };
1875
+ SuppliersController_removeRegion: {
1876
+ parameters: {
1877
+ query?: never;
1878
+ header?: never;
1879
+ path: {
1880
+ id: string;
1881
+ region: string;
1882
+ };
1883
+ cookie?: never;
1884
+ };
1885
+ requestBody?: never;
1886
+ responses: {
1887
+ 200: {
1888
+ headers: {
1889
+ [name: string]: unknown;
1890
+ };
1891
+ content: {
1892
+ "application/json": components["schemas"]["SupplierDto"];
1893
+ };
1894
+ };
1895
+ /** @description When the ID or body request is invalid */
1896
+ 400: {
1897
+ headers: {
1898
+ [name: string]: unknown;
1899
+ };
1900
+ content: {
1901
+ "application/json": components["schemas"]["BadRequestErrorDto"];
1902
+ };
1903
+ };
1904
+ /** @description When authentication fails */
1905
+ 401: {
1906
+ headers: {
1907
+ [name: string]: unknown;
1908
+ };
1909
+ content: {
1910
+ "application/json": components["schemas"]["UnauthorizedErrorDto"];
1911
+ };
1912
+ };
1913
+ /** @description When the requesting user is not allowed to perform this action */
1914
+ 403: {
1915
+ headers: {
1916
+ [name: string]: unknown;
1917
+ };
1918
+ content: {
1919
+ "application/json": components["schemas"]["ForbiddenErrorDto"];
1920
+ };
1921
+ };
1922
+ /** @description When the supplier is not found */
1923
+ 404: {
1924
+ headers: {
1925
+ [name: string]: unknown;
1926
+ };
1927
+ content: {
1928
+ "application/json": components["schemas"]["NotFoundErrorDto"];
1929
+ };
1930
+ };
1931
+ /** @description When the request is valid, but something goes wrong on the server */
1932
+ 500: {
1933
+ headers: {
1934
+ [name: string]: unknown;
1935
+ };
1936
+ content: {
1937
+ "application/json": components["schemas"]["InternalServerErrorDto"];
1938
+ };
1939
+ };
1940
+ };
1941
+ };
1942
+ DispatchesController_findAll: {
1943
+ parameters: {
1944
+ query?: {
1945
+ page?: number;
1946
+ limit?: number;
1947
+ supplierId?: string;
1948
+ };
1949
+ header?: never;
1950
+ path?: never;
1951
+ cookie?: never;
1952
+ };
1953
+ requestBody?: never;
1954
+ responses: {
1955
+ 200: {
1956
+ headers: {
1957
+ [name: string]: unknown;
1958
+ };
1959
+ content: {
1960
+ "application/json": {
1961
+ data: components["schemas"]["DispatchDto"][];
1962
+ paging: components["schemas"]["PagingDto"];
1963
+ };
1964
+ };
1965
+ };
1966
+ /** @description When the query request is invalid */
1967
+ 400: {
1968
+ headers: {
1969
+ [name: string]: unknown;
1970
+ };
1971
+ content: {
1972
+ "application/json": components["schemas"]["BadRequestErrorDto"];
1973
+ };
1974
+ };
1975
+ /** @description When authentication fails */
1976
+ 401: {
1977
+ headers: {
1978
+ [name: string]: unknown;
1979
+ };
1980
+ content: {
1981
+ "application/json": components["schemas"]["UnauthorizedErrorDto"];
1982
+ };
1983
+ };
1984
+ /** @description When the requesting user is not allowed to perform this action */
1985
+ 403: {
1986
+ headers: {
1987
+ [name: string]: unknown;
1988
+ };
1989
+ content: {
1990
+ "application/json": components["schemas"]["ForbiddenErrorDto"];
1991
+ };
1992
+ };
1993
+ /** @description When the request is valid, but something goes wrong on the server */
1994
+ 500: {
1995
+ headers: {
1996
+ [name: string]: unknown;
1997
+ };
1998
+ content: {
1999
+ "application/json": components["schemas"]["InternalServerErrorDto"];
2000
+ };
2001
+ };
2002
+ };
2003
+ };
2004
+ DispatchesController_create: {
2005
+ parameters: {
2006
+ query?: never;
2007
+ header?: never;
2008
+ path?: never;
2009
+ cookie?: never;
2010
+ };
2011
+ requestBody: {
2012
+ content: {
2013
+ "application/json": components["schemas"]["CreateDispatchDto"];
2014
+ };
2015
+ };
2016
+ responses: {
2017
+ 201: {
2018
+ headers: {
2019
+ [name: string]: unknown;
2020
+ };
2021
+ content: {
2022
+ "application/json": components["schemas"]["DispatchDto"];
2023
+ };
2024
+ };
2025
+ /** @description When the request is invalid */
2026
+ 400: {
2027
+ headers: {
2028
+ [name: string]: unknown;
2029
+ };
2030
+ content: {
2031
+ "application/json": components["schemas"]["BadRequestErrorDto"];
2032
+ };
2033
+ };
2034
+ /** @description When authentication fails */
2035
+ 401: {
2036
+ headers: {
2037
+ [name: string]: unknown;
2038
+ };
2039
+ content: {
2040
+ "application/json": components["schemas"]["UnauthorizedErrorDto"];
2041
+ };
2042
+ };
2043
+ /** @description When the requesting user is not allowed to perform this action */
2044
+ 403: {
2045
+ headers: {
2046
+ [name: string]: unknown;
2047
+ };
2048
+ content: {
2049
+ "application/json": components["schemas"]["ForbiddenErrorDto"];
2050
+ };
2051
+ };
2052
+ /** @description When a dispatch has been created for this project and is awaiting supplier response */
2053
+ 409: {
2054
+ headers: {
2055
+ [name: string]: unknown;
2056
+ };
2057
+ content: {
2058
+ "application/json": components["schemas"]["ConflictErrorDto"];
2059
+ };
2060
+ };
2061
+ /** @description When the request is valid, but something goes wrong on the server */
2062
+ 500: {
2063
+ headers: {
2064
+ [name: string]: unknown;
2065
+ };
2066
+ content: {
2067
+ "application/json": components["schemas"]["InternalServerErrorDto"];
2068
+ };
2069
+ };
2070
+ };
2071
+ };
2072
+ DispatchesController_updateStatus: {
2073
+ parameters: {
2074
+ query?: never;
2075
+ header?: never;
2076
+ path: {
2077
+ id: string;
2078
+ };
2079
+ cookie?: never;
2080
+ };
2081
+ requestBody: {
2082
+ content: {
2083
+ "application/json": components["schemas"]["UpdateDispatchStatusDto"];
2084
+ };
2085
+ };
2086
+ responses: {
2087
+ 200: {
2088
+ headers: {
2089
+ [name: string]: unknown;
2090
+ };
2091
+ content: {
2092
+ "application/json": components["schemas"]["DispatchDto"];
2093
+ };
2094
+ };
2095
+ /** @description When the ID or body request is invalid */
2096
+ 400: {
2097
+ headers: {
2098
+ [name: string]: unknown;
2099
+ };
2100
+ content: {
2101
+ "application/json": components["schemas"]["BadRequestErrorDto"];
2102
+ };
2103
+ };
2104
+ /** @description When authentication fails */
2105
+ 401: {
2106
+ headers: {
2107
+ [name: string]: unknown;
2108
+ };
2109
+ content: {
2110
+ "application/json": components["schemas"]["UnauthorizedErrorDto"];
2111
+ };
2112
+ };
2113
+ /** @description When the requesting user is not allowed to perform this action */
2114
+ 403: {
2115
+ headers: {
2116
+ [name: string]: unknown;
2117
+ };
2118
+ content: {
2119
+ "application/json": components["schemas"]["ForbiddenErrorDto"];
2120
+ };
2121
+ };
2122
+ /** @description When the dispatch is not found */
2123
+ 404: {
2124
+ headers: {
2125
+ [name: string]: unknown;
2126
+ };
2127
+ content: {
2128
+ "application/json": components["schemas"]["NotFoundErrorDto"];
2129
+ };
2130
+ };
2131
+ /** @description When the request is valid, but something goes wrong on the server */
2132
+ 500: {
2133
+ headers: {
2134
+ [name: string]: unknown;
2135
+ };
2136
+ content: {
2137
+ "application/json": components["schemas"]["InternalServerErrorDto"];
2138
+ };
2139
+ };
2140
+ };
2141
+ };
2142
+ }