s2-tools
Version:
A collection of geospatial tools primarily designed for WGS84, Web Mercator, and S2.
646 lines • 23.6 kB
TypeScript
/**
* # GBFS Vehicle Types V2.3, V2.2, V2.1, OR V2.0
* Describes the types of vehicles that System operator has available for rent (added in v2.1-RC).
*
* ## Links
* - [GBFS Specification V2.3](https://github.com/MobilityData/gbfs/blob/v2.3/gbfs.md#system_pricing_plansjson)
* - [GBFS Specification V2.2](https://github.com/MobilityData/gbfs/blob/v2.2/gbfs.md#system_pricing_plansjson)
* - [GBFS Specification V2.1](https://github.com/MobilityData/gbfs/blob/v2.1/gbfs.md#system_pricing_plansjson)
*/
export type GBFSVehicleTypesV2 = GBFSVehicleTypesV23 | GBFSVehicleTypesV22 | GBFSVehicleTypesV21;
/**
* # GBFS Vehicle Types Schema V2.3
* Describes the types of vehicles that System operator has available for rent (added in v2.1-RC).
*
* ## Links
* - [GBFS Specification](https://github.com/MobilityData/gbfs/blob/v2.3/gbfs.md#vehicle_typesjson)
*/
export declare const gbfsVehicleTypesSchemaV2: {
$schema: string;
$id: string;
description: string;
type: string;
properties: {
last_updated: {
description: string;
type: string;
minimum: number;
};
ttl: {
description: string;
type: string;
minimum: number;
};
version: {
description: string;
type: string;
const: string;
};
data: {
description: string;
type: string;
properties: {
vehicle_types: {
description: string;
type: string;
items: {
type: string;
properties: {
vehicle_type_id: {
description: string;
type: string;
};
form_factor: {
description: string;
type: string;
enum: string[];
};
rider_capacity: {
description: string;
type: string;
minimum: number;
};
cargo_volume_capacity: {
description: string;
type: string;
minimum: number;
};
cargo_load_capacity: {
description: string;
type: string;
minimum: number;
};
propulsion_type: {
description: string;
type: string;
enum: string[];
};
eco_label: {
description: string;
type: string;
items: {
type: string;
properties: {
country_code: {
description: string;
type: string;
pattern: string;
};
eco_sticker: {
description: string;
type: string;
};
};
};
required: string[];
};
max_range_meters: {
description: string;
type: string;
minimum: number;
};
name: {
description: string;
type: string;
};
vehicle_accessories: {
description: string;
type: string;
items: {
enum: string[];
};
};
g_CO2_km: {
description: string;
type: string;
minimum: number;
};
vehicle_image: {
description: string;
type: string;
format: string;
};
make: {
description: string;
type: string;
};
model: {
description: string;
type: string;
};
color: {
description: string;
type: string;
};
wheel_count: {
description: string;
type: string;
minimum: number;
};
max_permitted_speed: {
description: string;
type: string;
minimum: number;
};
rated_power: {
description: string;
type: string;
minimum: number;
};
default_reserve_time: {
description: string;
type: string;
minimum: number;
};
return_constraint: {
description: string;
type: string;
enum: string[];
};
vehicle_assets: {
description: string;
type: string;
properties: {
icon_url: {
description: string;
type: string;
format: string;
};
icon_url_dark: {
description: string;
type: string;
format: string;
};
icon_last_modified: {
description: string;
type: string;
format: string;
};
};
required: string[];
};
default_pricing_plan_id: {
description: string;
type: string;
};
pricing_plan_ids: {
description: string;
type: string;
items: {
type: string;
};
};
};
required: string[];
if: {
properties: {
propulsion_type: {
enum: string[];
};
};
};
then: {
required: string[];
};
};
};
};
required: string[];
};
};
required: string[];
};
/**
* # GBFS Vehicle Types V2.3
* Describes the types of vehicles that System operator has available for rent (added in v2.1-RC).
*
* ## Links
* - [GBFS Specification](https://github.com/MobilityData/gbfs/blob/v2.3/gbfs.md#vehicle_typesjson)
*/
export interface GBFSVehicleTypesV23 {
/**
* Last time the data in the feed was updated in POSIX time.
* Minimum: 1450155600.
*/
last_updated: number;
/**
* Number of seconds before the data in the feed will be updated again
* (0 if the data should always be refreshed).
*/
ttl: number;
/**
* GBFS version number to which the feed conforms.
*/
version: '2.3';
/**
* Response data in the form of name:value pairs.
*/
data: {
/**
* Array of vehicle types available in the system.
*/
vehicle_types: {
/**
* Unique identifier of a vehicle type.
*/
vehicle_type_id: string;
/**
* The vehicle's general form factor.
*/
form_factor: 'bicycle' | 'cargo_bicycle' | 'car' | 'moped' | 'scooter_standing' | 'scooter_seated' | 'other' | 'scooter';
/**
* The primary propulsion type of the vehicle.
*/
propulsion_type: 'human' | 'electric_assist' | 'electric' | 'combustion' | 'combustion_diesel' | 'hybrid' | 'plug_in_hybrid' | 'hydrogen_fuel_cell';
/**
* The number of riders (driver included) the vehicle can legally accommodate.
* Minimum: 0.
*/
rider_capacity?: number;
/**
* Cargo volume available in the vehicle, expressed in liters.
* Minimum: 0.
*/
cargo_volume_capacity?: number;
/**
* The capacity of the vehicle cargo space (excluding passengers), expressed in kilograms.
* Minimum: 0.
*/
cargo_load_capacity?: number;
/**
* The furthest distance in meters that the vehicle can travel without recharging or refueling
* when it has the maximum amount of energy potential.
* Minimum: 0.
*/
max_range_meters?: number;
/**
* The public name of this vehicle type.
*/
name?: string;
/**
* Description of accessories available in the vehicle.
*/
vehicle_accessories?: Array<'air_conditioning' | 'automatic' | 'manual' | 'convertible' | 'cruise_control' | 'doors_2' | 'doors_3' | 'doors_4' | 'doors_5' | 'navigation'>;
/**
* Maximum quantity of CO2, in grams, emitted per kilometer, according to the WLTP.
* Minimum: 0.
*/
g_CO2_km?: number;
/**
* URL to an image that would assist the user in identifying the vehicle.
* JPEG or PNG.
*/
vehicle_image?: string;
/**
* The name of the vehicle manufacturer.
*/
make?: string;
/**
* The name of the vehicle model.
*/
model?: string;
/**
* The color of the vehicle.
*/
color?: string;
/**
* Number of wheels this vehicle type has.
* Minimum: 0.
*/
wheel_count?: number;
/**
* The maximum speed in kilometers per hour this vehicle is permitted to reach in accordance
* with local permit and regulations.
* Minimum: 0.
*/
max_permitted_speed?: number;
/**
* The rated power of the motor for this vehicle type in watts.
* Minimum: 0.
*/
rated_power?: number;
/**
* Maximum time in minutes that a vehicle can be reserved before a rental begins.
* Minimum: 0.
*/
default_reserve_time?: number;
/**
* The conditions for returning the vehicle at the end of the trip.
*/
return_constraint?: 'free_floating' | 'roundtrip_station' | 'any_station' | 'hybrid';
/**
* A plan_id as defined in system_pricing_plans.json.
*/
default_pricing_plan_id?: string;
/**
* Array of all pricing plan IDs as defined in system_pricing_plans.json.
*/
pricing_plan_ids?: string[];
/**
* Vehicle air quality certificate.
*/
eco_label?: Array<{
/**
* Country code following the ISO 3166-1 alpha-2 notation.
*/
country_code: string;
/**
* Name of the eco label.
*/
eco_sticker: string;
}>;
/**
* An object where each key defines vehicle assets.
*/
vehicle_assets?: {
/**
* A fully qualified URL pointing to the location of a graphic icon file
* that MAY be used to represent this vehicle type on maps and in other applications.
*/
icon_url: string;
/**
* A fully qualified URL pointing to the location of a graphic icon file to
* be used to represent this vehicle type when in dark mode.
*/
icon_url_dark?: string;
/**
* Date that indicates the last time any included vehicle icon images were modified or updated.
*/
icon_last_modified: string;
};
}[];
};
}
/**
* # GBFS Vehicle Types Schema V2.2
* Describes the types of vehicles that System operator has available for rent (added in v2.1-RC).
*
* ## Links
* - [GBFS Specification](https://github.com/MobilityData/gbfs/blob/v2.2/gbfs.md#vehicle_typesjson)
*/
export declare const gbfsVehicleTypesSchemaV22: {
$schema: string;
$id: string;
description: string;
type: string;
properties: {
last_updated: {
description: string;
type: string;
minimum: number;
};
ttl: {
description: string;
type: string;
minimum: number;
};
version: {
description: string;
type: string;
const: string;
};
data: {
description: string;
type: string;
properties: {
vehicle_types: {
description: string;
type: string;
items: {
type: string;
properties: {
vehicle_type_id: {
description: string;
type: string;
};
form_factor: {
description: string;
type: string;
enum: string[];
};
propulsion_type: {
description: string;
type: string;
enum: string[];
};
max_range_meters: {
description: string;
type: string;
minimum: number;
};
name: {
description: string;
type: string;
};
};
required: string[];
if: {
properties: {
propulsion_type: {
enum: string[];
};
};
};
then: {
required: string[];
};
};
};
};
required: string[];
};
};
required: string[];
};
/**
* # GBFS Vehicle Types V2.2
* Describes the types of vehicles that System operator has available for rent (added in v2.1-RC).
*
* ## Links
* - [GBFS Specification](https://github.com/MobilityData/gbfs/blob/v2.3/gbfs.md#vehicle_typesjson)
*/
export interface GBFSVehicleTypesV22 {
/**
* Last time the data in the feed was updated in POSIX time.
* Minimum: 1450155600.
*/
last_updated: number;
/**
* Number of seconds before the data in the feed will be updated again
* (0 if the data should always be refreshed).
*/
ttl: number;
/**
* GBFS version number to which the feed conforms.
*/
version: '2.2';
/**
* Response data in the form of name:value pairs.
*/
data: {
/**
* Array of vehicle types available in the system.
*/
vehicle_types: {
/**
* Unique identifier of a vehicle type.
*/
vehicle_type_id: string;
/**
* The vehicle's general form factor.
*/
form_factor: 'bicycle' | 'car' | 'moped' | 'other' | 'scooter';
/**
* The primary propulsion type of the vehicle.
*/
propulsion_type: 'human' | 'electric_assist' | 'electric' | 'combustion';
/**
* The furthest distance in meters that the vehicle can travel without recharging or refueling
* when it has the maximum amount of energy potential.
* Minimum: 0.
*/
max_range_meters?: number;
/**
* The public name of this vehicle type.
*/
name?: string;
}[];
};
}
/**
* # GBFS Vehicle Types Schema V2.1
* Describes the types of vehicles that System operator has available for rent (added in v2.1-RC).
*
* ## Links
* - [GBFS Specification](https://github.com/MobilityData/gbfs/blob/v2.1/gbfs.md#vehicle_typesjson)
*/
export declare const gbfsVehicleTypesSchemaV21: {
$schema: string;
$id: string;
description: string;
type: string;
properties: {
last_updated: {
description: string;
type: string;
minimum: number;
};
ttl: {
description: string;
type: string;
minimum: number;
};
version: {
description: string;
type: string;
const: string;
};
data: {
description: string;
type: string;
properties: {
vehicle_types: {
description: string;
type: string;
items: {
type: string;
properties: {
vehicle_type_id: {
description: string;
type: string;
};
form_factor: {
description: string;
type: string;
enum: string[];
};
propulsion_type: {
description: string;
type: string;
enum: string[];
};
max_range_meters: {
description: string;
type: string;
minimum: number;
};
name: {
description: string;
type: string;
};
};
required: string[];
if: {
properties: {
propulsion_type: {
enum: string[];
};
};
};
then: {
required: string[];
};
};
};
};
required: string[];
};
};
required: string[];
};
/**
* # GBFS Vehicle Types V2.1
* Describes the types of vehicles that System operator has available for rent (added in v2.1-RC).
*
* ## Links
* - [GBFS Specification](https://github.com/MobilityData/gbfs/blob/v2.1/gbfs.md#vehicle_typesjson)
*/
export interface GBFSVehicleTypesV21 {
/**
* Last time the data in the feed was updated in POSIX time.
* Minimum: 1450155600.
*/
last_updated: number;
/**
* Number of seconds before the data in the feed will be updated again
* (0 if the data should always be refreshed).
*/
ttl: number;
/**
* GBFS version number to which the feed conforms.
*/
version: '2.1';
/**
* Response data in the form of name:value pairs.
*/
data: {
/**
* Array of vehicle types available in the system.
*/
vehicle_types: {
/**
* Unique identifier of a vehicle type.
*/
vehicle_type_id: string;
/**
* The vehicle's general form factor.
*/
form_factor: 'bicycle' | 'car' | 'moped' | 'other' | 'scooter';
/**
* The primary propulsion type of the vehicle.
*/
propulsion_type: 'human' | 'electric_assist' | 'electric' | 'combustion';
/**
* The furthest distance in meters that the vehicle can travel without recharging or refueling
* when it has the maximum amount of energy potential.
* Minimum: 0.
*/
max_range_meters?: number;
/**
* The public name of this vehicle type.
*/
name?: string;
}[];
};
}
//# sourceMappingURL=vehicleTypes.d.ts.map