eiagov-typescript-fetch-client 1.0.0

package/docs/NUCSTATUSApi.md

@@ -0,0 +1,1161 @@
+# NUCSTATUSApi
+
+All URIs are relative to *https://api.eia.gov*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**v2NuclearOutagesFacilityNuclearOutagesDataGet**](NUCSTATUSApi.md#v2nuclearoutagesfacilitynuclearoutagesdataget) | **GET** /v2/nuclear-outages/facility-nuclear-outages/data |  |
+| [**v2NuclearOutagesFacilityNuclearOutagesDataPost**](NUCSTATUSApi.md#v2nuclearoutagesfacilitynuclearoutagesdatapost) | **POST** /v2/nuclear-outages/facility-nuclear-outages/data | Return facility-nuclear-outages Data |
+| [**v2NuclearOutagesFacilityNuclearOutagesFacetFacetIdGet**](NUCSTATUSApi.md#v2nuclearoutagesfacilitynuclearoutagesfacetfacetidget) | **GET** /v2/nuclear-outages/facility-nuclear-outages/facet/{facet_id} |  |
+| [**v2NuclearOutagesFacilityNuclearOutagesFacetGet**](NUCSTATUSApi.md#v2nuclearoutagesfacilitynuclearoutagesfacetget) | **GET** /v2/nuclear-outages/facility-nuclear-outages/facet |  |
+| [**v2NuclearOutagesFacilityNuclearOutagesGet**](NUCSTATUSApi.md#v2nuclearoutagesfacilitynuclearoutagesget) | **GET** /v2/nuclear-outages/facility-nuclear-outages |  |
+| [**v2NuclearOutagesGeneratorNuclearOutagesDataGet**](NUCSTATUSApi.md#v2nuclearoutagesgeneratornuclearoutagesdataget) | **GET** /v2/nuclear-outages/generator-nuclear-outages/data |  |
+| [**v2NuclearOutagesGeneratorNuclearOutagesDataPost**](NUCSTATUSApi.md#v2nuclearoutagesgeneratornuclearoutagesdatapost) | **POST** /v2/nuclear-outages/generator-nuclear-outages/data | Return generator-nuclear-outages Data |
+| [**v2NuclearOutagesGeneratorNuclearOutagesFacetFacetIdGet**](NUCSTATUSApi.md#v2nuclearoutagesgeneratornuclearoutagesfacetfacetidget) | **GET** /v2/nuclear-outages/generator-nuclear-outages/facet/{facet_id} |  |
+| [**v2NuclearOutagesGeneratorNuclearOutagesFacetGet**](NUCSTATUSApi.md#v2nuclearoutagesgeneratornuclearoutagesfacetget) | **GET** /v2/nuclear-outages/generator-nuclear-outages/facet |  |
+| [**v2NuclearOutagesGeneratorNuclearOutagesGet**](NUCSTATUSApi.md#v2nuclearoutagesgeneratornuclearoutagesget) | **GET** /v2/nuclear-outages/generator-nuclear-outages |  |
+| [**v2NuclearOutagesGet**](NUCSTATUSApi.md#v2nuclearoutagesget) | **GET** /v2/nuclear-outages | Class NuclearOutagesController |
+| [**v2NuclearOutagesUsNuclearOutagesDataGet**](NUCSTATUSApi.md#v2nuclearoutagesusnuclearoutagesdataget) | **GET** /v2/nuclear-outages/us-nuclear-outages/data |  |
+| [**v2NuclearOutagesUsNuclearOutagesDataPost**](NUCSTATUSApi.md#v2nuclearoutagesusnuclearoutagesdatapost) | **POST** /v2/nuclear-outages/us-nuclear-outages/data | Return us-nuclear-outages Data |
+| [**v2NuclearOutagesUsNuclearOutagesFacetFacetIdGet**](NUCSTATUSApi.md#v2nuclearoutagesusnuclearoutagesfacetfacetidget) | **GET** /v2/nuclear-outages/us-nuclear-outages/facet/{facet_id} |  |
+| [**v2NuclearOutagesUsNuclearOutagesFacetGet**](NUCSTATUSApi.md#v2nuclearoutagesusnuclearoutagesfacetget) | **GET** /v2/nuclear-outages/us-nuclear-outages/facet |  |
+| [**v2NuclearOutagesUsNuclearOutagesGet**](NUCSTATUSApi.md#v2nuclearoutagesusnuclearoutagesget) | **GET** /v2/nuclear-outages/us-nuclear-outages |  |
+
+
+
+## v2NuclearOutagesFacilityNuclearOutagesDataGet
+
+> DataResponseContainer v2NuclearOutagesFacilityNuclearOutagesDataGet(data, facets, frequency, start, end, sort, length, offset)
+
+
+
+API data with query params
+
+### Example
+
+```ts
+import {
+  Configuration,
+  NUCSTATUSApi,
+} from '';
+import type { V2NuclearOutagesFacilityNuclearOutagesDataGetRequest } 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 NUCSTATUSApi(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 V2NuclearOutagesFacilityNuclearOutagesDataGetRequest;
+
+  try {
+    const data = await api.v2NuclearOutagesFacilityNuclearOutagesDataGet(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)
+
+
+## v2NuclearOutagesFacilityNuclearOutagesDataPost
+
+> DataResponseContainer v2NuclearOutagesFacilityNuclearOutagesDataPost(dataParams)
+
+Return facility-nuclear-outages Data
+
+Class NuclearOutagesController  Nuclear Outages data set top-level controller.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  NUCSTATUSApi,
+} from '';
+import type { V2NuclearOutagesFacilityNuclearOutagesDataPostRequest } 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 NUCSTATUSApi(config);
+
+  const body = {
+    // DataParams | Parameters for data call
+    dataParams: ...,
+  } satisfies V2NuclearOutagesFacilityNuclearOutagesDataPostRequest;
+
+  try {
+    const data = await api.v2NuclearOutagesFacilityNuclearOutagesDataPost(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)
+
+
+## v2NuclearOutagesFacilityNuclearOutagesFacetFacetIdGet
+
+> FacetDetailsContainer v2NuclearOutagesFacilityNuclearOutagesFacetFacetIdGet(facetId)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  NUCSTATUSApi,
+} from '';
+import type { V2NuclearOutagesFacilityNuclearOutagesFacetFacetIdGetRequest } 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 NUCSTATUSApi(config);
+
+  const body = {
+    // string | Facet ID
+    facetId: facetId_example,
+  } satisfies V2NuclearOutagesFacilityNuclearOutagesFacetFacetIdGetRequest;
+
+  try {
+    const data = await api.v2NuclearOutagesFacilityNuclearOutagesFacetFacetIdGet(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)
+
+
+## v2NuclearOutagesFacilityNuclearOutagesFacetGet
+
+> FacetOptionListContainer v2NuclearOutagesFacilityNuclearOutagesFacetGet()
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  NUCSTATUSApi,
+} from '';
+import type { V2NuclearOutagesFacilityNuclearOutagesFacetGetRequest } 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 NUCSTATUSApi(config);
+
+  try {
+    const data = await api.v2NuclearOutagesFacilityNuclearOutagesFacetGet();
+    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)
+
+
+## v2NuclearOutagesFacilityNuclearOutagesGet
+
+> FinalRouteResponseContainer v2NuclearOutagesFacilityNuclearOutagesGet()
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  NUCSTATUSApi,
+} from '';
+import type { V2NuclearOutagesFacilityNuclearOutagesGetRequest } 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 NUCSTATUSApi(config);
+
+  try {
+    const data = await api.v2NuclearOutagesFacilityNuclearOutagesGet();
+    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)
+
+
+## v2NuclearOutagesGeneratorNuclearOutagesDataGet
+
+> DataResponseContainer v2NuclearOutagesGeneratorNuclearOutagesDataGet(data, facets, frequency, start, end, sort, length, offset)
+
+
+
+API data with query params
+
+### Example
+
+```ts
+import {
+  Configuration,
+  NUCSTATUSApi,
+} from '';
+import type { V2NuclearOutagesGeneratorNuclearOutagesDataGetRequest } 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 NUCSTATUSApi(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 V2NuclearOutagesGeneratorNuclearOutagesDataGetRequest;
+
+  try {
+    const data = await api.v2NuclearOutagesGeneratorNuclearOutagesDataGet(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)
+
+
+## v2NuclearOutagesGeneratorNuclearOutagesDataPost
+
+> DataResponseContainer v2NuclearOutagesGeneratorNuclearOutagesDataPost(dataParams)
+
+Return generator-nuclear-outages Data
+
+Class NuclearOutagesController  Nuclear Outages data set top-level controller.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  NUCSTATUSApi,
+} from '';
+import type { V2NuclearOutagesGeneratorNuclearOutagesDataPostRequest } 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 NUCSTATUSApi(config);
+
+  const body = {
+    // DataParams | Parameters for data call
+    dataParams: ...,
+  } satisfies V2NuclearOutagesGeneratorNuclearOutagesDataPostRequest;
+
+  try {
+    const data = await api.v2NuclearOutagesGeneratorNuclearOutagesDataPost(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)
+
+
+## v2NuclearOutagesGeneratorNuclearOutagesFacetFacetIdGet
+
+> FacetDetailsContainer v2NuclearOutagesGeneratorNuclearOutagesFacetFacetIdGet(facetId)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  NUCSTATUSApi,
+} from '';
+import type { V2NuclearOutagesGeneratorNuclearOutagesFacetFacetIdGetRequest } 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 NUCSTATUSApi(config);
+
+  const body = {
+    // string | Facet ID
+    facetId: facetId_example,
+  } satisfies V2NuclearOutagesGeneratorNuclearOutagesFacetFacetIdGetRequest;
+
+  try {
+    const data = await api.v2NuclearOutagesGeneratorNuclearOutagesFacetFacetIdGet(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)
+
+
+## v2NuclearOutagesGeneratorNuclearOutagesFacetGet
+
+> FacetOptionListContainer v2NuclearOutagesGeneratorNuclearOutagesFacetGet()
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  NUCSTATUSApi,
+} from '';
+import type { V2NuclearOutagesGeneratorNuclearOutagesFacetGetRequest } 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 NUCSTATUSApi(config);
+
+  try {
+    const data = await api.v2NuclearOutagesGeneratorNuclearOutagesFacetGet();
+    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)
+
+
+## v2NuclearOutagesGeneratorNuclearOutagesGet
+
+> FinalRouteResponseContainer v2NuclearOutagesGeneratorNuclearOutagesGet()
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  NUCSTATUSApi,
+} from '';
+import type { V2NuclearOutagesGeneratorNuclearOutagesGetRequest } 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 NUCSTATUSApi(config);
+
+  try {
+    const data = await api.v2NuclearOutagesGeneratorNuclearOutagesGet();
+    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)
+
+
+## v2NuclearOutagesGet
+
+> RouteResponseContainer v2NuclearOutagesGet()
+
+Class NuclearOutagesController
+
+Nuclear Outages data set top-level controller.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  NUCSTATUSApi,
+} from '';
+import type { V2NuclearOutagesGetRequest } 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 NUCSTATUSApi(config);
+
+  try {
+    const data = await api.v2NuclearOutagesGet();
+    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)
+
+
+## v2NuclearOutagesUsNuclearOutagesDataGet
+
+> DataResponseContainer v2NuclearOutagesUsNuclearOutagesDataGet(data, facets, frequency, start, end, sort, length, offset)
+
+
+
+API data with query params
+
+### Example
+
+```ts
+import {
+  Configuration,
+  NUCSTATUSApi,
+} from '';
+import type { V2NuclearOutagesUsNuclearOutagesDataGetRequest } 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 NUCSTATUSApi(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 V2NuclearOutagesUsNuclearOutagesDataGetRequest;
+
+  try {
+    const data = await api.v2NuclearOutagesUsNuclearOutagesDataGet(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)
+
+
+## v2NuclearOutagesUsNuclearOutagesDataPost
+
+> DataResponseContainer v2NuclearOutagesUsNuclearOutagesDataPost(dataParams)
+
+Return us-nuclear-outages Data
+
+Class NuclearOutagesController  Nuclear Outages data set top-level controller.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  NUCSTATUSApi,
+} from '';
+import type { V2NuclearOutagesUsNuclearOutagesDataPostRequest } 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 NUCSTATUSApi(config);
+
+  const body = {
+    // DataParams | Parameters for data call
+    dataParams: ...,
+  } satisfies V2NuclearOutagesUsNuclearOutagesDataPostRequest;
+
+  try {
+    const data = await api.v2NuclearOutagesUsNuclearOutagesDataPost(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)
+
+
+## v2NuclearOutagesUsNuclearOutagesFacetFacetIdGet
+
+> FacetDetailsContainer v2NuclearOutagesUsNuclearOutagesFacetFacetIdGet(facetId)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  NUCSTATUSApi,
+} from '';
+import type { V2NuclearOutagesUsNuclearOutagesFacetFacetIdGetRequest } 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 NUCSTATUSApi(config);
+
+  const body = {
+    // string | Facet ID
+    facetId: facetId_example,
+  } satisfies V2NuclearOutagesUsNuclearOutagesFacetFacetIdGetRequest;
+
+  try {
+    const data = await api.v2NuclearOutagesUsNuclearOutagesFacetFacetIdGet(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)
+
+
+## v2NuclearOutagesUsNuclearOutagesFacetGet
+
+> FacetOptionListContainer v2NuclearOutagesUsNuclearOutagesFacetGet()
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  NUCSTATUSApi,
+} from '';
+import type { V2NuclearOutagesUsNuclearOutagesFacetGetRequest } 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 NUCSTATUSApi(config);
+
+  try {
+    const data = await api.v2NuclearOutagesUsNuclearOutagesFacetGet();
+    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)
+
+
+## v2NuclearOutagesUsNuclearOutagesGet
+
+> FinalRouteResponseContainer v2NuclearOutagesUsNuclearOutagesGet()
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  NUCSTATUSApi,
+} from '';
+import type { V2NuclearOutagesUsNuclearOutagesGetRequest } 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 NUCSTATUSApi(config);
+
+  try {
+    const data = await api.v2NuclearOutagesUsNuclearOutagesGet();
+    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)
+