@azure-rest/maps-route/dist/browser/generated/models.d.ts

A client library for Azure Maps maps-route

/** An object with a matrix of coordinates. */
export interface RouteMatrixQuery {
    /** A valid `GeoJSON MultiPoint` geometry type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1.3) for details. */
    origins: GeoJsonMultiPoint;
    /** A valid `GeoJSON MultiPoint` geometry type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1.3) for details. */
    destinations: GeoJsonMultiPoint;
}
/** A valid `GeoJSON MultiPoint` geometry type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1.3) for details. */
export interface GeoJsonMultiPoint extends GeoJsonGeometryParent, GeoJsonMultiPointData {
    type: "MultiPoint";
}
/** A valid `GeoJSON` geometry object. The type must be one of the seven valid GeoJSON geometry types - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon and GeometryCollection. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1) for details. */
export interface GeoJsonGeometryParent extends GeoJsonObjectParent {
    type: "GeoJsonGeometry" | "MultiPoint" | "MultiPolygon" | "Point" | "LineString" | "MultiLineString" | "Polygon" | "GeometryCollection";
}
/** A valid `GeoJSON` object. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3) for details. */
export interface GeoJsonObjectParent {
    type: "GeoJsonObject" | "GeoJsonGeometry" | "MultiPoint" | "MultiPolygon" | "Point" | "LineString" | "MultiLineString" | "Polygon" | "GeometryCollection" | "Feature" | "FeatureCollection";
}
/** Data contained by a `GeoJson MultiPoint`. */
export interface GeoJsonMultiPointData {
    /** Coordinates for the `GeoJson MultiPoint` geometry. */
    coordinates: Array<Array<number>>;
}
/** Post body parameters for Route directions. */
export interface RouteDirectionParameters {
    /**
     * A GeoJSON Geometry collection representing sequence of coordinates used as input for route reconstruction and for calculating zero or more alternative routes to this reference route.
     *   - The provided sequence of supporting points is used as input for route reconstruction.
     *   - The alternative routes are calculated between the origin and destination points specified in the base path parameter locations.
     *   - If both _minDeviationDistance_ and _minDeviationTime_ are set to zero, then these origin and destination points are
     *   expected to be at (or very near) the beginning and end of the reference route, respectively.
     *   - Intermediate locations (_waypoints_) are not supported when using <_supportingPoints_>.
     *   - The reference route may contain traffic incidents of type _ROAD_CLOSURE_, which are
     *   ignored for the calculation of the reference route's travel time and traffic delay.
     */
    supportingPoints?: Record<string, unknown>;
    /** This is a list of 3-character, ISO 3166-1, alpha-3 country codes of countries/regions in which all toll roads with vignettes are to be avoided, e.g. "AUS,CHE". Toll roads with vignettes in countries/regions not in the list are unaffected. Note: It is an error to specify both **avoidVignette** and **allowVignette**. */
    avoidVignette?: Array<string>;
    /** This is a list of 3-character, ISO 3166-1, alpha-3 country codes of countries/regions in which toll roads with vignettes are allowed, e.g. "AUS,CHE". Specifying **allowVignette** with some countries/regions X is equivalent to specifying **avoidVignette** with all countries/regions but X. Specifying **allowVignette** with an empty list is the same as avoiding all toll roads with vignettes. Note: It is an error to specify both **avoidVignette** and **allowVignette**. */
    allowVignette?: Array<string>;
    /** A GeoJSON MultiPolygon representing list of areas to avoid. Only rectangle polygons are supported. The maximum size of a rectangle is about 160x160 km. Maximum number of avoided areas is **10**. It cannot cross the 180th meridian. It must be between -80 and +80 degrees of latitude. */
    avoidAreas?: GeoJsonMultiPolygon;
}
/** A valid `GeoJSON MultiPolygon` object type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1.7) for details. */
export interface GeoJsonMultiPolygon extends GeoJsonGeometryParent, GeoJsonMultiPolygonData {
    type: "MultiPolygon";
}
export interface GeoJsonMultiPolygonData {
    /** Contains a list of valid `GeoJSON Polygon` objects. **Note** that coordinates in GeoJSON are in x, y order (longitude, latitude). */
    coordinates: Array<Array<Array<Array<number>>>>;
}
/** This type represents the request body for the Batch service. */
export interface BatchRequest {
    /** The list of queries to process. */
    batchItems?: Array<BatchRequestItem>;
}
/** Batch request object */
export interface BatchRequestItem {
    /** This parameter contains a query string used to perform an unstructured geocoding operation. The query string will be passed verbatim to the search API for processing. */
    query?: string;
}
/** A valid `GeoJSON Point` geometry type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1.2) for details. */
export interface GeoJsonPoint extends GeoJsonGeometryParent, GeoJsonPointData {
    type: "Point";
}
/** Data contained by a `GeoJson Point`. */
export interface GeoJsonPointData {
    /** A `Position` is an array of numbers with two or more elements. The first two elements are _longitude_ and _latitude_, precisely in that order. _Altitude/Elevation_ is an optional third element. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1.1) for details. */
    coordinates: Array<number>;
}
/** A valid `GeoJSON LineString` geometry type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1.4) for details. */
export interface GeoJsonLineString extends GeoJsonGeometryParent, GeoJsonLineStringData {
    type: "LineString";
}
export interface GeoJsonLineStringData {
    /** Coordinates for the `GeoJson LineString` geometry. */
    coordinates: Array<Array<number>>;
}
/** A valid `GeoJSON MultiLineString` geometry type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1.5) for details. */
export interface GeoJsonMultiLineString extends GeoJsonGeometryParent, GeoJsonMultiLineStringData {
    type: "MultiLineString";
}
export interface GeoJsonMultiLineStringData {
    /** Coordinates for the `GeoJson MultiLineString` geometry. */
    coordinates: Array<Array<Array<number>>>;
}
/** A valid `GeoJSON Polygon` geometry type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1.6) for details. */
export interface GeoJsonPolygon extends GeoJsonGeometryParent, GeoJsonPolygonData {
    type: "Polygon";
}
export interface GeoJsonPolygonData {
    /** Coordinates for the `GeoJson Polygon` geometry type. */
    coordinates: Array<Array<Array<number>>>;
}
/** A valid `GeoJSON GeometryCollection` object type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1.8) for details. */
export interface GeoJsonGeometryCollection extends GeoJsonGeometryParent, GeoJsonGeometryCollectionData {
    type: "GeometryCollection";
}
export interface GeoJsonGeometryCollectionData {
    /** Contains a list of valid `GeoJSON` geometry objects. **Note** that coordinates in GeoJSON are in x, y order (longitude, latitude). */
    geometries: Array<GeoJsonGeometry>;
}
/** A valid `GeoJSON Feature` object type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.2) for details. */
export interface GeoJsonFeature extends GeoJsonObjectParent, GeoJsonFeatureData {
    type: "Feature";
}
export interface GeoJsonFeatureData {
    /** A valid `GeoJSON` geometry object. The type must be one of the seven valid GeoJSON geometry types - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon and GeometryCollection. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1) for details. */
    geometry: GeoJsonGeometry;
    /** Properties can contain any additional metadata about the `Feature`. Value can be any JSON object or a JSON null value */
    properties?: Record<string, unknown>;
    /** Identifier for the feature. */
    id?: string;
    /** The type of the feature. The value depends on the data model the current feature is part of. Some data models may have an empty value. */
    featureType?: string;
}
/** A valid `GeoJSON FeatureCollection` object type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.3) for details. */
export interface GeoJsonFeatureCollection extends GeoJsonObjectParent, GeoJsonFeatureCollectionData {
    type: "FeatureCollection";
}
export interface GeoJsonFeatureCollectionData {
    /** Contains a list of valid `GeoJSON Feature` objects. */
    features: Array<GeoJsonFeature>;
}
/** A valid `GeoJSON` geometry object. The type must be one of the seven valid GeoJSON geometry types - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon and GeometryCollection. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1) for details. */
export type GeoJsonGeometry = GeoJsonGeometryParent | GeoJsonMultiPoint | GeoJsonMultiPolygon | GeoJsonPoint | GeoJsonLineString | GeoJsonMultiLineString | GeoJsonPolygon | GeoJsonGeometryCollection;
/** A valid `GeoJSON` object. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3) for details. */
export type GeoJsonObject = GeoJsonGeometry | GeoJsonMultiPoint | GeoJsonMultiPolygon | GeoJsonPoint | GeoJsonLineString | GeoJsonMultiLineString | GeoJsonPolygon | GeoJsonGeometryCollection | GeoJsonFeature | GeoJsonFeatureCollection;
//# sourceMappingURL=models.d.ts.map