eiagov-typescript-fetch-client 1.0.0

package/docs/TOTALApi.md

@@ -0,0 +1,371 @@
+# TOTALApi
+
+All URIs are relative to *https://api.eia.gov*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**v2TotalEnergyDataGet**](TOTALApi.md#v2totalenergydataget) | **GET** /v2/total-energy/data |  |
+| [**v2TotalEnergyDataPost**](TOTALApi.md#v2totalenergydatapost) | **POST** /v2/total-energy/data | Return Total Energy Data |
+| [**v2TotalEnergyFacetFacetIdGet**](TOTALApi.md#v2totalenergyfacetfacetidget) | **GET** /v2/total-energy/facet/{facet_id} |  |
+| [**v2TotalEnergyFacetGet**](TOTALApi.md#v2totalenergyfacetget) | **GET** /v2/total-energy/facet |  |
+| [**v2TotalEnergyGet**](TOTALApi.md#v2totalenergyget) | **GET** /v2/total-energy |  |
+
+
+
+## v2TotalEnergyDataGet
+
+> DataResponseContainer v2TotalEnergyDataGet(data, facets, frequency, start, end, sort, length, offset)
+
+
+
+API data with query params
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TOTALApi,
+} from '';
+import type { V2TotalEnergyDataGetRequest } 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 TOTALApi(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 V2TotalEnergyDataGetRequest;
+
+  try {
+    const data = await api.v2TotalEnergyDataGet(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)
+
+
+## v2TotalEnergyDataPost
+
+> DataResponseContainer v2TotalEnergyDataPost(dataParams)
+
+Return Total Energy Data
+
+Class TotalEnergyController  Total Energy controller.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TOTALApi,
+} from '';
+import type { V2TotalEnergyDataPostRequest } 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 TOTALApi(config);
+
+  const body = {
+    // DataParams | Parameters for data call
+    dataParams: ...,
+  } satisfies V2TotalEnergyDataPostRequest;
+
+  try {
+    const data = await api.v2TotalEnergyDataPost(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)
+
+
+## v2TotalEnergyFacetFacetIdGet
+
+> FacetDetailsContainer v2TotalEnergyFacetFacetIdGet(facetId)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TOTALApi,
+} from '';
+import type { V2TotalEnergyFacetFacetIdGetRequest } 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 TOTALApi(config);
+
+  const body = {
+    // string | Facet ID
+    facetId: facetId_example,
+  } satisfies V2TotalEnergyFacetFacetIdGetRequest;
+
+  try {
+    const data = await api.v2TotalEnergyFacetFacetIdGet(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)
+
+
+## v2TotalEnergyFacetGet
+
+> FacetOptionListContainer v2TotalEnergyFacetGet()
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TOTALApi,
+} from '';
+import type { V2TotalEnergyFacetGetRequest } 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 TOTALApi(config);
+
+  try {
+    const data = await api.v2TotalEnergyFacetGet();
+    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)
+
+
+## v2TotalEnergyGet
+
+> FinalRouteResponseContainer v2TotalEnergyGet()
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TOTALApi,
+} from '';
+import type { V2TotalEnergyGetRequest } 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 TOTALApi(config);
+
+  try {
+    const data = await api.v2TotalEnergyGet();
+    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)
+

package/index.ts

@@ -0,0 +1,5 @@
+/* tslint:disable */
+/* eslint-disable */
+export * from './runtime';
+export * from './apis/index';
+export * from './models/index';

package/models/DataParams.ts

@@ -0,0 +1,129 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EIA APIv2
+ * Swagger UI interface for EIA\'s APIv2.  You can also explore EIA\'s API using the [Opendata Query Browser](https://www.eia.gov/opendata/browser/).  For this UI, you must use your EIA `api key` to apply filters and return data. You can register for an API Key at [https://www.eia.gov/opendata/](https://www.eia.gov/opendata/)
+ *
+ * The version of the OpenAPI document: 2.1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+import type { Sort } from './Sort';
+import {
+    SortFromJSON,
+    SortFromJSONTyped,
+    SortToJSON,
+    SortToJSONTyped,
+} from './Sort';
+
+/**
+ * 
+ * @export
+ * @interface DataParams
+ */
+export interface DataParams {
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof DataParams
+     */
+    data?: Array<string>;
+    /**
+     * 
+     * @type {object}
+     * @memberof DataParams
+     */
+    facets?: object;
+    /**
+     * 
+     * @type {string}
+     * @memberof DataParams
+     */
+    frequency?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof DataParams
+     */
+    start?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof DataParams
+     */
+    end?: string;
+    /**
+     * 
+     * @type {Array<Sort>}
+     * @memberof DataParams
+     */
+    sort?: Array<Sort>;
+    /**
+     * 
+     * @type {number}
+     * @memberof DataParams
+     */
+    length?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof DataParams
+     */
+    offset?: number;
+}
+
+/**
+ * Check if a given object implements the DataParams interface.
+ */
+export function instanceOfDataParams(value: object): value is DataParams {
+    return true;
+}
+
+export function DataParamsFromJSON(json: any): DataParams {
+    return DataParamsFromJSONTyped(json, false);
+}
+
+export function DataParamsFromJSONTyped(json: any, ignoreDiscriminator: boolean): DataParams {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'data': json['data'] == null ? undefined : json['data'],
+        'facets': json['facets'] == null ? undefined : json['facets'],
+        'frequency': json['frequency'] == null ? undefined : json['frequency'],
+        'start': json['start'] == null ? undefined : json['start'],
+        'end': json['end'] == null ? undefined : json['end'],
+        'sort': json['sort'] == null ? undefined : ((json['sort'] as Array<any>).map(SortFromJSON)),
+        'length': json['length'] == null ? undefined : json['length'],
+        'offset': json['offset'] == null ? undefined : json['offset'],
+    };
+}
+
+export function DataParamsToJSON(json: any): DataParams {
+    return DataParamsToJSONTyped(json, false);
+}
+
+export function DataParamsToJSONTyped(value?: DataParams | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'data': value['data'],
+        'facets': value['facets'],
+        'frequency': value['frequency'],
+        'start': value['start'],
+        'end': value['end'],
+        'sort': value['sort'] == null ? undefined : ((value['sort'] as Array<any>).map(SortToJSON)),
+        'length': value['length'],
+        'offset': value['offset'],
+    };
+}
+

package/models/DataResponse.ts

@@ -0,0 +1,97 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EIA APIv2
+ * Swagger UI interface for EIA\'s APIv2.  You can also explore EIA\'s API using the [Opendata Query Browser](https://www.eia.gov/opendata/browser/).  For this UI, you must use your EIA `api key` to apply filters and return data. You can register for an API Key at [https://www.eia.gov/opendata/](https://www.eia.gov/opendata/)
+ *
+ * The version of the OpenAPI document: 2.1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface DataResponse
+ */
+export interface DataResponse {
+    /**
+     * 
+     * @type {any}
+     * @memberof DataResponse
+     */
+    data?: any | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof DataResponse
+     */
+    dateFormat?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof DataResponse
+     */
+    description?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof DataResponse
+     */
+    frequency?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof DataResponse
+     */
+    total?: number;
+}
+
+/**
+ * Check if a given object implements the DataResponse interface.
+ */
+export function instanceOfDataResponse(value: object): value is DataResponse {
+    return true;
+}
+
+export function DataResponseFromJSON(json: any): DataResponse {
+    return DataResponseFromJSONTyped(json, false);
+}
+
+export function DataResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): DataResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'data': json['data'] == null ? undefined : json['data'],
+        'dateFormat': json['dateFormat'] == null ? undefined : json['dateFormat'],
+        'description': json['description'] == null ? undefined : json['description'],
+        'frequency': json['frequency'] == null ? undefined : json['frequency'],
+        'total': json['total'] == null ? undefined : json['total'],
+    };
+}
+
+export function DataResponseToJSON(json: any): DataResponse {
+    return DataResponseToJSONTyped(json, false);
+}
+
+export function DataResponseToJSONTyped(value?: DataResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'data': value['data'],
+        'dateFormat': value['dateFormat'],
+        'description': value['description'],
+        'frequency': value['frequency'],
+        'total': value['total'],
+    };
+}
+

