eiagov-typescript-fetch-client 1.0.0

package/docs/RootApi.md

@@ -0,0 +1,70 @@
+# RootApi
+
+All URIs are relative to *https://api.eia.gov*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**v2Get**](RootApi.md#v2get) | **GET** /v2 |  |
+
+
+
+## v2Get
+
+> RouteResponseContainer v2Get()
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  RootApi,
+} from '';
+import type { V2GetRequest } 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 RootApi(config);
+
+  try {
+    const data = await api.v2Get();
+    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)
+

package/docs/RouteRequest.md

@@ -0,0 +1,36 @@
+
+# RouteRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`command` | Array<string>
+`params` | any
+
+## Example
+
+```typescript
+import type { RouteRequest } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "command": null,
+  "params": null,
+} satisfies RouteRequest
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as RouteRequest
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/RouteResponse.md

@@ -0,0 +1,36 @@
+
+# RouteResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`response` | [Routes](Routes.md)
+`request` | [RouteRequest](RouteRequest.md)
+
+## Example
+
+```typescript
+import type { RouteResponse } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "response": null,
+  "request": null,
+} satisfies RouteResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as RouteResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/RouteResponseContainer.md

@@ -0,0 +1,38 @@
+
+# RouteResponseContainer
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`apiVersion` | string
+`request` | [RouteRequest](RouteRequest.md)
+`response` | [RouteResponse](RouteResponse.md)
+
+## Example
+
+```typescript
+import type { RouteResponseContainer } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "apiVersion": null,
+  "request": null,
+  "response": null,
+} satisfies RouteResponseContainer
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as RouteResponseContainer
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/Routes.md

@@ -0,0 +1,40 @@
+
+# Routes
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`routes` | Array<string>
+`id` | string
+`name` | string
+`description` | string
+
+## Example
+
+```typescript
+import type { Routes } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "routes": null,
+  "id": null,
+  "name": null,
+  "description": null,
+} satisfies Routes
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as Routes
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/SEDSApi.md

@@ -0,0 +1,372 @@
+# SEDSApi
+
+All URIs are relative to *https://api.eia.gov*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**v2SedsDataGet**](SEDSApi.md#v2sedsdataget) | **GET** /v2/seds/data |  |
+| [**v2SedsDataPost**](SEDSApi.md#v2sedsdatapost) | **POST** /v2/seds/data | Return SEDS Data |
+| [**v2SedsFacetFacetIdGet**](SEDSApi.md#v2sedsfacetfacetidget) | **GET** /v2/seds/facet/{facet_id} |  |
+| [**v2SedsFacetGet**](SEDSApi.md#v2sedsfacetget) | **GET** /v2/seds/facet |  |
+| [**v2SedsGet**](SEDSApi.md#v2sedsget) | **GET** /v2/seds |  |
+
+
+
+## v2SedsDataGet
+
+> DataResponseContainer v2SedsDataGet(data, facets, frequency, start, end, sort, length, offset)
+
+
+
+API data with query params
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SEDSApi,
+} from '';
+import type { V2SedsDataGetRequest } 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 SEDSApi(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 V2SedsDataGetRequest;
+
+  try {
+    const data = await api.v2SedsDataGet(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 |  -  |
+| **404** | Not Found |  -  |
+| **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)
+
+
+## v2SedsDataPost
+
+> DataResponseContainer v2SedsDataPost(dataParams)
+
+Return SEDS Data
+
+Class SEDSController  SEDS data set top-level controller.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SEDSApi,
+} from '';
+import type { V2SedsDataPostRequest } 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 SEDSApi(config);
+
+  const body = {
+    // DataParams | Parameters for data call
+    dataParams: ...,
+  } satisfies V2SedsDataPostRequest;
+
+  try {
+    const data = await api.v2SedsDataPost(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)
+
+
+## v2SedsFacetFacetIdGet
+
+> FacetDetailsContainer v2SedsFacetFacetIdGet(facetId)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SEDSApi,
+} from '';
+import type { V2SedsFacetFacetIdGetRequest } 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 SEDSApi(config);
+
+  const body = {
+    // string | 
+    facetId: facetId_example,
+  } satisfies V2SedsFacetFacetIdGetRequest;
+
+  try {
+    const data = await api.v2SedsFacetFacetIdGet(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **facetId** | `string` |  | [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)
+
+
+## v2SedsFacetGet
+
+> FacetOptionListContainer v2SedsFacetGet()
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SEDSApi,
+} from '';
+import type { V2SedsFacetGetRequest } 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 SEDSApi(config);
+
+  try {
+    const data = await api.v2SedsFacetGet();
+    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)
+
+
+## v2SedsGet
+
+> FinalRouteResponseContainer v2SedsGet()
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SEDSApi,
+} from '';
+import type { V2SedsGetRequest } 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 SEDSApi(config);
+
+  try {
+    const data = await api.v2SedsGet();
+    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)
+