/**
* weather.gov API
* weather.gov API
*
* OpenAPI spec version: 1.8.5
*
*
* NOTE: This file is auto generated by the swagger code generator program.
* https://github.com/swagger-api/swagger-codegen.git
* Do not edit the file manually.
*/
///
import "isomorphic-fetch";
import { Configuration } from "./configuration";
/**
*
* @export
*/
export declare const COLLECTION_FORMATS: {
csv: string;
ssv: string;
tsv: string;
pipes: string;
};
/**
*
* @export
* @interface FetchAPI
*/
export interface FetchAPI {
(url: string, init?: any): Promise;
}
/**
*
* @export
* @interface FetchArgs
*/
export interface FetchArgs {
url: string;
options: any;
}
/**
*
* @export
* @class BaseAPI
*/
export declare class BaseAPI {
protected basePath: string;
protected fetch: FetchAPI;
protected configuration: Configuration;
constructor(configuration?: Configuration, basePath?: string, fetch?: FetchAPI);
}
/**
*
* @export
* @class RequiredError
* @extends {Error}
*/
export declare class RequiredError extends Error {
field: string;
name: "RequiredError";
constructor(field: string, msg?: string);
}
/**
* An object representing a public alert message. Unless otherwise noted, the fields in this object correspond to the National Weather Service CAP v1.2 specification, which extends the OASIS Common Alerting Protocol (CAP) v1.2 specification and USA Integrated Public Alert and Warning System (IPAWS) Profile v1.0. Refer to this documentation for more complete information. http://docs.oasis-open.org/emergency/cap/v1.2/CAP-v1.2-os.html http://docs.oasis-open.org/emergency/cap/v1.2/ipaws-profile/v1.0/cs01/cap-v1.2-ipaws-profile-cs01.html https://alerts.weather.gov/#technical-notes-v12
* @export
* @interface Alert
*/
export interface Alert {
/**
*
* @type {AlertId}
* @memberof Alert
*/
id?: AlertId;
/**
* A textual description of the area affected by the alert.
* @type {string}
* @memberof Alert
*/
areaDesc?: string;
/**
*
* @type {AlertGeocode}
* @memberof Alert
*/
geocode?: AlertGeocode;
/**
* An array of API links for zones affected by the alert. This is an API-specific extension field and is not part of the CAP specification.
* @type {Array}
* @memberof Alert
*/
affectedZones?: Array;
/**
* A list of prior alerts that this alert updates or replaces.
* @type {Array}
* @memberof Alert
*/
references?: Array;
/**
* The time of the origination of the alert message.
* @type {Date}
* @memberof Alert
*/
sent?: Date;
/**
* The effective time of the information of the alert message.
* @type {Date}
* @memberof Alert
*/
effective?: Date;
/**
* The expected time of the beginning of the subject event of the alert message.
* @type {Date}
* @memberof Alert
*/
onset?: Date;
/**
* The expiry time of the information of the alert message.
* @type {Date}
* @memberof Alert
*/
expires?: Date;
/**
* The expected end time of the subject event of the alert message.
* @type {Date}
* @memberof Alert
*/
ends?: Date;
/**
*
* @type {AlertStatus}
* @memberof Alert
*/
status?: AlertStatus;
/**
*
* @type {AlertMessageType}
* @memberof Alert
*/
messageType?: AlertMessageType;
/**
* The code denoting the category of the subject event of the alert message.
* @type {string}
* @memberof Alert
*/
category?: Alert.CategoryEnum;
/**
*
* @type {AlertSeverity}
* @memberof Alert
*/
severity?: AlertSeverity;
/**
*
* @type {AlertCertainty}
* @memberof Alert
*/
certainty?: AlertCertainty;
/**
*
* @type {AlertUrgency}
* @memberof Alert
*/
urgency?: AlertUrgency;
/**
* The text denoting the type of the subject event of the alert message.
* @type {string}
* @memberof Alert
*/
event?: string;
/**
* Email address of the NWS webmaster.
* @type {string}
* @memberof Alert
*/
sender?: string;
/**
* The text naming the originator of the alert message.
* @type {string}
* @memberof Alert
*/
senderName?: string;
/**
* The text headline of the alert message.
* @type {string}
* @memberof Alert
*/
headline?: string;
/**
* The text describing the subject event of the alert message.
* @type {string}
* @memberof Alert
*/
description?: string;
/**
* The text describing the recommended action to be taken by recipients of the alert message.
* @type {string}
* @memberof Alert
*/
instruction?: string;
/**
* The code denoting the type of action recommended for the target audience. This corresponds to responseType in the CAP specification.
* @type {string}
* @memberof Alert
*/
response?: Alert.ResponseEnum;
/**
* System-specific additional parameters associated with the alert message. The keys in this object correspond to parameter definitions in the NWS CAP specification.
* @type {{ [key: string]: Array; }}
* @memberof Alert
*/
parameters?: {
[key: string]: Array;
};
}
/**
* @export
* @namespace Alert
*/
export declare namespace Alert {
/**
* @export
* @enum {string}
*/
enum CategoryEnum {
Met,
Geo,
Safety,
Security,
Rescue,
Fire,
Health,
Env,
Transport,
Infra,
CBRNE,
Other
}
/**
* @export
* @enum {string}
*/
enum ResponseEnum {
Shelter,
Evacuate,
Prepare,
Execute,
Avoid,
Monitor,
Assess,
AllClear,
None
}
}
/**
* An alert entry in an Atom feed
* @export
* @interface AlertAtomEntry
*/
export interface AlertAtomEntry {
/**
*
* @type {string}
* @memberof AlertAtomEntry
*/
id?: string;
/**
*
* @type {string}
* @memberof AlertAtomEntry
*/
updated?: string;
/**
*
* @type {string}
* @memberof AlertAtomEntry
*/
published?: string;
/**
*
* @type {AlertAtomEntryAuthor}
* @memberof AlertAtomEntry
*/
author?: AlertAtomEntryAuthor;
/**
*
* @type {string}
* @memberof AlertAtomEntry
*/
summary?: string;
/**
*
* @type {string}
* @memberof AlertAtomEntry
*/
event?: string;
/**
*
* @type {string}
* @memberof AlertAtomEntry
*/
sent?: string;
/**
*
* @type {string}
* @memberof AlertAtomEntry
*/
effective?: string;
/**
*
* @type {string}
* @memberof AlertAtomEntry
*/
expires?: string;
/**
*
* @type {string}
* @memberof AlertAtomEntry
*/
status?: string;
/**
*
* @type {string}
* @memberof AlertAtomEntry
*/
msgType?: string;
/**
*
* @type {string}
* @memberof AlertAtomEntry
*/
category?: string;
/**
*
* @type {string}
* @memberof AlertAtomEntry
*/
urgency?: string;
/**
*
* @type {string}
* @memberof AlertAtomEntry
*/
severity?: string;
/**
*
* @type {string}
* @memberof AlertAtomEntry
*/
certainty?: string;
/**
*
* @type {string}
* @memberof AlertAtomEntry
*/
areaDesc?: string;
/**
*
* @type {string}
* @memberof AlertAtomEntry
*/
polygon?: string;
/**
*
* @type {Array}
* @memberof AlertAtomEntry
*/
geocode?: Array;
/**
*
* @type {Array}
* @memberof AlertAtomEntry
*/
parameter?: Array;
}
/**
*
* @export
* @interface AlertAtomEntryAuthor
*/
export interface AlertAtomEntryAuthor {
/**
*
* @type {string}
* @memberof AlertAtomEntryAuthor
*/
name?: string;
}
/**
* An alert feed in Atom format
* @export
* @interface AlertAtomFeed
*/
export interface AlertAtomFeed {
/**
*
* @type {string}
* @memberof AlertAtomFeed
*/
id?: string;
/**
*
* @type {string}
* @memberof AlertAtomFeed
*/
generator?: string;
/**
*
* @type {string}
* @memberof AlertAtomFeed
*/
updated?: string;
/**
*
* @type {AlertAtomFeedAuthor}
* @memberof AlertAtomFeed
*/
author?: AlertAtomFeedAuthor;
/**
*
* @type {string}
* @memberof AlertAtomFeed
*/
title?: string;
/**
*
* @type {Array}
* @memberof AlertAtomFeed
*/
entry?: Array;
}
/**
*
* @export
* @interface AlertAtomFeedAuthor
*/
export interface AlertAtomFeedAuthor {
/**
*
* @type {string}
* @memberof AlertAtomFeedAuthor
*/
name?: string;
}
/**
*
* @export
* @interface AlertCap
*/
export interface AlertCap {
}
/**
*
* @export
* @enum {string}
*/
export declare enum AlertCertainty {
Observed,
Likely,
Possible,
Unlikely,
Unknown
}
/**
*
* @export
* @interface AlertCollection
*/
export interface AlertCollection {
/**
* A title describing the alert collection
* @type {string}
* @memberof AlertCollection
*/
title?: string;
/**
* The last time a change occurred to this collection
* @type {Date}
* @memberof AlertCollection
*/
updated?: Date;
/**
*
* @type {AlertCollectionPagination}
* @memberof AlertCollection
*/
pagination?: AlertCollectionPagination;
}
/**
*
* @export
* @interface AlertCollectionGeoJson
*/
export interface AlertCollectionGeoJson extends GeoJsonFeatureCollection {
/**
* A title describing the alert collection
* @type {string}
* @memberof AlertCollectionGeoJson
*/
title?: string;
/**
* The last time a change occurred to this collection
* @type {Date}
* @memberof AlertCollectionGeoJson
*/
updated?: Date;
/**
*
* @type {AlertCollectionPagination}
* @memberof AlertCollectionGeoJson
*/
pagination?: AlertCollectionPagination;
/**
*
* @type {Array}
* @memberof AlertCollectionGeoJson
*/
features: Array;
}
/**
*
* @export
* @interface AlertCollectionJsonLd
*/
export interface AlertCollectionJsonLd extends AlertCollection {
/**
*
* @type {JsonLdContext}
* @memberof AlertCollectionJsonLd
*/
context?: JsonLdContext;
/**
*
* @type {Array}
* @memberof AlertCollectionJsonLd
*/
graph?: Array;
}
/**
* Links for retrieving more data
* @export
* @interface AlertCollectionPagination
*/
export interface AlertCollectionPagination {
/**
* A link to the next set of alerts
* @type {string}
* @memberof AlertCollectionPagination
*/
next: string;
}
/**
*
* @export
* @interface AlertGeoJson
*/
export interface AlertGeoJson extends GeoJsonFeature {
/**
*
* @type {Alert}
* @memberof AlertGeoJson
*/
properties: Alert;
}
/**
* @export
* @namespace AlertGeoJson
*/
export declare namespace AlertGeoJson { }
/**
* Lists of codes for NWS public zones and counties affected by the alert.
* @export
* @interface AlertGeocode
*/
export interface AlertGeocode {
/**
* A list of NWS public zone or county identifiers.
* @type {Array}
* @memberof AlertGeocode
*/
UGC?: Array;
/**
* A list of SAME (Specific Area Message Encoding) codes for affected counties.
* @type {Array}
* @memberof AlertGeocode
*/
SAME?: Array;
}
/**
* The identifier of the alert message.
* @export
*/
export declare type AlertId = string;
/**
*
* @export
* @interface AlertJsonLd
*/
export interface AlertJsonLd {
/**
*
* @type {Array}
* @memberof AlertJsonLd
*/
graph?: Array;
}
/**
*
* @export
* @enum {string}
*/
export declare enum AlertMessageType {
Alert,
Update,
Cancel,
Ack,
Error
}
/**
*
* @export
* @interface AlertReferences
*/
export interface AlertReferences {
/**
* An API link to the prior alert.
* @type {string}
* @memberof AlertReferences
*/
id?: string;
/**
*
* @type {AlertId}
* @memberof AlertReferences
*/
identifier?: AlertId;
/**
* The sender of the prior alert.
* @type {string}
* @memberof AlertReferences
*/
sender?: string;
/**
* The time the prior alert was sent.
* @type {Date}
* @memberof AlertReferences
*/
sent?: Date;
}
/**
*
* @export
* @enum {string}
*/
export declare enum AlertSeverity {
Extreme,
Severe,
Moderate,
Minor,
Unknown
}
/**
*
* @export
* @enum {string}
*/
export declare enum AlertStatus {
Actual,
Exercise,
System,
Test,
Draft
}
/**
*
* @export
* @enum {string}
*/
export declare enum AlertUrgency {
Immediate,
Expected,
Future,
Past,
Unknown
}
/**
*
* @export
* @interface AlertXMLParameter
*/
export interface AlertXMLParameter {
/**
*
* @type {string}
* @memberof AlertXMLParameter
*/
valueName?: string;
/**
*
* @type {string}
* @memberof AlertXMLParameter
*/
value?: string;
}
/**
* State/territory codes and marine area codes
* @export
* @interface AreaCode
*/
export declare type AreaCode = StateTerritoryCode | MarineAreaCode;
/**
*
* @export
*/
export declare type BinaryFile = string;
/**
* A GeoJSON bounding box. Please refer to IETF RFC 7946 for information on the GeoJSON format.
* @export
*/
export declare type GeoJsonBoundingBox = Array;
/**
* A GeoJSON coordinate. Please refer to IETF RFC 7946 for information on the GeoJSON format.
* @export
*/
export declare type GeoJsonCoordinate = Array;
/**
* A GeoJSON feature. Please refer to IETF RFC 7946 for information on the GeoJSON format.
* @export
* @interface GeoJsonFeature
*/
export interface GeoJsonFeature {
/**
*
* @type {JsonLdContext}
* @memberof GeoJsonFeature
*/
context?: JsonLdContext;
/**
*
* @type {string}
* @memberof GeoJsonFeature
*/
id?: string;
/**
*
* @type {string}
* @memberof GeoJsonFeature
*/
type: GeoJsonFeature.TypeEnum;
/**
*
* @type {GeoJsonGeometry}
* @memberof GeoJsonFeature
*/
geometry: GeoJsonGeometry;
/**
*
* @type {any}
* @memberof GeoJsonFeature
*/
properties: any;
}
/**
* @export
* @namespace GeoJsonFeature
*/
export declare namespace GeoJsonFeature {
/**
* @export
* @enum {string}
*/
enum TypeEnum {
Feature
}
}
/**
* A GeoJSON feature collection. Please refer to IETF RFC 7946 for information on the GeoJSON format.
* @export
* @interface GeoJsonFeatureCollection
*/
export interface GeoJsonFeatureCollection {
/**
*
* @type {JsonLdContext}
* @memberof GeoJsonFeatureCollection
*/
context?: JsonLdContext;
/**
*
* @type {string}
* @memberof GeoJsonFeatureCollection
*/
type: GeoJsonFeatureCollection.TypeEnum;
/**
*
* @type {Array}
* @memberof GeoJsonFeatureCollection
*/
features: Array;
}
/**
* @export
* @namespace GeoJsonFeatureCollection
*/
export declare namespace GeoJsonFeatureCollection {
/**
* @export
* @enum {string}
*/
enum TypeEnum {
FeatureCollection
}
}
/**
* A GeoJSON geometry object. Please refer to IETF RFC 7946 for information on the GeoJSON format.
* @export
* @interface GeoJsonGeometry
*/
export interface GeoJsonGeometry {
}
/**
* A GeoJSON line string. Please refer to IETF RFC 7946 for information on the GeoJSON format.
* @export
*/
export declare type GeoJsonLineString = Array;
/**
* A GeoJSON polygon. Please refer to IETF RFC 7946 for information on the GeoJSON format.
* @export
*/
export declare type GeoJsonPolygon = Array;
/**
* A geometry represented in Well-Known Text (WKT) format.
* @export
*/
export declare type GeometryString = string;
/**
* Raw forecast data for a 2.5km grid square. This is a list of all potential data layers that may appear. Some layers may not be present in all areas. * temperature * dewpoint * maxTemperature * minTemperature * relativeHumidity * apparentTemperature * heatIndex * windChill * skyCover * windDirection * windSpeed * windGust * weather * hazards: Watch and advisory products in effect * probabilityOfPrecipitation * quantitativePrecipitation * iceAccumulation * snowfallAmount * snowLevel * ceilingHeight * visibility * transportWindSpeed * transportWindDirection * mixingHeight * hainesIndex * lightningActivityLevel * twentyFootWindSpeed * twentyFootWindDirection * waveHeight * wavePeriod * waveDirection * primarySwellHeight * primarySwellDirection * secondarySwellHeight * secondarySwellDirection * wavePeriod2 * windWaveHeight * dispersionIndex * pressure: Barometric pressure * probabilityOfTropicalStormWinds * probabilityOfHurricaneWinds * potentialOf15mphWinds * potentialOf25mphWinds * potentialOf35mphWinds * potentialOf45mphWinds * potentialOf20mphWindGusts * potentialOf30mphWindGusts * potentialOf40mphWindGusts * potentialOf50mphWindGusts * potentialOf60mphWindGusts * grasslandFireDangerIndex * probabilityOfThunder * davisStabilityIndex * atmosphericDispersionIndex * lowVisibilityOccurrenceRiskIndex * stability * redFlagThreatIndex
* @export
* @interface Gridpoint
*/
export interface Gridpoint {
"@context": JsonLdContext;
geometry: GeometryString;
"@id": string;
"@type": any;
updateTime: string;
validTimes: ISO8601Interval;
elevation: QuantitativeValue;
forecastOffice: string;
gridId: string;
gridX: number;
gridY: number;
weather: GridpointWeatherValues;
hazards: GridpointHazardsValues;
}
/**
* A multi-day forecast for a 2.5km grid square.
* @export
* @interface GridpointForecast
*/
export interface GridpointForecast {
/**
*
* @type {JsonLdContext}
* @memberof GridpointForecast
*/
context?: JsonLdContext;
/**
*
* @type {GeometryString}
* @memberof GridpointForecast
*/
geometry?: GeometryString;
/**
*
* @type {GridpointForecastUnits}
* @memberof GridpointForecast
*/
units?: GridpointForecastUnits;
/**
* The internal generator class used to create the forecast text (used for NWS debugging).
* @type {string}
* @memberof GridpointForecast
*/
forecastGenerator?: string;
/**
* The time this forecast data was generated.
* @type {Date}
* @memberof GridpointForecast
*/
generatedAt?: Date;
/**
* The last update time of the data this forecast was generated from.
* @type {Date}
* @memberof GridpointForecast
*/
updateTime?: Date;
/**
* This property is deprecated (use updateTime instead).
* @type {Date}
* @memberof GridpointForecast
*/
updated?: Date;
/**
*
* @type {ISO8601Interval}
* @memberof GridpointForecast
*/
validTimes?: ISO8601Interval;
/**
*
* @type {QuantitativeValue}
* @memberof GridpointForecast
*/
elevation?: QuantitativeValue;
/**
* An array of forecast periods.
* @type {Array}
* @memberof GridpointForecast
*/
periods?: Array;
}
/**
*
* @export
* @interface GridpointForecastGeoJson
*/
export interface GridpointForecastGeoJson extends GeoJsonFeature {
/**
*
* @type {GridpointForecast}
* @memberof GridpointForecastGeoJson
*/
properties: GridpointForecast;
}
/**
* @export
* @namespace GridpointForecastGeoJson
*/
export declare namespace GridpointForecastGeoJson { }
/**
*
* @export
* @interface GridpointForecastJsonLd
*/
export interface GridpointForecastJsonLd extends GridpointForecast {
/**
*
* @type {JsonLdContext}
* @memberof GridpointForecastJsonLd
*/
context: JsonLdContext;
/**
*
* @type {GeometryString}
* @memberof GridpointForecastJsonLd
*/
geometry: GeometryString;
}
/**
* An object containing forecast information for a specific time period (generally 12-hour or 1-hour).
* @export
* @interface GridpointForecastPeriod
*/
export interface GridpointForecastPeriod {
/**
* Sequential period number.
* @type {number}
* @memberof GridpointForecastPeriod
*/
number?: number;
/**
* A textual identifier for the period. This value will not be present for hourly forecasts.
* @type {string}
* @memberof GridpointForecastPeriod
*/
name?: string;
/**
* The starting time that this forecast period is valid for.
* @type {Date}
* @memberof GridpointForecastPeriod
*/
startTime?: Date;
/**
* The ending time that this forecast period is valid for.
* @type {Date}
* @memberof GridpointForecastPeriod
*/
endTime?: Date;
/**
* Indicates whether this period is daytime or nighttime.
* @type {boolean}
* @memberof GridpointForecastPeriod
*/
isDaytime?: boolean;
/**
* High/low temperature for the period, depending on whether the period is day or night. This property as an integer value is deprecated. Future versions will express this value as a quantitative value object. To make use of the future standard format now, set the \"forecast_temperature_qv\" feature flag on the request.
* @type {QuantitativeValue | number}
* @memberof GridpointForecastPeriod
*/
temperature?: QuantitativeValue | number;
/**
* The unit of the temperature value (Fahrenheit or Celsius). This property is deprecated. Future versions will indicate the unit within the quantitative value object for the temperature property. To make use of the future standard format now, set the \"forecast_temperature_qv\" feature flag on the request.
* @type {string}
* @memberof GridpointForecastPeriod
*/
temperatureUnit?: GridpointForecastPeriod.TemperatureUnitEnum;
/**
* If not null, indicates a non-diurnal temperature trend for the period (either rising temperature overnight, or falling temperature during the day)
* @type {string}
* @memberof GridpointForecastPeriod
*/
temperatureTrend?: GridpointForecastPeriod.TemperatureTrendEnum;
/**
* Wind speed for the period. This property as an string value is deprecated. Future versions will express this value as a quantitative value object. To make use of the future standard format now, set the \"forecast_wind_speed_qv\" feature flag on the request.
* @type {QuantitativeValue | string}
* @memberof GridpointForecastPeriod
*/
windSpeed?: QuantitativeValue | string;
/**
* Peak wind gust for the period. This property as an string value is deprecated. Future versions will express this value as a quantitative value object. To make use of the future standard format now, set the \"forecast_wind_speed_qv\" feature flag on the request.
* @type {QuantitativeValue | string}
* @memberof GridpointForecastPeriod
*/
windGust?: QuantitativeValue | string;
/**
* The prevailing direction of the wind for the period, using a 16-point compass.
* @type {string}
* @memberof GridpointForecastPeriod
*/
windDirection?: GridpointForecastPeriod.WindDirectionEnum;
/**
* A link to an icon representing the forecast summary.
* @type {string}
* @memberof GridpointForecastPeriod
*/
icon?: string;
/**
* A brief textual forecast summary for the period.
* @type {string}
* @memberof GridpointForecastPeriod
*/
shortForecast?: string;
/**
* A detailed textual forecast for the period.
* @type {string}
* @memberof GridpointForecastPeriod
*/
detailedForecast?: string;
}
/**
* @export
* @namespace GridpointForecastPeriod
*/
export declare namespace GridpointForecastPeriod {
/**
* @export
* @enum {string}
*/
enum TemperatureUnitEnum {
F,
C
}
/**
* @export
* @enum {string}
*/
enum TemperatureTrendEnum {
Rising,
Falling
}
/**
* @export
* @enum {string}
*/
enum WindDirectionEnum {
N,
NNE,
NE,
ENE,
E,
ESE,
SE,
SSE,
S,
SSW,
SW,
WSW,
W,
WNW,
NW,
NNW
}
}
/**
* Denotes the units used in the textual portions of the forecast.
* @export
* @enum {string}
*/
export declare enum GridpointForecastUnits {
Us,
Si
}
/**
*
* @export
* @interface GridpointGeoJson
*/
export interface GridpointGeoJson extends GeoJsonFeature {
/**
*
* @type {Gridpoint}
* @memberof GridpointGeoJson
*/
properties: Gridpoint;
}
/**
* @export
* @namespace GridpointGeoJson
*/
export declare namespace GridpointGeoJson { }
/**
*
* @export
* @interface GridpointHazards
*/
export interface GridpointHazards {
/**
*
* @type {Array}
* @memberof GridpointHazards
*/
values: Array;
}
/**
* A value object representing an expected hazard.
* @export
* @interface GridpointHazardsValue
*/
export interface GridpointHazardsValue {
/**
* Hazard code. This value will correspond to a P-VTEC phenomenon code as defined in NWS Directive 10-1703.
* @type {string}
* @memberof GridpointHazardsValue
*/
phenomenon: string;
/**
* Significance code. This value will correspond to a P-VTEC significance code as defined in NWS Directive 10-1703. This will most frequently be \"A\" for a watch or \"Y\" for an advisory.
* @type {string}
* @memberof GridpointHazardsValue
*/
significance: string;
/**
* Event number. If this hazard refers to a national or regional center product (such as a Storm Prediction Center convective watch), this value will be the sequence number of that product.
* @type {number}
* @memberof GridpointHazardsValue
*/
eventNumber: number;
}
/**
*
* @export
* @interface GridpointHazardsValues
*/
export interface GridpointHazardsValues {
/**
*
* @type {ISO8601Interval}
* @memberof GridpointHazardsValues
*/
validTime: ISO8601Interval;
/**
*
* @type {Array}
* @memberof GridpointHazardsValues
*/
value: Array;
}
/**
*
* @export
*/
export declare type GridpointJsonLd = Gridpoint;
/**
* A gridpoint layer consisting of quantitative values (numeric values with associated units of measure).
* @export
* @interface GridpointQuantitativeValueLayer
*/
export interface GridpointQuantitativeValueLayer {
/**
*
* @type {UnitOfMeasure}
* @memberof GridpointQuantitativeValueLayer
*/
uom?: UnitOfMeasure;
/**
*
* @type {Array}
* @memberof GridpointQuantitativeValueLayer
*/
values: Array;
}
/**
*
* @export
* @interface GridpointQuantitativeValueLayerValues
*/
export interface GridpointQuantitativeValueLayerValues {
/**
*
* @type {ISO8601Interval}
* @memberof GridpointQuantitativeValueLayerValues
*/
validTime: ISO8601Interval;
/**
*
* @type {number}
* @memberof GridpointQuantitativeValueLayerValues
*/
value: number;
}
/**
*
* @export
* @interface GridpointWeather
*/
export interface GridpointWeather {
/**
*
* @type {Array}
* @memberof GridpointWeather
*/
values: Array;
}
/**
* A value object representing expected weather phenomena.
* @export
* @interface GridpointWeatherValue
*/
export interface GridpointWeatherValue {
/**
*
* @type {string}
* @memberof GridpointWeatherValue
*/
coverage: GridpointWeatherValue.CoverageEnum;
/**
*
* @type {string}
* @memberof GridpointWeatherValue
*/
weather: GridpointWeatherValue.WeatherEnum;
/**
*
* @type {string}
* @memberof GridpointWeatherValue
*/
intensity: GridpointWeatherValue.IntensityEnum;
/**
*
* @type {QuantitativeValue}
* @memberof GridpointWeatherValue
*/
visibility: QuantitativeValue;
/**
*
* @type {Array}
* @memberof GridpointWeatherValue
*/
attributes: Array;
}
/**
* @export
* @namespace GridpointWeatherValue
*/
export declare namespace GridpointWeatherValue {
/**
* @export
* @enum {string}
*/
enum CoverageEnum {
Areas,
Brief,
Chance,
Definite,
Few,
Frequent,
Intermittent,
Isolated,
Likely,
Numerous,
Occasional,
Patchy,
Periods,
Scattered,
SlightChance,
Widespread
}
/**
* @export
* @enum {string}
*/
enum WeatherEnum {
BlowingDust,
BlowingSand,
BlowingSnow,
Drizzle,
Fog,
FreezingFog,
FreezingDrizzle,
FreezingRain,
FreezingSpray,
Frost,
Hail,
Haze,
IceCrystals,
IceFog,
Rain,
RainShowers,
Sleet,
Smoke,
Snow,
SnowShowers,
Thunderstorms,
VolcanicAsh,
WaterSpouts
}
/**
* @export
* @enum {string}
*/
enum IntensityEnum {
VeryLight,
Light,
Moderate,
Heavy
}
/**
* @export
* @enum {string}
*/
enum AttributesEnum {
DamagingWind,
DryThunderstorms,
Flooding,
GustyWind,
HeavyRain,
LargeHail,
SmallHail,
Tornadoes
}
}
/**
*
* @export
* @interface GridpointWeatherValues
*/
export interface GridpointWeatherValues {
/**
*
* @type {ISO8601Interval}
* @memberof GridpointWeatherValues
*/
validTime: ISO8601Interval;
/**
*
* @type {Array}
* @memberof GridpointWeatherValues
*/
value: Array;
}
/**
* A time duration in ISO 8601 format.
* @export
*/
export declare type ISO8601Duration = string;
/**
* A time interval in ISO 8601 format. This can be one of: 1. Start and end time 2. Start time and duration 3. Duration and end time The string \"NOW\" can also be used in place of a start/end time.
* @export
* @interface ISO8601Interval
*/
export interface ISO8601Interval {
}
/**
*
* @export
* @interface InlineResponse200
*/
export interface InlineResponse200 {
/**
* The total number of active alerts
* @type {number}
* @memberof InlineResponse200
*/
total?: number;
/**
* The total number of active alerts affecting land zones
* @type {number}
* @memberof InlineResponse200
*/
land?: number;
/**
* The total number of active alerts affecting marine zones
* @type {number}
* @memberof InlineResponse200
*/
marine?: number;
/**
* Active alerts by marine region
* @type {{ [key: string]: number; }}
* @memberof InlineResponse200
*/
regions?: {
[key: string]: number;
};
/**
* Active alerts by area (state/territory)
* @type {{ [key: string]: number; }}
* @memberof InlineResponse200
*/
areas?: {
[key: string]: number;
};
/**
* Active alerts by NWS public zone or county code
* @type {{ [key: string]: number; }}
* @memberof InlineResponse200
*/
zones?: {
[key: string]: number;
};
}
/**
*
* @export
* @interface InlineResponse2001
*/
export interface InlineResponse2001 {
/**
* A list of recognized event types
* @type {Array}
* @memberof InlineResponse2001
*/
eventTypes?: Array;
}
/**
*
* @export
* @interface InlineResponse2002
*/
export interface InlineResponse2002 {
/**
*
* @type {JsonLdContext}
* @memberof InlineResponse2002
*/
context?: JsonLdContext;
/**
* A list of glossary terms
* @type {Array}
* @memberof InlineResponse2002
*/
glossary?: Array;
}
/**
*
* @export
* @interface InlineResponse2002Glossary
*/
export interface InlineResponse2002Glossary {
/**
* The term being defined
* @type {string}
* @memberof InlineResponse2002Glossary
*/
term?: string;
/**
* A definition for the term
* @type {string}
* @memberof InlineResponse2002Glossary
*/
definition?: string;
}
/**
*
* @export
* @interface InlineResponse2003
*/
export interface InlineResponse2003 {
/**
*
* @type {JsonLdContext}
* @memberof InlineResponse2003
*/
context?: JsonLdContext;
/**
*
* @type {{ [key: string]: InlineResponse2003Icons; }}
* @memberof InlineResponse2003
*/
icons: {
[key: string]: InlineResponse2003Icons;
};
}
/**
*
* @export
* @interface InlineResponse2003Icons
*/
export interface InlineResponse2003Icons {
/**
*
* @type {string}
* @memberof InlineResponse2003Icons
*/
description: string;
}
/**
*
* @export
* @interface JsonLdContext
*/
export interface JsonLdContext {
}
/**
* Land region code. These correspond to the six NWS regional headquarters: * AR: Alaska Region * CR: Central Region * ER: Eastern Region * PR: Pacific Region * SR: Southern Region * WR: Western Region
* @export
* @enum {string}
*/
export declare enum LandRegionCode {
AR,
CR,
ER,
PR,
SR,
WR
}
/**
* Marine area code as defined in NWS Directive 10-302: * AM: Western North Atlantic Ocean and along U.S. East Coast south of Currituck Beach Light NC following the coastline into Gulf of Mexico to Ocean Reef FL including the Caribbean * AN: Western North Atlantic Ocean and along U.S. East Coast from Canadian border south to Currituck Beach Light NC * GM: Gulf of Mexico and along the U.S. Gulf Coast from the Mexican border to Ocean Reef FL * LC: Lake St. Clair * LE: Lake Erie * LH: Lake Huron * LM: Lake Michigan * LO: Lake Ontario * LS: Lake Superior * PH: Central Pacific Ocean including Hawaiian waters * PK: North Pacific Ocean near Alaska and along Alaska coastline including the Bering Sea and the Gulf of Alaska * PM: Western Pacific Ocean including Mariana Island waters * PS: South Central Pacific Ocean including American Samoa waters * PZ: Eastern North Pacific Ocean and along U.S. West Coast from Canadian border to Mexican border * SL: St. Lawrence River above St. Regis
* @export
* @enum {string}
*/
export declare enum MarineAreaCode {
AM,
AN,
GM,
LC,
LE,
LH,
LM,
LO,
LS,
PH,
PK,
PM,
PS,
PZ,
SL
}
/**
* Marine region code. These are groups of marine areas combined. * AL: Alaska waters (PK) * AT: Atlantic Ocean (AM, AN) * GL: Great Lakes (LC, LE, LH, LM, LO, LS, SL) * GM: Gulf of Mexico (GM) * PA: Eastern Pacific Ocean and U.S. West Coast (PZ) * PI: Central and Western Pacific (PH, PM, PS)
* @export
* @enum {string}
*/
export declare enum MarineRegionCode {
AL,
AT,
GL,
GM,
PA,
PI
}
/**
* An object representing a decoded METAR phenomenon string.
* @export
* @interface MetarPhenomenon
*/
export interface MetarPhenomenon {
/**
*
* @type {string}
* @memberof MetarPhenomenon
*/
intensity: MetarPhenomenon.IntensityEnum;
/**
*
* @type {string}
* @memberof MetarPhenomenon
*/
modifier: MetarPhenomenon.ModifierEnum;
/**
*
* @type {string}
* @memberof MetarPhenomenon
*/
weather: MetarPhenomenon.WeatherEnum;
/**
*
* @type {string}
* @memberof MetarPhenomenon
*/
rawString: string;
/**
*
* @type {boolean}
* @memberof MetarPhenomenon
*/
inVicinity?: boolean;
}
/**
* @export
* @namespace MetarPhenomenon
*/
export declare namespace MetarPhenomenon {
/**
* @export
* @enum {string}
*/
enum IntensityEnum {
Light,
Heavy
}
/**
* @export
* @enum {string}
*/
enum ModifierEnum {
Patches,
Blowing,
LowDrifting,
Freezing,
Shallow,
Partial,
Showers
}
/**
* @export
* @enum {string}
*/
enum WeatherEnum {
FogMist,
DustStorm,
Dust,
Drizzle,
FunnelCloud,
Fog,
Smoke,
Hail,
SnowPellets,
Haze,
IceCrystals,
IcePellets,
DustWhirls,
Spray,
Rain,
Sand,
SnowGrains,
Snow,
Squalls,
SandStorm,
Thunderstorms,
Unknown,
VolcanicAsh
}
}
/**
*
* @export
* @enum {string}
*/
export declare enum MetarSkyCoverage {
OVC,
BKN,
SCT,
FEW,
SKC,
CLR,
VV
}
/**
* Three-letter identifier for a NWS office.
* @export
* @enum {string}
*/
export declare enum NWSForecastOfficeId {
AKQ,
ALY,
BGM,
BOX,
BTV,
BUF,
CAE,
CAR,
CHS,
CLE,
CTP,
GSP,
GYX,
ILM,
ILN,
LWX,
MHX,
OKX,
PBZ,
PHI,
RAH,
RLX,
RNK,
ABQ,
AMA,
BMX,
BRO,
CRP,
EPZ,
EWX,
FFC,
FWD,
HGX,
HUN,
JAN,
JAX,
KEY,
LCH,
LIX,
LUB,
LZK,
MAF,
MEG,
MFL,
MLB,
MOB,
MRX,
OHX,
OUN,
SHV,
SJT,
SJU,
TAE,
TBW,
TSA,
ABR,
APX,
ARX,
BIS,
BOU,
CYS,
DDC,
DLH,
DMX,
DTX,
DVN,
EAX,
FGF,
FSD,
GID,
GJT,
GLD,
GRB,
GRR,
ICT,
ILX,
IND,
IWX,
JKL,
LBF,
LMK,
LOT,
LSX,
MKX,
MPX,
MQT,
OAX,
PAH,
PUB,
RIW,
SGF,
TOP,
UNR,
BOI,
BYZ,
EKA,
FGZ,
GGW,
HNX,
LKN,
LOX,
MFR,
MSO,
MTR,
OTX,
PDT,
PIH,
PQR,
PSR,
REV,
SEW,
SGX,
SLC,
STO,
TFX,
TWC,
VEF,
AER,
AFC,
AFG,
AJK,
ALU,
GUM,
HPA,
HFO,
PPG,
STU,
NH1,
NH2,
ONA,
ONP
}
/**
* UGC identifier for a NWS forecast zone or county. The first two letters will correspond to either a state code or marine area code (see #/components/schemas/StateTerritoryCode and #/components/schemas/MarineAreaCode for lists of valid letter combinations). The third letter will be Z for public/fire zone or C for county.
* @export
*/
export declare type NWSZoneID = string;
/**
*
* @export
* @enum {string}
*/
export declare enum NWSZoneType {
Land,
Marine,
Forecast,
Public,
Coastal,
Offshore,
Fire,
County
}
/**
*
* @export
* @interface Observation
*/
export interface Observation {
/**
*
* @type {JsonLdContext}
* @memberof Observation
*/
context?: JsonLdContext;
/**
*
* @type {GeometryString}
* @memberof Observation
*/
geometry?: GeometryString;
/**
*
* @type {string}
* @memberof Observation
*/
id?: string;
/**
*
* @type {string}
* @memberof Observation
*/
type?: Observation.TypeEnum;
/**
*
* @type {QuantitativeValue}
* @memberof Observation
*/
elevation?: QuantitativeValue;
/**
*
* @type {string}
* @memberof Observation
*/
station?: string;
/**
*
* @type {Date}
* @memberof Observation
*/
timestamp?: Date;
/**
*
* @type {string}
* @memberof Observation
*/
rawMessage?: string;
/**
*
* @type {string}
* @memberof Observation
*/
textDescription?: string;
/**
*
* @type {string}
* @memberof Observation
*/
icon?: string;
/**
*
* @type {Array}
* @memberof Observation
*/
presentWeather?: Array;
/**
*
* @type {QuantitativeValue}
* @memberof Observation
*/
temperature?: QuantitativeValue;
/**
*
* @type {QuantitativeValue}
* @memberof Observation
*/
dewpoint?: QuantitativeValue;
/**
*
* @type {QuantitativeValue}
* @memberof Observation
*/
windDirection?: QuantitativeValue;
/**
*
* @type {QuantitativeValue}
* @memberof Observation
*/
windSpeed?: QuantitativeValue;
/**
*
* @type {QuantitativeValue}
* @memberof Observation
*/
windGust?: QuantitativeValue;
/**
*
* @type {QuantitativeValue}
* @memberof Observation
*/
barometricPressure?: QuantitativeValue;
/**
*
* @type {QuantitativeValue}
* @memberof Observation
*/
seaLevelPressure?: QuantitativeValue;
/**
*
* @type {QuantitativeValue}
* @memberof Observation
*/
visibility?: QuantitativeValue;
/**
*
* @type {QuantitativeValue}
* @memberof Observation
*/
maxTemperatureLast24Hours?: QuantitativeValue;
/**
*
* @type {QuantitativeValue}
* @memberof Observation
*/
minTemperatureLast24Hours?: QuantitativeValue;
/**
*
* @type {QuantitativeValue}
* @memberof Observation
*/
precipitationLastHour?: QuantitativeValue;
/**
*
* @type {QuantitativeValue}
* @memberof Observation
*/
precipitationLast3Hours?: QuantitativeValue;
/**
*
* @type {QuantitativeValue}
* @memberof Observation
*/
precipitationLast6Hours?: QuantitativeValue;
/**
*
* @type {QuantitativeValue}
* @memberof Observation
*/
relativeHumidity?: QuantitativeValue;
/**
*
* @type {QuantitativeValue}
* @memberof Observation
*/
windChill?: QuantitativeValue;
/**
*
* @type {QuantitativeValue}
* @memberof Observation
*/
heatIndex?: QuantitativeValue;
/**
*
* @type {Array}
* @memberof Observation
*/
cloudLayers?: Array;
}
/**
* @export
* @namespace Observation
*/
export declare namespace Observation {
/**
* @export
* @enum {string}
*/
enum TypeEnum {
WxObservationStation
}
}
/**
*
* @export
* @interface ObservationCloudLayers
*/
export interface ObservationCloudLayers {
/**
*
* @type {QuantitativeValue}
* @memberof ObservationCloudLayers
*/
base: QuantitativeValue;
/**
*
* @type {MetarSkyCoverage}
* @memberof ObservationCloudLayers
*/
amount: MetarSkyCoverage;
}
/**
*
* @export
* @interface ObservationCollectionGeoJson
*/
export interface ObservationCollectionGeoJson extends GeoJsonFeatureCollection {
/**
*
* @type {Array}
* @memberof ObservationCollectionGeoJson
*/
features: Array;
}
/**
* @export
* @namespace ObservationCollectionGeoJson
*/
export declare namespace ObservationCollectionGeoJson { }
/**
*
* @export
* @interface ObservationCollectionGeoJsonFeatures
*/
export interface ObservationCollectionGeoJsonFeatures extends GeoJsonFeature {
/**
*
* @type {Observation}
* @memberof ObservationCollectionGeoJsonFeatures
*/
properties: Observation;
}
/**
*
* @export
* @interface ObservationCollectionJsonLd
*/
export interface ObservationCollectionJsonLd {
/**
*
* @type {JsonLdContext}
* @memberof ObservationCollectionJsonLd
*/
context?: JsonLdContext;
/**
*
* @type {Array}
* @memberof ObservationCollectionJsonLd
*/
graph?: Array;
}
/**
*
* @export
* @interface ObservationGeoJson
*/
export interface ObservationGeoJson extends GeoJsonFeature {
/**
*
* @type {Observation}
* @memberof ObservationGeoJson
*/
properties: Observation;
}
/**
* @export
* @namespace ObservationGeoJson
*/
export declare namespace ObservationGeoJson { }
/**
*
* @export
* @interface ObservationJsonLd
*/
export interface ObservationJsonLd {
}
/**
*
* @export
* @interface ObservationStation
*/
export interface ObservationStation {
/**
*
* @type {JsonLdContext}
* @memberof ObservationStation
*/
context?: JsonLdContext;
/**
*
* @type {GeometryString}
* @memberof ObservationStation
*/
geometry?: GeometryString;
/**
*
* @type {string}
* @memberof ObservationStation
*/
id?: string;
/**
*
* @type {string}
* @memberof ObservationStation
*/
type?: ObservationStation.TypeEnum;
/**
*
* @type {QuantitativeValue}
* @memberof ObservationStation
*/
elevation?: QuantitativeValue;
/**
*
* @type {string}
* @memberof ObservationStation
*/
stationIdentifier?: string;
/**
*
* @type {string}
* @memberof ObservationStation
*/
name?: string;
/**
*
* @type {string}
* @memberof ObservationStation
*/
timeZone?: string;
/**
* A link to the NWS public forecast zone containing this station.
* @type {string}
* @memberof ObservationStation
*/
forecast?: string;
/**
* A link to the NWS county zone containing this station.
* @type {string}
* @memberof ObservationStation
*/
county?: string;
/**
* A link to the NWS fire weather forecast zone containing this station.
* @type {string}
* @memberof ObservationStation
*/
fireWeatherZone?: string;
}
/**
* @export
* @namespace ObservationStation
*/
export declare namespace ObservationStation {
/**
* @export
* @enum {string}
*/
enum TypeEnum {
WxObservationStation
}
}
/**
*
* @export
* @interface ObservationStationCollectionGeoJson
*/
export interface ObservationStationCollectionGeoJson extends GeoJsonFeatureCollection {
/**
*
* @type {Array}
* @memberof ObservationStationCollectionGeoJson
*/
features: Array;
/**
*
* @type {Array}
* @memberof ObservationStationCollectionGeoJson
*/
observationStations?: Array;
}
/**
* @export
* @namespace ObservationStationCollectionGeoJson
*/
export declare namespace ObservationStationCollectionGeoJson { }
/**
*
* @export
* @interface ObservationStationCollectionGeoJsonFeatures
*/
export interface ObservationStationCollectionGeoJsonFeatures extends GeoJsonFeature {
/**
*
* @type {ObservationStation}
* @memberof ObservationStationCollectionGeoJsonFeatures
*/
properties: ObservationStation;
}
/**
*
* @export
* @interface ObservationStationCollectionJsonLd
*/
export interface ObservationStationCollectionJsonLd {
/**
*
* @type {JsonLdContext}
* @memberof ObservationStationCollectionJsonLd
*/
context?: JsonLdContext;
/**
*
* @type {Array}
* @memberof ObservationStationCollectionJsonLd
*/
graph?: Array;
/**
*
* @type {Array}
* @memberof ObservationStationCollectionJsonLd
*/
observationStations?: Array;
}
/**
*
* @export
* @interface ObservationStationGeoJson
*/
export interface ObservationStationGeoJson extends GeoJsonFeature {
/**
*
* @type {ObservationStation}
* @memberof ObservationStationGeoJson
*/
properties: ObservationStation;
}
/**
* @export
* @namespace ObservationStationGeoJson
*/
export declare namespace ObservationStationGeoJson { }
/**
*
* @export
* @interface ObservationStationJsonLd
*/
export interface ObservationStationJsonLd extends ObservationStation {
/**
*
* @type {JsonLdContext}
* @memberof ObservationStationJsonLd
*/
context: JsonLdContext;
/**
*
* @type {GeometryString}
* @memberof ObservationStationJsonLd
*/
geometry: GeometryString;
}
/**
* @export
* @namespace ObservationStationJsonLd
*/
export declare namespace ObservationStationJsonLd { }
/**
*
* @export
* @interface Office
*/
export interface Office {
/**
*
* @type {JsonLdContext}
* @memberof Office
*/
context?: JsonLdContext;
/**
*
* @type {string}
* @memberof Office
*/
type?: Office.TypeEnum;
/**
*
* @type {string}
* @memberof Office
*/
"@id"?: string;
/**
*
* @type {string}
* @memberof Office
*/
id?: string;
/**
*
* @type {string}
* @memberof Office
*/
name?: string;
/**
*
* @type {OfficeAddress}
* @memberof Office
*/
address?: OfficeAddress;
/**
*
* @type {string}
* @memberof Office
*/
telephone?: string;
/**
*
* @type {string}
* @memberof Office
*/
faxNumber?: string;
/**
*
* @type {string}
* @memberof Office
*/
email?: string;
/**
*
* @type {string}
* @memberof Office
*/
sameAs?: string;
/**
*
* @type {string}
* @memberof Office
*/
nwsRegion?: string;
/**
*
* @type {string}
* @memberof Office
*/
parentOrganization?: string;
/**
*
* @type {Array}
* @memberof Office
*/
responsibleCounties?: Array;
/**
*
* @type {Array}
* @memberof Office
*/
responsibleForecastZones?: Array;
/**
*
* @type {Array}
* @memberof Office
*/
responsibleFireZones?: Array;
/**
*
* @type {Array}
* @memberof Office
*/
approvedObservationStations?: Array;
}
/**
* @export
* @namespace Office
*/
export declare namespace Office {
/**
* @export
* @enum {string}
*/
enum TypeEnum {
GovernmentOrganization
}
}
/**
*
* @export
* @interface OfficeAddress
*/
export interface OfficeAddress {
/**
*
* @type {string}
* @memberof OfficeAddress
*/
type?: OfficeAddress.TypeEnum;
/**
*
* @type {string}
* @memberof OfficeAddress
*/
streetAddress?: string;
/**
*
* @type {string}
* @memberof OfficeAddress
*/
addressLocality?: string;
/**
*
* @type {string}
* @memberof OfficeAddress
*/
addressRegion?: string;
/**
*
* @type {string}
* @memberof OfficeAddress
*/
postalCode?: string;
}
/**
* @export
* @namespace OfficeAddress
*/
export declare namespace OfficeAddress {
/**
* @export
* @enum {string}
*/
enum TypeEnum {
PostalAddress
}
}
/**
*
* @export
* @interface OfficeHeadline
*/
export interface OfficeHeadline {
/**
*
* @type {JsonLdContext}
* @memberof OfficeHeadline
*/
context?: JsonLdContext;
/**
*
* @type {string}
* @memberof OfficeHeadline
*/
"@id"?: string;
/**
*
* @type {string}
* @memberof OfficeHeadline
*/
id?: string;
/**
*
* @type {string}
* @memberof OfficeHeadline
*/
office?: string;
/**
*
* @type {boolean}
* @memberof OfficeHeadline
*/
important?: boolean;
/**
*
* @type {Date}
* @memberof OfficeHeadline
*/
issuanceTime?: Date;
/**
*
* @type {string}
* @memberof OfficeHeadline
*/
link?: string;
/**
*
* @type {string}
* @memberof OfficeHeadline
*/
name?: string;
/**
*
* @type {string}
* @memberof OfficeHeadline
*/
title?: string;
/**
*
* @type {string}
* @memberof OfficeHeadline
*/
summary?: string;
/**
*
* @type {string}
* @memberof OfficeHeadline
*/
content?: string;
}
/**
*
* @export
* @interface OfficeHeadlineCollection
*/
export interface OfficeHeadlineCollection {
/**
*
* @type {JsonLdContext}
* @memberof OfficeHeadlineCollection
*/
context: JsonLdContext;
/**
*
* @type {Array}
* @memberof OfficeHeadlineCollection
*/
graph: Array;
}
/**
*
* @export
* @interface Point
*/
export interface Point {
/**
*
* @type {JsonLdContext}
* @memberof Point
*/
context?: JsonLdContext;
/**
*
* @type {GeometryString}
* @memberof Point
*/
geometry?: GeometryString;
/**
*
* @type {string}
* @memberof Point
*/
id?: string;
/**
*
* @type {string}
* @memberof Point
*/
type?: Point.TypeEnum;
/**
*
* @type {NWSForecastOfficeId}
* @memberof Point
*/
cwa?: NWSForecastOfficeId;
/**
*
* @type {string}
* @memberof Point
*/
forecastOffice?: string;
/**
*
* @type {NWSForecastOfficeId}
* @memberof Point
*/
gridId?: NWSForecastOfficeId;
/**
*
* @type {number}
* @memberof Point
*/
gridX?: number;
/**
*
* @type {number}
* @memberof Point
*/
gridY?: number;
/**
*
* @type {string}
* @memberof Point
*/
forecast?: string;
/**
*
* @type {string}
* @memberof Point
*/
forecastHourly?: string;
/**
*
* @type {string}
* @memberof Point
*/
forecastGridData?: string;
/**
*
* @type {string}
* @memberof Point
*/
observationStations?: string;
/**
*
* @type {RelativeLocationGeoJson | RelativeLocationJsonLd}
* @memberof Point
*/
relativeLocation?: RelativeLocationGeoJson | RelativeLocationJsonLd;
/**
*
* @type {string}
* @memberof Point
*/
forecastZone?: string;
/**
*
* @type {string}
* @memberof Point
*/
county?: string;
/**
*
* @type {string}
* @memberof Point
*/
fireWeatherZone?: string;
/**
*
* @type {string}
* @memberof Point
*/
timeZone?: string;
/**
*
* @type {string}
* @memberof Point
*/
radarStation?: string;
}
/**
* @export
* @namespace Point
*/
export declare namespace Point {
/**
* @export
* @enum {string}
*/
enum TypeEnum {
WxPoint
}
}
/**
*
* @export
* @interface PointGeoJson
*/
export interface PointGeoJson extends GeoJsonFeature {
/**
*
* @type {Point}
* @memberof PointGeoJson
*/
properties: Point;
}
/**
* @export
* @namespace PointGeoJson
*/
export declare namespace PointGeoJson { }
/**
*
* @export
* @interface PointJsonLd
*/
export interface PointJsonLd extends Point {
/**
*
* @type {JsonLdContext}
* @memberof PointJsonLd
*/
context: JsonLdContext;
/**
*
* @type {GeometryString}
* @memberof PointJsonLd
*/
geometry: GeometryString;
}
/**
* @export
* @namespace PointJsonLd
*/
export declare namespace PointJsonLd { }
/**
*
* @export
*/
export declare type PointString = string;
/**
* Detail about an error. This document conforms to RFC 7807 (Problem Details for HTTP APIs).
* @export
* @interface ProblemDetail
*/
export interface ProblemDetail {
type: string;
title: string;
status: number;
detail: string;
instance: string;
correlationId: string;
}
/**
* A structured value representing a measurement and its unit of measure. This object is a slighly modified version of the schema.org definition at https://schema.org/QuantitativeValue
* @export
* @interface QuantitativeValue
*/
export interface QuantitativeValue {
/**
* A measured value
* @type {number}
* @memberof QuantitativeValue
*/
value?: number;
/**
* The maximum value of a range of measured values
* @type {number}
* @memberof QuantitativeValue
*/
maxValue?: number;
/**
* The minimum value of a range of measured values
* @type {number}
* @memberof QuantitativeValue
*/
minValue?: number;
/**
*
* @type {UnitOfMeasure}
* @memberof QuantitativeValue
*/
unitCode?: UnitOfMeasure;
/**
* For values in observation records, the quality control flag from the MADIS system. The definitions of these flags can be found at https://madis.ncep.noaa.gov/madis_sfc_qc_notes.shtml
* @type {string}
* @memberof QuantitativeValue
*/
qualityControl?: QuantitativeValue.QualityControlEnum;
}
/**
* @export
* @namespace QuantitativeValue
*/
export declare namespace QuantitativeValue {
/**
* @export
* @enum {string}
*/
enum QualityControlEnum {
Z,
C,
S,
V,
X,
Q,
G,
B,
T
}
}
/**
*
* @export
* @interface RegionCode
*/
export interface RegionCode {
}
/**
*
* @export
* @interface RelativeLocation
*/
export interface RelativeLocation {
/**
*
* @type {string}
* @memberof RelativeLocation
*/
city?: string;
/**
*
* @type {string}
* @memberof RelativeLocation
*/
state?: string;
/**
*
* @type {QuantitativeValue}
* @memberof RelativeLocation
*/
distance?: QuantitativeValue;
/**
*
* @type {QuantitativeValue}
* @memberof RelativeLocation
*/
bearing?: QuantitativeValue;
}
/**
*
* @export
* @interface RelativeLocationGeoJson
*/
export interface RelativeLocationGeoJson extends GeoJsonFeature {
/**
*
* @type {RelativeLocation}
* @memberof RelativeLocationGeoJson
*/
properties: RelativeLocation;
}
/**
* @export
* @namespace RelativeLocationGeoJson
*/
export declare namespace RelativeLocationGeoJson { }
/**
*
* @export
* @interface RelativeLocationJsonLd
*/
export interface RelativeLocationJsonLd extends RelativeLocation {
/**
*
* @type {GeometryString}
* @memberof RelativeLocationJsonLd
*/
geometry: GeometryString;
}
/**
*
* @export
* @interface Size
*/
export interface Size {
}
/**
*
* @export
* @interface Size1
*/
export interface Size1 {
}
/**
*
* @export
* @enum {string}
*/
export declare enum StateTerritoryCode {
AL,
AK,
AS,
AR,
AZ,
CA,
CO,
CT,
DE,
DC,
FL,
GA,
GU,
HI,
ID,
IL,
IN,
IA,
KS,
KY,
LA,
ME,
MD,
MA,
MI,
MN,
MS,
MO,
MT,
NE,
NV,
NH,
NJ,
NM,
NY,
NC,
ND,
OH,
OK,
OR,
PA,
PR,
RI,
SC,
SD,
TN,
TX,
UT,
VT,
VI,
VA,
WA,
WV,
WI,
WY,
MP,
PW,
FM,
MH
}
/**
*
* @export
* @interface TextProduct
*/
export interface TextProduct {
/**
*
* @type {JsonLdContext}
* @memberof TextProduct
*/
context?: JsonLdContext;
/**
*
* @type {string}
* @memberof TextProduct
*/
"@id"?: string;
/**
*
* @type {string}
* @memberof TextProduct
*/
id?: string;
/**
*
* @type {string}
* @memberof TextProduct
*/
wmoCollectiveId?: string;
/**
*
* @type {string}
* @memberof TextProduct
*/
issuingOffice?: string;
/**
*
* @type {Date}
* @memberof TextProduct
*/
issuanceTime?: Date;
/**
*
* @type {string}
* @memberof TextProduct
*/
productCode?: string;
/**
*
* @type {string}
* @memberof TextProduct
*/
productName?: string;
/**
*
* @type {string}
* @memberof TextProduct
*/
productText?: string;
}
/**
*
* @export
* @interface TextProductCollection
*/
export interface TextProductCollection {
/**
*
* @type {JsonLdContext}
* @memberof TextProductCollection
*/
context?: JsonLdContext;
/**
*
* @type {Array}
* @memberof TextProductCollection
*/
graph?: Array;
}
/**
*
* @export
* @interface TextProductLocationCollection
*/
export interface TextProductLocationCollection {
/**
*
* @type {JsonLdContext}
* @memberof TextProductLocationCollection
*/
context?: JsonLdContext;
/**
*
* @type {{ [key: string]: string; }}
* @memberof TextProductLocationCollection
*/
locations?: {
[key: string]: string;
};
}
/**
*
* @export
* @interface TextProductTypeCollection
*/
export interface TextProductTypeCollection {
/**
*
* @type {JsonLdContext}
* @memberof TextProductTypeCollection
*/
context?: JsonLdContext;
/**
*
* @type {Array}
* @memberof TextProductTypeCollection
*/
graph?: Array;
}
/**
*
* @export
* @interface TextProductTypeCollectionGraph
*/
export interface TextProductTypeCollectionGraph {
/**
*
* @type {string}
* @memberof TextProductTypeCollectionGraph
*/
productCode: string;
/**
*
* @type {string}
* @memberof TextProductTypeCollectionGraph
*/
productName: string;
}
/**
* A string denoting a unit of measure, expressed in the format \"{unit}\" or \"{namespace}:{unit}\". Units with the namespace \"wmo\" or \"wmoUnit\" are defined in the World Meteorological Organization Codes Registry at http://codes.wmo.int/common/unit and should be canonically resolvable to http://codes.wmo.int/common/unit/{unit}. Units with the namespace \"nwsUnit\" are currently custom and do not align to any standard. Units with no namespace or the namespace \"uc\" are compliant with the Unified Code for Units of Measure syntax defined at https://unitsofmeasure.org/. This also aligns with recent versions of the Geographic Markup Language (GML) standard, the IWXXM standard, and OGC Observations and Measurements v2.0 (ISO/DIS 19156). Namespaced units are considered deprecated. We will be aligning API to use the same standards as GML/IWXXM in the future.
* @export
*/
export declare type UnitOfMeasure = string;
/**
*
* @export
* @interface Zone
*/
export interface Zone {
/**
*
* @type {JsonLdContext}
* @memberof Zone
*/
context?: JsonLdContext;
/**
*
* @type {GeometryString}
* @memberof Zone
*/
geometry?: GeometryString;
/**
*
* @type {string}
* @memberof Zone
*/
"@id"?: string;
/**
*
* @type {string}
* @memberof Zone
*/
"@type"?: Zone.TypeEnum;
/**
*
* @type {NWSZoneID}
* @memberof Zone
*/
id?: NWSZoneID;
/**
*
* @type {NWSZoneType}
* @memberof Zone
*/
type?: NWSZoneType;
/**
*
* @type {string}
* @memberof Zone
*/
name?: string;
/**
*
* @type {Date}
* @memberof Zone
*/
effectiveDate?: Date;
/**
*
* @type {Date}
* @memberof Zone
*/
expirationDate?: Date;
/**
*
* @type {StateTerritoryCode | string}
* @memberof Zone
*/
state?: StateTerritoryCode | string;
/**
*
* @type {Array}
* @memberof Zone
*/
cwa?: Array;
/**
*
* @type {Array}
* @memberof Zone
*/
forecastOffices?: Array;
/**
*
* @type {Array}
* @memberof Zone
*/
timeZone?: Array;
/**
*
* @type {Array}
* @memberof Zone
*/
observationStations?: Array;
/**
*
* @type {string}
* @memberof Zone
*/
radarStation?: string;
}
/**
* @export
* @namespace Zone
*/
export declare namespace Zone {
/**
* @export
* @enum {string}
*/
enum TypeEnum {
WxZone
}
}
/**
*
* @export
* @interface ZoneCollectionGeoJson
*/
export interface ZoneCollectionGeoJson extends GeoJsonFeatureCollection {
/**
*
* @type {Array}
* @memberof ZoneCollectionGeoJson
*/
features: Array;
}
/**
* @export
* @namespace ZoneCollectionGeoJson
*/
export declare namespace ZoneCollectionGeoJson { }
/**
*
* @export
* @interface ZoneCollectionGeoJsonFeatures
*/
export interface ZoneCollectionGeoJsonFeatures extends GeoJsonFeature {
/**
*
* @type {Zone}
* @memberof ZoneCollectionGeoJsonFeatures
*/
properties: Zone;
}
/**
*
* @export
* @interface ZoneCollectionJsonLd
*/
export interface ZoneCollectionJsonLd {
/**
*
* @type {JsonLdContext}
* @memberof ZoneCollectionJsonLd
*/
context?: JsonLdContext;
/**
*
* @type {Array}
* @memberof ZoneCollectionJsonLd
*/
graph?: Array;
}
/**
* An object representing a zone area forecast.
* @export
* @interface ZoneForecast
*/
export interface ZoneForecast {
/**
*
* @type {JsonLdContext}
* @memberof ZoneForecast
*/
context?: JsonLdContext;
/**
*
* @type {GeometryString}
* @memberof ZoneForecast
*/
geometry?: GeometryString;
/**
* An API link to the zone this forecast is for.
* @type {string}
* @memberof ZoneForecast
*/
zone?: string;
/**
* The time this zone forecast product was published.
* @type {Date}
* @memberof ZoneForecast
*/
updated?: Date;
/**
* An array of forecast periods.
* @type {Array}
* @memberof ZoneForecast
*/
periods?: Array;
}
/**
*
* @export
* @interface ZoneForecastGeoJson
*/
export interface ZoneForecastGeoJson extends GeoJsonFeature {
/**
*
* @type {ZoneForecast}
* @memberof ZoneForecastGeoJson
*/
properties: ZoneForecast;
}
/**
* @export
* @namespace ZoneForecastGeoJson
*/
export declare namespace ZoneForecastGeoJson { }
/**
*
* @export
* @interface ZoneForecastJsonLd
*/
export interface ZoneForecastJsonLd {
}
/**
*
* @export
* @interface ZoneForecastPeriods
*/
export interface ZoneForecastPeriods {
/**
* A sequential identifier number.
* @type {number}
* @memberof ZoneForecastPeriods
*/
number: number;
/**
* A textual description of the period.
* @type {string}
* @memberof ZoneForecastPeriods
*/
name: string;
/**
* A detailed textual forecast for the period.
* @type {string}
* @memberof ZoneForecastPeriods
*/
detailedForecast: string;
}
/**
*
* @export
* @interface ZoneGeoJson
*/
export interface ZoneGeoJson extends GeoJsonFeature {
/**
*
* @type {Zone}
* @memberof ZoneGeoJson
*/
properties: Zone;
}
/**
* @export
* @namespace ZoneGeoJson
*/
export declare namespace ZoneGeoJson { }
/**
*
* @export
* @interface ZoneJsonLd
*/
export interface ZoneJsonLd {
}
/**
* DefaultApi - fetch parameter creator
* @export
*/
export declare const DefaultApiFetchParamCreator: (configuration?: Configuration) => {
/**
* Returns all currently active alerts
* @param {Array} [status] Status (actual, exercise, system, test, draft)
* @param {Array} [messageType] Message type (alert, update, cancel)
* @param {Array} [event] Event name
* @param {Array} [code] Event code
* @param {Array} [area] State/territory code or marine area code This parameter is incompatible with the following parameters: point, region, region_type, zone
* @param {PointString} [point] Point (latitude,longitude) This parameter is incompatible with the following parameters: area, region, region_type, zone
* @param {Array} [region] Marine region code This parameter is incompatible with the following parameters: area, point, region_type, zone
* @param {string} [regionType] Region type (land or marine) This parameter is incompatible with the following parameters: area, point, region, zone
* @param {Array} [zone] Zone ID (forecast or county) This parameter is incompatible with the following parameters: area, point, region, region_type
* @param {Array} [urgency] Urgency (immediate, expected, future, past, unknown)
* @param {Array} [severity] Severity (extreme, severe, moderate, minor, unknown)
* @param {Array} [certainty] Certainty (observed, likely, possible, unlikely, unknown)
* @param {number} [limit] Limit
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
alertsActive(status?: Array, messageType?: Array, event?: Array, code?: Array, area?: Array, point?: PointString, region?: Array, regionType?: string, zone?: Array, urgency?: Array, severity?: Array, certainty?: Array, limit?: number, options?: any): FetchArgs;
/**
* Returns active alerts for the given area (state or marine area)
* @param {AreaCode} area State/area ID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
alertsActiveArea(area: AreaCode, options?: any): FetchArgs;
/**
* Returns info on the number of active alerts
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
alertsActiveCount(options?: any): FetchArgs;
/**
* Returns active alerts for the given marine region
* @param {MarineRegionCode} region Marine region ID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
alertsActiveRegion(region: MarineRegionCode, options?: any): FetchArgs;
/**
* Returns active alerts for the given NWS public zone or county
* @param {NWSZoneID} zoneId NWS public zone/county identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
alertsActiveZone(zoneId: NWSZoneID, options?: any): FetchArgs;
/**
* Returns all alerts
* @param {boolean} [active] List only active alerts (use /alerts/active endpoints instead)
* @param {Date} [start] Start time
* @param {Date} [end] End time
* @param {Array} [status] Status (actual, exercise, system, test, draft)
* @param {Array} [messageType] Message type (alert, update, cancel)
* @param {Array} [event] Event name
* @param {Array} [code] Event code
* @param {Array} [area] State/territory code or marine area code This parameter is incompatible with the following parameters: point, region, region_type, zone
* @param {PointString} [point] Point (latitude,longitude) This parameter is incompatible with the following parameters: area, region, region_type, zone
* @param {Array} [region] Marine region code This parameter is incompatible with the following parameters: area, point, region_type, zone
* @param {string} [regionType] Region type (land or marine) This parameter is incompatible with the following parameters: area, point, region, zone
* @param {Array} [zone] Zone ID (forecast or county) This parameter is incompatible with the following parameters: area, point, region, region_type
* @param {Array} [urgency] Urgency (immediate, expected, future, past, unknown)
* @param {Array} [severity] Severity (extreme, severe, moderate, minor, unknown)
* @param {Array} [certainty] Certainty (observed, likely, possible, unlikely, unknown)
* @param {number} [limit] Limit
* @param {string} [cursor] Pagination cursor
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
alertsQuery(active?: boolean, start?: Date, end?: Date, status?: Array, messageType?: Array, event?: Array, code?: Array, area?: Array, point?: PointString, region?: Array, regionType?: string, zone?: Array, urgency?: Array, severity?: Array, certainty?: Array, limit?: number, cursor?: string, options?: any): FetchArgs;
/**
* Returns a specific alert
* @param {AlertId} id Alert identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
alertsSingle(id: AlertId, options?: any): FetchArgs;
/**
* Returns a list of alert types
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
alertsTypes(options?: any): FetchArgs;
/**
* Returns glossary terms
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
glossary(options?: any): FetchArgs;
/**
* Returns raw numerical forecast data for a 2.5km grid area
* @param {NWSForecastOfficeId} wfo Forecast office ID
* @param {number} x Forecast grid X coordinate
* @param {number} y Forecast grid Y coordinate
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
gridpoint(wfo: NWSForecastOfficeId, x: number, y: number, options?: any): FetchArgs;
/**
* Returns a textual forecast for a 2.5km grid area
* @param {NWSForecastOfficeId} wfo Forecast office ID
* @param {number} x Forecast grid X coordinate
* @param {number} y Forecast grid Y coordinate
* @param {Array} [featureFlags] Enable future and experimental features (see documentation for more info): * forecast_temperature_qv: Represent temperature as QuantitativeValue * forecast_wind_speed_qv: Represent wind speed as QuantitativeValue
* @param {GridpointForecastUnits} [units] Use US customary or SI (metric) units in textual output
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
gridpointForecast(wfo: NWSForecastOfficeId, x: number, y: number, featureFlags?: Array, units?: GridpointForecastUnits, options?: any): FetchArgs;
/**
* Returns a textual hourly forecast for a 2.5km grid area
* @param {NWSForecastOfficeId} wfo Forecast office ID
* @param {number} x Forecast grid X coordinate
* @param {number} y Forecast grid Y coordinate
* @param {Array} [featureFlags] Enable future and experimental features (see documentation for more info): * forecast_temperature_qv: Represent temperature as QuantitativeValue * forecast_wind_speed_qv: Represent wind speed as QuantitativeValue
* @param {GridpointForecastUnits} [units] Use US customary or SI (metric) units in textual output
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
gridpointForecastHourly(wfo: NWSForecastOfficeId, x: number, y: number, featureFlags?: Array, units?: GridpointForecastUnits, options?: any): FetchArgs;
/**
* Returns a list of observation stations usable for a given 2.5km grid area
* @param {NWSForecastOfficeId} wfo Forecast office ID
* @param {number} x Forecast grid X coordinate
* @param {number} y Forecast grid Y coordinate
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
gridpointStations(wfo: NWSForecastOfficeId, x: number, y: number, options?: any): FetchArgs;
/**
* Returns a forecast icon. Icon services in API are deprecated.
* @param {string} set .
* @param {string} timeOfDay .
* @param {string} first .
* @param {Size} [size] Font size
* @param {number} [fontsize] Font size
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
icons(set: string, timeOfDay: string, first: string, size?: Size, fontsize?: number, options?: any): FetchArgs;
/**
* Returns a forecast icon. Icon services in API are deprecated.
* @param {string} set .
* @param {string} timeOfDay .
* @param {string} first .
* @param {string} second .
* @param {Size1} [size] Font size
* @param {number} [fontsize] Font size
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
iconsDualCondition(set: string, timeOfDay: string, first: string, second: string, size?: Size1, fontsize?: number, options?: any): FetchArgs;
/**
* Returns a list of icon codes and textual descriptions. Icon services in API are deprecated.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
iconsSummary(options?: any): FetchArgs;
/**
* Returns a list of valid text product types for a given issuance location
* @param {string} locationId .
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
locationProducts(locationId: string, options?: any): FetchArgs;
/**
* Returns metadata about a given observation station
* @param {string} stationId Observation station ID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
obsStation(stationId: string, options?: any): FetchArgs;
/**
* Returns a list of observation stations.
* @param {Array} [id] Filter by observation station ID
* @param {Array} [state] Filter by state/marine area code
* @param {number} [limit] Limit
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
obsStations(id?: Array, state?: Array, limit?: number, options?: any): FetchArgs;
/**
* Returns metadata about a NWS forecast office
* @param {NWSForecastOfficeId} officeId NWS forecast office ID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
office(officeId: NWSForecastOfficeId, options?: any): FetchArgs;
/**
* Returns a specific news headline for a given NWS office
* @param {NWSForecastOfficeId} officeId NWS forecast office ID
* @param {string} headlineId Headline record ID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
officeHeadline(officeId: NWSForecastOfficeId, headlineId: string, options?: any): FetchArgs;
/**
* Returns a list of news headlines for a given NWS office
* @param {NWSForecastOfficeId} officeId NWS forecast office ID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
officeHeadlines(officeId: NWSForecastOfficeId, options?: any): FetchArgs;
/**
* Returns metadata about a given latitude/longitude point
* @param {PointString} point Point (latitude, longitude)
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
point(point: PointString, options?: any): FetchArgs;
/**
* Returns a list of observation stations for a given point
* @param {PointString} point Point (latitude, longitude)
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
pointStations(point: PointString, options?: any): FetchArgs;
/**
* Returns a specific text product
* @param {string} productId .
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
product(productId: string, options?: any): FetchArgs;
/**
* Returns a list of valid text product issuance locations
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
productLocations(options?: any): FetchArgs;
/**
* Returns a list of valid text product types and codes
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
productTypes(options?: any): FetchArgs;
/**
* Returns a list of text products
* @param {Array} [location] Location id
* @param {Date} [start] Start time
* @param {Date} [end] End time
* @param {Array} [office] Issuing office
* @param {Array} [wmoid] WMO id code
* @param {Array} [type] Product code
* @param {number} [limit] Limit
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
productsQuery(location?: Array, start?: Date, end?: Date, office?: Array, wmoid?: Array, type?: Array, limit?: number, options?: any): FetchArgs;
/**
* Returns a list of text products of a given type
* @param {string} typeId .
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
productsType(typeId: string, options?: any): FetchArgs;
/**
* Returns a list of text products of a given type for a given issuance location
* @param {string} typeId .
* @param {string} locationId .
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
productsTypeLocation(typeId: string, locationId: string, options?: any): FetchArgs;
/**
* Returns a list of valid text product issuance locations for a given product type
* @param {string} typeId .
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
productsTypeLocations(typeId: string, options?: any): FetchArgs;
/**
* Returns metadata about a given radar wind profiler
* @param {string} stationId Profiler station ID
* @param {ISO8601Interval} [time] Time interval
* @param {ISO8601Duration} [interval] Averaging interval
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
radarProfiler(stationId: string, time?: ISO8601Interval, interval?: ISO8601Duration, options?: any): FetchArgs;
/**
* Returns metadata about a given radar queue
* @param {string} host LDM host
* @param {number} [limit] Record limit
* @param {ISO8601Interval} [arrived] Range for arrival time
* @param {ISO8601Interval} [created] Range for creation time
* @param {ISO8601Interval} [published] Range for publish time
* @param {string} [station] Station identifier
* @param {string} [type] Record type
* @param {string} [feed] Originating product feed
* @param {number} [resolution] Resolution version
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
radarQueue(host: string, limit?: number, arrived?: ISO8601Interval, created?: ISO8601Interval, published?: ISO8601Interval, station?: string, type?: string, feed?: string, resolution?: number, options?: any): FetchArgs;
/**
* Returns metadata about a given radar server
* @param {string} id Server ID
* @param {string} [reportingHost] Show records from specific reporting host
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
radarServer(id: string, reportingHost?: string, options?: any): FetchArgs;
/**
* Returns a list of radar servers
* @param {string} [reportingHost] Show records from specific reporting host
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
radarServers(reportingHost?: string, options?: any): FetchArgs;
/**
* Returns metadata about a given radar station
* @param {string} stationId Radar station ID
* @param {string} [reportingHost] Show RDA and latency info from specific reporting host
* @param {string} [host] Show latency info from specific LDM host
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
radarStation(stationId: string, reportingHost?: string, host?: string, options?: any): FetchArgs;
/**
* Returns metadata about a given radar station alarms
* @param {string} stationId Radar station ID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
radarStationAlarms(stationId: string, options?: any): FetchArgs;
/**
* Returns a list of radar stations
* @param {Array} [stationType] Limit results to a specific station type or types
* @param {string} [reportingHost] Show RDA and latency info from specific reporting host
* @param {string} [host] Show latency info from specific LDM host
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
radarStations(stationType?: Array, reportingHost?: string, host?: string, options?: any): FetchArgs;
/**
* Returns a thumbnail image for a satellite region. Image services in API are deprecated.
* @param {string} area .
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
satelliteThumbnails(area: string, options?: any): FetchArgs;
/**
* Returns the latest observation for a station
* @param {string} stationId Observation station ID
* @param {boolean} [requireQc] Require QC
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
stationObservationLatest(stationId: string, requireQc?: boolean, options?: any): FetchArgs;
/**
* Returns a list of observations for a given station
* @param {string} stationId Observation station ID
* @param {Date} [start] Start time
* @param {Date} [end] End time
* @param {number} [limit] Limit
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
stationObservationList(stationId: string, start?: Date, end?: Date, limit?: number, options?: any): FetchArgs;
/**
* Returns a single observation.
* @param {string} stationId Observation station ID
* @param {Date} time Timestamp of requested observation
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
stationObservationTime(stationId: string, time: Date, options?: any): FetchArgs;
/**
* Returns metadata about a given zone
* @param {string} type Zone type
* @param {NWSZoneID} zoneId NWS public zone/county identifier
* @param {Date} [effective] Effective date/time
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
zone(type: string, zoneId: NWSZoneID, effective?: Date, options?: any): FetchArgs;
/**
* Returns the current zone forecast for a given zone
* @param {string} type Zone type
* @param {NWSZoneID} zoneId NWS public zone/county identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
zoneForecast(type: string, zoneId: NWSZoneID, options?: any): FetchArgs;
/**
* Returns a list of zones
* @param {Array} [id] Zone ID (forecast or county)
* @param {Array} [area] State/marine area code
* @param {Array} [region] Region code
* @param {Array} [type] Zone type
* @param {PointString} [point] Point (latitude,longitude)
* @param {boolean} [includeGeometry] Include geometry in results (true/false)
* @param {number} [limit] Limit
* @param {Date} [effective] Effective date/time
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
zoneList(id?: Array, area?: Array, region?: Array, type?: Array, point?: PointString, includeGeometry?: boolean, limit?: number, effective?: Date, options?: any): FetchArgs;
/**
* Returns a list of zones of a given type
* @param {string} type Zone type
* @param {Array} [id] Zone ID (forecast or county)
* @param {Array} [area] State/marine area code
* @param {Array} [region] Region code
* @param {Array} [typeArray] Zone type
* @param {PointString} [point] Point (latitude,longitude)
* @param {boolean} [includeGeometry] Include geometry in results (true/false)
* @param {number} [limit] Limit
* @param {Date} [effective] Effective date/time
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
zoneListType(type: string, id?: Array, area?: Array, region?: Array, typeArray?: Array, point?: PointString, includeGeometry?: boolean, limit?: number, effective?: Date, options?: any): FetchArgs;
/**
* Returns a list of observations for a given zone
* @param {NWSZoneID} zoneId NWS public zone/county identifier
* @param {Date} [start] Start date/time
* @param {Date} [end] End date/time
* @param {number} [limit] Limit
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
zoneObs(zoneId: NWSZoneID, start?: Date, end?: Date, limit?: number, options?: any): FetchArgs;
/**
* Returns a list of observation stations for a given zone
* @param {NWSZoneID} zoneId NWS public zone/county identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
zoneStations(zoneId: NWSZoneID, options?: any): FetchArgs;
};
/**
* DefaultApi - functional programming interface
* @export
*/
export declare const DefaultApiFp: (configuration?: Configuration) => {
/**
* Returns all currently active alerts
* @param {Array} [status] Status (actual, exercise, system, test, draft)
* @param {Array} [messageType] Message type (alert, update, cancel)
* @param {Array} [event] Event name
* @param {Array} [code] Event code
* @param {Array} [area] State/territory code or marine area code This parameter is incompatible with the following parameters: point, region, region_type, zone
* @param {PointString} [point] Point (latitude,longitude) This parameter is incompatible with the following parameters: area, region, region_type, zone
* @param {Array} [region] Marine region code This parameter is incompatible with the following parameters: area, point, region_type, zone
* @param {string} [regionType] Region type (land or marine) This parameter is incompatible with the following parameters: area, point, region, zone
* @param {Array} [zone] Zone ID (forecast or county) This parameter is incompatible with the following parameters: area, point, region, region_type
* @param {Array} [urgency] Urgency (immediate, expected, future, past, unknown)
* @param {Array} [severity] Severity (extreme, severe, moderate, minor, unknown)
* @param {Array} [certainty] Certainty (observed, likely, possible, unlikely, unknown)
* @param {number} [limit] Limit
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
alertsActive(status?: Array, messageType?: Array, event?: Array, code?: Array, area?: Array, point?: PointString, region?: Array, regionType?: string, zone?: Array, urgency?: Array, severity?: Array, certainty?: Array, limit?: number, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise;
/**
* Returns active alerts for the given area (state or marine area)
* @param {AreaCode} area State/area ID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
alertsActiveArea(area: AreaCode, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise;
/**
* Returns info on the number of active alerts
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
alertsActiveCount(options?: any): (fetch?: FetchAPI, basePath?: string) => Promise;
/**
* Returns active alerts for the given marine region
* @param {MarineRegionCode} region Marine region ID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
alertsActiveRegion(region: MarineRegionCode, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise;
/**
* Returns active alerts for the given NWS public zone or county
* @param {NWSZoneID} zoneId NWS public zone/county identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
alertsActiveZone(zoneId: NWSZoneID, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise;
/**
* Returns all alerts
* @param {boolean} [active] List only active alerts (use /alerts/active endpoints instead)
* @param {Date} [start] Start time
* @param {Date} [end] End time
* @param {Array} [status] Status (actual, exercise, system, test, draft)
* @param {Array} [messageType] Message type (alert, update, cancel)
* @param {Array} [event] Event name
* @param {Array} [code] Event code
* @param {Array} [area] State/territory code or marine area code This parameter is incompatible with the following parameters: point, region, region_type, zone
* @param {PointString} [point] Point (latitude,longitude) This parameter is incompatible with the following parameters: area, region, region_type, zone
* @param {Array} [region] Marine region code This parameter is incompatible with the following parameters: area, point, region_type, zone
* @param {string} [regionType] Region type (land or marine) This parameter is incompatible with the following parameters: area, point, region, zone
* @param {Array} [zone] Zone ID (forecast or county) This parameter is incompatible with the following parameters: area, point, region, region_type
* @param {Array} [urgency] Urgency (immediate, expected, future, past, unknown)
* @param {Array} [severity] Severity (extreme, severe, moderate, minor, unknown)
* @param {Array} [certainty] Certainty (observed, likely, possible, unlikely, unknown)
* @param {number} [limit] Limit
* @param {string} [cursor] Pagination cursor
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
alertsQuery(active?: boolean, start?: Date, end?: Date, status?: Array, messageType?: Array, event?: Array, code?: Array, area?: Array, point?: PointString, region?: Array, regionType?: string, zone?: Array, urgency?: Array, severity?: Array, certainty?: Array, limit?: number, cursor?: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise;
/**
* Returns a specific alert
* @param {AlertId} id Alert identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
alertsSingle(id: AlertId, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise;
/**
* Returns a list of alert types
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
alertsTypes(options?: any): (fetch?: FetchAPI, basePath?: string) => Promise;
/**
* Returns glossary terms
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
glossary(options?: any): (fetch?: FetchAPI, basePath?: string) => Promise;
/**
* Returns raw numerical forecast data for a 2.5km grid area
* @param {NWSForecastOfficeId} wfo Forecast office ID
* @param {number} x Forecast grid X coordinate
* @param {number} y Forecast grid Y coordinate
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
gridpoint(wfo: NWSForecastOfficeId, x: number, y: number, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise;
/**
* Returns a textual forecast for a 2.5km grid area
* @param {NWSForecastOfficeId} wfo Forecast office ID
* @param {number} x Forecast grid X coordinate
* @param {number} y Forecast grid Y coordinate
* @param {Array} [featureFlags] Enable future and experimental features (see documentation for more info): * forecast_temperature_qv: Represent temperature as QuantitativeValue * forecast_wind_speed_qv: Represent wind speed as QuantitativeValue
* @param {GridpointForecastUnits} [units] Use US customary or SI (metric) units in textual output
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
gridpointForecast(wfo: NWSForecastOfficeId, x: number, y: number, featureFlags?: Array, units?: GridpointForecastUnits, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise;
/**
* Returns a textual hourly forecast for a 2.5km grid area
* @param {NWSForecastOfficeId} wfo Forecast office ID
* @param {number} x Forecast grid X coordinate
* @param {number} y Forecast grid Y coordinate
* @param {Array} [featureFlags] Enable future and experimental features (see documentation for more info): * forecast_temperature_qv: Represent temperature as QuantitativeValue * forecast_wind_speed_qv: Represent wind speed as QuantitativeValue
* @param {GridpointForecastUnits} [units] Use US customary or SI (metric) units in textual output
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
gridpointForecastHourly(wfo: NWSForecastOfficeId, x: number, y: number, featureFlags?: Array, units?: GridpointForecastUnits, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise;
/**
* Returns a list of observation stations usable for a given 2.5km grid area
* @param {NWSForecastOfficeId} wfo Forecast office ID
* @param {number} x Forecast grid X coordinate
* @param {number} y Forecast grid Y coordinate
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
gridpointStations(wfo: NWSForecastOfficeId, x: number, y: number, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise;
/**
* Returns a forecast icon. Icon services in API are deprecated.
* @param {string} set .
* @param {string} timeOfDay .
* @param {string} first .
* @param {Size} [size] Font size
* @param {number} [fontsize] Font size
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
icons(set: string, timeOfDay: string, first: string, size?: Size, fontsize?: number, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise;
/**
* Returns a forecast icon. Icon services in API are deprecated.
* @param {string} set .
* @param {string} timeOfDay .
* @param {string} first .
* @param {string} second .
* @param {Size1} [size] Font size
* @param {number} [fontsize] Font size
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
iconsDualCondition(set: string, timeOfDay: string, first: string, second: string, size?: Size1, fontsize?: number, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise;
/**
* Returns a list of icon codes and textual descriptions. Icon services in API are deprecated.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
iconsSummary(options?: any): (fetch?: FetchAPI, basePath?: string) => Promise;
/**
* Returns a list of valid text product types for a given issuance location
* @param {string} locationId .
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
locationProducts(locationId: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise;
/**
* Returns metadata about a given observation station
* @param {string} stationId Observation station ID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
obsStation(stationId: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise;
/**
* Returns a list of observation stations.
* @param {Array} [id] Filter by observation station ID
* @param {Array} [state] Filter by state/marine area code
* @param {number} [limit] Limit
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
obsStations(id?: Array, state?: Array, limit?: number, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise;
/**
* Returns metadata about a NWS forecast office
* @param {NWSForecastOfficeId} officeId NWS forecast office ID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
office(officeId: NWSForecastOfficeId, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise;
/**
* Returns a specific news headline for a given NWS office
* @param {NWSForecastOfficeId} officeId NWS forecast office ID
* @param {string} headlineId Headline record ID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
officeHeadline(officeId: NWSForecastOfficeId, headlineId: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise;
/**
* Returns a list of news headlines for a given NWS office
* @param {NWSForecastOfficeId} officeId NWS forecast office ID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
officeHeadlines(officeId: NWSForecastOfficeId, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise;
/**
* Returns metadata about a given latitude/longitude point
* @param {PointString} point Point (latitude, longitude)
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
point(point: PointString, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise;
/**
* Returns a list of observation stations for a given point
* @param {PointString} point Point (latitude, longitude)
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
pointStations(point: PointString, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise;
/**
* Returns a specific text product
* @param {string} productId .
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
product(productId: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise;
/**
* Returns a list of valid text product issuance locations
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
productLocations(options?: any): (fetch?: FetchAPI, basePath?: string) => Promise;
/**
* Returns a list of valid text product types and codes
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
productTypes(options?: any): (fetch?: FetchAPI, basePath?: string) => Promise;
/**
* Returns a list of text products
* @param {Array} [location] Location id
* @param {Date} [start] Start time
* @param {Date} [end] End time
* @param {Array} [office] Issuing office
* @param {Array} [wmoid] WMO id code
* @param {Array} [type] Product code
* @param {number} [limit] Limit
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
productsQuery(location?: Array, start?: Date, end?: Date, office?: Array, wmoid?: Array, type?: Array, limit?: number, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise;
/**
* Returns a list of text products of a given type
* @param {string} typeId .
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
productsType(typeId: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise;
/**
* Returns a list of text products of a given type for a given issuance location
* @param {string} typeId .
* @param {string} locationId .
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
productsTypeLocation(typeId: string, locationId: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise;
/**
* Returns a list of valid text product issuance locations for a given product type
* @param {string} typeId .
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
productsTypeLocations(typeId: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise;
/**
* Returns metadata about a given radar wind profiler
* @param {string} stationId Profiler station ID
* @param {ISO8601Interval} [time] Time interval
* @param {ISO8601Duration} [interval] Averaging interval
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
radarProfiler(stationId: string, time?: ISO8601Interval, interval?: ISO8601Duration, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise;
/**
* Returns metadata about a given radar queue
* @param {string} host LDM host
* @param {number} [limit] Record limit
* @param {ISO8601Interval} [arrived] Range for arrival time
* @param {ISO8601Interval} [created] Range for creation time
* @param {ISO8601Interval} [published] Range for publish time
* @param {string} [station] Station identifier
* @param {string} [type] Record type
* @param {string} [feed] Originating product feed
* @param {number} [resolution] Resolution version
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
radarQueue(host: string, limit?: number, arrived?: ISO8601Interval, created?: ISO8601Interval, published?: ISO8601Interval, station?: string, type?: string, feed?: string, resolution?: number, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise;
/**
* Returns metadata about a given radar server
* @param {string} id Server ID
* @param {string} [reportingHost] Show records from specific reporting host
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
radarServer(id: string, reportingHost?: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise