eiagov-typescript-fetch-client 1.0.0

package/models/Facet.ts

@@ -0,0 +1,81 @@
+/* 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 Facet
+ */
+export interface Facet {
+    /**
+     * 
+     * @type {string}
+     * @memberof Facet
+     */
+    id?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Facet
+     */
+    name?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Facet
+     */
+    alias?: string;
+}
+
+/**
+ * Check if a given object implements the Facet interface.
+ */
+export function instanceOfFacet(value: object): value is Facet {
+    return true;
+}
+
+export function FacetFromJSON(json: any): Facet {
+    return FacetFromJSONTyped(json, false);
+}
+
+export function FacetFromJSONTyped(json: any, ignoreDiscriminator: boolean): Facet {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'] == null ? undefined : json['id'],
+        'name': json['name'] == null ? undefined : json['name'],
+        'alias': json['alias'] == null ? undefined : json['alias'],
+    };
+}
+
+export function FacetToJSON(json: any): Facet {
+    return FacetToJSONTyped(json, false);
+}
+
+export function FacetToJSONTyped(value?: Facet | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'name': value['name'],
+        'alias': value['alias'],
+    };
+}
+

package/models/FacetDetails.ts

@@ -0,0 +1,81 @@
+/* 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 { Facet } from './Facet';
+import {
+    FacetFromJSON,
+    FacetFromJSONTyped,
+    FacetToJSON,
+    FacetToJSONTyped,
+} from './Facet';
+
+/**
+ * 
+ * @export
+ * @interface FacetDetails
+ */
+export interface FacetDetails {
+    /**
+     * 
+     * @type {number}
+     * @memberof FacetDetails
+     */
+    totalFacets?: number;
+    /**
+     * 
+     * @type {Array<Facet>}
+     * @memberof FacetDetails
+     */
+    facets?: Array<Facet>;
+}
+
+/**
+ * Check if a given object implements the FacetDetails interface.
+ */
+export function instanceOfFacetDetails(value: object): value is FacetDetails {
+    return true;
+}
+
+export function FacetDetailsFromJSON(json: any): FacetDetails {
+    return FacetDetailsFromJSONTyped(json, false);
+}
+
+export function FacetDetailsFromJSONTyped(json: any, ignoreDiscriminator: boolean): FacetDetails {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'totalFacets': json['totalFacets'] == null ? undefined : json['totalFacets'],
+        'facets': json['facets'] == null ? undefined : ((json['facets'] as Array<any>).map(FacetFromJSON)),
+    };
+}
+
+export function FacetDetailsToJSON(json: any): FacetDetails {
+    return FacetDetailsToJSONTyped(json, false);
+}
+
+export function FacetDetailsToJSONTyped(value?: FacetDetails | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'totalFacets': value['totalFacets'],
+        'facets': value['facets'] == null ? undefined : ((value['facets'] as Array<any>).map(FacetToJSON)),
+    };
+}
+

package/models/FacetDetailsContainer.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 { FacetDetails } from './FacetDetails';
+import {
+    FacetDetailsFromJSON,
+    FacetDetailsFromJSONTyped,
+    FacetDetailsToJSON,
+    FacetDetailsToJSONTyped,
+} from './FacetDetails';
+import type { RouteRequest } from './RouteRequest';
+import {
+    RouteRequestFromJSON,
+    RouteRequestFromJSONTyped,
+    RouteRequestToJSON,
+    RouteRequestToJSONTyped,
+} from './RouteRequest';
+
+/**
+ * 
+ * @export
+ * @interface FacetDetailsContainer
+ */
+export interface FacetDetailsContainer {
+    /**
+     * 
+     * @type {string}
+     * @memberof FacetDetailsContainer
+     */
+    apiVersion?: string;
+    /**
+     * 
+     * @type {RouteRequest}
+     * @memberof FacetDetailsContainer
+     */
+    request?: RouteRequest;
+    /**
+     * 
+     * @type {FacetDetails}
+     * @memberof FacetDetailsContainer
+     */
+    response?: FacetDetails;
+}
+
+/**
+ * Check if a given object implements the FacetDetailsContainer interface.
+ */
+export function instanceOfFacetDetailsContainer(value: object): value is FacetDetailsContainer {
+    return true;
+}
+
+export function FacetDetailsContainerFromJSON(json: any): FacetDetailsContainer {
+    return FacetDetailsContainerFromJSONTyped(json, false);
+}
+
+export function FacetDetailsContainerFromJSONTyped(json: any, ignoreDiscriminator: boolean): FacetDetailsContainer {
+    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 : FacetDetailsFromJSON(json['response']),
+    };
+}
+
+export function FacetDetailsContainerToJSON(json: any): FacetDetailsContainer {
+    return FacetDetailsContainerToJSONTyped(json, false);
+}
+
+export function FacetDetailsContainerToJSONTyped(value?: FacetDetailsContainer | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'apiVersion': value['apiVersion'],
+        'request': RouteRequestToJSON(value['request']),
+        'response': FacetDetailsToJSON(value['response']),
+    };
+}
+

