eiagov-typescript-fetch-client 1.0.0

package/docs/COALApi.md

@@ -0,0 +1,4847 @@
+# COALApi
+
+All URIs are relative to *https://api.eia.gov*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**v2CoalAggregateProductionDataGet**](COALApi.md#v2coalaggregateproductiondataget) | **GET** /v2/coal/aggregate-production/data |  |
+| [**v2CoalAggregateProductionDataPost**](COALApi.md#v2coalaggregateproductiondatapost) | **POST** /v2/coal/aggregate-production/data | Return aggregate-production Data |
+| [**v2CoalAggregateProductionFacetFacetIdGet**](COALApi.md#v2coalaggregateproductionfacetfacetidget) | **GET** /v2/coal/aggregate-production/facet/{facet_id} |  |
+| [**v2CoalAggregateProductionFacetGet**](COALApi.md#v2coalaggregateproductionfacetget) | **GET** /v2/coal/aggregate-production/facet |  |
+| [**v2CoalAggregateProductionGet**](COALApi.md#v2coalaggregateproductionget) | **GET** /v2/coal/aggregate-production |  |
+| [**v2CoalConsumptionAndQualityDataGet**](COALApi.md#v2coalconsumptionandqualitydataget) | **GET** /v2/coal/consumption-and-quality/data |  |
+| [**v2CoalConsumptionAndQualityDataPost**](COALApi.md#v2coalconsumptionandqualitydatapost) | **POST** /v2/coal/consumption-and-quality/data | Return consumption-and-quality Data |
+| [**v2CoalConsumptionAndQualityFacetFacetIdGet**](COALApi.md#v2coalconsumptionandqualityfacetfacetidget) | **GET** /v2/coal/consumption-and-quality/facet/{facet_id} |  |
+| [**v2CoalConsumptionAndQualityFacetGet**](COALApi.md#v2coalconsumptionandqualityfacetget) | **GET** /v2/coal/consumption-and-quality/facet |  |
+| [**v2CoalConsumptionAndQualityGet**](COALApi.md#v2coalconsumptionandqualityget) | **GET** /v2/coal/consumption-and-quality |  |
+| [**v2CoalExportsImportsQuantityPriceDataGet**](COALApi.md#v2coalexportsimportsquantitypricedataget) | **GET** /v2/coal/exports-imports-quantity-price/data |  |
+| [**v2CoalExportsImportsQuantityPriceDataPost**](COALApi.md#v2coalexportsimportsquantitypricedatapost) | **POST** /v2/coal/exports-imports-quantity-price/data | Return exports-imports-quantity-price Data |
+| [**v2CoalExportsImportsQuantityPriceFacetFacetIdGet**](COALApi.md#v2coalexportsimportsquantitypricefacetfacetidget) | **GET** /v2/coal/exports-imports-quantity-price/facet/{facet_id} |  |
+| [**v2CoalExportsImportsQuantityPriceFacetGet**](COALApi.md#v2coalexportsimportsquantitypricefacetget) | **GET** /v2/coal/exports-imports-quantity-price/facet |  |
+| [**v2CoalExportsImportsQuantityPriceGet**](COALApi.md#v2coalexportsimportsquantitypriceget) | **GET** /v2/coal/exports-imports-quantity-price |  |
+| [**v2CoalGet**](COALApi.md#v2coalget) | **GET** /v2/coal | Class CoalController |
+| [**v2CoalMarketSalesPriceDataGet**](COALApi.md#v2coalmarketsalespricedataget) | **GET** /v2/coal/market-sales-price/data |  |
+| [**v2CoalMarketSalesPriceDataPost**](COALApi.md#v2coalmarketsalespricedatapost) | **POST** /v2/coal/market-sales-price/data | Return market-sales-price Data |
+| [**v2CoalMarketSalesPriceFacetFacetIdGet**](COALApi.md#v2coalmarketsalespricefacetfacetidget) | **GET** /v2/coal/market-sales-price/facet/{facet_id} |  |
+| [**v2CoalMarketSalesPriceFacetGet**](COALApi.md#v2coalmarketsalespricefacetget) | **GET** /v2/coal/market-sales-price/facet |  |
+| [**v2CoalMarketSalesPriceGet**](COALApi.md#v2coalmarketsalespriceget) | **GET** /v2/coal/market-sales-price |  |
+| [**v2CoalMineProductionDataGet**](COALApi.md#v2coalmineproductiondataget) | **GET** /v2/coal/mine-production/data |  |
+| [**v2CoalMineProductionDataPost**](COALApi.md#v2coalmineproductiondatapost) | **POST** /v2/coal/mine-production/data | Return mine-production Data |
+| [**v2CoalMineProductionFacetFacetIdGet**](COALApi.md#v2coalmineproductionfacetfacetidget) | **GET** /v2/coal/mine-production/facet/{facet_id} |  |
+| [**v2CoalMineProductionFacetGet**](COALApi.md#v2coalmineproductionfacetget) | **GET** /v2/coal/mine-production/facet |  |
+| [**v2CoalMineProductionGet**](COALApi.md#v2coalmineproductionget) | **GET** /v2/coal/mine-production |  |
+| [**v2CoalPriceByRankDataGet**](COALApi.md#v2coalpricebyrankdataget) | **GET** /v2/coal/price-by-rank/data |  |
+| [**v2CoalPriceByRankDataPost**](COALApi.md#v2coalpricebyrankdatapost) | **POST** /v2/coal/price-by-rank/data | Return price-by-rank Data |
+| [**v2CoalPriceByRankFacetFacetIdGet**](COALApi.md#v2coalpricebyrankfacetfacetidget) | **GET** /v2/coal/price-by-rank/facet/{facet_id} |  |
+| [**v2CoalPriceByRankFacetGet**](COALApi.md#v2coalpricebyrankfacetget) | **GET** /v2/coal/price-by-rank/facet |  |
+| [**v2CoalPriceByRankGet**](COALApi.md#v2coalpricebyrankget) | **GET** /v2/coal/price-by-rank |  |
+| [**v2CoalReservesCapacityDataGet**](COALApi.md#v2coalreservescapacitydataget) | **GET** /v2/coal/reserves-capacity/data |  |
+| [**v2CoalReservesCapacityDataPost**](COALApi.md#v2coalreservescapacitydatapost) | **POST** /v2/coal/reserves-capacity/data | Return reserves-capacity data |
+| [**v2CoalReservesCapacityFacetFacetIdGet**](COALApi.md#v2coalreservescapacityfacetfacetidget) | **GET** /v2/coal/reserves-capacity/facet/{facet_id} |  |
+| [**v2CoalReservesCapacityFacetGet**](COALApi.md#v2coalreservescapacityfacetget) | **GET** /v2/coal/reserves-capacity/facet |  |
+| [**v2CoalReservesCapacityGet**](COALApi.md#v2coalreservescapacityget) | **GET** /v2/coal/reserves-capacity |  |
+| [**v2CoalShipmentsByMineByPlantDataGet**](COALApi.md#v2coalshipmentsbyminebyplantdataget) | **GET** /v2/coal/shipments/by-mine-by-plant/data |  |
+| [**v2CoalShipmentsByMineByPlantDataPost**](COALApi.md#v2coalshipmentsbyminebyplantdatapost) | **POST** /v2/coal/shipments/by-mine-by-plant/data | Return shipments by-mine-by-plant data |
+| [**v2CoalShipmentsByMineByPlantFacetFacetIdGet**](COALApi.md#v2coalshipmentsbyminebyplantfacetfacetidget) | **GET** /v2/coal/shipments/by-mine-by-plant/facet/{facet_id} |  |
+| [**v2CoalShipmentsByMineByPlantFacetGet**](COALApi.md#v2coalshipmentsbyminebyplantfacetget) | **GET** /v2/coal/shipments/by-mine-by-plant/facet |  |
+| [**v2CoalShipmentsByMineByPlantGet**](COALApi.md#v2coalshipmentsbyminebyplantget) | **GET** /v2/coal/shipments/by-mine-by-plant |  |
+| [**v2CoalShipmentsGet**](COALApi.md#v2coalshipmentsget) | **GET** /v2/coal/shipments | Class CoalController |
+| [**v2CoalShipmentsMineAggregatesDataGet**](COALApi.md#v2coalshipmentsmineaggregatesdataget) | **GET** /v2/coal/shipments/mine-aggregates/data |  |
+| [**v2CoalShipmentsMineAggregatesDataPost**](COALApi.md#v2coalshipmentsmineaggregatesdatapost) | **POST** /v2/coal/shipments/mine-aggregates/data | Return shipments mine-aggregates data |
+| [**v2CoalShipmentsMineAggregatesFacetFacetIdGet**](COALApi.md#v2coalshipmentsmineaggregatesfacetfacetidget) | **GET** /v2/coal/shipments/mine-aggregates/facet/{facet_id} |  |
+| [**v2CoalShipmentsMineAggregatesFacetGet**](COALApi.md#v2coalshipmentsmineaggregatesfacetget) | **GET** /v2/coal/shipments/mine-aggregates/facet |  |
+| [**v2CoalShipmentsMineAggregatesGet**](COALApi.md#v2coalshipmentsmineaggregatesget) | **GET** /v2/coal/shipments/mine-aggregates |  |
+| [**v2CoalShipmentsMineStateAggregatesDataGet**](COALApi.md#v2coalshipmentsminestateaggregatesdataget) | **GET** /v2/coal/shipments/mine-state-aggregates/data |  |
+| [**v2CoalShipmentsMineStateAggregatesDataPost**](COALApi.md#v2coalshipmentsminestateaggregatesdatapost) | **POST** /v2/coal/shipments/mine-state-aggregates/data | Return shipments mine-state-aggregates data |
+| [**v2CoalShipmentsMineStateAggregatesFacetFacetIdGet**](COALApi.md#v2coalshipmentsminestateaggregatesfacetfacetidget) | **GET** /v2/coal/shipments/mine-state-aggregates/facet/{facet_id} |  |
+| [**v2CoalShipmentsMineStateAggregatesFacetGet**](COALApi.md#v2coalshipmentsminestateaggregatesfacetget) | **GET** /v2/coal/shipments/mine-state-aggregates/facet |  |
+| [**v2CoalShipmentsMineStateAggregatesGet**](COALApi.md#v2coalshipmentsminestateaggregatesget) | **GET** /v2/coal/shipments/mine-state-aggregates |  |
+| [**v2CoalShipmentsPlantAggregatesDataGet**](COALApi.md#v2coalshipmentsplantaggregatesdataget) | **GET** /v2/coal/shipments/plant-aggregates/data |  |
+| [**v2CoalShipmentsPlantAggregatesDataPost**](COALApi.md#v2coalshipmentsplantaggregatesdatapost) | **POST** /v2/coal/shipments/plant-aggregates/data | Return shipments plant-aggregates data |
+| [**v2CoalShipmentsPlantAggregatesFacetFacetIdGet**](COALApi.md#v2coalshipmentsplantaggregatesfacetfacetidget) | **GET** /v2/coal/shipments/plant-aggregates/facet/{facet_id} |  |
+| [**v2CoalShipmentsPlantAggregatesFacetGet**](COALApi.md#v2coalshipmentsplantaggregatesfacetget) | **GET** /v2/coal/shipments/plant-aggregates/facet |  |
+| [**v2CoalShipmentsPlantAggregatesGet**](COALApi.md#v2coalshipmentsplantaggregatesget) | **GET** /v2/coal/shipments/plant-aggregates |  |
+| [**v2CoalShipmentsPlantStateAggregatesDataGet**](COALApi.md#v2coalshipmentsplantstateaggregatesdataget) | **GET** /v2/coal/shipments/plant-state-aggregates/data |  |
+| [**v2CoalShipmentsPlantStateAggregatesDataPost**](COALApi.md#v2coalshipmentsplantstateaggregatesdatapost) | **POST** /v2/coal/shipments/plant-state-aggregates/data | Return shipments plant-state-aggregates data |
+| [**v2CoalShipmentsPlantStateAggregatesFacetFacetIdGet**](COALApi.md#v2coalshipmentsplantstateaggregatesfacetfacetidget) | **GET** /v2/coal/shipments/plant-state-aggregates/facet/{facet_id} |  |
+| [**v2CoalShipmentsPlantStateAggregatesFacetGet**](COALApi.md#v2coalshipmentsplantstateaggregatesfacetget) | **GET** /v2/coal/shipments/plant-state-aggregates/facet |  |
+| [**v2CoalShipmentsPlantStateAggregatesGet**](COALApi.md#v2coalshipmentsplantstateaggregatesget) | **GET** /v2/coal/shipments/plant-state-aggregates |  |
+| [**v2CoalShipmentsReceiptsDataGet**](COALApi.md#v2coalshipmentsreceiptsdataget) | **GET** /v2/coal/shipments/receipts/data |  |
+| [**v2CoalShipmentsReceiptsDataPost**](COALApi.md#v2coalshipmentsreceiptsdatapost) | **POST** /v2/coal/shipments/receipts/data | Return shipments receipts data |
+| [**v2CoalShipmentsReceiptsFacetFacetIdGet**](COALApi.md#v2coalshipmentsreceiptsfacetfacetidget) | **GET** /v2/coal/shipments/receipts/facet/{facet_id} |  |
+| [**v2CoalShipmentsReceiptsFacetGet**](COALApi.md#v2coalshipmentsreceiptsfacetget) | **GET** /v2/coal/shipments/receipts/facet |  |
+| [**v2CoalShipmentsReceiptsGet**](COALApi.md#v2coalshipmentsreceiptsget) | **GET** /v2/coal/shipments/receipts |  |
+
+
+
+## v2CoalAggregateProductionDataGet
+
+> DataResponseContainer v2CoalAggregateProductionDataGet(data, facets, frequency, start, end, sort, length, offset)
+
+
+
+API data with query params
+
+### Example
+
+```ts
+import {
+  Configuration,
+  COALApi,
+} from '';
+import type { V2CoalAggregateProductionDataGetRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: api_key
+    apiKey: "YOUR API KEY",
+  });
+  const api = new COALApi(config);
+
+  const body = {
+    // Array<string> | Data columns to filter by (optional)
+    data: ...,
+    // object | Facets to filter by (optional)
+    facets: Object,
+    // string | Frequency to filter by (optional)
+    frequency: frequency_example,
+    // string | Start date to filter by (optional)
+    start: start_example,
+    // string | End date to filter by (optional)
+    end: end_example,
+    // Sort | How to sort returned data (optional)
+    sort: ...,
+    // number | Max length of returned data (optional)
+    length: 56,
+    // number | Offset of returned data (optional)
+    offset: 56,
+  } satisfies V2CoalAggregateProductionDataGetRequest;
+
+  try {
+    const data = await api.v2CoalAggregateProductionDataGet(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **data** | `Array<string>` | Data columns to filter by | [Optional] |
+| **facets** | `object` | Facets to filter by | [Optional] [Defaults to `undefined`] |
+| **frequency** | `string` | Frequency to filter by | [Optional] [Defaults to `undefined`] |
+| **start** | `string` | Start date to filter by | [Optional] [Defaults to `undefined`] |
+| **end** | `string` | End date to filter by | [Optional] [Defaults to `undefined`] |
+| **sort** | [](.md) | How to sort returned data | [Optional] [Defaults to `undefined`] |
+| **length** | `number` | Max length of returned data | [Optional] [Defaults to `undefined`] |
+| **offset** | `number` | Offset of returned data | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**DataResponseContainer**](DataResponseContainer.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **400** | Invalid input |  -  |
+| **200** | API Data |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## v2CoalAggregateProductionDataPost
+
+> DataResponseContainer v2CoalAggregateProductionDataPost(dataParams)
+
+Return aggregate-production Data
+
+Class AggregateProductionController  Aggregate Production data set top-level controller.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  COALApi,
+} from '';
+import type { V2CoalAggregateProductionDataPostRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: api_key
+    apiKey: "YOUR API KEY",
+  });
+  const api = new COALApi(config);
+
+  const body = {
+    // DataParams | Parameters for data call
+    dataParams: ...,
+  } satisfies V2CoalAggregateProductionDataPostRequest;
+
+  try {
+    const data = await api.v2CoalAggregateProductionDataPost(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **dataParams** | [DataParams](DataParams.md) | Parameters for data call | |
+
+### Return type
+
+[**DataResponseContainer**](DataResponseContainer.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **400** | Invalid input |  -  |
+| **200** | API Data |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## v2CoalAggregateProductionFacetFacetIdGet
+
+> FacetDetailsContainer v2CoalAggregateProductionFacetFacetIdGet(facetId)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  COALApi,
+} from '';
+import type { V2CoalAggregateProductionFacetFacetIdGetRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: api_key
+    apiKey: "YOUR API KEY",
+  });
+  const api = new COALApi(config);
+
+  const body = {
+    // string | Facet ID
+    facetId: facetId_example,
+  } satisfies V2CoalAggregateProductionFacetFacetIdGetRequest;
+
+  try {
+    const data = await api.v2CoalAggregateProductionFacetFacetIdGet(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **facetId** | `string` | Facet ID | [Defaults to `undefined`] |
+
+### Return type
+
+[**FacetDetailsContainer**](FacetDetailsContainer.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **400** | Invalid input |  -  |
+| **200** | Facet details |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## v2CoalAggregateProductionFacetGet
+
+> FacetOptionListContainer v2CoalAggregateProductionFacetGet()
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  COALApi,
+} from '';
+import type { V2CoalAggregateProductionFacetGetRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: api_key
+    apiKey: "YOUR API KEY",
+  });
+  const api = new COALApi(config);
+
+  try {
+    const data = await api.v2CoalAggregateProductionFacetGet();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**FacetOptionListContainer**](FacetOptionListContainer.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **400** | Invalid input |  -  |
+| **200** | List of facet options |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## v2CoalAggregateProductionGet
+
+> FinalRouteResponseContainer v2CoalAggregateProductionGet()
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  COALApi,
+} from '';
+import type { V2CoalAggregateProductionGetRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: api_key
+    apiKey: "YOUR API KEY",
+  });
+  const api = new COALApi(config);
+
+  try {
+    const data = await api.v2CoalAggregateProductionGet();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**FinalRouteResponseContainer**](FinalRouteResponseContainer.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | List of API data sets |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## v2CoalConsumptionAndQualityDataGet
+
+> DataResponseContainer v2CoalConsumptionAndQualityDataGet(data, facets, frequency, start, end, sort, length, offset)
+
+
+
+API data with query params
+
+### Example
+
+```ts
+import {
+  Configuration,
+  COALApi,
+} from '';
+import type { V2CoalConsumptionAndQualityDataGetRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: api_key
+    apiKey: "YOUR API KEY",
+  });
+  const api = new COALApi(config);
+
+  const body = {
+    // Array<string> | Data columns to filter by (optional)
+    data: ...,
+    // object | Facets to filter by (optional)
+    facets: Object,
+    // string | Frequency to filter by (optional)
+    frequency: frequency_example,
+    // string | Start date to filter by (optional)
+    start: start_example,
+    // string | End date to filter by (optional)
+    end: end_example,
+    // Sort | How to sort returned data (optional)
+    sort: ...,
+    // number | Max length of returned data (optional)
+    length: 56,
+    // number | Offset of returned data (optional)
+    offset: 56,
+  } satisfies V2CoalConsumptionAndQualityDataGetRequest;
+
+  try {
+    const data = await api.v2CoalConsumptionAndQualityDataGet(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **data** | `Array<string>` | Data columns to filter by | [Optional] |
+| **facets** | `object` | Facets to filter by | [Optional] [Defaults to `undefined`] |
+| **frequency** | `string` | Frequency to filter by | [Optional] [Defaults to `undefined`] |
+| **start** | `string` | Start date to filter by | [Optional] [Defaults to `undefined`] |
+| **end** | `string` | End date to filter by | [Optional] [Defaults to `undefined`] |
+| **sort** | [](.md) | How to sort returned data | [Optional] [Defaults to `undefined`] |
+| **length** | `number` | Max length of returned data | [Optional] [Defaults to `undefined`] |
+| **offset** | `number` | Offset of returned data | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**DataResponseContainer**](DataResponseContainer.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **400** | Invalid input |  -  |
+| **200** | API Data |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## v2CoalConsumptionAndQualityDataPost
+
+> DataResponseContainer v2CoalConsumptionAndQualityDataPost(dataParams)
+
+Return consumption-and-quality Data
+
+### Example
+
+```ts
+import {
+  Configuration,
+  COALApi,
+} from '';
+import type { V2CoalConsumptionAndQualityDataPostRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: api_key
+    apiKey: "YOUR API KEY",
+  });
+  const api = new COALApi(config);
+
+  const body = {
+    // DataParams | Parameters for data call
+    dataParams: ...,
+  } satisfies V2CoalConsumptionAndQualityDataPostRequest;
+
+  try {
+    const data = await api.v2CoalConsumptionAndQualityDataPost(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **dataParams** | [DataParams](DataParams.md) | Parameters for data call | |
+
+### Return type
+
+[**DataResponseContainer**](DataResponseContainer.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **400** | Invalid input |  -  |
+| **200** | API Data |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## v2CoalConsumptionAndQualityFacetFacetIdGet
+
+> FacetDetailsContainer v2CoalConsumptionAndQualityFacetFacetIdGet(facetId)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  COALApi,
+} from '';
+import type { V2CoalConsumptionAndQualityFacetFacetIdGetRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: api_key
+    apiKey: "YOUR API KEY",
+  });
+  const api = new COALApi(config);
+
+  const body = {
+    // string | Facet ID
+    facetId: facetId_example,
+  } satisfies V2CoalConsumptionAndQualityFacetFacetIdGetRequest;
+
+  try {
+    const data = await api.v2CoalConsumptionAndQualityFacetFacetIdGet(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **facetId** | `string` | Facet ID | [Defaults to `undefined`] |
+
+### Return type
+
+[**FacetDetailsContainer**](FacetDetailsContainer.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **400** | Invalid input |  -  |
+| **200** | Facet details |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## v2CoalConsumptionAndQualityFacetGet
+
+> FacetOptionListContainer v2CoalConsumptionAndQualityFacetGet()
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  COALApi,
+} from '';
+import type { V2CoalConsumptionAndQualityFacetGetRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: api_key
+    apiKey: "YOUR API KEY",
+  });
+  const api = new COALApi(config);
+
+  try {
+    const data = await api.v2CoalConsumptionAndQualityFacetGet();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**FacetOptionListContainer**](FacetOptionListContainer.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **400** | Invalid input |  -  |
+| **200** | List of facet options |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## v2CoalConsumptionAndQualityGet
+
+> FinalRouteResponseContainer v2CoalConsumptionAndQualityGet()
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  COALApi,
+} from '';
+import type { V2CoalConsumptionAndQualityGetRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: api_key
+    apiKey: "YOUR API KEY",
+  });
+  const api = new COALApi(config);
+
+  try {
+    const data = await api.v2CoalConsumptionAndQualityGet();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**FinalRouteResponseContainer**](FinalRouteResponseContainer.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | List of API data sets |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## v2CoalExportsImportsQuantityPriceDataGet
+
+> DataResponseContainer v2CoalExportsImportsQuantityPriceDataGet(data, facets, frequency, start, end, sort, length, offset)
+
+
+
+API data with query params
+
+### Example
+
+```ts
+import {
+  Configuration,
+  COALApi,
+} from '';
+import type { V2CoalExportsImportsQuantityPriceDataGetRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: api_key
+    apiKey: "YOUR API KEY",
+  });
+  const api = new COALApi(config);
+
+  const body = {
+    // Array<string> | Data columns to filter by (optional)
+    data: ...,
+    // object | Facets to filter by (optional)
+    facets: Object,
+    // string | Frequency to filter by (optional)
+    frequency: frequency_example,
+    // string | Start date to filter by (optional)
+    start: start_example,
+    // string | End date to filter by (optional)
+    end: end_example,
+    // Sort | How to sort returned data (optional)
+    sort: ...,
+    // number | Max length of returned data (optional)
+    length: 56,
+    // number | Offset of returned data (optional)
+    offset: 56,
+  } satisfies V2CoalExportsImportsQuantityPriceDataGetRequest;
+
+  try {
+    const data = await api.v2CoalExportsImportsQuantityPriceDataGet(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **data** | `Array<string>` | Data columns to filter by | [Optional] |
+| **facets** | `object` | Facets to filter by | [Optional] [Defaults to `undefined`] |
+| **frequency** | `string` | Frequency to filter by | [Optional] [Defaults to `undefined`] |
+| **start** | `string` | Start date to filter by | [Optional] [Defaults to `undefined`] |
+| **end** | `string` | End date to filter by | [Optional] [Defaults to `undefined`] |
+| **sort** | [](.md) | How to sort returned data | [Optional] [Defaults to `undefined`] |
+| **length** | `number` | Max length of returned data | [Optional] [Defaults to `undefined`] |
+| **offset** | `number` | Offset of returned data | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**DataResponseContainer**](DataResponseContainer.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **400** | Invalid input |  -  |
+| **200** | API Data |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## v2CoalExportsImportsQuantityPriceDataPost
+
+> DataResponseContainer v2CoalExportsImportsQuantityPriceDataPost(dataParams)
+
+Return exports-imports-quantity-price Data
+
+Class ExportsImportsQuantityPriceController  Exports\\Imports Quantity\\Price data set top-level controller.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  COALApi,
+} from '';
+import type { V2CoalExportsImportsQuantityPriceDataPostRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: api_key
+    apiKey: "YOUR API KEY",
+  });
+  const api = new COALApi(config);
+
+  const body = {
+    // DataParams | Parameters for data call
+    dataParams: ...,
+  } satisfies V2CoalExportsImportsQuantityPriceDataPostRequest;
+
+  try {
+    const data = await api.v2CoalExportsImportsQuantityPriceDataPost(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **dataParams** | [DataParams](DataParams.md) | Parameters for data call | |
+
+### Return type
+
+[**DataResponseContainer**](DataResponseContainer.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **400** | Invalid input |  -  |
+| **200** | API Data |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## v2CoalExportsImportsQuantityPriceFacetFacetIdGet
+
+> FacetDetailsContainer v2CoalExportsImportsQuantityPriceFacetFacetIdGet(facetId)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  COALApi,
+} from '';
+import type { V2CoalExportsImportsQuantityPriceFacetFacetIdGetRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: api_key
+    apiKey: "YOUR API KEY",
+  });
+  const api = new COALApi(config);
+
+  const body = {
+    // string | Facet ID
+    facetId: facetId_example,
+  } satisfies V2CoalExportsImportsQuantityPriceFacetFacetIdGetRequest;
+
+  try {
+    const data = await api.v2CoalExportsImportsQuantityPriceFacetFacetIdGet(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **facetId** | `string` | Facet ID | [Defaults to `undefined`] |
+
+### Return type
+
+[**FacetDetailsContainer**](FacetDetailsContainer.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **400** | Invalid input |  -  |
+| **200** | Facet details |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## v2CoalExportsImportsQuantityPriceFacetGet
+
+> FacetOptionListContainer v2CoalExportsImportsQuantityPriceFacetGet()
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  COALApi,
+} from '';
+import type { V2CoalExportsImportsQuantityPriceFacetGetRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: api_key
+    apiKey: "YOUR API KEY",
+  });
+  const api = new COALApi(config);
+
+  try {
+    const data = await api.v2CoalExportsImportsQuantityPriceFacetGet();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**FacetOptionListContainer**](FacetOptionListContainer.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **400** | Invalid input |  -  |
+| **200** | List of facet options |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## v2CoalExportsImportsQuantityPriceGet
+
+> FinalRouteResponseContainer v2CoalExportsImportsQuantityPriceGet()
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  COALApi,
+} from '';
+import type { V2CoalExportsImportsQuantityPriceGetRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: api_key
+    apiKey: "YOUR API KEY",
+  });
+  const api = new COALApi(config);
+
+  try {
+    const data = await api.v2CoalExportsImportsQuantityPriceGet();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**FinalRouteResponseContainer**](FinalRouteResponseContainer.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | List of API data sets |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## v2CoalGet
+
+> RouteResponseContainer v2CoalGet()
+
+Class CoalController
+
+Coal data set top-level controller.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  COALApi,
+} from '';
+import type { V2CoalGetRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: api_key
+    apiKey: "YOUR API KEY",
+  });
+  const api = new COALApi(config);
+
+  try {
+    const data = await api.v2CoalGet();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**RouteResponseContainer**](RouteResponseContainer.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | List of API data sets |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## v2CoalMarketSalesPriceDataGet
+
+> DataResponseContainer v2CoalMarketSalesPriceDataGet(data, facets, frequency, start, end, sort, length, offset)
+
+
+
+API data with query params
+
+### Example
+
+```ts
+import {
+  Configuration,
+  COALApi,
+} from '';
+import type { V2CoalMarketSalesPriceDataGetRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: api_key
+    apiKey: "YOUR API KEY",
+  });
+  const api = new COALApi(config);
+
+  const body = {
+    // Array<string> | Data columns to filter by (optional)
+    data: ...,
+    // object | Facets to filter by (optional)
+    facets: Object,
+    // string | Frequency to filter by (optional)
+    frequency: frequency_example,
+    // string | Start date to filter by (optional)
+    start: start_example,
+    // string | End date to filter by (optional)
+    end: end_example,
+    // Sort | How to sort returned data (optional)
+    sort: ...,
+    // number | Max length of returned data (optional)
+    length: 56,
+    // number | Offset of returned data (optional)
+    offset: 56,
+  } satisfies V2CoalMarketSalesPriceDataGetRequest;
+
+  try {
+    const data = await api.v2CoalMarketSalesPriceDataGet(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **data** | `Array<string>` | Data columns to filter by | [Optional] |
+| **facets** | `object` | Facets to filter by | [Optional] [Defaults to `undefined`] |
+| **frequency** | `string` | Frequency to filter by | [Optional] [Defaults to `undefined`] |
+| **start** | `string` | Start date to filter by | [Optional] [Defaults to `undefined`] |
+| **end** | `string` | End date to filter by | [Optional] [Defaults to `undefined`] |
+| **sort** | [](.md) | How to sort returned data | [Optional] [Defaults to `undefined`] |
+| **length** | `number` | Max length of returned data | [Optional] [Defaults to `undefined`] |
+| **offset** | `number` | Offset of returned data | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**DataResponseContainer**](DataResponseContainer.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **400** | Invalid input |  -  |
+| **200** | API Data |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## v2CoalMarketSalesPriceDataPost
+
+> DataResponseContainer v2CoalMarketSalesPriceDataPost(dataParams)
+
+Return market-sales-price Data
+
+Class MarketSalesPriceController  Market Sales Price data set top-level controller.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  COALApi,
+} from '';
+import type { V2CoalMarketSalesPriceDataPostRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: api_key
+    apiKey: "YOUR API KEY",
+  });
+  const api = new COALApi(config);
+
+  const body = {
+    // DataParams | Parameters for data call
+    dataParams: ...,
+  } satisfies V2CoalMarketSalesPriceDataPostRequest;
+
+  try {
+    const data = await api.v2CoalMarketSalesPriceDataPost(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **dataParams** | [DataParams](DataParams.md) | Parameters for data call | |
+
+### Return type
+
+[**DataResponseContainer**](DataResponseContainer.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **400** | Invalid input |  -  |
+| **200** | API Data |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## v2CoalMarketSalesPriceFacetFacetIdGet
+
+> FacetDetailsContainer v2CoalMarketSalesPriceFacetFacetIdGet(facetId)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  COALApi,
+} from '';
+import type { V2CoalMarketSalesPriceFacetFacetIdGetRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: api_key
+    apiKey: "YOUR API KEY",
+  });
+  const api = new COALApi(config);
+
+  const body = {
+    // string | Facet ID
+    facetId: facetId_example,
+  } satisfies V2CoalMarketSalesPriceFacetFacetIdGetRequest;
+
+  try {
+    const data = await api.v2CoalMarketSalesPriceFacetFacetIdGet(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **facetId** | `string` | Facet ID | [Defaults to `undefined`] |
+
+### Return type
+
+[**FacetDetailsContainer**](FacetDetailsContainer.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **400** | Invalid input |  -  |
+| **200** | Facet details |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## v2CoalMarketSalesPriceFacetGet
+
+> FacetOptionListContainer v2CoalMarketSalesPriceFacetGet()
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  COALApi,
+} from '';
+import type { V2CoalMarketSalesPriceFacetGetRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: api_key
+    apiKey: "YOUR API KEY",
+  });
+  const api = new COALApi(config);
+
+  try {
+    const data = await api.v2CoalMarketSalesPriceFacetGet();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**FacetOptionListContainer**](FacetOptionListContainer.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **400** | Invalid input |  -  |
+| **200** | List of facet options |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## v2CoalMarketSalesPriceGet
+
+> FinalRouteResponseContainer v2CoalMarketSalesPriceGet()
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  COALApi,
+} from '';
+import type { V2CoalMarketSalesPriceGetRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: api_key
+    apiKey: "YOUR API KEY",
+  });
+  const api = new COALApi(config);
+
+  try {
+    const data = await api.v2CoalMarketSalesPriceGet();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**FinalRouteResponseContainer**](FinalRouteResponseContainer.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | List of API data sets |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## v2CoalMineProductionDataGet
+
+> DataResponseContainer v2CoalMineProductionDataGet(data, facets, frequency, start, end, sort, length, offset)
+
+
+
+API data with query params
+
+### Example
+
+```ts
+import {
+  Configuration,
+  COALApi,
+} from '';
+import type { V2CoalMineProductionDataGetRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: api_key
+    apiKey: "YOUR API KEY",
+  });
+  const api = new COALApi(config);
+
+  const body = {
+    // Array<string> | Data columns to filter by (optional)
+    data: ...,
+    // object | Facets to filter by (optional)
+    facets: Object,
+    // string | Frequency to filter by (optional)
+    frequency: frequency_example,
+    // string | Start date to filter by (optional)
+    start: start_example,
+    // string | End date to filter by (optional)
+    end: end_example,
+    // Sort | How to sort returned data (optional)
+    sort: ...,
+    // number | Max length of returned data (optional)
+    length: 56,
+    // number | Offset of returned data (optional)
+    offset: 56,
+  } satisfies V2CoalMineProductionDataGetRequest;
+
+  try {
+    const data = await api.v2CoalMineProductionDataGet(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **data** | `Array<string>` | Data columns to filter by | [Optional] |
+| **facets** | `object` | Facets to filter by | [Optional] [Defaults to `undefined`] |
+| **frequency** | `string` | Frequency to filter by | [Optional] [Defaults to `undefined`] |
+| **start** | `string` | Start date to filter by | [Optional] [Defaults to `undefined`] |
+| **end** | `string` | End date to filter by | [Optional] [Defaults to `undefined`] |
+| **sort** | [](.md) | How to sort returned data | [Optional] [Defaults to `undefined`] |
+| **length** | `number` | Max length of returned data | [Optional] [Defaults to `undefined`] |
+| **offset** | `number` | Offset of returned data | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**DataResponseContainer**](DataResponseContainer.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **400** | Invalid input |  -  |
+| **200** | API Data |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## v2CoalMineProductionDataPost
+
+> DataResponseContainer v2CoalMineProductionDataPost(dataParams)
+
+Return mine-production Data
+
+Class MinProductionController  Mine Production data set top-level controller.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  COALApi,
+} from '';
+import type { V2CoalMineProductionDataPostRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: api_key
+    apiKey: "YOUR API KEY",
+  });
+  const api = new COALApi(config);
+
+  const body = {
+    // DataParams | Parameters for data call
+    dataParams: ...,
+  } satisfies V2CoalMineProductionDataPostRequest;
+
+  try {
+    const data = await api.v2CoalMineProductionDataPost(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **dataParams** | [DataParams](DataParams.md) | Parameters for data call | |
+
+### Return type
+
+[**DataResponseContainer**](DataResponseContainer.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **400** | Invalid input |  -  |
+| **200** | API Data |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## v2CoalMineProductionFacetFacetIdGet
+
+> FacetDetailsContainer v2CoalMineProductionFacetFacetIdGet(facetId)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  COALApi,
+} from '';
+import type { V2CoalMineProductionFacetFacetIdGetRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: api_key
+    apiKey: "YOUR API KEY",
+  });
+  const api = new COALApi(config);
+
+  const body = {
+    // string | Facet ID
+    facetId: facetId_example,
+  } satisfies V2CoalMineProductionFacetFacetIdGetRequest;
+
+  try {
+    const data = await api.v2CoalMineProductionFacetFacetIdGet(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **facetId** | `string` | Facet ID | [Defaults to `undefined`] |
+
+### Return type
+
+[**FacetDetailsContainer**](FacetDetailsContainer.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **400** | Invalid input |  -  |
+| **200** | Facet details |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## v2CoalMineProductionFacetGet
+
+> FacetOptionListContainer v2CoalMineProductionFacetGet()
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  COALApi,
+} from '';
+import type { V2CoalMineProductionFacetGetRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: api_key
+    apiKey: "YOUR API KEY",
+  });
+  const api = new COALApi(config);
+
+  try {
+    const data = await api.v2CoalMineProductionFacetGet();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**FacetOptionListContainer**](FacetOptionListContainer.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **400** | Invalid input |  -  |
+| **200** | List of facet options |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## v2CoalMineProductionGet
+
+> FinalRouteResponseContainer v2CoalMineProductionGet()
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  COALApi,
+} from '';
+import type { V2CoalMineProductionGetRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: api_key
+    apiKey: "YOUR API KEY",
+  });
+  const api = new COALApi(config);
+
+  try {
+    const data = await api.v2CoalMineProductionGet();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**FinalRouteResponseContainer**](FinalRouteResponseContainer.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | List of API data sets |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## v2CoalPriceByRankDataGet
+
+> DataResponseContainer v2CoalPriceByRankDataGet(data, facets, frequency, start, end, sort, length, offset)
+
+
+
+API data with query params
+
+### Example
+
+```ts
+import {
+  Configuration,
+  COALApi,
+} from '';
+import type { V2CoalPriceByRankDataGetRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: api_key
+    apiKey: "YOUR API KEY",
+  });
+  const api = new COALApi(config);
+
+  const body = {
+    // Array<string> | Data columns to filter by (optional)
+    data: ...,
+    // object | Facets to filter by (optional)
+    facets: Object,
+    // string | Frequency to filter by (optional)
+    frequency: frequency_example,
+    // string | Start date to filter by (optional)
+    start: start_example,
+    // string | End date to filter by (optional)
+    end: end_example,
+    // Sort | How to sort returned data (optional)
+    sort: ...,
+    // number | Max length of returned data (optional)
+    length: 56,
+    // number | Offset of returned data (optional)
+    offset: 56,
+  } satisfies V2CoalPriceByRankDataGetRequest;
+
+  try {
+    const data = await api.v2CoalPriceByRankDataGet(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **data** | `Array<string>` | Data columns to filter by | [Optional] |
+| **facets** | `object` | Facets to filter by | [Optional] [Defaults to `undefined`] |
+| **frequency** | `string` | Frequency to filter by | [Optional] [Defaults to `undefined`] |
+| **start** | `string` | Start date to filter by | [Optional] [Defaults to `undefined`] |
+| **end** | `string` | End date to filter by | [Optional] [Defaults to `undefined`] |
+| **sort** | [](.md) | How to sort returned data | [Optional] [Defaults to `undefined`] |
+| **length** | `number` | Max length of returned data | [Optional] [Defaults to `undefined`] |
+| **offset** | `number` | Offset of returned data | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**DataResponseContainer**](DataResponseContainer.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **400** | Invalid input |  -  |
+| **200** | API Data |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## v2CoalPriceByRankDataPost
+
+> DataResponseContainer v2CoalPriceByRankDataPost(dataParams)
+
+Return price-by-rank Data
+
+Class PriceByRankController  Price By Rank data set top-level controller.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  COALApi,
+} from '';
+import type { V2CoalPriceByRankDataPostRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: api_key
+    apiKey: "YOUR API KEY",
+  });
+  const api = new COALApi(config);
+
+  const body = {
+    // DataParams | Parameters for data call
+    dataParams: ...,
+  } satisfies V2CoalPriceByRankDataPostRequest;
+
+  try {
+    const data = await api.v2CoalPriceByRankDataPost(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **dataParams** | [DataParams](DataParams.md) | Parameters for data call | |
+
+### Return type
+
+[**DataResponseContainer**](DataResponseContainer.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **400** | Invalid input |  -  |
+| **200** | API Data |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## v2CoalPriceByRankFacetFacetIdGet
+
+> FacetDetailsContainer v2CoalPriceByRankFacetFacetIdGet(facetId)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  COALApi,
+} from '';
+import type { V2CoalPriceByRankFacetFacetIdGetRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: api_key
+    apiKey: "YOUR API KEY",
+  });
+  const api = new COALApi(config);
+
+  const body = {
+    // string | Facet ID
+    facetId: facetId_example,
+  } satisfies V2CoalPriceByRankFacetFacetIdGetRequest;
+
+  try {
+    const data = await api.v2CoalPriceByRankFacetFacetIdGet(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **facetId** | `string` | Facet ID | [Defaults to `undefined`] |
+
+### Return type
+
+[**FacetDetailsContainer**](FacetDetailsContainer.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **400** | Invalid input |  -  |
+| **200** | Facet details |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## v2CoalPriceByRankFacetGet
+
+> FacetOptionListContainer v2CoalPriceByRankFacetGet()
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  COALApi,
+} from '';
+import type { V2CoalPriceByRankFacetGetRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: api_key
+    apiKey: "YOUR API KEY",
+  });
+  const api = new COALApi(config);
+
+  try {
+    const data = await api.v2CoalPriceByRankFacetGet();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**FacetOptionListContainer**](FacetOptionListContainer.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **400** | Invalid input |  -  |
+| **200** | List of facet options |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## v2CoalPriceByRankGet
+
+> FinalRouteResponseContainer v2CoalPriceByRankGet()
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  COALApi,
+} from '';
+import type { V2CoalPriceByRankGetRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: api_key
+    apiKey: "YOUR API KEY",
+  });
+  const api = new COALApi(config);
+
+  try {
+    const data = await api.v2CoalPriceByRankGet();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**FinalRouteResponseContainer**](FinalRouteResponseContainer.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | List of API data sets |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## v2CoalReservesCapacityDataGet
+
+> DataResponseContainer v2CoalReservesCapacityDataGet(data, facets, frequency, start, end, sort, length, offset)
+
+
+
+API data with query params
+
+### Example
+
+```ts
+import {
+  Configuration,
+  COALApi,
+} from '';
+import type { V2CoalReservesCapacityDataGetRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: api_key
+    apiKey: "YOUR API KEY",
+  });
+  const api = new COALApi(config);
+
+  const body = {
+    // Array<string> | Data columns to filter by (optional)
+    data: ...,
+    // object | Facets to filter by (optional)
+    facets: Object,
+    // string | Frequency to filter by (optional)
+    frequency: frequency_example,
+    // string | Start date to filter by (optional)
+    start: start_example,
+    // string | End date to filter by (optional)
+    end: end_example,
+    // Sort | How to sort returned data (optional)
+    sort: ...,
+    // number | Max length of returned data (optional)
+    length: 56,
+    // number | Offset of returned data (optional)
+    offset: 56,
+  } satisfies V2CoalReservesCapacityDataGetRequest;
+
+  try {
+    const data = await api.v2CoalReservesCapacityDataGet(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **data** | `Array<string>` | Data columns to filter by | [Optional] |
+| **facets** | `object` | Facets to filter by | [Optional] [Defaults to `undefined`] |
+| **frequency** | `string` | Frequency to filter by | [Optional] [Defaults to `undefined`] |
+| **start** | `string` | Start date to filter by | [Optional] [Defaults to `undefined`] |
+| **end** | `string` | End date to filter by | [Optional] [Defaults to `undefined`] |
+| **sort** | [](.md) | How to sort returned data | [Optional] [Defaults to `undefined`] |
+| **length** | `number` | Max length of returned data | [Optional] [Defaults to `undefined`] |
+| **offset** | `number` | Offset of returned data | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**DataResponseContainer**](DataResponseContainer.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **400** | Invalid input |  -  |
+| **200** | API Data |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## v2CoalReservesCapacityDataPost
+
+> DataResponseContainer v2CoalReservesCapacityDataPost(dataParams)
+
+Return reserves-capacity data
+
+Class ReservesCapacityController  Reserves Capacity data set top-level controller.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  COALApi,
+} from '';
+import type { V2CoalReservesCapacityDataPostRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: api_key
+    apiKey: "YOUR API KEY",
+  });
+  const api = new COALApi(config);
+
+  const body = {
+    // DataParams | Parameters for data call
+    dataParams: ...,
+  } satisfies V2CoalReservesCapacityDataPostRequest;
+
+  try {
+    const data = await api.v2CoalReservesCapacityDataPost(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **dataParams** | [DataParams](DataParams.md) | Parameters for data call | |
+
+### Return type
+
+[**DataResponseContainer**](DataResponseContainer.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **400** | Invalid input |  -  |
+| **200** | API Data |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## v2CoalReservesCapacityFacetFacetIdGet
+
+> FacetDetailsContainer v2CoalReservesCapacityFacetFacetIdGet(facetId)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  COALApi,
+} from '';
+import type { V2CoalReservesCapacityFacetFacetIdGetRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: api_key
+    apiKey: "YOUR API KEY",
+  });
+  const api = new COALApi(config);
+
+  const body = {
+    // string | Facet ID
+    facetId: facetId_example,
+  } satisfies V2CoalReservesCapacityFacetFacetIdGetRequest;
+
+  try {
+    const data = await api.v2CoalReservesCapacityFacetFacetIdGet(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **facetId** | `string` | Facet ID | [Defaults to `undefined`] |
+
+### Return type
+
+[**FacetDetailsContainer**](FacetDetailsContainer.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **400** | Invalid input |  -  |
+| **200** | Facet details |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## v2CoalReservesCapacityFacetGet
+
+> FacetOptionListContainer v2CoalReservesCapacityFacetGet()
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  COALApi,
+} from '';
+import type { V2CoalReservesCapacityFacetGetRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: api_key
+    apiKey: "YOUR API KEY",
+  });
+  const api = new COALApi(config);
+
+  try {
+    const data = await api.v2CoalReservesCapacityFacetGet();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**FacetOptionListContainer**](FacetOptionListContainer.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **400** | Invalid input |  -  |
+| **200** | List of facet options |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## v2CoalReservesCapacityGet
+
+> FinalRouteResponseContainer v2CoalReservesCapacityGet()
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  COALApi,
+} from '';
+import type { V2CoalReservesCapacityGetRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: api_key
+    apiKey: "YOUR API KEY",
+  });
+  const api = new COALApi(config);
+
+  try {
+    const data = await api.v2CoalReservesCapacityGet();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**FinalRouteResponseContainer**](FinalRouteResponseContainer.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | List of API data sets |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## v2CoalShipmentsByMineByPlantDataGet
+
+> DataResponseContainer v2CoalShipmentsByMineByPlantDataGet(data, facets, frequency, start, end, sort, length, offset)
+
+
+
+API data with query params
+
+### Example
+
+```ts
+import {
+  Configuration,
+  COALApi,
+} from '';
+import type { V2CoalShipmentsByMineByPlantDataGetRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: api_key
+    apiKey: "YOUR API KEY",
+  });
+  const api = new COALApi(config);
+
+  const body = {
+    // Array<string> | Data columns to filter by (optional)
+    data: ...,
+    // object | Facets to filter by (optional)
+    facets: Object,
+    // string | Frequency to filter by (optional)
+    frequency: frequency_example,
+    // string | Start date to filter by (optional)
+    start: start_example,
+    // string | End date to filter by (optional)
+    end: end_example,
+    // Sort | How to sort returned data (optional)
+    sort: ...,
+    // number | Max length of returned data (optional)
+    length: 56,
+    // number | Offset of returned data (optional)
+    offset: 56,
+  } satisfies V2CoalShipmentsByMineByPlantDataGetRequest;
+
+  try {
+    const data = await api.v2CoalShipmentsByMineByPlantDataGet(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **data** | `Array<string>` | Data columns to filter by | [Optional] |
+| **facets** | `object` | Facets to filter by | [Optional] [Defaults to `undefined`] |
+| **frequency** | `string` | Frequency to filter by | [Optional] [Defaults to `undefined`] |
+| **start** | `string` | Start date to filter by | [Optional] [Defaults to `undefined`] |
+| **end** | `string` | End date to filter by | [Optional] [Defaults to `undefined`] |
+| **sort** | [](.md) | How to sort returned data | [Optional] [Defaults to `undefined`] |
+| **length** | `number` | Max length of returned data | [Optional] [Defaults to `undefined`] |
+| **offset** | `number` | Offset of returned data | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**DataResponseContainer**](DataResponseContainer.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **400** | Invalid input |  -  |
+| **200** | API Data |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## v2CoalShipmentsByMineByPlantDataPost
+
+> DataResponseContainer v2CoalShipmentsByMineByPlantDataPost(dataParams)
+
+Return shipments by-mine-by-plant data
+
+### Example
+
+```ts
+import {
+  Configuration,
+  COALApi,
+} from '';
+import type { V2CoalShipmentsByMineByPlantDataPostRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: api_key
+    apiKey: "YOUR API KEY",
+  });
+  const api = new COALApi(config);
+
+  const body = {
+    // DataParams | Parameters for data call
+    dataParams: ...,
+  } satisfies V2CoalShipmentsByMineByPlantDataPostRequest;
+
+  try {
+    const data = await api.v2CoalShipmentsByMineByPlantDataPost(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **dataParams** | [DataParams](DataParams.md) | Parameters for data call | |
+
+### Return type
+
+[**DataResponseContainer**](DataResponseContainer.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **400** | Invalid input |  -  |
+| **200** | API Data |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## v2CoalShipmentsByMineByPlantFacetFacetIdGet
+
+> FacetDetailsContainer v2CoalShipmentsByMineByPlantFacetFacetIdGet(facetId)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  COALApi,
+} from '';
+import type { V2CoalShipmentsByMineByPlantFacetFacetIdGetRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: api_key
+    apiKey: "YOUR API KEY",
+  });
+  const api = new COALApi(config);
+
+  const body = {
+    // string | Facet ID
+    facetId: facetId_example,
+  } satisfies V2CoalShipmentsByMineByPlantFacetFacetIdGetRequest;
+
+  try {
+    const data = await api.v2CoalShipmentsByMineByPlantFacetFacetIdGet(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **facetId** | `string` | Facet ID | [Defaults to `undefined`] |
+
+### Return type
+
+[**FacetDetailsContainer**](FacetDetailsContainer.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **400** | Invalid input |  -  |
+| **200** | Facet details |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## v2CoalShipmentsByMineByPlantFacetGet
+
+> FacetOptionListContainer v2CoalShipmentsByMineByPlantFacetGet()
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  COALApi,
+} from '';
+import type { V2CoalShipmentsByMineByPlantFacetGetRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: api_key
+    apiKey: "YOUR API KEY",
+  });
+  const api = new COALApi(config);
+
+  try {
+    const data = await api.v2CoalShipmentsByMineByPlantFacetGet();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**FacetOptionListContainer**](FacetOptionListContainer.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **400** | Invalid input |  -  |
+| **200** | List of facet options |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## v2CoalShipmentsByMineByPlantGet
+
+> FinalRouteResponseContainer v2CoalShipmentsByMineByPlantGet()
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  COALApi,
+} from '';
+import type { V2CoalShipmentsByMineByPlantGetRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: api_key
+    apiKey: "YOUR API KEY",
+  });
+  const api = new COALApi(config);
+
+  try {
+    const data = await api.v2CoalShipmentsByMineByPlantGet();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**FinalRouteResponseContainer**](FinalRouteResponseContainer.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | List of API data sets |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## v2CoalShipmentsGet
+
+> RouteResponseContainer v2CoalShipmentsGet()
+
+Class CoalController
+
+Coal data set top-level controller.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  COALApi,
+} from '';
+import type { V2CoalShipmentsGetRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: api_key
+    apiKey: "YOUR API KEY",
+  });
+  const api = new COALApi(config);
+
+  try {
+    const data = await api.v2CoalShipmentsGet();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**RouteResponseContainer**](RouteResponseContainer.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | List of API data sets |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## v2CoalShipmentsMineAggregatesDataGet
+
+> DataResponseContainer v2CoalShipmentsMineAggregatesDataGet(data, facets, frequency, start, end, sort, length, offset)
+
+
+
+API data with query params
+
+### Example
+
+```ts
+import {
+  Configuration,
+  COALApi,
+} from '';
+import type { V2CoalShipmentsMineAggregatesDataGetRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: api_key
+    apiKey: "YOUR API KEY",
+  });
+  const api = new COALApi(config);
+
+  const body = {
+    // Array<string> | Data columns to filter by (optional)
+    data: ...,
+    // object | Facets to filter by (optional)
+    facets: Object,
+    // string | Frequency to filter by (optional)
+    frequency: frequency_example,
+    // string | Start date to filter by (optional)
+    start: start_example,
+    // string | End date to filter by (optional)
+    end: end_example,
+    // Sort | How to sort returned data (optional)
+    sort: ...,
+    // number | Max length of returned data (optional)
+    length: 56,
+    // number | Offset of returned data (optional)
+    offset: 56,
+  } satisfies V2CoalShipmentsMineAggregatesDataGetRequest;
+
+  try {
+    const data = await api.v2CoalShipmentsMineAggregatesDataGet(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **data** | `Array<string>` | Data columns to filter by | [Optional] |
+| **facets** | `object` | Facets to filter by | [Optional] [Defaults to `undefined`] |
+| **frequency** | `string` | Frequency to filter by | [Optional] [Defaults to `undefined`] |
+| **start** | `string` | Start date to filter by | [Optional] [Defaults to `undefined`] |
+| **end** | `string` | End date to filter by | [Optional] [Defaults to `undefined`] |
+| **sort** | [](.md) | How to sort returned data | [Optional] [Defaults to `undefined`] |
+| **length** | `number` | Max length of returned data | [Optional] [Defaults to `undefined`] |
+| **offset** | `number` | Offset of returned data | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**DataResponseContainer**](DataResponseContainer.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **400** | Invalid input |  -  |
+| **200** | API Data |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## v2CoalShipmentsMineAggregatesDataPost
+
+> DataResponseContainer v2CoalShipmentsMineAggregatesDataPost(dataParams)
+
+Return shipments mine-aggregates data
+
+### Example
+
+```ts
+import {
+  Configuration,
+  COALApi,
+} from '';
+import type { V2CoalShipmentsMineAggregatesDataPostRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: api_key
+    apiKey: "YOUR API KEY",
+  });
+  const api = new COALApi(config);
+
+  const body = {
+    // DataParams | Parameters for data call
+    dataParams: ...,
+  } satisfies V2CoalShipmentsMineAggregatesDataPostRequest;
+
+  try {
+    const data = await api.v2CoalShipmentsMineAggregatesDataPost(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **dataParams** | [DataParams](DataParams.md) | Parameters for data call | |
+
+### Return type
+
+[**DataResponseContainer**](DataResponseContainer.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **400** | Invalid input |  -  |
+| **200** | API Data |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## v2CoalShipmentsMineAggregatesFacetFacetIdGet
+
+> FacetDetailsContainer v2CoalShipmentsMineAggregatesFacetFacetIdGet(facetId)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  COALApi,
+} from '';
+import type { V2CoalShipmentsMineAggregatesFacetFacetIdGetRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: api_key
+    apiKey: "YOUR API KEY",
+  });
+  const api = new COALApi(config);
+
+  const body = {
+    // string | Facet ID
+    facetId: facetId_example,
+  } satisfies V2CoalShipmentsMineAggregatesFacetFacetIdGetRequest;
+
+  try {
+    const data = await api.v2CoalShipmentsMineAggregatesFacetFacetIdGet(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **facetId** | `string` | Facet ID | [Defaults to `undefined`] |
+
+### Return type
+
+[**FacetDetailsContainer**](FacetDetailsContainer.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **400** | Invalid input |  -  |
+| **200** | Facet details |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## v2CoalShipmentsMineAggregatesFacetGet
+
+> FacetOptionListContainer v2CoalShipmentsMineAggregatesFacetGet()
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  COALApi,
+} from '';
+import type { V2CoalShipmentsMineAggregatesFacetGetRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: api_key
+    apiKey: "YOUR API KEY",
+  });
+  const api = new COALApi(config);
+
+  try {
+    const data = await api.v2CoalShipmentsMineAggregatesFacetGet();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**FacetOptionListContainer**](FacetOptionListContainer.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **400** | Invalid input |  -  |
+| **200** | List of facet options |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## v2CoalShipmentsMineAggregatesGet
+
+> FinalRouteResponseContainer v2CoalShipmentsMineAggregatesGet()
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  COALApi,
+} from '';
+import type { V2CoalShipmentsMineAggregatesGetRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: api_key
+    apiKey: "YOUR API KEY",
+  });
+  const api = new COALApi(config);
+
+  try {
+    const data = await api.v2CoalShipmentsMineAggregatesGet();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**FinalRouteResponseContainer**](FinalRouteResponseContainer.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | List of API data sets |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## v2CoalShipmentsMineStateAggregatesDataGet
+
+> DataResponseContainer v2CoalShipmentsMineStateAggregatesDataGet(data, facets, frequency, start, end, sort, length, offset)
+
+
+
+API data with query params
+
+### Example
+
+```ts
+import {
+  Configuration,
+  COALApi,
+} from '';
+import type { V2CoalShipmentsMineStateAggregatesDataGetRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: api_key
+    apiKey: "YOUR API KEY",
+  });
+  const api = new COALApi(config);
+
+  const body = {
+    // Array<string> | Data columns to filter by (optional)
+    data: ...,
+    // object | Facets to filter by (optional)
+    facets: Object,
+    // string | Frequency to filter by (optional)
+    frequency: frequency_example,
+    // string | Start date to filter by (optional)
+    start: start_example,
+    // string | End date to filter by (optional)
+    end: end_example,
+    // Sort | How to sort returned data (optional)
+    sort: ...,
+    // number | Max length of returned data (optional)
+    length: 56,
+    // number | Offset of returned data (optional)
+    offset: 56,
+  } satisfies V2CoalShipmentsMineStateAggregatesDataGetRequest;
+
+  try {
+    const data = await api.v2CoalShipmentsMineStateAggregatesDataGet(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **data** | `Array<string>` | Data columns to filter by | [Optional] |
+| **facets** | `object` | Facets to filter by | [Optional] [Defaults to `undefined`] |
+| **frequency** | `string` | Frequency to filter by | [Optional] [Defaults to `undefined`] |
+| **start** | `string` | Start date to filter by | [Optional] [Defaults to `undefined`] |
+| **end** | `string` | End date to filter by | [Optional] [Defaults to `undefined`] |
+| **sort** | [](.md) | How to sort returned data | [Optional] [Defaults to `undefined`] |
+| **length** | `number` | Max length of returned data | [Optional] [Defaults to `undefined`] |
+| **offset** | `number` | Offset of returned data | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**DataResponseContainer**](DataResponseContainer.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **400** | Invalid input |  -  |
+| **200** | API Data |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## v2CoalShipmentsMineStateAggregatesDataPost
+
+> DataResponseContainer v2CoalShipmentsMineStateAggregatesDataPost(dataParams)
+
+Return shipments mine-state-aggregates data
+
+### Example
+
+```ts
+import {
+  Configuration,
+  COALApi,
+} from '';
+import type { V2CoalShipmentsMineStateAggregatesDataPostRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: api_key
+    apiKey: "YOUR API KEY",
+  });
+  const api = new COALApi(config);
+
+  const body = {
+    // DataParams | Parameters for data call
+    dataParams: ...,
+  } satisfies V2CoalShipmentsMineStateAggregatesDataPostRequest;
+
+  try {
+    const data = await api.v2CoalShipmentsMineStateAggregatesDataPost(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **dataParams** | [DataParams](DataParams.md) | Parameters for data call | |
+
+### Return type
+
+[**DataResponseContainer**](DataResponseContainer.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **400** | Invalid input |  -  |
+| **200** | API Data |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## v2CoalShipmentsMineStateAggregatesFacetFacetIdGet
+
+> FacetDetailsContainer v2CoalShipmentsMineStateAggregatesFacetFacetIdGet(facetId)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  COALApi,
+} from '';
+import type { V2CoalShipmentsMineStateAggregatesFacetFacetIdGetRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: api_key
+    apiKey: "YOUR API KEY",
+  });
+  const api = new COALApi(config);
+
+  const body = {
+    // string | Facet ID
+    facetId: facetId_example,
+  } satisfies V2CoalShipmentsMineStateAggregatesFacetFacetIdGetRequest;
+
+  try {
+    const data = await api.v2CoalShipmentsMineStateAggregatesFacetFacetIdGet(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **facetId** | `string` | Facet ID | [Defaults to `undefined`] |
+
+### Return type
+
+[**FacetDetailsContainer**](FacetDetailsContainer.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **400** | Invalid input |  -  |
+| **200** | Facet details |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## v2CoalShipmentsMineStateAggregatesFacetGet
+
+> FacetOptionListContainer v2CoalShipmentsMineStateAggregatesFacetGet()
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  COALApi,
+} from '';
+import type { V2CoalShipmentsMineStateAggregatesFacetGetRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: api_key
+    apiKey: "YOUR API KEY",
+  });
+  const api = new COALApi(config);
+
+  try {
+    const data = await api.v2CoalShipmentsMineStateAggregatesFacetGet();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**FacetOptionListContainer**](FacetOptionListContainer.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **400** | Invalid input |  -  |
+| **200** | List of facet options |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## v2CoalShipmentsMineStateAggregatesGet
+
+> FinalRouteResponseContainer v2CoalShipmentsMineStateAggregatesGet()
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  COALApi,
+} from '';
+import type { V2CoalShipmentsMineStateAggregatesGetRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: api_key
+    apiKey: "YOUR API KEY",
+  });
+  const api = new COALApi(config);
+
+  try {
+    const data = await api.v2CoalShipmentsMineStateAggregatesGet();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**FinalRouteResponseContainer**](FinalRouteResponseContainer.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | List of API data sets |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## v2CoalShipmentsPlantAggregatesDataGet
+
+> DataResponseContainer v2CoalShipmentsPlantAggregatesDataGet(data, facets, frequency, start, end, sort, length, offset)
+
+
+
+API data with query params
+
+### Example
+
+```ts
+import {
+  Configuration,
+  COALApi,
+} from '';
+import type { V2CoalShipmentsPlantAggregatesDataGetRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: api_key
+    apiKey: "YOUR API KEY",
+  });
+  const api = new COALApi(config);
+
+  const body = {
+    // Array<string> | Data columns to filter by (optional)
+    data: ...,
+    // object | Facets to filter by (optional)
+    facets: Object,
+    // string | Frequency to filter by (optional)
+    frequency: frequency_example,
+    // string | Start date to filter by (optional)
+    start: start_example,
+    // string | End date to filter by (optional)
+    end: end_example,
+    // Sort | How to sort returned data (optional)
+    sort: ...,
+    // number | Max length of returned data (optional)
+    length: 56,
+    // number | Offset of returned data (optional)
+    offset: 56,
+  } satisfies V2CoalShipmentsPlantAggregatesDataGetRequest;
+
+  try {
+    const data = await api.v2CoalShipmentsPlantAggregatesDataGet(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **data** | `Array<string>` | Data columns to filter by | [Optional] |
+| **facets** | `object` | Facets to filter by | [Optional] [Defaults to `undefined`] |
+| **frequency** | `string` | Frequency to filter by | [Optional] [Defaults to `undefined`] |
+| **start** | `string` | Start date to filter by | [Optional] [Defaults to `undefined`] |
+| **end** | `string` | End date to filter by | [Optional] [Defaults to `undefined`] |
+| **sort** | [](.md) | How to sort returned data | [Optional] [Defaults to `undefined`] |
+| **length** | `number` | Max length of returned data | [Optional] [Defaults to `undefined`] |
+| **offset** | `number` | Offset of returned data | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**DataResponseContainer**](DataResponseContainer.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **400** | Invalid input |  -  |
+| **200** | API Data |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## v2CoalShipmentsPlantAggregatesDataPost
+
+> DataResponseContainer v2CoalShipmentsPlantAggregatesDataPost(dataParams)
+
+Return shipments plant-aggregates data
+
+Class PlantAggregateController  Coal\\Shipments dataset controller.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  COALApi,
+} from '';
+import type { V2CoalShipmentsPlantAggregatesDataPostRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: api_key
+    apiKey: "YOUR API KEY",
+  });
+  const api = new COALApi(config);
+
+  const body = {
+    // DataParams | Parameters for data call
+    dataParams: ...,
+  } satisfies V2CoalShipmentsPlantAggregatesDataPostRequest;
+
+  try {
+    const data = await api.v2CoalShipmentsPlantAggregatesDataPost(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **dataParams** | [DataParams](DataParams.md) | Parameters for data call | |
+
+### Return type
+
+[**DataResponseContainer**](DataResponseContainer.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **400** | Invalid input |  -  |
+| **200** | API Data |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## v2CoalShipmentsPlantAggregatesFacetFacetIdGet
+
+> FacetDetailsContainer v2CoalShipmentsPlantAggregatesFacetFacetIdGet(facetId)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  COALApi,
+} from '';
+import type { V2CoalShipmentsPlantAggregatesFacetFacetIdGetRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: api_key
+    apiKey: "YOUR API KEY",
+  });
+  const api = new COALApi(config);
+
+  const body = {
+    // string | Facet ID
+    facetId: facetId_example,
+  } satisfies V2CoalShipmentsPlantAggregatesFacetFacetIdGetRequest;
+
+  try {
+    const data = await api.v2CoalShipmentsPlantAggregatesFacetFacetIdGet(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **facetId** | `string` | Facet ID | [Defaults to `undefined`] |
+
+### Return type
+
+[**FacetDetailsContainer**](FacetDetailsContainer.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **400** | Invalid input |  -  |
+| **200** | Facet details |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## v2CoalShipmentsPlantAggregatesFacetGet
+
+> FacetOptionListContainer v2CoalShipmentsPlantAggregatesFacetGet()
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  COALApi,
+} from '';
+import type { V2CoalShipmentsPlantAggregatesFacetGetRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: api_key
+    apiKey: "YOUR API KEY",
+  });
+  const api = new COALApi(config);
+
+  try {
+    const data = await api.v2CoalShipmentsPlantAggregatesFacetGet();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**FacetOptionListContainer**](FacetOptionListContainer.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **400** | Invalid input |  -  |
+| **200** | List of facet options |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## v2CoalShipmentsPlantAggregatesGet
+
+> FinalRouteResponseContainer v2CoalShipmentsPlantAggregatesGet()
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  COALApi,
+} from '';
+import type { V2CoalShipmentsPlantAggregatesGetRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: api_key
+    apiKey: "YOUR API KEY",
+  });
+  const api = new COALApi(config);
+
+  try {
+    const data = await api.v2CoalShipmentsPlantAggregatesGet();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**FinalRouteResponseContainer**](FinalRouteResponseContainer.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | List of API data sets |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## v2CoalShipmentsPlantStateAggregatesDataGet
+
+> DataResponseContainer v2CoalShipmentsPlantStateAggregatesDataGet(data, facets, frequency, start, end, sort, length, offset)
+
+
+
+API data with query params
+
+### Example
+
+```ts
+import {
+  Configuration,
+  COALApi,
+} from '';
+import type { V2CoalShipmentsPlantStateAggregatesDataGetRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: api_key
+    apiKey: "YOUR API KEY",
+  });
+  const api = new COALApi(config);
+
+  const body = {
+    // Array<string> | Data columns to filter by (optional)
+    data: ...,
+    // object | Facets to filter by (optional)
+    facets: Object,
+    // string | Frequency to filter by (optional)
+    frequency: frequency_example,
+    // string | Start date to filter by (optional)
+    start: start_example,
+    // string | End date to filter by (optional)
+    end: end_example,
+    // Sort | How to sort returned data (optional)
+    sort: ...,
+    // number | Max length of returned data (optional)
+    length: 56,
+    // number | Offset of returned data (optional)
+    offset: 56,
+  } satisfies V2CoalShipmentsPlantStateAggregatesDataGetRequest;
+
+  try {
+    const data = await api.v2CoalShipmentsPlantStateAggregatesDataGet(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **data** | `Array<string>` | Data columns to filter by | [Optional] |
+| **facets** | `object` | Facets to filter by | [Optional] [Defaults to `undefined`] |
+| **frequency** | `string` | Frequency to filter by | [Optional] [Defaults to `undefined`] |
+| **start** | `string` | Start date to filter by | [Optional] [Defaults to `undefined`] |
+| **end** | `string` | End date to filter by | [Optional] [Defaults to `undefined`] |
+| **sort** | [](.md) | How to sort returned data | [Optional] [Defaults to `undefined`] |
+| **length** | `number` | Max length of returned data | [Optional] [Defaults to `undefined`] |
+| **offset** | `number` | Offset of returned data | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**DataResponseContainer**](DataResponseContainer.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **400** | Invalid input |  -  |
+| **200** | API Data |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## v2CoalShipmentsPlantStateAggregatesDataPost
+
+> DataResponseContainer v2CoalShipmentsPlantStateAggregatesDataPost(dataParams)
+
+Return shipments plant-state-aggregates data
+
+Class PlantStateAggregateController  Coal\\Shipments dataset controller.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  COALApi,
+} from '';
+import type { V2CoalShipmentsPlantStateAggregatesDataPostRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: api_key
+    apiKey: "YOUR API KEY",
+  });
+  const api = new COALApi(config);
+
+  const body = {
+    // DataParams | Parameters for data call
+    dataParams: ...,
+  } satisfies V2CoalShipmentsPlantStateAggregatesDataPostRequest;
+
+  try {
+    const data = await api.v2CoalShipmentsPlantStateAggregatesDataPost(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **dataParams** | [DataParams](DataParams.md) | Parameters for data call | |
+
+### Return type
+
+[**DataResponseContainer**](DataResponseContainer.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **400** | Invalid input |  -  |
+| **200** | API Data |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## v2CoalShipmentsPlantStateAggregatesFacetFacetIdGet
+
+> FacetDetailsContainer v2CoalShipmentsPlantStateAggregatesFacetFacetIdGet(facetId)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  COALApi,
+} from '';
+import type { V2CoalShipmentsPlantStateAggregatesFacetFacetIdGetRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: api_key
+    apiKey: "YOUR API KEY",
+  });
+  const api = new COALApi(config);
+
+  const body = {
+    // string | Facet ID
+    facetId: facetId_example,
+  } satisfies V2CoalShipmentsPlantStateAggregatesFacetFacetIdGetRequest;
+
+  try {
+    const data = await api.v2CoalShipmentsPlantStateAggregatesFacetFacetIdGet(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **facetId** | `string` | Facet ID | [Defaults to `undefined`] |
+
+### Return type
+
+[**FacetDetailsContainer**](FacetDetailsContainer.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **400** | Invalid input |  -  |
+| **200** | Facet details |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## v2CoalShipmentsPlantStateAggregatesFacetGet
+
+> FacetOptionListContainer v2CoalShipmentsPlantStateAggregatesFacetGet()
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  COALApi,
+} from '';
+import type { V2CoalShipmentsPlantStateAggregatesFacetGetRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: api_key
+    apiKey: "YOUR API KEY",
+  });
+  const api = new COALApi(config);
+
+  try {
+    const data = await api.v2CoalShipmentsPlantStateAggregatesFacetGet();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**FacetOptionListContainer**](FacetOptionListContainer.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **400** | Invalid input |  -  |
+| **200** | List of facet options |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## v2CoalShipmentsPlantStateAggregatesGet
+
+> FinalRouteResponseContainer v2CoalShipmentsPlantStateAggregatesGet()
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  COALApi,
+} from '';
+import type { V2CoalShipmentsPlantStateAggregatesGetRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: api_key
+    apiKey: "YOUR API KEY",
+  });
+  const api = new COALApi(config);
+
+  try {
+    const data = await api.v2CoalShipmentsPlantStateAggregatesGet();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**FinalRouteResponseContainer**](FinalRouteResponseContainer.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | List of API data sets |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## v2CoalShipmentsReceiptsDataGet
+
+> DataResponseContainer v2CoalShipmentsReceiptsDataGet(data, facets, frequency, start, end, sort, length, offset)
+
+
+
+API data with query params
+
+### Example
+
+```ts
+import {
+  Configuration,
+  COALApi,
+} from '';
+import type { V2CoalShipmentsReceiptsDataGetRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: api_key
+    apiKey: "YOUR API KEY",
+  });
+  const api = new COALApi(config);
+
+  const body = {
+    // Array<string> | Data columns to filter by (optional)
+    data: ...,
+    // object | Facets to filter by (optional)
+    facets: Object,
+    // string | Frequency to filter by (optional)
+    frequency: frequency_example,
+    // string | Start date to filter by (optional)
+    start: start_example,
+    // string | End date to filter by (optional)
+    end: end_example,
+    // Sort | How to sort returned data (optional)
+    sort: ...,
+    // number | Max length of returned data (optional)
+    length: 56,
+    // number | Offset of returned data (optional)
+    offset: 56,
+  } satisfies V2CoalShipmentsReceiptsDataGetRequest;
+
+  try {
+    const data = await api.v2CoalShipmentsReceiptsDataGet(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **data** | `Array<string>` | Data columns to filter by | [Optional] |
+| **facets** | `object` | Facets to filter by | [Optional] [Defaults to `undefined`] |
+| **frequency** | `string` | Frequency to filter by | [Optional] [Defaults to `undefined`] |
+| **start** | `string` | Start date to filter by | [Optional] [Defaults to `undefined`] |
+| **end** | `string` | End date to filter by | [Optional] [Defaults to `undefined`] |
+| **sort** | [](.md) | How to sort returned data | [Optional] [Defaults to `undefined`] |
+| **length** | `number` | Max length of returned data | [Optional] [Defaults to `undefined`] |
+| **offset** | `number` | Offset of returned data | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**DataResponseContainer**](DataResponseContainer.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **400** | Invalid input |  -  |
+| **200** | API Data |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## v2CoalShipmentsReceiptsDataPost
+
+> DataResponseContainer v2CoalShipmentsReceiptsDataPost(dataParams)
+
+Return shipments receipts data
+
+Class ReceiptsController  Coal\\Shipments dataset controller.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  COALApi,
+} from '';
+import type { V2CoalShipmentsReceiptsDataPostRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: api_key
+    apiKey: "YOUR API KEY",
+  });
+  const api = new COALApi(config);
+
+  const body = {
+    // DataParams | Parameters for data call
+    dataParams: ...,
+  } satisfies V2CoalShipmentsReceiptsDataPostRequest;
+
+  try {
+    const data = await api.v2CoalShipmentsReceiptsDataPost(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **dataParams** | [DataParams](DataParams.md) | Parameters for data call | |
+
+### Return type
+
+[**DataResponseContainer**](DataResponseContainer.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **400** | Invalid input |  -  |
+| **200** | API Data |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## v2CoalShipmentsReceiptsFacetFacetIdGet
+
+> FacetDetailsContainer v2CoalShipmentsReceiptsFacetFacetIdGet(facetId)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  COALApi,
+} from '';
+import type { V2CoalShipmentsReceiptsFacetFacetIdGetRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: api_key
+    apiKey: "YOUR API KEY",
+  });
+  const api = new COALApi(config);
+
+  const body = {
+    // string | Facet ID
+    facetId: facetId_example,
+  } satisfies V2CoalShipmentsReceiptsFacetFacetIdGetRequest;
+
+  try {
+    const data = await api.v2CoalShipmentsReceiptsFacetFacetIdGet(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **facetId** | `string` | Facet ID | [Defaults to `undefined`] |
+
+### Return type
+
+[**FacetDetailsContainer**](FacetDetailsContainer.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **400** | Invalid input |  -  |
+| **200** | Facet details |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## v2CoalShipmentsReceiptsFacetGet
+
+> FacetOptionListContainer v2CoalShipmentsReceiptsFacetGet()
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  COALApi,
+} from '';
+import type { V2CoalShipmentsReceiptsFacetGetRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: api_key
+    apiKey: "YOUR API KEY",
+  });
+  const api = new COALApi(config);
+
+  try {
+    const data = await api.v2CoalShipmentsReceiptsFacetGet();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**FacetOptionListContainer**](FacetOptionListContainer.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **400** | Invalid input |  -  |
+| **200** | List of facet options |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## v2CoalShipmentsReceiptsGet
+
+> FinalRouteResponseContainer v2CoalShipmentsReceiptsGet()
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  COALApi,
+} from '';
+import type { V2CoalShipmentsReceiptsGetRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: api_key
+    apiKey: "YOUR API KEY",
+  });
+  const api = new COALApi(config);
+
+  try {
+    const data = await api.v2CoalShipmentsReceiptsGet();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**FinalRouteResponseContainer**](FinalRouteResponseContainer.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | List of API data sets |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+