s2-tools
Version:
A collection of geospatial tools primarily designed for WGS84, Web Mercator, and S2.
543 lines • 19.9 kB
TypeScript
/**
* # GBFS System Alerts Schema V3.1-RC & V3.0
* Describes ad-hoc changes to the system.
*
* ## Links
* - [GBFS Specification](https://github.com/MobilityData/gbfs/blob/v3.1-RC/gbfs.md#system_alertsjson)
* - [GBFS Specification](https://github.com/MobilityData/gbfs/blob/v3.0/gbfs.md#system_alertsjson)
*/
export type GBFSSystemAlertsV3 = GBFSSystemAlertsV31RC | GBFSSystemAlertsV30;
/**
* # GBFS System Alerts Schema V3.1-RC
* Describes ad-hoc changes to the system.
*
* ## Links
* - [GBFS Specification](https://github.com/MobilityData/gbfs/blob/v3.1-RC/gbfs.md#system_alertsjson)
*/
export declare const gbfsSystemAlertsSchemaV31RC: {
$schema: string;
$id: string;
description: string;
type: string;
properties: {
last_updated: {
description: string;
type: string;
format: string;
};
ttl: {
description: string;
type: string;
minimum: number;
};
version: {
description: string;
type: string;
const: string;
};
data: {
description: string;
type: string;
properties: {
alerts: {
type: string;
items: {
type: string;
properties: {
alert_id: {
description: string;
type: string;
};
type: {
description: string;
type: string;
enum: string[];
};
times: {
description: string;
type: string;
items: {
type: string;
properties: {
start: {
description: string;
type: string;
format: string;
};
end: {
description: string;
type: string;
format: string;
};
};
};
additionalItems: boolean;
required: string[];
};
station_ids: {
description: string;
type: string;
items: {
type: string;
};
};
region_ids: {
description: string;
type: string;
items: {
type: string;
};
};
url: {
description: string;
type: string;
items: {
type: string;
properties: {
text: {
description: string;
type: string;
format: string;
};
language: {
description: string;
type: string;
pattern: string;
};
};
required: string[];
};
};
summary: {
description: string;
type: string;
items: {
type: string;
properties: {
text: {
description: string;
type: string;
};
language: {
description: string;
type: string;
pattern: string;
};
};
required: string[];
};
};
description: {
description: string;
type: string;
items: {
type: string;
properties: {
text: {
description: string;
type: string;
};
language: {
description: string;
type: string;
pattern: string;
};
};
required: string[];
};
};
last_updated: {
description: string;
type: string;
format: string;
};
};
required: string[];
};
};
};
required: string[];
};
};
required: string[];
};
/**
* # GBFS System Alerts Schema V3.1-RC
* Describes ad-hoc changes to the system.
*
* ## Links
* - [GBFS Specification](https://github.com/MobilityData/gbfs/blob/v3.1-RC/gbfs.md#system_alertsjson)
*/
export interface GBFSSystemAlertsV31RC {
/**
* Last time the data in the feed was updated in RFC3339 format.
* **Format**: date-time
*/
last_updated: string;
/**
* Number of seconds before the data in the feed will be updated again
* (0 if the data should always be refreshed).
* **Minimum**: 0
*/
ttl: number;
/**
* GBFS version number to which the feed conforms, according to the versioning framework (added in v1.1).
* **Const**: 3.1-RC
*/
version: '3.1-RC';
/**
* Contains ad-hoc alerts for the system.
*/
data: {
/**
* Array of alerts describing ad-hoc system changes.
*/
alerts: Array<{
/**
* Identifier for this alert.
*/
alert_id: string;
/**
* Type of alert.
* **Enum**: ['system_closure', 'station_closure', 'station_move', 'other']
*/
type: 'system_closure' | 'station_closure' | 'station_move' | 'other';
/**
* Array of objects indicating when the alert is in effect.
*/
times?: Array<{
/**
* Start time of the alert.
* **Format**: date-time
*/
start: string;
/**
* End time of the alert.
* **Format**: date-time
*/
end?: string;
}>;
/**
* Array of station IDs for which this alert applies.
*/
station_ids?: string[];
/**
* Array of region IDs for which this alert applies.
*/
region_ids?: string[];
/**
* URL where the customer can learn more information about this alert.
*/
url?: Array<{
/**
* Translated text of the URL.
* **Format**: uri
*/
text: string;
/**
* IETF BCP 47 language code.
* **Pattern**: `^[a-z]{2,3}(-[A-Z]{2})?$`
*/
language: string;
}>;
/**
* A short summary of this alert to be displayed to the customer.
*/
summary: Array<{
/**
* Translated text of the summary.
*/
text: string;
/**
* IETF BCP 47 language code.
* **Pattern**: `^[a-z]{2,3}(-[A-Z]{2})?$`
*/
language: string;
}>;
/**
* Detailed description of the alert.
*/
description?: Array<{
/**
* Translated text of the description.
*/
text: string;
/**
* IETF BCP 47 language code.
* **Pattern**: `^[a-z]{2,3}(-[A-Z]{2})?$`
*/
language: string;
}>;
/**
* Indicates the last time the info for the alert was updated.
* **Format**: date-time
*/
last_updated?: string;
}>;
};
}
/**
* # GBFS System Alerts Schema V3.0
* Describes ad-hoc changes to the system.
*
* ## Links
* - [GBFS Specification](https://github.com/MobilityData/gbfs/blob/v3.0/gbfs.md#system_alertsjson)
*/
export declare const gbfsSystemAlertsSchemaV30: {
$schema: string;
$id: string;
description: string;
type: string;
properties: {
last_updated: {
description: string;
type: string;
format: string;
};
ttl: {
description: string;
type: string;
minimum: number;
};
version: {
description: string;
type: string;
const: string;
};
data: {
description: string;
type: string;
properties: {
alerts: {
type: string;
items: {
type: string;
properties: {
alert_id: {
description: string;
type: string;
};
type: {
description: string;
type: string;
enum: string[];
};
times: {
description: string;
type: string;
items: {
type: string;
properties: {
start: {
description: string;
type: string;
format: string;
};
end: {
description: string;
type: string;
format: string;
};
};
};
additionalItems: boolean;
required: string[];
};
station_ids: {
description: string;
type: string;
items: {
type: string;
};
};
region_ids: {
description: string;
type: string;
items: {
type: string;
};
};
url: {
description: string;
type: string;
items: {
type: string;
properties: {
text: {
description: string;
type: string;
format: string;
};
language: {
description: string;
type: string;
pattern: string;
};
};
required: string[];
};
};
summary: {
description: string;
type: string;
items: {
type: string;
properties: {
text: {
description: string;
type: string;
};
language: {
description: string;
type: string;
pattern: string;
};
};
required: string[];
};
};
description: {
description: string;
type: string;
items: {
type: string;
properties: {
text: {
description: string;
type: string;
};
language: {
description: string;
type: string;
pattern: string;
};
};
required: string[];
};
};
last_updated: {
description: string;
type: string;
format: string;
};
};
required: string[];
};
};
};
required: string[];
};
};
required: string[];
};
/**
* # GBFS System Alerts Schema V3.0
* Describes ad-hoc changes to the system.
*
* ## Links
* - [GBFS Specification](https://github.com/MobilityData/gbfs/blob/v3.0/gbfs.md#system_alertsjson)
*/
export interface GBFSSystemAlertsV30 {
/**
* Last time the data in the feed was updated in RFC3339 format.
* **Format**: date-time
*/
last_updated: string;
/**
* Number of seconds before the data in the feed will be updated again (0 if the data should always be refreshed).
* **Minimum**: 0
*/
ttl: number;
/**
* GBFS version number to which the feed conforms.
* **Const**: '3.0'
*/
version: '3.0';
/**
* Data object containing system alerts.
*/
data: {
/**
* Array of alerts for the system.
*/
alerts: Array<{
/**
* Identifier for this alert.
*/
alert_id: string;
/**
* Type of alert.
* Possible values: 'system_closure', 'station_closure', 'station_move', 'other'.
*/
type: 'system_closure' | 'station_closure' | 'station_move' | 'other';
/**
* Array of objects indicating when the alert is in effect.
*/
times?: Array<{
/**
* Start time of the alert in RFC3339 format.
* **Format**: date-time
*/
start: string;
/**
* End time of the alert in RFC3339 format.
* **Format**: date-time
*/
end?: string;
}>;
/**
* Array of identifiers of the stations for which this alert applies.
*/
station_ids?: string[];
/**
* Array of identifiers of the regions for which this alert applies.
*/
region_ids?: string[];
/**
* URL where customers can learn more information about this alert.
*/
url?: Array<{
/**
* Translated text for the URL.
*/
text: string;
/**
* IETF BCP 47 language code.
*/
language: string;
}>;
/**
* Short summary of this alert to be displayed to the customer.
*/
summary: Array<{
/**
* Translated text for the summary.
*/
text: string;
/**
* IETF BCP 47 language code.
*/
language: string;
}>;
/**
* Detailed description of the alert.
*/
description?: Array<{
/**
* Translated text for the description.
*/
text: string;
/**
* IETF BCP 47 language code.
*/
language: string;
}>;
/**
* Indicates the last time the info for the alert was updated in RFC3339 format.
* **Format**: date-time
*/
last_updated?: string;
}>;
};
}
//# sourceMappingURL=systemAlerts.d.ts.map