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

package/dist/commonjs/generated/responses.d.ts

@@ -0,0 +1,1409 @@
+import { RawHttpHeaders } from "@azure/core-rest-pipeline";
+import { HttpResponse } from "@azure-rest/core-client";
+import { RouteMatrixResultOutput, ErrorResponseOutput, RouteDirectionsOutput, RouteRangeResultOutput, RouteDirectionsBatchResultOutput } from "./outputModels.js";
+/**
+ *
+ * The `Post Route Matrix` API is an HTTP `POST` request that allows calculation of a matrix of route summaries for a set of routes defined by origin and destination locations by using an asynchronous (async) request. To make a synchronous (sync) request, see [Post Route Matrix Sync](/rest/api/maps/route/post-route-matrix-sync). For every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. As an example, let's say a food delivery company has 20 drivers and they need to find the closest driver to pick up the delivery from the restaurant. To solve this use case, they can call Matrix Route API.
+ *
+ *
+ * For each route, the travel times and distances are returned. You can use the computed costs to determine which detailed routes to calculate using the Route Directions API.
+ *
+ *
+ * The maximum size of a matrix for async request is **700** and for sync request it's **100** (the number of origins multiplied by the number of destinations).
+ *
+ * > [!NOTE]
+ * > All origins and destinations should be contained in an axis-aligned 400 km x 400 km bounding box. Otherwise some matrix cells will be resolved as OUT_OF_REGION.
+ *
+ *
+ *
+ * ### Submit Synchronous Route Matrix Request
+ * If your scenario requires synchronous requests and the maximum size of the matrix is less than or equal to 100, you might want to make synchronous request. The maximum size of a matrix for this API is **100** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 10x10, 6x8, 9x8 (it does not need to be square).
+ *
+ * ```
+ * POST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}
+ * ```
+ *
+ * ### Submit Asynchronous Route Matrix Request
+ * The Asynchronous API is appropriate for processing big volumes of relatively complex routing requests. When you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available. If `waitForResults` parameter in the request is set to true, user will get a 200 response if the request is finished under 120 seconds.
+ *
+ *
+ * The maximum size of a matrix for this API is **700** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 50x10, 10x10, 28x25. 10x70 (it does not need to be square).
+ *
+ *
+ * The asynchronous responses are stored for **24** hours. The redirect URL returns a 404 response if used after the expiration period.
+ *
+ *
+ *
+ *
+ * ```
+ * POST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}
+ * ```
+ *
+ * Here's a typical sequence of asynchronous operations:
+ * 1. Client sends a Route Matrix POST request to Azure Maps
+ *
+ * 2. The server will respond with one of the following:
+ *
+ *     > HTTP `202 Accepted` -  Route Matrix request has been accepted.
+ *
+ *     > HTTP `Error` - There was an error processing your Route Matrix request. This could either be a 400 Bad Request or any other Error status code.
+ *
+ *
+ * 3. If the Matrix Route request was accepted successfully, the Location header in the response contains the URL to download the results of the request. This status URI looks like the following:
+ *
+ *   ```
+ *     GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
+ *   ```
+ *
+ *
+ * 4. Client issues a GET request on the download URL obtained in Step 3 to download the results
+ *
+ * ### Download Sync Results
+ * When you make a POST request for Route Matrix Sync API, the service returns 200 response code for successful request and a response array. The response body will contain the data and there will be no possibility to retrieve the results later.
+ *
+ * ### Download Async Results
+ * When a request issues a `202 Accepted` response, the request is being processed using our async pipeline. You will be given a URL to check the progress of your  async request in the location header of the response. This status URI looks like the following:
+ * ```
+ *   GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
+ * ```
+ *
+ * The URL provided by the location header will return the following responses when a `GET` request is issued.
+ *
+ *   > HTTP `202 Accepted` - Matrix request was accepted but is still being processed. Please try again in some time.
+ *
+ *   > HTTP `200 OK` - Matrix request successfully processed. The response body contains all of the results.
+ */
+export interface RouteRequestRouteMatrix200Response extends HttpResponse {
+    status: "200";
+    body: RouteMatrixResultOutput;
+}
+export interface RouteRequestRouteMatrix202Headers {
+    /** New URL to check for the results of the long-running operation. */
+    location?: string;
+}
+/**
+ *
+ * The `Post Route Matrix` API is an HTTP `POST` request that allows calculation of a matrix of route summaries for a set of routes defined by origin and destination locations by using an asynchronous (async) request. To make a synchronous (sync) request, see [Post Route Matrix Sync](/rest/api/maps/route/post-route-matrix-sync). For every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. As an example, let's say a food delivery company has 20 drivers and they need to find the closest driver to pick up the delivery from the restaurant. To solve this use case, they can call Matrix Route API.
+ *
+ *
+ * For each route, the travel times and distances are returned. You can use the computed costs to determine which detailed routes to calculate using the Route Directions API.
+ *
+ *
+ * The maximum size of a matrix for async request is **700** and for sync request it's **100** (the number of origins multiplied by the number of destinations).
+ *
+ * > [!NOTE]
+ * > All origins and destinations should be contained in an axis-aligned 400 km x 400 km bounding box. Otherwise some matrix cells will be resolved as OUT_OF_REGION.
+ *
+ *
+ *
+ * ### Submit Synchronous Route Matrix Request
+ * If your scenario requires synchronous requests and the maximum size of the matrix is less than or equal to 100, you might want to make synchronous request. The maximum size of a matrix for this API is **100** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 10x10, 6x8, 9x8 (it does not need to be square).
+ *
+ * ```
+ * POST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}
+ * ```
+ *
+ * ### Submit Asynchronous Route Matrix Request
+ * The Asynchronous API is appropriate for processing big volumes of relatively complex routing requests. When you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available. If `waitForResults` parameter in the request is set to true, user will get a 200 response if the request is finished under 120 seconds.
+ *
+ *
+ * The maximum size of a matrix for this API is **700** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 50x10, 10x10, 28x25. 10x70 (it does not need to be square).
+ *
+ *
+ * The asynchronous responses are stored for **24** hours. The redirect URL returns a 404 response if used after the expiration period.
+ *
+ *
+ *
+ *
+ * ```
+ * POST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}
+ * ```
+ *
+ * Here's a typical sequence of asynchronous operations:
+ * 1. Client sends a Route Matrix POST request to Azure Maps
+ *
+ * 2. The server will respond with one of the following:
+ *
+ *     > HTTP `202 Accepted` -  Route Matrix request has been accepted.
+ *
+ *     > HTTP `Error` - There was an error processing your Route Matrix request. This could either be a 400 Bad Request or any other Error status code.
+ *
+ *
+ * 3. If the Matrix Route request was accepted successfully, the Location header in the response contains the URL to download the results of the request. This status URI looks like the following:
+ *
+ *   ```
+ *     GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
+ *   ```
+ *
+ *
+ * 4. Client issues a GET request on the download URL obtained in Step 3 to download the results
+ *
+ * ### Download Sync Results
+ * When you make a POST request for Route Matrix Sync API, the service returns 200 response code for successful request and a response array. The response body will contain the data and there will be no possibility to retrieve the results later.
+ *
+ * ### Download Async Results
+ * When a request issues a `202 Accepted` response, the request is being processed using our async pipeline. You will be given a URL to check the progress of your  async request in the location header of the response. This status URI looks like the following:
+ * ```
+ *   GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
+ * ```
+ *
+ * The URL provided by the location header will return the following responses when a `GET` request is issued.
+ *
+ *   > HTTP `202 Accepted` - Matrix request was accepted but is still being processed. Please try again in some time.
+ *
+ *   > HTTP `200 OK` - Matrix request successfully processed. The response body contains all of the results.
+ */
+export interface RouteRequestRouteMatrix202Response extends HttpResponse {
+    status: "202";
+    headers: RawHttpHeaders & RouteRequestRouteMatrix202Headers;
+}
+/**
+ *
+ * The `Get Route Matrix` API is an HTTP `GET` request that computes the travel time and distance for all possible pairs in a list of origins and destinations. Unlike the [Get Route Directions](/rest/api/maps/route/get-route-directions) API, which provide detailed route instructions, this API focuses on efficiency by giving you the cost (travel time and distance) of routing from each origin to every destination.  For more information, see [Best practices for Azure Maps Route service](/azure/azure-maps/how-to-use-best-practices-for-routing).
+ *
+ * For every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. As an example, let's say a food delivery company has 20 drivers and they need to find the closest driver to pick up the delivery from the restaurant. To solve this use case, they can call Matrix Route API.
+ *
+ *
+ * For each route, the travel times and distances are returned. You can use the computed costs to determine which detailed routes to calculate using the Route Directions API.
+ *
+ *
+ * The maximum size of a matrix for async request is **700** and for sync request it's **100** (the number of origins multiplied by the number of destinations).
+ *
+ *
+ *
+ * ### Submit Synchronous Route Matrix Request
+ * If your scenario requires synchronous requests and the maximum size of the matrix is less than or equal to 100, you might want to make synchronous request. The maximum size of a matrix for this API is **100** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 10x10, 6x8, 9x8 (it does not need to be square).
+ *
+ * ```
+ * GET https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}
+ * ```
+ *
+ * ### Submit Asynchronous Route Matrix Request
+ * The Asynchronous API is appropriate for processing big volumes of relatively complex routing requests. When you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available. If `waitForResults` parameter in the request is set to true, user will get a 200 response if the request is finished under 120 seconds.
+ *
+ *
+ * The maximum size of a matrix for this API is **700** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 50x10, 10x10, 28x25. 10x70 (it does not need to be square).
+ *
+ *
+ * The asynchronous responses are stored for **24** hours. The redirect URL returns a 404 response if used after the expiration period.
+ *
+ *
+ *
+ *
+ * ```
+ * GET https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}
+ * ```
+ *
+ * Here's a typical sequence of asynchronous operations:
+ * 1. Client sends a Route Matrix GET request to Azure Maps
+ *
+ * 2. The server will respond with one of the following:
+ *
+ *     > HTTP `202 Accepted` -  Route Matrix request has been accepted.
+ *
+ *     > HTTP `Error` - There was an error processing your Route Matrix request. This could either be a 400 Bad Request or any other Error status code.
+ *
+ *
+ * 3. If the Matrix Route request was accepted successfully, the Location header in the response contains the URL to download the results of the request. This status URI looks like the following:
+ *
+ *   ```
+ *     GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
+ *   ```
+ *
+ *
+ * 4. Client issues a GET request on the download URL obtained in Step 3 to download the results
+ *
+ * ### Download Sync Results
+ * When you make a GET request for Route Matrix Sync API, the service returns 200 response code for successful request and a response array. The response body will contain the data and there will be no possibility to retrieve the results later.
+ *
+ * ### Download Async Results
+ * When a request issues a `202 Accepted` response, the request is being processed using our async pipeline. You will be given a URL to check the progress of your  async request in the location header of the response. This status URI looks like the following:
+ * ```
+ *   GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
+ * ```
+ *
+ * The URL provided by the location header will return the following responses when a `GET` request is issued.
+ *
+ *   > HTTP `202 Accepted` - Matrix request was accepted but is still being processed. Please try again in some time.
+ *
+ *   > HTTP `200 OK` - Matrix request successfully processed. The response body contains all of the results.
+ */
+export interface RouteGetRouteMatrix200Response extends HttpResponse {
+    status: "200";
+    body: RouteMatrixResultOutput;
+}
+export interface RouteGetRouteMatrix202Headers {
+    /** New URL to check for the results of the long-running operation. */
+    location?: string;
+}
+/**
+ *
+ * The `Get Route Matrix` API is an HTTP `GET` request that computes the travel time and distance for all possible pairs in a list of origins and destinations. Unlike the [Get Route Directions](/rest/api/maps/route/get-route-directions) API, which provide detailed route instructions, this API focuses on efficiency by giving you the cost (travel time and distance) of routing from each origin to every destination.  For more information, see [Best practices for Azure Maps Route service](/azure/azure-maps/how-to-use-best-practices-for-routing).
+ *
+ * For every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. As an example, let's say a food delivery company has 20 drivers and they need to find the closest driver to pick up the delivery from the restaurant. To solve this use case, they can call Matrix Route API.
+ *
+ *
+ * For each route, the travel times and distances are returned. You can use the computed costs to determine which detailed routes to calculate using the Route Directions API.
+ *
+ *
+ * The maximum size of a matrix for async request is **700** and for sync request it's **100** (the number of origins multiplied by the number of destinations).
+ *
+ *
+ *
+ * ### Submit Synchronous Route Matrix Request
+ * If your scenario requires synchronous requests and the maximum size of the matrix is less than or equal to 100, you might want to make synchronous request. The maximum size of a matrix for this API is **100** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 10x10, 6x8, 9x8 (it does not need to be square).
+ *
+ * ```
+ * GET https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}
+ * ```
+ *
+ * ### Submit Asynchronous Route Matrix Request
+ * The Asynchronous API is appropriate for processing big volumes of relatively complex routing requests. When you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available. If `waitForResults` parameter in the request is set to true, user will get a 200 response if the request is finished under 120 seconds.
+ *
+ *
+ * The maximum size of a matrix for this API is **700** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 50x10, 10x10, 28x25. 10x70 (it does not need to be square).
+ *
+ *
+ * The asynchronous responses are stored for **24** hours. The redirect URL returns a 404 response if used after the expiration period.
+ *
+ *
+ *
+ *
+ * ```
+ * GET https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}
+ * ```
+ *
+ * Here's a typical sequence of asynchronous operations:
+ * 1. Client sends a Route Matrix GET request to Azure Maps
+ *
+ * 2. The server will respond with one of the following:
+ *
+ *     > HTTP `202 Accepted` -  Route Matrix request has been accepted.
+ *
+ *     > HTTP `Error` - There was an error processing your Route Matrix request. This could either be a 400 Bad Request or any other Error status code.
+ *
+ *
+ * 3. If the Matrix Route request was accepted successfully, the Location header in the response contains the URL to download the results of the request. This status URI looks like the following:
+ *
+ *   ```
+ *     GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
+ *   ```
+ *
+ *
+ * 4. Client issues a GET request on the download URL obtained in Step 3 to download the results
+ *
+ * ### Download Sync Results
+ * When you make a GET request for Route Matrix Sync API, the service returns 200 response code for successful request and a response array. The response body will contain the data and there will be no possibility to retrieve the results later.
+ *
+ * ### Download Async Results
+ * When a request issues a `202 Accepted` response, the request is being processed using our async pipeline. You will be given a URL to check the progress of your  async request in the location header of the response. This status URI looks like the following:
+ * ```
+ *   GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
+ * ```
+ *
+ * The URL provided by the location header will return the following responses when a `GET` request is issued.
+ *
+ *   > HTTP `202 Accepted` - Matrix request was accepted but is still being processed. Please try again in some time.
+ *
+ *   > HTTP `200 OK` - Matrix request successfully processed. The response body contains all of the results.
+ */
+export interface RouteGetRouteMatrix202Response extends HttpResponse {
+    status: "202";
+    headers: RawHttpHeaders & RouteGetRouteMatrix202Headers;
+}
+/**
+ *
+ * The `Post Route Matrix Sync` API is an HTTP `POST` request that allows calculation of a matrix of route summaries for a set of routes defined by origin and destination locations by using a single synchronous (sync) request. To make an asynchronous (async) request, see [Post Route Matrix](/rest/api/maps/route/post-route-matrix). For every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. As an example, let's say a food delivery company has 20 drivers and they need to find the closest driver to pick up the delivery from the restaurant. To solve this use case, they can call Matrix Route API.
+ *
+ *
+ * For each route, the travel times and distances are returned. You can use the computed costs to determine which detailed routes to calculate using the Route Directions API.
+ *
+ *
+ * The maximum size of a matrix for async request is **700** and for sync request it's **100** (the number of origins multiplied by the number of destinations).
+ *
+ *
+ *
+ * ### Submit Synchronous Route Matrix Request
+ * If your scenario requires synchronous requests and the maximum size of the matrix is less than or equal to 100, you might want to make synchronous request. The maximum size of a matrix for this API is **100** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 10x10, 6x8, 9x8 (it does not need to be square).
+ *
+ * ```
+ * POST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}
+ * ```
+ *
+ * ### Submit Asynchronous Route Matrix Request
+ * The Asynchronous API is appropriate for processing big volumes of relatively complex routing requests. When you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available. If `waitForResults` parameter in the request is set to true, user will get a 200 response if the request is finished under 120 seconds.
+ *
+ *
+ * The maximum size of a matrix for this API is **700** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 50x10, 10x10, 28x25. 10x70 (it does not need to be square).
+ *
+ *
+ * The asynchronous responses are stored for **24** hours. The redirect URL returns a 404 response if used after the expiration period.
+ *
+ *
+ *
+ *
+ * ```
+ * POST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}
+ * ```
+ *
+ * Here's a typical sequence of asynchronous operations:
+ * 1. Client sends a Route Matrix POST request to Azure Maps
+ *
+ * 2. The server will respond with one of the following:
+ *
+ *     > HTTP `202 Accepted` -  Route Matrix request has been accepted.
+ *
+ *     > HTTP `Error` - There was an error processing your Route Matrix request. This could either be a 400 Bad Request or any other Error status code.
+ *
+ *
+ * 3. If the Matrix Route request was accepted successfully, the Location header in the response contains the URL to download the results of the request. This status URI looks like the following:
+ *
+ *   ```
+ *     GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
+ *   ```
+ *
+ *
+ * 4. Client issues a GET request on the download URL obtained in Step 3 to download the results
+ *
+ * ### Download Sync Results
+ * When you make a POST request for Route Matrix Sync API, the service returns 200 response code for successful request and a response array. The response body will contain the data and there will be no possibility to retrieve the results later.
+ *
+ * ### Download Async Results
+ * When a request issues a `202 Accepted` response, the request is being processed using our async pipeline. You will be given a URL to check the progress of your  async request in the location header of the response. This status URI looks like the following:
+ * ```
+ *   GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
+ * ```
+ *
+ * The URL provided by the location header will return the following responses when a `GET` request is issued.
+ *
+ *   > HTTP `202 Accepted` - Matrix request was accepted but is still being processed. Please try again in some time.
+ *
+ *   > HTTP `200 OK` - Matrix request successfully processed. The response body contains all of the results.
+ */
+export interface RouteRequestRouteMatrixSync200Response extends HttpResponse {
+    status: "200";
+    body: RouteMatrixResultOutput;
+}
+/**
+ *
+ * The `Post Route Matrix Sync` API is an HTTP `POST` request that allows calculation of a matrix of route summaries for a set of routes defined by origin and destination locations by using a single synchronous (sync) request. To make an asynchronous (async) request, see [Post Route Matrix](/rest/api/maps/route/post-route-matrix). For every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. As an example, let's say a food delivery company has 20 drivers and they need to find the closest driver to pick up the delivery from the restaurant. To solve this use case, they can call Matrix Route API.
+ *
+ *
+ * For each route, the travel times and distances are returned. You can use the computed costs to determine which detailed routes to calculate using the Route Directions API.
+ *
+ *
+ * The maximum size of a matrix for async request is **700** and for sync request it's **100** (the number of origins multiplied by the number of destinations).
+ *
+ *
+ *
+ * ### Submit Synchronous Route Matrix Request
+ * If your scenario requires synchronous requests and the maximum size of the matrix is less than or equal to 100, you might want to make synchronous request. The maximum size of a matrix for this API is **100** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 10x10, 6x8, 9x8 (it does not need to be square).
+ *
+ * ```
+ * POST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}
+ * ```
+ *
+ * ### Submit Asynchronous Route Matrix Request
+ * The Asynchronous API is appropriate for processing big volumes of relatively complex routing requests. When you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available. If `waitForResults` parameter in the request is set to true, user will get a 200 response if the request is finished under 120 seconds.
+ *
+ *
+ * The maximum size of a matrix for this API is **700** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 50x10, 10x10, 28x25. 10x70 (it does not need to be square).
+ *
+ *
+ * The asynchronous responses are stored for **24** hours. The redirect URL returns a 404 response if used after the expiration period.
+ *
+ *
+ *
+ *
+ * ```
+ * POST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}
+ * ```
+ *
+ * Here's a typical sequence of asynchronous operations:
+ * 1. Client sends a Route Matrix POST request to Azure Maps
+ *
+ * 2. The server will respond with one of the following:
+ *
+ *     > HTTP `202 Accepted` -  Route Matrix request has been accepted.
+ *
+ *     > HTTP `Error` - There was an error processing your Route Matrix request. This could either be a 400 Bad Request or any other Error status code.
+ *
+ *
+ * 3. If the Matrix Route request was accepted successfully, the Location header in the response contains the URL to download the results of the request. This status URI looks like the following:
+ *
+ *   ```
+ *     GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
+ *   ```
+ *
+ *
+ * 4. Client issues a GET request on the download URL obtained in Step 3 to download the results
+ *
+ * ### Download Sync Results
+ * When you make a POST request for Route Matrix Sync API, the service returns 200 response code for successful request and a response array. The response body will contain the data and there will be no possibility to retrieve the results later.
+ *
+ * ### Download Async Results
+ * When a request issues a `202 Accepted` response, the request is being processed using our async pipeline. You will be given a URL to check the progress of your  async request in the location header of the response. This status URI looks like the following:
+ * ```
+ *   GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
+ * ```
+ *
+ * The URL provided by the location header will return the following responses when a `GET` request is issued.
+ *
+ *   > HTTP `202 Accepted` - Matrix request was accepted but is still being processed. Please try again in some time.
+ *
+ *   > HTTP `200 OK` - Matrix request successfully processed. The response body contains all of the results.
+ */
+export interface RouteRequestRouteMatrixSync408Response extends HttpResponse {
+    status: "408";
+    body: ErrorResponseOutput;
+}
+/**
+ *
+ * The `Post Route Matrix Sync` API is an HTTP `POST` request that allows calculation of a matrix of route summaries for a set of routes defined by origin and destination locations by using a single synchronous (sync) request. To make an asynchronous (async) request, see [Post Route Matrix](/rest/api/maps/route/post-route-matrix). For every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. As an example, let's say a food delivery company has 20 drivers and they need to find the closest driver to pick up the delivery from the restaurant. To solve this use case, they can call Matrix Route API.
+ *
+ *
+ * For each route, the travel times and distances are returned. You can use the computed costs to determine which detailed routes to calculate using the Route Directions API.
+ *
+ *
+ * The maximum size of a matrix for async request is **700** and for sync request it's **100** (the number of origins multiplied by the number of destinations).
+ *
+ *
+ *
+ * ### Submit Synchronous Route Matrix Request
+ * If your scenario requires synchronous requests and the maximum size of the matrix is less than or equal to 100, you might want to make synchronous request. The maximum size of a matrix for this API is **100** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 10x10, 6x8, 9x8 (it does not need to be square).
+ *
+ * ```
+ * POST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}
+ * ```
+ *
+ * ### Submit Asynchronous Route Matrix Request
+ * The Asynchronous API is appropriate for processing big volumes of relatively complex routing requests. When you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available. If `waitForResults` parameter in the request is set to true, user will get a 200 response if the request is finished under 120 seconds.
+ *
+ *
+ * The maximum size of a matrix for this API is **700** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 50x10, 10x10, 28x25. 10x70 (it does not need to be square).
+ *
+ *
+ * The asynchronous responses are stored for **24** hours. The redirect URL returns a 404 response if used after the expiration period.
+ *
+ *
+ *
+ *
+ * ```
+ * POST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}
+ * ```
+ *
+ * Here's a typical sequence of asynchronous operations:
+ * 1. Client sends a Route Matrix POST request to Azure Maps
+ *
+ * 2. The server will respond with one of the following:
+ *
+ *     > HTTP `202 Accepted` -  Route Matrix request has been accepted.
+ *
+ *     > HTTP `Error` - There was an error processing your Route Matrix request. This could either be a 400 Bad Request or any other Error status code.
+ *
+ *
+ * 3. If the Matrix Route request was accepted successfully, the Location header in the response contains the URL to download the results of the request. This status URI looks like the following:
+ *
+ *   ```
+ *     GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
+ *   ```
+ *
+ *
+ * 4. Client issues a GET request on the download URL obtained in Step 3 to download the results
+ *
+ * ### Download Sync Results
+ * When you make a POST request for Route Matrix Sync API, the service returns 200 response code for successful request and a response array. The response body will contain the data and there will be no possibility to retrieve the results later.
+ *
+ * ### Download Async Results
+ * When a request issues a `202 Accepted` response, the request is being processed using our async pipeline. You will be given a URL to check the progress of your  async request in the location header of the response. This status URI looks like the following:
+ * ```
+ *   GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
+ * ```
+ *
+ * The URL provided by the location header will return the following responses when a `GET` request is issued.
+ *
+ *   > HTTP `202 Accepted` - Matrix request was accepted but is still being processed. Please try again in some time.
+ *
+ *   > HTTP `200 OK` - Matrix request successfully processed. The response body contains all of the results.
+ */
+export interface RouteRequestRouteMatrixSyncDefaultResponse extends HttpResponse {
+    status: string;
+    body: ErrorResponseOutput;
+}
+/**
+ *
+ * The `Get Route Directions` API is an HTTP `GET` request that returns a route between an origin and a destination, passing through waypoints if specified. The route takes into account factors such as current traffic and the typical road speeds on the requested day of the week and time of day.
+ *
+ * Information returned includes the distance, estimated travel time, and a representation of the route geometry. Additional routing information such as optimized waypoint order or turn by turn instructions is also available, depending on the options selected.
+ *
+ * Routing service provides a set of parameters for a detailed description of a vehicle-specific consumption model. For more information, see [Consumption Model](/azure/azure-maps/consumption-model).
+ */
+export interface RouteGetRouteDirections200Response extends HttpResponse {
+    status: "200";
+    body: RouteDirectionsOutput;
+}
+/**
+ *
+ * The `Get Route Directions` API is an HTTP `GET` request that returns a route between an origin and a destination, passing through waypoints if specified. The route takes into account factors such as current traffic and the typical road speeds on the requested day of the week and time of day.
+ *
+ * Information returned includes the distance, estimated travel time, and a representation of the route geometry. Additional routing information such as optimized waypoint order or turn by turn instructions is also available, depending on the options selected.
+ *
+ * Routing service provides a set of parameters for a detailed description of a vehicle-specific consumption model. For more information, see [Consumption Model](/azure/azure-maps/consumption-model).
+ */
+export interface RouteGetRouteDirectionsDefaultResponse extends HttpResponse {
+    status: string;
+    body: ErrorResponseOutput;
+}
+/**
+ *
+ * The `Post Route Directions` API is an HTTP `POST` request that returns a route between an origin and a destination, passing through waypoints if they are specified. The route will take into account factors such as current traffic and the typical road speeds on the requested day of the week and time of day.
+ *
+ * Information returned includes the distance, estimated travel time, and a representation of the route geometry. Additional routing information such as optimized waypoint order or turn by turn instructions is also available, depending on the options selected.
+ *
+ * Routing service provides a set of parameters for a detailed description of a vehicle-specific Consumption Model. Please check [Consumption Model](https://docs.microsoft.com/azure/azure-maps/consumption-model) for detailed explanation of the concepts and parameters involved.
+ */
+export interface RouteGetRouteDirectionsWithAdditionalParameters200Response extends HttpResponse {
+    status: "200";
+    body: RouteDirectionsOutput;
+}
+/**
+ *
+ * The `Post Route Directions` API is an HTTP `POST` request that returns a route between an origin and a destination, passing through waypoints if they are specified. The route will take into account factors such as current traffic and the typical road speeds on the requested day of the week and time of day.
+ *
+ * Information returned includes the distance, estimated travel time, and a representation of the route geometry. Additional routing information such as optimized waypoint order or turn by turn instructions is also available, depending on the options selected.
+ *
+ * Routing service provides a set of parameters for a detailed description of a vehicle-specific Consumption Model. Please check [Consumption Model](https://docs.microsoft.com/azure/azure-maps/consumption-model) for detailed explanation of the concepts and parameters involved.
+ */
+export interface RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse extends HttpResponse {
+    status: string;
+    body: ErrorResponseOutput;
+}
+/**
+ *
+ * The `Get Route Range` (Isochrone) API is an HTTP `GET` request that will calculate a set of locations that can be reached from the origin point based on fuel, energy, time or distance budget that is specified. A polygon boundary (or Isochrone) is returned in a counterclockwise  orientation as well as the precise polygon center which was the result of the origin point.
+ *
+ * The returned polygon can be used for further processing such as  [Search Inside Geometry](/rest/api/maps/search/post-search-inside-geometry) to  search for POIs within the provided isochrone.
+ */
+export interface RouteGetRouteRange200Response extends HttpResponse {
+    status: "200";
+    body: RouteRangeResultOutput;
+}
+/**
+ *
+ * The `Get Route Range` (Isochrone) API is an HTTP `GET` request that will calculate a set of locations that can be reached from the origin point based on fuel, energy, time or distance budget that is specified. A polygon boundary (or Isochrone) is returned in a counterclockwise  orientation as well as the precise polygon center which was the result of the origin point.
+ *
+ * The returned polygon can be used for further processing such as  [Search Inside Geometry](/rest/api/maps/search/post-search-inside-geometry) to  search for POIs within the provided isochrone.
+ */
+export interface RouteGetRouteRangeDefaultResponse extends HttpResponse {
+    status: string;
+    body: ErrorResponseOutput;
+}
+/**
+ *
+ * The `Post Route Directions Batch` API is an HTTP `POST` request that sends batches of queries to the [Get Route Directions](/rest/api/maps/route/get-route-directions) API using a single asynchronous request. You can call `Route Directions Batch` API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **700** queries and sync API up to **100** queries. To call the `Post Route Directions Batch` API in a synchronous request, see [Post Route Directions Batch Sync](/rest/api/maps/route/post-route-directions-batch-sync).
+ *
+ * ### Submit Asynchronous Batch Request
+ * The Asynchronous API is appropriate for processing big volumes of relatively complex route requests
+ * - It allows the retrieval of results in a separate call (multiple downloads are possible).
+ * - The asynchronous API is optimized for reliability and is not expected to run into a timeout.
+ * - The number of batch items is limited to **700** for this API.
+ *
+ * When you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available.
+ * The asynchronous responses are stored for **24** hours. The redirect URL returns a 404 response if used after the expiration period.
+ *
+ * Please note that asynchronous batch request is a long-running operation. Here's a typical sequence of operations:
+ * 1. Client sends a Route Directions Batch `POST` request to Azure Maps.
+ * ```
+ * POST https://atlas.microsoft.com/route/directions/batch/json?api-version=1.0&subscription-key={subscription-key}
+ * ```
+ * 2. The server will respond with one of the following:
+ *
+ *     > HTTP `202 Accepted` - Batch request has been accepted.
+ *
+ *     > HTTP `Error` - There was an error processing your Batch request. This could either be a `400 Bad Request` or any other `Error` status code.
+ *
+ * 3. If the batch request was accepted successfully, the `Location` header in the response contains the URL to download the results of the batch request.
+ *     This status URI looks like following:
+ * ```
+ * GET https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
+ * ```
+ * 4. Client issues a `GET` request on the _download URL_ obtained in Step 3 to download the batch results.
+ *
+ * ### POST Body for Batch Request
+ * To send the _route directions_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 3 _route directions_ queries:
+ *
+ *
+ * ```json
+ * {
+ *     "batchItems": [
+ *         { "query": "?query=47.620659,-122.348934:47.610101,-122.342015&travelMode=bicycle&routeType=eco&traffic=false" },
+ *         { "query": "?query=40.759856,-73.985108:40.771136,-73.973506&travelMode=pedestrian&routeType=shortest" },
+ *         { "query": "?query=48.923159,-122.557362:32.621279,-116.840362" }
+ *     ]
+ * }
+ * ```
+ *
+ * A _route directions_ query in a batch is just a partial URL _without_ the protocol, base URL, path, api-version and subscription-key. It can accept any of the supported _route directions_ [URI parameters](https://docs.microsoft.com/rest/api/maps/route/getroutedirections#uri-parameters). The string values in the _route directions_ query must be properly escaped (e.g. " character should be escaped with \\ ) and it should also be properly URL-encoded.
+ *
+ *
+ * The async API allows caller to batch up to **700** queries and sync API up to **100** queries, and the batch should contain at least **1** query.
+ *
+ *
+ * ### Download Asynchronous Batch Results
+ * To download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following:
+ *
+ * ```
+ * https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
+ * ```
+ * Here's the typical sequence of operations for downloading the batch results:
+ * 1. Client sends a `GET` request using the _download URL_.
+ * 2. The server will respond with one of the following:
+ *
+ *     > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time.
+ *
+ *     > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results.
+ *
+ *
+ *
+ * ### Batch Response Model
+ * The returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types:
+ *
+ *   - [`RouteDirections`](https://docs.microsoft.com/rest/api/maps/route/getroutedirections#routedirections) - If the query completed successfully.
+ *
+ *   - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.
+ *
+ *
+ * Here's a sample Batch Response with 1 _successful_ and 1 _failed_ result:
+ *
+ *
+ * ```json
+ * {
+ *     "summary": {
+ *         "successfulRequests": 1,
+ *         "totalRequests": 2
+ *     },
+ *     "batchItems": [
+ *         {
+ *             "statusCode": 200,
+ *             "response": {
+ *                 "routes": [
+ *                     {
+ *                         "summary": {
+ *                             "lengthInMeters": 1758,
+ *                             "travelTimeInSeconds": 387,
+ *                             "trafficDelayInSeconds": 0,
+ *                             "departureTime": "2018-07-17T00:49:56+00:00",
+ *                             "arrivalTime": "2018-07-17T00:56:22+00:00"
+ *                         },
+ *                         "legs": [
+ *                             {
+ *                                 "summary": {
+ *                                     "lengthInMeters": 1758,
+ *                                     "travelTimeInSeconds": 387,
+ *                                     "trafficDelayInSeconds": 0,
+ *                                     "departureTime": "2018-07-17T00:49:56+00:00",
+ *                                     "arrivalTime": "2018-07-17T00:56:22+00:00"
+ *                                 },
+ *                                 "points": [
+ *                                     {
+ *                                         "latitude": 47.62094,
+ *                                         "longitude": -122.34892
+ *                                     },
+ *                                     {
+ *                                         "latitude": 47.62094,
+ *                                         "longitude": -122.3485
+ *                                     },
+ *                                     {
+ *                                         "latitude": 47.62095,
+ *                                         "longitude": -122.3476
+ *                                     }
+ *                                 ]
+ *                             }
+ *                         ],
+ *                         "sections": [
+ *                             {
+ *                                 "startPointIndex": 0,
+ *                                 "endPointIndex": 40,
+ *                                 "sectionType": "TRAVEL_MODE",
+ *                                 "travelMode": "bicycle"
+ *                             }
+ *                         ]
+ *                     }
+ *                 ]
+ *             }
+ *         },
+ *         {
+ *             "statusCode": 400,
+ *             "response":
+ *             {
+ *                 "error":
+ *                 {
+ *                     "code": "400 BadRequest",
+ *                     "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
+ *                 }
+ *             }
+ *         }
+ *     ]
+ * }
+ * ```
+ */
+export interface RouteRequestRouteDirectionsBatch200Response extends HttpResponse {
+    status: "200";
+    body: RouteDirectionsBatchResultOutput;
+}
+export interface RouteRequestRouteDirectionsBatch202Headers {
+    /** New URL to check for the results of the long-running operation. */
+    location?: string;
+}
+/**
+ *
+ * The `Post Route Directions Batch` API is an HTTP `POST` request that sends batches of queries to the [Get Route Directions](/rest/api/maps/route/get-route-directions) API using a single asynchronous request. You can call `Route Directions Batch` API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **700** queries and sync API up to **100** queries. To call the `Post Route Directions Batch` API in a synchronous request, see [Post Route Directions Batch Sync](/rest/api/maps/route/post-route-directions-batch-sync).
+ *
+ * ### Submit Asynchronous Batch Request
+ * The Asynchronous API is appropriate for processing big volumes of relatively complex route requests
+ * - It allows the retrieval of results in a separate call (multiple downloads are possible).
+ * - The asynchronous API is optimized for reliability and is not expected to run into a timeout.
+ * - The number of batch items is limited to **700** for this API.
+ *
+ * When you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available.
+ * The asynchronous responses are stored for **24** hours. The redirect URL returns a 404 response if used after the expiration period.
+ *
+ * Please note that asynchronous batch request is a long-running operation. Here's a typical sequence of operations:
+ * 1. Client sends a Route Directions Batch `POST` request to Azure Maps.
+ * ```
+ * POST https://atlas.microsoft.com/route/directions/batch/json?api-version=1.0&subscription-key={subscription-key}
+ * ```
+ * 2. The server will respond with one of the following:
+ *
+ *     > HTTP `202 Accepted` - Batch request has been accepted.
+ *
+ *     > HTTP `Error` - There was an error processing your Batch request. This could either be a `400 Bad Request` or any other `Error` status code.
+ *
+ * 3. If the batch request was accepted successfully, the `Location` header in the response contains the URL to download the results of the batch request.
+ *     This status URI looks like following:
+ * ```
+ * GET https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
+ * ```
+ * 4. Client issues a `GET` request on the _download URL_ obtained in Step 3 to download the batch results.
+ *
+ * ### POST Body for Batch Request
+ * To send the _route directions_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 3 _route directions_ queries:
+ *
+ *
+ * ```json
+ * {
+ *     "batchItems": [
+ *         { "query": "?query=47.620659,-122.348934:47.610101,-122.342015&travelMode=bicycle&routeType=eco&traffic=false" },
+ *         { "query": "?query=40.759856,-73.985108:40.771136,-73.973506&travelMode=pedestrian&routeType=shortest" },
+ *         { "query": "?query=48.923159,-122.557362:32.621279,-116.840362" }
+ *     ]
+ * }
+ * ```
+ *
+ * A _route directions_ query in a batch is just a partial URL _without_ the protocol, base URL, path, api-version and subscription-key. It can accept any of the supported _route directions_ [URI parameters](https://docs.microsoft.com/rest/api/maps/route/getroutedirections#uri-parameters). The string values in the _route directions_ query must be properly escaped (e.g. " character should be escaped with \\ ) and it should also be properly URL-encoded.
+ *
+ *
+ * The async API allows caller to batch up to **700** queries and sync API up to **100** queries, and the batch should contain at least **1** query.
+ *
+ *
+ * ### Download Asynchronous Batch Results
+ * To download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following:
+ *
+ * ```
+ * https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
+ * ```
+ * Here's the typical sequence of operations for downloading the batch results:
+ * 1. Client sends a `GET` request using the _download URL_.
+ * 2. The server will respond with one of the following:
+ *
+ *     > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time.
+ *
+ *     > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results.
+ *
+ *
+ *
+ * ### Batch Response Model
+ * The returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types:
+ *
+ *   - [`RouteDirections`](https://docs.microsoft.com/rest/api/maps/route/getroutedirections#routedirections) - If the query completed successfully.
+ *
+ *   - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.
+ *
+ *
+ * Here's a sample Batch Response with 1 _successful_ and 1 _failed_ result:
+ *
+ *
+ * ```json
+ * {
+ *     "summary": {
+ *         "successfulRequests": 1,
+ *         "totalRequests": 2
+ *     },
+ *     "batchItems": [
+ *         {
+ *             "statusCode": 200,
+ *             "response": {
+ *                 "routes": [
+ *                     {
+ *                         "summary": {
+ *                             "lengthInMeters": 1758,
+ *                             "travelTimeInSeconds": 387,
+ *                             "trafficDelayInSeconds": 0,
+ *                             "departureTime": "2018-07-17T00:49:56+00:00",
+ *                             "arrivalTime": "2018-07-17T00:56:22+00:00"
+ *                         },
+ *                         "legs": [
+ *                             {
+ *                                 "summary": {
+ *                                     "lengthInMeters": 1758,
+ *                                     "travelTimeInSeconds": 387,
+ *                                     "trafficDelayInSeconds": 0,
+ *                                     "departureTime": "2018-07-17T00:49:56+00:00",
+ *                                     "arrivalTime": "2018-07-17T00:56:22+00:00"
+ *                                 },
+ *                                 "points": [
+ *                                     {
+ *                                         "latitude": 47.62094,
+ *                                         "longitude": -122.34892
+ *                                     },
+ *                                     {
+ *                                         "latitude": 47.62094,
+ *                                         "longitude": -122.3485
+ *                                     },
+ *                                     {
+ *                                         "latitude": 47.62095,
+ *                                         "longitude": -122.3476
+ *                                     }
+ *                                 ]
+ *                             }
+ *                         ],
+ *                         "sections": [
+ *                             {
+ *                                 "startPointIndex": 0,
+ *                                 "endPointIndex": 40,
+ *                                 "sectionType": "TRAVEL_MODE",
+ *                                 "travelMode": "bicycle"
+ *                             }
+ *                         ]
+ *                     }
+ *                 ]
+ *             }
+ *         },
+ *         {
+ *             "statusCode": 400,
+ *             "response":
+ *             {
+ *                 "error":
+ *                 {
+ *                     "code": "400 BadRequest",
+ *                     "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
+ *                 }
+ *             }
+ *         }
+ *     ]
+ * }
+ * ```
+ */
+export interface RouteRequestRouteDirectionsBatch202Response extends HttpResponse {
+    status: "202";
+    headers: RawHttpHeaders & RouteRequestRouteDirectionsBatch202Headers;
+}
+/**
+ *
+ * The `Get Route Directions Batch` API is an HTTP `GET` request that sends batches of queries to the [Get Route Directions](/rest/api/maps/route/get-route-directions) API using a single request. You can call `Get Route Directions Batch` API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **700** queries and sync API up to **100** queries.
+ *
+ * ### Download Asynchronous Batch Results
+ * To download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following:
+ *
+ * ```
+ * https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
+ * ```
+ * Here's the typical sequence of operations for downloading the batch results:
+ * 1. Client sends a `GET` request using the _download URL_.
+ * 2. The server will respond with one of the following:
+ *
+ *     > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time.
+ *
+ *     > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results.
+ *
+ *
+ *
+ * ### Batch Response Model
+ * The returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types:
+ *
+ *   - [`RouteDirections`](https://docs.microsoft.com/rest/api/maps/route/getroutedirections#routedirections) - If the query completed successfully.
+ *
+ *   - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.
+ *
+ *
+ * Here's a sample Batch Response with 1 _successful_ and 1 _failed_ result:
+ *
+ *
+ * ```json
+ * {
+ *     "summary": {
+ *         "successfulRequests": 1,
+ *         "totalRequests": 2
+ *     },
+ *     "batchItems": [
+ *         {
+ *             "statusCode": 200,
+ *             "response": {
+ *                 "routes": [
+ *                     {
+ *                         "summary": {
+ *                             "lengthInMeters": 1758,
+ *                             "travelTimeInSeconds": 387,
+ *                             "trafficDelayInSeconds": 0,
+ *                             "departureTime": "2018-07-17T00:49:56+00:00",
+ *                             "arrivalTime": "2018-07-17T00:56:22+00:00"
+ *                         },
+ *                         "legs": [
+ *                             {
+ *                                 "summary": {
+ *                                     "lengthInMeters": 1758,
+ *                                     "travelTimeInSeconds": 387,
+ *                                     "trafficDelayInSeconds": 0,
+ *                                     "departureTime": "2018-07-17T00:49:56+00:00",
+ *                                     "arrivalTime": "2018-07-17T00:56:22+00:00"
+ *                                 },
+ *                                 "points": [
+ *                                     {
+ *                                         "latitude": 47.62094,
+ *                                         "longitude": -122.34892
+ *                                     },
+ *                                     {
+ *                                         "latitude": 47.62094,
+ *                                         "longitude": -122.3485
+ *                                     },
+ *                                     {
+ *                                         "latitude": 47.62095,
+ *                                         "longitude": -122.3476
+ *                                     }
+ *                                 ]
+ *                             }
+ *                         ],
+ *                         "sections": [
+ *                             {
+ *                                 "startPointIndex": 0,
+ *                                 "endPointIndex": 40,
+ *                                 "sectionType": "TRAVEL_MODE",
+ *                                 "travelMode": "bicycle"
+ *                             }
+ *                         ]
+ *                     }
+ *                 ]
+ *             }
+ *         },
+ *         {
+ *             "statusCode": 400,
+ *             "response":
+ *             {
+ *                 "error":
+ *                 {
+ *                     "code": "400 BadRequest",
+ *                     "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
+ *                 }
+ *             }
+ *         }
+ *     ]
+ * }
+ * ```
+ */
+export interface RouteGetRouteDirectionsBatch200Response extends HttpResponse {
+    status: "200";
+    body: RouteDirectionsBatchResultOutput;
+}
+export interface RouteGetRouteDirectionsBatch202Headers {
+    /** New URL to check for the results of the long-running operation. */
+    location?: string;
+}
+/**
+ *
+ * The `Get Route Directions Batch` API is an HTTP `GET` request that sends batches of queries to the [Get Route Directions](/rest/api/maps/route/get-route-directions) API using a single request. You can call `Get Route Directions Batch` API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **700** queries and sync API up to **100** queries.
+ *
+ * ### Download Asynchronous Batch Results
+ * To download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following:
+ *
+ * ```
+ * https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
+ * ```
+ * Here's the typical sequence of operations for downloading the batch results:
+ * 1. Client sends a `GET` request using the _download URL_.
+ * 2. The server will respond with one of the following:
+ *
+ *     > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time.
+ *
+ *     > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results.
+ *
+ *
+ *
+ * ### Batch Response Model
+ * The returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types:
+ *
+ *   - [`RouteDirections`](https://docs.microsoft.com/rest/api/maps/route/getroutedirections#routedirections) - If the query completed successfully.
+ *
+ *   - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.
+ *
+ *
+ * Here's a sample Batch Response with 1 _successful_ and 1 _failed_ result:
+ *
+ *
+ * ```json
+ * {
+ *     "summary": {
+ *         "successfulRequests": 1,
+ *         "totalRequests": 2
+ *     },
+ *     "batchItems": [
+ *         {
+ *             "statusCode": 200,
+ *             "response": {
+ *                 "routes": [
+ *                     {
+ *                         "summary": {
+ *                             "lengthInMeters": 1758,
+ *                             "travelTimeInSeconds": 387,
+ *                             "trafficDelayInSeconds": 0,
+ *                             "departureTime": "2018-07-17T00:49:56+00:00",
+ *                             "arrivalTime": "2018-07-17T00:56:22+00:00"
+ *                         },
+ *                         "legs": [
+ *                             {
+ *                                 "summary": {
+ *                                     "lengthInMeters": 1758,
+ *                                     "travelTimeInSeconds": 387,
+ *                                     "trafficDelayInSeconds": 0,
+ *                                     "departureTime": "2018-07-17T00:49:56+00:00",
+ *                                     "arrivalTime": "2018-07-17T00:56:22+00:00"
+ *                                 },
+ *                                 "points": [
+ *                                     {
+ *                                         "latitude": 47.62094,
+ *                                         "longitude": -122.34892
+ *                                     },
+ *                                     {
+ *                                         "latitude": 47.62094,
+ *                                         "longitude": -122.3485
+ *                                     },
+ *                                     {
+ *                                         "latitude": 47.62095,
+ *                                         "longitude": -122.3476
+ *                                     }
+ *                                 ]
+ *                             }
+ *                         ],
+ *                         "sections": [
+ *                             {
+ *                                 "startPointIndex": 0,
+ *                                 "endPointIndex": 40,
+ *                                 "sectionType": "TRAVEL_MODE",
+ *                                 "travelMode": "bicycle"
+ *                             }
+ *                         ]
+ *                     }
+ *                 ]
+ *             }
+ *         },
+ *         {
+ *             "statusCode": 400,
+ *             "response":
+ *             {
+ *                 "error":
+ *                 {
+ *                     "code": "400 BadRequest",
+ *                     "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
+ *                 }
+ *             }
+ *         }
+ *     ]
+ * }
+ * ```
+ */
+export interface RouteGetRouteDirectionsBatch202Response extends HttpResponse {
+    status: "202";
+    headers: RawHttpHeaders & RouteGetRouteDirectionsBatch202Headers;
+}
+/**
+ *
+ * The `Post Route Directions Batch Sync` API is an HTTP `POST` request that sends batches of queries to the [Get Route Directions](/rest/api/maps/route/get-route-directions) API using a single synchronous request. You can call `Route Directions Batch` API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **700** queries and sync API up to **100** queries. To call the `Post Route Directions Batch` API in a asynchronous request, see [Post Route Directions Batch](/rest/api/maps/route/post-route-directions-batch).
+ * ### Submit Synchronous Batch Request
+ * The Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.
+ * ```
+ * POST https://atlas.microsoft.com/route/directions/batch/sync/json?api-version=1.0&subscription-key={subscription-key}
+ * ```
+ * ### Batch Response Model
+ * The returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types:
+ *
+ *   - [`RouteDirections`](https://docs.microsoft.com/rest/api/maps/route/getroutedirections#routedirections) - If the query completed successfully.
+ *
+ *   - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.
+ *
+ *
+ * Here's a sample Batch Response with 1 _successful_ and 1 _failed_ result:
+ *
+ *
+ * ```json
+ * {
+ *     "summary": {
+ *         "successfulRequests": 1,
+ *         "totalRequests": 2
+ *     },
+ *     "batchItems": [
+ *         {
+ *             "statusCode": 200,
+ *             "response": {
+ *                 "routes": [
+ *                     {
+ *                         "summary": {
+ *                             "lengthInMeters": 1758,
+ *                             "travelTimeInSeconds": 387,
+ *                             "trafficDelayInSeconds": 0,
+ *                             "departureTime": "2018-07-17T00:49:56+00:00",
+ *                             "arrivalTime": "2018-07-17T00:56:22+00:00"
+ *                         },
+ *                         "legs": [
+ *                             {
+ *                                 "summary": {
+ *                                     "lengthInMeters": 1758,
+ *                                     "travelTimeInSeconds": 387,
+ *                                     "trafficDelayInSeconds": 0,
+ *                                     "departureTime": "2018-07-17T00:49:56+00:00",
+ *                                     "arrivalTime": "2018-07-17T00:56:22+00:00"
+ *                                 },
+ *                                 "points": [
+ *                                     {
+ *                                         "latitude": 47.62094,
+ *                                         "longitude": -122.34892
+ *                                     },
+ *                                     {
+ *                                         "latitude": 47.62094,
+ *                                         "longitude": -122.3485
+ *                                     },
+ *                                     {
+ *                                         "latitude": 47.62095,
+ *                                         "longitude": -122.3476
+ *                                     }
+ *                                 ]
+ *                             }
+ *                         ],
+ *                         "sections": [
+ *                             {
+ *                                 "startPointIndex": 0,
+ *                                 "endPointIndex": 40,
+ *                                 "sectionType": "TRAVEL_MODE",
+ *                                 "travelMode": "bicycle"
+ *                             }
+ *                         ]
+ *                     }
+ *                 ]
+ *             }
+ *         },
+ *         {
+ *             "statusCode": 400,
+ *             "response":
+ *             {
+ *                 "error":
+ *                 {
+ *                     "code": "400 BadRequest",
+ *                     "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
+ *                 }
+ *             }
+ *         }
+ *     ]
+ * }
+ * ```
+ */
+export interface RouteRequestRouteDirectionsBatchSync200Response extends HttpResponse {
+    status: "200";
+    body: RouteDirectionsBatchResultOutput;
+}
+/**
+ *
+ * The `Post Route Directions Batch Sync` API is an HTTP `POST` request that sends batches of queries to the [Get Route Directions](/rest/api/maps/route/get-route-directions) API using a single synchronous request. You can call `Route Directions Batch` API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **700** queries and sync API up to **100** queries. To call the `Post Route Directions Batch` API in a asynchronous request, see [Post Route Directions Batch](/rest/api/maps/route/post-route-directions-batch).
+ * ### Submit Synchronous Batch Request
+ * The Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.
+ * ```
+ * POST https://atlas.microsoft.com/route/directions/batch/sync/json?api-version=1.0&subscription-key={subscription-key}
+ * ```
+ * ### Batch Response Model
+ * The returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types:
+ *
+ *   - [`RouteDirections`](https://docs.microsoft.com/rest/api/maps/route/getroutedirections#routedirections) - If the query completed successfully.
+ *
+ *   - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.
+ *
+ *
+ * Here's a sample Batch Response with 1 _successful_ and 1 _failed_ result:
+ *
+ *
+ * ```json
+ * {
+ *     "summary": {
+ *         "successfulRequests": 1,
+ *         "totalRequests": 2
+ *     },
+ *     "batchItems": [
+ *         {
+ *             "statusCode": 200,
+ *             "response": {
+ *                 "routes": [
+ *                     {
+ *                         "summary": {
+ *                             "lengthInMeters": 1758,
+ *                             "travelTimeInSeconds": 387,
+ *                             "trafficDelayInSeconds": 0,
+ *                             "departureTime": "2018-07-17T00:49:56+00:00",
+ *                             "arrivalTime": "2018-07-17T00:56:22+00:00"
+ *                         },
+ *                         "legs": [
+ *                             {
+ *                                 "summary": {
+ *                                     "lengthInMeters": 1758,
+ *                                     "travelTimeInSeconds": 387,
+ *                                     "trafficDelayInSeconds": 0,
+ *                                     "departureTime": "2018-07-17T00:49:56+00:00",
+ *                                     "arrivalTime": "2018-07-17T00:56:22+00:00"
+ *                                 },
+ *                                 "points": [
+ *                                     {
+ *                                         "latitude": 47.62094,
+ *                                         "longitude": -122.34892
+ *                                     },
+ *                                     {
+ *                                         "latitude": 47.62094,
+ *                                         "longitude": -122.3485
+ *                                     },
+ *                                     {
+ *                                         "latitude": 47.62095,
+ *                                         "longitude": -122.3476
+ *                                     }
+ *                                 ]
+ *                             }
+ *                         ],
+ *                         "sections": [
+ *                             {
+ *                                 "startPointIndex": 0,
+ *                                 "endPointIndex": 40,
+ *                                 "sectionType": "TRAVEL_MODE",
+ *                                 "travelMode": "bicycle"
+ *                             }
+ *                         ]
+ *                     }
+ *                 ]
+ *             }
+ *         },
+ *         {
+ *             "statusCode": 400,
+ *             "response":
+ *             {
+ *                 "error":
+ *                 {
+ *                     "code": "400 BadRequest",
+ *                     "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
+ *                 }
+ *             }
+ *         }
+ *     ]
+ * }
+ * ```
+ */
+export interface RouteRequestRouteDirectionsBatchSync408Response extends HttpResponse {
+    status: "408";
+    body: ErrorResponseOutput;
+}
+/**
+ *
+ * The `Post Route Directions Batch Sync` API is an HTTP `POST` request that sends batches of queries to the [Get Route Directions](/rest/api/maps/route/get-route-directions) API using a single synchronous request. You can call `Route Directions Batch` API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **700** queries and sync API up to **100** queries. To call the `Post Route Directions Batch` API in a asynchronous request, see [Post Route Directions Batch](/rest/api/maps/route/post-route-directions-batch).
+ * ### Submit Synchronous Batch Request
+ * The Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.
+ * ```
+ * POST https://atlas.microsoft.com/route/directions/batch/sync/json?api-version=1.0&subscription-key={subscription-key}
+ * ```
+ * ### Batch Response Model
+ * The returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types:
+ *
+ *   - [`RouteDirections`](https://docs.microsoft.com/rest/api/maps/route/getroutedirections#routedirections) - If the query completed successfully.
+ *
+ *   - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.
+ *
+ *
+ * Here's a sample Batch Response with 1 _successful_ and 1 _failed_ result:
+ *
+ *
+ * ```json
+ * {
+ *     "summary": {
+ *         "successfulRequests": 1,
+ *         "totalRequests": 2
+ *     },
+ *     "batchItems": [
+ *         {
+ *             "statusCode": 200,
+ *             "response": {
+ *                 "routes": [
+ *                     {
+ *                         "summary": {
+ *                             "lengthInMeters": 1758,
+ *                             "travelTimeInSeconds": 387,
+ *                             "trafficDelayInSeconds": 0,
+ *                             "departureTime": "2018-07-17T00:49:56+00:00",
+ *                             "arrivalTime": "2018-07-17T00:56:22+00:00"
+ *                         },
+ *                         "legs": [
+ *                             {
+ *                                 "summary": {
+ *                                     "lengthInMeters": 1758,
+ *                                     "travelTimeInSeconds": 387,
+ *                                     "trafficDelayInSeconds": 0,
+ *                                     "departureTime": "2018-07-17T00:49:56+00:00",
+ *                                     "arrivalTime": "2018-07-17T00:56:22+00:00"
+ *                                 },
+ *                                 "points": [
+ *                                     {
+ *                                         "latitude": 47.62094,
+ *                                         "longitude": -122.34892
+ *                                     },
+ *                                     {
+ *                                         "latitude": 47.62094,
+ *                                         "longitude": -122.3485
+ *                                     },
+ *                                     {
+ *                                         "latitude": 47.62095,
+ *                                         "longitude": -122.3476
+ *                                     }
+ *                                 ]
+ *                             }
+ *                         ],
+ *                         "sections": [
+ *                             {
+ *                                 "startPointIndex": 0,
+ *                                 "endPointIndex": 40,
+ *                                 "sectionType": "TRAVEL_MODE",
+ *                                 "travelMode": "bicycle"
+ *                             }
+ *                         ]
+ *                     }
+ *                 ]
+ *             }
+ *         },
+ *         {
+ *             "statusCode": 400,
+ *             "response":
+ *             {
+ *                 "error":
+ *                 {
+ *                     "code": "400 BadRequest",
+ *                     "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
+ *                 }
+ *             }
+ *         }
+ *     ]
+ * }
+ * ```
+ */
+export interface RouteRequestRouteDirectionsBatchSyncDefaultResponse extends HttpResponse {
+    status: string;
+    body: ErrorResponseOutput;
+}
+//# sourceMappingURL=responses.d.ts.map