@azure-rest/maps-route 1.0.0-beta.5 → 1.0.0-beta.6

package/review/maps-route-node.api.md

@@ -0,0 +1,934 @@
+## API Report File for "@azure-rest/maps-route"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { AbortSignalLike } from '@azure/abort-controller';
+import type { AzureKeyCredential } from '@azure/core-auth';
+import type { AzureSASCredential } from '@azure/core-auth';
+import { CancelOnProgress } from '@azure/core-lro';
+import { Client } from '@azure-rest/core-client';
+import { ClientOptions } from '@azure-rest/core-client';
+import { CreateHttpPollerOptions } from '@azure/core-lro';
+import { HttpResponse } from '@azure-rest/core-client';
+import type { LatLon } from '@azure/maps-common';
+import { OperationState } from '@azure/core-lro';
+import { RawHttpHeaders } from '@azure/core-rest-pipeline';
+import { RequestParameters } from '@azure-rest/core-client';
+import { StreamableMethod } from '@azure-rest/core-client';
+import type { TokenCredential } from '@azure/core-auth';
+
+// @public
+export interface BatchRequest {
+    batchItems?: Array<BatchRequestItem>;
+}
+
+// @public
+export interface BatchRequestItem {
+    query?: string;
+}
+
+// @public
+export interface BatchResultItemOutput {
+    readonly statusCode: number;
+}
+
+// @public
+export interface BatchResultOutput {
+    readonly summary: BatchResultSummaryOutput;
+}
+
+// @public
+export interface BatchResultSummaryOutput {
+    readonly successfulRequests: number;
+    readonly totalRequests: number;
+}
+
+// @public (undocumented)
+export function buildMultiCollection(items: string[], parameterName: string): string;
+
+// @public
+export function createRouteDirectionsBatchRequest(queryParamProperties: RouteGetRouteDirectionsQueryParamProperties[]): BatchRequest;
+
+// @public
+export interface EffectiveSettingOutput {
+    readonly key: string;
+    readonly value: string;
+}
+
+// @public
+export interface ErrorDetailOutput {
+    readonly code?: string;
+    readonly message?: string;
+}
+
+// @public
+export interface ErrorResponseOutput {
+    error?: ErrorDetailOutput;
+}
+
+// @public
+export interface GeoJsonFeature extends GeoJsonObjectParent, GeoJsonFeatureData {
+    // (undocumented)
+    type: "Feature";
+}
+
+// @public
+export interface GeoJsonFeatureCollection extends GeoJsonObjectParent, GeoJsonFeatureCollectionData {
+    // (undocumented)
+    type: "FeatureCollection";
+}
+
+// @public (undocumented)
+export interface GeoJsonFeatureCollectionData {
+    features: Array<GeoJsonFeature>;
+}
+
+// @public (undocumented)
+export interface GeoJsonFeatureData {
+    featureType?: string;
+    geometry: GeoJsonGeometry;
+    id?: string;
+    properties?: Record<string, unknown>;
+}
+
+// @public
+export type GeoJsonGeometry = GeoJsonGeometryParent | GeoJsonMultiPoint | GeoJsonMultiPolygon | GeoJsonPoint | GeoJsonLineString | GeoJsonMultiLineString | GeoJsonPolygon | GeoJsonGeometryCollection;
+
+// @public
+export interface GeoJsonGeometryCollection extends GeoJsonGeometryParent, GeoJsonGeometryCollectionData {
+    // (undocumented)
+    type: "GeometryCollection";
+}
+
+// @public (undocumented)
+export interface GeoJsonGeometryCollectionData {
+    geometries: Array<GeoJsonGeometry>;
+}
+
+// @public
+export interface GeoJsonGeometryParent extends GeoJsonObjectParent {
+    // (undocumented)
+    type: "GeoJsonGeometry" | "MultiPoint" | "MultiPolygon" | "Point" | "LineString" | "MultiLineString" | "Polygon" | "GeometryCollection";
+}
+
+// @public
+export interface GeoJsonLineString extends GeoJsonGeometryParent, GeoJsonLineStringData {
+    // (undocumented)
+    type: "LineString";
+}
+
+// @public (undocumented)
+export interface GeoJsonLineStringData {
+    coordinates: Array<Array<number>>;
+}
+
+// @public
+export interface GeoJsonMultiLineString extends GeoJsonGeometryParent, GeoJsonMultiLineStringData {
+    // (undocumented)
+    type: "MultiLineString";
+}
+
+// @public (undocumented)
+export interface GeoJsonMultiLineStringData {
+    coordinates: Array<Array<Array<number>>>;
+}
+
+// @public
+export interface GeoJsonMultiPoint extends GeoJsonGeometryParent, GeoJsonMultiPointData {
+    // (undocumented)
+    type: "MultiPoint";
+}
+
+// @public
+export interface GeoJsonMultiPointData {
+    coordinates: Array<Array<number>>;
+}
+
+// @public
+export interface GeoJsonMultiPolygon extends GeoJsonGeometryParent, GeoJsonMultiPolygonData {
+    // (undocumented)
+    type: "MultiPolygon";
+}
+
+// @public (undocumented)
+export interface GeoJsonMultiPolygonData {
+    coordinates: Array<Array<Array<Array<number>>>>;
+}
+
+// @public
+export type GeoJsonObject = GeoJsonGeometry | GeoJsonMultiPoint | GeoJsonMultiPolygon | GeoJsonPoint | GeoJsonLineString | GeoJsonMultiLineString | GeoJsonPolygon | GeoJsonGeometryCollection | GeoJsonFeature | GeoJsonFeatureCollection;
+
+// @public
+export interface GeoJsonObjectParent {
+    // (undocumented)
+    type: "GeoJsonObject" | "GeoJsonGeometry" | "MultiPoint" | "MultiPolygon" | "Point" | "LineString" | "MultiLineString" | "Polygon" | "GeometryCollection" | "Feature" | "FeatureCollection";
+}
+
+// @public
+export interface GeoJsonPoint extends GeoJsonGeometryParent, GeoJsonPointData {
+    // (undocumented)
+    type: "Point";
+}
+
+// @public
+export interface GeoJsonPointData {
+    coordinates: Array<number>;
+}
+
+// @public
+export interface GeoJsonPolygon extends GeoJsonGeometryParent, GeoJsonPolygonData {
+    // (undocumented)
+    type: "Polygon";
+}
+
+// @public (undocumented)
+export interface GeoJsonPolygonData {
+    coordinates: Array<Array<Array<number>>>;
+}
+
+// @public
+export function getLongRunningPoller<TResult extends HttpResponse>(client: Client, initialResponse: TResult, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>;
+
+// @public (undocumented)
+export interface GetRouteDirections {
+    get(options: RouteGetRouteDirectionsParameters): StreamableMethod<RouteGetRouteDirections200Response | RouteGetRouteDirectionsDefaultResponse>;
+    post(options: RouteGetRouteDirectionsWithAdditionalParametersParameters): StreamableMethod<RouteGetRouteDirectionsWithAdditionalParameters200Response | RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse>;
+}
+
+// @public (undocumented)
+export interface GetRouteRange {
+    get(options: RouteGetRouteRangeParameters): StreamableMethod<RouteGetRouteRange200Response | RouteGetRouteRangeDefaultResponse>;
+}
+
+// @public (undocumented)
+export function isUnexpected(response: RouteRequestRouteMatrixSync200Response | RouteRequestRouteMatrixSync408Response | RouteRequestRouteMatrixSyncDefaultResponse): response is RouteRequestRouteMatrixSync408Response;
+
+// @public (undocumented)
+export function isUnexpected(response: RouteGetRouteDirections200Response | RouteGetRouteDirectionsDefaultResponse): response is RouteGetRouteDirectionsDefaultResponse;
+
+// @public (undocumented)
+export function isUnexpected(response: RouteGetRouteDirectionsWithAdditionalParameters200Response | RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse): response is RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse;
+
+// @public (undocumented)
+export function isUnexpected(response: RouteGetRouteRange200Response | RouteGetRouteRangeDefaultResponse): response is RouteGetRouteRangeDefaultResponse;
+
+// @public (undocumented)
+export function isUnexpected(response: RouteRequestRouteDirectionsBatchSync200Response | RouteRequestRouteDirectionsBatchSync408Response | RouteRequestRouteDirectionsBatchSyncDefaultResponse): response is RouteRequestRouteDirectionsBatchSync408Response;
+
+// @public
+export interface LatLongPairOutput {
+    latitude: number;
+    longitude: number;
+}
+
+// @public
+function MapsRoute(credential: AzureKeyCredential, options?: ClientOptions): MapsRouteClient;
+
+// @public
+function MapsRoute(credential: TokenCredential, mapsAccountClientId: string, options?: ClientOptions): MapsRouteClient;
+
+// @public
+function MapsRoute(credential: AzureSASCredential, options?: ClientOptions): MapsRouteClient;
+export default MapsRoute;
+
+// @public (undocumented)
+export type MapsRouteClient = Client & {
+    path: Routes;
+};
+
+// @public
+export interface MapsRouteClientOptions extends ClientOptions {
+    apiVersion?: string;
+}
+
+// @public (undocumented)
+export interface RequestRouteDirectionsBatch {
+    get(options?: RouteGetRouteDirectionsBatchParameters): StreamableMethod<RouteGetRouteDirectionsBatch200Response | RouteGetRouteDirectionsBatch202Response>;
+    post(options: RouteRequestRouteDirectionsBatchParameters): StreamableMethod<RouteRequestRouteDirectionsBatch200Response | RouteRequestRouteDirectionsBatch202Response>;
+}
+
+// @public (undocumented)
+export interface RequestRouteDirectionsBatchSync {
+    post(options: RouteRequestRouteDirectionsBatchSyncParameters): StreamableMethod<RouteRequestRouteDirectionsBatchSync200Response | RouteRequestRouteDirectionsBatchSync408Response | RouteRequestRouteDirectionsBatchSyncDefaultResponse>;
+}
+
+// @public (undocumented)
+export interface RequestRouteMatrix {
+    get(options?: RouteGetRouteMatrixParameters): StreamableMethod<RouteGetRouteMatrix200Response | RouteGetRouteMatrix202Response>;
+    post(options: RouteRequestRouteMatrixParameters): StreamableMethod<RouteRequestRouteMatrix200Response | RouteRequestRouteMatrix202Response>;
+}
+
+// @public (undocumented)
+export interface RequestRouteMatrixSync {
+    post(options: RouteRequestRouteMatrixSyncParameters): StreamableMethod<RouteRequestRouteMatrixSync200Response | RouteRequestRouteMatrixSync408Response | RouteRequestRouteMatrixSyncDefaultResponse>;
+}
+
+// @public
+export interface RouteDirectionParameters {
+    allowVignette?: Array<string>;
+    avoidAreas?: GeoJsonMultiPolygon;
+    avoidVignette?: Array<string>;
+    supportingPoints?: Record<string, unknown>;
+}
+
+// @public
+export interface RouteDirectionsBatchItemOutput extends BatchResultItemOutput {
+    readonly response: RouteDirectionsBatchItemResponseOutput;
+}
+
+// @public
+export interface RouteDirectionsBatchItemResponseOutput extends RouteDirectionsOutput, ErrorResponseOutput {
+}
+
+// @public
+export interface RouteDirectionsBatchResultOutput extends BatchResultOutput {
+    readonly batchItems: Array<RouteDirectionsBatchItemOutput>;
+}
+
+// @public
+export interface RouteDirectionsOutput {
+    readonly formatVersion?: string;
+    readonly optimizedWaypoints?: Array<RouteOptimizedWaypointOutput>;
+    report?: RouteReportOutput;
+    readonly routes: Array<RouteOutput>;
+}
+
+// @public
+export interface RouteGetRouteDirections200Response extends HttpResponse {
+    // (undocumented)
+    body: RouteDirectionsOutput;
+    // (undocumented)
+    status: "200";
+}
+
+// @public
+export interface RouteGetRouteDirectionsBatch200Response extends HttpResponse {
+    // (undocumented)
+    body: RouteDirectionsBatchResultOutput;
+    // (undocumented)
+    status: "200";
+}
+
+// @public (undocumented)
+export interface RouteGetRouteDirectionsBatch202Headers {
+    location?: string;
+}
+
+// @public
+export interface RouteGetRouteDirectionsBatch202Response extends HttpResponse {
+    // (undocumented)
+    headers: RawHttpHeaders & RouteGetRouteDirectionsBatch202Headers;
+    // (undocumented)
+    status: "202";
+}
+
+// @public (undocumented)
+export type RouteGetRouteDirectionsBatchParameters = RequestParameters;
+
+// @public
+export interface RouteGetRouteDirectionsDefaultResponse extends HttpResponse {
+    // (undocumented)
+    body: ErrorResponseOutput;
+    // (undocumented)
+    status: string;
+}
+
+// @public (undocumented)
+export type RouteGetRouteDirectionsParameters = RouteGetRouteDirectionsQueryParam & RequestParameters;
+
+// @public (undocumented)
+export interface RouteGetRouteDirectionsQueryParam {
+    // (undocumented)
+    queryParameters: RouteGetRouteDirectionsQueryParamProperties;
+}
+
+// @public (undocumented)
+export interface RouteGetRouteDirectionsQueryParamProperties {
+    accelerationEfficiency?: number;
+    alternativeType?: "anyRoute" | "betterRoute";
+    arriveAt?: Date | string;
+    auxiliaryPowerInkW?: number;
+    auxiliaryPowerInLitersPerHour?: number;
+    avoid?: Array<"tollRoads" | "motorways" | "ferries" | "unpavedRoads" | "carpools" | "alreadyUsedRoads" | "borderCrossings">;
+    computeBestOrder?: boolean;
+    computeTravelTimeFor?: "none" | "all";
+    constantSpeedConsumptionInkWhPerHundredkm?: string;
+    constantSpeedConsumptionInLitersPerHundredkm?: string;
+    currentChargeInkWh?: number;
+    currentFuelInLiters?: number;
+    decelerationEfficiency?: number;
+    departAt?: Date | string;
+    downhillEfficiency?: number;
+    fuelEnergyDensityInMJoulesPerLiter?: number;
+    hilliness?: "low" | "normal" | "high";
+    instructionsType?: "coded" | "text" | "tagged";
+    language?: string;
+    maxAlternatives?: number;
+    maxChargeInkWh?: number;
+    minDeviationDistance?: number;
+    minDeviationTime?: number;
+    query: string;
+    report?: "effectiveSettings";
+    routeRepresentation?: "polyline" | "summaryOnly" | "none";
+    routeType?: "fastest" | "shortest" | "eco" | "thrilling";
+    sectionType?: Array<"carTrain" | "country" | "ferry" | "motorway" | "pedestrian" | "tollRoad" | "tollVignette" | "traffic" | "travelMode" | "tunnel" | "carpool" | "urban">;
+    traffic?: boolean;
+    travelMode?: "car" | "truck" | "taxi" | "bus" | "van" | "motorcycle" | "bicycle" | "pedestrian";
+    uphillEfficiency?: number;
+    vehicleAxleWeight?: number;
+    vehicleCommercial?: boolean;
+    vehicleEngineType?: "combustion" | "electric";
+    vehicleHeading?: number;
+    vehicleHeight?: number;
+    vehicleLength?: number;
+    vehicleLoadType?: "USHazmatClass1" | "USHazmatClass2" | "USHazmatClass3" | "USHazmatClass4" | "USHazmatClass5" | "USHazmatClass6" | "USHazmatClass7" | "USHazmatClass8" | "USHazmatClass9" | "otherHazmatExplosive" | "otherHazmatGeneral" | "otherHazmatHarmfulToWater";
+    vehicleMaxSpeed?: number;
+    vehicleWeight?: number;
+    vehicleWidth?: number;
+    windingness?: "low" | "normal" | "high";
+}
+
+// @public
+export interface RouteGetRouteDirectionsWithAdditionalParameters200Response extends HttpResponse {
+    // (undocumented)
+    body: RouteDirectionsOutput;
+    // (undocumented)
+    status: "200";
+}
+
+// @public (undocumented)
+export interface RouteGetRouteDirectionsWithAdditionalParametersBodyParam {
+    body: RouteDirectionParameters;
+}
+
+// @public
+export interface RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse extends HttpResponse {
+    // (undocumented)
+    body: ErrorResponseOutput;
+    // (undocumented)
+    status: string;
+}
+
+// @public (undocumented)
+export interface RouteGetRouteDirectionsWithAdditionalParametersMediaTypesParam {
+    contentType?: "application/json";
+}
+
+// @public (undocumented)
+export type RouteGetRouteDirectionsWithAdditionalParametersParameters = RouteGetRouteDirectionsWithAdditionalParametersQueryParam & RouteGetRouteDirectionsWithAdditionalParametersMediaTypesParam & RouteGetRouteDirectionsWithAdditionalParametersBodyParam & RequestParameters;
+
+// @public (undocumented)
+export interface RouteGetRouteDirectionsWithAdditionalParametersQueryParam {
+    // (undocumented)
+    queryParameters: RouteGetRouteDirectionsWithAdditionalParametersQueryParamProperties;
+}
+
+// @public (undocumented)
+export interface RouteGetRouteDirectionsWithAdditionalParametersQueryParamProperties {
+    accelerationEfficiency?: number;
+    alternativeType?: "anyRoute" | "betterRoute";
+    arriveAt?: Date | string;
+    auxiliaryPowerInkW?: number;
+    auxiliaryPowerInLitersPerHour?: number;
+    avoid?: Array<"tollRoads" | "motorways" | "ferries" | "unpavedRoads" | "carpools" | "alreadyUsedRoads" | "borderCrossings">;
+    computeBestOrder?: boolean;
+    computeTravelTimeFor?: "none" | "all";
+    constantSpeedConsumptionInkWhPerHundredkm?: string;
+    constantSpeedConsumptionInLitersPerHundredkm?: string;
+    currentChargeInkWh?: number;
+    currentFuelInLiters?: number;
+    decelerationEfficiency?: number;
+    departAt?: Date | string;
+    downhillEfficiency?: number;
+    fuelEnergyDensityInMJoulesPerLiter?: number;
+    hilliness?: "low" | "normal" | "high";
+    instructionsType?: "coded" | "text" | "tagged";
+    language?: string;
+    maxAlternatives?: number;
+    maxChargeInkWh?: number;
+    minDeviationDistance?: number;
+    minDeviationTime?: number;
+    query: string;
+    report?: "effectiveSettings";
+    routeRepresentation?: "polyline" | "summaryOnly" | "none";
+    routeType?: "fastest" | "shortest" | "eco" | "thrilling";
+    sectionType?: Array<"carTrain" | "country" | "ferry" | "motorway" | "pedestrian" | "tollRoad" | "tollVignette" | "traffic" | "travelMode" | "tunnel" | "carpool" | "urban">;
+    traffic?: boolean;
+    travelMode?: "car" | "truck" | "taxi" | "bus" | "van" | "motorcycle" | "bicycle" | "pedestrian";
+    uphillEfficiency?: number;
+    vehicleAxleWeight?: number;
+    vehicleCommercial?: boolean;
+    vehicleEngineType?: "combustion" | "electric";
+    vehicleHeading?: number;
+    vehicleHeight?: number;
+    vehicleLength?: number;
+    vehicleLoadType?: "USHazmatClass1" | "USHazmatClass2" | "USHazmatClass3" | "USHazmatClass4" | "USHazmatClass5" | "USHazmatClass6" | "USHazmatClass7" | "USHazmatClass8" | "USHazmatClass9" | "otherHazmatExplosive" | "otherHazmatGeneral" | "otherHazmatHarmfulToWater";
+    vehicleMaxSpeed?: number;
+    vehicleWeight?: number;
+    vehicleWidth?: number;
+    windingness?: "low" | "normal" | "high";
+}
+
+// @public
+export interface RouteGetRouteMatrix200Response extends HttpResponse {
+    // (undocumented)
+    body: RouteMatrixResultOutput;
+    // (undocumented)
+    status: "200";
+}
+
+// @public (undocumented)
+export interface RouteGetRouteMatrix202Headers {
+    location?: string;
+}
+
+// @public
+export interface RouteGetRouteMatrix202Response extends HttpResponse {
+    // (undocumented)
+    headers: RawHttpHeaders & RouteGetRouteMatrix202Headers;
+    // (undocumented)
+    status: "202";
+}
+
+// @public (undocumented)
+export type RouteGetRouteMatrixParameters = RequestParameters;
+
+// @public
+export interface RouteGetRouteRange200Response extends HttpResponse {
+    // (undocumented)
+    body: RouteRangeResultOutput;
+    // (undocumented)
+    status: "200";
+}
+
+// @public
+export interface RouteGetRouteRangeDefaultResponse extends HttpResponse {
+    // (undocumented)
+    body: ErrorResponseOutput;
+    // (undocumented)
+    status: string;
+}
+
+// @public (undocumented)
+export type RouteGetRouteRangeParameters = RouteGetRouteRangeQueryParam & RequestParameters;
+
+// @public (undocumented)
+export interface RouteGetRouteRangeQueryParam {
+    // (undocumented)
+    queryParameters: RouteGetRouteRangeQueryParamProperties;
+}
+
+// @public (undocumented)
+export interface RouteGetRouteRangeQueryParamProperties {
+    accelerationEfficiency?: number;
+    auxiliaryPowerInkW?: number;
+    auxiliaryPowerInLitersPerHour?: number;
+    avoid?: Array<"tollRoads" | "motorways" | "ferries" | "unpavedRoads" | "carpools" | "alreadyUsedRoads" | "borderCrossings">;
+    constantSpeedConsumptionInkWhPerHundredkm?: string;
+    constantSpeedConsumptionInLitersPerHundredkm?: string;
+    currentChargeInkWh?: number;
+    currentFuelInLiters?: number;
+    decelerationEfficiency?: number;
+    departAt?: Date | string;
+    distanceBudgetInMeters?: number;
+    downhillEfficiency?: number;
+    energyBudgetInkWh?: number;
+    fuelBudgetInLiters?: number;
+    fuelEnergyDensityInMJoulesPerLiter?: number;
+    hilliness?: "low" | "normal" | "high";
+    maxChargeInkWh?: number;
+    query: Array<number>;
+    routeType?: "fastest" | "shortest" | "eco" | "thrilling";
+    timeBudgetInSec?: number;
+    traffic?: boolean;
+    travelMode?: "car" | "truck" | "taxi" | "bus" | "van" | "motorcycle" | "bicycle" | "pedestrian";
+    uphillEfficiency?: number;
+    vehicleAxleWeight?: number;
+    vehicleCommercial?: boolean;
+    vehicleEngineType?: "combustion" | "electric";
+    vehicleHeight?: number;
+    vehicleLength?: number;
+    vehicleLoadType?: "USHazmatClass1" | "USHazmatClass2" | "USHazmatClass3" | "USHazmatClass4" | "USHazmatClass5" | "USHazmatClass6" | "USHazmatClass7" | "USHazmatClass8" | "USHazmatClass9" | "otherHazmatExplosive" | "otherHazmatGeneral" | "otherHazmatHarmfulToWater";
+    vehicleMaxSpeed?: number;
+    vehicleWeight?: number;
+    vehicleWidth?: number;
+    windingness?: "low" | "normal" | "high";
+}
+
+// @public
+export interface RouteGuidanceOutput {
+    readonly instructionGroups: Array<RouteInstructionGroupOutput>;
+    readonly instructions: Array<RouteInstructionOutput>;
+}
+
+// @public
+export interface RouteInstructionGroupOutput {
+    readonly firstInstructionIndex?: number;
+    readonly groupLengthInMeters?: number;
+    readonly groupMessage?: string;
+    readonly lastInstructionIndex?: number;
+}
+
+// @public
+export interface RouteInstructionOutput {
+    readonly combinedMessage?: string;
+    readonly countryCode?: string;
+    readonly drivingSide?: "LEFT" | "RIGHT";
+    readonly exitNumber?: string;
+    instructionType?: "TURN" | "ROAD_CHANGE" | "LOCATION_DEPARTURE" | "LOCATION_ARRIVAL" | "DIRECTION_INFO" | "LOCATION_WAYPOINT";
+    readonly junctionType?: "REGULAR" | "ROUNDABOUT" | "BIFURCATION";
+    readonly maneuver?: "ARRIVE" | "ARRIVE_LEFT" | "ARRIVE_RIGHT" | "DEPART" | "STRAIGHT" | "KEEP_RIGHT" | "BEAR_RIGHT" | "TURN_RIGHT" | "SHARP_RIGHT" | "KEEP_LEFT" | "BEAR_LEFT" | "TURN_LEFT" | "SHARP_LEFT" | "MAKE_UTURN" | "ENTER_MOTORWAY" | "ENTER_FREEWAY" | "ENTER_HIGHWAY" | "TAKE_EXIT" | "MOTORWAY_EXIT_LEFT" | "MOTORWAY_EXIT_RIGHT" | "TAKE_FERRY" | "ROUNDABOUT_CROSS" | "ROUNDABOUT_RIGHT" | "ROUNDABOUT_LEFT" | "ROUNDABOUT_BACK" | "TRY_MAKE_UTURN" | "FOLLOW" | "SWITCH_PARALLEL_ROAD" | "SWITCH_MAIN_ROAD" | "ENTRANCE_RAMP" | "WAYPOINT_LEFT" | "WAYPOINT_RIGHT" | "WAYPOINT_REACHED";
+    readonly message?: string;
+    point?: LatLongPairOutput;
+    readonly pointIndex?: number;
+    readonly possibleCombineWithNext?: boolean;
+    readonly roadNumbers?: Array<string>;
+    readonly roundaboutExitNumber?: number;
+    readonly routeOffsetInMeters?: number;
+    readonly signpostText?: string;
+    readonly stateCode?: string;
+    readonly street?: string;
+    readonly travelTimeInSeconds?: number;
+    readonly turnAngleInDecimalDegrees?: number;
+}
+
+// @public
+export interface RouteLegOutput {
+    readonly points: Array<LatLongPairOutput>;
+    readonly summary: RouteSummaryOutput;
+}
+
+// @public
+export interface RouteMatrixOutput {
+    readonly response?: RouteMatrixResultResponseOutput;
+    readonly statusCode: number;
+}
+
+// @public
+export interface RouteMatrixQuery {
+    destinations: GeoJsonMultiPoint;
+    origins: GeoJsonMultiPoint;
+}
+
+// @public
+export interface RouteMatrixResultOutput {
+    readonly formatVersion?: string;
+    readonly matrix: Array<Array<RouteMatrixOutput>>;
+    readonly summary: RouteMatrixSummaryOutput;
+}
+
+// @public
+export interface RouteMatrixResultResponseOutput {
+    readonly routeSummary?: RouteSummaryOutput;
+}
+
+// @public
+export interface RouteMatrixSummaryOutput {
+    readonly successfulRoutes: number;
+    readonly totalRoutes: number;
+}
+
+// @public
+export interface RouteOptimizedWaypointOutput {
+    readonly optimizedIndex: number;
+    readonly providedIndex: number;
+}
+
+// @public (undocumented)
+export interface RouteOutput {
+    readonly guidance?: RouteGuidanceOutput;
+    readonly legs: Array<RouteLegOutput>;
+    readonly sections?: Array<RouteSectionOutput>;
+    readonly summary: RouteSummaryOutput;
+}
+
+// @public
+export interface RouteRangeOutput {
+    readonly boundary: Array<LatLongPairOutput>;
+    center: LatLongPairOutput;
+}
+
+// @public
+export interface RouteRangeResultOutput {
+    readonly formatVersion?: string;
+    reachableRange: RouteRangeOutput;
+    report?: RouteReportOutput;
+}
+
+// @public
+export interface RouteReportOutput {
+    readonly effectiveSettings: Array<EffectiveSettingOutput>;
+}
+
+// @public
+export interface RouteRequestRouteDirectionsBatch200Response extends HttpResponse {
+    // (undocumented)
+    body: RouteDirectionsBatchResultOutput;
+    // (undocumented)
+    status: "200";
+}
+
+// @public (undocumented)
+export interface RouteRequestRouteDirectionsBatch202Headers {
+    location?: string;
+}
+
+// @public
+export interface RouteRequestRouteDirectionsBatch202Response extends HttpResponse {
+    // (undocumented)
+    headers: RawHttpHeaders & RouteRequestRouteDirectionsBatch202Headers;
+    // (undocumented)
+    status: "202";
+}
+
+// @public (undocumented)
+export interface RouteRequestRouteDirectionsBatchBodyParam {
+    body: BatchRequest;
+}
+
+// @public (undocumented)
+export interface RouteRequestRouteDirectionsBatchMediaTypesParam {
+    contentType?: "application/json";
+}
+
+// @public (undocumented)
+export type RouteRequestRouteDirectionsBatchParameters = RouteRequestRouteDirectionsBatchMediaTypesParam & RouteRequestRouteDirectionsBatchBodyParam & RequestParameters;
+
+// @public
+export interface RouteRequestRouteDirectionsBatchSync200Response extends HttpResponse {
+    // (undocumented)
+    body: RouteDirectionsBatchResultOutput;
+    // (undocumented)
+    status: "200";
+}
+
+// @public
+export interface RouteRequestRouteDirectionsBatchSync408Response extends HttpResponse {
+    // (undocumented)
+    body: ErrorResponseOutput;
+    // (undocumented)
+    status: "408";
+}
+
+// @public (undocumented)
+export interface RouteRequestRouteDirectionsBatchSyncBodyParam {
+    body: BatchRequest;
+}
+
+// @public
+export interface RouteRequestRouteDirectionsBatchSyncDefaultResponse extends HttpResponse {
+    // (undocumented)
+    body: ErrorResponseOutput;
+    // (undocumented)
+    status: string;
+}
+
+// @public (undocumented)
+export interface RouteRequestRouteDirectionsBatchSyncMediaTypesParam {
+    contentType?: "application/json";
+}
+
+// @public (undocumented)
+export type RouteRequestRouteDirectionsBatchSyncParameters = RouteRequestRouteDirectionsBatchSyncMediaTypesParam & RouteRequestRouteDirectionsBatchSyncBodyParam & RequestParameters;
+
+// @public
+export interface RouteRequestRouteMatrix200Response extends HttpResponse {
+    // (undocumented)
+    body: RouteMatrixResultOutput;
+    // (undocumented)
+    status: "200";
+}
+
+// @public (undocumented)
+export interface RouteRequestRouteMatrix202Headers {
+    location?: string;
+}
+
+// @public
+export interface RouteRequestRouteMatrix202Response extends HttpResponse {
+    // (undocumented)
+    headers: RawHttpHeaders & RouteRequestRouteMatrix202Headers;
+    // (undocumented)
+    status: "202";
+}
+
+// @public (undocumented)
+export interface RouteRequestRouteMatrixBodyParam {
+    body: RouteMatrixQuery;
+}
+
+// @public (undocumented)
+export interface RouteRequestRouteMatrixMediaTypesParam {
+    contentType?: "application/json";
+}
+
+// @public (undocumented)
+export type RouteRequestRouteMatrixParameters = RouteRequestRouteMatrixQueryParam & RouteRequestRouteMatrixMediaTypesParam & RouteRequestRouteMatrixBodyParam & RequestParameters;
+
+// @public (undocumented)
+export interface RouteRequestRouteMatrixQueryParam {
+    // (undocumented)
+    queryParameters?: RouteRequestRouteMatrixQueryParamProperties;
+}
+
+// @public (undocumented)
+export interface RouteRequestRouteMatrixQueryParamProperties {
+    arriveAt?: Date | string;
+    avoid?: Array<"tollRoads" | "motorways" | "ferries" | "unpavedRoads" | "carpools" | "alreadyUsedRoads" | "borderCrossings">;
+    computeTravelTimeFor?: "none" | "all";
+    departAt?: Date | string;
+    hilliness?: "low" | "normal" | "high";
+    routeType?: "fastest" | "shortest" | "eco" | "thrilling";
+    sectionType?: Array<"carTrain" | "country" | "ferry" | "motorway" | "pedestrian" | "tollRoad" | "tollVignette" | "traffic" | "travelMode" | "tunnel" | "carpool" | "urban">;
+    traffic?: boolean;
+    travelMode?: "car" | "truck" | "taxi" | "bus" | "van" | "motorcycle" | "bicycle" | "pedestrian";
+    vehicleAxleWeight?: number;
+    vehicleHeight?: number;
+    vehicleLength?: number;
+    vehicleLoadType?: "USHazmatClass1" | "USHazmatClass2" | "USHazmatClass3" | "USHazmatClass4" | "USHazmatClass5" | "USHazmatClass6" | "USHazmatClass7" | "USHazmatClass8" | "USHazmatClass9" | "otherHazmatExplosive" | "otherHazmatGeneral" | "otherHazmatHarmfulToWater";
+    vehicleMaxSpeed?: number;
+    vehicleWeight?: number;
+    vehicleWidth?: number;
+    waitForResults?: boolean;
+    windingness?: "low" | "normal" | "high";
+}
+
+// @public
+export interface RouteRequestRouteMatrixSync200Response extends HttpResponse {
+    // (undocumented)
+    body: RouteMatrixResultOutput;
+    // (undocumented)
+    status: "200";
+}
+
+// @public
+export interface RouteRequestRouteMatrixSync408Response extends HttpResponse {
+    // (undocumented)
+    body: ErrorResponseOutput;
+    // (undocumented)
+    status: "408";
+}
+
+// @public (undocumented)
+export interface RouteRequestRouteMatrixSyncBodyParam {
+    body: RouteMatrixQuery;
+}
+
+// @public
+export interface RouteRequestRouteMatrixSyncDefaultResponse extends HttpResponse {
+    // (undocumented)
+    body: ErrorResponseOutput;
+    // (undocumented)
+    status: string;
+}
+
+// @public (undocumented)
+export interface RouteRequestRouteMatrixSyncMediaTypesParam {
+    contentType?: "application/json";
+}
+
+// @public (undocumented)
+export type RouteRequestRouteMatrixSyncParameters = RouteRequestRouteMatrixSyncQueryParam & RouteRequestRouteMatrixSyncMediaTypesParam & RouteRequestRouteMatrixSyncBodyParam & RequestParameters;
+
+// @public (undocumented)
+export interface RouteRequestRouteMatrixSyncQueryParam {
+    // (undocumented)
+    queryParameters?: RouteRequestRouteMatrixSyncQueryParamProperties;
+}
+
+// @public (undocumented)
+export interface RouteRequestRouteMatrixSyncQueryParamProperties {
+    arriveAt?: Date | string;
+    avoid?: Array<"tollRoads" | "motorways" | "ferries" | "unpavedRoads" | "carpools" | "alreadyUsedRoads" | "borderCrossings">;
+    computeTravelTimeFor?: "none" | "all";
+    departAt?: Date | string;
+    hilliness?: "low" | "normal" | "high";
+    routeType?: "fastest" | "shortest" | "eco" | "thrilling";
+    sectionType?: Array<"carTrain" | "country" | "ferry" | "motorway" | "pedestrian" | "tollRoad" | "tollVignette" | "traffic" | "travelMode" | "tunnel" | "carpool" | "urban">;
+    traffic?: boolean;
+    travelMode?: "car" | "truck" | "taxi" | "bus" | "van" | "motorcycle" | "bicycle" | "pedestrian";
+    vehicleAxleWeight?: number;
+    vehicleHeight?: number;
+    vehicleLength?: number;
+    vehicleLoadType?: "USHazmatClass1" | "USHazmatClass2" | "USHazmatClass3" | "USHazmatClass4" | "USHazmatClass5" | "USHazmatClass6" | "USHazmatClass7" | "USHazmatClass8" | "USHazmatClass9" | "otherHazmatExplosive" | "otherHazmatGeneral" | "otherHazmatHarmfulToWater";
+    vehicleMaxSpeed?: number;
+    vehicleWeight?: number;
+    vehicleWidth?: number;
+    waitForResults?: boolean;
+    windingness?: "low" | "normal" | "high";
+}
+
+// @public (undocumented)
+export interface Routes {
+    (path: "/route/matrix/{format}", format: "json"): RequestRouteMatrix;
+    (path: "/route/matrix/sync/{format}", format: "json"): RequestRouteMatrixSync;
+    (path: "/route/directions/{format}", format: "json" | "xml"): GetRouteDirections;
+    (path: "/route/range/{format}", format: "json" | "xml"): GetRouteRange;
+    (path: "/route/directions/batch/{format}", format: "json"): RequestRouteDirectionsBatch;
+    (path: "/route/directions/batch/sync/{format}", format: "json"): RequestRouteDirectionsBatchSync;
+}
+
+// @public
+export interface RouteSectionOutput {
+    readonly delayInSeconds?: number;
+    readonly effectiveSpeedInKmh?: number;
+    readonly endPointIndex: number;
+    readonly magnitudeOfDelay?: "0" | "1" | "2" | "3" | "4";
+    readonly sectionType: "CAR_TRAIN" | "COUNTRY" | "FERRY" | "MOTORWAY" | "PEDESTRIAN" | "TOLL_ROAD" | "TOLL_VIGNETTE" | "TRAFFIC" | "TRAVEL_MODE" | "TUNNEL" | "CARPOOL" | "URBAN";
+    readonly simpleCategory?: "JAM" | "ROAD_WORK" | "ROAD_CLOSURE" | "OTHER";
+    readonly startPointIndex: number;
+    tec?: RouteSectionTecOutput;
+    readonly travelMode?: "car" | "truck" | "taxi" | "bus" | "van" | "motorcycle" | "bicycle" | "pedestrian" | "other";
+}
+
+// @public
+export interface RouteSectionTecCauseOutput {
+    readonly mainCauseCode?: number;
+    readonly subCauseCode?: number;
+}
+
+// @public
+export interface RouteSectionTecOutput {
+    causes?: Array<RouteSectionTecCauseOutput>;
+    readonly effectCode?: number;
+}
+
+// @public
+export interface RouteSummaryOutput {
+    readonly arrivalTime: string;
+    readonly departureTime: string;
+    readonly lengthInMeters: number;
+    readonly trafficDelayInSeconds: number;
+    readonly travelTimeInSeconds: number;
+}
+
+// @public
+export interface SimplePollerLike<TState extends OperationState<TResult>, TResult> {
+    getOperationState(): TState;
+    getResult(): TResult | undefined;
+    isDone(): boolean;
+    // @deprecated
+    isStopped(): boolean;
+    onProgress(callback: (state: TState) => void): CancelOnProgress;
+    poll(options?: {
+        abortSignal?: AbortSignalLike;
+    }): Promise<TState>;
+    pollUntilDone(pollOptions?: {
+        abortSignal?: AbortSignalLike;
+    }): Promise<TResult>;
+    serialize(): Promise<string>;
+    // @deprecated
+    stopPolling(): void;
+    submitted(): Promise<void>;
+    // @deprecated
+    toString(): string;
+}
+
+// @public
+export function toColonDelimitedLatLonString(coordinates: LatLon[]): string;
+
+// (No @packageDocumentation comment for this package)
+
+```