package/models/DataResponseContainer.ts

@@ -0,0 +1,96 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EIA APIv2
+ * Swagger UI interface for EIA\'s APIv2.  You can also explore EIA\'s API using the [Opendata Query Browser](https://www.eia.gov/opendata/browser/).  For this UI, you must use your EIA `api key` to apply filters and return data. You can register for an API Key at [https://www.eia.gov/opendata/](https://www.eia.gov/opendata/)
+ *
+ * The version of the OpenAPI document: 2.1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+import type { DataResponse } from './DataResponse';
+import {
+    DataResponseFromJSON,
+    DataResponseFromJSONTyped,
+    DataResponseToJSON,
+    DataResponseToJSONTyped,
+} from './DataResponse';
+import type { RouteRequest } from './RouteRequest';
+import {
+    RouteRequestFromJSON,
+    RouteRequestFromJSONTyped,
+    RouteRequestToJSON,
+    RouteRequestToJSONTyped,
+} from './RouteRequest';
+
+/**
+ * 
+ * @export
+ * @interface DataResponseContainer
+ */
+export interface DataResponseContainer {
+    /**
+     * 
+     * @type {string}
+     * @memberof DataResponseContainer
+     */
+    apiVersion?: string;
+    /**
+     * 
+     * @type {RouteRequest}
+     * @memberof DataResponseContainer
+     */
+    request?: RouteRequest;
+    /**
+     * 
+     * @type {DataResponse}
+     * @memberof DataResponseContainer
+     */
+    response?: DataResponse;
+}
+
+/**
+ * Check if a given object implements the DataResponseContainer interface.
+ */
+export function instanceOfDataResponseContainer(value: object): value is DataResponseContainer {
+    return true;
+}
+
+export function DataResponseContainerFromJSON(json: any): DataResponseContainer {
+    return DataResponseContainerFromJSONTyped(json, false);
+}
+
+export function DataResponseContainerFromJSONTyped(json: any, ignoreDiscriminator: boolean): DataResponseContainer {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'apiVersion': json['apiVersion'] == null ? undefined : json['apiVersion'],
+        'request': json['request'] == null ? undefined : RouteRequestFromJSON(json['request']),
+        'response': json['response'] == null ? undefined : DataResponseFromJSON(json['response']),
+    };
+}
+
+export function DataResponseContainerToJSON(json: any): DataResponseContainer {
+    return DataResponseContainerToJSONTyped(json, false);
+}
+
+export function DataResponseContainerToJSONTyped(value?: DataResponseContainer | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'apiVersion': value['apiVersion'],
+        'request': RouteRequestToJSON(value['request']),
+        'response': DataResponseToJSON(value['response']),
+    };
+}
+