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.
Files changed (76) hide show
  1. package/.openapi-generator/FILES +73 -0
  2. package/.openapi-generator/VERSION +1 -0
  3. package/.openapi-generator-ignore +23 -0
  4. package/apis/AEOApi.ts +415 -0
  5. package/apis/COALApi.ts +3645 -0
  6. package/apis/CRUDIMPORTSApi.ts +322 -0
  7. package/apis/DBFApi.ts +2260 -0
  8. package/apis/ELECApi.ts +1180 -0
  9. package/apis/EMISSApi.ts +640 -0
  10. package/apis/IEOApi.ts +415 -0
  11. package/apis/INTLApi.ts +322 -0
  12. package/apis/NGApi.ts +511 -0
  13. package/apis/NUCSTATUSApi.ts +910 -0
  14. package/apis/RTOApi.ts +2260 -0
  15. package/apis/RootApi.ts +66 -0
  16. package/apis/SEDSApi.ts +322 -0
  17. package/apis/SEPApi.ts +1990 -0
  18. package/apis/STEOApi.ts +322 -0
  19. package/apis/TOTALApi.ts +322 -0
  20. package/apis/index.ts +18 -0
  21. package/docs/AEOApi.md +456 -0
  22. package/docs/COALApi.md +4847 -0
  23. package/docs/CRUDIMPORTSApi.md +371 -0
  24. package/docs/DBFApi.md +2976 -0
  25. package/docs/DataParams.md +48 -0
  26. package/docs/DataResponse.md +42 -0
  27. package/docs/DataResponseContainer.md +38 -0
  28. package/docs/ELECApi.md +1524 -0
  29. package/docs/EMISSApi.md +798 -0
  30. package/docs/Facet.md +38 -0
  31. package/docs/FacetDetails.md +36 -0
  32. package/docs/FacetDetailsContainer.md +38 -0
  33. package/docs/FacetMetaData.md +36 -0
  34. package/docs/FacetOptionList.md +36 -0
  35. package/docs/FacetOptionListContainer.md +38 -0
  36. package/docs/FinalRoute.md +52 -0
  37. package/docs/FinalRouteResponse.md +36 -0
  38. package/docs/FinalRouteResponseContainer.md +38 -0
  39. package/docs/Frequency.md +40 -0
  40. package/docs/IEOApi.md +456 -0
  41. package/docs/INTLApi.md +371 -0
  42. package/docs/NGApi.md +541 -0
  43. package/docs/NUCSTATUSApi.md +1161 -0
  44. package/docs/RTOApi.md +2976 -0
  45. package/docs/RootApi.md +70 -0
  46. package/docs/RouteRequest.md +36 -0
  47. package/docs/RouteResponse.md +36 -0
  48. package/docs/RouteResponseContainer.md +38 -0
  49. package/docs/Routes.md +40 -0
  50. package/docs/SEDSApi.md +372 -0
  51. package/docs/SEPApi.md +2613 -0
  52. package/docs/STEOApi.md +371 -0
  53. package/docs/Sort.md +36 -0
  54. package/docs/TOTALApi.md +371 -0
  55. package/index.ts +5 -0
  56. package/models/DataParams.ts +129 -0
  57. package/models/DataResponse.ts +97 -0
  58. package/models/DataResponseContainer.ts +96 -0
  59. package/models/Facet.ts +81 -0
  60. package/models/FacetDetails.ts +81 -0
  61. package/models/FacetDetailsContainer.ts +96 -0
  62. package/models/FacetMetaData.ts +73 -0
  63. package/models/FacetOptionList.ts +73 -0
  64. package/models/FacetOptionListContainer.ts +96 -0
  65. package/models/FinalRoute.ts +152 -0
  66. package/models/FinalRouteResponse.ts +88 -0
  67. package/models/FinalRouteResponseContainer.ts +96 -0
  68. package/models/Frequency.ts +89 -0
  69. package/models/RouteRequest.ts +73 -0
  70. package/models/RouteResponse.ts +88 -0
  71. package/models/RouteResponseContainer.ts +96 -0
  72. package/models/Routes.ts +89 -0
  73. package/models/Sort.ts +73 -0
  74. package/models/index.ts +20 -0
  75. package/package.json +15 -0
  76. package/runtime.ts +449 -0
