eiagov-typescript-fetch-client 1.0.0

package/docs/ELECApi.md

@@ -0,0 +1,1524 @@
+# ELECApi
+
+All URIs are relative to *https://api.eia.gov*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**v2ElectricityElectricPowerOperationalDataDataGet**](ELECApi.md#v2electricityelectricpoweroperationaldatadataget) | **GET** /v2/electricity/electric-power-operational-data/data |  |
+| [**v2ElectricityElectricPowerOperationalDataDataPost**](ELECApi.md#v2electricityelectricpoweroperationaldatadatapost) | **POST** /v2/electricity/electric-power-operational-data/data | Return Electricity electric-power-operational Data |
+| [**v2ElectricityElectricPowerOperationalDataFacetFacetIdGet**](ELECApi.md#v2electricityelectricpoweroperationaldatafacetfacetidget) | **GET** /v2/electricity/electric-power-operational-data/facet/{facet_id} |  |
+| [**v2ElectricityElectricPowerOperationalDataFacetGet**](ELECApi.md#v2electricityelectricpoweroperationaldatafacetget) | **GET** /v2/electricity/electric-power-operational-data/facet |  |
+| [**v2ElectricityElectricPowerOperationalDataGet**](ELECApi.md#v2electricityelectricpoweroperationaldataget) | **GET** /v2/electricity/electric-power-operational-data |  |
+| [**v2ElectricityFacilityFuelDataGet**](ELECApi.md#v2electricityfacilityfueldataget) | **GET** /v2/electricity/facility-fuel/data |  |
+| [**v2ElectricityFacilityFuelDataPost**](ELECApi.md#v2electricityfacilityfueldatapost) | **POST** /v2/electricity/facility-fuel/data | Class FacilityFuelController |
+| [**v2ElectricityFacilityFuelFacetFacetIdGet**](ELECApi.md#v2electricityfacilityfuelfacetfacetidget) | **GET** /v2/electricity/facility-fuel/facet/{facet_id} |  |
+| [**v2ElectricityFacilityFuelFacetGet**](ELECApi.md#v2electricityfacilityfuelfacetget) | **GET** /v2/electricity/facility-fuel/facet |  |
+| [**v2ElectricityFacilityFuelGet**](ELECApi.md#v2electricityfacilityfuelget) | **GET** /v2/electricity/facility-fuel |  |
+| [**v2ElectricityGet**](ELECApi.md#v2electricityget) | **GET** /v2/electricity | Class ElectricityController |
+| [**v2ElectricityOperatingGeneratorCapacityDataGet**](ELECApi.md#v2electricityoperatinggeneratorcapacitydataget) | **GET** /v2/electricity/operating-generator-capacity/data |  |
+| [**v2ElectricityOperatingGeneratorCapacityDataPost**](ELECApi.md#v2electricityoperatinggeneratorcapacitydatapost) | **POST** /v2/electricity/operating-generator-capacity/data | Return Electricity operating-generator-capacity Data |
+| [**v2ElectricityOperatingGeneratorCapacityFacetFacetIdGet**](ELECApi.md#v2electricityoperatinggeneratorcapacityfacetfacetidget) | **GET** /v2/electricity/operating-generator-capacity/facet/{facet_id} |  |
+| [**v2ElectricityOperatingGeneratorCapacityFacetGet**](ELECApi.md#v2electricityoperatinggeneratorcapacityfacetget) | **GET** /v2/electricity/operating-generator-capacity/facet |  |
+| [**v2ElectricityOperatingGeneratorCapacityGet**](ELECApi.md#v2electricityoperatinggeneratorcapacityget) | **GET** /v2/electricity/operating-generator-capacity |  |
+| [**v2ElectricityRetailSalesDataGet**](ELECApi.md#v2electricityretailsalesdataget) | **GET** /v2/electricity/retail-sales/data |  |
+| [**v2ElectricityRetailSalesDataPost**](ELECApi.md#v2electricityretailsalesdatapost) | **POST** /v2/electricity/retail-sales/data | Return Electricity retail-sales Data |
+| [**v2ElectricityRetailSalesFacetFacetIdGet**](ELECApi.md#v2electricityretailsalesfacetfacetidget) | **GET** /v2/electricity/retail-sales/facet/{facet_id} |  |
+| [**v2ElectricityRetailSalesFacetGet**](ELECApi.md#v2electricityretailsalesfacetget) | **GET** /v2/electricity/retail-sales/facet |  |
+| [**v2ElectricityRetailSalesGet**](ELECApi.md#v2electricityretailsalesget) | **GET** /v2/electricity/retail-sales |  |
+
+
+
+## v2ElectricityElectricPowerOperationalDataDataGet
+
+> DataResponseContainer v2ElectricityElectricPowerOperationalDataDataGet(data, facets, frequency, start, end, sort, length, offset)
+
+
+
+API data with query params
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ELECApi,
+} from '';
+import type { V2ElectricityElectricPowerOperationalDataDataGetRequest } 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 ELECApi(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 V2ElectricityElectricPowerOperationalDataDataGetRequest;
+
+  try {
+    const data = await api.v2ElectricityElectricPowerOperationalDataDataGet(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)
+
+
+## v2ElectricityElectricPowerOperationalDataDataPost
+
+> DataResponseContainer v2ElectricityElectricPowerOperationalDataDataPost(dataParams)
+
+Return Electricity electric-power-operational Data
+
+Class GenerationController  Electricity generation dataset controller.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ELECApi,
+} from '';
+import type { V2ElectricityElectricPowerOperationalDataDataPostRequest } 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 ELECApi(config);
+
+  const body = {
+    // DataParams | Parameters for data call
+    dataParams: ...,
+  } satisfies V2ElectricityElectricPowerOperationalDataDataPostRequest;
+
+  try {
+    const data = await api.v2ElectricityElectricPowerOperationalDataDataPost(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)
+
+
+## v2ElectricityElectricPowerOperationalDataFacetFacetIdGet
+
+> FacetDetailsContainer v2ElectricityElectricPowerOperationalDataFacetFacetIdGet(facetId)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ELECApi,
+} from '';
+import type { V2ElectricityElectricPowerOperationalDataFacetFacetIdGetRequest } 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 ELECApi(config);
+
+  const body = {
+    // string | Facet ID
+    facetId: facetId_example,
+  } satisfies V2ElectricityElectricPowerOperationalDataFacetFacetIdGetRequest;
+
+  try {
+    const data = await api.v2ElectricityElectricPowerOperationalDataFacetFacetIdGet(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)
+
+
+## v2ElectricityElectricPowerOperationalDataFacetGet
+
+> FacetOptionListContainer v2ElectricityElectricPowerOperationalDataFacetGet()
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ELECApi,
+} from '';
+import type { V2ElectricityElectricPowerOperationalDataFacetGetRequest } 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 ELECApi(config);
+
+  try {
+    const data = await api.v2ElectricityElectricPowerOperationalDataFacetGet();
+    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)
+
+
+## v2ElectricityElectricPowerOperationalDataGet
+
+> FinalRouteResponseContainer v2ElectricityElectricPowerOperationalDataGet()
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ELECApi,
+} from '';
+import type { V2ElectricityElectricPowerOperationalDataGetRequest } 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 ELECApi(config);
+
+  try {
+    const data = await api.v2ElectricityElectricPowerOperationalDataGet();
+    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)
+
+
+## v2ElectricityFacilityFuelDataGet
+
+> DataResponseContainer v2ElectricityFacilityFuelDataGet(data, facets, frequency, start, end, sort, length, offset)
+
+
+
+API data with query params
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ELECApi,
+} from '';
+import type { V2ElectricityFacilityFuelDataGetRequest } 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 ELECApi(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 V2ElectricityFacilityFuelDataGetRequest;
+
+  try {
+    const data = await api.v2ElectricityFacilityFuelDataGet(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)
+
+
+## v2ElectricityFacilityFuelDataPost
+
+> DataResponseContainer v2ElectricityFacilityFuelDataPost(dataParams)
+
+Class FacilityFuelController
+
+Electricity FacilityFuel dataset controller.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ELECApi,
+} from '';
+import type { V2ElectricityFacilityFuelDataPostRequest } 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 ELECApi(config);
+
+  const body = {
+    // DataParams | Parameters for data call
+    dataParams: ...,
+  } satisfies V2ElectricityFacilityFuelDataPostRequest;
+
+  try {
+    const data = await api.v2ElectricityFacilityFuelDataPost(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)
+
+
+## v2ElectricityFacilityFuelFacetFacetIdGet
+
+> FacetDetailsContainer v2ElectricityFacilityFuelFacetFacetIdGet(facetId)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ELECApi,
+} from '';
+import type { V2ElectricityFacilityFuelFacetFacetIdGetRequest } 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 ELECApi(config);
+
+  const body = {
+    // string | Facet ID
+    facetId: facetId_example,
+  } satisfies V2ElectricityFacilityFuelFacetFacetIdGetRequest;
+
+  try {
+    const data = await api.v2ElectricityFacilityFuelFacetFacetIdGet(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)
+
+
+## v2ElectricityFacilityFuelFacetGet
+
+> FacetOptionListContainer v2ElectricityFacilityFuelFacetGet()
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ELECApi,
+} from '';
+import type { V2ElectricityFacilityFuelFacetGetRequest } 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 ELECApi(config);
+
+  try {
+    const data = await api.v2ElectricityFacilityFuelFacetGet();
+    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)
+
+
+## v2ElectricityFacilityFuelGet
+
+> FinalRouteResponseContainer v2ElectricityFacilityFuelGet()
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ELECApi,
+} from '';
+import type { V2ElectricityFacilityFuelGetRequest } 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 ELECApi(config);
+
+  try {
+    const data = await api.v2ElectricityFacilityFuelGet();
+    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)
+
+
+## v2ElectricityGet
+
+> RouteResponseContainer v2ElectricityGet()
+
+Class ElectricityController
+
+Electricity data set top-level controller.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ELECApi,
+} from '';
+import type { V2ElectricityGetRequest } 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 ELECApi(config);
+
+  try {
+    const data = await api.v2ElectricityGet();
+    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)
+
+
+## v2ElectricityOperatingGeneratorCapacityDataGet
+
+> DataResponseContainer v2ElectricityOperatingGeneratorCapacityDataGet(data, facets, frequency, start, end, sort, length, offset)
+
+
+
+API data with query params
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ELECApi,
+} from '';
+import type { V2ElectricityOperatingGeneratorCapacityDataGetRequest } 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 ELECApi(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 V2ElectricityOperatingGeneratorCapacityDataGetRequest;
+
+  try {
+    const data = await api.v2ElectricityOperatingGeneratorCapacityDataGet(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)
+
+
+## v2ElectricityOperatingGeneratorCapacityDataPost
+
+> DataResponseContainer v2ElectricityOperatingGeneratorCapacityDataPost(dataParams)
+
+Return Electricity operating-generator-capacity Data
+
+Class GeneratorLevelCapacityController  Electricity generation dataset controller.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ELECApi,
+} from '';
+import type { V2ElectricityOperatingGeneratorCapacityDataPostRequest } 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 ELECApi(config);
+
+  const body = {
+    // DataParams | Parameters for data call
+    dataParams: ...,
+  } satisfies V2ElectricityOperatingGeneratorCapacityDataPostRequest;
+
+  try {
+    const data = await api.v2ElectricityOperatingGeneratorCapacityDataPost(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)
+
+
+## v2ElectricityOperatingGeneratorCapacityFacetFacetIdGet
+
+> FacetDetailsContainer v2ElectricityOperatingGeneratorCapacityFacetFacetIdGet(facetId)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ELECApi,
+} from '';
+import type { V2ElectricityOperatingGeneratorCapacityFacetFacetIdGetRequest } 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 ELECApi(config);
+
+  const body = {
+    // string | Facet ID
+    facetId: facetId_example,
+  } satisfies V2ElectricityOperatingGeneratorCapacityFacetFacetIdGetRequest;
+
+  try {
+    const data = await api.v2ElectricityOperatingGeneratorCapacityFacetFacetIdGet(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)
+
+
+## v2ElectricityOperatingGeneratorCapacityFacetGet
+
+> FacetOptionListContainer v2ElectricityOperatingGeneratorCapacityFacetGet()
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ELECApi,
+} from '';
+import type { V2ElectricityOperatingGeneratorCapacityFacetGetRequest } 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 ELECApi(config);
+
+  try {
+    const data = await api.v2ElectricityOperatingGeneratorCapacityFacetGet();
+    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)
+
+
+## v2ElectricityOperatingGeneratorCapacityGet
+
+> FinalRouteResponseContainer v2ElectricityOperatingGeneratorCapacityGet()
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ELECApi,
+} from '';
+import type { V2ElectricityOperatingGeneratorCapacityGetRequest } 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 ELECApi(config);
+
+  try {
+    const data = await api.v2ElectricityOperatingGeneratorCapacityGet();
+    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)
+
+
+## v2ElectricityRetailSalesDataGet
+
+> DataResponseContainer v2ElectricityRetailSalesDataGet(data, facets, frequency, start, end, sort, length, offset)
+
+
+
+API data with query params
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ELECApi,
+} from '';
+import type { V2ElectricityRetailSalesDataGetRequest } 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 ELECApi(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 V2ElectricityRetailSalesDataGetRequest;
+
+  try {
+    const data = await api.v2ElectricityRetailSalesDataGet(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)
+
+
+## v2ElectricityRetailSalesDataPost
+
+> DataResponseContainer v2ElectricityRetailSalesDataPost(dataParams)
+
+Return Electricity retail-sales Data
+
+Class RetailSalesController  Electricity retail sales dataset controller.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ELECApi,
+} from '';
+import type { V2ElectricityRetailSalesDataPostRequest } 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 ELECApi(config);
+
+  const body = {
+    // DataParams | Parameters for data call
+    dataParams: ...,
+  } satisfies V2ElectricityRetailSalesDataPostRequest;
+
+  try {
+    const data = await api.v2ElectricityRetailSalesDataPost(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)
+
+
+## v2ElectricityRetailSalesFacetFacetIdGet
+
+> FacetDetailsContainer v2ElectricityRetailSalesFacetFacetIdGet(facetId)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ELECApi,
+} from '';
+import type { V2ElectricityRetailSalesFacetFacetIdGetRequest } 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 ELECApi(config);
+
+  const body = {
+    // string | Facet ID
+    facetId: facetId_example,
+  } satisfies V2ElectricityRetailSalesFacetFacetIdGetRequest;
+
+  try {
+    const data = await api.v2ElectricityRetailSalesFacetFacetIdGet(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)
+
+
+## v2ElectricityRetailSalesFacetGet
+
+> FacetOptionListContainer v2ElectricityRetailSalesFacetGet()
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ELECApi,
+} from '';
+import type { V2ElectricityRetailSalesFacetGetRequest } 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 ELECApi(config);
+
+  try {
+    const data = await api.v2ElectricityRetailSalesFacetGet();
+    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)
+
+
+## v2ElectricityRetailSalesGet
+
+> FinalRouteResponseContainer v2ElectricityRetailSalesGet()
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ELECApi,
+} from '';
+import type { V2ElectricityRetailSalesGetRequest } 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 ELECApi(config);
+
+  try {
+    const data = await api.v2ElectricityRetailSalesGet();
+    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)
+