eiagov-typescript-fetch-client 1.0.0

package/.openapi-generator/FILES

@@ -0,0 +1,73 @@
+.openapi-generator-ignore
+apis/AEOApi.ts
+apis/COALApi.ts
+apis/CRUDIMPORTSApi.ts
+apis/DBFApi.ts
+apis/ELECApi.ts
+apis/EMISSApi.ts
+apis/IEOApi.ts
+apis/INTLApi.ts
+apis/NGApi.ts
+apis/NUCSTATUSApi.ts
+apis/RTOApi.ts
+apis/RootApi.ts
+apis/SEDSApi.ts
+apis/SEPApi.ts
+apis/STEOApi.ts
+apis/TOTALApi.ts
+apis/index.ts
+docs/AEOApi.md
+docs/COALApi.md
+docs/CRUDIMPORTSApi.md
+docs/DBFApi.md
+docs/DataParams.md
+docs/DataResponse.md
+docs/DataResponseContainer.md
+docs/ELECApi.md
+docs/EMISSApi.md
+docs/Facet.md
+docs/FacetDetails.md
+docs/FacetDetailsContainer.md
+docs/FacetMetaData.md
+docs/FacetOptionList.md
+docs/FacetOptionListContainer.md
+docs/FinalRoute.md
+docs/FinalRouteResponse.md
+docs/FinalRouteResponseContainer.md
+docs/Frequency.md
+docs/IEOApi.md
+docs/INTLApi.md
+docs/NGApi.md
+docs/NUCSTATUSApi.md
+docs/RTOApi.md
+docs/RootApi.md
+docs/RouteRequest.md
+docs/RouteResponse.md
+docs/RouteResponseContainer.md
+docs/Routes.md
+docs/SEDSApi.md
+docs/SEPApi.md
+docs/STEOApi.md
+docs/Sort.md
+docs/TOTALApi.md
+index.ts
+models/DataParams.ts
+models/DataResponse.ts
+models/DataResponseContainer.ts
+models/Facet.ts
+models/FacetDetails.ts
+models/FacetDetailsContainer.ts
+models/FacetMetaData.ts
+models/FacetOptionList.ts
+models/FacetOptionListContainer.ts
+models/FinalRoute.ts
+models/FinalRouteResponse.ts
+models/FinalRouteResponseContainer.ts
+models/Frequency.ts
+models/RouteRequest.ts
+models/RouteResponse.ts
+models/RouteResponseContainer.ts
+models/Routes.ts
+models/Sort.ts
+models/index.ts
+runtime.ts

package/.openapi-generator/VERSION

@@ -0,0 +1 @@
+7.22.0

package/.openapi-generator-ignore

@@ -0,0 +1,23 @@
+# OpenAPI Generator Ignore
+# Generated by openapi-generator https://github.com/openapitools/openapi-generator
+
+# Use this file to prevent files from being overwritten by the generator.
+# The patterns follow closely to .gitignore or .dockerignore.
+
+# As an example, the C# client generator defines ApiClient.cs.
+# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
+#ApiClient.cs
+
+# You can match any string of characters against a directory, file or extension with a single asterisk (*):
+#foo/*/qux
+# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
+
+# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
+#foo/**/qux
+# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
+
+# You can also negate patterns with an exclamation (!).
+# For example, you can ignore all files in a docs folder with the file extension .md:
+#docs/*.md
+# Then explicitly reverse the ignore rule for a single file:
+#!docs/README.md

package/apis/AEOApi.ts

