eiagov-typescript-fetch-client 1.0.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/.openapi-generator/FILES +73 -0
- package/.openapi-generator/VERSION +1 -0
- package/.openapi-generator-ignore +23 -0
- package/apis/AEOApi.ts +415 -0
- package/apis/COALApi.ts +3645 -0
- package/apis/CRUDIMPORTSApi.ts +322 -0
- package/apis/DBFApi.ts +2260 -0
- package/apis/ELECApi.ts +1180 -0
- package/apis/EMISSApi.ts +640 -0
- package/apis/IEOApi.ts +415 -0
- package/apis/INTLApi.ts +322 -0
- package/apis/NGApi.ts +511 -0
- package/apis/NUCSTATUSApi.ts +910 -0
- package/apis/RTOApi.ts +2260 -0
- package/apis/RootApi.ts +66 -0
- package/apis/SEDSApi.ts +322 -0
- package/apis/SEPApi.ts +1990 -0
- package/apis/STEOApi.ts +322 -0
- package/apis/TOTALApi.ts +322 -0
- package/apis/index.ts +18 -0
- package/docs/AEOApi.md +456 -0
- package/docs/COALApi.md +4847 -0
- package/docs/CRUDIMPORTSApi.md +371 -0
- package/docs/DBFApi.md +2976 -0
- package/docs/DataParams.md +48 -0
- package/docs/DataResponse.md +42 -0
- package/docs/DataResponseContainer.md +38 -0
- package/docs/ELECApi.md +1524 -0
- package/docs/EMISSApi.md +798 -0
- package/docs/Facet.md +38 -0
- package/docs/FacetDetails.md +36 -0
- package/docs/FacetDetailsContainer.md +38 -0
- package/docs/FacetMetaData.md +36 -0
- package/docs/FacetOptionList.md +36 -0
- package/docs/FacetOptionListContainer.md +38 -0
- package/docs/FinalRoute.md +52 -0
- package/docs/FinalRouteResponse.md +36 -0
- package/docs/FinalRouteResponseContainer.md +38 -0
- package/docs/Frequency.md +40 -0
- package/docs/IEOApi.md +456 -0
- package/docs/INTLApi.md +371 -0
- package/docs/NGApi.md +541 -0
- package/docs/NUCSTATUSApi.md +1161 -0
- package/docs/RTOApi.md +2976 -0
- package/docs/RootApi.md +70 -0
- package/docs/RouteRequest.md +36 -0
- package/docs/RouteResponse.md +36 -0
- package/docs/RouteResponseContainer.md +38 -0
- package/docs/Routes.md +40 -0
- package/docs/SEDSApi.md +372 -0
- package/docs/SEPApi.md +2613 -0
- package/docs/STEOApi.md +371 -0
- package/docs/Sort.md +36 -0
- package/docs/TOTALApi.md +371 -0
- package/index.ts +5 -0
- package/models/DataParams.ts +129 -0
- package/models/DataResponse.ts +97 -0
- package/models/DataResponseContainer.ts +96 -0
- package/models/Facet.ts +81 -0
- package/models/FacetDetails.ts +81 -0
- package/models/FacetDetailsContainer.ts +96 -0
- package/models/FacetMetaData.ts +73 -0
- package/models/FacetOptionList.ts +73 -0
- package/models/FacetOptionListContainer.ts +96 -0
- package/models/FinalRoute.ts +152 -0
- package/models/FinalRouteResponse.ts +88 -0
- package/models/FinalRouteResponseContainer.ts +96 -0
- package/models/Frequency.ts +89 -0
- package/models/RouteRequest.ts +73 -0
- package/models/RouteResponse.ts +88 -0
- package/models/RouteResponseContainer.ts +96 -0
- package/models/Routes.ts +89 -0
- package/models/Sort.ts +73 -0
- package/models/index.ts +20 -0
- package/package.json +15 -0
- package/runtime.ts +449 -0
package/docs/EMISSApi.md
ADDED
|
@@ -0,0 +1,798 @@
|
|
|
1
|
+
# EMISSApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.eia.gov*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
| [**v2Co2EmissionsCo2EmissionsAggregatesDataGet**](EMISSApi.md#v2co2emissionsco2emissionsaggregatesdataget) | **GET** /v2/co2-emissions/co2-emissions-aggregates/data | |
|
|
8
|
+
| [**v2Co2EmissionsCo2EmissionsAggregatesDataPost**](EMISSApi.md#v2co2emissionsco2emissionsaggregatesdatapost) | **POST** /v2/co2-emissions/co2-emissions-aggregates/data | Return co2-emissions-aggregates Data |
|
|
9
|
+
| [**v2Co2EmissionsCo2EmissionsAggregatesFacetFacetIdGet**](EMISSApi.md#v2co2emissionsco2emissionsaggregatesfacetfacetidget) | **GET** /v2/co2-emissions/co2-emissions-aggregates/facet/{facet_id} | |
|
|
10
|
+
| [**v2Co2EmissionsCo2EmissionsAggregatesFacetGet**](EMISSApi.md#v2co2emissionsco2emissionsaggregatesfacetget) | **GET** /v2/co2-emissions/co2-emissions-aggregates/facet | |
|
|
11
|
+
| [**v2Co2EmissionsCo2EmissionsAggregatesGet**](EMISSApi.md#v2co2emissionsco2emissionsaggregatesget) | **GET** /v2/co2-emissions/co2-emissions-aggregates | |
|
|
12
|
+
| [**v2Co2EmissionsCo2EmissionsAndCarbonCoefficientsDataGet**](EMISSApi.md#v2co2emissionsco2emissionsandcarboncoefficientsdataget) | **GET** /v2/co2-emissions/co2-emissions-and-carbon-coefficients/data | |
|
|
13
|
+
| [**v2Co2EmissionsCo2EmissionsAndCarbonCoefficientsDataPost**](EMISSApi.md#v2co2emissionsco2emissionsandcarboncoefficientsdatapost) | **POST** /v2/co2-emissions/co2-emissions-and-carbon-coefficients/data | Return co2-emissions-and-carbon-coefficients Data |
|
|
14
|
+
| [**v2Co2EmissionsCo2EmissionsAndCarbonCoefficientsFacetFacetIdGet**](EMISSApi.md#v2co2emissionsco2emissionsandcarboncoefficientsfacetfacetidget) | **GET** /v2/co2-emissions/co2-emissions-and-carbon-coefficients/facet/{facet_id} | |
|
|
15
|
+
| [**v2Co2EmissionsCo2EmissionsAndCarbonCoefficientsFacetGet**](EMISSApi.md#v2co2emissionsco2emissionsandcarboncoefficientsfacetget) | **GET** /v2/co2-emissions/co2-emissions-and-carbon-coefficients/facet | |
|
|
16
|
+
| [**v2Co2EmissionsCo2EmissionsAndCarbonCoefficientsGet**](EMISSApi.md#v2co2emissionsco2emissionsandcarboncoefficientsget) | **GET** /v2/co2-emissions/co2-emissions-and-carbon-coefficients | |
|
|
17
|
+
| [**v2Co2EmissionsGet**](EMISSApi.md#v2co2emissionsget) | **GET** /v2/co2-emissions | Class CO2EmissionsController |
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
## v2Co2EmissionsCo2EmissionsAggregatesDataGet
|
|
22
|
+
|
|
23
|
+
> DataResponseContainer v2Co2EmissionsCo2EmissionsAggregatesDataGet(data, facets, frequency, start, end, sort, length, offset)
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
API data with query params
|
|
28
|
+
|
|
29
|
+
### Example
|
|
30
|
+
|
|
31
|
+
```ts
|
|
32
|
+
import {
|
|
33
|
+
Configuration,
|
|
34
|
+
EMISSApi,
|
|
35
|
+
} from '';
|
|
36
|
+
import type { V2Co2EmissionsCo2EmissionsAggregatesDataGetRequest } from '';
|
|
37
|
+
|
|
38
|
+
async function example() {
|
|
39
|
+
console.log("🚀 Testing SDK...");
|
|
40
|
+
const config = new Configuration({
|
|
41
|
+
// To configure API key authorization: api_key
|
|
42
|
+
apiKey: "YOUR API KEY",
|
|
43
|
+
});
|
|
44
|
+
const api = new EMISSApi(config);
|
|
45
|
+
|
|
46
|
+
const body = {
|
|
47
|
+
// Array<string> | Data columns to filter by (optional)
|
|
48
|
+
data: ...,
|
|
49
|
+
// object | Facets to filter by (optional)
|
|
50
|
+
facets: Object,
|
|
51
|
+
// string | Frequency to filter by (optional)
|
|
52
|
+
frequency: frequency_example,
|
|
53
|
+
// string | Start date to filter by (optional)
|
|
54
|
+
start: start_example,
|
|
55
|
+
// string | End date to filter by (optional)
|
|
56
|
+
end: end_example,
|
|
57
|
+
// Sort | How to sort returned data (optional)
|
|
58
|
+
sort: ...,
|
|
59
|
+
// number | Max length of returned data (optional)
|
|
60
|
+
length: 56,
|
|
61
|
+
// number | Offset of returned data (optional)
|
|
62
|
+
offset: 56,
|
|
63
|
+
} satisfies V2Co2EmissionsCo2EmissionsAggregatesDataGetRequest;
|
|
64
|
+
|
|
65
|
+
try {
|
|
66
|
+
const data = await api.v2Co2EmissionsCo2EmissionsAggregatesDataGet(body);
|
|
67
|
+
console.log(data);
|
|
68
|
+
} catch (error) {
|
|
69
|
+
console.error(error);
|
|
70
|
+
}
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
// Run the test
|
|
74
|
+
example().catch(console.error);
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
### Parameters
|
|
78
|
+
|
|
79
|
+
|
|
80
|
+
| Name | Type | Description | Notes |
|
|
81
|
+
|------------- | ------------- | ------------- | -------------|
|
|
82
|
+
| **data** | `Array<string>` | Data columns to filter by | [Optional] |
|
|
83
|
+
| **facets** | `object` | Facets to filter by | [Optional] [Defaults to `undefined`] |
|
|
84
|
+
| **frequency** | `string` | Frequency to filter by | [Optional] [Defaults to `undefined`] |
|
|
85
|
+
| **start** | `string` | Start date to filter by | [Optional] [Defaults to `undefined`] |
|
|
86
|
+
| **end** | `string` | End date to filter by | [Optional] [Defaults to `undefined`] |
|
|
87
|
+
| **sort** | [](.md) | How to sort returned data | [Optional] [Defaults to `undefined`] |
|
|
88
|
+
| **length** | `number` | Max length of returned data | [Optional] [Defaults to `undefined`] |
|
|
89
|
+
| **offset** | `number` | Offset of returned data | [Optional] [Defaults to `undefined`] |
|
|
90
|
+
|
|
91
|
+
### Return type
|
|
92
|
+
|
|
93
|
+
[**DataResponseContainer**](DataResponseContainer.md)
|
|
94
|
+
|
|
95
|
+
### Authorization
|
|
96
|
+
|
|
97
|
+
[api_key](../README.md#api_key)
|
|
98
|
+
|
|
99
|
+
### HTTP request headers
|
|
100
|
+
|
|
101
|
+
- **Content-Type**: Not defined
|
|
102
|
+
- **Accept**: `application/json`
|
|
103
|
+
|
|
104
|
+
|
|
105
|
+
### HTTP response details
|
|
106
|
+
| Status code | Description | Response headers |
|
|
107
|
+
|-------------|-------------|------------------|
|
|
108
|
+
| **400** | Invalid input | - |
|
|
109
|
+
| **200** | API Data | - |
|
|
110
|
+
|
|
111
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
112
|
+
|
|
113
|
+
|
|
114
|
+
## v2Co2EmissionsCo2EmissionsAggregatesDataPost
|
|
115
|
+
|
|
116
|
+
> DataResponseContainer v2Co2EmissionsCo2EmissionsAggregatesDataPost(dataParams)
|
|
117
|
+
|
|
118
|
+
Return co2-emissions-aggregates Data
|
|
119
|
+
|
|
120
|
+
Class CO2EmissionsAggregatesController CO2 Emissions Aggregates data set controller.
|
|
121
|
+
|
|
122
|
+
### Example
|
|
123
|
+
|
|
124
|
+
```ts
|
|
125
|
+
import {
|
|
126
|
+
Configuration,
|
|
127
|
+
EMISSApi,
|
|
128
|
+
} from '';
|
|
129
|
+
import type { V2Co2EmissionsCo2EmissionsAggregatesDataPostRequest } from '';
|
|
130
|
+
|
|
131
|
+
async function example() {
|
|
132
|
+
console.log("🚀 Testing SDK...");
|
|
133
|
+
const config = new Configuration({
|
|
134
|
+
// To configure API key authorization: api_key
|
|
135
|
+
apiKey: "YOUR API KEY",
|
|
136
|
+
});
|
|
137
|
+
const api = new EMISSApi(config);
|
|
138
|
+
|
|
139
|
+
const body = {
|
|
140
|
+
// DataParams | Parameters for data call
|
|
141
|
+
dataParams: ...,
|
|
142
|
+
} satisfies V2Co2EmissionsCo2EmissionsAggregatesDataPostRequest;
|
|
143
|
+
|
|
144
|
+
try {
|
|
145
|
+
const data = await api.v2Co2EmissionsCo2EmissionsAggregatesDataPost(body);
|
|
146
|
+
console.log(data);
|
|
147
|
+
} catch (error) {
|
|
148
|
+
console.error(error);
|
|
149
|
+
}
|
|
150
|
+
}
|
|
151
|
+
|
|
152
|
+
// Run the test
|
|
153
|
+
example().catch(console.error);
|
|
154
|
+
```
|
|
155
|
+
|
|
156
|
+
### Parameters
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
| Name | Type | Description | Notes |
|
|
160
|
+
|------------- | ------------- | ------------- | -------------|
|
|
161
|
+
| **dataParams** | [DataParams](DataParams.md) | Parameters for data call | |
|
|
162
|
+
|
|
163
|
+
### Return type
|
|
164
|
+
|
|
165
|
+
[**DataResponseContainer**](DataResponseContainer.md)
|
|
166
|
+
|
|
167
|
+
### Authorization
|
|
168
|
+
|
|
169
|
+
[api_key](../README.md#api_key)
|
|
170
|
+
|
|
171
|
+
### HTTP request headers
|
|
172
|
+
|
|
173
|
+
- **Content-Type**: `application/json`
|
|
174
|
+
- **Accept**: `application/json`
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
### HTTP response details
|
|
178
|
+
| Status code | Description | Response headers |
|
|
179
|
+
|-------------|-------------|------------------|
|
|
180
|
+
| **400** | Invalid input | - |
|
|
181
|
+
| **200** | API Data | - |
|
|
182
|
+
|
|
183
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
## v2Co2EmissionsCo2EmissionsAggregatesFacetFacetIdGet
|
|
187
|
+
|
|
188
|
+
> FacetDetailsContainer v2Co2EmissionsCo2EmissionsAggregatesFacetFacetIdGet(facetId)
|
|
189
|
+
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
### Example
|
|
193
|
+
|
|
194
|
+
```ts
|
|
195
|
+
import {
|
|
196
|
+
Configuration,
|
|
197
|
+
EMISSApi,
|
|
198
|
+
} from '';
|
|
199
|
+
import type { V2Co2EmissionsCo2EmissionsAggregatesFacetFacetIdGetRequest } from '';
|
|
200
|
+
|
|
201
|
+
async function example() {
|
|
202
|
+
console.log("🚀 Testing SDK...");
|
|
203
|
+
const config = new Configuration({
|
|
204
|
+
// To configure API key authorization: api_key
|
|
205
|
+
apiKey: "YOUR API KEY",
|
|
206
|
+
});
|
|
207
|
+
const api = new EMISSApi(config);
|
|
208
|
+
|
|
209
|
+
const body = {
|
|
210
|
+
// string | Facet ID
|
|
211
|
+
facetId: facetId_example,
|
|
212
|
+
} satisfies V2Co2EmissionsCo2EmissionsAggregatesFacetFacetIdGetRequest;
|
|
213
|
+
|
|
214
|
+
try {
|
|
215
|
+
const data = await api.v2Co2EmissionsCo2EmissionsAggregatesFacetFacetIdGet(body);
|
|
216
|
+
console.log(data);
|
|
217
|
+
} catch (error) {
|
|
218
|
+
console.error(error);
|
|
219
|
+
}
|
|
220
|
+
}
|
|
221
|
+
|
|
222
|
+
// Run the test
|
|
223
|
+
example().catch(console.error);
|
|
224
|
+
```
|
|
225
|
+
|
|
226
|
+
### Parameters
|
|
227
|
+
|
|
228
|
+
|
|
229
|
+
| Name | Type | Description | Notes |
|
|
230
|
+
|------------- | ------------- | ------------- | -------------|
|
|
231
|
+
| **facetId** | `string` | Facet ID | [Defaults to `undefined`] |
|
|
232
|
+
|
|
233
|
+
### Return type
|
|
234
|
+
|
|
235
|
+
[**FacetDetailsContainer**](FacetDetailsContainer.md)
|
|
236
|
+
|
|
237
|
+
### Authorization
|
|
238
|
+
|
|
239
|
+
[api_key](../README.md#api_key)
|
|
240
|
+
|
|
241
|
+
### HTTP request headers
|
|
242
|
+
|
|
243
|
+
- **Content-Type**: Not defined
|
|
244
|
+
- **Accept**: `application/json`
|
|
245
|
+
|
|
246
|
+
|
|
247
|
+
### HTTP response details
|
|
248
|
+
| Status code | Description | Response headers |
|
|
249
|
+
|-------------|-------------|------------------|
|
|
250
|
+
| **400** | Invalid input | - |
|
|
251
|
+
| **200** | Facet details | - |
|
|
252
|
+
|
|
253
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
254
|
+
|
|
255
|
+
|
|
256
|
+
## v2Co2EmissionsCo2EmissionsAggregatesFacetGet
|
|
257
|
+
|
|
258
|
+
> FacetOptionListContainer v2Co2EmissionsCo2EmissionsAggregatesFacetGet()
|
|
259
|
+
|
|
260
|
+
|
|
261
|
+
|
|
262
|
+
### Example
|
|
263
|
+
|
|
264
|
+
```ts
|
|
265
|
+
import {
|
|
266
|
+
Configuration,
|
|
267
|
+
EMISSApi,
|
|
268
|
+
} from '';
|
|
269
|
+
import type { V2Co2EmissionsCo2EmissionsAggregatesFacetGetRequest } from '';
|
|
270
|
+
|
|
271
|
+
async function example() {
|
|
272
|
+
console.log("🚀 Testing SDK...");
|
|
273
|
+
const config = new Configuration({
|
|
274
|
+
// To configure API key authorization: api_key
|
|
275
|
+
apiKey: "YOUR API KEY",
|
|
276
|
+
});
|
|
277
|
+
const api = new EMISSApi(config);
|
|
278
|
+
|
|
279
|
+
try {
|
|
280
|
+
const data = await api.v2Co2EmissionsCo2EmissionsAggregatesFacetGet();
|
|
281
|
+
console.log(data);
|
|
282
|
+
} catch (error) {
|
|
283
|
+
console.error(error);
|
|
284
|
+
}
|
|
285
|
+
}
|
|
286
|
+
|
|
287
|
+
// Run the test
|
|
288
|
+
example().catch(console.error);
|
|
289
|
+
```
|
|
290
|
+
|
|
291
|
+
### Parameters
|
|
292
|
+
|
|
293
|
+
This endpoint does not need any parameter.
|
|
294
|
+
|
|
295
|
+
### Return type
|
|
296
|
+
|
|
297
|
+
[**FacetOptionListContainer**](FacetOptionListContainer.md)
|
|
298
|
+
|
|
299
|
+
### Authorization
|
|
300
|
+
|
|
301
|
+
[api_key](../README.md#api_key)
|
|
302
|
+
|
|
303
|
+
### HTTP request headers
|
|
304
|
+
|
|
305
|
+
- **Content-Type**: Not defined
|
|
306
|
+
- **Accept**: `application/json`
|
|
307
|
+
|
|
308
|
+
|
|
309
|
+
### HTTP response details
|
|
310
|
+
| Status code | Description | Response headers |
|
|
311
|
+
|-------------|-------------|------------------|
|
|
312
|
+
| **400** | Invalid input | - |
|
|
313
|
+
| **200** | List of facet options | - |
|
|
314
|
+
|
|
315
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
316
|
+
|
|
317
|
+
|
|
318
|
+
## v2Co2EmissionsCo2EmissionsAggregatesGet
|
|
319
|
+
|
|
320
|
+
> FinalRouteResponseContainer v2Co2EmissionsCo2EmissionsAggregatesGet()
|
|
321
|
+
|
|
322
|
+
|
|
323
|
+
|
|
324
|
+
### Example
|
|
325
|
+
|
|
326
|
+
```ts
|
|
327
|
+
import {
|
|
328
|
+
Configuration,
|
|
329
|
+
EMISSApi,
|
|
330
|
+
} from '';
|
|
331
|
+
import type { V2Co2EmissionsCo2EmissionsAggregatesGetRequest } from '';
|
|
332
|
+
|
|
333
|
+
async function example() {
|
|
334
|
+
console.log("🚀 Testing SDK...");
|
|
335
|
+
const config = new Configuration({
|
|
336
|
+
// To configure API key authorization: api_key
|
|
337
|
+
apiKey: "YOUR API KEY",
|
|
338
|
+
});
|
|
339
|
+
const api = new EMISSApi(config);
|
|
340
|
+
|
|
341
|
+
try {
|
|
342
|
+
const data = await api.v2Co2EmissionsCo2EmissionsAggregatesGet();
|
|
343
|
+
console.log(data);
|
|
344
|
+
} catch (error) {
|
|
345
|
+
console.error(error);
|
|
346
|
+
}
|
|
347
|
+
}
|
|
348
|
+
|
|
349
|
+
// Run the test
|
|
350
|
+
example().catch(console.error);
|
|
351
|
+
```
|
|
352
|
+
|
|
353
|
+
### Parameters
|
|
354
|
+
|
|
355
|
+
This endpoint does not need any parameter.
|
|
356
|
+
|
|
357
|
+
### Return type
|
|
358
|
+
|
|
359
|
+
[**FinalRouteResponseContainer**](FinalRouteResponseContainer.md)
|
|
360
|
+
|
|
361
|
+
### Authorization
|
|
362
|
+
|
|
363
|
+
[api_key](../README.md#api_key)
|
|
364
|
+
|
|
365
|
+
### HTTP request headers
|
|
366
|
+
|
|
367
|
+
- **Content-Type**: Not defined
|
|
368
|
+
- **Accept**: `application/json`
|
|
369
|
+
|
|
370
|
+
|
|
371
|
+
### HTTP response details
|
|
372
|
+
| Status code | Description | Response headers |
|
|
373
|
+
|-------------|-------------|------------------|
|
|
374
|
+
| **200** | List of API data sets | - |
|
|
375
|
+
|
|
376
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
377
|
+
|
|
378
|
+
|
|
379
|
+
## v2Co2EmissionsCo2EmissionsAndCarbonCoefficientsDataGet
|
|
380
|
+
|
|
381
|
+
> DataResponseContainer v2Co2EmissionsCo2EmissionsAndCarbonCoefficientsDataGet(data, facets, frequency, start, end, sort, length, offset)
|
|
382
|
+
|
|
383
|
+
|
|
384
|
+
|
|
385
|
+
API data with query params
|
|
386
|
+
|
|
387
|
+
### Example
|
|
388
|
+
|
|
389
|
+
```ts
|
|
390
|
+
import {
|
|
391
|
+
Configuration,
|
|
392
|
+
EMISSApi,
|
|
393
|
+
} from '';
|
|
394
|
+
import type { V2Co2EmissionsCo2EmissionsAndCarbonCoefficientsDataGetRequest } from '';
|
|
395
|
+
|
|
396
|
+
async function example() {
|
|
397
|
+
console.log("🚀 Testing SDK...");
|
|
398
|
+
const config = new Configuration({
|
|
399
|
+
// To configure API key authorization: api_key
|
|
400
|
+
apiKey: "YOUR API KEY",
|
|
401
|
+
});
|
|
402
|
+
const api = new EMISSApi(config);
|
|
403
|
+
|
|
404
|
+
const body = {
|
|
405
|
+
// Array<string> | Data columns to filter by (optional)
|
|
406
|
+
data: ...,
|
|
407
|
+
// object | Facets to filter by (optional)
|
|
408
|
+
facets: Object,
|
|
409
|
+
// string | Frequency to filter by (optional)
|
|
410
|
+
frequency: frequency_example,
|
|
411
|
+
// string | Start date to filter by (optional)
|
|
412
|
+
start: start_example,
|
|
413
|
+
// string | End date to filter by (optional)
|
|
414
|
+
end: end_example,
|
|
415
|
+
// Sort | How to sort returned data (optional)
|
|
416
|
+
sort: ...,
|
|
417
|
+
// number | Max length of returned data (optional)
|
|
418
|
+
length: 56,
|
|
419
|
+
// number | Offset of returned data (optional)
|
|
420
|
+
offset: 56,
|
|
421
|
+
} satisfies V2Co2EmissionsCo2EmissionsAndCarbonCoefficientsDataGetRequest;
|
|
422
|
+
|
|
423
|
+
try {
|
|
424
|
+
const data = await api.v2Co2EmissionsCo2EmissionsAndCarbonCoefficientsDataGet(body);
|
|
425
|
+
console.log(data);
|
|
426
|
+
} catch (error) {
|
|
427
|
+
console.error(error);
|
|
428
|
+
}
|
|
429
|
+
}
|
|
430
|
+
|
|
431
|
+
// Run the test
|
|
432
|
+
example().catch(console.error);
|
|
433
|
+
```
|
|
434
|
+
|
|
435
|
+
### Parameters
|
|
436
|
+
|
|
437
|
+
|
|
438
|
+
| Name | Type | Description | Notes |
|
|
439
|
+
|------------- | ------------- | ------------- | -------------|
|
|
440
|
+
| **data** | `Array<string>` | Data columns to filter by | [Optional] |
|
|
441
|
+
| **facets** | `object` | Facets to filter by | [Optional] [Defaults to `undefined`] |
|
|
442
|
+
| **frequency** | `string` | Frequency to filter by | [Optional] [Defaults to `undefined`] |
|
|
443
|
+
| **start** | `string` | Start date to filter by | [Optional] [Defaults to `undefined`] |
|
|
444
|
+
| **end** | `string` | End date to filter by | [Optional] [Defaults to `undefined`] |
|
|
445
|
+
| **sort** | [](.md) | How to sort returned data | [Optional] [Defaults to `undefined`] |
|
|
446
|
+
| **length** | `number` | Max length of returned data | [Optional] [Defaults to `undefined`] |
|
|
447
|
+
| **offset** | `number` | Offset of returned data | [Optional] [Defaults to `undefined`] |
|
|
448
|
+
|
|
449
|
+
### Return type
|
|
450
|
+
|
|
451
|
+
[**DataResponseContainer**](DataResponseContainer.md)
|
|
452
|
+
|
|
453
|
+
### Authorization
|
|
454
|
+
|
|
455
|
+
[api_key](../README.md#api_key)
|
|
456
|
+
|
|
457
|
+
### HTTP request headers
|
|
458
|
+
|
|
459
|
+
- **Content-Type**: Not defined
|
|
460
|
+
- **Accept**: `application/json`
|
|
461
|
+
|
|
462
|
+
|
|
463
|
+
### HTTP response details
|
|
464
|
+
| Status code | Description | Response headers |
|
|
465
|
+
|-------------|-------------|------------------|
|
|
466
|
+
| **400** | Invalid input | - |
|
|
467
|
+
| **200** | API Data | - |
|
|
468
|
+
|
|
469
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
470
|
+
|
|
471
|
+
|
|
472
|
+
## v2Co2EmissionsCo2EmissionsAndCarbonCoefficientsDataPost
|
|
473
|
+
|
|
474
|
+
> DataResponseContainer v2Co2EmissionsCo2EmissionsAndCarbonCoefficientsDataPost(dataParams)
|
|
475
|
+
|
|
476
|
+
Return co2-emissions-and-carbon-coefficients Data
|
|
477
|
+
|
|
478
|
+
Class CO2EmissionsAndCarbonCoefficientsController CO2 Emissions Aggregates data set controller.
|
|
479
|
+
|
|
480
|
+
### Example
|
|
481
|
+
|
|
482
|
+
```ts
|
|
483
|
+
import {
|
|
484
|
+
Configuration,
|
|
485
|
+
EMISSApi,
|
|
486
|
+
} from '';
|
|
487
|
+
import type { V2Co2EmissionsCo2EmissionsAndCarbonCoefficientsDataPostRequest } from '';
|
|
488
|
+
|
|
489
|
+
async function example() {
|
|
490
|
+
console.log("🚀 Testing SDK...");
|
|
491
|
+
const config = new Configuration({
|
|
492
|
+
// To configure API key authorization: api_key
|
|
493
|
+
apiKey: "YOUR API KEY",
|
|
494
|
+
});
|
|
495
|
+
const api = new EMISSApi(config);
|
|
496
|
+
|
|
497
|
+
const body = {
|
|
498
|
+
// DataParams | Parameters for data call
|
|
499
|
+
dataParams: ...,
|
|
500
|
+
} satisfies V2Co2EmissionsCo2EmissionsAndCarbonCoefficientsDataPostRequest;
|
|
501
|
+
|
|
502
|
+
try {
|
|
503
|
+
const data = await api.v2Co2EmissionsCo2EmissionsAndCarbonCoefficientsDataPost(body);
|
|
504
|
+
console.log(data);
|
|
505
|
+
} catch (error) {
|
|
506
|
+
console.error(error);
|
|
507
|
+
}
|
|
508
|
+
}
|
|
509
|
+
|
|
510
|
+
// Run the test
|
|
511
|
+
example().catch(console.error);
|
|
512
|
+
```
|
|
513
|
+
|
|
514
|
+
### Parameters
|
|
515
|
+
|
|
516
|
+
|
|
517
|
+
| Name | Type | Description | Notes |
|
|
518
|
+
|------------- | ------------- | ------------- | -------------|
|
|
519
|
+
| **dataParams** | [DataParams](DataParams.md) | Parameters for data call | |
|
|
520
|
+
|
|
521
|
+
### Return type
|
|
522
|
+
|
|
523
|
+
[**DataResponseContainer**](DataResponseContainer.md)
|
|
524
|
+
|
|
525
|
+
### Authorization
|
|
526
|
+
|
|
527
|
+
[api_key](../README.md#api_key)
|
|
528
|
+
|
|
529
|
+
### HTTP request headers
|
|
530
|
+
|
|
531
|
+
- **Content-Type**: `application/json`
|
|
532
|
+
- **Accept**: `application/json`
|
|
533
|
+
|
|
534
|
+
|
|
535
|
+
### HTTP response details
|
|
536
|
+
| Status code | Description | Response headers |
|
|
537
|
+
|-------------|-------------|------------------|
|
|
538
|
+
| **400** | Invalid input | - |
|
|
539
|
+
| **200** | API Data | - |
|
|
540
|
+
|
|
541
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
542
|
+
|
|
543
|
+
|
|
544
|
+
## v2Co2EmissionsCo2EmissionsAndCarbonCoefficientsFacetFacetIdGet
|
|
545
|
+
|
|
546
|
+
> FacetDetailsContainer v2Co2EmissionsCo2EmissionsAndCarbonCoefficientsFacetFacetIdGet(facetId)
|
|
547
|
+
|
|
548
|
+
|
|
549
|
+
|
|
550
|
+
### Example
|
|
551
|
+
|
|
552
|
+
```ts
|
|
553
|
+
import {
|
|
554
|
+
Configuration,
|
|
555
|
+
EMISSApi,
|
|
556
|
+
} from '';
|
|
557
|
+
import type { V2Co2EmissionsCo2EmissionsAndCarbonCoefficientsFacetFacetIdGetRequest } from '';
|
|
558
|
+
|
|
559
|
+
async function example() {
|
|
560
|
+
console.log("🚀 Testing SDK...");
|
|
561
|
+
const config = new Configuration({
|
|
562
|
+
// To configure API key authorization: api_key
|
|
563
|
+
apiKey: "YOUR API KEY",
|
|
564
|
+
});
|
|
565
|
+
const api = new EMISSApi(config);
|
|
566
|
+
|
|
567
|
+
const body = {
|
|
568
|
+
// string | Facet ID
|
|
569
|
+
facetId: facetId_example,
|
|
570
|
+
} satisfies V2Co2EmissionsCo2EmissionsAndCarbonCoefficientsFacetFacetIdGetRequest;
|
|
571
|
+
|
|
572
|
+
try {
|
|
573
|
+
const data = await api.v2Co2EmissionsCo2EmissionsAndCarbonCoefficientsFacetFacetIdGet(body);
|
|
574
|
+
console.log(data);
|
|
575
|
+
} catch (error) {
|
|
576
|
+
console.error(error);
|
|
577
|
+
}
|
|
578
|
+
}
|
|
579
|
+
|
|
580
|
+
// Run the test
|
|
581
|
+
example().catch(console.error);
|
|
582
|
+
```
|
|
583
|
+
|
|
584
|
+
### Parameters
|
|
585
|
+
|
|
586
|
+
|
|
587
|
+
| Name | Type | Description | Notes |
|
|
588
|
+
|------------- | ------------- | ------------- | -------------|
|
|
589
|
+
| **facetId** | `string` | Facet ID | [Defaults to `undefined`] |
|
|
590
|
+
|
|
591
|
+
### Return type
|
|
592
|
+
|
|
593
|
+
[**FacetDetailsContainer**](FacetDetailsContainer.md)
|
|
594
|
+
|
|
595
|
+
### Authorization
|
|
596
|
+
|
|
597
|
+
[api_key](../README.md#api_key)
|
|
598
|
+
|
|
599
|
+
### HTTP request headers
|
|
600
|
+
|
|
601
|
+
- **Content-Type**: Not defined
|
|
602
|
+
- **Accept**: `application/json`
|
|
603
|
+
|
|
604
|
+
|
|
605
|
+
### HTTP response details
|
|
606
|
+
| Status code | Description | Response headers |
|
|
607
|
+
|-------------|-------------|------------------|
|
|
608
|
+
| **400** | Invalid input | - |
|
|
609
|
+
| **200** | Facet details | - |
|
|
610
|
+
|
|
611
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
612
|
+
|
|
613
|
+
|
|
614
|
+
## v2Co2EmissionsCo2EmissionsAndCarbonCoefficientsFacetGet
|
|
615
|
+
|
|
616
|
+
> FacetOptionListContainer v2Co2EmissionsCo2EmissionsAndCarbonCoefficientsFacetGet()
|
|
617
|
+
|
|
618
|
+
|
|
619
|
+
|
|
620
|
+
### Example
|
|
621
|
+
|
|
622
|
+
```ts
|
|
623
|
+
import {
|
|
624
|
+
Configuration,
|
|
625
|
+
EMISSApi,
|
|
626
|
+
} from '';
|
|
627
|
+
import type { V2Co2EmissionsCo2EmissionsAndCarbonCoefficientsFacetGetRequest } from '';
|
|
628
|
+
|
|
629
|
+
async function example() {
|
|
630
|
+
console.log("🚀 Testing SDK...");
|
|
631
|
+
const config = new Configuration({
|
|
632
|
+
// To configure API key authorization: api_key
|
|
633
|
+
apiKey: "YOUR API KEY",
|
|
634
|
+
});
|
|
635
|
+
const api = new EMISSApi(config);
|
|
636
|
+
|
|
637
|
+
try {
|
|
638
|
+
const data = await api.v2Co2EmissionsCo2EmissionsAndCarbonCoefficientsFacetGet();
|
|
639
|
+
console.log(data);
|
|
640
|
+
} catch (error) {
|
|
641
|
+
console.error(error);
|
|
642
|
+
}
|
|
643
|
+
}
|
|
644
|
+
|
|
645
|
+
// Run the test
|
|
646
|
+
example().catch(console.error);
|
|
647
|
+
```
|
|
648
|
+
|
|
649
|
+
### Parameters
|
|
650
|
+
|
|
651
|
+
This endpoint does not need any parameter.
|
|
652
|
+
|
|
653
|
+
### Return type
|
|
654
|
+
|
|
655
|
+
[**FacetOptionListContainer**](FacetOptionListContainer.md)
|
|
656
|
+
|
|
657
|
+
### Authorization
|
|
658
|
+
|
|
659
|
+
[api_key](../README.md#api_key)
|
|
660
|
+
|
|
661
|
+
### HTTP request headers
|
|
662
|
+
|
|
663
|
+
- **Content-Type**: Not defined
|
|
664
|
+
- **Accept**: `application/json`
|
|
665
|
+
|
|
666
|
+
|
|
667
|
+
### HTTP response details
|
|
668
|
+
| Status code | Description | Response headers |
|
|
669
|
+
|-------------|-------------|------------------|
|
|
670
|
+
| **400** | Invalid input | - |
|
|
671
|
+
| **200** | List of facet options | - |
|
|
672
|
+
|
|
673
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
674
|
+
|
|
675
|
+
|
|
676
|
+
## v2Co2EmissionsCo2EmissionsAndCarbonCoefficientsGet
|
|
677
|
+
|
|
678
|
+
> FinalRouteResponseContainer v2Co2EmissionsCo2EmissionsAndCarbonCoefficientsGet()
|
|
679
|
+
|
|
680
|
+
|
|
681
|
+
|
|
682
|
+
### Example
|
|
683
|
+
|
|
684
|
+
```ts
|
|
685
|
+
import {
|
|
686
|
+
Configuration,
|
|
687
|
+
EMISSApi,
|
|
688
|
+
} from '';
|
|
689
|
+
import type { V2Co2EmissionsCo2EmissionsAndCarbonCoefficientsGetRequest } from '';
|
|
690
|
+
|
|
691
|
+
async function example() {
|
|
692
|
+
console.log("🚀 Testing SDK...");
|
|
693
|
+
const config = new Configuration({
|
|
694
|
+
// To configure API key authorization: api_key
|
|
695
|
+
apiKey: "YOUR API KEY",
|
|
696
|
+
});
|
|
697
|
+
const api = new EMISSApi(config);
|
|
698
|
+
|
|
699
|
+
try {
|
|
700
|
+
const data = await api.v2Co2EmissionsCo2EmissionsAndCarbonCoefficientsGet();
|
|
701
|
+
console.log(data);
|
|
702
|
+
} catch (error) {
|
|
703
|
+
console.error(error);
|
|
704
|
+
}
|
|
705
|
+
}
|
|
706
|
+
|
|
707
|
+
// Run the test
|
|
708
|
+
example().catch(console.error);
|
|
709
|
+
```
|
|
710
|
+
|
|
711
|
+
### Parameters
|
|
712
|
+
|
|
713
|
+
This endpoint does not need any parameter.
|
|
714
|
+
|
|
715
|
+
### Return type
|
|
716
|
+
|
|
717
|
+
[**FinalRouteResponseContainer**](FinalRouteResponseContainer.md)
|
|
718
|
+
|
|
719
|
+
### Authorization
|
|
720
|
+
|
|
721
|
+
[api_key](../README.md#api_key)
|
|
722
|
+
|
|
723
|
+
### HTTP request headers
|
|
724
|
+
|
|
725
|
+
- **Content-Type**: Not defined
|
|
726
|
+
- **Accept**: `application/json`
|
|
727
|
+
|
|
728
|
+
|
|
729
|
+
### HTTP response details
|
|
730
|
+
| Status code | Description | Response headers |
|
|
731
|
+
|-------------|-------------|------------------|
|
|
732
|
+
| **200** | List of API data sets | - |
|
|
733
|
+
|
|
734
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
735
|
+
|
|
736
|
+
|
|
737
|
+
## v2Co2EmissionsGet
|
|
738
|
+
|
|
739
|
+
> RouteResponseContainer v2Co2EmissionsGet()
|
|
740
|
+
|
|
741
|
+
Class CO2EmissionsController
|
|
742
|
+
|
|
743
|
+
CO2 Emissions data set top-level controller.
|
|
744
|
+
|
|
745
|
+
### Example
|
|
746
|
+
|
|
747
|
+
```ts
|
|
748
|
+
import {
|
|
749
|
+
Configuration,
|
|
750
|
+
EMISSApi,
|
|
751
|
+
} from '';
|
|
752
|
+
import type { V2Co2EmissionsGetRequest } from '';
|
|
753
|
+
|
|
754
|
+
async function example() {
|
|
755
|
+
console.log("🚀 Testing SDK...");
|
|
756
|
+
const config = new Configuration({
|
|
757
|
+
// To configure API key authorization: api_key
|
|
758
|
+
apiKey: "YOUR API KEY",
|
|
759
|
+
});
|
|
760
|
+
const api = new EMISSApi(config);
|
|
761
|
+
|
|
762
|
+
try {
|
|
763
|
+
const data = await api.v2Co2EmissionsGet();
|
|
764
|
+
console.log(data);
|
|
765
|
+
} catch (error) {
|
|
766
|
+
console.error(error);
|
|
767
|
+
}
|
|
768
|
+
}
|
|
769
|
+
|
|
770
|
+
// Run the test
|
|
771
|
+
example().catch(console.error);
|
|
772
|
+
```
|
|
773
|
+
|
|
774
|
+
### Parameters
|
|
775
|
+
|
|
776
|
+
This endpoint does not need any parameter.
|
|
777
|
+
|
|
778
|
+
### Return type
|
|
779
|
+
|
|
780
|
+
[**RouteResponseContainer**](RouteResponseContainer.md)
|
|
781
|
+
|
|
782
|
+
### Authorization
|
|
783
|
+
|
|
784
|
+
[api_key](../README.md#api_key)
|
|
785
|
+
|
|
786
|
+
### HTTP request headers
|
|
787
|
+
|
|
788
|
+
- **Content-Type**: Not defined
|
|
789
|
+
- **Accept**: `application/json`
|
|
790
|
+
|
|
791
|
+
|
|
792
|
+
### HTTP response details
|
|
793
|
+
| Status code | Description | Response headers |
|
|
794
|
+
|-------------|-------------|------------------|
|
|
795
|
+
| **200** | List of API data sets | - |
|
|
796
|
+
|
|
797
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
798
|
+
|