eiagov-typescript-fetch-client 1.0.0

package/apis/IEOApi.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 EIAAPIControllersDatasetAeoIeoIeoControllerConstructRequest {
+    route1: string;
+}
+
+export interface EIAAPIControllersDatasetAeoIeoIeoControllerGetDataRequest {
+    route1: string;
+    data?: Array<string>;
+    facets?: object;
+    frequency?: string;
+    start?: string;
+    end?: string;
+    sort?: Sort;
+    length?: number;
+    offset?: number;
+}
+
+export interface EIAAPIControllersDatasetAeoIeoIeoControllerPostDataRequest {
+    route1: string;
+    dataParams: DataParams;
+}
+
+export interface EIAAPIControllersDatasetAeoIeoIeoControllerRouteFacetRequest {
+    route1: string;
+}
+
+export interface EIAAPIControllersDatasetAeoIeoIeoControllerRouteFacetIdRequest {
+    route1: string;
+    facetId: string;
+}
+
+/**
+ * 
+ */
+export class IEOApi extends runtime.BaseAPI {
+
+    /**
+     * Creates request options for eIAAPIControllersDatasetAeoIeoIeoControllerConstruct without sending the request
+     */
+    async eIAAPIControllersDatasetAeoIeoIeoControllerConstructRequestOpts(requestParameters: EIAAPIControllersDatasetAeoIeoIeoControllerConstructRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['route1'] == null) {
+            throw new runtime.RequiredError(
+                'route1',
+                'Required parameter "route1" was null or undefined when calling eIAAPIControllersDatasetAeoIeoIeoControllerConstruct().'
+            );
+        }
+
+        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/ieo/{route1}`;
+        urlPath = urlPath.replace('{route1}', encodeURIComponent(String(requestParameters['route1'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     */
+    async eIAAPIControllersDatasetAeoIeoIeoControllerConstructRaw(requestParameters: EIAAPIControllersDatasetAeoIeoIeoControllerConstructRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FinalRouteResponseContainer>> {
+        const requestOptions = await this.eIAAPIControllersDatasetAeoIeoIeoControllerConstructRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => FinalRouteResponseContainerFromJSON(jsonValue));
+    }
+
+    /**
+     */
+    async eIAAPIControllersDatasetAeoIeoIeoControllerConstruct(requestParameters: EIAAPIControllersDatasetAeoIeoIeoControllerConstructRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FinalRouteResponseContainer> {
+        const response = await this.eIAAPIControllersDatasetAeoIeoIeoControllerConstructRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for eIAAPIControllersDatasetAeoIeoIeoControllerGetData without sending the request
+     */
+    async eIAAPIControllersDatasetAeoIeoIeoControllerGetDataRequestOpts(requestParameters: EIAAPIControllersDatasetAeoIeoIeoControllerGetDataRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['route1'] == null) {
+            throw new runtime.RequiredError(
+                'route1',
+                'Required parameter "route1" was null or undefined when calling eIAAPIControllersDatasetAeoIeoIeoControllerGetData().'
+            );
+        }
+
+        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/ieo/{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 eIAAPIControllersDatasetAeoIeoIeoControllerGetDataRaw(requestParameters: EIAAPIControllersDatasetAeoIeoIeoControllerGetDataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DataResponseContainer>> {
+        const requestOptions = await this.eIAAPIControllersDatasetAeoIeoIeoControllerGetDataRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => DataResponseContainerFromJSON(jsonValue));
+    }
+
+    /**
+     * API data with query params
+     */
+    async eIAAPIControllersDatasetAeoIeoIeoControllerGetData(requestParameters: EIAAPIControllersDatasetAeoIeoIeoControllerGetDataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DataResponseContainer> {
+        const response = await this.eIAAPIControllersDatasetAeoIeoIeoControllerGetDataRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for eIAAPIControllersDatasetAeoIeoIeoControllerIeo without sending the request
+     */
+    async eIAAPIControllersDatasetAeoIeoIeoControllerIeoRequestOpts(): 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/ieo`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     */
+    async eIAAPIControllersDatasetAeoIeoIeoControllerIeoRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RouteResponseContainer>> {
+        const requestOptions = await this.eIAAPIControllersDatasetAeoIeoIeoControllerIeoRequestOpts();
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => RouteResponseContainerFromJSON(jsonValue));
+    }
+
+    /**
+     */
+    async eIAAPIControllersDatasetAeoIeoIeoControllerIeo(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RouteResponseContainer> {
+        const response = await this.eIAAPIControllersDatasetAeoIeoIeoControllerIeoRaw(initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for eIAAPIControllersDatasetAeoIeoIeoControllerPostData without sending the request
+     */
+    async eIAAPIControllersDatasetAeoIeoIeoControllerPostDataRequestOpts(requestParameters: EIAAPIControllersDatasetAeoIeoIeoControllerPostDataRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['route1'] == null) {
+            throw new runtime.RequiredError(
+                'route1',
+                'Required parameter "route1" was null or undefined when calling eIAAPIControllersDatasetAeoIeoIeoControllerPostData().'
+            );
+        }
+
+        if (requestParameters['dataParams'] == null) {
+            throw new runtime.RequiredError(
+                'dataParams',
+                'Required parameter "dataParams" was null or undefined when calling eIAAPIControllersDatasetAeoIeoIeoControllerPostData().'
+            );
+        }
+
+        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/ieo/{route1}/data`;
+        urlPath = urlPath.replace('{route1}', encodeURIComponent(String(requestParameters['route1'])));
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: DataParamsToJSON(requestParameters['dataParams']),
+        };
+    }
+
+    /**
+     * Return IEO Data
+     */
+    async eIAAPIControllersDatasetAeoIeoIeoControllerPostDataRaw(requestParameters: EIAAPIControllersDatasetAeoIeoIeoControllerPostDataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DataResponseContainer>> {
+        const requestOptions = await this.eIAAPIControllersDatasetAeoIeoIeoControllerPostDataRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => DataResponseContainerFromJSON(jsonValue));
+    }
+
+    /**
+     * Return IEO Data
+     */
+    async eIAAPIControllersDatasetAeoIeoIeoControllerPostData(requestParameters: EIAAPIControllersDatasetAeoIeoIeoControllerPostDataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DataResponseContainer> {
+        const response = await this.eIAAPIControllersDatasetAeoIeoIeoControllerPostDataRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for eIAAPIControllersDatasetAeoIeoIeoControllerRouteFacet without sending the request
+     */
+    async eIAAPIControllersDatasetAeoIeoIeoControllerRouteFacetRequestOpts(requestParameters: EIAAPIControllersDatasetAeoIeoIeoControllerRouteFacetRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['route1'] == null) {
+            throw new runtime.RequiredError(
+                'route1',
+                'Required parameter "route1" was null or undefined when calling eIAAPIControllersDatasetAeoIeoIeoControllerRouteFacet().'
+            );
+        }
+
+        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/ieo/{route1}/facet`;
+        urlPath = urlPath.replace('{route1}', encodeURIComponent(String(requestParameters['route1'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     */
+    async eIAAPIControllersDatasetAeoIeoIeoControllerRouteFacetRaw(requestParameters: EIAAPIControllersDatasetAeoIeoIeoControllerRouteFacetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FacetOptionListContainer>> {
+        const requestOptions = await this.eIAAPIControllersDatasetAeoIeoIeoControllerRouteFacetRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => FacetOptionListContainerFromJSON(jsonValue));
+    }
+
+    /**
+     */
+    async eIAAPIControllersDatasetAeoIeoIeoControllerRouteFacet(requestParameters: EIAAPIControllersDatasetAeoIeoIeoControllerRouteFacetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FacetOptionListContainer> {
+        const response = await this.eIAAPIControllersDatasetAeoIeoIeoControllerRouteFacetRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for eIAAPIControllersDatasetAeoIeoIeoControllerRouteFacetId without sending the request
+     */
+    async eIAAPIControllersDatasetAeoIeoIeoControllerRouteFacetIdRequestOpts(requestParameters: EIAAPIControllersDatasetAeoIeoIeoControllerRouteFacetIdRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['route1'] == null) {
+            throw new runtime.RequiredError(
+                'route1',
+                'Required parameter "route1" was null or undefined when calling eIAAPIControllersDatasetAeoIeoIeoControllerRouteFacetId().'
+            );
+        }
+
+        if (requestParameters['facetId'] == null) {
+            throw new runtime.RequiredError(
+                'facetId',
+                'Required parameter "facetId" was null or undefined when calling eIAAPIControllersDatasetAeoIeoIeoControllerRouteFacetId().'
+            );
+        }
+
+        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/ieo/{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 eIAAPIControllersDatasetAeoIeoIeoControllerRouteFacetIdRaw(requestParameters: EIAAPIControllersDatasetAeoIeoIeoControllerRouteFacetIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FacetDetailsContainer>> {
+        const requestOptions = await this.eIAAPIControllersDatasetAeoIeoIeoControllerRouteFacetIdRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => FacetDetailsContainerFromJSON(jsonValue));
+    }
+
+    /**
+     */
+    async eIAAPIControllersDatasetAeoIeoIeoControllerRouteFacetId(requestParameters: EIAAPIControllersDatasetAeoIeoIeoControllerRouteFacetIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FacetDetailsContainer> {
+        const response = await this.eIAAPIControllersDatasetAeoIeoIeoControllerRouteFacetIdRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}