package/models/FacetMetaData.ts

@@ -0,0 +1,73 @@
+/* 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 FacetMetaData
+ */
+export interface FacetMetaData {
+    /**
+     * 
+     * @type {string}
+     * @memberof FacetMetaData
+     */
+    id?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof FacetMetaData
+     */
+    description?: string;
+}
+
+/**
+ * Check if a given object implements the FacetMetaData interface.
+ */
+export function instanceOfFacetMetaData(value: object): value is FacetMetaData {
+    return true;
+}
+
+export function FacetMetaDataFromJSON(json: any): FacetMetaData {
+    return FacetMetaDataFromJSONTyped(json, false);
+}
+
+export function FacetMetaDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): FacetMetaData {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'] == null ? undefined : json['id'],
+        'description': json['description'] == null ? undefined : json['description'],
+    };
+}
+
+export function FacetMetaDataToJSON(json: any): FacetMetaData {
+    return FacetMetaDataToJSONTyped(json, false);
+}
+
+export function FacetMetaDataToJSONTyped(value?: FacetMetaData | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'description': value['description'],
+    };
+}
+

package/models/FacetOptionList.ts

@@ -0,0 +1,73 @@
+/* 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 FacetOptionList
+ */
+export interface FacetOptionList {
+    /**
+     * 
+     * @type {number}
+     * @memberof FacetOptionList
+     */
+    totalFacetOptions?: number;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof FacetOptionList
+     */
+    facetOptions?: Array<string>;
+}
+
+/**
+ * Check if a given object implements the FacetOptionList interface.
+ */
+export function instanceOfFacetOptionList(value: object): value is FacetOptionList {
+    return true;
+}
+
+export function FacetOptionListFromJSON(json: any): FacetOptionList {
+    return FacetOptionListFromJSONTyped(json, false);
+}
+
+export function FacetOptionListFromJSONTyped(json: any, ignoreDiscriminator: boolean): FacetOptionList {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'totalFacetOptions': json['totalFacetOptions'] == null ? undefined : json['totalFacetOptions'],
+        'facetOptions': json['facetOptions'] == null ? undefined : json['facetOptions'],
+    };
+}
+
+export function FacetOptionListToJSON(json: any): FacetOptionList {
+    return FacetOptionListToJSONTyped(json, false);
+}
+
+export function FacetOptionListToJSONTyped(value?: FacetOptionList | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'totalFacetOptions': value['totalFacetOptions'],
+        'facetOptions': value['facetOptions'],
+    };
+}
+

package/models/FacetOptionListContainer.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 { FacetOptionList } from './FacetOptionList';
+import {
+    FacetOptionListFromJSON,
+    FacetOptionListFromJSONTyped,
+    FacetOptionListToJSON,
+    FacetOptionListToJSONTyped,
+} from './FacetOptionList';
+import type { RouteRequest } from './RouteRequest';
+import {
+    RouteRequestFromJSON,
+    RouteRequestFromJSONTyped,
+    RouteRequestToJSON,
+    RouteRequestToJSONTyped,
+} from './RouteRequest';
+
+/**
+ * 
+ * @export
+ * @interface FacetOptionListContainer
+ */
+export interface FacetOptionListContainer {
+    /**
+     * 
+     * @type {string}
+     * @memberof FacetOptionListContainer
+     */
+    apiVersion?: string;
+    /**
+     * 
+     * @type {RouteRequest}
+     * @memberof FacetOptionListContainer
+     */
+    request?: RouteRequest;
+    /**
+     * 
+     * @type {FacetOptionList}
+     * @memberof FacetOptionListContainer
+     */
+    response?: FacetOptionList;
+}
+
+/**
+ * Check if a given object implements the FacetOptionListContainer interface.
+ */
+export function instanceOfFacetOptionListContainer(value: object): value is FacetOptionListContainer {
+    return true;
+}
+
+export function FacetOptionListContainerFromJSON(json: any): FacetOptionListContainer {
+    return FacetOptionListContainerFromJSONTyped(json, false);
+}
+
+export function FacetOptionListContainerFromJSONTyped(json: any, ignoreDiscriminator: boolean): FacetOptionListContainer {
+    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 : FacetOptionListFromJSON(json['response']),
+    };
+}
+
+export function FacetOptionListContainerToJSON(json: any): FacetOptionListContainer {
+    return FacetOptionListContainerToJSONTyped(json, false);
+}
+
+export function FacetOptionListContainerToJSONTyped(value?: FacetOptionListContainer | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'apiVersion': value['apiVersion'],
+        'request': RouteRequestToJSON(value['request']),
+        'response': FacetOptionListToJSON(value['response']),
+    };
+}
+

