eiagov-typescript-fetch-client 1.0.0

package/docs/NGApi.md

@@ -0,0 +1,541 @@
+# NGApi
+
+All URIs are relative to *https://api.eia.gov*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**v2NaturalGasGet**](NGApi.md#v2naturalgasget) | **GET** /v2/natural-gas |  |
+| [**v2NaturalGasRoute1Get**](NGApi.md#v2naturalgasroute1get) | **GET** /v2/natural-gas/{route1} |  |
+| [**v2NaturalGasRoute1Route2DataGet**](NGApi.md#v2naturalgasroute1route2dataget) | **GET** /v2/natural-gas/{route1}/{route2}/data |  |
+| [**v2NaturalGasRoute1Route2DataPost**](NGApi.md#v2naturalgasroute1route2datapost) | **POST** /v2/natural-gas/{route1}/{route2}/data | Return Natural Gas Data |
+| [**v2NaturalGasRoute1Route2FacetFacetIdGet**](NGApi.md#v2naturalgasroute1route2facetfacetidget) | **GET** /v2/natural-gas/{route1}/{route2}/facet/{facet_id} |  |
+| [**v2NaturalGasRoute1Route2FacetGet**](NGApi.md#v2naturalgasroute1route2facetget) | **GET** /v2/natural-gas/{route1}/{route2}/facet |  |
+| [**v2NaturalGasRoute1Route2Get**](NGApi.md#v2naturalgasroute1route2get) | **GET** /v2/natural-gas/{route1}/{route2} |  |
+
+
+
+## v2NaturalGasGet
+
+> RouteResponseContainer v2NaturalGasGet()
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  NGApi,
+} from '';
+import type { V2NaturalGasGetRequest } 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 NGApi(config);
+
+  try {
+    const data = await api.v2NaturalGasGet();
+    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)
+
+
+## v2NaturalGasRoute1Get
+
+> RouteResponseContainer v2NaturalGasRoute1Get(route1)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  NGApi,
+} from '';
+import type { V2NaturalGasRoute1GetRequest } 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 NGApi(config);
+
+  const body = {
+    // string | First level Sub route
+    route1: route1_example,
+  } satisfies V2NaturalGasRoute1GetRequest;
+
+  try {
+    const data = await api.v2NaturalGasRoute1Get(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **route1** | `string` | First level Sub route | [Defaults to `undefined`] |
+
+### 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)
+
+
+## v2NaturalGasRoute1Route2DataGet
+
+> DataResponseContainer v2NaturalGasRoute1Route2DataGet(route1, route2, data, facets, frequency, start, end, sort, length, offset)
+
+
+
+API data with query params
+
+### Example
+
+```ts
+import {
+  Configuration,
+  NGApi,
+} from '';
+import type { V2NaturalGasRoute1Route2DataGetRequest } 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 NGApi(config);
+
+  const body = {
+    // string | First level Sub route
+    route1: route1_example,
+    // string | Second level Sub route
+    route2: route2_example,
+    // 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 V2NaturalGasRoute1Route2DataGetRequest;
+
+  try {
+    const data = await api.v2NaturalGasRoute1Route2DataGet(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **route1** | `string` | First level Sub route | [Defaults to `undefined`] |
+| **route2** | `string` | Second level Sub route | [Defaults to `undefined`] |
+| **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 |
+|-------------|-------------|------------------|
+| **405** | 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)
+
+
+## v2NaturalGasRoute1Route2DataPost
+
+> DataResponseContainer v2NaturalGasRoute1Route2DataPost(route1, route2, dataParams)
+
+Return Natural Gas Data
+
+### Example
+
+```ts
+import {
+  Configuration,
+  NGApi,
+} from '';
+import type { V2NaturalGasRoute1Route2DataPostRequest } 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 NGApi(config);
+
+  const body = {
+    // string | First level Sub route
+    route1: route1_example,
+    // string | Second level Sub route
+    route2: route2_example,
+    // DataParams | Parameters for data call
+    dataParams: ...,
+  } satisfies V2NaturalGasRoute1Route2DataPostRequest;
+
+  try {
+    const data = await api.v2NaturalGasRoute1Route2DataPost(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **route1** | `string` | First level Sub route | [Defaults to `undefined`] |
+| **route2** | `string` | Second level Sub route | [Defaults to `undefined`] |
+| **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 |
+|-------------|-------------|------------------|
+| **405** | 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)
+
+
+## v2NaturalGasRoute1Route2FacetFacetIdGet
+
+> FacetDetailsContainer v2NaturalGasRoute1Route2FacetFacetIdGet(route1, route2, facetId)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  NGApi,
+} from '';
+import type { V2NaturalGasRoute1Route2FacetFacetIdGetRequest } 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 NGApi(config);
+
+  const body = {
+    // string | First level Sub route
+    route1: route1_example,
+    // string | Second level Sub route
+    route2: route2_example,
+    // string | Facet ID
+    facetId: facetId_example,
+  } satisfies V2NaturalGasRoute1Route2FacetFacetIdGetRequest;
+
+  try {
+    const data = await api.v2NaturalGasRoute1Route2FacetFacetIdGet(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **route1** | `string` | First level Sub route | [Defaults to `undefined`] |
+| **route2** | `string` | Second level Sub route | [Defaults to `undefined`] |
+| **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)
+
+
+## v2NaturalGasRoute1Route2FacetGet
+
+> FacetOptionListContainer v2NaturalGasRoute1Route2FacetGet(route1, route2)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  NGApi,
+} from '';
+import type { V2NaturalGasRoute1Route2FacetGetRequest } 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 NGApi(config);
+
+  const body = {
+    // string | First level Sub route
+    route1: route1_example,
+    // string | Second level Sub route
+    route2: route2_example,
+  } satisfies V2NaturalGasRoute1Route2FacetGetRequest;
+
+  try {
+    const data = await api.v2NaturalGasRoute1Route2FacetGet(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **route1** | `string` | First level Sub route | [Defaults to `undefined`] |
+| **route2** | `string` | Second level Sub route | [Defaults to `undefined`] |
+
+### 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)
+
+
+## v2NaturalGasRoute1Route2Get
+
+> FinalRouteResponseContainer v2NaturalGasRoute1Route2Get(route1, route2)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  NGApi,
+} from '';
+import type { V2NaturalGasRoute1Route2GetRequest } 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 NGApi(config);
+
+  const body = {
+    // string | First level Sub route
+    route1: route1_example,
+    // string | Second level Sub route
+    route2: route2_example,
+  } satisfies V2NaturalGasRoute1Route2GetRequest;
+
+  try {
+    const data = await api.v2NaturalGasRoute1Route2Get(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **route1** | `string` | First level Sub route | [Defaults to `undefined`] |
+| **route2** | `string` | Second level Sub route | [Defaults to `undefined`] |
+
+### 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)
+