eiagov-typescript-fetch-client 1.0.0

package/apis/STEOApi.ts

@@ -0,0 +1,322 @@
+/* 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 * as runtime from '../runtime';
+import {
+    type DataParams,
+    DataParamsFromJSON,
+    DataParamsToJSON,
+} from '../models/DataParams';
+import {
+    type DataResponseContainer,
+    DataResponseContainerFromJSON,
+    DataResponseContainerToJSON,
+} from '../models/DataResponseContainer';
+import {
+    type FacetDetailsContainer,
+    FacetDetailsContainerFromJSON,
+    FacetDetailsContainerToJSON,
+} from '../models/FacetDetailsContainer';
+import {
+    type FacetOptionListContainer,
+    FacetOptionListContainerFromJSON,
+    FacetOptionListContainerToJSON,
+} from '../models/FacetOptionListContainer';
+import {
+    type FinalRouteResponseContainer,
+    FinalRouteResponseContainerFromJSON,
+    FinalRouteResponseContainerToJSON,
+} from '../models/FinalRouteResponseContainer';
+import {
+    type Sort,
+    SortFromJSON,
+    SortToJSON,
+} from '../models/Sort';
+
+export interface V2SteoDataGetRequest {
+    data?: Array<string>;
+    facets?: object;
+    frequency?: string;
+    start?: string;
+    end?: string;
+    sort?: Sort;
+    length?: number;
+    offset?: number;
+}
+
+export interface V2SteoDataPostRequest {
+    dataParams: DataParams;
+}
+
+export interface V2SteoFacetFacetIdGetRequest {
+    facetId: string;
+}
+
+/**
+ * 
+ */
+export class STEOApi extends runtime.BaseAPI {
+
+    /**
+     * Creates request options for v2SteoDataGet without sending the request
+     */
+    async v2SteoDataGetRequestOpts(requestParameters: V2SteoDataGetRequest): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        if (requestParameters['data'] != null) {
+            queryParameters['data'] = requestParameters['data'];
+        }
+
+        if (requestParameters['facets'] != null) {
+            queryParameters['facets'] = requestParameters['facets'];
+        }
+
+        if (requestParameters['frequency'] != null) {
+            queryParameters['frequency'] = requestParameters['frequency'];
+        }
+
+        if (requestParameters['start'] != null) {
+            queryParameters['start'] = requestParameters['start'];
+        }
+
+        if (requestParameters['end'] != null) {
+            queryParameters['end'] = requestParameters['end'];
+        }
+
+        if (requestParameters['sort'] != null) {
+            queryParameters['sort'] = requestParameters['sort'];
+        }
+
+        if (requestParameters['length'] != null) {
+            queryParameters['length'] = requestParameters['length'];
+        }
+
+        if (requestParameters['offset'] != null) {
+            queryParameters['offset'] = requestParameters['offset'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            queryParameters["api_key"] = await this.configuration.apiKey("api_key"); // api_key authentication
+        }
+
+
+        let urlPath = `/v2/steo/data`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * API data with query params
+     */
+    async v2SteoDataGetRaw(requestParameters: V2SteoDataGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DataResponseContainer>> {
+        const requestOptions = await this.v2SteoDataGetRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => DataResponseContainerFromJSON(jsonValue));
+    }
+
+    /**
+     * API data with query params
+     */
+    async v2SteoDataGet(requestParameters: V2SteoDataGetRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DataResponseContainer> {
+        const response = await this.v2SteoDataGetRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for v2SteoDataPost without sending the request
+     */
+    async v2SteoDataPostRequestOpts(requestParameters: V2SteoDataPostRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['dataParams'] == null) {
+            throw new runtime.RequiredError(
+                'dataParams',
+                'Required parameter "dataParams" was null or undefined when calling v2SteoDataPost().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.apiKey) {
+            queryParameters["api_key"] = await this.configuration.apiKey("api_key"); // api_key authentication
+        }
+
+
+        let urlPath = `/v2/steo/data`;
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: DataParamsToJSON(requestParameters['dataParams']),
+        };
+    }
+
+    /**
+     * STEO data set top-level controller.
+     * Class STEOController
+     */
+    async v2SteoDataPostRaw(requestParameters: V2SteoDataPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DataResponseContainer>> {
+        const requestOptions = await this.v2SteoDataPostRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => DataResponseContainerFromJSON(jsonValue));
+    }
+
+    /**
+     * STEO data set top-level controller.
+     * Class STEOController
+     */
+    async v2SteoDataPost(requestParameters: V2SteoDataPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DataResponseContainer> {
+        const response = await this.v2SteoDataPostRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for v2SteoFacetFacetIdGet without sending the request
+     */
+    async v2SteoFacetFacetIdGetRequestOpts(requestParameters: V2SteoFacetFacetIdGetRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['facetId'] == null) {
+            throw new runtime.RequiredError(
+                'facetId',
+                'Required parameter "facetId" was null or undefined when calling v2SteoFacetFacetIdGet().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            queryParameters["api_key"] = await this.configuration.apiKey("api_key"); // api_key authentication
+        }
+
+
+        let urlPath = `/v2/steo/facet/{facet_id}`;
+        urlPath = urlPath.replace('{facet_id}', encodeURIComponent(String(requestParameters['facetId'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     */
+    async v2SteoFacetFacetIdGetRaw(requestParameters: V2SteoFacetFacetIdGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FacetDetailsContainer>> {
+        const requestOptions = await this.v2SteoFacetFacetIdGetRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => FacetDetailsContainerFromJSON(jsonValue));
+    }
+
+    /**
+     */
+    async v2SteoFacetFacetIdGet(requestParameters: V2SteoFacetFacetIdGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FacetDetailsContainer> {
+        const response = await this.v2SteoFacetFacetIdGetRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for v2SteoFacetGet without sending the request
+     */
+    async v2SteoFacetGetRequestOpts(): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            queryParameters["api_key"] = await this.configuration.apiKey("api_key"); // api_key authentication
+        }
+
+
+        let urlPath = `/v2/steo/facet`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     */
+    async v2SteoFacetGetRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FacetOptionListContainer>> {
+        const requestOptions = await this.v2SteoFacetGetRequestOpts();
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => FacetOptionListContainerFromJSON(jsonValue));
+    }
+
+    /**
+     */
+    async v2SteoFacetGet(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FacetOptionListContainer> {
+        const response = await this.v2SteoFacetGetRaw(initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for v2SteoGet without sending the request
+     */
+    async v2SteoGetRequestOpts(): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            queryParameters["api_key"] = await this.configuration.apiKey("api_key"); // api_key authentication
+        }
+
+
+        let urlPath = `/v2/steo`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     */
+    async v2SteoGetRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FinalRouteResponseContainer>> {
+        const requestOptions = await this.v2SteoGetRequestOpts();
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => FinalRouteResponseContainerFromJSON(jsonValue));
+    }
+
+    /**
+     */
+    async v2SteoGet(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FinalRouteResponseContainer> {
+        const response = await this.v2SteoGetRaw(initOverrides);
+        return await response.value();
+    }
+
+}

package/apis/TOTALApi.ts

@@ -0,0 +1,322 @@
+/* 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 * as runtime from '../runtime';
+import {
+    type DataParams,
+    DataParamsFromJSON,
+    DataParamsToJSON,
+} from '../models/DataParams';
+import {
+    type DataResponseContainer,
+    DataResponseContainerFromJSON,
+    DataResponseContainerToJSON,
+} from '../models/DataResponseContainer';
+import {
+    type FacetDetailsContainer,
+    FacetDetailsContainerFromJSON,
+    FacetDetailsContainerToJSON,
+} from '../models/FacetDetailsContainer';
+import {
+    type FacetOptionListContainer,
+    FacetOptionListContainerFromJSON,
+    FacetOptionListContainerToJSON,
+} from '../models/FacetOptionListContainer';
+import {
+    type FinalRouteResponseContainer,
+    FinalRouteResponseContainerFromJSON,
+    FinalRouteResponseContainerToJSON,
+} from '../models/FinalRouteResponseContainer';
+import {
+    type Sort,
+    SortFromJSON,
+    SortToJSON,
+} from '../models/Sort';
+
+export interface V2TotalEnergyDataGetRequest {
+    data?: Array<string>;
+    facets?: object;
+    frequency?: string;
+    start?: string;
+    end?: string;
+    sort?: Sort;
+    length?: number;
+    offset?: number;
+}
+
+export interface V2TotalEnergyDataPostRequest {
+    dataParams: DataParams;
+}
+
+export interface V2TotalEnergyFacetFacetIdGetRequest {
+    facetId: string;
+}
+
+/**
+ * 
+ */
+export class TOTALApi extends runtime.BaseAPI {
+
+    /**
+     * Creates request options for v2TotalEnergyDataGet without sending the request
+     */
+    async v2TotalEnergyDataGetRequestOpts(requestParameters: V2TotalEnergyDataGetRequest): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        if (requestParameters['data'] != null) {
+            queryParameters['data'] = requestParameters['data'];
+        }
+
+        if (requestParameters['facets'] != null) {
+            queryParameters['facets'] = requestParameters['facets'];
+        }
+
+        if (requestParameters['frequency'] != null) {
+            queryParameters['frequency'] = requestParameters['frequency'];
+        }
+
+        if (requestParameters['start'] != null) {
+            queryParameters['start'] = requestParameters['start'];
+        }
+
+        if (requestParameters['end'] != null) {
+            queryParameters['end'] = requestParameters['end'];
+        }
+
+        if (requestParameters['sort'] != null) {
+            queryParameters['sort'] = requestParameters['sort'];
+        }
+
+        if (requestParameters['length'] != null) {
+            queryParameters['length'] = requestParameters['length'];
+        }
+
+        if (requestParameters['offset'] != null) {
+            queryParameters['offset'] = requestParameters['offset'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            queryParameters["api_key"] = await this.configuration.apiKey("api_key"); // api_key authentication
+        }
+
+
+        let urlPath = `/v2/total-energy/data`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * API data with query params
+     */
+    async v2TotalEnergyDataGetRaw(requestParameters: V2TotalEnergyDataGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DataResponseContainer>> {
+        const requestOptions = await this.v2TotalEnergyDataGetRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => DataResponseContainerFromJSON(jsonValue));
+    }
+
+    /**
+     * API data with query params
+     */
+    async v2TotalEnergyDataGet(requestParameters: V2TotalEnergyDataGetRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DataResponseContainer> {
+        const response = await this.v2TotalEnergyDataGetRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for v2TotalEnergyDataPost without sending the request
+     */
+    async v2TotalEnergyDataPostRequestOpts(requestParameters: V2TotalEnergyDataPostRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['dataParams'] == null) {
+            throw new runtime.RequiredError(
+                'dataParams',
+                'Required parameter "dataParams" was null or undefined when calling v2TotalEnergyDataPost().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.apiKey) {
+            queryParameters["api_key"] = await this.configuration.apiKey("api_key"); // api_key authentication
+        }
+
+
+        let urlPath = `/v2/total-energy/data`;
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: DataParamsToJSON(requestParameters['dataParams']),
+        };
+    }
+
+    /**
+     * Class TotalEnergyController  Total Energy controller.
+     * Return Total Energy Data
+     */
+    async v2TotalEnergyDataPostRaw(requestParameters: V2TotalEnergyDataPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DataResponseContainer>> {
+        const requestOptions = await this.v2TotalEnergyDataPostRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => DataResponseContainerFromJSON(jsonValue));
+    }
+
+    /**
+     * Class TotalEnergyController  Total Energy controller.
+     * Return Total Energy Data
+     */
+    async v2TotalEnergyDataPost(requestParameters: V2TotalEnergyDataPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DataResponseContainer> {
+        const response = await this.v2TotalEnergyDataPostRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for v2TotalEnergyFacetFacetIdGet without sending the request
+     */
+    async v2TotalEnergyFacetFacetIdGetRequestOpts(requestParameters: V2TotalEnergyFacetFacetIdGetRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['facetId'] == null) {
+            throw new runtime.RequiredError(
+                'facetId',
+                'Required parameter "facetId" was null or undefined when calling v2TotalEnergyFacetFacetIdGet().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            queryParameters["api_key"] = await this.configuration.apiKey("api_key"); // api_key authentication
+        }
+
+
+        let urlPath = `/v2/total-energy/facet/{facet_id}`;
+        urlPath = urlPath.replace('{facet_id}', encodeURIComponent(String(requestParameters['facetId'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     */
+    async v2TotalEnergyFacetFacetIdGetRaw(requestParameters: V2TotalEnergyFacetFacetIdGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FacetDetailsContainer>> {
+        const requestOptions = await this.v2TotalEnergyFacetFacetIdGetRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => FacetDetailsContainerFromJSON(jsonValue));
+    }
+
+    /**
+     */
+    async v2TotalEnergyFacetFacetIdGet(requestParameters: V2TotalEnergyFacetFacetIdGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FacetDetailsContainer> {
+        const response = await this.v2TotalEnergyFacetFacetIdGetRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for v2TotalEnergyFacetGet without sending the request
+     */
+    async v2TotalEnergyFacetGetRequestOpts(): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            queryParameters["api_key"] = await this.configuration.apiKey("api_key"); // api_key authentication
+        }
+
+
+        let urlPath = `/v2/total-energy/facet`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     */
+    async v2TotalEnergyFacetGetRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FacetOptionListContainer>> {
+        const requestOptions = await this.v2TotalEnergyFacetGetRequestOpts();
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => FacetOptionListContainerFromJSON(jsonValue));
+    }
+
+    /**
+     */
+    async v2TotalEnergyFacetGet(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FacetOptionListContainer> {
+        const response = await this.v2TotalEnergyFacetGetRaw(initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for v2TotalEnergyGet without sending the request
+     */
+    async v2TotalEnergyGetRequestOpts(): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            queryParameters["api_key"] = await this.configuration.apiKey("api_key"); // api_key authentication
+        }
+
+
+        let urlPath = `/v2/total-energy`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     */
+    async v2TotalEnergyGetRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FinalRouteResponseContainer>> {
+        const requestOptions = await this.v2TotalEnergyGetRequestOpts();
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => FinalRouteResponseContainerFromJSON(jsonValue));
+    }
+
+    /**
+     */
+    async v2TotalEnergyGet(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FinalRouteResponseContainer> {
+        const response = await this.v2TotalEnergyGetRaw(initOverrides);
+        return await response.value();
+    }
+
+}

package/apis/index.ts

@@ -0,0 +1,18 @@
+/* tslint:disable */
+/* eslint-disable */
+export * from './AEOApi';
+export * from './COALApi';
+export * from './CRUDIMPORTSApi';
+export * from './DBFApi';
+export * from './ELECApi';
+export * from './EMISSApi';
+export * from './IEOApi';
+export * from './INTLApi';
+export * from './NGApi';
+export * from './NUCSTATUSApi';
+export * from './RTOApi';
+export * from './RootApi';
+export * from './SEDSApi';
+export * from './SEPApi';
+export * from './STEOApi';
+export * from './TOTALApi';