@@ -0,0 +1,415 @@
+/* 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 RouteResponseContainer,
+    RouteResponseContainerFromJSON,
+    RouteResponseContainerToJSON,
+} from '../models/RouteResponseContainer';
+import {
+    type Sort,
+    SortFromJSON,
+    SortToJSON,
+} from '../models/Sort';
+
+export interface V2AeoRoute1DataGetRequest {
+    route1: string;
+    data?: Array<string>;
+    facets?: object;
+    frequency?: string;
+    start?: string;
+    end?: string;
+    sort?: Sort;
+    length?: number;
+    offset?: number;
+}
+
+export interface V2AeoRoute1DataPostRequest {
+    route1: string;
+    dataParams: DataParams;
+}
+
+export interface V2AeoRoute1FacetFacetIdGetRequest {
+    route1: string;
+    facetId: string;
+}
+
+export interface V2AeoRoute1FacetGetRequest {
+    route1: string;
+}
+
+export interface V2AeoRoute1GetRequest {
+    route1: string;
+}
+
+/**
+ * 
+ */
+export class AEOApi extends runtime.BaseAPI {
+
+    /**
+     * Creates request options for v2AeoGet without sending the request
+     */
+    async v2AeoGetRequestOpts(): 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/aeo`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     */
+    async v2AeoGetRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RouteResponseContainer>> {
+        const requestOptions = await this.v2AeoGetRequestOpts();
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => RouteResponseContainerFromJSON(jsonValue));
+    }
+
+    /**
+     */
+    async v2AeoGet(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RouteResponseContainer> {
+        const response = await this.v2AeoGetRaw(initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for v2AeoRoute1DataGet without sending the request
+     */
+    async v2AeoRoute1DataGetRequestOpts(requestParameters: V2AeoRoute1DataGetRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['route1'] == null) {
+            throw new runtime.RequiredError(
+                'route1',
+                'Required parameter "route1" was null or undefined when calling v2AeoRoute1DataGet().'
+            );
+        }
+
+        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/aeo/{route1}/data`;
+        urlPath = urlPath.replace('{route1}', encodeURIComponent(String(requestParameters['route1'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * API data with query params
+     */
+    async v2AeoRoute1DataGetRaw(requestParameters: V2AeoRoute1DataGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DataResponseContainer>> {
+        const requestOptions = await this.v2AeoRoute1DataGetRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => DataResponseContainerFromJSON(jsonValue));
+    }
+
+    /**
+     * API data with query params
+     */
+    async v2AeoRoute1DataGet(requestParameters: V2AeoRoute1DataGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DataResponseContainer> {
+        const response = await this.v2AeoRoute1DataGetRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for v2AeoRoute1DataPost without sending the request
+     */
+    async v2AeoRoute1DataPostRequestOpts(requestParameters: V2AeoRoute1DataPostRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['route1'] == null) {
+            throw new runtime.RequiredError(
+                'route1',
+                'Required parameter "route1" was null or undefined when calling v2AeoRoute1DataPost().'
+            );
+        }
+
+        if (requestParameters['dataParams'] == null) {
+            throw new runtime.RequiredError(
+                'dataParams',
+                'Required parameter "dataParams" was null or undefined when calling v2AeoRoute1DataPost().'
+            );
+        }
+
+        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/aeo/{route1}/data`;
+        urlPath = urlPath.replace('{route1}', encodeURIComponent(String(requestParameters['route1'])));
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: DataParamsToJSON(requestParameters['dataParams']),
+        };
+    }
+
+    /**
+     * Return AEO Data
+     */
+    async v2AeoRoute1DataPostRaw(requestParameters: V2AeoRoute1DataPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DataResponseContainer>> {
+        const requestOptions = await this.v2AeoRoute1DataPostRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => DataResponseContainerFromJSON(jsonValue));
+    }
+
+    /**
+     * Return AEO Data
+     */
+    async v2AeoRoute1DataPost(requestParameters: V2AeoRoute1DataPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DataResponseContainer> {
+        const response = await this.v2AeoRoute1DataPostRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for v2AeoRoute1FacetFacetIdGet without sending the request
+     */
+    async v2AeoRoute1FacetFacetIdGetRequestOpts(requestParameters: V2AeoRoute1FacetFacetIdGetRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['route1'] == null) {
+            throw new runtime.RequiredError(
+                'route1',
+                'Required parameter "route1" was null or undefined when calling v2AeoRoute1FacetFacetIdGet().'
+            );
+        }
+
+        if (requestParameters['facetId'] == null) {
+            throw new runtime.RequiredError(
+                'facetId',
+                'Required parameter "facetId" was null or undefined when calling v2AeoRoute1FacetFacetIdGet().'
+            );
+        }
+
+        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/aeo/{route1}/facet/{facet_id}`;
+        urlPath = urlPath.replace('{route1}', encodeURIComponent(String(requestParameters['route1'])));
+        urlPath = urlPath.replace('{facet_id}', encodeURIComponent(String(requestParameters['facetId'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     */
+    async v2AeoRoute1FacetFacetIdGetRaw(requestParameters: V2AeoRoute1FacetFacetIdGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FacetDetailsContainer>> {
+        const requestOptions = await this.v2AeoRoute1FacetFacetIdGetRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => FacetDetailsContainerFromJSON(jsonValue));
+    }
+
+    /**
+     */
+    async v2AeoRoute1FacetFacetIdGet(requestParameters: V2AeoRoute1FacetFacetIdGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FacetDetailsContainer> {
+        const response = await this.v2AeoRoute1FacetFacetIdGetRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for v2AeoRoute1FacetGet without sending the request
+     */
+    async v2AeoRoute1FacetGetRequestOpts(requestParameters: V2AeoRoute1FacetGetRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['route1'] == null) {
+            throw new runtime.RequiredError(
+                'route1',
+                'Required parameter "route1" was null or undefined when calling v2AeoRoute1FacetGet().'
+            );
+        }
+
+        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/aeo/{route1}/facet`;
+        urlPath = urlPath.replace('{route1}', encodeURIComponent(String(requestParameters['route1'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     */
+    async v2AeoRoute1FacetGetRaw(requestParameters: V2AeoRoute1FacetGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FacetOptionListContainer>> {
+        const requestOptions = await this.v2AeoRoute1FacetGetRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => FacetOptionListContainerFromJSON(jsonValue));
+    }
+
+    /**
+     */
+    async v2AeoRoute1FacetGet(requestParameters: V2AeoRoute1FacetGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FacetOptionListContainer> {
+        const response = await this.v2AeoRoute1FacetGetRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for v2AeoRoute1Get without sending the request
+     */
+    async v2AeoRoute1GetRequestOpts(requestParameters: V2AeoRoute1GetRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['route1'] == null) {
+            throw new runtime.RequiredError(
+                'route1',
+                'Required parameter "route1" was null or undefined when calling v2AeoRoute1Get().'
+            );
+        }
+
+        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/aeo/{route1}`;
+        urlPath = urlPath.replace('{route1}', encodeURIComponent(String(requestParameters['route1'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     */
+    async v2AeoRoute1GetRaw(requestParameters: V2AeoRoute1GetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FinalRouteResponseContainer>> {
+        const requestOptions = await this.v2AeoRoute1GetRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => FinalRouteResponseContainerFromJSON(jsonValue));
+    }
+
+    /**
+     */
+    async v2AeoRoute1Get(requestParameters: V2AeoRoute1GetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FinalRouteResponseContainer> {
+        const response = await this.v2AeoRoute1GetRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}