@azure-rest/maps-route 1.0.0-beta.2 → 1.0.0-beta.4

package/review/maps-route.api.md

@@ -4,18 +4,20 @@
 
 ```ts
 
-import { AzureKeyCredential } from '@azure/core-auth';
+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 { LatLon } from '@azure/maps-common';
-import { LroEngineOptions } from '@azure/core-lro';
-import { PollerLike } from '@azure/core-lro';
-import { PollOperationState } from '@azure/core-lro';
+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 { TokenCredential } from '@azure/core-auth';
+import type { TokenCredential } from '@azure/core-auth';
 
 // @public
 export interface BatchRequest {
@@ -29,33 +31,36 @@ export interface BatchRequestItem {
 
 // @public
 export interface BatchResultItemOutput {
-    statusCode: number;
+    readonly statusCode: number;
 }
 
 // @public
 export interface BatchResultOutput {
-    summary: BatchResultSummaryOutput;
+    readonly summary: BatchResultSummaryOutput;
 }
 
 // @public
 export interface BatchResultSummaryOutput {
-    successfulRequests: number;
-    totalRequests: number;
+    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 {
-    key: string;
-    value: string;
+    readonly key: string;
+    readonly value: string;
 }
 
 // @public
 export interface ErrorDetailOutput {
-    code?: string;
-    message?: string;
+    readonly code?: string;
+    readonly message?: string;
 }
 
 // @public
@@ -184,7 +189,7 @@ export interface GeoJsonPolygonData {
 }
 
 // @public
-export function getLongRunningPoller<TResult extends HttpResponse>(client: Client, initialResponse: TResult, options?: LroEngineOptions<TResult, PollOperationState<TResult>>): PollerLike<PollOperationState<TResult>, TResult>;
+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 {
@@ -223,6 +228,9 @@ function MapsRoute(credential: AzureKeyCredential, options?: ClientOptions): Map
 
 // @public
 function MapsRoute(credential: TokenCredential, mapsAccountClientId: string, options?: ClientOptions): MapsRouteClient;
+
+// @public
+function MapsRoute(credential: AzureSASCredential, options?: ClientOptions): MapsRouteClient;
 export default MapsRoute;
 
 // @public (undocumented)
@@ -230,6 +238,11 @@ 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>;
@@ -262,7 +275,7 @@ export interface RouteDirectionParameters {
 
 // @public
 export interface RouteDirectionsBatchItemOutput extends BatchResultItemOutput {
-    response: RouteDirectionsBatchItemResponseOutput;
+    readonly response: RouteDirectionsBatchItemResponseOutput;
 }
 
 // @public
@@ -271,15 +284,15 @@ export interface RouteDirectionsBatchItemResponseOutput extends RouteDirectionsO
 
 // @public
 export interface RouteDirectionsBatchResultOutput extends BatchResultOutput {
-    batchItems: Array<RouteDirectionsBatchItemOutput>;
+    readonly batchItems: Array<RouteDirectionsBatchItemOutput>;
 }
 
 // @public
 export interface RouteDirectionsOutput {
-    formatVersion?: string;
-    optimizedWaypoints?: Array<RouteOptimizedWaypointOutput>;
+    readonly formatVersion?: string;
+    readonly optimizedWaypoints?: Array<RouteOptimizedWaypointOutput>;
     report?: RouteReportOutput;
-    routes: Array<RouteOutput>;
+    readonly routes: Array<RouteOutput>;
 }
 
 // @public
@@ -305,8 +318,6 @@ export interface RouteGetRouteDirectionsBatch202Headers {
 
 // @public
 export interface RouteGetRouteDirectionsBatch202Response extends HttpResponse {
-    // (undocumented)
-    body: Record<string, unknown>;
     // (undocumented)
     headers: RawHttpHeaders & RouteGetRouteDirectionsBatch202Headers;
     // (undocumented)
@@ -362,7 +373,7 @@ export interface RouteGetRouteDirectionsQueryParamProperties {
     report?: "effectiveSettings";
     routeRepresentation?: "polyline" | "summaryOnly" | "none";
     routeType?: "fastest" | "shortest" | "eco" | "thrilling";
-    sectionType?: "carTrain" | "country" | "ferry" | "motorway" | "pedestrian" | "tollRoad" | "tollVignette" | "traffic" | "travelMode" | "tunnel" | "carpool" | "urban";
+    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;
@@ -443,7 +454,7 @@ export interface RouteGetRouteDirectionsWithAdditionalParametersQueryParamProper
     report?: "effectiveSettings";
     routeRepresentation?: "polyline" | "summaryOnly" | "none";
     routeType?: "fastest" | "shortest" | "eco" | "thrilling";
-    sectionType?: "carTrain" | "country" | "ferry" | "motorway" | "pedestrian" | "tollRoad" | "tollVignette" | "traffic" | "travelMode" | "tunnel" | "carpool" | "urban";
+    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;
@@ -475,8 +486,6 @@ export interface RouteGetRouteMatrix202Headers {
 
 // @public
 export interface RouteGetRouteMatrix202Response extends HttpResponse {
-    // (undocumented)
-    body: Record<string, unknown>;
     // (undocumented)
     headers: RawHttpHeaders & RouteGetRouteMatrix202Headers;
     // (undocumented)
@@ -550,51 +559,51 @@ export interface RouteGetRouteRangeQueryParamProperties {
 
 // @public
 export interface RouteGuidanceOutput {
-    instructionGroups: Array<RouteInstructionGroupOutput>;
-    instructions: Array<RouteInstructionOutput>;
+    readonly instructionGroups: Array<RouteInstructionGroupOutput>;
+    readonly instructions: Array<RouteInstructionOutput>;
 }
 
 // @public
 export interface RouteInstructionGroupOutput {
-    firstInstructionIndex?: number;
-    groupLengthInMeters?: number;
-    groupMessage?: string;
-    lastInstructionIndex?: number;
+    readonly firstInstructionIndex?: number;
+    readonly groupLengthInMeters?: number;
+    readonly groupMessage?: string;
+    readonly lastInstructionIndex?: number;
 }
 
 // @public
 export interface RouteInstructionOutput {
-    combinedMessage?: string;
-    countryCode?: string;
-    drivingSide?: "LEFT" | "RIGHT";
-    exitNumber?: string;
+    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";
-    junctionType?: "REGULAR" | "ROUNDABOUT" | "BIFURCATION";
-    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";
-    message?: string;
+    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;
-    pointIndex?: number;
-    possibleCombineWithNext?: boolean;
-    roadNumbers?: Array<string>;
-    roundaboutExitNumber?: string;
-    routeOffsetInMeters?: number;
-    signpostText?: string;
-    stateCode?: string;
-    street?: string;
-    travelTimeInSeconds?: number;
-    turnAngleInDecimalDegrees?: number;
+    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 {
-    points: Array<LatLongPairOutput>;
-    summary: RouteSummaryOutput;
+    readonly points: Array<LatLongPairOutput>;
+    readonly summary: RouteSummaryOutput;
 }
 
 // @public
 export interface RouteMatrixOutput {
-    response?: RouteMatrixResultResponseOutput;
-    statusCode: number;
+    readonly response?: RouteMatrixResultResponseOutput;
+    readonly statusCode: number;
 }
 
 // @public
@@ -605,52 +614,52 @@ export interface RouteMatrixQuery {
 
 // @public
 export interface RouteMatrixResultOutput {
-    formatVersion?: string;
-    matrix: Array<Array<RouteMatrixOutput>>;
-    summary: RouteMatrixSummaryOutput;
+    readonly formatVersion?: string;
+    readonly matrix: Array<Array<RouteMatrixOutput>>;
+    readonly summary: RouteMatrixSummaryOutput;
 }
 
 // @public
 export interface RouteMatrixResultResponseOutput {
-    routeSummary?: RouteSummaryOutput;
+    readonly routeSummary?: RouteSummaryOutput;
 }
 
 // @public
 export interface RouteMatrixSummaryOutput {
-    successfulRoutes: number;
-    totalRoutes: number;
+    readonly successfulRoutes: number;
+    readonly totalRoutes: number;
 }
 
 // @public
 export interface RouteOptimizedWaypointOutput {
-    optimizedIndex: number;
-    providedIndex: number;
+    readonly optimizedIndex: number;
+    readonly providedIndex: number;
 }
 
 // @public (undocumented)
 export interface RouteOutput {
-    guidance?: RouteGuidanceOutput;
-    legs: Array<RouteLegOutput>;
-    sections?: Array<RouteSectionOutput>;
-    summary: RouteSummaryOutput;
+    readonly guidance?: RouteGuidanceOutput;
+    readonly legs: Array<RouteLegOutput>;
+    readonly sections?: Array<RouteSectionOutput>;
+    readonly summary: RouteSummaryOutput;
 }
 
 // @public
 export interface RouteRangeOutput {
-    boundary: Array<LatLongPairOutput>;
+    readonly boundary: Array<LatLongPairOutput>;
     center: LatLongPairOutput;
 }
 
 // @public
 export interface RouteRangeResultOutput {
-    formatVersion?: string;
+    readonly formatVersion?: string;
     reachableRange: RouteRangeOutput;
     report?: RouteReportOutput;
 }
 
 // @public
 export interface RouteReportOutput {
-    effectiveSettings: Array<EffectiveSettingOutput>;
+    readonly effectiveSettings: Array<EffectiveSettingOutput>;
 }
 
 // @public
@@ -668,8 +677,6 @@ export interface RouteRequestRouteDirectionsBatch202Headers {
 
 // @public
 export interface RouteRequestRouteDirectionsBatch202Response extends HttpResponse {
-    // (undocumented)
-    body: Record<string, unknown>;
     // (undocumented)
     headers: RawHttpHeaders & RouteRequestRouteDirectionsBatch202Headers;
     // (undocumented)
@@ -741,8 +748,6 @@ export interface RouteRequestRouteMatrix202Headers {
 
 // @public
 export interface RouteRequestRouteMatrix202Response extends HttpResponse {
-    // (undocumented)
-    body: Record<string, unknown>;
     // (undocumented)
     headers: RawHttpHeaders & RouteRequestRouteMatrix202Headers;
     // (undocumented)
@@ -776,7 +781,7 @@ export interface RouteRequestRouteMatrixQueryParamProperties {
     departAt?: Date | string;
     hilliness?: "low" | "normal" | "high";
     routeType?: "fastest" | "shortest" | "eco" | "thrilling";
-    sectionType?: "carTrain" | "country" | "ferry" | "motorway" | "pedestrian" | "tollRoad" | "tollVignette" | "traffic" | "travelMode" | "tunnel" | "carpool" | "urban";
+    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;
@@ -841,7 +846,7 @@ export interface RouteRequestRouteMatrixSyncQueryParamProperties {
     departAt?: Date | string;
     hilliness?: "low" | "normal" | "high";
     routeType?: "fastest" | "shortest" | "eco" | "thrilling";
-    sectionType?: "carTrain" | "country" | "ferry" | "motorway" | "pedestrian" | "tollRoad" | "tollVignette" | "traffic" | "travelMode" | "tunnel" | "carpool" | "urban";
+    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;
@@ -867,36 +872,58 @@ export interface Routes {
 
 // @public
 export interface RouteSectionOutput {
-    delayInSeconds?: number;
-    effectiveSpeedInKmh?: number;
-    endPointIndex: number;
-    magnitudeOfDelay?: "0" | "1" | "2" | "3" | "4";
-    sectionType: "CAR_TRAIN" | "COUNTRY" | "FERRY" | "MOTORWAY" | "PEDESTRIAN" | "TOLL_ROAD" | "TOLL_VIGNETTE" | "TRAFFIC" | "TRAVEL_MODE" | "TUNNEL" | "CARPOOL" | "URBAN";
-    simpleCategory?: "JAM" | "ROAD_WORK" | "ROAD_CLOSURE" | "OTHER";
-    startPointIndex: number;
+    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;
-    travelMode?: "car" | "truck" | "taxi" | "bus" | "van" | "motorcycle" | "bicycle" | "pedestrian" | "other";
+    readonly travelMode?: "car" | "truck" | "taxi" | "bus" | "van" | "motorcycle" | "bicycle" | "pedestrian" | "other";
 }
 
 // @public
 export interface RouteSectionTecCauseOutput {
-    mainCauseCode?: number;
-    subCauseCode?: number;
+    readonly mainCauseCode?: number;
+    readonly subCauseCode?: number;
 }
 
 // @public
 export interface RouteSectionTecOutput {
     causes?: Array<RouteSectionTecCauseOutput>;
-    effectCode?: number;
+    readonly effectCode?: number;
 }
 
 // @public
 export interface RouteSummaryOutput {
-    arrivalTime: string;
-    departureTime: string;
-    lengthInMeters: number;
-    trafficDelayInSeconds: number;
-    travelTimeInSeconds: number;
+    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