eiagov-typescript-fetch-client 1.0.0

package/apis/NGApi.ts

@@ -0,0 +1,511 @@
+/* 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 V2NaturalGasRoute1GetRequest {
+    route1: string;
+}
+
+export interface V2NaturalGasRoute1Route2DataGetRequest {
+    route1: string;
+    route2: string;
+    data?: Array<string>;
+    facets?: object;
+    frequency?: string;
+    start?: string;
+    end?: string;
+    sort?: Sort;
+    length?: number;
+    offset?: number;
+}
+
+export interface V2NaturalGasRoute1Route2DataPostRequest {
+    route1: string;
+    route2: string;
+    dataParams: DataParams;
+}
+
+export interface V2NaturalGasRoute1Route2FacetFacetIdGetRequest {
+    route1: string;
+    route2: string;
+    facetId: string;
+}
+
+export interface V2NaturalGasRoute1Route2FacetGetRequest {
+    route1: string;
+    route2: string;
+}
+
+export interface V2NaturalGasRoute1Route2GetRequest {
+    route1: string;
+    route2: string;
+}
+
+/**
+ * 
+ */
+export class NGApi extends runtime.BaseAPI {
+
+    /**
+     * Creates request options for v2NaturalGasGet without sending the request
+     */
+    async v2NaturalGasGetRequestOpts(): 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/natural-gas`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     */
+    async v2NaturalGasGetRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RouteResponseContainer>> {
+        const requestOptions = await this.v2NaturalGasGetRequestOpts();
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => RouteResponseContainerFromJSON(jsonValue));
+    }
+
+    /**
+     */
+    async v2NaturalGasGet(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RouteResponseContainer> {
+        const response = await this.v2NaturalGasGetRaw(initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for v2NaturalGasRoute1Get without sending the request
+     */
+    async v2NaturalGasRoute1GetRequestOpts(requestParameters: V2NaturalGasRoute1GetRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['route1'] == null) {
+            throw new runtime.RequiredError(
+                'route1',
+                'Required parameter "route1" was null or undefined when calling v2NaturalGasRoute1Get().'
+            );
+        }
+
+        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/natural-gas/{route1}`;
+        urlPath = urlPath.replace('{route1}', encodeURIComponent(String(requestParameters['route1'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     */
+    async v2NaturalGasRoute1GetRaw(requestParameters: V2NaturalGasRoute1GetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RouteResponseContainer>> {
+        const requestOptions = await this.v2NaturalGasRoute1GetRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => RouteResponseContainerFromJSON(jsonValue));
+    }
+
+    /**
+     */
+    async v2NaturalGasRoute1Get(requestParameters: V2NaturalGasRoute1GetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RouteResponseContainer> {
+        const response = await this.v2NaturalGasRoute1GetRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for v2NaturalGasRoute1Route2DataGet without sending the request
+     */
+    async v2NaturalGasRoute1Route2DataGetRequestOpts(requestParameters: V2NaturalGasRoute1Route2DataGetRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['route1'] == null) {
+            throw new runtime.RequiredError(
+                'route1',
+                'Required parameter "route1" was null or undefined when calling v2NaturalGasRoute1Route2DataGet().'
+            );
+        }
+
+        if (requestParameters['route2'] == null) {
+            throw new runtime.RequiredError(
+                'route2',
+                'Required parameter "route2" was null or undefined when calling v2NaturalGasRoute1Route2DataGet().'
+            );
+        }
+
+        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/natural-gas/{route1}/{route2}/data`;
+        urlPath = urlPath.replace('{route1}', encodeURIComponent(String(requestParameters['route1'])));
+        urlPath = urlPath.replace('{route2}', encodeURIComponent(String(requestParameters['route2'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * API data with query params
+     */
+    async v2NaturalGasRoute1Route2DataGetRaw(requestParameters: V2NaturalGasRoute1Route2DataGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DataResponseContainer>> {
+        const requestOptions = await this.v2NaturalGasRoute1Route2DataGetRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => DataResponseContainerFromJSON(jsonValue));
+    }
+
+    /**
+     * API data with query params
+     */
+    async v2NaturalGasRoute1Route2DataGet(requestParameters: V2NaturalGasRoute1Route2DataGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DataResponseContainer> {
+        const response = await this.v2NaturalGasRoute1Route2DataGetRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for v2NaturalGasRoute1Route2DataPost without sending the request
+     */
+    async v2NaturalGasRoute1Route2DataPostRequestOpts(requestParameters: V2NaturalGasRoute1Route2DataPostRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['route1'] == null) {
+            throw new runtime.RequiredError(
+                'route1',
+                'Required parameter "route1" was null or undefined when calling v2NaturalGasRoute1Route2DataPost().'
+            );
+        }
+
+        if (requestParameters['route2'] == null) {
+            throw new runtime.RequiredError(
+                'route2',
+                'Required parameter "route2" was null or undefined when calling v2NaturalGasRoute1Route2DataPost().'
+            );
+        }
+
+        if (requestParameters['dataParams'] == null) {
+            throw new runtime.RequiredError(
+                'dataParams',
+                'Required parameter "dataParams" was null or undefined when calling v2NaturalGasRoute1Route2DataPost().'
+            );
+        }
+
+        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/natural-gas/{route1}/{route2}/data`;
+        urlPath = urlPath.replace('{route1}', encodeURIComponent(String(requestParameters['route1'])));
+        urlPath = urlPath.replace('{route2}', encodeURIComponent(String(requestParameters['route2'])));
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: DataParamsToJSON(requestParameters['dataParams']),
+        };
+    }
+
+    /**
+     * Return Natural Gas Data
+     */
+    async v2NaturalGasRoute1Route2DataPostRaw(requestParameters: V2NaturalGasRoute1Route2DataPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DataResponseContainer>> {
+        const requestOptions = await this.v2NaturalGasRoute1Route2DataPostRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => DataResponseContainerFromJSON(jsonValue));
+    }
+
+    /**
+     * Return Natural Gas Data
+     */
+    async v2NaturalGasRoute1Route2DataPost(requestParameters: V2NaturalGasRoute1Route2DataPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DataResponseContainer> {
+        const response = await this.v2NaturalGasRoute1Route2DataPostRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for v2NaturalGasRoute1Route2FacetFacetIdGet without sending the request
+     */
+    async v2NaturalGasRoute1Route2FacetFacetIdGetRequestOpts(requestParameters: V2NaturalGasRoute1Route2FacetFacetIdGetRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['route1'] == null) {
+            throw new runtime.RequiredError(
+                'route1',
+                'Required parameter "route1" was null or undefined when calling v2NaturalGasRoute1Route2FacetFacetIdGet().'
+            );
+        }
+
+        if (requestParameters['route2'] == null) {
+            throw new runtime.RequiredError(
+                'route2',
+                'Required parameter "route2" was null or undefined when calling v2NaturalGasRoute1Route2FacetFacetIdGet().'
+            );
+        }
+
+        if (requestParameters['facetId'] == null) {
+            throw new runtime.RequiredError(
+                'facetId',
+                'Required parameter "facetId" was null or undefined when calling v2NaturalGasRoute1Route2FacetFacetIdGet().'
+            );
+        }
+
+        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/natural-gas/{route1}/{route2}/facet/{facet_id}`;
+        urlPath = urlPath.replace('{route1}', encodeURIComponent(String(requestParameters['route1'])));
+        urlPath = urlPath.replace('{route2}', encodeURIComponent(String(requestParameters['route2'])));
+        urlPath = urlPath.replace('{facet_id}', encodeURIComponent(String(requestParameters['facetId'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     */
+    async v2NaturalGasRoute1Route2FacetFacetIdGetRaw(requestParameters: V2NaturalGasRoute1Route2FacetFacetIdGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FacetDetailsContainer>> {
+        const requestOptions = await this.v2NaturalGasRoute1Route2FacetFacetIdGetRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => FacetDetailsContainerFromJSON(jsonValue));
+    }
+
+    /**
+     */
+    async v2NaturalGasRoute1Route2FacetFacetIdGet(requestParameters: V2NaturalGasRoute1Route2FacetFacetIdGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FacetDetailsContainer> {
+        const response = await this.v2NaturalGasRoute1Route2FacetFacetIdGetRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for v2NaturalGasRoute1Route2FacetGet without sending the request
+     */
+    async v2NaturalGasRoute1Route2FacetGetRequestOpts(requestParameters: V2NaturalGasRoute1Route2FacetGetRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['route1'] == null) {
+            throw new runtime.RequiredError(
+                'route1',
+                'Required parameter "route1" was null or undefined when calling v2NaturalGasRoute1Route2FacetGet().'
+            );
+        }
+
+        if (requestParameters['route2'] == null) {
+            throw new runtime.RequiredError(
+                'route2',
+                'Required parameter "route2" was null or undefined when calling v2NaturalGasRoute1Route2FacetGet().'
+            );
+        }
+
+        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/natural-gas/{route1}/{route2}/facet`;
+        urlPath = urlPath.replace('{route1}', encodeURIComponent(String(requestParameters['route1'])));
+        urlPath = urlPath.replace('{route2}', encodeURIComponent(String(requestParameters['route2'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     */
+    async v2NaturalGasRoute1Route2FacetGetRaw(requestParameters: V2NaturalGasRoute1Route2FacetGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FacetOptionListContainer>> {
+        const requestOptions = await this.v2NaturalGasRoute1Route2FacetGetRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => FacetOptionListContainerFromJSON(jsonValue));
+    }
+
+    /**
+     */
+    async v2NaturalGasRoute1Route2FacetGet(requestParameters: V2NaturalGasRoute1Route2FacetGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FacetOptionListContainer> {
+        const response = await this.v2NaturalGasRoute1Route2FacetGetRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for v2NaturalGasRoute1Route2Get without sending the request
+     */
+    async v2NaturalGasRoute1Route2GetRequestOpts(requestParameters: V2NaturalGasRoute1Route2GetRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['route1'] == null) {
+            throw new runtime.RequiredError(
+                'route1',
+                'Required parameter "route1" was null or undefined when calling v2NaturalGasRoute1Route2Get().'
+            );
+        }
+
+        if (requestParameters['route2'] == null) {
+            throw new runtime.RequiredError(
+                'route2',
+                'Required parameter "route2" was null or undefined when calling v2NaturalGasRoute1Route2Get().'
+            );
+        }
+
+        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/natural-gas/{route1}/{route2}`;
+        urlPath = urlPath.replace('{route1}', encodeURIComponent(String(requestParameters['route1'])));
+        urlPath = urlPath.replace('{route2}', encodeURIComponent(String(requestParameters['route2'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     */
+    async v2NaturalGasRoute1Route2GetRaw(requestParameters: V2NaturalGasRoute1Route2GetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FinalRouteResponseContainer>> {
+        const requestOptions = await this.v2NaturalGasRoute1Route2GetRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => FinalRouteResponseContainerFromJSON(jsonValue));
+    }
+
+    /**
+     */
+    async v2NaturalGasRoute1Route2Get(requestParameters: V2NaturalGasRoute1Route2GetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FinalRouteResponseContainer> {
+        const response = await this.v2NaturalGasRoute1Route2GetRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}