@palmetto/dispatch-sdk 0.5.0 → 0.7.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.
- package/dist/__generated__/schema.d.ts +539 -339
- package/dist/client.d.ts +5 -0
- package/dist/client.js +19 -5
- package/dist/client.js.map +1 -1
- package/package.json +2 -1
|
@@ -50,43 +50,42 @@ export interface paths {
|
|
|
50
50
|
patch: operations["ProjectsController_update"];
|
|
51
51
|
trace?: never;
|
|
52
52
|
};
|
|
53
|
-
"/api/
|
|
53
|
+
"/api/dispatches": {
|
|
54
54
|
parameters: {
|
|
55
55
|
query?: never;
|
|
56
56
|
header?: never;
|
|
57
57
|
path?: never;
|
|
58
58
|
cookie?: never;
|
|
59
59
|
};
|
|
60
|
-
/** Find All
|
|
61
|
-
get: operations["
|
|
60
|
+
/** Find All Dispatches */
|
|
61
|
+
get: operations["DispatchesController_findAll"];
|
|
62
62
|
put?: never;
|
|
63
|
-
/** Create
|
|
64
|
-
post: operations["
|
|
63
|
+
/** Create Dispatch */
|
|
64
|
+
post: operations["DispatchesController_create"];
|
|
65
65
|
delete?: never;
|
|
66
66
|
options?: never;
|
|
67
67
|
head?: never;
|
|
68
68
|
patch?: never;
|
|
69
69
|
trace?: never;
|
|
70
70
|
};
|
|
71
|
-
"/api/
|
|
71
|
+
"/api/dispatches/{id}": {
|
|
72
72
|
parameters: {
|
|
73
73
|
query?: never;
|
|
74
74
|
header?: never;
|
|
75
75
|
path?: never;
|
|
76
76
|
cookie?: never;
|
|
77
77
|
};
|
|
78
|
-
/** Find
|
|
79
|
-
get: operations["
|
|
78
|
+
/** Find Dispatch By ID */
|
|
79
|
+
get: operations["DispatchesController_findOne"];
|
|
80
80
|
put?: never;
|
|
81
81
|
post?: never;
|
|
82
82
|
delete?: never;
|
|
83
83
|
options?: never;
|
|
84
84
|
head?: never;
|
|
85
|
-
|
|
86
|
-
patch: operations["SuppliersController_update"];
|
|
85
|
+
patch?: never;
|
|
87
86
|
trace?: never;
|
|
88
87
|
};
|
|
89
|
-
"/api/
|
|
88
|
+
"/api/dispatches/{id}/status": {
|
|
90
89
|
parameters: {
|
|
91
90
|
query?: never;
|
|
92
91
|
header?: never;
|
|
@@ -99,8 +98,27 @@ export interface paths {
|
|
|
99
98
|
delete?: never;
|
|
100
99
|
options?: never;
|
|
101
100
|
head?: never;
|
|
102
|
-
/** Update
|
|
103
|
-
patch: operations["
|
|
101
|
+
/** Update Dispatch Status */
|
|
102
|
+
patch: operations["DispatchesController_updateStatus"];
|
|
103
|
+
trace?: never;
|
|
104
|
+
};
|
|
105
|
+
"/api/coverage-areas/{id}": {
|
|
106
|
+
parameters: {
|
|
107
|
+
query?: never;
|
|
108
|
+
header?: never;
|
|
109
|
+
path?: never;
|
|
110
|
+
cookie?: never;
|
|
111
|
+
};
|
|
112
|
+
/** Get a coverage area */
|
|
113
|
+
get: operations["CoverageAreasController_findOne"];
|
|
114
|
+
put?: never;
|
|
115
|
+
post?: never;
|
|
116
|
+
/** Remove a coverage area */
|
|
117
|
+
delete: operations["CoverageAreasController_remove"];
|
|
118
|
+
options?: never;
|
|
119
|
+
head?: never;
|
|
120
|
+
/** Update a coverage area */
|
|
121
|
+
patch: operations["CoverageAreasController_update"];
|
|
104
122
|
trace?: never;
|
|
105
123
|
};
|
|
106
124
|
"/api/suppliers/{id}/regions": {
|
|
@@ -146,7 +164,7 @@ export interface paths {
|
|
|
146
164
|
path?: never;
|
|
147
165
|
cookie?: never;
|
|
148
166
|
};
|
|
149
|
-
/**
|
|
167
|
+
/** Get coverage areas for a supplier region */
|
|
150
168
|
get: operations["SupplierRegionsController_getCoverageAreas"];
|
|
151
169
|
put?: never;
|
|
152
170
|
/** Create a new coverage area */
|
|
@@ -157,61 +175,43 @@ export interface paths {
|
|
|
157
175
|
patch?: never;
|
|
158
176
|
trace?: never;
|
|
159
177
|
};
|
|
160
|
-
"/api/
|
|
161
|
-
parameters: {
|
|
162
|
-
query?: never;
|
|
163
|
-
header?: never;
|
|
164
|
-
path?: never;
|
|
165
|
-
cookie?: never;
|
|
166
|
-
};
|
|
167
|
-
/** Get a coverage area */
|
|
168
|
-
get: operations["CoverageAreasController_findOne"];
|
|
169
|
-
put?: never;
|
|
170
|
-
post?: never;
|
|
171
|
-
/** Remove a coverage area */
|
|
172
|
-
delete: operations["CoverageAreasController_remove"];
|
|
173
|
-
options?: never;
|
|
174
|
-
head?: never;
|
|
175
|
-
/** Update a coverage area */
|
|
176
|
-
patch: operations["CoverageAreasController_update"];
|
|
177
|
-
trace?: never;
|
|
178
|
-
};
|
|
179
|
-
"/api/dispatches": {
|
|
178
|
+
"/api/suppliers": {
|
|
180
179
|
parameters: {
|
|
181
180
|
query?: never;
|
|
182
181
|
header?: never;
|
|
183
182
|
path?: never;
|
|
184
183
|
cookie?: never;
|
|
185
184
|
};
|
|
186
|
-
/** Find All
|
|
187
|
-
get: operations["
|
|
185
|
+
/** Find All Suppliers */
|
|
186
|
+
get: operations["SuppliersController_findAll"];
|
|
188
187
|
put?: never;
|
|
189
|
-
/** Create
|
|
190
|
-
post: operations["
|
|
188
|
+
/** Create Supplier */
|
|
189
|
+
post: operations["SuppliersController_create"];
|
|
191
190
|
delete?: never;
|
|
192
191
|
options?: never;
|
|
193
192
|
head?: never;
|
|
194
193
|
patch?: never;
|
|
195
194
|
trace?: never;
|
|
196
195
|
};
|
|
197
|
-
"/api/
|
|
196
|
+
"/api/suppliers/{id}": {
|
|
198
197
|
parameters: {
|
|
199
198
|
query?: never;
|
|
200
199
|
header?: never;
|
|
201
200
|
path?: never;
|
|
202
201
|
cookie?: never;
|
|
203
202
|
};
|
|
204
|
-
/** Find
|
|
205
|
-
get: operations["
|
|
203
|
+
/** Find Supplier By ID */
|
|
204
|
+
get: operations["SuppliersController_findOne"];
|
|
206
205
|
put?: never;
|
|
207
206
|
post?: never;
|
|
208
207
|
delete?: never;
|
|
209
208
|
options?: never;
|
|
210
209
|
head?: never;
|
|
211
|
-
|
|
210
|
+
/** Update Supplier */
|
|
211
|
+
patch: operations["SuppliersController_update"];
|
|
212
212
|
trace?: never;
|
|
213
213
|
};
|
|
214
|
-
"/api/
|
|
214
|
+
"/api/suppliers/{id}/status": {
|
|
215
215
|
parameters: {
|
|
216
216
|
query?: never;
|
|
217
217
|
header?: never;
|
|
@@ -224,8 +224,8 @@ export interface paths {
|
|
|
224
224
|
delete?: never;
|
|
225
225
|
options?: never;
|
|
226
226
|
head?: never;
|
|
227
|
-
/** Update
|
|
228
|
-
patch: operations["
|
|
227
|
+
/** Update Supplier Status */
|
|
228
|
+
patch: operations["SuppliersController_updateStatus"];
|
|
229
229
|
trace?: never;
|
|
230
230
|
};
|
|
231
231
|
}
|
|
@@ -575,118 +575,58 @@ export interface components {
|
|
|
575
575
|
/** @example Technical error description */
|
|
576
576
|
reason: string;
|
|
577
577
|
};
|
|
578
|
-
|
|
579
|
-
|
|
580
|
-
|
|
581
|
-
|
|
582
|
-
|
|
583
|
-
|
|
584
|
-
|
|
585
|
-
|
|
586
|
-
|
|
587
|
-
};
|
|
588
|
-
/** @example Solar Company */
|
|
589
|
-
name: string;
|
|
590
|
-
address: {
|
|
591
|
-
/** @example 4 Bonnie Dr */
|
|
592
|
-
streetAddress: string;
|
|
593
|
-
/** @example Berkley */
|
|
594
|
-
locality: string;
|
|
595
|
-
/** @example MA */
|
|
596
|
-
region: string;
|
|
597
|
-
/** @example 02779 */
|
|
598
|
-
postalCode: string;
|
|
599
|
-
/** @example US */
|
|
600
|
-
country: string;
|
|
601
|
-
coordinates: {
|
|
602
|
-
/** @example 41.8714689 */
|
|
603
|
-
lat: number;
|
|
604
|
-
/** @example -71.0950429 */
|
|
605
|
-
lon: number;
|
|
606
|
-
};
|
|
607
|
-
};
|
|
608
|
-
aspects: {
|
|
609
|
-
/** @example 2.5 */
|
|
610
|
-
minPpw: number;
|
|
611
|
-
/**
|
|
612
|
-
* @example [
|
|
613
|
-
* "SOLAR",
|
|
614
|
-
* "STORAGE"
|
|
615
|
-
* ]
|
|
616
|
-
*/
|
|
617
|
-
supportedProducts: ("SOLAR" | "STORAGE")[];
|
|
618
|
-
/**
|
|
619
|
-
* @example ELITE
|
|
620
|
-
* @enum {string}
|
|
621
|
-
*/
|
|
622
|
-
tier: "PLATINUM" | "ELITE" | "PRO" | "CERTIFIED";
|
|
623
|
-
};
|
|
578
|
+
CreateDispatchDto: {
|
|
579
|
+
projectId: string;
|
|
580
|
+
};
|
|
581
|
+
DispatchDto: {
|
|
582
|
+
id: string;
|
|
583
|
+
/** @example 507f1f77bcf86cd799439011 */
|
|
584
|
+
projectId: string;
|
|
585
|
+
/** @example 507f1f77bcf86cd799439012 */
|
|
586
|
+
supplierId: string;
|
|
624
587
|
status: {
|
|
625
588
|
/** @constant */
|
|
626
|
-
code: "
|
|
589
|
+
code: "PENDING";
|
|
590
|
+
/** Format: date-time */
|
|
591
|
+
statusUpdatedAt: string;
|
|
627
592
|
} | {
|
|
628
593
|
/** @constant */
|
|
629
|
-
code: "
|
|
630
|
-
|
|
631
|
-
|
|
632
|
-
|
|
633
|
-
|
|
634
|
-
|
|
635
|
-
/** @example org_12345 */
|
|
636
|
-
id: string;
|
|
637
|
-
/**
|
|
638
|
-
* @example LIGHT_REACH
|
|
639
|
-
* @enum {string}
|
|
640
|
-
*/
|
|
641
|
-
type: "LIGHT_REACH";
|
|
642
|
-
};
|
|
643
|
-
/** @example Solar Company */
|
|
644
|
-
name: string;
|
|
645
|
-
address: {
|
|
646
|
-
/** @example 4 Bonnie Dr */
|
|
647
|
-
streetAddress: string;
|
|
648
|
-
/** @example Berkley */
|
|
649
|
-
locality: string;
|
|
650
|
-
/** @example MA */
|
|
651
|
-
region: string;
|
|
652
|
-
/** @example 02779 */
|
|
653
|
-
postalCode: string;
|
|
654
|
-
/** @example US */
|
|
655
|
-
country: string;
|
|
656
|
-
coordinates: {
|
|
657
|
-
/** @example 41.8714689 */
|
|
658
|
-
lat: number;
|
|
659
|
-
/** @example -71.0950429 */
|
|
660
|
-
lon: number;
|
|
661
|
-
};
|
|
662
|
-
};
|
|
663
|
-
aspects: {
|
|
664
|
-
/** @example 2.5 */
|
|
665
|
-
minPpw: number;
|
|
666
|
-
/**
|
|
667
|
-
* @example [
|
|
668
|
-
* "SOLAR",
|
|
669
|
-
* "STORAGE"
|
|
670
|
-
* ]
|
|
671
|
-
*/
|
|
672
|
-
supportedProducts: ("SOLAR" | "STORAGE")[];
|
|
594
|
+
code: "ACCEPTED";
|
|
595
|
+
/** Format: date-time */
|
|
596
|
+
statusUpdatedAt: string;
|
|
597
|
+
} | {
|
|
598
|
+
/** @constant */
|
|
599
|
+
code: "REJECTED";
|
|
673
600
|
/**
|
|
674
|
-
* @example
|
|
601
|
+
* @example CAPACITY
|
|
675
602
|
* @enum {string}
|
|
676
603
|
*/
|
|
677
|
-
|
|
678
|
-
};
|
|
679
|
-
status: {
|
|
680
|
-
/** @constant */
|
|
681
|
-
code: "ACTIVE";
|
|
604
|
+
reason: "CAPACITY" | "EQUIPEMENT" | "DISTANCE" | "PRICING" | "NOT_INTERESTED" | "OTHER";
|
|
682
605
|
/** Format: date-time */
|
|
683
606
|
statusUpdatedAt: string;
|
|
684
607
|
} | {
|
|
685
608
|
/** @constant */
|
|
686
|
-
code: "
|
|
609
|
+
code: "WITHDRAWN";
|
|
610
|
+
/**
|
|
611
|
+
* @example EXPIRED
|
|
612
|
+
* @enum {string}
|
|
613
|
+
*/
|
|
614
|
+
reason: "EXPIRED" | "MANUAL";
|
|
687
615
|
/** Format: date-time */
|
|
688
616
|
statusUpdatedAt: string;
|
|
689
617
|
};
|
|
618
|
+
/** Format: date-time */
|
|
619
|
+
offeredAt: string;
|
|
620
|
+
/** Format: date-time */
|
|
621
|
+
respondedAt?: string;
|
|
622
|
+
/** Format: date-time */
|
|
623
|
+
expiresAt: string;
|
|
624
|
+
match: {
|
|
625
|
+
/** @example 507f1f77bcf86cd799439011 */
|
|
626
|
+
supplierId: string;
|
|
627
|
+
/** @example 0.85 */
|
|
628
|
+
weight: number;
|
|
629
|
+
}[];
|
|
690
630
|
meta: {
|
|
691
631
|
/**
|
|
692
632
|
* Format: date-time
|
|
@@ -711,9 +651,30 @@ export interface components {
|
|
|
711
651
|
deletedBy?: string;
|
|
712
652
|
};
|
|
713
653
|
};
|
|
714
|
-
|
|
715
|
-
|
|
716
|
-
|
|
654
|
+
UpdateDispatchStatusDto: {
|
|
655
|
+
status: {
|
|
656
|
+
/** @constant */
|
|
657
|
+
code: "ACCEPTED";
|
|
658
|
+
} | {
|
|
659
|
+
/** @constant */
|
|
660
|
+
code: "REJECTED";
|
|
661
|
+
/**
|
|
662
|
+
* @example CAPACITY
|
|
663
|
+
* @enum {string}
|
|
664
|
+
*/
|
|
665
|
+
reason: "CAPACITY" | "EQUIPEMENT" | "DISTANCE" | "PRICING" | "NOT_INTERESTED" | "OTHER";
|
|
666
|
+
} | {
|
|
667
|
+
/** @constant */
|
|
668
|
+
code: "WITHDRAWN";
|
|
669
|
+
/** @enum {string} */
|
|
670
|
+
reason: "MANUAL";
|
|
671
|
+
};
|
|
672
|
+
};
|
|
673
|
+
CoverageAreaDto: {
|
|
674
|
+
id: string;
|
|
675
|
+
supplierId: string;
|
|
676
|
+
supplierRegionId: string;
|
|
677
|
+
address: {
|
|
717
678
|
/** @example 4 Bonnie Dr */
|
|
718
679
|
streetAddress: string;
|
|
719
680
|
/** @example Berkley */
|
|
@@ -731,14 +692,25 @@ export interface components {
|
|
|
731
692
|
lon: number;
|
|
732
693
|
};
|
|
733
694
|
};
|
|
734
|
-
|
|
735
|
-
|
|
736
|
-
|
|
737
|
-
|
|
738
|
-
|
|
739
|
-
|
|
740
|
-
/** @
|
|
741
|
-
|
|
695
|
+
radius: {
|
|
696
|
+
/**
|
|
697
|
+
* @example MILES
|
|
698
|
+
* @enum {string}
|
|
699
|
+
*/
|
|
700
|
+
unit: "MILES" | "METERS";
|
|
701
|
+
/** @example 50 */
|
|
702
|
+
value: number;
|
|
703
|
+
};
|
|
704
|
+
};
|
|
705
|
+
UpdateCoverageAreaDto: {
|
|
706
|
+
radius: {
|
|
707
|
+
/**
|
|
708
|
+
* @example MILES
|
|
709
|
+
* @enum {string}
|
|
710
|
+
*/
|
|
711
|
+
unit: "MILES" | "METERS";
|
|
712
|
+
/** @example 50 */
|
|
713
|
+
value: number;
|
|
742
714
|
};
|
|
743
715
|
};
|
|
744
716
|
CreateSupplierRegionDto: {
|
|
@@ -803,10 +775,18 @@ export interface components {
|
|
|
803
775
|
value: number;
|
|
804
776
|
};
|
|
805
777
|
};
|
|
806
|
-
|
|
807
|
-
|
|
808
|
-
|
|
809
|
-
|
|
778
|
+
CreateSupplierDto: {
|
|
779
|
+
organization: {
|
|
780
|
+
/** @example org_12345 */
|
|
781
|
+
id: string;
|
|
782
|
+
/**
|
|
783
|
+
* @example LIGHT_REACH
|
|
784
|
+
* @enum {string}
|
|
785
|
+
*/
|
|
786
|
+
type: "LIGHT_REACH";
|
|
787
|
+
};
|
|
788
|
+
/** @example Solar Company */
|
|
789
|
+
name: string;
|
|
810
790
|
address: {
|
|
811
791
|
/** @example 4 Bonnie Dr */
|
|
812
792
|
streetAddress: string;
|
|
@@ -825,74 +805,88 @@ export interface components {
|
|
|
825
805
|
lon: number;
|
|
826
806
|
};
|
|
827
807
|
};
|
|
828
|
-
|
|
808
|
+
aspects: {
|
|
809
|
+
/** @example 2.5 */
|
|
810
|
+
minPpw: number;
|
|
829
811
|
/**
|
|
830
|
-
* @example
|
|
831
|
-
*
|
|
812
|
+
* @example [
|
|
813
|
+
* "SOLAR",
|
|
814
|
+
* "STORAGE"
|
|
815
|
+
* ]
|
|
832
816
|
*/
|
|
833
|
-
|
|
834
|
-
/** @example 50 */
|
|
835
|
-
value: number;
|
|
836
|
-
};
|
|
837
|
-
};
|
|
838
|
-
UpdateCoverageAreaDto: {
|
|
839
|
-
radius: {
|
|
817
|
+
supportedProducts: ("SOLAR" | "STORAGE")[];
|
|
840
818
|
/**
|
|
841
|
-
* @example
|
|
819
|
+
* @example ELITE
|
|
842
820
|
* @enum {string}
|
|
843
821
|
*/
|
|
844
|
-
|
|
845
|
-
/** @example 50 */
|
|
846
|
-
value: number;
|
|
822
|
+
tier: "PLATINUM" | "ELITE" | "PRO" | "CERTIFIED";
|
|
847
823
|
};
|
|
848
|
-
};
|
|
849
|
-
CreateDispatchDto: {
|
|
850
|
-
projectId: string;
|
|
851
|
-
};
|
|
852
|
-
DispatchDto: {
|
|
853
|
-
id: string;
|
|
854
|
-
/** @example 507f1f77bcf86cd799439011 */
|
|
855
|
-
projectId: string;
|
|
856
|
-
/** @example 507f1f77bcf86cd799439012 */
|
|
857
|
-
supplierId: string;
|
|
858
824
|
status: {
|
|
859
825
|
/** @constant */
|
|
860
|
-
code: "
|
|
861
|
-
/** Format: date-time */
|
|
862
|
-
statusUpdatedAt: string;
|
|
863
|
-
} | {
|
|
864
|
-
/** @constant */
|
|
865
|
-
code: "ACCEPTED";
|
|
866
|
-
/** Format: date-time */
|
|
867
|
-
statusUpdatedAt: string;
|
|
826
|
+
code: "ACTIVE";
|
|
868
827
|
} | {
|
|
869
828
|
/** @constant */
|
|
870
|
-
code: "
|
|
829
|
+
code: "INACTIVE";
|
|
830
|
+
};
|
|
831
|
+
};
|
|
832
|
+
SupplierDto: {
|
|
833
|
+
id: string;
|
|
834
|
+
organization: {
|
|
835
|
+
/** @example org_12345 */
|
|
836
|
+
id: string;
|
|
871
837
|
/**
|
|
872
|
-
* @example
|
|
838
|
+
* @example LIGHT_REACH
|
|
873
839
|
* @enum {string}
|
|
874
840
|
*/
|
|
875
|
-
|
|
841
|
+
type: "LIGHT_REACH";
|
|
842
|
+
};
|
|
843
|
+
/** @example Solar Company */
|
|
844
|
+
name: string;
|
|
845
|
+
address: {
|
|
846
|
+
/** @example 4 Bonnie Dr */
|
|
847
|
+
streetAddress: string;
|
|
848
|
+
/** @example Berkley */
|
|
849
|
+
locality: string;
|
|
850
|
+
/** @example MA */
|
|
851
|
+
region: string;
|
|
852
|
+
/** @example 02779 */
|
|
853
|
+
postalCode: string;
|
|
854
|
+
/** @example US */
|
|
855
|
+
country: string;
|
|
856
|
+
coordinates: {
|
|
857
|
+
/** @example 41.8714689 */
|
|
858
|
+
lat: number;
|
|
859
|
+
/** @example -71.0950429 */
|
|
860
|
+
lon: number;
|
|
861
|
+
};
|
|
862
|
+
};
|
|
863
|
+
aspects: {
|
|
864
|
+
/** @example 2.5 */
|
|
865
|
+
minPpw: number;
|
|
866
|
+
/**
|
|
867
|
+
* @example [
|
|
868
|
+
* "SOLAR",
|
|
869
|
+
* "STORAGE"
|
|
870
|
+
* ]
|
|
871
|
+
*/
|
|
872
|
+
supportedProducts: ("SOLAR" | "STORAGE")[];
|
|
873
|
+
/**
|
|
874
|
+
* @example ELITE
|
|
875
|
+
* @enum {string}
|
|
876
|
+
*/
|
|
877
|
+
tier: "PLATINUM" | "ELITE" | "PRO" | "CERTIFIED";
|
|
878
|
+
};
|
|
879
|
+
status: {
|
|
880
|
+
/** @constant */
|
|
881
|
+
code: "ACTIVE";
|
|
876
882
|
/** Format: date-time */
|
|
877
883
|
statusUpdatedAt: string;
|
|
878
884
|
} | {
|
|
879
885
|
/** @constant */
|
|
880
|
-
code: "
|
|
886
|
+
code: "INACTIVE";
|
|
881
887
|
/** Format: date-time */
|
|
882
888
|
statusUpdatedAt: string;
|
|
883
889
|
};
|
|
884
|
-
/** Format: date-time */
|
|
885
|
-
offeredAt: string;
|
|
886
|
-
/** Format: date-time */
|
|
887
|
-
respondedAt?: string;
|
|
888
|
-
/** Format: date-time */
|
|
889
|
-
expiresAt: string;
|
|
890
|
-
match: {
|
|
891
|
-
/** @example 507f1f77bcf86cd799439011 */
|
|
892
|
-
supplierId: string;
|
|
893
|
-
/** @example 0.85 */
|
|
894
|
-
weight: number;
|
|
895
|
-
}[];
|
|
896
890
|
meta: {
|
|
897
891
|
/**
|
|
898
892
|
* Format: date-time
|
|
@@ -917,24 +911,34 @@ export interface components {
|
|
|
917
911
|
deletedBy?: string;
|
|
918
912
|
};
|
|
919
913
|
};
|
|
920
|
-
|
|
914
|
+
UpdateSupplierDto: {
|
|
915
|
+
name?: string;
|
|
916
|
+
address?: {
|
|
917
|
+
/** @example 4 Bonnie Dr */
|
|
918
|
+
streetAddress: string;
|
|
919
|
+
/** @example Berkley */
|
|
920
|
+
locality: string;
|
|
921
|
+
/** @example MA */
|
|
922
|
+
region: string;
|
|
923
|
+
/** @example 02779 */
|
|
924
|
+
postalCode: string;
|
|
925
|
+
/** @example US */
|
|
926
|
+
country: string;
|
|
927
|
+
coordinates: {
|
|
928
|
+
/** @example 41.8714689 */
|
|
929
|
+
lat: number;
|
|
930
|
+
/** @example -71.0950429 */
|
|
931
|
+
lon: number;
|
|
932
|
+
};
|
|
933
|
+
};
|
|
934
|
+
};
|
|
935
|
+
UpdateSupplierStatusDto: {
|
|
921
936
|
status: {
|
|
922
937
|
/** @constant */
|
|
923
|
-
code: "
|
|
924
|
-
} | {
|
|
925
|
-
/** @constant */
|
|
926
|
-
code: "ACCEPTED";
|
|
927
|
-
} | {
|
|
928
|
-
/** @constant */
|
|
929
|
-
code: "REJECTED";
|
|
930
|
-
/**
|
|
931
|
-
* @example CAPACITY
|
|
932
|
-
* @enum {string}
|
|
933
|
-
*/
|
|
934
|
-
reason: "CAPACITY" | "EQUIPEMENT" | "DISTANCE" | "PRICING" | "NOT_INTERESTED" | "OTHER";
|
|
938
|
+
code: "ACTIVE";
|
|
935
939
|
} | {
|
|
936
940
|
/** @constant */
|
|
937
|
-
code: "
|
|
941
|
+
code: "INACTIVE";
|
|
938
942
|
};
|
|
939
943
|
};
|
|
940
944
|
};
|
|
@@ -1176,19 +1180,12 @@ export interface operations {
|
|
|
1176
1180
|
};
|
|
1177
1181
|
};
|
|
1178
1182
|
};
|
|
1179
|
-
|
|
1183
|
+
DispatchesController_findAll: {
|
|
1180
1184
|
parameters: {
|
|
1181
1185
|
query?: {
|
|
1182
1186
|
page?: number;
|
|
1183
1187
|
limit?: number;
|
|
1184
|
-
|
|
1185
|
-
name?: string;
|
|
1186
|
-
"status.code"?: "ACTIVE" | "INACTIVE";
|
|
1187
|
-
"aspects.minPpw"?: number;
|
|
1188
|
-
"aspects.supportedProducts"?: "SOLAR" | "STORAGE";
|
|
1189
|
-
"aspects.tier"?: "PLATINUM" | "ELITE" | "PRO" | "CERTIFIED";
|
|
1190
|
-
"regions.region"?: string;
|
|
1191
|
-
"regions.capacity"?: number;
|
|
1188
|
+
supplierId?: string;
|
|
1192
1189
|
};
|
|
1193
1190
|
header?: never;
|
|
1194
1191
|
path?: never;
|
|
@@ -1202,12 +1199,12 @@ export interface operations {
|
|
|
1202
1199
|
};
|
|
1203
1200
|
content: {
|
|
1204
1201
|
"application/json": {
|
|
1205
|
-
data: components["schemas"]["
|
|
1202
|
+
data: components["schemas"]["DispatchDto"][];
|
|
1206
1203
|
paging: components["schemas"]["PagingDto"];
|
|
1207
1204
|
};
|
|
1208
1205
|
};
|
|
1209
1206
|
};
|
|
1210
|
-
/** @description When the request is invalid */
|
|
1207
|
+
/** @description When the query request is invalid */
|
|
1211
1208
|
400: {
|
|
1212
1209
|
headers: {
|
|
1213
1210
|
[name: string]: unknown;
|
|
@@ -1245,7 +1242,7 @@ export interface operations {
|
|
|
1245
1242
|
};
|
|
1246
1243
|
};
|
|
1247
1244
|
};
|
|
1248
|
-
|
|
1245
|
+
DispatchesController_create: {
|
|
1249
1246
|
parameters: {
|
|
1250
1247
|
query?: never;
|
|
1251
1248
|
header?: never;
|
|
@@ -1254,17 +1251,15 @@ export interface operations {
|
|
|
1254
1251
|
};
|
|
1255
1252
|
requestBody: {
|
|
1256
1253
|
content: {
|
|
1257
|
-
"application/json": components["schemas"]["
|
|
1254
|
+
"application/json": components["schemas"]["CreateDispatchDto"];
|
|
1258
1255
|
};
|
|
1259
1256
|
};
|
|
1260
1257
|
responses: {
|
|
1261
|
-
|
|
1258
|
+
204: {
|
|
1262
1259
|
headers: {
|
|
1263
1260
|
[name: string]: unknown;
|
|
1264
1261
|
};
|
|
1265
|
-
content
|
|
1266
|
-
"application/json": components["schemas"]["SupplierDto"];
|
|
1267
|
-
};
|
|
1262
|
+
content?: never;
|
|
1268
1263
|
};
|
|
1269
1264
|
/** @description When the request is invalid */
|
|
1270
1265
|
400: {
|
|
@@ -1293,7 +1288,7 @@ export interface operations {
|
|
|
1293
1288
|
"application/json": components["schemas"]["ForbiddenErrorDto"];
|
|
1294
1289
|
};
|
|
1295
1290
|
};
|
|
1296
|
-
/** @description When
|
|
1291
|
+
/** @description When a dispatch has been created for this project and is awaiting supplier response */
|
|
1297
1292
|
409: {
|
|
1298
1293
|
headers: {
|
|
1299
1294
|
[name: string]: unknown;
|
|
@@ -1313,7 +1308,7 @@ export interface operations {
|
|
|
1313
1308
|
};
|
|
1314
1309
|
};
|
|
1315
1310
|
};
|
|
1316
|
-
|
|
1311
|
+
DispatchesController_findOne: {
|
|
1317
1312
|
parameters: {
|
|
1318
1313
|
query?: never;
|
|
1319
1314
|
header?: never;
|
|
@@ -1329,7 +1324,7 @@ export interface operations {
|
|
|
1329
1324
|
[name: string]: unknown;
|
|
1330
1325
|
};
|
|
1331
1326
|
content: {
|
|
1332
|
-
"application/json": components["schemas"]["
|
|
1327
|
+
"application/json": components["schemas"]["DispatchDto"];
|
|
1333
1328
|
};
|
|
1334
1329
|
};
|
|
1335
1330
|
/** @description When the ID is invalid */
|
|
@@ -1359,7 +1354,7 @@ export interface operations {
|
|
|
1359
1354
|
"application/json": components["schemas"]["ForbiddenErrorDto"];
|
|
1360
1355
|
};
|
|
1361
1356
|
};
|
|
1362
|
-
/** @description When the
|
|
1357
|
+
/** @description When the dispatch is not found */
|
|
1363
1358
|
404: {
|
|
1364
1359
|
headers: {
|
|
1365
1360
|
[name: string]: unknown;
|
|
@@ -1379,7 +1374,7 @@ export interface operations {
|
|
|
1379
1374
|
};
|
|
1380
1375
|
};
|
|
1381
1376
|
};
|
|
1382
|
-
|
|
1377
|
+
DispatchesController_updateStatus: {
|
|
1383
1378
|
parameters: {
|
|
1384
1379
|
query?: never;
|
|
1385
1380
|
header?: never;
|
|
@@ -1390,7 +1385,7 @@ export interface operations {
|
|
|
1390
1385
|
};
|
|
1391
1386
|
requestBody: {
|
|
1392
1387
|
content: {
|
|
1393
|
-
"application/json": components["schemas"]["
|
|
1388
|
+
"application/json": components["schemas"]["UpdateDispatchStatusDto"];
|
|
1394
1389
|
};
|
|
1395
1390
|
};
|
|
1396
1391
|
responses: {
|
|
@@ -1399,10 +1394,10 @@ export interface operations {
|
|
|
1399
1394
|
[name: string]: unknown;
|
|
1400
1395
|
};
|
|
1401
1396
|
content: {
|
|
1402
|
-
"application/json": components["schemas"]["
|
|
1397
|
+
"application/json": components["schemas"]["DispatchDto"];
|
|
1403
1398
|
};
|
|
1404
1399
|
};
|
|
1405
|
-
/** @description When the request is invalid */
|
|
1400
|
+
/** @description When the ID or body request is invalid */
|
|
1406
1401
|
400: {
|
|
1407
1402
|
headers: {
|
|
1408
1403
|
[name: string]: unknown;
|
|
@@ -1429,7 +1424,7 @@ export interface operations {
|
|
|
1429
1424
|
"application/json": components["schemas"]["ForbiddenErrorDto"];
|
|
1430
1425
|
};
|
|
1431
1426
|
};
|
|
1432
|
-
/** @description When the
|
|
1427
|
+
/** @description When the dispatch is not found */
|
|
1433
1428
|
404: {
|
|
1434
1429
|
headers: {
|
|
1435
1430
|
[name: string]: unknown;
|
|
@@ -1449,7 +1444,7 @@ export interface operations {
|
|
|
1449
1444
|
};
|
|
1450
1445
|
};
|
|
1451
1446
|
};
|
|
1452
|
-
|
|
1447
|
+
CoverageAreasController_findOne: {
|
|
1453
1448
|
parameters: {
|
|
1454
1449
|
query?: never;
|
|
1455
1450
|
header?: never;
|
|
@@ -1458,21 +1453,17 @@ export interface operations {
|
|
|
1458
1453
|
};
|
|
1459
1454
|
cookie?: never;
|
|
1460
1455
|
};
|
|
1461
|
-
requestBody
|
|
1462
|
-
content: {
|
|
1463
|
-
"application/json": components["schemas"]["UpdateSupplierStatusDto"];
|
|
1464
|
-
};
|
|
1465
|
-
};
|
|
1456
|
+
requestBody?: never;
|
|
1466
1457
|
responses: {
|
|
1467
1458
|
200: {
|
|
1468
1459
|
headers: {
|
|
1469
1460
|
[name: string]: unknown;
|
|
1470
1461
|
};
|
|
1471
1462
|
content: {
|
|
1472
|
-
"application/json": components["schemas"]["
|
|
1463
|
+
"application/json": components["schemas"]["CoverageAreaDto"];
|
|
1473
1464
|
};
|
|
1474
1465
|
};
|
|
1475
|
-
/** @description When the
|
|
1466
|
+
/** @description When the request is invalid */
|
|
1476
1467
|
400: {
|
|
1477
1468
|
headers: {
|
|
1478
1469
|
[name: string]: unknown;
|
|
@@ -1499,7 +1490,7 @@ export interface operations {
|
|
|
1499
1490
|
"application/json": components["schemas"]["ForbiddenErrorDto"];
|
|
1500
1491
|
};
|
|
1501
1492
|
};
|
|
1502
|
-
/** @description When the
|
|
1493
|
+
/** @description When the coverage area is not found */
|
|
1503
1494
|
404: {
|
|
1504
1495
|
headers: {
|
|
1505
1496
|
[name: string]: unknown;
|
|
@@ -1519,7 +1510,7 @@ export interface operations {
|
|
|
1519
1510
|
};
|
|
1520
1511
|
};
|
|
1521
1512
|
};
|
|
1522
|
-
|
|
1513
|
+
CoverageAreasController_remove: {
|
|
1523
1514
|
parameters: {
|
|
1524
1515
|
query?: never;
|
|
1525
1516
|
header?: never;
|
|
@@ -1530,15 +1521,11 @@ export interface operations {
|
|
|
1530
1521
|
};
|
|
1531
1522
|
requestBody?: never;
|
|
1532
1523
|
responses: {
|
|
1533
|
-
|
|
1524
|
+
204: {
|
|
1534
1525
|
headers: {
|
|
1535
1526
|
[name: string]: unknown;
|
|
1536
1527
|
};
|
|
1537
|
-
content
|
|
1538
|
-
"application/json": {
|
|
1539
|
-
data: components["schemas"]["SupplierRegionDto"][];
|
|
1540
|
-
};
|
|
1541
|
-
};
|
|
1528
|
+
content?: never;
|
|
1542
1529
|
};
|
|
1543
1530
|
/** @description When the request is invalid */
|
|
1544
1531
|
400: {
|
|
@@ -1549,13 +1536,31 @@ export interface operations {
|
|
|
1549
1536
|
"application/json": components["schemas"]["BadRequestErrorDto"];
|
|
1550
1537
|
};
|
|
1551
1538
|
};
|
|
1552
|
-
/** @description When
|
|
1553
|
-
|
|
1539
|
+
/** @description When authentication fails */
|
|
1540
|
+
401: {
|
|
1554
1541
|
headers: {
|
|
1555
1542
|
[name: string]: unknown;
|
|
1556
1543
|
};
|
|
1557
1544
|
content: {
|
|
1558
|
-
"application/json": components["schemas"]["
|
|
1545
|
+
"application/json": components["schemas"]["UnauthorizedErrorDto"];
|
|
1546
|
+
};
|
|
1547
|
+
};
|
|
1548
|
+
/** @description When the requesting user is not allowed to perform this action */
|
|
1549
|
+
403: {
|
|
1550
|
+
headers: {
|
|
1551
|
+
[name: string]: unknown;
|
|
1552
|
+
};
|
|
1553
|
+
content: {
|
|
1554
|
+
"application/json": components["schemas"]["ForbiddenErrorDto"];
|
|
1555
|
+
};
|
|
1556
|
+
};
|
|
1557
|
+
/** @description When the coverage area is not found */
|
|
1558
|
+
404: {
|
|
1559
|
+
headers: {
|
|
1560
|
+
[name: string]: unknown;
|
|
1561
|
+
};
|
|
1562
|
+
content: {
|
|
1563
|
+
"application/json": components["schemas"]["NotFoundErrorDto"];
|
|
1559
1564
|
};
|
|
1560
1565
|
};
|
|
1561
1566
|
/** @description When the request is valid, but something goes wrong on the server */
|
|
@@ -1569,7 +1574,7 @@ export interface operations {
|
|
|
1569
1574
|
};
|
|
1570
1575
|
};
|
|
1571
1576
|
};
|
|
1572
|
-
|
|
1577
|
+
CoverageAreasController_update: {
|
|
1573
1578
|
parameters: {
|
|
1574
1579
|
query?: never;
|
|
1575
1580
|
header?: never;
|
|
@@ -1580,16 +1585,16 @@ export interface operations {
|
|
|
1580
1585
|
};
|
|
1581
1586
|
requestBody: {
|
|
1582
1587
|
content: {
|
|
1583
|
-
"application/json": components["schemas"]["
|
|
1588
|
+
"application/json": components["schemas"]["UpdateCoverageAreaDto"];
|
|
1584
1589
|
};
|
|
1585
1590
|
};
|
|
1586
1591
|
responses: {
|
|
1587
|
-
|
|
1592
|
+
200: {
|
|
1588
1593
|
headers: {
|
|
1589
1594
|
[name: string]: unknown;
|
|
1590
1595
|
};
|
|
1591
1596
|
content: {
|
|
1592
|
-
"application/json": components["schemas"]["
|
|
1597
|
+
"application/json": components["schemas"]["CoverageAreaDto"];
|
|
1593
1598
|
};
|
|
1594
1599
|
};
|
|
1595
1600
|
/** @description When the request is invalid */
|
|
@@ -1601,22 +1606,31 @@ export interface operations {
|
|
|
1601
1606
|
"application/json": components["schemas"]["BadRequestErrorDto"];
|
|
1602
1607
|
};
|
|
1603
1608
|
};
|
|
1604
|
-
/** @description When
|
|
1605
|
-
|
|
1609
|
+
/** @description When authentication fails */
|
|
1610
|
+
401: {
|
|
1606
1611
|
headers: {
|
|
1607
1612
|
[name: string]: unknown;
|
|
1608
1613
|
};
|
|
1609
1614
|
content: {
|
|
1610
|
-
"application/json": components["schemas"]["
|
|
1615
|
+
"application/json": components["schemas"]["UnauthorizedErrorDto"];
|
|
1611
1616
|
};
|
|
1612
1617
|
};
|
|
1613
|
-
/** @description When
|
|
1614
|
-
|
|
1618
|
+
/** @description When the requesting user is not allowed to perform this action */
|
|
1619
|
+
403: {
|
|
1615
1620
|
headers: {
|
|
1616
1621
|
[name: string]: unknown;
|
|
1617
1622
|
};
|
|
1618
1623
|
content: {
|
|
1619
|
-
"application/json": components["schemas"]["
|
|
1624
|
+
"application/json": components["schemas"]["ForbiddenErrorDto"];
|
|
1625
|
+
};
|
|
1626
|
+
};
|
|
1627
|
+
/** @description When the coverage area is not found */
|
|
1628
|
+
404: {
|
|
1629
|
+
headers: {
|
|
1630
|
+
[name: string]: unknown;
|
|
1631
|
+
};
|
|
1632
|
+
content: {
|
|
1633
|
+
"application/json": components["schemas"]["NotFoundErrorDto"];
|
|
1620
1634
|
};
|
|
1621
1635
|
};
|
|
1622
1636
|
/** @description When the request is valid, but something goes wrong on the server */
|
|
@@ -1630,7 +1644,7 @@ export interface operations {
|
|
|
1630
1644
|
};
|
|
1631
1645
|
};
|
|
1632
1646
|
};
|
|
1633
|
-
|
|
1647
|
+
SupplierExtensionsController_getSupplierRegions: {
|
|
1634
1648
|
parameters: {
|
|
1635
1649
|
query?: never;
|
|
1636
1650
|
header?: never;
|
|
@@ -1646,10 +1660,39 @@ export interface operations {
|
|
|
1646
1660
|
[name: string]: unknown;
|
|
1647
1661
|
};
|
|
1648
1662
|
content: {
|
|
1649
|
-
"application/json":
|
|
1663
|
+
"application/json": {
|
|
1664
|
+
data: components["schemas"]["SupplierRegionDto"][];
|
|
1665
|
+
};
|
|
1650
1666
|
};
|
|
1651
1667
|
};
|
|
1652
|
-
/** @description When the
|
|
1668
|
+
/** @description When the request is invalid */
|
|
1669
|
+
400: {
|
|
1670
|
+
headers: {
|
|
1671
|
+
[name: string]: unknown;
|
|
1672
|
+
};
|
|
1673
|
+
content: {
|
|
1674
|
+
"application/json": components["schemas"]["BadRequestErrorDto"];
|
|
1675
|
+
};
|
|
1676
|
+
};
|
|
1677
|
+
/** @description When authentication fails */
|
|
1678
|
+
401: {
|
|
1679
|
+
headers: {
|
|
1680
|
+
[name: string]: unknown;
|
|
1681
|
+
};
|
|
1682
|
+
content: {
|
|
1683
|
+
"application/json": components["schemas"]["UnauthorizedErrorDto"];
|
|
1684
|
+
};
|
|
1685
|
+
};
|
|
1686
|
+
/** @description When the requesting user is not allowed to perform this action */
|
|
1687
|
+
403: {
|
|
1688
|
+
headers: {
|
|
1689
|
+
[name: string]: unknown;
|
|
1690
|
+
};
|
|
1691
|
+
content: {
|
|
1692
|
+
"application/json": components["schemas"]["ForbiddenErrorDto"];
|
|
1693
|
+
};
|
|
1694
|
+
};
|
|
1695
|
+
/** @description When the supplier is not found */
|
|
1653
1696
|
404: {
|
|
1654
1697
|
headers: {
|
|
1655
1698
|
[name: string]: unknown;
|
|
@@ -1669,7 +1712,7 @@ export interface operations {
|
|
|
1669
1712
|
};
|
|
1670
1713
|
};
|
|
1671
1714
|
};
|
|
1672
|
-
|
|
1715
|
+
SupplierExtensionsController_createSupplierRegion: {
|
|
1673
1716
|
parameters: {
|
|
1674
1717
|
query?: never;
|
|
1675
1718
|
header?: never;
|
|
@@ -1680,11 +1723,11 @@ export interface operations {
|
|
|
1680
1723
|
};
|
|
1681
1724
|
requestBody: {
|
|
1682
1725
|
content: {
|
|
1683
|
-
"application/json": components["schemas"]["
|
|
1726
|
+
"application/json": components["schemas"]["CreateSupplierRegionDto"];
|
|
1684
1727
|
};
|
|
1685
1728
|
};
|
|
1686
1729
|
responses: {
|
|
1687
|
-
|
|
1730
|
+
201: {
|
|
1688
1731
|
headers: {
|
|
1689
1732
|
[name: string]: unknown;
|
|
1690
1733
|
};
|
|
@@ -1692,7 +1735,34 @@ export interface operations {
|
|
|
1692
1735
|
"application/json": components["schemas"]["SupplierRegionDto"];
|
|
1693
1736
|
};
|
|
1694
1737
|
};
|
|
1695
|
-
/** @description When the
|
|
1738
|
+
/** @description When the request is invalid */
|
|
1739
|
+
400: {
|
|
1740
|
+
headers: {
|
|
1741
|
+
[name: string]: unknown;
|
|
1742
|
+
};
|
|
1743
|
+
content: {
|
|
1744
|
+
"application/json": components["schemas"]["BadRequestErrorDto"];
|
|
1745
|
+
};
|
|
1746
|
+
};
|
|
1747
|
+
/** @description When authentication fails */
|
|
1748
|
+
401: {
|
|
1749
|
+
headers: {
|
|
1750
|
+
[name: string]: unknown;
|
|
1751
|
+
};
|
|
1752
|
+
content: {
|
|
1753
|
+
"application/json": components["schemas"]["UnauthorizedErrorDto"];
|
|
1754
|
+
};
|
|
1755
|
+
};
|
|
1756
|
+
/** @description When the requesting user is not allowed to perform this action */
|
|
1757
|
+
403: {
|
|
1758
|
+
headers: {
|
|
1759
|
+
[name: string]: unknown;
|
|
1760
|
+
};
|
|
1761
|
+
content: {
|
|
1762
|
+
"application/json": components["schemas"]["ForbiddenErrorDto"];
|
|
1763
|
+
};
|
|
1764
|
+
};
|
|
1765
|
+
/** @description When the supplier is not found */
|
|
1696
1766
|
404: {
|
|
1697
1767
|
headers: {
|
|
1698
1768
|
[name: string]: unknown;
|
|
@@ -1701,6 +1771,15 @@ export interface operations {
|
|
|
1701
1771
|
"application/json": components["schemas"]["NotFoundErrorDto"];
|
|
1702
1772
|
};
|
|
1703
1773
|
};
|
|
1774
|
+
/** @description When there's an existing region for this supplier */
|
|
1775
|
+
409: {
|
|
1776
|
+
headers: {
|
|
1777
|
+
[name: string]: unknown;
|
|
1778
|
+
};
|
|
1779
|
+
content: {
|
|
1780
|
+
"application/json": components["schemas"]["ConflictErrorDto"];
|
|
1781
|
+
};
|
|
1782
|
+
};
|
|
1704
1783
|
/** @description When the request is valid, but something goes wrong on the server */
|
|
1705
1784
|
500: {
|
|
1706
1785
|
headers: {
|
|
@@ -1712,7 +1791,7 @@ export interface operations {
|
|
|
1712
1791
|
};
|
|
1713
1792
|
};
|
|
1714
1793
|
};
|
|
1715
|
-
|
|
1794
|
+
SupplierRegionsController_findOne: {
|
|
1716
1795
|
parameters: {
|
|
1717
1796
|
query?: never;
|
|
1718
1797
|
header?: never;
|
|
@@ -1728,55 +1807,37 @@ export interface operations {
|
|
|
1728
1807
|
[name: string]: unknown;
|
|
1729
1808
|
};
|
|
1730
1809
|
content: {
|
|
1731
|
-
"application/json":
|
|
1732
|
-
data: components["schemas"]["CoverageAreaDto"][];
|
|
1733
|
-
};
|
|
1810
|
+
"application/json": components["schemas"]["SupplierRegionDto"];
|
|
1734
1811
|
};
|
|
1735
1812
|
};
|
|
1736
|
-
/** @description When the
|
|
1737
|
-
|
|
1813
|
+
/** @description When the request is invalid */
|
|
1814
|
+
400: {
|
|
1738
1815
|
headers: {
|
|
1739
1816
|
[name: string]: unknown;
|
|
1740
1817
|
};
|
|
1741
1818
|
content: {
|
|
1742
|
-
"application/json": components["schemas"]["
|
|
1819
|
+
"application/json": components["schemas"]["BadRequestErrorDto"];
|
|
1743
1820
|
};
|
|
1744
1821
|
};
|
|
1745
|
-
/** @description When
|
|
1746
|
-
|
|
1822
|
+
/** @description When authentication fails */
|
|
1823
|
+
401: {
|
|
1747
1824
|
headers: {
|
|
1748
1825
|
[name: string]: unknown;
|
|
1749
1826
|
};
|
|
1750
1827
|
content: {
|
|
1751
|
-
"application/json": components["schemas"]["
|
|
1828
|
+
"application/json": components["schemas"]["UnauthorizedErrorDto"];
|
|
1752
1829
|
};
|
|
1753
1830
|
};
|
|
1754
|
-
|
|
1755
|
-
|
|
1756
|
-
SupplierRegionsController_createCoverageArea: {
|
|
1757
|
-
parameters: {
|
|
1758
|
-
query?: never;
|
|
1759
|
-
header?: never;
|
|
1760
|
-
path: {
|
|
1761
|
-
id: string;
|
|
1762
|
-
};
|
|
1763
|
-
cookie?: never;
|
|
1764
|
-
};
|
|
1765
|
-
requestBody: {
|
|
1766
|
-
content: {
|
|
1767
|
-
"application/json": components["schemas"]["CreateCoverageAreaDto"];
|
|
1768
|
-
};
|
|
1769
|
-
};
|
|
1770
|
-
responses: {
|
|
1771
|
-
201: {
|
|
1831
|
+
/** @description When the requesting user is not allowed to perform this action */
|
|
1832
|
+
403: {
|
|
1772
1833
|
headers: {
|
|
1773
1834
|
[name: string]: unknown;
|
|
1774
1835
|
};
|
|
1775
1836
|
content: {
|
|
1776
|
-
"application/json": components["schemas"]["
|
|
1837
|
+
"application/json": components["schemas"]["ForbiddenErrorDto"];
|
|
1777
1838
|
};
|
|
1778
1839
|
};
|
|
1779
|
-
/** @description When the supplier
|
|
1840
|
+
/** @description When the supplier region is not found */
|
|
1780
1841
|
404: {
|
|
1781
1842
|
headers: {
|
|
1782
1843
|
[name: string]: unknown;
|
|
@@ -1796,7 +1857,7 @@ export interface operations {
|
|
|
1796
1857
|
};
|
|
1797
1858
|
};
|
|
1798
1859
|
};
|
|
1799
|
-
|
|
1860
|
+
SupplierRegionsController_update: {
|
|
1800
1861
|
parameters: {
|
|
1801
1862
|
query?: never;
|
|
1802
1863
|
header?: never;
|
|
@@ -1805,14 +1866,18 @@ export interface operations {
|
|
|
1805
1866
|
};
|
|
1806
1867
|
cookie?: never;
|
|
1807
1868
|
};
|
|
1808
|
-
requestBody
|
|
1869
|
+
requestBody: {
|
|
1870
|
+
content: {
|
|
1871
|
+
"application/json": components["schemas"]["UpdateSupplierRegionDto"];
|
|
1872
|
+
};
|
|
1873
|
+
};
|
|
1809
1874
|
responses: {
|
|
1810
1875
|
200: {
|
|
1811
1876
|
headers: {
|
|
1812
1877
|
[name: string]: unknown;
|
|
1813
1878
|
};
|
|
1814
1879
|
content: {
|
|
1815
|
-
"application/json": components["schemas"]["
|
|
1880
|
+
"application/json": components["schemas"]["SupplierRegionDto"];
|
|
1816
1881
|
};
|
|
1817
1882
|
};
|
|
1818
1883
|
/** @description When the request is invalid */
|
|
@@ -1824,7 +1889,25 @@ export interface operations {
|
|
|
1824
1889
|
"application/json": components["schemas"]["BadRequestErrorDto"];
|
|
1825
1890
|
};
|
|
1826
1891
|
};
|
|
1827
|
-
/** @description When
|
|
1892
|
+
/** @description When authentication fails */
|
|
1893
|
+
401: {
|
|
1894
|
+
headers: {
|
|
1895
|
+
[name: string]: unknown;
|
|
1896
|
+
};
|
|
1897
|
+
content: {
|
|
1898
|
+
"application/json": components["schemas"]["UnauthorizedErrorDto"];
|
|
1899
|
+
};
|
|
1900
|
+
};
|
|
1901
|
+
/** @description When the requesting user is not allowed to perform this action */
|
|
1902
|
+
403: {
|
|
1903
|
+
headers: {
|
|
1904
|
+
[name: string]: unknown;
|
|
1905
|
+
};
|
|
1906
|
+
content: {
|
|
1907
|
+
"application/json": components["schemas"]["ForbiddenErrorDto"];
|
|
1908
|
+
};
|
|
1909
|
+
};
|
|
1910
|
+
/** @description When the supplier region is not found */
|
|
1828
1911
|
404: {
|
|
1829
1912
|
headers: {
|
|
1830
1913
|
[name: string]: unknown;
|
|
@@ -1844,7 +1927,7 @@ export interface operations {
|
|
|
1844
1927
|
};
|
|
1845
1928
|
};
|
|
1846
1929
|
};
|
|
1847
|
-
|
|
1930
|
+
SupplierRegionsController_getCoverageAreas: {
|
|
1848
1931
|
parameters: {
|
|
1849
1932
|
query?: never;
|
|
1850
1933
|
header?: never;
|
|
@@ -1855,11 +1938,15 @@ export interface operations {
|
|
|
1855
1938
|
};
|
|
1856
1939
|
requestBody?: never;
|
|
1857
1940
|
responses: {
|
|
1858
|
-
|
|
1941
|
+
200: {
|
|
1859
1942
|
headers: {
|
|
1860
1943
|
[name: string]: unknown;
|
|
1861
1944
|
};
|
|
1862
|
-
content
|
|
1945
|
+
content: {
|
|
1946
|
+
"application/json": {
|
|
1947
|
+
data: components["schemas"]["CoverageAreaDto"][];
|
|
1948
|
+
};
|
|
1949
|
+
};
|
|
1863
1950
|
};
|
|
1864
1951
|
/** @description When the request is invalid */
|
|
1865
1952
|
400: {
|
|
@@ -1870,7 +1957,25 @@ export interface operations {
|
|
|
1870
1957
|
"application/json": components["schemas"]["BadRequestErrorDto"];
|
|
1871
1958
|
};
|
|
1872
1959
|
};
|
|
1873
|
-
/** @description When
|
|
1960
|
+
/** @description When authentication fails */
|
|
1961
|
+
401: {
|
|
1962
|
+
headers: {
|
|
1963
|
+
[name: string]: unknown;
|
|
1964
|
+
};
|
|
1965
|
+
content: {
|
|
1966
|
+
"application/json": components["schemas"]["UnauthorizedErrorDto"];
|
|
1967
|
+
};
|
|
1968
|
+
};
|
|
1969
|
+
/** @description When the requesting user is not allowed to perform this action */
|
|
1970
|
+
403: {
|
|
1971
|
+
headers: {
|
|
1972
|
+
[name: string]: unknown;
|
|
1973
|
+
};
|
|
1974
|
+
content: {
|
|
1975
|
+
"application/json": components["schemas"]["ForbiddenErrorDto"];
|
|
1976
|
+
};
|
|
1977
|
+
};
|
|
1978
|
+
/** @description When the supplier region is not found */
|
|
1874
1979
|
404: {
|
|
1875
1980
|
headers: {
|
|
1876
1981
|
[name: string]: unknown;
|
|
@@ -1890,7 +1995,7 @@ export interface operations {
|
|
|
1890
1995
|
};
|
|
1891
1996
|
};
|
|
1892
1997
|
};
|
|
1893
|
-
|
|
1998
|
+
SupplierRegionsController_createCoverageArea: {
|
|
1894
1999
|
parameters: {
|
|
1895
2000
|
query?: never;
|
|
1896
2001
|
header?: never;
|
|
@@ -1901,11 +2006,11 @@ export interface operations {
|
|
|
1901
2006
|
};
|
|
1902
2007
|
requestBody: {
|
|
1903
2008
|
content: {
|
|
1904
|
-
"application/json": components["schemas"]["
|
|
2009
|
+
"application/json": components["schemas"]["CreateCoverageAreaDto"];
|
|
1905
2010
|
};
|
|
1906
2011
|
};
|
|
1907
2012
|
responses: {
|
|
1908
|
-
|
|
2013
|
+
201: {
|
|
1909
2014
|
headers: {
|
|
1910
2015
|
[name: string]: unknown;
|
|
1911
2016
|
};
|
|
@@ -1922,7 +2027,25 @@ export interface operations {
|
|
|
1922
2027
|
"application/json": components["schemas"]["BadRequestErrorDto"];
|
|
1923
2028
|
};
|
|
1924
2029
|
};
|
|
1925
|
-
/** @description When
|
|
2030
|
+
/** @description When authentication fails */
|
|
2031
|
+
401: {
|
|
2032
|
+
headers: {
|
|
2033
|
+
[name: string]: unknown;
|
|
2034
|
+
};
|
|
2035
|
+
content: {
|
|
2036
|
+
"application/json": components["schemas"]["UnauthorizedErrorDto"];
|
|
2037
|
+
};
|
|
2038
|
+
};
|
|
2039
|
+
/** @description When the requesting user is not allowed to perform this action */
|
|
2040
|
+
403: {
|
|
2041
|
+
headers: {
|
|
2042
|
+
[name: string]: unknown;
|
|
2043
|
+
};
|
|
2044
|
+
content: {
|
|
2045
|
+
"application/json": components["schemas"]["ForbiddenErrorDto"];
|
|
2046
|
+
};
|
|
2047
|
+
};
|
|
2048
|
+
/** @description When the supplier or region is not found */
|
|
1926
2049
|
404: {
|
|
1927
2050
|
headers: {
|
|
1928
2051
|
[name: string]: unknown;
|
|
@@ -1942,12 +2065,19 @@ export interface operations {
|
|
|
1942
2065
|
};
|
|
1943
2066
|
};
|
|
1944
2067
|
};
|
|
1945
|
-
|
|
2068
|
+
SuppliersController_findAll: {
|
|
1946
2069
|
parameters: {
|
|
1947
2070
|
query?: {
|
|
1948
2071
|
page?: number;
|
|
1949
2072
|
limit?: number;
|
|
1950
|
-
|
|
2073
|
+
"organization.id"?: string;
|
|
2074
|
+
name?: string;
|
|
2075
|
+
"status.code"?: "ACTIVE" | "INACTIVE";
|
|
2076
|
+
"aspects.minPpw"?: number;
|
|
2077
|
+
"aspects.supportedProducts"?: "SOLAR" | "STORAGE";
|
|
2078
|
+
"aspects.tier"?: "PLATINUM" | "ELITE" | "PRO" | "CERTIFIED";
|
|
2079
|
+
"regions.region"?: string;
|
|
2080
|
+
"regions.capacity"?: number;
|
|
1951
2081
|
};
|
|
1952
2082
|
header?: never;
|
|
1953
2083
|
path?: never;
|
|
@@ -1961,12 +2091,12 @@ export interface operations {
|
|
|
1961
2091
|
};
|
|
1962
2092
|
content: {
|
|
1963
2093
|
"application/json": {
|
|
1964
|
-
data: components["schemas"]["
|
|
2094
|
+
data: components["schemas"]["SupplierDto"][];
|
|
1965
2095
|
paging: components["schemas"]["PagingDto"];
|
|
1966
2096
|
};
|
|
1967
2097
|
};
|
|
1968
2098
|
};
|
|
1969
|
-
/** @description When the
|
|
2099
|
+
/** @description When the request is invalid */
|
|
1970
2100
|
400: {
|
|
1971
2101
|
headers: {
|
|
1972
2102
|
[name: string]: unknown;
|
|
@@ -2004,7 +2134,7 @@ export interface operations {
|
|
|
2004
2134
|
};
|
|
2005
2135
|
};
|
|
2006
2136
|
};
|
|
2007
|
-
|
|
2137
|
+
SuppliersController_create: {
|
|
2008
2138
|
parameters: {
|
|
2009
2139
|
query?: never;
|
|
2010
2140
|
header?: never;
|
|
@@ -2013,7 +2143,7 @@ export interface operations {
|
|
|
2013
2143
|
};
|
|
2014
2144
|
requestBody: {
|
|
2015
2145
|
content: {
|
|
2016
|
-
"application/json": components["schemas"]["
|
|
2146
|
+
"application/json": components["schemas"]["CreateSupplierDto"];
|
|
2017
2147
|
};
|
|
2018
2148
|
};
|
|
2019
2149
|
responses: {
|
|
@@ -2022,7 +2152,7 @@ export interface operations {
|
|
|
2022
2152
|
[name: string]: unknown;
|
|
2023
2153
|
};
|
|
2024
2154
|
content: {
|
|
2025
|
-
"application/json": components["schemas"]["
|
|
2155
|
+
"application/json": components["schemas"]["SupplierDto"];
|
|
2026
2156
|
};
|
|
2027
2157
|
};
|
|
2028
2158
|
/** @description When the request is invalid */
|
|
@@ -2052,7 +2182,7 @@ export interface operations {
|
|
|
2052
2182
|
"application/json": components["schemas"]["ForbiddenErrorDto"];
|
|
2053
2183
|
};
|
|
2054
2184
|
};
|
|
2055
|
-
/** @description When
|
|
2185
|
+
/** @description When the supplier already exists */
|
|
2056
2186
|
409: {
|
|
2057
2187
|
headers: {
|
|
2058
2188
|
[name: string]: unknown;
|
|
@@ -2072,7 +2202,7 @@ export interface operations {
|
|
|
2072
2202
|
};
|
|
2073
2203
|
};
|
|
2074
2204
|
};
|
|
2075
|
-
|
|
2205
|
+
SuppliersController_findOne: {
|
|
2076
2206
|
parameters: {
|
|
2077
2207
|
query?: never;
|
|
2078
2208
|
header?: never;
|
|
@@ -2088,7 +2218,7 @@ export interface operations {
|
|
|
2088
2218
|
[name: string]: unknown;
|
|
2089
2219
|
};
|
|
2090
2220
|
content: {
|
|
2091
|
-
"application/json": components["schemas"]["
|
|
2221
|
+
"application/json": components["schemas"]["SupplierDto"];
|
|
2092
2222
|
};
|
|
2093
2223
|
};
|
|
2094
2224
|
/** @description When the ID is invalid */
|
|
@@ -2118,7 +2248,7 @@ export interface operations {
|
|
|
2118
2248
|
"application/json": components["schemas"]["ForbiddenErrorDto"];
|
|
2119
2249
|
};
|
|
2120
2250
|
};
|
|
2121
|
-
/** @description When the
|
|
2251
|
+
/** @description When the supplier is not found */
|
|
2122
2252
|
404: {
|
|
2123
2253
|
headers: {
|
|
2124
2254
|
[name: string]: unknown;
|
|
@@ -2138,7 +2268,7 @@ export interface operations {
|
|
|
2138
2268
|
};
|
|
2139
2269
|
};
|
|
2140
2270
|
};
|
|
2141
|
-
|
|
2271
|
+
SuppliersController_update: {
|
|
2142
2272
|
parameters: {
|
|
2143
2273
|
query?: never;
|
|
2144
2274
|
header?: never;
|
|
@@ -2149,7 +2279,7 @@ export interface operations {
|
|
|
2149
2279
|
};
|
|
2150
2280
|
requestBody: {
|
|
2151
2281
|
content: {
|
|
2152
|
-
"application/json": components["schemas"]["
|
|
2282
|
+
"application/json": components["schemas"]["UpdateSupplierDto"];
|
|
2153
2283
|
};
|
|
2154
2284
|
};
|
|
2155
2285
|
responses: {
|
|
@@ -2158,7 +2288,77 @@ export interface operations {
|
|
|
2158
2288
|
[name: string]: unknown;
|
|
2159
2289
|
};
|
|
2160
2290
|
content: {
|
|
2161
|
-
"application/json": components["schemas"]["
|
|
2291
|
+
"application/json": components["schemas"]["SupplierDto"];
|
|
2292
|
+
};
|
|
2293
|
+
};
|
|
2294
|
+
/** @description When the request is invalid */
|
|
2295
|
+
400: {
|
|
2296
|
+
headers: {
|
|
2297
|
+
[name: string]: unknown;
|
|
2298
|
+
};
|
|
2299
|
+
content: {
|
|
2300
|
+
"application/json": components["schemas"]["BadRequestErrorDto"];
|
|
2301
|
+
};
|
|
2302
|
+
};
|
|
2303
|
+
/** @description When authentication fails */
|
|
2304
|
+
401: {
|
|
2305
|
+
headers: {
|
|
2306
|
+
[name: string]: unknown;
|
|
2307
|
+
};
|
|
2308
|
+
content: {
|
|
2309
|
+
"application/json": components["schemas"]["UnauthorizedErrorDto"];
|
|
2310
|
+
};
|
|
2311
|
+
};
|
|
2312
|
+
/** @description When the requesting user is not allowed to perform this action */
|
|
2313
|
+
403: {
|
|
2314
|
+
headers: {
|
|
2315
|
+
[name: string]: unknown;
|
|
2316
|
+
};
|
|
2317
|
+
content: {
|
|
2318
|
+
"application/json": components["schemas"]["ForbiddenErrorDto"];
|
|
2319
|
+
};
|
|
2320
|
+
};
|
|
2321
|
+
/** @description When the supplier is not found */
|
|
2322
|
+
404: {
|
|
2323
|
+
headers: {
|
|
2324
|
+
[name: string]: unknown;
|
|
2325
|
+
};
|
|
2326
|
+
content: {
|
|
2327
|
+
"application/json": components["schemas"]["NotFoundErrorDto"];
|
|
2328
|
+
};
|
|
2329
|
+
};
|
|
2330
|
+
/** @description When the request is valid, but something goes wrong on the server */
|
|
2331
|
+
500: {
|
|
2332
|
+
headers: {
|
|
2333
|
+
[name: string]: unknown;
|
|
2334
|
+
};
|
|
2335
|
+
content: {
|
|
2336
|
+
"application/json": components["schemas"]["InternalServerErrorDto"];
|
|
2337
|
+
};
|
|
2338
|
+
};
|
|
2339
|
+
};
|
|
2340
|
+
};
|
|
2341
|
+
SuppliersController_updateStatus: {
|
|
2342
|
+
parameters: {
|
|
2343
|
+
query?: never;
|
|
2344
|
+
header?: never;
|
|
2345
|
+
path: {
|
|
2346
|
+
id: string;
|
|
2347
|
+
};
|
|
2348
|
+
cookie?: never;
|
|
2349
|
+
};
|
|
2350
|
+
requestBody: {
|
|
2351
|
+
content: {
|
|
2352
|
+
"application/json": components["schemas"]["UpdateSupplierStatusDto"];
|
|
2353
|
+
};
|
|
2354
|
+
};
|
|
2355
|
+
responses: {
|
|
2356
|
+
200: {
|
|
2357
|
+
headers: {
|
|
2358
|
+
[name: string]: unknown;
|
|
2359
|
+
};
|
|
2360
|
+
content: {
|
|
2361
|
+
"application/json": components["schemas"]["SupplierDto"];
|
|
2162
2362
|
};
|
|
2163
2363
|
};
|
|
2164
2364
|
/** @description When the ID or body request is invalid */
|
|
@@ -2188,7 +2388,7 @@ export interface operations {
|
|
|
2188
2388
|
"application/json": components["schemas"]["ForbiddenErrorDto"];
|
|
2189
2389
|
};
|
|
2190
2390
|
};
|
|
2191
|
-
/** @description When the
|
|
2391
|
+
/** @description When the supplier is not found */
|
|
2192
2392
|
404: {
|
|
2193
2393
|
headers: {
|
|
2194
2394
|
[name: string]: unknown;
|