package/models/FinalRoute.ts

@@ -0,0 +1,152 @@
+/* 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 { Frequency } from './Frequency';
+import {
+    FrequencyFromJSON,
+    FrequencyFromJSONTyped,
+    FrequencyToJSON,
+    FrequencyToJSONTyped,
+} from './Frequency';
+import type { FacetMetaData } from './FacetMetaData';
+import {
+    FacetMetaDataFromJSON,
+    FacetMetaDataFromJSONTyped,
+    FacetMetaDataToJSON,
+    FacetMetaDataToJSONTyped,
+} from './FacetMetaData';
+
+/**
+ * 
+ * @export
+ * @interface FinalRoute
+ */
+export interface FinalRoute {
+    /**
+     * 
+     * @type {string}
+     * @memberof FinalRoute
+     */
+    id?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof FinalRoute
+     */
+    name?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof FinalRoute
+     */
+    description?: string;
+    /**
+     * 
+     * @type {Array<Frequency>}
+     * @memberof FinalRoute
+     */
+    frequency?: Array<Frequency>;
+    /**
+     * 
+     * @type {Array<FacetMetaData>}
+     * @memberof FinalRoute
+     */
+    facets?: Array<FacetMetaData>;
+    /**
+     * 
+     * @type {any}
+     * @memberof FinalRoute
+     */
+    data?: any | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof FinalRoute
+     */
+    startPeriod?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof FinalRoute
+     */
+    endPeriod?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof FinalRoute
+     */
+    defaultDateFormat?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof FinalRoute
+     */
+    defaultFrequency?: string;
+}
+
+/**
+ * Check if a given object implements the FinalRoute interface.
+ */
+export function instanceOfFinalRoute(value: object): value is FinalRoute {
+    return true;
+}
+
+export function FinalRouteFromJSON(json: any): FinalRoute {
+    return FinalRouteFromJSONTyped(json, false);
+}
+
+export function FinalRouteFromJSONTyped(json: any, ignoreDiscriminator: boolean): FinalRoute {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'] == null ? undefined : json['id'],
+        'name': json['name'] == null ? undefined : json['name'],
+        'description': json['description'] == null ? undefined : json['description'],
+        'frequency': json['frequency'] == null ? undefined : ((json['frequency'] as Array<any>).map(FrequencyFromJSON)),
+        'facets': json['facets'] == null ? undefined : ((json['facets'] as Array<any>).map(FacetMetaDataFromJSON)),
+        'data': json['data'] == null ? undefined : json['data'],
+        'startPeriod': json['startPeriod'] == null ? undefined : json['startPeriod'],
+        'endPeriod': json['endPeriod'] == null ? undefined : json['endPeriod'],
+        'defaultDateFormat': json['defaultDateFormat'] == null ? undefined : json['defaultDateFormat'],
+        'defaultFrequency': json['defaultFrequency'] == null ? undefined : json['defaultFrequency'],
+    };
+}
+
+export function FinalRouteToJSON(json: any): FinalRoute {
+    return FinalRouteToJSONTyped(json, false);
+}
+
+export function FinalRouteToJSONTyped(value?: FinalRoute | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'name': value['name'],
+        'description': value['description'],
+        'frequency': value['frequency'] == null ? undefined : ((value['frequency'] as Array<any>).map(FrequencyToJSON)),
+        'facets': value['facets'] == null ? undefined : ((value['facets'] as Array<any>).map(FacetMetaDataToJSON)),
+        'data': value['data'],
+        'startPeriod': value['startPeriod'],
+        'endPeriod': value['endPeriod'],
+        'defaultDateFormat': value['defaultDateFormat'],
+        'defaultFrequency': value['defaultFrequency'],
+    };
+}
+