package/docs/DBFApi.md ADDED
@@ -0,0 +1,2976 @@
1
+ # DBFApi
2
+
3
+ All URIs are relative to *https://api.eia.gov*
4
+
5
+ | Method | HTTP request | Description |
6
+ |------------- | ------------- | -------------|
7
+ | [**v2DensifiedBiomassCapacityByRegionDataGet**](DBFApi.md#v2densifiedbiomasscapacitybyregiondataget) | **GET** /v2/densified-biomass/capacity-by-region/data | |
8
+ | [**v2DensifiedBiomassCapacityByRegionDataPost**](DBFApi.md#v2densifiedbiomasscapacitybyregiondatapost) | **POST** /v2/densified-biomass/capacity-by-region/data | Return biomass capacity-by-region Data |
9
+ | [**v2DensifiedBiomassCapacityByRegionFacetFacetIdGet**](DBFApi.md#v2densifiedbiomasscapacitybyregionfacetfacetidget) | **GET** /v2/densified-biomass/capacity-by-region/facet/{facet_id} | |
10
+ | [**v2DensifiedBiomassCapacityByRegionFacetGet**](DBFApi.md#v2densifiedbiomasscapacitybyregionfacetget) | **GET** /v2/densified-biomass/capacity-by-region/facet | |
11
+ | [**v2DensifiedBiomassCapacityByRegionGet**](DBFApi.md#v2densifiedbiomasscapacitybyregionget) | **GET** /v2/densified-biomass/capacity-by-region | |
12
+ | [**v2DensifiedBiomassCharacteristicsByRegionDataGet**](DBFApi.md#v2densifiedbiomasscharacteristicsbyregiondataget) | **GET** /v2/densified-biomass/characteristics-by-region/data | |
13
+ | [**v2DensifiedBiomassCharacteristicsByRegionDataPost**](DBFApi.md#v2densifiedbiomasscharacteristicsbyregiondatapost) | **POST** /v2/densified-biomass/characteristics-by-region/data | Return biomass characteristics-by-region Data |
14
+ | [**v2DensifiedBiomassCharacteristicsByRegionFacetFacetIdGet**](DBFApi.md#v2densifiedbiomasscharacteristicsbyregionfacetfacetidget) | **GET** /v2/densified-biomass/characteristics-by-region/facet/{facet_id} | |
15
+ | [**v2DensifiedBiomassCharacteristicsByRegionFacetGet**](DBFApi.md#v2densifiedbiomasscharacteristicsbyregionfacetget) | **GET** /v2/densified-biomass/characteristics-by-region/facet | |
16
+ | [**v2DensifiedBiomassCharacteristicsByRegionGet**](DBFApi.md#v2densifiedbiomasscharacteristicsbyregionget) | **GET** /v2/densified-biomass/characteristics-by-region | |
17
+ | [**v2DensifiedBiomassExportSalesAndPriceDataGet**](DBFApi.md#v2densifiedbiomassexportsalesandpricedataget) | **GET** /v2/densified-biomass/export-sales-and-price/data | |
18
+ | [**v2DensifiedBiomassExportSalesAndPriceDataPost**](DBFApi.md#v2densifiedbiomassexportsalesandpricedatapost) | **POST** /v2/densified-biomass/export-sales-and-price/data | Return biomass export-sales-and-price Data |
19
+ | [**v2DensifiedBiomassExportSalesAndPriceFacetFacetIdGet**](DBFApi.md#v2densifiedbiomassexportsalesandpricefacetfacetidget) | **GET** /v2/densified-biomass/export-sales-and-price/facet/{facet_id} | |
20
+ | [**v2DensifiedBiomassExportSalesAndPriceFacetGet**](DBFApi.md#v2densifiedbiomassexportsalesandpricefacetget) | **GET** /v2/densified-biomass/export-sales-and-price/facet | |
21
+ | [**v2DensifiedBiomassExportSalesAndPriceGet**](DBFApi.md#v2densifiedbiomassexportsalesandpriceget) | **GET** /v2/densified-biomass/export-sales-and-price | |
22
+ | [**v2DensifiedBiomassFeedstocksAndCostDataGet**](DBFApi.md#v2densifiedbiomassfeedstocksandcostdataget) | **GET** /v2/densified-biomass/feedstocks-and-cost/data | |
23
+ | [**v2DensifiedBiomassFeedstocksAndCostDataPost**](DBFApi.md#v2densifiedbiomassfeedstocksandcostdatapost) | **POST** /v2/densified-biomass/feedstocks-and-cost/data | Return biomass feedstocks-and-cost Data |
24
+ | [**v2DensifiedBiomassFeedstocksAndCostFacetFacetIdGet**](DBFApi.md#v2densifiedbiomassfeedstocksandcostfacetfacetidget) | **GET** /v2/densified-biomass/feedstocks-and-cost/facet/{facet_id} | |
25
+ | [**v2DensifiedBiomassFeedstocksAndCostFacetGet**](DBFApi.md#v2densifiedbiomassfeedstocksandcostfacetget) | **GET** /v2/densified-biomass/feedstocks-and-cost/facet | |
26
+ | [**v2DensifiedBiomassFeedstocksAndCostGet**](DBFApi.md#v2densifiedbiomassfeedstocksandcostget) | **GET** /v2/densified-biomass/feedstocks-and-cost | |
27
+ | [**v2DensifiedBiomassGet**](DBFApi.md#v2densifiedbiomassget) | **GET** /v2/densified-biomass | Class Controller |
28
+ | [**v2DensifiedBiomassInventoriesByRegionDataGet**](DBFApi.md#v2densifiedbiomassinventoriesbyregiondataget) | **GET** /v2/densified-biomass/inventories-by-region/data | |
29
+ | [**v2DensifiedBiomassInventoriesByRegionDataPost**](DBFApi.md#v2densifiedbiomassinventoriesbyregiondatapost) | **POST** /v2/densified-biomass/inventories-by-region/data | Return biomass inventories-by-region Data |
30
+ | [**v2DensifiedBiomassInventoriesByRegionFacetFacetIdGet**](DBFApi.md#v2densifiedbiomassinventoriesbyregionfacetfacetidget) | **GET** /v2/densified-biomass/inventories-by-region/facet/{facet_id} | |
31
+ | [**v2DensifiedBiomassInventoriesByRegionFacetGet**](DBFApi.md#v2densifiedbiomassinventoriesbyregionfacetget) | **GET** /v2/densified-biomass/inventories-by-region/facet | |
32
+ | [**v2DensifiedBiomassInventoriesByRegionGet**](DBFApi.md#v2densifiedbiomassinventoriesbyregionget) | **GET** /v2/densified-biomass/inventories-by-region | |
33
+ | [**v2DensifiedBiomassProductionByRegionDataGet**](DBFApi.md#v2densifiedbiomassproductionbyregiondataget) | **GET** /v2/densified-biomass/production-by-region/data | |
34
+ | [**v2DensifiedBiomassProductionByRegionDataPost**](DBFApi.md#v2densifiedbiomassproductionbyregiondatapost) | **POST** /v2/densified-biomass/production-by-region/data | Return biomass production-by-region Data |
35
+ | [**v2DensifiedBiomassProductionByRegionFacetFacetIdGet**](DBFApi.md#v2densifiedbiomassproductionbyregionfacetfacetidget) | **GET** /v2/densified-biomass/production-by-region/facet/{facet_id} | |
36
+ | [**v2DensifiedBiomassProductionByRegionFacetGet**](DBFApi.md#v2densifiedbiomassproductionbyregionfacetget) | **GET** /v2/densified-biomass/production-by-region/facet | |
37
+ | [**v2DensifiedBiomassProductionByRegionGet**](DBFApi.md#v2densifiedbiomassproductionbyregionget) | **GET** /v2/densified-biomass/production-by-region | |
38
+ | [**v2DensifiedBiomassSalesAndPriceByRegionDataGet**](DBFApi.md#v2densifiedbiomasssalesandpricebyregiondataget) | **GET** /v2/densified-biomass/sales-and-price-by-region/data | |
39
+ | [**v2DensifiedBiomassSalesAndPriceByRegionDataPost**](DBFApi.md#v2densifiedbiomasssalesandpricebyregiondatapost) | **POST** /v2/densified-biomass/sales-and-price-by-region/data | Return biomass sales-and-price-by-region Data |
40
+ | [**v2DensifiedBiomassSalesAndPriceByRegionFacetFacetIdGet**](DBFApi.md#v2densifiedbiomasssalesandpricebyregionfacetfacetidget) | **GET** /v2/densified-biomass/sales-and-price-by-region/facet/{facet_id} | |
41
+ | [**v2DensifiedBiomassSalesAndPriceByRegionFacetGet**](DBFApi.md#v2densifiedbiomasssalesandpricebyregionfacetget) | **GET** /v2/densified-biomass/sales-and-price-by-region/facet | |
42
+ | [**v2DensifiedBiomassSalesAndPriceByRegionGet**](DBFApi.md#v2densifiedbiomasssalesandpricebyregionget) | **GET** /v2/densified-biomass/sales-and-price-by-region | |
43
+ | [**v2DensifiedBiomassWoodPelletPlantsDataGet**](DBFApi.md#v2densifiedbiomasswoodpelletplantsdataget) | **GET** /v2/densified-biomass/wood-pellet-plants/data | |
44
+ | [**v2DensifiedBiomassWoodPelletPlantsDataPost**](DBFApi.md#v2densifiedbiomasswoodpelletplantsdatapost) | **POST** /v2/densified-biomass/wood-pellet-plants/data | Return biomass wood-pellet-plants Data |
45
+ | [**v2DensifiedBiomassWoodPelletPlantsFacetFacetIdGet**](DBFApi.md#v2densifiedbiomasswoodpelletplantsfacetfacetidget) | **GET** /v2/densified-biomass/wood-pellet-plants/facet/{facet_id} | |
46
+ | [**v2DensifiedBiomassWoodPelletPlantsFacetGet**](DBFApi.md#v2densifiedbiomasswoodpelletplantsfacetget) | **GET** /v2/densified-biomass/wood-pellet-plants/facet | |
47
+ | [**v2DensifiedBiomassWoodPelletPlantsGet**](DBFApi.md#v2densifiedbiomasswoodpelletplantsget) | **GET** /v2/densified-biomass/wood-pellet-plants | |
48
+
49
+
50
+
51
+ ## v2DensifiedBiomassCapacityByRegionDataGet
52
+
53
+ > DataResponseContainer v2DensifiedBiomassCapacityByRegionDataGet(data, facets, frequency, start, end, sort, length, offset)
54
+
55
+
56
+
57
+ API data with query params
58
+
59
+ ### Example
60
+
61
+ ```ts
62
+ import {
63
+ Configuration,
64
+ DBFApi,
65
+ } from '';
66
+ import type { V2DensifiedBiomassCapacityByRegionDataGetRequest } from '';
67
+
68
+ async function example() {
69
+ console.log("🚀 Testing SDK...");
70
+ const config = new Configuration({
71
+ // To configure API key authorization: api_key
72
+ apiKey: "YOUR API KEY",
73
+ });
74
+ const api = new DBFApi(config);
75
+
76
+ const body = {
77
+ // Array<string> | Data columns to filter by (optional)
78
+ data: ...,
79
+ // object | Facets to filter by (optional)
80
+ facets: Object,
81
+ // string | Frequency to filter by (optional)
82
+ frequency: frequency_example,
83
+ // string | Start date to filter by (optional)
84
+ start: start_example,
85
+ // string | End date to filter by (optional)
86
+ end: end_example,
87
+ // Sort | How to sort returned data (optional)
88
+ sort: ...,
89
+ // number | Max length of returned data (optional)
90
+ length: 56,
91
+ // number | Offset of returned data (optional)
92
+ offset: 56,
93
+ } satisfies V2DensifiedBiomassCapacityByRegionDataGetRequest;
94
+
95
+ try {
96
+ const data = await api.v2DensifiedBiomassCapacityByRegionDataGet(body);
97
+ console.log(data);
98
+ } catch (error) {
99
+ console.error(error);
100
+ }
101
+ }
102
+
103
+ // Run the test
104
+ example().catch(console.error);
105
+ ```
106
+
107
+ ### Parameters
108
+
109
+
110
+ | Name | Type | Description | Notes |
111
+ |------------- | ------------- | ------------- | -------------|
112
+ | **data** | `Array<string>` | Data columns to filter by | [Optional] |
113
+ | **facets** | `object` | Facets to filter by | [Optional] [Defaults to `undefined`] |
114
+ | **frequency** | `string` | Frequency to filter by | [Optional] [Defaults to `undefined`] |
115
+ | **start** | `string` | Start date to filter by | [Optional] [Defaults to `undefined`] |
116
+ | **end** | `string` | End date to filter by | [Optional] [Defaults to `undefined`] |
117
+ | **sort** | [](.md) | How to sort returned data | [Optional] [Defaults to `undefined`] |
118
+ | **length** | `number` | Max length of returned data | [Optional] [Defaults to `undefined`] |
119
+ | **offset** | `number` | Offset of returned data | [Optional] [Defaults to `undefined`] |
120
+
121
+ ### Return type
122
+
123
+ [**DataResponseContainer**](DataResponseContainer.md)
124
+
125
+ ### Authorization
126
+
127
+ [api_key](../README.md#api_key)
128
+
129
+ ### HTTP request headers
130
+
131
+ - **Content-Type**: Not defined
132
+ - **Accept**: `application/json`
133
+
134
+
135
+ ### HTTP response details
136
+ | Status code | Description | Response headers |
137
+ |-------------|-------------|------------------|
138
+ | **400** | Invalid input | - |
139
+ | **200** | API Data | - |
140
+
141
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
142
+
143
+
144
+ ## v2DensifiedBiomassCapacityByRegionDataPost
145
+
146
+ > DataResponseContainer v2DensifiedBiomassCapacityByRegionDataPost(dataParams)
147
+
148
+ Return biomass capacity-by-region Data
149
+
150
+ Class CapacityByRegionController CapacityByRegion data set top-level controller.
151
+
152
+ ### Example
153
+
154
+ ```ts
155
+ import {
156
+ Configuration,
157
+ DBFApi,
158
+ } from '';
159
+ import type { V2DensifiedBiomassCapacityByRegionDataPostRequest } from '';
160
+
161
+ async function example() {
162
+ console.log("🚀 Testing SDK...");
163
+ const config = new Configuration({
164
+ // To configure API key authorization: api_key
165
+ apiKey: "YOUR API KEY",
166
+ });
167
+ const api = new DBFApi(config);
168
+
169
+ const body = {
170
+ // DataParams | Parameters for data call
171
+ dataParams: ...,
172
+ } satisfies V2DensifiedBiomassCapacityByRegionDataPostRequest;
173
+
174
+ try {
175
+ const data = await api.v2DensifiedBiomassCapacityByRegionDataPost(body);
176
+ console.log(data);
177
+ } catch (error) {
178
+ console.error(error);
179
+ }
180
+ }
181
+
182
+ // Run the test
183
+ example().catch(console.error);
184
+ ```
185
+
186
+ ### Parameters
187
+
188
+
189
+ | Name | Type | Description | Notes |
190
+ |------------- | ------------- | ------------- | -------------|
191
+ | **dataParams** | [DataParams](DataParams.md) | Parameters for data call | |
192
+
193
+ ### Return type
194
+
195
+ [**DataResponseContainer**](DataResponseContainer.md)
196
+
197
+ ### Authorization
198
+
199
+ [api_key](../README.md#api_key)
200
+
201
+ ### HTTP request headers
202
+
203
+ - **Content-Type**: `application/json`
204
+ - **Accept**: `application/json`
205
+
206
+
207
+ ### HTTP response details
208
+ | Status code | Description | Response headers |
209
+ |-------------|-------------|------------------|
210
+ | **400** | Invalid input | - |
211
+ | **200** | API Data | - |
212
+
213
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
214
+
215
+
216
+ ## v2DensifiedBiomassCapacityByRegionFacetFacetIdGet
217
+
218
+ > FacetDetailsContainer v2DensifiedBiomassCapacityByRegionFacetFacetIdGet(facetId)
219
+
220
+
221
+
222
+ ### Example
223
+
224
+ ```ts
225
+ import {
226
+ Configuration,
227
+ DBFApi,
228
+ } from '';
229
+ import type { V2DensifiedBiomassCapacityByRegionFacetFacetIdGetRequest } from '';
230
+
231
+ async function example() {
232
+ console.log("🚀 Testing SDK...");
233
+ const config = new Configuration({
234
+ // To configure API key authorization: api_key
235
+ apiKey: "YOUR API KEY",
236
+ });
237
+ const api = new DBFApi(config);
238
+
239
+ const body = {
240
+ // string | Facet ID
241
+ facetId: facetId_example,
242
+ } satisfies V2DensifiedBiomassCapacityByRegionFacetFacetIdGetRequest;
243
+
244
+ try {
245
+ const data = await api.v2DensifiedBiomassCapacityByRegionFacetFacetIdGet(body);
246
+ console.log(data);
247
+ } catch (error) {
248
+ console.error(error);
249
+ }
250
+ }
251
+
252
+ // Run the test
253
+ example().catch(console.error);
254
+ ```
255
+
256
+ ### Parameters
257
+
258
+
259
+ | Name | Type | Description | Notes |
260
+ |------------- | ------------- | ------------- | -------------|
261
+ | **facetId** | `string` | Facet ID | [Defaults to `undefined`] |
262
+
263
+ ### Return type
264
+
265
+ [**FacetDetailsContainer**](FacetDetailsContainer.md)
266
+
267
+ ### Authorization
268
+
269
+ [api_key](../README.md#api_key)
270
+
271
+ ### HTTP request headers
272
+
273
+ - **Content-Type**: Not defined
274
+ - **Accept**: `application/json`
275
+
276
+
277
+ ### HTTP response details
278
+ | Status code | Description | Response headers |
279
+ |-------------|-------------|------------------|
280
+ | **400** | Invalid input | - |
281
+ | **200** | Facet details | - |
282
+
283
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
284
+
285
+
286
+ ## v2DensifiedBiomassCapacityByRegionFacetGet
287
+
288
+ > FacetOptionListContainer v2DensifiedBiomassCapacityByRegionFacetGet()
289
+
290
+
291
+
292
+ ### Example
293
+
294
+ ```ts
295
+ import {
296
+ Configuration,
297
+ DBFApi,
298
+ } from '';
299
+ import type { V2DensifiedBiomassCapacityByRegionFacetGetRequest } from '';
300
+
301
+ async function example() {
302
+ console.log("🚀 Testing SDK...");
303
+ const config = new Configuration({
304
+ // To configure API key authorization: api_key
305
+ apiKey: "YOUR API KEY",
306
+ });
307
+ const api = new DBFApi(config);
308
+
309
+ try {
310
+ const data = await api.v2DensifiedBiomassCapacityByRegionFacetGet();
311
+ console.log(data);
312
+ } catch (error) {
313
+ console.error(error);
314
+ }
315
+ }
316
+
317
+ // Run the test
318
+ example().catch(console.error);
319
+ ```
320
+
321
+ ### Parameters
322
+
323
+ This endpoint does not need any parameter.
324
+
325
+ ### Return type
326
+
327
+ [**FacetOptionListContainer**](FacetOptionListContainer.md)
328
+
329
+ ### Authorization
330
+
331
+ [api_key](../README.md#api_key)
332
+
333
+ ### HTTP request headers
334
+
335
+ - **Content-Type**: Not defined
336
+ - **Accept**: `application/json`
337
+
338
+
339
+ ### HTTP response details
340
+ | Status code | Description | Response headers |
341
+ |-------------|-------------|------------------|
342
+ | **400** | Invalid input | - |
343
+ | **200** | List of facet options | - |
344
+
345
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
346
+
347
+
348
+ ## v2DensifiedBiomassCapacityByRegionGet
349
+
350
+ > FinalRouteResponseContainer v2DensifiedBiomassCapacityByRegionGet()
351
+
352
+
353
+
354
+ ### Example
355
+
356
+ ```ts
357
+ import {
358
+ Configuration,
359
+ DBFApi,
360
+ } from '';
361
+ import type { V2DensifiedBiomassCapacityByRegionGetRequest } from '';
362
+
363
+ async function example() {
364
+ console.log("🚀 Testing SDK...");
365
+ const config = new Configuration({
366
+ // To configure API key authorization: api_key
367
+ apiKey: "YOUR API KEY",
368
+ });
369
+ const api = new DBFApi(config);
370
+
371
+ try {
372
+ const data = await api.v2DensifiedBiomassCapacityByRegionGet();
373
+ console.log(data);
374
+ } catch (error) {
375
+ console.error(error);
376
+ }
377
+ }
378
+
379
+ // Run the test
380
+ example().catch(console.error);
381
+ ```
382
+
383
+ ### Parameters
384
+
385
+ This endpoint does not need any parameter.
386
+
387
+ ### Return type
388
+
389
+ [**FinalRouteResponseContainer**](FinalRouteResponseContainer.md)
390
+
391
+ ### Authorization
392
+
393
+ [api_key](../README.md#api_key)
394
+
395
+ ### HTTP request headers
396
+
397
+ - **Content-Type**: Not defined
398
+ - **Accept**: `application/json`
399
+
400
+
401
+ ### HTTP response details
402
+ | Status code | Description | Response headers |
403
+ |-------------|-------------|------------------|
404
+ | **200** | List of API data sets | - |
405
+
406
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
407
+
408
+
409
+ ## v2DensifiedBiomassCharacteristicsByRegionDataGet
410
+
411
+ > DataResponseContainer v2DensifiedBiomassCharacteristicsByRegionDataGet(data, facets, frequency, start, end, sort, length, offset)
412
+
413
+
414
+
415
+ API data with query params
416
+
417
+ ### Example
418
+
419
+ ```ts
420
+ import {
421
+ Configuration,
422
+ DBFApi,
423
+ } from '';
424
+ import type { V2DensifiedBiomassCharacteristicsByRegionDataGetRequest } from '';
425
+
426
+ async function example() {
427
+ console.log("🚀 Testing SDK...");
428
+ const config = new Configuration({
429
+ // To configure API key authorization: api_key
430
+ apiKey: "YOUR API KEY",
431
+ });
432
+ const api = new DBFApi(config);
433
+
434
+ const body = {
435
+ // Array<string> | Data columns to filter by (optional)
436
+ data: ...,
437
+ // object | Facets to filter by (optional)
438
+ facets: Object,
439
+ // string | Frequency to filter by (optional)
440
+ frequency: frequency_example,
441
+ // string | Start date to filter by (optional)
442
+ start: start_example,
443
+ // string | End date to filter by (optional)
444
+ end: end_example,
445
+ // Sort | How to sort returned data (optional)
446
+ sort: ...,
447
+ // number | Max length of returned data (optional)
448
+ length: 56,
449
+ // number | Offset of returned data (optional)
450
+ offset: 56,
451
+ } satisfies V2DensifiedBiomassCharacteristicsByRegionDataGetRequest;
452
+
453
+ try {
454
+ const data = await api.v2DensifiedBiomassCharacteristicsByRegionDataGet(body);
455
+ console.log(data);
456
+ } catch (error) {
457
+ console.error(error);
458
+ }
459
+ }
460
+
461
+ // Run the test
462
+ example().catch(console.error);
463
+ ```
464
+
465
+ ### Parameters
466
+
467
+
468
+ | Name | Type | Description | Notes |
469
+ |------------- | ------------- | ------------- | -------------|
470
+ | **data** | `Array<string>` | Data columns to filter by | [Optional] |
471
+ | **facets** | `object` | Facets to filter by | [Optional] [Defaults to `undefined`] |
472
+ | **frequency** | `string` | Frequency to filter by | [Optional] [Defaults to `undefined`] |
473
+ | **start** | `string` | Start date to filter by | [Optional] [Defaults to `undefined`] |
474
+ | **end** | `string` | End date to filter by | [Optional] [Defaults to `undefined`] |
475
+ | **sort** | [](.md) | How to sort returned data | [Optional] [Defaults to `undefined`] |
476
+ | **length** | `number` | Max length of returned data | [Optional] [Defaults to `undefined`] |
477
+ | **offset** | `number` | Offset of returned data | [Optional] [Defaults to `undefined`] |
478
+
479
+ ### Return type
480
+
481
+ [**DataResponseContainer**](DataResponseContainer.md)
482
+
483
+ ### Authorization
484
+
485
+ [api_key](../README.md#api_key)
486
+
487
+ ### HTTP request headers
488
+
489
+ - **Content-Type**: Not defined
490
+ - **Accept**: `application/json`
491
+
492
+
493
+ ### HTTP response details
494
+ | Status code | Description | Response headers |
495
+ |-------------|-------------|------------------|
496
+ | **400** | Invalid input | - |
497
+ | **200** | API Data | - |
498
+
499
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
500
+
501
+
502
+ ## v2DensifiedBiomassCharacteristicsByRegionDataPost
503
+
504
+ > DataResponseContainer v2DensifiedBiomassCharacteristicsByRegionDataPost(dataParams)
505
+
506
+ Return biomass characteristics-by-region Data
507
+
508
+ Class CharacteristicsByRegionController CharacteristicsByRegion data set top-level controller.
509
+
510
+ ### Example
511
+
512
+ ```ts
513
+ import {
514
+ Configuration,
515
+ DBFApi,
516
+ } from '';
517
+ import type { V2DensifiedBiomassCharacteristicsByRegionDataPostRequest } from '';
518
+
519
+ async function example() {
520
+ console.log("🚀 Testing SDK...");
521
+ const config = new Configuration({
522
+ // To configure API key authorization: api_key
523
+ apiKey: "YOUR API KEY",
524
+ });
525
+ const api = new DBFApi(config);
526
+
527
+ const body = {
528
+ // DataParams | Parameters for data call
529
+ dataParams: ...,
530
+ } satisfies V2DensifiedBiomassCharacteristicsByRegionDataPostRequest;
531
+
532
+ try {
533
+ const data = await api.v2DensifiedBiomassCharacteristicsByRegionDataPost(body);
534
+ console.log(data);
535
+ } catch (error) {
536
+ console.error(error);
537
+ }
538
+ }
539
+
540
+ // Run the test
541
+ example().catch(console.error);
542
+ ```
543
+
544
+ ### Parameters
545
+
546
+
547
+ | Name | Type | Description | Notes |
548
+ |------------- | ------------- | ------------- | -------------|
549
+ | **dataParams** | [DataParams](DataParams.md) | Parameters for data call | |
550
+
551
+ ### Return type
552
+
553
+ [**DataResponseContainer**](DataResponseContainer.md)
554
+
555
+ ### Authorization
556
+
557
+ [api_key](../README.md#api_key)
558
+
559
+ ### HTTP request headers
560
+
561
+ - **Content-Type**: `application/json`
562
+ - **Accept**: `application/json`
563
+
564
+
565
+ ### HTTP response details
566
+ | Status code | Description | Response headers |
567
+ |-------------|-------------|------------------|
568
+ | **400** | Invalid input | - |
569
+ | **200** | API Data | - |
570
+
571
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
572
+
573
+
574
+ ## v2DensifiedBiomassCharacteristicsByRegionFacetFacetIdGet
575
+
576
+ > FacetDetailsContainer v2DensifiedBiomassCharacteristicsByRegionFacetFacetIdGet(facetId)
577
+
578
+
579
+
580
+ ### Example
581
+
582
+ ```ts
583
+ import {
584
+ Configuration,
585
+ DBFApi,
586
+ } from '';
587
+ import type { V2DensifiedBiomassCharacteristicsByRegionFacetFacetIdGetRequest } from '';
588
+
589
+ async function example() {
590
+ console.log("🚀 Testing SDK...");
591
+ const config = new Configuration({
592
+ // To configure API key authorization: api_key
593
+ apiKey: "YOUR API KEY",
594
+ });
595
+ const api = new DBFApi(config);
596
+
597
+ const body = {
598
+ // string | Facet ID
599
+ facetId: facetId_example,
600
+ } satisfies V2DensifiedBiomassCharacteristicsByRegionFacetFacetIdGetRequest;
601
+
602
+ try {
603
+ const data = await api.v2DensifiedBiomassCharacteristicsByRegionFacetFacetIdGet(body);
604
+ console.log(data);
605
+ } catch (error) {
606
+ console.error(error);
607
+ }
608
+ }
609
+
610
+ // Run the test
611
+ example().catch(console.error);
612
+ ```
613
+
614
+ ### Parameters
615
+
616
+
617
+ | Name | Type | Description | Notes |
618
+ |------------- | ------------- | ------------- | -------------|
619
+ | **facetId** | `string` | Facet ID | [Defaults to `undefined`] |
620
+
621
+ ### Return type
622
+
623
+ [**FacetDetailsContainer**](FacetDetailsContainer.md)
624
+
625
+ ### Authorization
626
+
627
+ [api_key](../README.md#api_key)
628
+
629
+ ### HTTP request headers
630
+
631
+ - **Content-Type**: Not defined
632
+ - **Accept**: `application/json`
633
+
634
+
635
+ ### HTTP response details
636
+ | Status code | Description | Response headers |
637
+ |-------------|-------------|------------------|
638
+ | **400** | Invalid input | - |
639
+ | **200** | Facet details | - |
640
+
641
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
642
+
643
+
644
+ ## v2DensifiedBiomassCharacteristicsByRegionFacetGet
645
+
646
+ > FacetOptionListContainer v2DensifiedBiomassCharacteristicsByRegionFacetGet()
647
+
648
+
649
+
650
+ ### Example
651
+
652
+ ```ts
653
+ import {
654
+ Configuration,
655
+ DBFApi,
656
+ } from '';
657
+ import type { V2DensifiedBiomassCharacteristicsByRegionFacetGetRequest } from '';
658
+
659
+ async function example() {
660
+ console.log("🚀 Testing SDK...");
661
+ const config = new Configuration({
662
+ // To configure API key authorization: api_key
663
+ apiKey: "YOUR API KEY",
664
+ });
665
+ const api = new DBFApi(config);
666
+
667
+ try {
668
+ const data = await api.v2DensifiedBiomassCharacteristicsByRegionFacetGet();
669
+ console.log(data);
670
+ } catch (error) {
671
+ console.error(error);
672
+ }
673
+ }
674
+
675
+ // Run the test
676
+ example().catch(console.error);
677
+ ```
678
+
679
+ ### Parameters
680
+
681
+ This endpoint does not need any parameter.
682
+
683
+ ### Return type
684
+
685
+ [**FacetOptionListContainer**](FacetOptionListContainer.md)
686
+
687
+ ### Authorization
688
+
689
+ [api_key](../README.md#api_key)
690
+
691
+ ### HTTP request headers
692
+
693
+ - **Content-Type**: Not defined
694
+ - **Accept**: `application/json`
695
+
696
+
697
+ ### HTTP response details
698
+ | Status code | Description | Response headers |
699
+ |-------------|-------------|------------------|
700
+ | **400** | Invalid input | - |
701
+ | **200** | List of facet options | - |
702
+
703
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
704
+
705
+
706
+ ## v2DensifiedBiomassCharacteristicsByRegionGet
707
+
708
+ > FinalRouteResponseContainer v2DensifiedBiomassCharacteristicsByRegionGet()
709
+
710
+
711
+
712
+ ### Example
713
+
714
+ ```ts
715
+ import {
716
+ Configuration,
717
+ DBFApi,
718
+ } from '';
719
+ import type { V2DensifiedBiomassCharacteristicsByRegionGetRequest } from '';
720
+
721
+ async function example() {
722
+ console.log("🚀 Testing SDK...");
723
+ const config = new Configuration({
724
+ // To configure API key authorization: api_key
725
+ apiKey: "YOUR API KEY",
726
+ });
727
+ const api = new DBFApi(config);
728
+
729
+ try {
730
+ const data = await api.v2DensifiedBiomassCharacteristicsByRegionGet();
731
+ console.log(data);
732
+ } catch (error) {
733
+ console.error(error);
734
+ }
735
+ }
736
+
737
+ // Run the test
738
+ example().catch(console.error);
739
+ ```
740
+
741
+ ### Parameters
742
+
743
+ This endpoint does not need any parameter.
744
+
745
+ ### Return type
746
+
747
+ [**FinalRouteResponseContainer**](FinalRouteResponseContainer.md)
748
+
749
+ ### Authorization
750
+
751
+ [api_key](../README.md#api_key)
752
+
753
+ ### HTTP request headers
754
+
755
+ - **Content-Type**: Not defined
756
+ - **Accept**: `application/json`
757
+
758
+
759
+ ### HTTP response details
760
+ | Status code | Description | Response headers |
761
+ |-------------|-------------|------------------|
762
+ | **200** | List of API data sets | - |
763
+
764
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
765
+
766
+
767
+ ## v2DensifiedBiomassExportSalesAndPriceDataGet
768
+
769
+ > DataResponseContainer v2DensifiedBiomassExportSalesAndPriceDataGet(data, facets, frequency, start, end, sort, length, offset)
770
+
771
+
772
+
773
+ API data with query params
774
+
775
+ ### Example
776
+
777
+ ```ts
778
+ import {
779
+ Configuration,
780
+ DBFApi,
781
+ } from '';
782
+ import type { V2DensifiedBiomassExportSalesAndPriceDataGetRequest } from '';
783
+
784
+ async function example() {
785
+ console.log("🚀 Testing SDK...");
786
+ const config = new Configuration({
787
+ // To configure API key authorization: api_key
788
+ apiKey: "YOUR API KEY",
789
+ });
790
+ const api = new DBFApi(config);
791
+
792
+ const body = {
793
+ // Array<string> | Data columns to filter by (optional)
794
+ data: ...,
795
+ // object | Facets to filter by (optional)
796
+ facets: Object,
797
+ // string | Frequency to filter by (optional)
798
+ frequency: frequency_example,
799
+ // string | Start date to filter by (optional)
800
+ start: start_example,
801
+ // string | End date to filter by (optional)
802
+ end: end_example,
803
+ // Sort | How to sort returned data (optional)
804
+ sort: ...,
805
+ // number | Max length of returned data (optional)
806
+ length: 56,
807
+ // number | Offset of returned data (optional)
808
+ offset: 56,
809
+ } satisfies V2DensifiedBiomassExportSalesAndPriceDataGetRequest;
810
+
811
+ try {
812
+ const data = await api.v2DensifiedBiomassExportSalesAndPriceDataGet(body);
813
+ console.log(data);
814
+ } catch (error) {
815
+ console.error(error);
816
+ }
817
+ }
818
+
819
+ // Run the test
820
+ example().catch(console.error);
821
+ ```
822
+
823
+ ### Parameters
824
+
825
+
826
+ | Name | Type | Description | Notes |
827
+ |------------- | ------------- | ------------- | -------------|
828
+ | **data** | `Array<string>` | Data columns to filter by | [Optional] |
829
+ | **facets** | `object` | Facets to filter by | [Optional] [Defaults to `undefined`] |
830
+ | **frequency** | `string` | Frequency to filter by | [Optional] [Defaults to `undefined`] |
831
+ | **start** | `string` | Start date to filter by | [Optional] [Defaults to `undefined`] |
832
+ | **end** | `string` | End date to filter by | [Optional] [Defaults to `undefined`] |
833
+ | **sort** | [](.md) | How to sort returned data | [Optional] [Defaults to `undefined`] |
834
+ | **length** | `number` | Max length of returned data | [Optional] [Defaults to `undefined`] |
835
+ | **offset** | `number` | Offset of returned data | [Optional] [Defaults to `undefined`] |
836
+
837
+ ### Return type
838
+
839
+ [**DataResponseContainer**](DataResponseContainer.md)
840
+
841
+ ### Authorization
842
+
843
+ [api_key](../README.md#api_key)
844
+
845
+ ### HTTP request headers
846
+
847
+ - **Content-Type**: Not defined
848
+ - **Accept**: `application/json`
849
+
850
+
851
+ ### HTTP response details
852
+ | Status code | Description | Response headers |
853
+ |-------------|-------------|------------------|
854
+ | **400** | Invalid input | - |
855
+ | **200** | API Data | - |
856
+
857
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
858
+
859
+
860
+ ## v2DensifiedBiomassExportSalesAndPriceDataPost
861
+
862
+ > DataResponseContainer v2DensifiedBiomassExportSalesAndPriceDataPost(dataParams)
863
+
864
+ Return biomass export-sales-and-price Data
865
+
866
+ Class ExportSalesAndPriceController ExportSalesAndPrice data set top-level controller.
867
+
868
+ ### Example
869
+
870
+ ```ts
871
+ import {
872
+ Configuration,
873
+ DBFApi,
874
+ } from '';
875
+ import type { V2DensifiedBiomassExportSalesAndPriceDataPostRequest } from '';
876
+
877
+ async function example() {
878
+ console.log("🚀 Testing SDK...");
879
+ const config = new Configuration({
880
+ // To configure API key authorization: api_key
881
+ apiKey: "YOUR API KEY",
882
+ });
883
+ const api = new DBFApi(config);
884
+
885
+ const body = {
886
+ // DataParams | Parameters for data call
887
+ dataParams: ...,
888
+ } satisfies V2DensifiedBiomassExportSalesAndPriceDataPostRequest;
889
+
890
+ try {
891
+ const data = await api.v2DensifiedBiomassExportSalesAndPriceDataPost(body);
892
+ console.log(data);
893
+ } catch (error) {
894
+ console.error(error);
895
+ }
896
+ }
897
+
898
+ // Run the test
899
+ example().catch(console.error);
900
+ ```
901
+
902
+ ### Parameters
903
+
904
+
905
+ | Name | Type | Description | Notes |
906
+ |------------- | ------------- | ------------- | -------------|
907
+ | **dataParams** | [DataParams](DataParams.md) | Parameters for data call | |
908
+
909
+ ### Return type
910
+
911
+ [**DataResponseContainer**](DataResponseContainer.md)
912
+
913
+ ### Authorization
914
+
915
+ [api_key](../README.md#api_key)
916
+
917
+ ### HTTP request headers
918
+
919
+ - **Content-Type**: `application/json`
920
+ - **Accept**: `application/json`
921
+
922
+
923
+ ### HTTP response details
924
+ | Status code | Description | Response headers |
925
+ |-------------|-------------|------------------|
926
+ | **400** | Invalid input | - |
927
+ | **200** | API Data | - |
928
+
929
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
930
+
931
+
932
+ ## v2DensifiedBiomassExportSalesAndPriceFacetFacetIdGet
933
+
934
+ > FacetDetailsContainer v2DensifiedBiomassExportSalesAndPriceFacetFacetIdGet(facetId)
935
+
936
+
937
+
938
+ ### Example
939
+
940
+ ```ts
941
+ import {
942
+ Configuration,
943
+ DBFApi,
944
+ } from '';
945
+ import type { V2DensifiedBiomassExportSalesAndPriceFacetFacetIdGetRequest } from '';
946
+
947
+ async function example() {
948
+ console.log("🚀 Testing SDK...");
949
+ const config = new Configuration({
950
+ // To configure API key authorization: api_key
951
+ apiKey: "YOUR API KEY",
952
+ });
953
+ const api = new DBFApi(config);
954
+
955
+ const body = {
956
+ // string | Facet ID
957
+ facetId: facetId_example,
958
+ } satisfies V2DensifiedBiomassExportSalesAndPriceFacetFacetIdGetRequest;
959
+
960
+ try {
961
+ const data = await api.v2DensifiedBiomassExportSalesAndPriceFacetFacetIdGet(body);
962
+ console.log(data);
963
+ } catch (error) {
964
+ console.error(error);
965
+ }
966
+ }
967
+
968
+ // Run the test
969
+ example().catch(console.error);
970
+ ```
971
+
972
+ ### Parameters
973
+
974
+
975
+ | Name | Type | Description | Notes |
976
+ |------------- | ------------- | ------------- | -------------|
977
+ | **facetId** | `string` | Facet ID | [Defaults to `undefined`] |
978
+
979
+ ### Return type
980
+
981
+ [**FacetDetailsContainer**](FacetDetailsContainer.md)
982
+
983
+ ### Authorization
984
+
985
+ [api_key](../README.md#api_key)
986
+
987
+ ### HTTP request headers
988
+
989
+ - **Content-Type**: Not defined
990
+ - **Accept**: `application/json`
991
+
992
+
993
+ ### HTTP response details
994
+ | Status code | Description | Response headers |
995
+ |-------------|-------------|------------------|
996
+ | **400** | Invalid input | - |
997
+ | **200** | Facet details | - |
998
+
999
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1000
+
1001
+
1002
+ ## v2DensifiedBiomassExportSalesAndPriceFacetGet
1003
+
1004
+ > FacetOptionListContainer v2DensifiedBiomassExportSalesAndPriceFacetGet()
1005
+
1006
+
1007
+
1008
+ ### Example
1009
+
1010
+ ```ts
1011
+ import {
1012
+ Configuration,
1013
+ DBFApi,
1014
+ } from '';
1015
+ import type { V2DensifiedBiomassExportSalesAndPriceFacetGetRequest } from '';
1016
+
1017
+ async function example() {
1018
+ console.log("🚀 Testing SDK...");
1019
+ const config = new Configuration({
1020
+ // To configure API key authorization: api_key
1021
+ apiKey: "YOUR API KEY",
1022
+ });
1023
+ const api = new DBFApi(config);
1024
+
1025
+ try {
1026
+ const data = await api.v2DensifiedBiomassExportSalesAndPriceFacetGet();
1027
+ console.log(data);
1028
+ } catch (error) {
1029
+ console.error(error);
1030
+ }
1031
+ }
1032
+
1033
+ // Run the test
1034
+ example().catch(console.error);
1035
+ ```
1036
+
1037
+ ### Parameters
1038
+
1039
+ This endpoint does not need any parameter.
1040
+
1041
+ ### Return type
1042
+
1043
+ [**FacetOptionListContainer**](FacetOptionListContainer.md)
1044
+
1045
+ ### Authorization
1046
+
1047
+ [api_key](../README.md#api_key)
1048
+
1049
+ ### HTTP request headers
1050
+
1051
+ - **Content-Type**: Not defined
1052
+ - **Accept**: `application/json`
1053
+
1054
+
1055
+ ### HTTP response details
1056
+ | Status code | Description | Response headers |
1057
+ |-------------|-------------|------------------|
1058
+ | **400** | Invalid input | - |
1059
+ | **200** | List of facet options | - |
1060
+
1061
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1062
+
1063
+
1064
+ ## v2DensifiedBiomassExportSalesAndPriceGet
1065
+
1066
+ > FinalRouteResponseContainer v2DensifiedBiomassExportSalesAndPriceGet()
1067
+
1068
+
1069
+
1070
+ ### Example
1071
+
1072
+ ```ts
1073
+ import {
1074
+ Configuration,
1075
+ DBFApi,
1076
+ } from '';
1077
+ import type { V2DensifiedBiomassExportSalesAndPriceGetRequest } from '';
1078
+
1079
+ async function example() {
1080
+ console.log("🚀 Testing SDK...");
1081
+ const config = new Configuration({
1082
+ // To configure API key authorization: api_key
1083
+ apiKey: "YOUR API KEY",
1084
+ });
1085
+ const api = new DBFApi(config);
1086
+
1087
+ try {
1088
+ const data = await api.v2DensifiedBiomassExportSalesAndPriceGet();
1089
+ console.log(data);
1090
+ } catch (error) {
1091
+ console.error(error);
1092
+ }
1093
+ }
1094
+
1095
+ // Run the test
1096
+ example().catch(console.error);
1097
+ ```
1098
+
1099
+ ### Parameters
1100
+
1101
+ This endpoint does not need any parameter.
1102
+
1103
+ ### Return type
1104
+
1105
+ [**FinalRouteResponseContainer**](FinalRouteResponseContainer.md)
1106
+
1107
+ ### Authorization
1108
+
1109
+ [api_key](../README.md#api_key)
1110
+
1111
+ ### HTTP request headers
1112
+
1113
+ - **Content-Type**: Not defined
1114
+ - **Accept**: `application/json`
1115
+
1116
+
1117
+ ### HTTP response details
1118
+ | Status code | Description | Response headers |
1119
+ |-------------|-------------|------------------|
1120
+ | **200** | List of API data sets | - |
1121
+
1122
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1123
+
1124
+
1125
+ ## v2DensifiedBiomassFeedstocksAndCostDataGet
1126
+
1127
+ > DataResponseContainer v2DensifiedBiomassFeedstocksAndCostDataGet(data, facets, frequency, start, end, sort, length, offset)
1128
+
1129
+
1130
+
1131
+ API data with query params
1132
+
1133
+ ### Example
1134
+
1135
+ ```ts
1136
+ import {
1137
+ Configuration,
1138
+ DBFApi,
1139
+ } from '';
1140
+ import type { V2DensifiedBiomassFeedstocksAndCostDataGetRequest } from '';
1141
+
1142
+ async function example() {
1143
+ console.log("🚀 Testing SDK...");
1144
+ const config = new Configuration({
1145
+ // To configure API key authorization: api_key
1146
+ apiKey: "YOUR API KEY",
1147
+ });
1148
+ const api = new DBFApi(config);
1149
+
1150
+ const body = {
1151
+ // Array<string> | Data columns to filter by (optional)
1152
+ data: ...,
1153
+ // object | Facets to filter by (optional)
1154
+ facets: Object,
1155
+ // string | Frequency to filter by (optional)
1156
+ frequency: frequency_example,
1157
+ // string | Start date to filter by (optional)
1158
+ start: start_example,
1159
+ // string | End date to filter by (optional)
1160
+ end: end_example,
1161
+ // Sort | How to sort returned data (optional)
1162
+ sort: ...,
1163
+ // number | Max length of returned data (optional)
1164
+ length: 56,
1165
+ // number | Offset of returned data (optional)
1166
+ offset: 56,
1167
+ } satisfies V2DensifiedBiomassFeedstocksAndCostDataGetRequest;
1168
+
1169
+ try {
1170
+ const data = await api.v2DensifiedBiomassFeedstocksAndCostDataGet(body);
1171
+ console.log(data);
1172
+ } catch (error) {
1173
+ console.error(error);
1174
+ }
1175
+ }
1176
+
1177
+ // Run the test
1178
+ example().catch(console.error);
1179
+ ```
1180
+
1181
+ ### Parameters
1182
+
1183
+
1184
+ | Name | Type | Description | Notes |
1185
+ |------------- | ------------- | ------------- | -------------|
1186
+ | **data** | `Array<string>` | Data columns to filter by | [Optional] |
1187
+ | **facets** | `object` | Facets to filter by | [Optional] [Defaults to `undefined`] |
1188
+ | **frequency** | `string` | Frequency to filter by | [Optional] [Defaults to `undefined`] |
1189
+ | **start** | `string` | Start date to filter by | [Optional] [Defaults to `undefined`] |
1190
+ | **end** | `string` | End date to filter by | [Optional] [Defaults to `undefined`] |
1191
+ | **sort** | [](.md) | How to sort returned data | [Optional] [Defaults to `undefined`] |
1192
+ | **length** | `number` | Max length of returned data | [Optional] [Defaults to `undefined`] |
1193
+ | **offset** | `number` | Offset of returned data | [Optional] [Defaults to `undefined`] |
1194
+
1195
+ ### Return type
1196
+
1197
+ [**DataResponseContainer**](DataResponseContainer.md)
1198
+
1199
+ ### Authorization
1200
+
1201
+ [api_key](../README.md#api_key)
1202
+
1203
+ ### HTTP request headers
1204
+
1205
+ - **Content-Type**: Not defined
1206
+ - **Accept**: `application/json`
1207
+
1208
+
1209
+ ### HTTP response details
1210
+ | Status code | Description | Response headers |
1211
+ |-------------|-------------|------------------|
1212
+ | **400** | Invalid input | - |
1213
+ | **200** | API Data | - |
1214
+
1215
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1216
+
1217
+
1218
+ ## v2DensifiedBiomassFeedstocksAndCostDataPost
1219
+
1220
+ > DataResponseContainer v2DensifiedBiomassFeedstocksAndCostDataPost(dataParams)
1221
+
1222
+ Return biomass feedstocks-and-cost Data
1223
+
1224
+ Class FeedstocksAndCostController FeedstocksAndCost data set top-level controller.
1225
+
1226
+ ### Example
1227
+
1228
+ ```ts
1229
+ import {
1230
+ Configuration,
1231
+ DBFApi,
1232
+ } from '';
1233
+ import type { V2DensifiedBiomassFeedstocksAndCostDataPostRequest } from '';
1234
+
1235
+ async function example() {
1236
+ console.log("🚀 Testing SDK...");
1237
+ const config = new Configuration({
1238
+ // To configure API key authorization: api_key
1239
+ apiKey: "YOUR API KEY",
1240
+ });
1241
+ const api = new DBFApi(config);
1242
+
1243
+ const body = {
1244
+ // DataParams | Parameters for data call
1245
+ dataParams: ...,
1246
+ } satisfies V2DensifiedBiomassFeedstocksAndCostDataPostRequest;
1247
+
1248
+ try {
1249
+ const data = await api.v2DensifiedBiomassFeedstocksAndCostDataPost(body);
1250
+ console.log(data);
1251
+ } catch (error) {
1252
+ console.error(error);
1253
+ }
1254
+ }
1255
+
1256
+ // Run the test
1257
+ example().catch(console.error);
1258
+ ```
1259
+
1260
+ ### Parameters
1261
+
1262
+
1263
+ | Name | Type | Description | Notes |
1264
+ |------------- | ------------- | ------------- | -------------|
1265
+ | **dataParams** | [DataParams](DataParams.md) | Parameters for data call | |
1266
+
1267
+ ### Return type
1268
+
1269
+ [**DataResponseContainer**](DataResponseContainer.md)
1270
+
1271
+ ### Authorization
1272
+
1273
+ [api_key](../README.md#api_key)
1274
+
1275
+ ### HTTP request headers
1276
+
1277
+ - **Content-Type**: `application/json`
1278
+ - **Accept**: `application/json`
1279
+
1280
+
1281
+ ### HTTP response details
1282
+ | Status code | Description | Response headers |
1283
+ |-------------|-------------|------------------|
1284
+ | **400** | Invalid input | - |
1285
+ | **200** | API Data | - |
1286
+
1287
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1288
+
1289
+
1290
+ ## v2DensifiedBiomassFeedstocksAndCostFacetFacetIdGet
1291
+
1292
+ > FacetDetailsContainer v2DensifiedBiomassFeedstocksAndCostFacetFacetIdGet(facetId)
1293
+
1294
+
1295
+
1296
+ ### Example
1297
+
1298
+ ```ts
1299
+ import {
1300
+ Configuration,
1301
+ DBFApi,
1302
+ } from '';
1303
+ import type { V2DensifiedBiomassFeedstocksAndCostFacetFacetIdGetRequest } from '';
1304
+
1305
+ async function example() {
1306
+ console.log("🚀 Testing SDK...");
1307
+ const config = new Configuration({
1308
+ // To configure API key authorization: api_key
1309
+ apiKey: "YOUR API KEY",
1310
+ });
1311
+ const api = new DBFApi(config);
1312
+
1313
+ const body = {
1314
+ // string | Facet ID
1315
+ facetId: facetId_example,
1316
+ } satisfies V2DensifiedBiomassFeedstocksAndCostFacetFacetIdGetRequest;
1317
+
1318
+ try {
1319
+ const data = await api.v2DensifiedBiomassFeedstocksAndCostFacetFacetIdGet(body);
1320
+ console.log(data);
1321
+ } catch (error) {
1322
+ console.error(error);
1323
+ }
1324
+ }
1325
+
1326
+ // Run the test
1327
+ example().catch(console.error);
1328
+ ```
1329
+
1330
+ ### Parameters
1331
+
1332
+
1333
+ | Name | Type | Description | Notes |
1334
+ |------------- | ------------- | ------------- | -------------|
1335
+ | **facetId** | `string` | Facet ID | [Defaults to `undefined`] |
1336
+
1337
+ ### Return type
1338
+
1339
+ [**FacetDetailsContainer**](FacetDetailsContainer.md)
1340
+
1341
+ ### Authorization
1342
+
1343
+ [api_key](../README.md#api_key)
1344
+
1345
+ ### HTTP request headers
1346
+
1347
+ - **Content-Type**: Not defined
1348
+ - **Accept**: `application/json`
1349
+
1350
+
1351
+ ### HTTP response details
1352
+ | Status code | Description | Response headers |
1353
+ |-------------|-------------|------------------|
1354
+ | **400** | Invalid input | - |
1355
+ | **200** | Facet details | - |
1356
+
1357
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1358
+
1359
+
1360
+ ## v2DensifiedBiomassFeedstocksAndCostFacetGet
1361
+
1362
+ > FacetOptionListContainer v2DensifiedBiomassFeedstocksAndCostFacetGet()
1363
+
1364
+
1365
+
1366
+ ### Example
1367
+
1368
+ ```ts
1369
+ import {
1370
+ Configuration,
1371
+ DBFApi,
1372
+ } from '';
1373
+ import type { V2DensifiedBiomassFeedstocksAndCostFacetGetRequest } from '';
1374
+
1375
+ async function example() {
1376
+ console.log("🚀 Testing SDK...");
1377
+ const config = new Configuration({
1378
+ // To configure API key authorization: api_key
1379
+ apiKey: "YOUR API KEY",
1380
+ });
1381
+ const api = new DBFApi(config);
1382
+
1383
+ try {
1384
+ const data = await api.v2DensifiedBiomassFeedstocksAndCostFacetGet();
1385
+ console.log(data);
1386
+ } catch (error) {
1387
+ console.error(error);
1388
+ }
1389
+ }
1390
+
1391
+ // Run the test
1392
+ example().catch(console.error);
1393
+ ```
1394
+
1395
+ ### Parameters
1396
+
1397
+ This endpoint does not need any parameter.
1398
+
1399
+ ### Return type
1400
+
1401
+ [**FacetOptionListContainer**](FacetOptionListContainer.md)
1402
+
1403
+ ### Authorization
1404
+
1405
+ [api_key](../README.md#api_key)
1406
+
1407
+ ### HTTP request headers
1408
+
1409
+ - **Content-Type**: Not defined
1410
+ - **Accept**: `application/json`
1411
+
1412
+
1413
+ ### HTTP response details
1414
+ | Status code | Description | Response headers |
1415
+ |-------------|-------------|------------------|
1416
+ | **400** | Invalid input | - |
1417
+ | **200** | List of facet options | - |
1418
+
1419
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1420
+
1421
+
1422
+ ## v2DensifiedBiomassFeedstocksAndCostGet
1423
+
1424
+ > FinalRouteResponseContainer v2DensifiedBiomassFeedstocksAndCostGet()
1425
+
1426
+
1427
+
1428
+ ### Example
1429
+
1430
+ ```ts
1431
+ import {
1432
+ Configuration,
1433
+ DBFApi,
1434
+ } from '';
1435
+ import type { V2DensifiedBiomassFeedstocksAndCostGetRequest } from '';
1436
+
1437
+ async function example() {
1438
+ console.log("🚀 Testing SDK...");
1439
+ const config = new Configuration({
1440
+ // To configure API key authorization: api_key
1441
+ apiKey: "YOUR API KEY",
1442
+ });
1443
+ const api = new DBFApi(config);
1444
+
1445
+ try {
1446
+ const data = await api.v2DensifiedBiomassFeedstocksAndCostGet();
1447
+ console.log(data);
1448
+ } catch (error) {
1449
+ console.error(error);
1450
+ }
1451
+ }
1452
+
1453
+ // Run the test
1454
+ example().catch(console.error);
1455
+ ```
1456
+
1457
+ ### Parameters
1458
+
1459
+ This endpoint does not need any parameter.
1460
+
1461
+ ### Return type
1462
+
1463
+ [**FinalRouteResponseContainer**](FinalRouteResponseContainer.md)
1464
+
1465
+ ### Authorization
1466
+
1467
+ [api_key](../README.md#api_key)
1468
+
1469
+ ### HTTP request headers
1470
+
1471
+ - **Content-Type**: Not defined
1472
+ - **Accept**: `application/json`
1473
+
1474
+
1475
+ ### HTTP response details
1476
+ | Status code | Description | Response headers |
1477
+ |-------------|-------------|------------------|
1478
+ | **200** | List of API data sets | - |
1479
+
1480
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1481
+
1482
+
1483
+ ## v2DensifiedBiomassGet
1484
+
1485
+ > RouteResponseContainer v2DensifiedBiomassGet()
1486
+
1487
+ Class Controller
1488
+
1489
+ Densified Biomass data set top-level controller.
1490
+
1491
+ ### Example
1492
+
1493
+ ```ts
1494
+ import {
1495
+ Configuration,
1496
+ DBFApi,
1497
+ } from '';
1498
+ import type { V2DensifiedBiomassGetRequest } from '';
1499
+
1500
+ async function example() {
1501
+ console.log("🚀 Testing SDK...");
1502
+ const config = new Configuration({
1503
+ // To configure API key authorization: api_key
1504
+ apiKey: "YOUR API KEY",
1505
+ });
1506
+ const api = new DBFApi(config);
1507
+
1508
+ try {
1509
+ const data = await api.v2DensifiedBiomassGet();
1510
+ console.log(data);
1511
+ } catch (error) {
1512
+ console.error(error);
1513
+ }
1514
+ }
1515
+
1516
+ // Run the test
1517
+ example().catch(console.error);
1518
+ ```
1519
+
1520
+ ### Parameters
1521
+
1522
+ This endpoint does not need any parameter.
1523
+
1524
+ ### Return type
1525
+
1526
+ [**RouteResponseContainer**](RouteResponseContainer.md)
1527
+
1528
+ ### Authorization
1529
+
1530
+ [api_key](../README.md#api_key)
1531
+
1532
+ ### HTTP request headers
1533
+
1534
+ - **Content-Type**: Not defined
1535
+ - **Accept**: `application/json`
1536
+
1537
+
1538
+ ### HTTP response details
1539
+ | Status code | Description | Response headers |
1540
+ |-------------|-------------|------------------|
1541
+ | **200** | List of API data sets | - |
1542
+
1543
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1544
+
1545
+
1546
+ ## v2DensifiedBiomassInventoriesByRegionDataGet
1547
+
1548
+ > DataResponseContainer v2DensifiedBiomassInventoriesByRegionDataGet(data, facets, frequency, start, end, sort, length, offset)
1549
+
1550
+
1551
+
1552
+ API data with query params
1553
+
1554
+ ### Example
1555
+
1556
+ ```ts
1557
+ import {
1558
+ Configuration,
1559
+ DBFApi,
1560
+ } from '';
1561
+ import type { V2DensifiedBiomassInventoriesByRegionDataGetRequest } from '';
1562
+
1563
+ async function example() {
1564
+ console.log("🚀 Testing SDK...");
1565
+ const config = new Configuration({
1566
+ // To configure API key authorization: api_key
1567
+ apiKey: "YOUR API KEY",
1568
+ });
1569
+ const api = new DBFApi(config);
1570
+
1571
+ const body = {
1572
+ // Array<string> | Data columns to filter by (optional)
1573
+ data: ...,
1574
+ // object | Facets to filter by (optional)
1575
+ facets: Object,
1576
+ // string | Frequency to filter by (optional)
1577
+ frequency: frequency_example,
1578
+ // string | Start date to filter by (optional)
1579
+ start: start_example,
1580
+ // string | End date to filter by (optional)
1581
+ end: end_example,
1582
+ // Sort | How to sort returned data (optional)
1583
+ sort: ...,
1584
+ // number | Max length of returned data (optional)
1585
+ length: 56,
1586
+ // number | Offset of returned data (optional)
1587
+ offset: 56,
1588
+ } satisfies V2DensifiedBiomassInventoriesByRegionDataGetRequest;
1589
+
1590
+ try {
1591
+ const data = await api.v2DensifiedBiomassInventoriesByRegionDataGet(body);
1592
+ console.log(data);
1593
+ } catch (error) {
1594
+ console.error(error);
1595
+ }
1596
+ }
1597
+
1598
+ // Run the test
1599
+ example().catch(console.error);
1600
+ ```
1601
+
1602
+ ### Parameters
1603
+
1604
+
1605
+ | Name | Type | Description | Notes |
1606
+ |------------- | ------------- | ------------- | -------------|
1607
+ | **data** | `Array<string>` | Data columns to filter by | [Optional] |
1608
+ | **facets** | `object` | Facets to filter by | [Optional] [Defaults to `undefined`] |
1609
+ | **frequency** | `string` | Frequency to filter by | [Optional] [Defaults to `undefined`] |
1610
+ | **start** | `string` | Start date to filter by | [Optional] [Defaults to `undefined`] |
1611
+ | **end** | `string` | End date to filter by | [Optional] [Defaults to `undefined`] |
1612
+ | **sort** | [](.md) | How to sort returned data | [Optional] [Defaults to `undefined`] |
1613
+ | **length** | `number` | Max length of returned data | [Optional] [Defaults to `undefined`] |
1614
+ | **offset** | `number` | Offset of returned data | [Optional] [Defaults to `undefined`] |
1615
+
1616
+ ### Return type
1617
+
1618
+ [**DataResponseContainer**](DataResponseContainer.md)
1619
+
1620
+ ### Authorization
1621
+
1622
+ [api_key](../README.md#api_key)
1623
+
1624
+ ### HTTP request headers
1625
+
1626
+ - **Content-Type**: Not defined
1627
+ - **Accept**: `application/json`
1628
+
1629
+
1630
+ ### HTTP response details
1631
+ | Status code | Description | Response headers |
1632
+ |-------------|-------------|------------------|
1633
+ | **400** | Invalid input | - |
1634
+ | **200** | API Data | - |
1635
+
1636
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1637
+
1638
+
1639
+ ## v2DensifiedBiomassInventoriesByRegionDataPost
1640
+
1641
+ > DataResponseContainer v2DensifiedBiomassInventoriesByRegionDataPost(dataParams)
1642
+
1643
+ Return biomass inventories-by-region Data
1644
+
1645
+ Class InventoriesByRegionController InventoriesByRegion data set top-level controller.
1646
+
1647
+ ### Example
1648
+
1649
+ ```ts
1650
+ import {
1651
+ Configuration,
1652
+ DBFApi,
1653
+ } from '';
1654
+ import type { V2DensifiedBiomassInventoriesByRegionDataPostRequest } from '';
1655
+
1656
+ async function example() {
1657
+ console.log("🚀 Testing SDK...");
1658
+ const config = new Configuration({
1659
+ // To configure API key authorization: api_key
1660
+ apiKey: "YOUR API KEY",
1661
+ });
1662
+ const api = new DBFApi(config);
1663
+
1664
+ const body = {
1665
+ // DataParams | Parameters for data call
1666
+ dataParams: ...,
1667
+ } satisfies V2DensifiedBiomassInventoriesByRegionDataPostRequest;
1668
+
1669
+ try {
1670
+ const data = await api.v2DensifiedBiomassInventoriesByRegionDataPost(body);
1671
+ console.log(data);
1672
+ } catch (error) {
1673
+ console.error(error);
1674
+ }
1675
+ }
1676
+
1677
+ // Run the test
1678
+ example().catch(console.error);
1679
+ ```
1680
+
1681
+ ### Parameters
1682
+
1683
+
1684
+ | Name | Type | Description | Notes |
1685
+ |------------- | ------------- | ------------- | -------------|
1686
+ | **dataParams** | [DataParams](DataParams.md) | Parameters for data call | |
1687
+
1688
+ ### Return type
1689
+
1690
+ [**DataResponseContainer**](DataResponseContainer.md)
1691
+
1692
+ ### Authorization
1693
+
1694
+ [api_key](../README.md#api_key)
1695
+
1696
+ ### HTTP request headers
1697
+
1698
+ - **Content-Type**: `application/json`
1699
+ - **Accept**: `application/json`
1700
+
1701
+
1702
+ ### HTTP response details
1703
+ | Status code | Description | Response headers |
1704
+ |-------------|-------------|------------------|
1705
+ | **400** | Invalid input | - |
1706
+ | **200** | API Data | - |
1707
+
1708
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1709
+
1710
+
1711
+ ## v2DensifiedBiomassInventoriesByRegionFacetFacetIdGet
1712
+
1713
+ > FacetDetailsContainer v2DensifiedBiomassInventoriesByRegionFacetFacetIdGet(facetId)
1714
+
1715
+
1716
+
1717
+ ### Example
1718
+
1719
+ ```ts
1720
+ import {
1721
+ Configuration,
1722
+ DBFApi,
1723
+ } from '';
1724
+ import type { V2DensifiedBiomassInventoriesByRegionFacetFacetIdGetRequest } from '';
1725
+
1726
+ async function example() {
1727
+ console.log("🚀 Testing SDK...");
1728
+ const config = new Configuration({
1729
+ // To configure API key authorization: api_key
1730
+ apiKey: "YOUR API KEY",
1731
+ });
1732
+ const api = new DBFApi(config);
1733
+
1734
+ const body = {
1735
+ // string | Facet ID
1736
+ facetId: facetId_example,
1737
+ } satisfies V2DensifiedBiomassInventoriesByRegionFacetFacetIdGetRequest;
1738
+
1739
+ try {
1740
+ const data = await api.v2DensifiedBiomassInventoriesByRegionFacetFacetIdGet(body);
1741
+ console.log(data);
1742
+ } catch (error) {
1743
+ console.error(error);
1744
+ }
1745
+ }
1746
+
1747
+ // Run the test
1748
+ example().catch(console.error);
1749
+ ```
1750
+
1751
+ ### Parameters
1752
+
1753
+
1754
+ | Name | Type | Description | Notes |
1755
+ |------------- | ------------- | ------------- | -------------|
1756
+ | **facetId** | `string` | Facet ID | [Defaults to `undefined`] |
1757
+
1758
+ ### Return type
1759
+
1760
+ [**FacetDetailsContainer**](FacetDetailsContainer.md)
1761
+
1762
+ ### Authorization
1763
+
1764
+ [api_key](../README.md#api_key)
1765
+
1766
+ ### HTTP request headers
1767
+
1768
+ - **Content-Type**: Not defined
1769
+ - **Accept**: `application/json`
1770
+
1771
+
1772
+ ### HTTP response details
1773
+ | Status code | Description | Response headers |
1774
+ |-------------|-------------|------------------|
1775
+ | **400** | Invalid input | - |
1776
+ | **200** | Facet details | - |
1777
+
1778
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1779
+
1780
+
1781
+ ## v2DensifiedBiomassInventoriesByRegionFacetGet
1782
+
1783
+ > FacetOptionListContainer v2DensifiedBiomassInventoriesByRegionFacetGet()
1784
+
1785
+
1786
+
1787
+ ### Example
1788
+
1789
+ ```ts
1790
+ import {
1791
+ Configuration,
1792
+ DBFApi,
1793
+ } from '';
1794
+ import type { V2DensifiedBiomassInventoriesByRegionFacetGetRequest } from '';
1795
+
1796
+ async function example() {
1797
+ console.log("🚀 Testing SDK...");
1798
+ const config = new Configuration({
1799
+ // To configure API key authorization: api_key
1800
+ apiKey: "YOUR API KEY",
1801
+ });
1802
+ const api = new DBFApi(config);
1803
+
1804
+ try {
1805
+ const data = await api.v2DensifiedBiomassInventoriesByRegionFacetGet();
1806
+ console.log(data);
1807
+ } catch (error) {
1808
+ console.error(error);
1809
+ }
1810
+ }
1811
+
1812
+ // Run the test
1813
+ example().catch(console.error);
1814
+ ```
1815
+
1816
+ ### Parameters
1817
+
1818
+ This endpoint does not need any parameter.
1819
+
1820
+ ### Return type
1821
+
1822
+ [**FacetOptionListContainer**](FacetOptionListContainer.md)
1823
+
1824
+ ### Authorization
1825
+
1826
+ [api_key](../README.md#api_key)
1827
+
1828
+ ### HTTP request headers
1829
+
1830
+ - **Content-Type**: Not defined
1831
+ - **Accept**: `application/json`
1832
+
1833
+
1834
+ ### HTTP response details
1835
+ | Status code | Description | Response headers |
1836
+ |-------------|-------------|------------------|
1837
+ | **400** | Invalid input | - |
1838
+ | **200** | List of facet options | - |
1839
+
1840
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1841
+
1842
+
1843
+ ## v2DensifiedBiomassInventoriesByRegionGet
1844
+
1845
+ > FinalRouteResponseContainer v2DensifiedBiomassInventoriesByRegionGet()
1846
+
1847
+
1848
+
1849
+ ### Example
1850
+
1851
+ ```ts
1852
+ import {
1853
+ Configuration,
1854
+ DBFApi,
1855
+ } from '';
1856
+ import type { V2DensifiedBiomassInventoriesByRegionGetRequest } from '';
1857
+
1858
+ async function example() {
1859
+ console.log("🚀 Testing SDK...");
1860
+ const config = new Configuration({
1861
+ // To configure API key authorization: api_key
1862
+ apiKey: "YOUR API KEY",
1863
+ });
1864
+ const api = new DBFApi(config);
1865
+
1866
+ try {
1867
+ const data = await api.v2DensifiedBiomassInventoriesByRegionGet();
1868
+ console.log(data);
1869
+ } catch (error) {
1870
+ console.error(error);
1871
+ }
1872
+ }
1873
+
1874
+ // Run the test
1875
+ example().catch(console.error);
1876
+ ```
1877
+
1878
+ ### Parameters
1879
+
1880
+ This endpoint does not need any parameter.
1881
+
1882
+ ### Return type
1883
+
1884
+ [**FinalRouteResponseContainer**](FinalRouteResponseContainer.md)
1885
+
1886
+ ### Authorization
1887
+
1888
+ [api_key](../README.md#api_key)
1889
+
1890
+ ### HTTP request headers
1891
+
1892
+ - **Content-Type**: Not defined
1893
+ - **Accept**: `application/json`
1894
+
1895
+
1896
+ ### HTTP response details
1897
+ | Status code | Description | Response headers |
1898
+ |-------------|-------------|------------------|
1899
+ | **200** | List of API data sets | - |
1900
+
1901
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1902
+
1903
+
1904
+ ## v2DensifiedBiomassProductionByRegionDataGet
1905
+
1906
+ > DataResponseContainer v2DensifiedBiomassProductionByRegionDataGet(data, facets, frequency, start, end, sort, length, offset)
1907
+
1908
+
1909
+
1910
+ API data with query params
1911
+
1912
+ ### Example
1913
+
1914
+ ```ts
1915
+ import {
1916
+ Configuration,
1917
+ DBFApi,
1918
+ } from '';
1919
+ import type { V2DensifiedBiomassProductionByRegionDataGetRequest } from '';
1920
+
1921
+ async function example() {
1922
+ console.log("🚀 Testing SDK...");
1923
+ const config = new Configuration({
1924
+ // To configure API key authorization: api_key
1925
+ apiKey: "YOUR API KEY",
1926
+ });
1927
+ const api = new DBFApi(config);
1928
+
1929
+ const body = {
1930
+ // Array<string> | Data columns to filter by (optional)
1931
+ data: ...,
1932
+ // object | Facets to filter by (optional)
1933
+ facets: Object,
1934
+ // string | Frequency to filter by (optional)
1935
+ frequency: frequency_example,
1936
+ // string | Start date to filter by (optional)
1937
+ start: start_example,
1938
+ // string | End date to filter by (optional)
1939
+ end: end_example,
1940
+ // Sort | How to sort returned data (optional)
1941
+ sort: ...,
1942
+ // number | Max length of returned data (optional)
1943
+ length: 56,
1944
+ // number | Offset of returned data (optional)
1945
+ offset: 56,
1946
+ } satisfies V2DensifiedBiomassProductionByRegionDataGetRequest;
1947
+
1948
+ try {
1949
+ const data = await api.v2DensifiedBiomassProductionByRegionDataGet(body);
1950
+ console.log(data);
1951
+ } catch (error) {
1952
+ console.error(error);
1953
+ }
1954
+ }
1955
+
1956
+ // Run the test
1957
+ example().catch(console.error);
1958
+ ```
1959
+
1960
+ ### Parameters
1961
+
1962
+
1963
+ | Name | Type | Description | Notes |
1964
+ |------------- | ------------- | ------------- | -------------|
1965
+ | **data** | `Array<string>` | Data columns to filter by | [Optional] |
1966
+ | **facets** | `object` | Facets to filter by | [Optional] [Defaults to `undefined`] |
1967
+ | **frequency** | `string` | Frequency to filter by | [Optional] [Defaults to `undefined`] |
1968
+ | **start** | `string` | Start date to filter by | [Optional] [Defaults to `undefined`] |
1969
+ | **end** | `string` | End date to filter by | [Optional] [Defaults to `undefined`] |
1970
+ | **sort** | [](.md) | How to sort returned data | [Optional] [Defaults to `undefined`] |
1971
+ | **length** | `number` | Max length of returned data | [Optional] [Defaults to `undefined`] |
1972
+ | **offset** | `number` | Offset of returned data | [Optional] [Defaults to `undefined`] |
1973
+
1974
+ ### Return type
1975
+
1976
+ [**DataResponseContainer**](DataResponseContainer.md)
1977
+
1978
+ ### Authorization
1979
+
1980
+ [api_key](../README.md#api_key)
1981
+
1982
+ ### HTTP request headers
1983
+
1984
+ - **Content-Type**: Not defined
1985
+ - **Accept**: `application/json`
1986
+
1987
+
1988
+ ### HTTP response details
1989
+ | Status code | Description | Response headers |
1990
+ |-------------|-------------|------------------|
1991
+ | **400** | Invalid input | - |
1992
+ | **200** | API Data | - |
1993
+
1994
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1995
+
1996
+
1997
+ ## v2DensifiedBiomassProductionByRegionDataPost
1998
+
1999
+ > DataResponseContainer v2DensifiedBiomassProductionByRegionDataPost(dataParams)
2000
+
2001
+ Return biomass production-by-region Data
2002
+
2003
+ Class ProductionByRegionController ProductionByRegion data set top-level controller.
2004
+
2005
+ ### Example
2006
+
2007
+ ```ts
2008
+ import {
2009
+ Configuration,
2010
+ DBFApi,
2011
+ } from '';
2012
+ import type { V2DensifiedBiomassProductionByRegionDataPostRequest } from '';
2013
+
2014
+ async function example() {
2015
+ console.log("🚀 Testing SDK...");
2016
+ const config = new Configuration({
2017
+ // To configure API key authorization: api_key
2018
+ apiKey: "YOUR API KEY",
2019
+ });
2020
+ const api = new DBFApi(config);
2021
+
2022
+ const body = {
2023
+ // DataParams | Parameters for data call
2024
+ dataParams: ...,
2025
+ } satisfies V2DensifiedBiomassProductionByRegionDataPostRequest;
2026
+
2027
+ try {
2028
+ const data = await api.v2DensifiedBiomassProductionByRegionDataPost(body);
2029
+ console.log(data);
2030
+ } catch (error) {
2031
+ console.error(error);
2032
+ }
2033
+ }
2034
+
2035
+ // Run the test
2036
+ example().catch(console.error);
2037
+ ```
2038
+
2039
+ ### Parameters
2040
+
2041
+
2042
+ | Name | Type | Description | Notes |
2043
+ |------------- | ------------- | ------------- | -------------|
2044
+ | **dataParams** | [DataParams](DataParams.md) | Parameters for data call | |
2045
+
2046
+ ### Return type
2047
+
2048
+ [**DataResponseContainer**](DataResponseContainer.md)
2049
+
2050
+ ### Authorization
2051
+
2052
+ [api_key](../README.md#api_key)
2053
+
2054
+ ### HTTP request headers
2055
+
2056
+ - **Content-Type**: `application/json`
2057
+ - **Accept**: `application/json`
2058
+
2059
+
2060
+ ### HTTP response details
2061
+ | Status code | Description | Response headers |
2062
+ |-------------|-------------|------------------|
2063
+ | **400** | Invalid input | - |
2064
+ | **200** | API Data | - |
2065
+
2066
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
2067
+
2068
+
2069
+ ## v2DensifiedBiomassProductionByRegionFacetFacetIdGet
2070
+
2071
+ > FacetDetailsContainer v2DensifiedBiomassProductionByRegionFacetFacetIdGet(facetId)
2072
+
2073
+
2074
+
2075
+ ### Example
2076
+
2077
+ ```ts
2078
+ import {
2079
+ Configuration,
2080
+ DBFApi,
2081
+ } from '';
2082
+ import type { V2DensifiedBiomassProductionByRegionFacetFacetIdGetRequest } from '';
2083
+
2084
+ async function example() {
2085
+ console.log("🚀 Testing SDK...");
2086
+ const config = new Configuration({
2087
+ // To configure API key authorization: api_key
2088
+ apiKey: "YOUR API KEY",
2089
+ });
2090
+ const api = new DBFApi(config);
2091
+
2092
+ const body = {
2093
+ // string | Facet ID
2094
+ facetId: facetId_example,
2095
+ } satisfies V2DensifiedBiomassProductionByRegionFacetFacetIdGetRequest;
2096
+
2097
+ try {
2098
+ const data = await api.v2DensifiedBiomassProductionByRegionFacetFacetIdGet(body);
2099
+ console.log(data);
2100
+ } catch (error) {
2101
+ console.error(error);
2102
+ }
2103
+ }
2104
+
2105
+ // Run the test
2106
+ example().catch(console.error);
2107
+ ```
2108
+
2109
+ ### Parameters
2110
+
2111
+
2112
+ | Name | Type | Description | Notes |
2113
+ |------------- | ------------- | ------------- | -------------|
2114
+ | **facetId** | `string` | Facet ID | [Defaults to `undefined`] |
2115
+
2116
+ ### Return type
2117
+
2118
+ [**FacetDetailsContainer**](FacetDetailsContainer.md)
2119
+
2120
+ ### Authorization
2121
+
2122
+ [api_key](../README.md#api_key)
2123
+
2124
+ ### HTTP request headers
2125
+
2126
+ - **Content-Type**: Not defined
2127
+ - **Accept**: `application/json`
2128
+
2129
+
2130
+ ### HTTP response details
2131
+ | Status code | Description | Response headers |
2132
+ |-------------|-------------|------------------|
2133
+ | **400** | Invalid input | - |
2134
+ | **200** | Facet details | - |
2135
+
2136
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
2137
+
2138
+
2139
+ ## v2DensifiedBiomassProductionByRegionFacetGet
2140
+
2141
+ > FacetOptionListContainer v2DensifiedBiomassProductionByRegionFacetGet()
2142
+
2143
+
2144
+
2145
+ ### Example
2146
+
2147
+ ```ts
2148
+ import {
2149
+ Configuration,
2150
+ DBFApi,
2151
+ } from '';
2152
+ import type { V2DensifiedBiomassProductionByRegionFacetGetRequest } from '';
2153
+
2154
+ async function example() {
2155
+ console.log("🚀 Testing SDK...");
2156
+ const config = new Configuration({
2157
+ // To configure API key authorization: api_key
2158
+ apiKey: "YOUR API KEY",
2159
+ });
2160
+ const api = new DBFApi(config);
2161
+
2162
+ try {
2163
+ const data = await api.v2DensifiedBiomassProductionByRegionFacetGet();
2164
+ console.log(data);
2165
+ } catch (error) {
2166
+ console.error(error);
2167
+ }
2168
+ }
2169
+
2170
+ // Run the test
2171
+ example().catch(console.error);
2172
+ ```
2173
+
2174
+ ### Parameters
2175
+
2176
+ This endpoint does not need any parameter.
2177
+
2178
+ ### Return type
2179
+
2180
+ [**FacetOptionListContainer**](FacetOptionListContainer.md)
2181
+
2182
+ ### Authorization
2183
+
2184
+ [api_key](../README.md#api_key)
2185
+
2186
+ ### HTTP request headers
2187
+
2188
+ - **Content-Type**: Not defined
2189
+ - **Accept**: `application/json`
2190
+
2191
+
2192
+ ### HTTP response details
2193
+ | Status code | Description | Response headers |
2194
+ |-------------|-------------|------------------|
2195
+ | **400** | Invalid input | - |
2196
+ | **200** | List of facet options | - |
2197
+
2198
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
2199
+
2200
+
2201
+ ## v2DensifiedBiomassProductionByRegionGet
2202
+
2203
+ > FinalRouteResponseContainer v2DensifiedBiomassProductionByRegionGet()
2204
+
2205
+
2206
+
2207
+ ### Example
2208
+
2209
+ ```ts
2210
+ import {
2211
+ Configuration,
2212
+ DBFApi,
2213
+ } from '';
2214
+ import type { V2DensifiedBiomassProductionByRegionGetRequest } from '';
2215
+
2216
+ async function example() {
2217
+ console.log("🚀 Testing SDK...");
2218
+ const config = new Configuration({
2219
+ // To configure API key authorization: api_key
2220
+ apiKey: "YOUR API KEY",
2221
+ });
2222
+ const api = new DBFApi(config);
2223
+
2224
+ try {
2225
+ const data = await api.v2DensifiedBiomassProductionByRegionGet();
2226
+ console.log(data);
2227
+ } catch (error) {
2228
+ console.error(error);
2229
+ }
2230
+ }
2231
+
2232
+ // Run the test
2233
+ example().catch(console.error);
2234
+ ```
2235
+
2236
+ ### Parameters
2237
+
2238
+ This endpoint does not need any parameter.
2239
+
2240
+ ### Return type
2241
+
2242
+ [**FinalRouteResponseContainer**](FinalRouteResponseContainer.md)
2243
+
2244
+ ### Authorization
2245
+
2246
+ [api_key](../README.md#api_key)
2247
+
2248
+ ### HTTP request headers
2249
+
2250
+ - **Content-Type**: Not defined
2251
+ - **Accept**: `application/json`
2252
+
2253
+
2254
+ ### HTTP response details
2255
+ | Status code | Description | Response headers |
2256
+ |-------------|-------------|------------------|
2257
+ | **200** | List of API data sets | - |
2258
+
2259
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
2260
+
2261
+
2262
+ ## v2DensifiedBiomassSalesAndPriceByRegionDataGet
2263
+
2264
+ > DataResponseContainer v2DensifiedBiomassSalesAndPriceByRegionDataGet(data, facets, frequency, start, end, sort, length, offset)
2265
+
2266
+
2267
+
2268
+ API data with query params
2269
+
2270
+ ### Example
2271
+
2272
+ ```ts
2273
+ import {
2274
+ Configuration,
2275
+ DBFApi,
2276
+ } from '';
2277
+ import type { V2DensifiedBiomassSalesAndPriceByRegionDataGetRequest } from '';
2278
+
2279
+ async function example() {
2280
+ console.log("🚀 Testing SDK...");
2281
+ const config = new Configuration({
2282
+ // To configure API key authorization: api_key
2283
+ apiKey: "YOUR API KEY",
2284
+ });
2285
+ const api = new DBFApi(config);
2286
+
2287
+ const body = {
2288
+ // Array<string> | Data columns to filter by (optional)
2289
+ data: ...,
2290
+ // object | Facets to filter by (optional)
2291
+ facets: Object,
2292
+ // string | Frequency to filter by (optional)
2293
+ frequency: frequency_example,
2294
+ // string | Start date to filter by (optional)
2295
+ start: start_example,
2296
+ // string | End date to filter by (optional)
2297
+ end: end_example,
2298
+ // Sort | How to sort returned data (optional)
2299
+ sort: ...,
2300
+ // number | Max length of returned data (optional)
2301
+ length: 56,
2302
+ // number | Offset of returned data (optional)
2303
+ offset: 56,
2304
+ } satisfies V2DensifiedBiomassSalesAndPriceByRegionDataGetRequest;
2305
+
2306
+ try {
2307
+ const data = await api.v2DensifiedBiomassSalesAndPriceByRegionDataGet(body);
2308
+ console.log(data);
2309
+ } catch (error) {
2310
+ console.error(error);
2311
+ }
2312
+ }
2313
+
2314
+ // Run the test
2315
+ example().catch(console.error);
2316
+ ```
2317
+
2318
+ ### Parameters
2319
+
2320
+
2321
+ | Name | Type | Description | Notes |
2322
+ |------------- | ------------- | ------------- | -------------|
2323
+ | **data** | `Array<string>` | Data columns to filter by | [Optional] |
2324
+ | **facets** | `object` | Facets to filter by | [Optional] [Defaults to `undefined`] |
2325
+ | **frequency** | `string` | Frequency to filter by | [Optional] [Defaults to `undefined`] |
2326
+ | **start** | `string` | Start date to filter by | [Optional] [Defaults to `undefined`] |
2327
+ | **end** | `string` | End date to filter by | [Optional] [Defaults to `undefined`] |
2328
+ | **sort** | [](.md) | How to sort returned data | [Optional] [Defaults to `undefined`] |
2329
+ | **length** | `number` | Max length of returned data | [Optional] [Defaults to `undefined`] |
2330
+ | **offset** | `number` | Offset of returned data | [Optional] [Defaults to `undefined`] |
2331
+
2332
+ ### Return type
2333
+
2334
+ [**DataResponseContainer**](DataResponseContainer.md)
2335
+
2336
+ ### Authorization
2337
+
2338
+ [api_key](../README.md#api_key)
2339
+
2340
+ ### HTTP request headers
2341
+
2342
+ - **Content-Type**: Not defined
2343
+ - **Accept**: `application/json`
2344
+
2345
+
2346
+ ### HTTP response details
2347
+ | Status code | Description | Response headers |
2348
+ |-------------|-------------|------------------|
2349
+ | **400** | Invalid input | - |
2350
+ | **200** | API Data | - |
2351
+
2352
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
2353
+
2354
+
2355
+ ## v2DensifiedBiomassSalesAndPriceByRegionDataPost
2356
+
2357
+ > DataResponseContainer v2DensifiedBiomassSalesAndPriceByRegionDataPost(dataParams)
2358
+
2359
+ Return biomass sales-and-price-by-region Data
2360
+
2361
+ Class SalesAndPriceByRegionController SalesAndPriceByRegion data set top-level controller.
2362
+
2363
+ ### Example
2364
+
2365
+ ```ts
2366
+ import {
2367
+ Configuration,
2368
+ DBFApi,
2369
+ } from '';
2370
+ import type { V2DensifiedBiomassSalesAndPriceByRegionDataPostRequest } from '';
2371
+
2372
+ async function example() {
2373
+ console.log("🚀 Testing SDK...");
2374
+ const config = new Configuration({
2375
+ // To configure API key authorization: api_key
2376
+ apiKey: "YOUR API KEY",
2377
+ });
2378
+ const api = new DBFApi(config);
2379
+
2380
+ const body = {
2381
+ // DataParams | Parameters for data call
2382
+ dataParams: ...,
2383
+ } satisfies V2DensifiedBiomassSalesAndPriceByRegionDataPostRequest;
2384
+
2385
+ try {
2386
+ const data = await api.v2DensifiedBiomassSalesAndPriceByRegionDataPost(body);
2387
+ console.log(data);
2388
+ } catch (error) {
2389
+ console.error(error);
2390
+ }
2391
+ }
2392
+
2393
+ // Run the test
2394
+ example().catch(console.error);
2395
+ ```
2396
+
2397
+ ### Parameters
2398
+
2399
+
2400
+ | Name | Type | Description | Notes |
2401
+ |------------- | ------------- | ------------- | -------------|
2402
+ | **dataParams** | [DataParams](DataParams.md) | Parameters for data call | |
2403
+
2404
+ ### Return type
2405
+
2406
+ [**DataResponseContainer**](DataResponseContainer.md)
2407
+
2408
+ ### Authorization
2409
+
2410
+ [api_key](../README.md#api_key)
2411
+
2412
+ ### HTTP request headers
2413
+
2414
+ - **Content-Type**: `application/json`
2415
+ - **Accept**: `application/json`
2416
+
2417
+
2418
+ ### HTTP response details
2419
+ | Status code | Description | Response headers |
2420
+ |-------------|-------------|------------------|
2421
+ | **400** | Invalid input | - |
2422
+ | **200** | API Data | - |
2423
+
2424
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
2425
+
2426
+
2427
+ ## v2DensifiedBiomassSalesAndPriceByRegionFacetFacetIdGet
2428
+
2429
+ > FacetDetailsContainer v2DensifiedBiomassSalesAndPriceByRegionFacetFacetIdGet(facetId)
2430
+
2431
+
2432
+
2433
+ ### Example
2434
+
2435
+ ```ts
2436
+ import {
2437
+ Configuration,
2438
+ DBFApi,
2439
+ } from '';
2440
+ import type { V2DensifiedBiomassSalesAndPriceByRegionFacetFacetIdGetRequest } from '';
2441
+
2442
+ async function example() {
2443
+ console.log("🚀 Testing SDK...");
2444
+ const config = new Configuration({
2445
+ // To configure API key authorization: api_key
2446
+ apiKey: "YOUR API KEY",
2447
+ });
2448
+ const api = new DBFApi(config);
2449
+
2450
+ const body = {
2451
+ // string | Facet ID
2452
+ facetId: facetId_example,
2453
+ } satisfies V2DensifiedBiomassSalesAndPriceByRegionFacetFacetIdGetRequest;
2454
+
2455
+ try {
2456
+ const data = await api.v2DensifiedBiomassSalesAndPriceByRegionFacetFacetIdGet(body);
2457
+ console.log(data);
2458
+ } catch (error) {
2459
+ console.error(error);
2460
+ }
2461
+ }
2462
+
2463
+ // Run the test
2464
+ example().catch(console.error);
2465
+ ```
2466
+
2467
+ ### Parameters
2468
+
2469
+
2470
+ | Name | Type | Description | Notes |
2471
+ |------------- | ------------- | ------------- | -------------|
2472
+ | **facetId** | `string` | Facet ID | [Defaults to `undefined`] |
2473
+
2474
+ ### Return type
2475
+
2476
+ [**FacetDetailsContainer**](FacetDetailsContainer.md)
2477
+
2478
+ ### Authorization
2479
+
2480
+ [api_key](../README.md#api_key)
2481
+
2482
+ ### HTTP request headers
2483
+
2484
+ - **Content-Type**: Not defined
2485
+ - **Accept**: `application/json`
2486
+
2487
+
2488
+ ### HTTP response details
2489
+ | Status code | Description | Response headers |
2490
+ |-------------|-------------|------------------|
2491
+ | **400** | Invalid input | - |
2492
+ | **200** | Facet details | - |
2493
+
2494
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
2495
+
2496
+
2497
+ ## v2DensifiedBiomassSalesAndPriceByRegionFacetGet
2498
+
2499
+ > FacetOptionListContainer v2DensifiedBiomassSalesAndPriceByRegionFacetGet()
2500
+
2501
+
2502
+
2503
+ ### Example
2504
+
2505
+ ```ts
2506
+ import {
2507
+ Configuration,
2508
+ DBFApi,
2509
+ } from '';
2510
+ import type { V2DensifiedBiomassSalesAndPriceByRegionFacetGetRequest } from '';
2511
+
2512
+ async function example() {
2513
+ console.log("🚀 Testing SDK...");
2514
+ const config = new Configuration({
2515
+ // To configure API key authorization: api_key
2516
+ apiKey: "YOUR API KEY",
2517
+ });
2518
+ const api = new DBFApi(config);
2519
+
2520
+ try {
2521
+ const data = await api.v2DensifiedBiomassSalesAndPriceByRegionFacetGet();
2522
+ console.log(data);
2523
+ } catch (error) {
2524
+ console.error(error);
2525
+ }
2526
+ }
2527
+
2528
+ // Run the test
2529
+ example().catch(console.error);
2530
+ ```
2531
+
2532
+ ### Parameters
2533
+
2534
+ This endpoint does not need any parameter.
2535
+
2536
+ ### Return type
2537
+
2538
+ [**FacetOptionListContainer**](FacetOptionListContainer.md)
2539
+
2540
+ ### Authorization
2541
+
2542
+ [api_key](../README.md#api_key)
2543
+
2544
+ ### HTTP request headers
2545
+
2546
+ - **Content-Type**: Not defined
2547
+ - **Accept**: `application/json`
2548
+
2549
+
2550
+ ### HTTP response details
2551
+ | Status code | Description | Response headers |
2552
+ |-------------|-------------|------------------|
2553
+ | **400** | Invalid input | - |
2554
+ | **200** | List of facet options | - |
2555
+
2556
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
2557
+
2558
+
2559
+ ## v2DensifiedBiomassSalesAndPriceByRegionGet
2560
+
2561
+ > FinalRouteResponseContainer v2DensifiedBiomassSalesAndPriceByRegionGet()
2562
+
2563
+
2564
+
2565
+ ### Example
2566
+
2567
+ ```ts
2568
+ import {
2569
+ Configuration,
2570
+ DBFApi,
2571
+ } from '';
2572
+ import type { V2DensifiedBiomassSalesAndPriceByRegionGetRequest } from '';
2573
+
2574
+ async function example() {
2575
+ console.log("🚀 Testing SDK...");
2576
+ const config = new Configuration({
2577
+ // To configure API key authorization: api_key
2578
+ apiKey: "YOUR API KEY",
2579
+ });
2580
+ const api = new DBFApi(config);
2581
+
2582
+ try {
2583
+ const data = await api.v2DensifiedBiomassSalesAndPriceByRegionGet();
2584
+ console.log(data);
2585
+ } catch (error) {
2586
+ console.error(error);
2587
+ }
2588
+ }
2589
+
2590
+ // Run the test
2591
+ example().catch(console.error);
2592
+ ```
2593
+
2594
+ ### Parameters
2595
+
2596
+ This endpoint does not need any parameter.
2597
+
2598
+ ### Return type
2599
+
2600
+ [**FinalRouteResponseContainer**](FinalRouteResponseContainer.md)
2601
+
2602
+ ### Authorization
2603
+
2604
+ [api_key](../README.md#api_key)
2605
+
2606
+ ### HTTP request headers
2607
+
2608
+ - **Content-Type**: Not defined
2609
+ - **Accept**: `application/json`
2610
+
2611
+
2612
+ ### HTTP response details
2613
+ | Status code | Description | Response headers |
2614
+ |-------------|-------------|------------------|
2615
+ | **200** | List of API data sets | - |
2616
+
2617
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
2618
+
2619
+
2620
+ ## v2DensifiedBiomassWoodPelletPlantsDataGet
2621
+
2622
+ > DataResponseContainer v2DensifiedBiomassWoodPelletPlantsDataGet(data, facets, frequency, start, end, sort, length, offset)
2623
+
2624
+
2625
+
2626
+ API data with query params
2627
+
2628
+ ### Example
2629
+
2630
+ ```ts
2631
+ import {
2632
+ Configuration,
2633
+ DBFApi,
2634
+ } from '';
2635
+ import type { V2DensifiedBiomassWoodPelletPlantsDataGetRequest } from '';
2636
+
2637
+ async function example() {
2638
+ console.log("🚀 Testing SDK...");
2639
+ const config = new Configuration({
2640
+ // To configure API key authorization: api_key
2641
+ apiKey: "YOUR API KEY",
2642
+ });
2643
+ const api = new DBFApi(config);
2644
+
2645
+ const body = {
2646
+ // Array<string> | Data columns to filter by (optional)
2647
+ data: ...,
2648
+ // object | Facets to filter by (optional)
2649
+ facets: Object,
2650
+ // string | Frequency to filter by (optional)
2651
+ frequency: frequency_example,
2652
+ // string | Start date to filter by (optional)
2653
+ start: start_example,
2654
+ // string | End date to filter by (optional)
2655
+ end: end_example,
2656
+ // Sort | How to sort returned data (optional)
2657
+ sort: ...,
2658
+ // number | Max length of returned data (optional)
2659
+ length: 56,
2660
+ // number | Offset of returned data (optional)
2661
+ offset: 56,
2662
+ } satisfies V2DensifiedBiomassWoodPelletPlantsDataGetRequest;
2663
+
2664
+ try {
2665
+ const data = await api.v2DensifiedBiomassWoodPelletPlantsDataGet(body);
2666
+ console.log(data);
2667
+ } catch (error) {
2668
+ console.error(error);
2669
+ }
2670
+ }
2671
+
2672
+ // Run the test
2673
+ example().catch(console.error);
2674
+ ```
2675
+
2676
+ ### Parameters
2677
+
2678
+
2679
+ | Name | Type | Description | Notes |
2680
+ |------------- | ------------- | ------------- | -------------|
2681
+ | **data** | `Array<string>` | Data columns to filter by | [Optional] |
2682
+ | **facets** | `object` | Facets to filter by | [Optional] [Defaults to `undefined`] |
2683
+ | **frequency** | `string` | Frequency to filter by | [Optional] [Defaults to `undefined`] |
2684
+ | **start** | `string` | Start date to filter by | [Optional] [Defaults to `undefined`] |
2685
+ | **end** | `string` | End date to filter by | [Optional] [Defaults to `undefined`] |
2686
+ | **sort** | [](.md) | How to sort returned data | [Optional] [Defaults to `undefined`] |
2687
+ | **length** | `number` | Max length of returned data | [Optional] [Defaults to `undefined`] |
2688
+ | **offset** | `number` | Offset of returned data | [Optional] [Defaults to `undefined`] |
2689
+
2690
+ ### Return type
2691
+
2692
+ [**DataResponseContainer**](DataResponseContainer.md)
2693
+
2694
+ ### Authorization
2695
+
2696
+ [api_key](../README.md#api_key)
2697
+
2698
+ ### HTTP request headers
2699
+
2700
+ - **Content-Type**: Not defined
2701
+ - **Accept**: `application/json`
2702
+
2703
+
2704
+ ### HTTP response details
2705
+ | Status code | Description | Response headers |
2706
+ |-------------|-------------|------------------|
2707
+ | **400** | Invalid input | - |
2708
+ | **200** | API Data | - |
2709
+
2710
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
2711
+
2712
+
2713
+ ## v2DensifiedBiomassWoodPelletPlantsDataPost
2714
+
2715
+ > DataResponseContainer v2DensifiedBiomassWoodPelletPlantsDataPost(dataParams)
2716
+
2717
+ Return biomass wood-pellet-plants Data
2718
+
2719
+ Class WoodPelletPlantsController WoodPelletPlants data set top-level controller.
2720
+
2721
+ ### Example
2722
+
2723
+ ```ts
2724
+ import {
2725
+ Configuration,
2726
+ DBFApi,
2727
+ } from '';
2728
+ import type { V2DensifiedBiomassWoodPelletPlantsDataPostRequest } from '';
2729
+
2730
+ async function example() {
2731
+ console.log("🚀 Testing SDK...");
2732
+ const config = new Configuration({
2733
+ // To configure API key authorization: api_key
2734
+ apiKey: "YOUR API KEY",
2735
+ });
2736
+ const api = new DBFApi(config);
2737
+
2738
+ const body = {
2739
+ // DataParams | Parameters for data call
2740
+ dataParams: ...,
2741
+ } satisfies V2DensifiedBiomassWoodPelletPlantsDataPostRequest;
2742
+
2743
+ try {
2744
+ const data = await api.v2DensifiedBiomassWoodPelletPlantsDataPost(body);
2745
+ console.log(data);
2746
+ } catch (error) {
2747
+ console.error(error);
2748
+ }
2749
+ }
2750
+
2751
+ // Run the test
2752
+ example().catch(console.error);
2753
+ ```
2754
+
2755
+ ### Parameters
2756
+
2757
+
2758
+ | Name | Type | Description | Notes |
2759
+ |------------- | ------------- | ------------- | -------------|
2760
+ | **dataParams** | [DataParams](DataParams.md) | Parameters for data call | |
2761
+
2762
+ ### Return type
2763
+
2764
+ [**DataResponseContainer**](DataResponseContainer.md)
2765
+
2766
+ ### Authorization
2767
+
2768
+ [api_key](../README.md#api_key)
2769
+
2770
+ ### HTTP request headers
2771
+
2772
+ - **Content-Type**: `application/json`
2773
+ - **Accept**: `application/json`
2774
+
2775
+
2776
+ ### HTTP response details
2777
+ | Status code | Description | Response headers |
2778
+ |-------------|-------------|------------------|
2779
+ | **400** | Invalid input | - |
2780
+ | **200** | API Data | - |
2781
+
2782
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
2783
+
2784
+
2785
+ ## v2DensifiedBiomassWoodPelletPlantsFacetFacetIdGet
2786
+
2787
+ > FacetDetailsContainer v2DensifiedBiomassWoodPelletPlantsFacetFacetIdGet(facetId)
2788
+
2789
+
2790
+
2791
+ ### Example
2792
+
2793
+ ```ts
2794
+ import {
2795
+ Configuration,
2796
+ DBFApi,
2797
+ } from '';
2798
+ import type { V2DensifiedBiomassWoodPelletPlantsFacetFacetIdGetRequest } from '';
2799
+
2800
+ async function example() {
2801
+ console.log("🚀 Testing SDK...");
2802
+ const config = new Configuration({
2803
+ // To configure API key authorization: api_key
2804
+ apiKey: "YOUR API KEY",
2805
+ });
2806
+ const api = new DBFApi(config);
2807
+
2808
+ const body = {
2809
+ // string | Facet ID
2810
+ facetId: facetId_example,
2811
+ } satisfies V2DensifiedBiomassWoodPelletPlantsFacetFacetIdGetRequest;
2812
+
2813
+ try {
2814
+ const data = await api.v2DensifiedBiomassWoodPelletPlantsFacetFacetIdGet(body);
2815
+ console.log(data);
2816
+ } catch (error) {
2817
+ console.error(error);
2818
+ }
2819
+ }
2820
+
2821
+ // Run the test
2822
+ example().catch(console.error);
2823
+ ```
2824
+
2825
+ ### Parameters
2826
+
2827
+
2828
+ | Name | Type | Description | Notes |
2829
+ |------------- | ------------- | ------------- | -------------|
2830
+ | **facetId** | `string` | Facet ID | [Defaults to `undefined`] |
2831
+
2832
+ ### Return type
2833
+
2834
+ [**FacetDetailsContainer**](FacetDetailsContainer.md)
2835
+
2836
+ ### Authorization
2837
+
2838
+ [api_key](../README.md#api_key)
2839
+
2840
+ ### HTTP request headers
2841
+
2842
+ - **Content-Type**: Not defined
2843
+ - **Accept**: `application/json`
2844
+
2845
+
2846
+ ### HTTP response details
2847
+ | Status code | Description | Response headers |
2848
+ |-------------|-------------|------------------|
2849
+ | **400** | Invalid input | - |
2850
+ | **200** | Facet details | - |
2851
+
2852
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
2853
+
2854
+
2855
+ ## v2DensifiedBiomassWoodPelletPlantsFacetGet
2856
+
2857
+ > FacetOptionListContainer v2DensifiedBiomassWoodPelletPlantsFacetGet()
2858
+
2859
+
2860
+
2861
+ ### Example
2862
+
2863
+ ```ts
2864
+ import {
2865
+ Configuration,
2866
+ DBFApi,
2867
+ } from '';
2868
+ import type { V2DensifiedBiomassWoodPelletPlantsFacetGetRequest } from '';
2869
+
2870
+ async function example() {
2871
+ console.log("🚀 Testing SDK...");
2872
+ const config = new Configuration({
2873
+ // To configure API key authorization: api_key
2874
+ apiKey: "YOUR API KEY",
2875
+ });
2876
+ const api = new DBFApi(config);
2877
+
2878
+ try {
2879
+ const data = await api.v2DensifiedBiomassWoodPelletPlantsFacetGet();
2880
+ console.log(data);
2881
+ } catch (error) {
2882
+ console.error(error);
2883
+ }
2884
+ }
2885
+
2886
+ // Run the test
2887
+ example().catch(console.error);
2888
+ ```
2889
+
2890
+ ### Parameters
2891
+
2892
+ This endpoint does not need any parameter.
2893
+
2894
+ ### Return type
2895
+
2896
+ [**FacetOptionListContainer**](FacetOptionListContainer.md)
2897
+
2898
+ ### Authorization
2899
+
2900
+ [api_key](../README.md#api_key)
2901
+
2902
+ ### HTTP request headers
2903
+
2904
+ - **Content-Type**: Not defined
2905
+ - **Accept**: `application/json`
2906
+
2907
+
2908
+ ### HTTP response details
2909
+ | Status code | Description | Response headers |
2910
+ |-------------|-------------|------------------|
2911
+ | **400** | Invalid input | - |
2912
+ | **200** | List of facet options | - |
2913
+
2914
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
2915
+
2916
+
2917
+ ## v2DensifiedBiomassWoodPelletPlantsGet
2918
+
2919
+ > FinalRouteResponseContainer v2DensifiedBiomassWoodPelletPlantsGet()
2920
+
2921
+
2922
+
2923
+ ### Example
2924
+
2925
+ ```ts
2926
+ import {
2927
+ Configuration,
2928
+ DBFApi,
2929
+ } from '';
2930
+ import type { V2DensifiedBiomassWoodPelletPlantsGetRequest } from '';
2931
+
2932
+ async function example() {
2933
+ console.log("🚀 Testing SDK...");
2934
+ const config = new Configuration({
2935
+ // To configure API key authorization: api_key
2936
+ apiKey: "YOUR API KEY",
2937
+ });
2938
+ const api = new DBFApi(config);
2939
+
2940
+ try {
2941
+ const data = await api.v2DensifiedBiomassWoodPelletPlantsGet();
2942
+ console.log(data);
2943
+ } catch (error) {
2944
+ console.error(error);
2945
+ }
2946
+ }
2947
+
2948
+ // Run the test
2949
+ example().catch(console.error);
2950
+ ```
2951
+
2952
+ ### Parameters
2953
+
2954
+ This endpoint does not need any parameter.
2955
+
2956
+ ### Return type
2957
+
2958
+ [**FinalRouteResponseContainer**](FinalRouteResponseContainer.md)
2959
+
2960
+ ### Authorization
2961
+
2962
+ [api_key](../README.md#api_key)
2963
+
2964
+ ### HTTP request headers
2965
+
2966
+ - **Content-Type**: Not defined
2967
+ - **Accept**: `application/json`
2968
+
2969
+
2970
+ ### HTTP response details
2971
+ | Status code | Description | Response headers |
2972
+ |-------------|-------------|------------------|
2973
+ | **200** | List of API data sets | - |
2974
+
2975
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
2976
+