@azure-rest/maps-route 1.0.0-beta.3 → 1.0.0-beta.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +4 -4
- package/README.md +81 -67
- package/dist/browser/generated/clientDefinitions.d.ts +617 -0
- package/dist/browser/generated/clientDefinitions.d.ts.map +1 -0
- package/dist/browser/generated/clientDefinitions.js +4 -0
- package/dist/browser/generated/clientDefinitions.js.map +1 -0
- package/dist/browser/generated/index.d.ts +12 -0
- package/dist/browser/generated/index.d.ts.map +1 -0
- package/dist/browser/generated/index.js +14 -0
- package/dist/browser/generated/index.js.map +1 -0
- package/dist/browser/generated/isUnexpected.d.ts +7 -0
- package/dist/browser/generated/isUnexpected.d.ts.map +1 -0
- package/dist/browser/generated/isUnexpected.js +79 -0
- package/dist/browser/generated/isUnexpected.js.map +1 -0
- package/dist/browser/generated/logger.d.ts +2 -0
- package/dist/browser/generated/logger.d.ts.map +1 -0
- package/dist/browser/generated/logger.js +5 -0
- package/dist/browser/generated/logger.js.map +1 -0
- package/dist/browser/generated/mapsRouteClient.d.ts +15 -0
- package/dist/browser/generated/mapsRouteClient.d.ts.map +1 -0
- package/dist/browser/generated/mapsRouteClient.js +42 -0
- package/dist/browser/generated/mapsRouteClient.js.map +1 -0
- package/dist/browser/generated/models.d.ts +130 -0
- package/dist/browser/generated/models.d.ts.map +1 -0
- package/dist/browser/generated/models.js +4 -0
- package/dist/browser/generated/models.js.map +1 -0
- package/dist/browser/generated/outputModels.d.ts +286 -0
- package/dist/browser/generated/outputModels.d.ts.map +1 -0
- package/dist/browser/generated/outputModels.js +4 -0
- package/dist/browser/generated/outputModels.js.map +1 -0
- package/dist/browser/generated/parameters.d.ts +937 -0
- package/dist/browser/generated/parameters.d.ts.map +1 -0
- package/dist/browser/generated/parameters.js +4 -0
- package/dist/browser/generated/parameters.js.map +1 -0
- package/dist/browser/generated/pollingHelper.d.ts +76 -0
- package/dist/browser/generated/pollingHelper.d.ts.map +1 -0
- package/dist/browser/generated/pollingHelper.js +105 -0
- package/dist/browser/generated/pollingHelper.js.map +1 -0
- package/dist/browser/generated/responses.d.ts +1409 -0
- package/dist/browser/generated/responses.d.ts.map +1 -0
- package/dist/browser/generated/responses.js +4 -0
- package/dist/browser/generated/responses.js.map +1 -0
- package/dist/browser/generated/serializeHelper.d.ts +2 -0
- package/dist/browser/generated/serializeHelper.d.ts.map +1 -0
- package/dist/browser/generated/serializeHelper.js +13 -0
- package/dist/browser/generated/serializeHelper.js.map +1 -0
- package/dist/browser/helpers.d.ts +18 -0
- package/dist/browser/helpers.d.ts.map +1 -0
- package/{dist-esm/src → dist/browser}/helpers.js +1 -1
- package/dist/browser/helpers.js.map +1 -0
- package/dist/browser/index.d.ts +5 -0
- package/dist/browser/index.d.ts.map +1 -0
- package/dist/browser/index.js +7 -0
- package/dist/browser/index.js.map +1 -0
- package/dist/browser/mapsRoute.d.ts +53 -0
- package/dist/browser/mapsRoute.d.ts.map +1 -0
- package/{dist-esm/src → dist/browser}/mapsRoute.js +5 -5
- package/dist/browser/mapsRoute.js.map +1 -0
- package/dist/browser/package.json +3 -0
- package/dist/commonjs/generated/clientDefinitions.d.ts +617 -0
- package/dist/commonjs/generated/clientDefinitions.d.ts.map +1 -0
- package/dist/commonjs/generated/clientDefinitions.js +5 -0
- package/dist/commonjs/generated/clientDefinitions.js.map +1 -0
- package/dist/commonjs/generated/index.d.ts +12 -0
- package/dist/commonjs/generated/index.d.ts.map +1 -0
- package/dist/commonjs/generated/index.js +17 -0
- package/dist/commonjs/generated/index.js.map +1 -0
- package/dist/commonjs/generated/isUnexpected.d.ts +7 -0
- package/dist/commonjs/generated/isUnexpected.d.ts.map +1 -0
- package/dist/commonjs/generated/isUnexpected.js +82 -0
- package/dist/commonjs/generated/isUnexpected.js.map +1 -0
- package/dist/commonjs/generated/logger.d.ts +2 -0
- package/dist/commonjs/generated/logger.d.ts.map +1 -0
- package/dist/commonjs/generated/logger.js +8 -0
- package/dist/commonjs/generated/logger.js.map +1 -0
- package/dist/commonjs/generated/mapsRouteClient.d.ts +15 -0
- package/dist/commonjs/generated/mapsRouteClient.d.ts.map +1 -0
- package/dist/commonjs/generated/mapsRouteClient.js +45 -0
- package/dist/commonjs/generated/mapsRouteClient.js.map +1 -0
- package/dist/commonjs/generated/models.d.ts +130 -0
- package/dist/commonjs/generated/models.d.ts.map +1 -0
- package/dist/commonjs/generated/models.js +5 -0
- package/dist/commonjs/generated/models.js.map +1 -0
- package/dist/commonjs/generated/outputModels.d.ts +286 -0
- package/dist/commonjs/generated/outputModels.d.ts.map +1 -0
- package/dist/commonjs/generated/outputModels.js +5 -0
- package/dist/commonjs/generated/outputModels.js.map +1 -0
- package/dist/commonjs/generated/parameters.d.ts +937 -0
- package/dist/commonjs/generated/parameters.d.ts.map +1 -0
- package/dist/commonjs/generated/parameters.js +5 -0
- package/dist/commonjs/generated/parameters.js.map +1 -0
- package/dist/commonjs/generated/pollingHelper.d.ts +76 -0
- package/dist/commonjs/generated/pollingHelper.d.ts.map +1 -0
- package/dist/commonjs/generated/pollingHelper.js +108 -0
- package/dist/commonjs/generated/pollingHelper.js.map +1 -0
- package/dist/commonjs/generated/responses.d.ts +1409 -0
- package/dist/commonjs/generated/responses.d.ts.map +1 -0
- package/dist/commonjs/generated/responses.js +5 -0
- package/dist/commonjs/generated/responses.js.map +1 -0
- package/dist/commonjs/generated/serializeHelper.d.ts +2 -0
- package/dist/commonjs/generated/serializeHelper.d.ts.map +1 -0
- package/dist/commonjs/generated/serializeHelper.js +16 -0
- package/dist/commonjs/generated/serializeHelper.js.map +1 -0
- package/dist/commonjs/helpers.d.ts +18 -0
- package/dist/commonjs/helpers.d.ts.map +1 -0
- package/dist/commonjs/helpers.js +47 -0
- package/dist/commonjs/helpers.js.map +1 -0
- package/dist/commonjs/index.d.ts +5 -0
- package/dist/commonjs/index.d.ts.map +1 -0
- package/dist/commonjs/index.js +10 -0
- package/dist/commonjs/index.js.map +1 -0
- package/dist/commonjs/mapsRoute.d.ts +53 -0
- package/dist/commonjs/mapsRoute.d.ts.map +1 -0
- package/dist/commonjs/mapsRoute.js +44 -0
- package/dist/commonjs/mapsRoute.js.map +1 -0
- package/dist/commonjs/package.json +3 -0
- package/dist/commonjs/tsdoc-metadata.json +11 -0
- package/dist/esm/generated/clientDefinitions.d.ts +617 -0
- package/dist/esm/generated/clientDefinitions.d.ts.map +1 -0
- package/dist/esm/generated/clientDefinitions.js +4 -0
- package/dist/esm/generated/clientDefinitions.js.map +1 -0
- package/dist/esm/generated/index.d.ts +12 -0
- package/dist/esm/generated/index.d.ts.map +1 -0
- package/dist/esm/generated/index.js +14 -0
- package/dist/esm/generated/index.js.map +1 -0
- package/dist/esm/generated/isUnexpected.d.ts +7 -0
- package/dist/esm/generated/isUnexpected.d.ts.map +1 -0
- package/dist/esm/generated/isUnexpected.js +79 -0
- package/dist/esm/generated/isUnexpected.js.map +1 -0
- package/dist/esm/generated/logger.d.ts +2 -0
- package/dist/esm/generated/logger.d.ts.map +1 -0
- package/dist/esm/generated/logger.js +5 -0
- package/dist/esm/generated/logger.js.map +1 -0
- package/dist/esm/generated/mapsRouteClient.d.ts +15 -0
- package/dist/esm/generated/mapsRouteClient.d.ts.map +1 -0
- package/dist/esm/generated/mapsRouteClient.js +42 -0
- package/dist/esm/generated/mapsRouteClient.js.map +1 -0
- package/dist/esm/generated/models.d.ts +130 -0
- package/dist/esm/generated/models.d.ts.map +1 -0
- package/dist/esm/generated/models.js +4 -0
- package/dist/esm/generated/models.js.map +1 -0
- package/dist/esm/generated/outputModels.d.ts +286 -0
- package/dist/esm/generated/outputModels.d.ts.map +1 -0
- package/dist/esm/generated/outputModels.js +4 -0
- package/dist/esm/generated/outputModels.js.map +1 -0
- package/dist/esm/generated/parameters.d.ts +937 -0
- package/dist/esm/generated/parameters.d.ts.map +1 -0
- package/dist/esm/generated/parameters.js +4 -0
- package/dist/esm/generated/parameters.js.map +1 -0
- package/dist/esm/generated/pollingHelper.d.ts +76 -0
- package/dist/esm/generated/pollingHelper.d.ts.map +1 -0
- package/dist/esm/generated/pollingHelper.js +105 -0
- package/dist/esm/generated/pollingHelper.js.map +1 -0
- package/dist/esm/generated/responses.d.ts +1409 -0
- package/dist/esm/generated/responses.d.ts.map +1 -0
- package/dist/esm/generated/responses.js +4 -0
- package/dist/esm/generated/responses.js.map +1 -0
- package/dist/esm/generated/serializeHelper.d.ts +2 -0
- package/dist/esm/generated/serializeHelper.d.ts.map +1 -0
- package/dist/esm/generated/serializeHelper.js +13 -0
- package/dist/esm/generated/serializeHelper.js.map +1 -0
- package/dist/esm/helpers.d.ts +18 -0
- package/dist/esm/helpers.d.ts.map +1 -0
- package/dist/esm/helpers.js +43 -0
- package/dist/esm/helpers.js.map +1 -0
- package/dist/esm/index.d.ts +5 -0
- package/dist/esm/index.d.ts.map +1 -0
- package/dist/esm/index.js +7 -0
- package/dist/esm/index.js.map +1 -0
- package/dist/esm/mapsRoute.d.ts +53 -0
- package/dist/esm/mapsRoute.d.ts.map +1 -0
- package/dist/esm/mapsRoute.js +40 -0
- package/dist/esm/mapsRoute.js.map +1 -0
- package/dist/esm/package.json +3 -0
- package/dist/react-native/generated/clientDefinitions.d.ts +617 -0
- package/dist/react-native/generated/clientDefinitions.d.ts.map +1 -0
- package/dist/react-native/generated/clientDefinitions.js +4 -0
- package/dist/react-native/generated/clientDefinitions.js.map +1 -0
- package/dist/react-native/generated/index.d.ts +12 -0
- package/dist/react-native/generated/index.d.ts.map +1 -0
- package/dist/react-native/generated/index.js +14 -0
- package/dist/react-native/generated/index.js.map +1 -0
- package/dist/react-native/generated/isUnexpected.d.ts +7 -0
- package/dist/react-native/generated/isUnexpected.d.ts.map +1 -0
- package/dist/react-native/generated/isUnexpected.js +79 -0
- package/dist/react-native/generated/isUnexpected.js.map +1 -0
- package/dist/react-native/generated/logger.d.ts +2 -0
- package/dist/react-native/generated/logger.d.ts.map +1 -0
- package/dist/react-native/generated/logger.js +5 -0
- package/dist/react-native/generated/logger.js.map +1 -0
- package/dist/react-native/generated/mapsRouteClient.d.ts +15 -0
- package/dist/react-native/generated/mapsRouteClient.d.ts.map +1 -0
- package/dist/react-native/generated/mapsRouteClient.js +42 -0
- package/dist/react-native/generated/mapsRouteClient.js.map +1 -0
- package/dist/react-native/generated/models.d.ts +130 -0
- package/dist/react-native/generated/models.d.ts.map +1 -0
- package/dist/react-native/generated/models.js +4 -0
- package/dist/react-native/generated/models.js.map +1 -0
- package/dist/react-native/generated/outputModels.d.ts +286 -0
- package/dist/react-native/generated/outputModels.d.ts.map +1 -0
- package/dist/react-native/generated/outputModels.js +4 -0
- package/dist/react-native/generated/outputModels.js.map +1 -0
- package/dist/react-native/generated/parameters.d.ts +937 -0
- package/dist/react-native/generated/parameters.d.ts.map +1 -0
- package/dist/react-native/generated/parameters.js +4 -0
- package/dist/react-native/generated/parameters.js.map +1 -0
- package/dist/react-native/generated/pollingHelper.d.ts +76 -0
- package/dist/react-native/generated/pollingHelper.d.ts.map +1 -0
- package/dist/react-native/generated/pollingHelper.js +105 -0
- package/dist/react-native/generated/pollingHelper.js.map +1 -0
- package/dist/react-native/generated/responses.d.ts +1409 -0
- package/dist/react-native/generated/responses.d.ts.map +1 -0
- package/dist/react-native/generated/responses.js +4 -0
- package/dist/react-native/generated/responses.js.map +1 -0
- package/dist/react-native/generated/serializeHelper.d.ts +2 -0
- package/dist/react-native/generated/serializeHelper.d.ts.map +1 -0
- package/dist/react-native/generated/serializeHelper.js +13 -0
- package/dist/react-native/generated/serializeHelper.js.map +1 -0
- package/dist/react-native/helpers.d.ts +18 -0
- package/dist/react-native/helpers.d.ts.map +1 -0
- package/dist/react-native/helpers.js +43 -0
- package/dist/react-native/helpers.js.map +1 -0
- package/dist/react-native/index.d.ts +5 -0
- package/dist/react-native/index.d.ts.map +1 -0
- package/dist/react-native/index.js +7 -0
- package/dist/react-native/index.js.map +1 -0
- package/dist/react-native/mapsRoute.d.ts +53 -0
- package/dist/react-native/mapsRoute.d.ts.map +1 -0
- package/dist/react-native/mapsRoute.js +40 -0
- package/dist/react-native/mapsRoute.js.map +1 -0
- package/dist/react-native/package.json +3 -0
- package/package.json +80 -63
- package/dist/index.js +0 -257
- package/dist/index.js.map +0 -1
- package/dist-esm/src/generated/clientDefinitions.js +0 -4
- package/dist-esm/src/generated/clientDefinitions.js.map +0 -1
- package/dist-esm/src/generated/index.js +0 -13
- package/dist-esm/src/generated/index.js.map +0 -1
- package/dist-esm/src/generated/isUnexpected.js +0 -76
- package/dist-esm/src/generated/isUnexpected.js.map +0 -1
- package/dist-esm/src/generated/mapsRouteClient.js +0 -30
- package/dist-esm/src/generated/mapsRouteClient.js.map +0 -1
- package/dist-esm/src/generated/models.js +0 -4
- package/dist-esm/src/generated/models.js.map +0 -1
- package/dist-esm/src/generated/outputModels.js +0 -4
- package/dist-esm/src/generated/outputModels.js.map +0 -1
- package/dist-esm/src/generated/parameters.js +0 -4
- package/dist-esm/src/generated/parameters.js.map +0 -1
- package/dist-esm/src/generated/pollingHelper.js +0 -55
- package/dist-esm/src/generated/pollingHelper.js.map +0 -1
- package/dist-esm/src/generated/responses.js +0 -4
- package/dist-esm/src/generated/responses.js.map +0 -1
- package/dist-esm/src/helpers.js.map +0 -1
- package/dist-esm/src/index.js +0 -7
- package/dist-esm/src/index.js.map +0 -1
- package/dist-esm/src/mapsRoute.js.map +0 -1
- package/review/maps-route.api.md +0 -911
- package/types/maps-route-rest.d.ts +0 -3431
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"responses.js","sourceRoot":"","sources":["../../../src/generated/responses.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { RawHttpHeaders } from \"@azure/core-rest-pipeline\";\nimport { HttpResponse } from \"@azure-rest/core-client\";\nimport {\n RouteMatrixResultOutput,\n ErrorResponseOutput,\n RouteDirectionsOutput,\n RouteRangeResultOutput,\n RouteDirectionsBatchResultOutput\n} from \"./outputModels\";\n\n/**\n *\n * **Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n *\n * The Matrix Routing service allows calculation of a matrix of route summaries for a set of routes defined by origin and destination locations by using an asynchronous (async) or synchronous (sync) POST request. 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.\n *\n *\n * 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.\n *\n *\n * 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).\n *\n *\n *\n * ### Submit Synchronous Route Matrix Request\n * 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).\n *\n * ```\n * POST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}\n * ```\n *\n * ### Submit Asynchronous Route Matrix Request\n * 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.\n *\n *\n * 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).\n *\n *\n * The asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n *\n *\n *\n *\n * ```\n * POST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}\n * ```\n *\n * Here's a typical sequence of asynchronous operations:\n * 1. Client sends a Route Matrix POST request to Azure Maps\n *\n * 2. The server will respond with one of the following:\n *\n * > HTTP `202 Accepted` - Route Matrix request has been accepted.\n *\n * > 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.\n *\n *\n * 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:\n *\n * ```\n * GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n * ```\n *\n *\n * 4. Client issues a GET request on the download URL obtained in Step 3 to download the results\n *\n * ### Download Sync Results\n * 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.\n *\n * ### Download Async Results\n * 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:\n * ```\n * GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n * ```\n *\n * The URL provided by the location header will return the following responses when a `GET` request is issued.\n *\n * > HTTP `202 Accepted` - Matrix request was accepted but is still being processed. Please try again in some time.\n *\n * > HTTP `200 OK` - Matrix request successfully processed. The response body contains all of the results.\n */\nexport interface RouteRequestRouteMatrix200Response extends HttpResponse {\n status: \"200\";\n body: RouteMatrixResultOutput;\n}\n\nexport interface RouteRequestRouteMatrix202Headers {\n /** New URL to check for the results of the long running process. */\n location?: string;\n}\n\n/**\n *\n * **Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n *\n * The Matrix Routing service allows calculation of a matrix of route summaries for a set of routes defined by origin and destination locations by using an asynchronous (async) or synchronous (sync) POST request. 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.\n *\n *\n * 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.\n *\n *\n * 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).\n *\n *\n *\n * ### Submit Synchronous Route Matrix Request\n * 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).\n *\n * ```\n * POST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}\n * ```\n *\n * ### Submit Asynchronous Route Matrix Request\n * 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.\n *\n *\n * 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).\n *\n *\n * The asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n *\n *\n *\n *\n * ```\n * POST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}\n * ```\n *\n * Here's a typical sequence of asynchronous operations:\n * 1. Client sends a Route Matrix POST request to Azure Maps\n *\n * 2. The server will respond with one of the following:\n *\n * > HTTP `202 Accepted` - Route Matrix request has been accepted.\n *\n * > 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.\n *\n *\n * 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:\n *\n * ```\n * GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n * ```\n *\n *\n * 4. Client issues a GET request on the download URL obtained in Step 3 to download the results\n *\n * ### Download Sync Results\n * 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.\n *\n * ### Download Async Results\n * 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:\n * ```\n * GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n * ```\n *\n * The URL provided by the location header will return the following responses when a `GET` request is issued.\n *\n * > HTTP `202 Accepted` - Matrix request was accepted but is still being processed. Please try again in some time.\n *\n * > HTTP `200 OK` - Matrix request successfully processed. The response body contains all of the results.\n */\nexport interface RouteRequestRouteMatrix202Response extends HttpResponse {\n status: \"202\";\n body: Record<string, unknown>;\n headers: RawHttpHeaders & RouteRequestRouteMatrix202Headers;\n}\n\n/**\n * **Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n *\n * 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:\n *\n * ```\n * GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n * ```\n *\n *\n * 4. Client issues a GET request on the download URL obtained in Step 3 to download the results\n *\n * ### Download Sync Results\n * 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.\n *\n * ### Download Async Results\n * 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:\n * ```\n * GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n * ```\n *\n * The URL provided by the location header will return the following responses when a `GET` request is issued.\n *\n * > HTTP `202 Accepted` - Matrix request was accepted but is still being processed. Please try again in some time.\n *\n * > HTTP `200 OK` - Matrix request successfully processed. The response body contains all of the results.\n */\nexport interface RouteGetRouteMatrix200Response extends HttpResponse {\n status: \"200\";\n body: RouteMatrixResultOutput;\n}\n\nexport interface RouteGetRouteMatrix202Headers {\n /** New URL to check for the results of the long running process. */\n location?: string;\n}\n\n/**\n * **Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n *\n * 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:\n *\n * ```\n * GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n * ```\n *\n *\n * 4. Client issues a GET request on the download URL obtained in Step 3 to download the results\n *\n * ### Download Sync Results\n * 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.\n *\n * ### Download Async Results\n * 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:\n * ```\n * GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n * ```\n *\n * The URL provided by the location header will return the following responses when a `GET` request is issued.\n *\n * > HTTP `202 Accepted` - Matrix request was accepted but is still being processed. Please try again in some time.\n *\n * > HTTP `200 OK` - Matrix request successfully processed. The response body contains all of the results.\n */\nexport interface RouteGetRouteMatrix202Response extends HttpResponse {\n status: \"202\";\n body: Record<string, unknown>;\n headers: RawHttpHeaders & RouteGetRouteMatrix202Headers;\n}\n\n/**\n *\n * **Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n *\n * The Matrix Routing service allows calculation of a matrix of route summaries for a set of routes defined by origin and destination locations by using an asynchronous (async) or synchronous (sync) POST request. 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.\n *\n *\n * 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.\n *\n *\n * 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).\n *\n *\n *\n * ### Submit Synchronous Route Matrix Request\n * 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).\n *\n * ```\n * POST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}\n * ```\n *\n * ### Submit Asynchronous Route Matrix Request\n * 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.\n *\n *\n * 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).\n *\n *\n * The asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n *\n *\n *\n *\n * ```\n * POST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}\n * ```\n *\n * Here's a typical sequence of asynchronous operations:\n * 1. Client sends a Route Matrix POST request to Azure Maps\n *\n * 2. The server will respond with one of the following:\n *\n * > HTTP `202 Accepted` - Route Matrix request has been accepted.\n *\n * > 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.\n *\n *\n * 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:\n *\n * ```\n * GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n * ```\n *\n *\n * 4. Client issues a GET request on the download URL obtained in Step 3 to download the results\n *\n * ### Download Sync Results\n * 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.\n *\n * ### Download Async Results\n * 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:\n * ```\n * GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n * ```\n *\n * The URL provided by the location header will return the following responses when a `GET` request is issued.\n *\n * > HTTP `202 Accepted` - Matrix request was accepted but is still being processed. Please try again in some time.\n *\n * > HTTP `200 OK` - Matrix request successfully processed. The response body contains all of the results.\n */\nexport interface RouteRequestRouteMatrixSync200Response extends HttpResponse {\n status: \"200\";\n body: RouteMatrixResultOutput;\n}\n\n/**\n *\n * **Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n *\n * The Matrix Routing service allows calculation of a matrix of route summaries for a set of routes defined by origin and destination locations by using an asynchronous (async) or synchronous (sync) POST request. 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.\n *\n *\n * 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.\n *\n *\n * 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).\n *\n *\n *\n * ### Submit Synchronous Route Matrix Request\n * 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).\n *\n * ```\n * POST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}\n * ```\n *\n * ### Submit Asynchronous Route Matrix Request\n * 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.\n *\n *\n * 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).\n *\n *\n * The asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n *\n *\n *\n *\n * ```\n * POST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}\n * ```\n *\n * Here's a typical sequence of asynchronous operations:\n * 1. Client sends a Route Matrix POST request to Azure Maps\n *\n * 2. The server will respond with one of the following:\n *\n * > HTTP `202 Accepted` - Route Matrix request has been accepted.\n *\n * > 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.\n *\n *\n * 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:\n *\n * ```\n * GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n * ```\n *\n *\n * 4. Client issues a GET request on the download URL obtained in Step 3 to download the results\n *\n * ### Download Sync Results\n * 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.\n *\n * ### Download Async Results\n * 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:\n * ```\n * GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n * ```\n *\n * The URL provided by the location header will return the following responses when a `GET` request is issued.\n *\n * > HTTP `202 Accepted` - Matrix request was accepted but is still being processed. Please try again in some time.\n *\n * > HTTP `200 OK` - Matrix request successfully processed. The response body contains all of the results.\n */\nexport interface RouteRequestRouteMatrixSync408Response extends HttpResponse {\n status: \"408\";\n body: ErrorResponseOutput;\n}\n\n/**\n *\n * **Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n *\n * The Matrix Routing service allows calculation of a matrix of route summaries for a set of routes defined by origin and destination locations by using an asynchronous (async) or synchronous (sync) POST request. 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.\n *\n *\n * 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.\n *\n *\n * 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).\n *\n *\n *\n * ### Submit Synchronous Route Matrix Request\n * 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).\n *\n * ```\n * POST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}\n * ```\n *\n * ### Submit Asynchronous Route Matrix Request\n * 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.\n *\n *\n * 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).\n *\n *\n * The asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n *\n *\n *\n *\n * ```\n * POST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}\n * ```\n *\n * Here's a typical sequence of asynchronous operations:\n * 1. Client sends a Route Matrix POST request to Azure Maps\n *\n * 2. The server will respond with one of the following:\n *\n * > HTTP `202 Accepted` - Route Matrix request has been accepted.\n *\n * > 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.\n *\n *\n * 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:\n *\n * ```\n * GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n * ```\n *\n *\n * 4. Client issues a GET request on the download URL obtained in Step 3 to download the results\n *\n * ### Download Sync Results\n * 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.\n *\n * ### Download Async Results\n * 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:\n * ```\n * GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n * ```\n *\n * The URL provided by the location header will return the following responses when a `GET` request is issued.\n *\n * > HTTP `202 Accepted` - Matrix request was accepted but is still being processed. Please try again in some time.\n *\n * > HTTP `200 OK` - Matrix request successfully processed. The response body contains all of the results.\n */\nexport interface RouteRequestRouteMatrixSyncDefaultResponse\n extends HttpResponse {\n status: string;\n body: ErrorResponseOutput;\n}\n\n/**\n * **Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n *\n *\n * 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.\n *\n * 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.\n *\n * Routing service provides a set of parameters for a detailed description of 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.\n */\nexport interface RouteGetRouteDirections200Response extends HttpResponse {\n status: \"200\";\n body: RouteDirectionsOutput;\n}\n\n/**\n * **Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n *\n *\n * 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.\n *\n * 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.\n *\n * Routing service provides a set of parameters for a detailed description of 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.\n */\nexport interface RouteGetRouteDirectionsDefaultResponse extends HttpResponse {\n status: string;\n body: ErrorResponseOutput;\n}\n\n/**\n * **Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n *\n *\n * 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.\n *\n * 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.\n *\n * 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.\n */\nexport interface RouteGetRouteDirectionsWithAdditionalParameters200Response\n extends HttpResponse {\n status: \"200\";\n body: RouteDirectionsOutput;\n}\n\n/**\n * **Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n *\n *\n * 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.\n *\n * 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.\n *\n * 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.\n */\nexport interface RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse\n extends HttpResponse {\n status: string;\n body: ErrorResponseOutput;\n}\n\n/**\n * __Route Range (Isochrone) API__\n *\n *\n * **Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n *\n * This service 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.\n *\n * The returned polygon can be used for further processing such as [Search Inside Geometry](https://docs.microsoft.com/rest/api/maps/search/postsearchinsidegeometry) to search for POIs within the provided Isochrone.\n */\nexport interface RouteGetRouteRange200Response extends HttpResponse {\n status: \"200\";\n body: RouteRangeResultOutput;\n}\n\n/**\n * __Route Range (Isochrone) API__\n *\n *\n * **Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n *\n * This service 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.\n *\n * The returned polygon can be used for further processing such as [Search Inside Geometry](https://docs.microsoft.com/rest/api/maps/search/postsearchinsidegeometry) to search for POIs within the provided Isochrone.\n */\nexport interface RouteGetRouteRangeDefaultResponse extends HttpResponse {\n status: string;\n body: ErrorResponseOutput;\n}\n\n/**\n * **Route Directions Batch API**\n *\n *\n * **Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n *\n *\n *\n * The Route Directions Batch API sends batches of queries to [Route Directions API](https://docs.microsoft.com/rest/api/maps/route/getroutedirections) using just a single API call. 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.\n * ### Submit Asynchronous Batch Request\n * The Asynchronous API is appropriate for processing big volumes of relatively complex route requests\n * - It allows the retrieval of results in a separate call (multiple downloads are possible).\n * - The asynchronous API is optimized for reliability and is not expected to run into a timeout.\n * - The number of batch items is limited to **700** for this API.\n *\n * 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.\n * The asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n *\n * Please note that asynchronous batch request is a long-running request. Here's a typical sequence of operations:\n * 1. Client sends a Route Directions Batch `POST` request to Azure Maps\n * 2. The server will respond with one of the following:\n *\n * > HTTP `202 Accepted` - Batch request has been accepted.\n *\n * > HTTP `Error` - There was an error processing your Batch request. This could either be a `400 Bad Request` or any other `Error` status code.\n *\n * 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.\n * This status URI looks like following:\n *\n * ``` GET https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0 ```\n * Note:- Please remember to add AUTH information (subscription-key/azure_auth - See [Security](#security)) to the _status URI_ before running it. <br>\n * 4. Client issues a `GET` request on the _download URL_ obtained in Step 3 to download the batch results.\n *\n * ### POST Body for Batch Request\n * 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:\n *\n *\n * ```json\n * {\n * \"batchItems\": [\n * { \"query\": \"?query=47.620659,-122.348934:47.610101,-122.342015&travelMode=bicycle&routeType=eco&traffic=false\" },\n * { \"query\": \"?query=40.759856,-73.985108:40.771136,-73.973506&travelMode=pedestrian&routeType=shortest\" },\n * { \"query\": \"?query=48.923159,-122.557362:32.621279,-116.840362\" }\n * ]\n * }\n * ```\n *\n * 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.\n *\n *\n * 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.\n *\n *\n * ### Download Asynchronous Batch Results\n * 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:\n *\n * ```\n * https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n * ```\n * Here's the typical sequence of operations for downloading the batch results:\n * 1. Client sends a `GET` request using the _download URL_.\n * 2. The server will respond with one of the following:\n *\n * > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time.\n *\n * > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results.\n *\n *\n *\n * ### Batch Response Model\n * 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:\n *\n * - [`RouteDirections`](https://docs.microsoft.com/rest/api/maps/route/getroutedirections#routedirections) - If the query completed successfully.\n *\n * - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n *\n *\n * Here's a sample Batch Response with 1 _successful_ and 1 _failed_ result:\n *\n *\n * ```json\n * {\n * \"summary\": {\n * \"successfulRequests\": 1,\n * \"totalRequests\": 2\n * },\n * \"batchItems\": [\n * {\n * \"statusCode\": 200,\n * \"response\": {\n * \"routes\": [\n * {\n * \"summary\": {\n * \"lengthInMeters\": 1758,\n * \"travelTimeInSeconds\": 387,\n * \"trafficDelayInSeconds\": 0,\n * \"departureTime\": \"2018-07-17T00:49:56+00:00\",\n * \"arrivalTime\": \"2018-07-17T00:56:22+00:00\"\n * },\n * \"legs\": [\n * {\n * \"summary\": {\n * \"lengthInMeters\": 1758,\n * \"travelTimeInSeconds\": 387,\n * \"trafficDelayInSeconds\": 0,\n * \"departureTime\": \"2018-07-17T00:49:56+00:00\",\n * \"arrivalTime\": \"2018-07-17T00:56:22+00:00\"\n * },\n * \"points\": [\n * {\n * \"latitude\": 47.62094,\n * \"longitude\": -122.34892\n * },\n * {\n * \"latitude\": 47.62094,\n * \"longitude\": -122.3485\n * },\n * {\n * \"latitude\": 47.62095,\n * \"longitude\": -122.3476\n * }\n * ]\n * }\n * ],\n * \"sections\": [\n * {\n * \"startPointIndex\": 0,\n * \"endPointIndex\": 40,\n * \"sectionType\": \"TRAVEL_MODE\",\n * \"travelMode\": \"bicycle\"\n * }\n * ]\n * }\n * ]\n * }\n * },\n * {\n * \"statusCode\": 400,\n * \"response\":\n * {\n * \"error\":\n * {\n * \"code\": \"400 BadRequest\",\n * \"message\": \"Bad request: one or more parameters were incorrectly specified or are mutually exclusive.\"\n * }\n * }\n * }\n * ]\n * }\n * ```\n */\nexport interface RouteRequestRouteDirectionsBatch200Response\n extends HttpResponse {\n status: \"200\";\n body: RouteDirectionsBatchResultOutput;\n}\n\nexport interface RouteRequestRouteDirectionsBatch202Headers {\n /** New URL to check for the results of the long running process. */\n location?: string;\n}\n\n/**\n * **Route Directions Batch API**\n *\n *\n * **Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n *\n *\n *\n * The Route Directions Batch API sends batches of queries to [Route Directions API](https://docs.microsoft.com/rest/api/maps/route/getroutedirections) using just a single API call. 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.\n * ### Submit Asynchronous Batch Request\n * The Asynchronous API is appropriate for processing big volumes of relatively complex route requests\n * - It allows the retrieval of results in a separate call (multiple downloads are possible).\n * - The asynchronous API is optimized for reliability and is not expected to run into a timeout.\n * - The number of batch items is limited to **700** for this API.\n *\n * 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.\n * The asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n *\n * Please note that asynchronous batch request is a long-running request. Here's a typical sequence of operations:\n * 1. Client sends a Route Directions Batch `POST` request to Azure Maps\n * 2. The server will respond with one of the following:\n *\n * > HTTP `202 Accepted` - Batch request has been accepted.\n *\n * > HTTP `Error` - There was an error processing your Batch request. This could either be a `400 Bad Request` or any other `Error` status code.\n *\n * 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.\n * This status URI looks like following:\n *\n * ``` GET https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0 ```\n * Note:- Please remember to add AUTH information (subscription-key/azure_auth - See [Security](#security)) to the _status URI_ before running it. <br>\n * 4. Client issues a `GET` request on the _download URL_ obtained in Step 3 to download the batch results.\n *\n * ### POST Body for Batch Request\n * 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:\n *\n *\n * ```json\n * {\n * \"batchItems\": [\n * { \"query\": \"?query=47.620659,-122.348934:47.610101,-122.342015&travelMode=bicycle&routeType=eco&traffic=false\" },\n * { \"query\": \"?query=40.759856,-73.985108:40.771136,-73.973506&travelMode=pedestrian&routeType=shortest\" },\n * { \"query\": \"?query=48.923159,-122.557362:32.621279,-116.840362\" }\n * ]\n * }\n * ```\n *\n * 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.\n *\n *\n * 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.\n *\n *\n * ### Download Asynchronous Batch Results\n * 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:\n *\n * ```\n * https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n * ```\n * Here's the typical sequence of operations for downloading the batch results:\n * 1. Client sends a `GET` request using the _download URL_.\n * 2. The server will respond with one of the following:\n *\n * > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time.\n *\n * > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results.\n *\n *\n *\n * ### Batch Response Model\n * 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:\n *\n * - [`RouteDirections`](https://docs.microsoft.com/rest/api/maps/route/getroutedirections#routedirections) - If the query completed successfully.\n *\n * - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n *\n *\n * Here's a sample Batch Response with 1 _successful_ and 1 _failed_ result:\n *\n *\n * ```json\n * {\n * \"summary\": {\n * \"successfulRequests\": 1,\n * \"totalRequests\": 2\n * },\n * \"batchItems\": [\n * {\n * \"statusCode\": 200,\n * \"response\": {\n * \"routes\": [\n * {\n * \"summary\": {\n * \"lengthInMeters\": 1758,\n * \"travelTimeInSeconds\": 387,\n * \"trafficDelayInSeconds\": 0,\n * \"departureTime\": \"2018-07-17T00:49:56+00:00\",\n * \"arrivalTime\": \"2018-07-17T00:56:22+00:00\"\n * },\n * \"legs\": [\n * {\n * \"summary\": {\n * \"lengthInMeters\": 1758,\n * \"travelTimeInSeconds\": 387,\n * \"trafficDelayInSeconds\": 0,\n * \"departureTime\": \"2018-07-17T00:49:56+00:00\",\n * \"arrivalTime\": \"2018-07-17T00:56:22+00:00\"\n * },\n * \"points\": [\n * {\n * \"latitude\": 47.62094,\n * \"longitude\": -122.34892\n * },\n * {\n * \"latitude\": 47.62094,\n * \"longitude\": -122.3485\n * },\n * {\n * \"latitude\": 47.62095,\n * \"longitude\": -122.3476\n * }\n * ]\n * }\n * ],\n * \"sections\": [\n * {\n * \"startPointIndex\": 0,\n * \"endPointIndex\": 40,\n * \"sectionType\": \"TRAVEL_MODE\",\n * \"travelMode\": \"bicycle\"\n * }\n * ]\n * }\n * ]\n * }\n * },\n * {\n * \"statusCode\": 400,\n * \"response\":\n * {\n * \"error\":\n * {\n * \"code\": \"400 BadRequest\",\n * \"message\": \"Bad request: one or more parameters were incorrectly specified or are mutually exclusive.\"\n * }\n * }\n * }\n * ]\n * }\n * ```\n */\nexport interface RouteRequestRouteDirectionsBatch202Response\n extends HttpResponse {\n status: \"202\";\n body: Record<string, unknown>;\n headers: RawHttpHeaders & RouteRequestRouteDirectionsBatch202Headers;\n}\n\n/**\n * **Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n *\n * ### Download Asynchronous Batch Results\n * 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:\n *\n * ```\n * https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n * ```\n * Here's the typical sequence of operations for downloading the batch results:\n * 1. Client sends a `GET` request using the _download URL_.\n * 2. The server will respond with one of the following:\n *\n * > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time.\n *\n * > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results.\n *\n *\n *\n * ### Batch Response Model\n * 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:\n *\n * - [`RouteDirections`](https://docs.microsoft.com/rest/api/maps/route/getroutedirections#routedirections) - If the query completed successfully.\n *\n * - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n *\n *\n * Here's a sample Batch Response with 1 _successful_ and 1 _failed_ result:\n *\n *\n * ```json\n * {\n * \"summary\": {\n * \"successfulRequests\": 1,\n * \"totalRequests\": 2\n * },\n * \"batchItems\": [\n * {\n * \"statusCode\": 200,\n * \"response\": {\n * \"routes\": [\n * {\n * \"summary\": {\n * \"lengthInMeters\": 1758,\n * \"travelTimeInSeconds\": 387,\n * \"trafficDelayInSeconds\": 0,\n * \"departureTime\": \"2018-07-17T00:49:56+00:00\",\n * \"arrivalTime\": \"2018-07-17T00:56:22+00:00\"\n * },\n * \"legs\": [\n * {\n * \"summary\": {\n * \"lengthInMeters\": 1758,\n * \"travelTimeInSeconds\": 387,\n * \"trafficDelayInSeconds\": 0,\n * \"departureTime\": \"2018-07-17T00:49:56+00:00\",\n * \"arrivalTime\": \"2018-07-17T00:56:22+00:00\"\n * },\n * \"points\": [\n * {\n * \"latitude\": 47.62094,\n * \"longitude\": -122.34892\n * },\n * {\n * \"latitude\": 47.62094,\n * \"longitude\": -122.3485\n * },\n * {\n * \"latitude\": 47.62095,\n * \"longitude\": -122.3476\n * }\n * ]\n * }\n * ],\n * \"sections\": [\n * {\n * \"startPointIndex\": 0,\n * \"endPointIndex\": 40,\n * \"sectionType\": \"TRAVEL_MODE\",\n * \"travelMode\": \"bicycle\"\n * }\n * ]\n * }\n * ]\n * }\n * },\n * {\n * \"statusCode\": 400,\n * \"response\":\n * {\n * \"error\":\n * {\n * \"code\": \"400 BadRequest\",\n * \"message\": \"Bad request: one or more parameters were incorrectly specified or are mutually exclusive.\"\n * }\n * }\n * }\n * ]\n * }\n * ```\n */\nexport interface RouteGetRouteDirectionsBatch200Response extends HttpResponse {\n status: \"200\";\n body: RouteDirectionsBatchResultOutput;\n}\n\nexport interface RouteGetRouteDirectionsBatch202Headers {\n /** New URL to check for the results of the long running process. */\n location?: string;\n}\n\n/**\n * **Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n *\n * ### Download Asynchronous Batch Results\n * 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:\n *\n * ```\n * https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n * ```\n * Here's the typical sequence of operations for downloading the batch results:\n * 1. Client sends a `GET` request using the _download URL_.\n * 2. The server will respond with one of the following:\n *\n * > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time.\n *\n * > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results.\n *\n *\n *\n * ### Batch Response Model\n * 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:\n *\n * - [`RouteDirections`](https://docs.microsoft.com/rest/api/maps/route/getroutedirections#routedirections) - If the query completed successfully.\n *\n * - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n *\n *\n * Here's a sample Batch Response with 1 _successful_ and 1 _failed_ result:\n *\n *\n * ```json\n * {\n * \"summary\": {\n * \"successfulRequests\": 1,\n * \"totalRequests\": 2\n * },\n * \"batchItems\": [\n * {\n * \"statusCode\": 200,\n * \"response\": {\n * \"routes\": [\n * {\n * \"summary\": {\n * \"lengthInMeters\": 1758,\n * \"travelTimeInSeconds\": 387,\n * \"trafficDelayInSeconds\": 0,\n * \"departureTime\": \"2018-07-17T00:49:56+00:00\",\n * \"arrivalTime\": \"2018-07-17T00:56:22+00:00\"\n * },\n * \"legs\": [\n * {\n * \"summary\": {\n * \"lengthInMeters\": 1758,\n * \"travelTimeInSeconds\": 387,\n * \"trafficDelayInSeconds\": 0,\n * \"departureTime\": \"2018-07-17T00:49:56+00:00\",\n * \"arrivalTime\": \"2018-07-17T00:56:22+00:00\"\n * },\n * \"points\": [\n * {\n * \"latitude\": 47.62094,\n * \"longitude\": -122.34892\n * },\n * {\n * \"latitude\": 47.62094,\n * \"longitude\": -122.3485\n * },\n * {\n * \"latitude\": 47.62095,\n * \"longitude\": -122.3476\n * }\n * ]\n * }\n * ],\n * \"sections\": [\n * {\n * \"startPointIndex\": 0,\n * \"endPointIndex\": 40,\n * \"sectionType\": \"TRAVEL_MODE\",\n * \"travelMode\": \"bicycle\"\n * }\n * ]\n * }\n * ]\n * }\n * },\n * {\n * \"statusCode\": 400,\n * \"response\":\n * {\n * \"error\":\n * {\n * \"code\": \"400 BadRequest\",\n * \"message\": \"Bad request: one or more parameters were incorrectly specified or are mutually exclusive.\"\n * }\n * }\n * }\n * ]\n * }\n * ```\n */\nexport interface RouteGetRouteDirectionsBatch202Response extends HttpResponse {\n status: \"202\";\n body: Record<string, unknown>;\n headers: RawHttpHeaders & RouteGetRouteDirectionsBatch202Headers;\n}\n\n/**\n * **Route Directions Batch API**\n *\n *\n * **Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n *\n *\n *\n * The Route Directions Batch API sends batches of queries to [Route Directions API](https://docs.microsoft.com/rest/api/maps/route/getroutedirections) using just a single API call. 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.\n * ### Submit Synchronous Batch Request\n * 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.\n * ```\n * POST https://atlas.microsoft.com/route/directions/batch/sync/json?api-version=1.0&subscription-key={subscription-key}\n * ```\n * ### Batch Response Model\n * 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:\n *\n * - [`RouteDirections`](https://docs.microsoft.com/rest/api/maps/route/getroutedirections#routedirections) - If the query completed successfully.\n *\n * - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n *\n *\n * Here's a sample Batch Response with 1 _successful_ and 1 _failed_ result:\n *\n *\n * ```json\n * {\n * \"summary\": {\n * \"successfulRequests\": 1,\n * \"totalRequests\": 2\n * },\n * \"batchItems\": [\n * {\n * \"statusCode\": 200,\n * \"response\": {\n * \"routes\": [\n * {\n * \"summary\": {\n * \"lengthInMeters\": 1758,\n * \"travelTimeInSeconds\": 387,\n * \"trafficDelayInSeconds\": 0,\n * \"departureTime\": \"2018-07-17T00:49:56+00:00\",\n * \"arrivalTime\": \"2018-07-17T00:56:22+00:00\"\n * },\n * \"legs\": [\n * {\n * \"summary\": {\n * \"lengthInMeters\": 1758,\n * \"travelTimeInSeconds\": 387,\n * \"trafficDelayInSeconds\": 0,\n * \"departureTime\": \"2018-07-17T00:49:56+00:00\",\n * \"arrivalTime\": \"2018-07-17T00:56:22+00:00\"\n * },\n * \"points\": [\n * {\n * \"latitude\": 47.62094,\n * \"longitude\": -122.34892\n * },\n * {\n * \"latitude\": 47.62094,\n * \"longitude\": -122.3485\n * },\n * {\n * \"latitude\": 47.62095,\n * \"longitude\": -122.3476\n * }\n * ]\n * }\n * ],\n * \"sections\": [\n * {\n * \"startPointIndex\": 0,\n * \"endPointIndex\": 40,\n * \"sectionType\": \"TRAVEL_MODE\",\n * \"travelMode\": \"bicycle\"\n * }\n * ]\n * }\n * ]\n * }\n * },\n * {\n * \"statusCode\": 400,\n * \"response\":\n * {\n * \"error\":\n * {\n * \"code\": \"400 BadRequest\",\n * \"message\": \"Bad request: one or more parameters were incorrectly specified or are mutually exclusive.\"\n * }\n * }\n * }\n * ]\n * }\n * ```\n */\nexport interface RouteRequestRouteDirectionsBatchSync200Response\n extends HttpResponse {\n status: \"200\";\n body: RouteDirectionsBatchResultOutput;\n}\n\n/**\n * **Route Directions Batch API**\n *\n *\n * **Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n *\n *\n *\n * The Route Directions Batch API sends batches of queries to [Route Directions API](https://docs.microsoft.com/rest/api/maps/route/getroutedirections) using just a single API call. 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.\n * ### Submit Synchronous Batch Request\n * 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.\n * ```\n * POST https://atlas.microsoft.com/route/directions/batch/sync/json?api-version=1.0&subscription-key={subscription-key}\n * ```\n * ### Batch Response Model\n * 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:\n *\n * - [`RouteDirections`](https://docs.microsoft.com/rest/api/maps/route/getroutedirections#routedirections) - If the query completed successfully.\n *\n * - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n *\n *\n * Here's a sample Batch Response with 1 _successful_ and 1 _failed_ result:\n *\n *\n * ```json\n * {\n * \"summary\": {\n * \"successfulRequests\": 1,\n * \"totalRequests\": 2\n * },\n * \"batchItems\": [\n * {\n * \"statusCode\": 200,\n * \"response\": {\n * \"routes\": [\n * {\n * \"summary\": {\n * \"lengthInMeters\": 1758,\n * \"travelTimeInSeconds\": 387,\n * \"trafficDelayInSeconds\": 0,\n * \"departureTime\": \"2018-07-17T00:49:56+00:00\",\n * \"arrivalTime\": \"2018-07-17T00:56:22+00:00\"\n * },\n * \"legs\": [\n * {\n * \"summary\": {\n * \"lengthInMeters\": 1758,\n * \"travelTimeInSeconds\": 387,\n * \"trafficDelayInSeconds\": 0,\n * \"departureTime\": \"2018-07-17T00:49:56+00:00\",\n * \"arrivalTime\": \"2018-07-17T00:56:22+00:00\"\n * },\n * \"points\": [\n * {\n * \"latitude\": 47.62094,\n * \"longitude\": -122.34892\n * },\n * {\n * \"latitude\": 47.62094,\n * \"longitude\": -122.3485\n * },\n * {\n * \"latitude\": 47.62095,\n * \"longitude\": -122.3476\n * }\n * ]\n * }\n * ],\n * \"sections\": [\n * {\n * \"startPointIndex\": 0,\n * \"endPointIndex\": 40,\n * \"sectionType\": \"TRAVEL_MODE\",\n * \"travelMode\": \"bicycle\"\n * }\n * ]\n * }\n * ]\n * }\n * },\n * {\n * \"statusCode\": 400,\n * \"response\":\n * {\n * \"error\":\n * {\n * \"code\": \"400 BadRequest\",\n * \"message\": \"Bad request: one or more parameters were incorrectly specified or are mutually exclusive.\"\n * }\n * }\n * }\n * ]\n * }\n * ```\n */\nexport interface RouteRequestRouteDirectionsBatchSync408Response\n extends HttpResponse {\n status: \"408\";\n body: ErrorResponseOutput;\n}\n\n/**\n * **Route Directions Batch API**\n *\n *\n * **Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n *\n *\n *\n * The Route Directions Batch API sends batches of queries to [Route Directions API](https://docs.microsoft.com/rest/api/maps/route/getroutedirections) using just a single API call. 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.\n * ### Submit Synchronous Batch Request\n * 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.\n * ```\n * POST https://atlas.microsoft.com/route/directions/batch/sync/json?api-version=1.0&subscription-key={subscription-key}\n * ```\n * ### Batch Response Model\n * 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:\n *\n * - [`RouteDirections`](https://docs.microsoft.com/rest/api/maps/route/getroutedirections#routedirections) - If the query completed successfully.\n *\n * - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n *\n *\n * Here's a sample Batch Response with 1 _successful_ and 1 _failed_ result:\n *\n *\n * ```json\n * {\n * \"summary\": {\n * \"successfulRequests\": 1,\n * \"totalRequests\": 2\n * },\n * \"batchItems\": [\n * {\n * \"statusCode\": 200,\n * \"response\": {\n * \"routes\": [\n * {\n * \"summary\": {\n * \"lengthInMeters\": 1758,\n * \"travelTimeInSeconds\": 387,\n * \"trafficDelayInSeconds\": 0,\n * \"departureTime\": \"2018-07-17T00:49:56+00:00\",\n * \"arrivalTime\": \"2018-07-17T00:56:22+00:00\"\n * },\n * \"legs\": [\n * {\n * \"summary\": {\n * \"lengthInMeters\": 1758,\n * \"travelTimeInSeconds\": 387,\n * \"trafficDelayInSeconds\": 0,\n * \"departureTime\": \"2018-07-17T00:49:56+00:00\",\n * \"arrivalTime\": \"2018-07-17T00:56:22+00:00\"\n * },\n * \"points\": [\n * {\n * \"latitude\": 47.62094,\n * \"longitude\": -122.34892\n * },\n * {\n * \"latitude\": 47.62094,\n * \"longitude\": -122.3485\n * },\n * {\n * \"latitude\": 47.62095,\n * \"longitude\": -122.3476\n * }\n * ]\n * }\n * ],\n * \"sections\": [\n * {\n * \"startPointIndex\": 0,\n * \"endPointIndex\": 40,\n * \"sectionType\": \"TRAVEL_MODE\",\n * \"travelMode\": \"bicycle\"\n * }\n * ]\n * }\n * ]\n * }\n * },\n * {\n * \"statusCode\": 400,\n * \"response\":\n * {\n * \"error\":\n * {\n * \"code\": \"400 BadRequest\",\n * \"message\": \"Bad request: one or more parameters were incorrectly specified or are mutually exclusive.\"\n * }\n * }\n * }\n * ]\n * }\n * ```\n */\nexport interface RouteRequestRouteDirectionsBatchSyncDefaultResponse\n extends HttpResponse {\n status: string;\n body: ErrorResponseOutput;\n}\n"]}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../../src/helpers.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAKlC,SAAS,cAAc,CAAC,WAAmB;IACzC,OAAO,GAAG,WAAW,CAAC,CAAC,CAAC,IAAI,WAAW,CAAC,CAAC,CAAC,EAAE,CAAC;AAC/C,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,4BAA4B,CAAC,WAAqB;IAChE,OAAO,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC7D,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,iCAAiC,CAC/C,oBAAmE;IAEnE,OAAO;QACL,UAAU,EAAE,oBAAoB,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;YACpD,KAAK,EACH,GAAG;gBACH,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC;qBACvB,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE;oBACd,mBAAmB;oBACnB,IAAI,OAAO,CAAC,KAAK,WAAW,IAAI,CAAC,KAAK,IAAI,EAAE;wBAC1C,OAAO,EAAE,CAAC;qBACX;oBACD,oCAAoC;oBACpC,IAAI,CAAC,CAAC,KAAK,UAAU,IAAI,CAAC,KAAK,UAAU,CAAC,IAAI,CAAC,YAAY,IAAI,EAAE;wBAC/D,OAAO,GAAG,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC;qBAClC;oBACD,OAAO,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;gBACrB,CAAC,CAAC;qBACD,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC;qBACvB,IAAI,CAAC,GAAG,CAAC;SACf,CAAC,CAAC;KACJ,CAAC;AACJ,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { LatLon } from \"@azure/maps-common\";\nimport { BatchRequest, RouteGetRouteDirectionsQueryParamProperties } from \"./generated\";\n\nfunction toLatLonString(coordinates: LatLon): string {\n return `${coordinates[0]},${coordinates[1]}`;\n}\n\n/**\n * Transform an array of [Latitude, Longtitute] to a string in the following format:\n * \"Latitude_1,Longtitute_1:Latitude_2,Longtitute_2:...\"\n *\n * @param coordinates - An array of Latitude/Longtitute pair to transform.\n * @returns The transformed string.\n */\nexport function toColonDelimitedLatLonString(coordinates: LatLon[]): string {\n return coordinates.map((c) => toLatLonString(c)).join(\":\");\n}\n\n/**\n * Create a batch request body of a bunch of route direction requests.\n *\n * @param queryParamProperties - An object of the query parameters for a route direction request\n * @returns The composed batch request.\n */\nexport function createRouteDirectionsBatchRequest(\n queryParamProperties: RouteGetRouteDirectionsQueryParamProperties[],\n): BatchRequest {\n return {\n batchItems: queryParamProperties.map((queryParam) => ({\n query:\n \"?\" +\n Object.entries(queryParam)\n .map(([k, v]) => {\n // Skip if no value\n if (typeof v === \"undefined\" || v === null) {\n return \"\";\n }\n // Check name mappings: Array values\n if ((k === \"departAt\" || k === \"arriveAt\") && v instanceof Date) {\n return `${k}=${v.toISOString()}`;\n }\n return `${k}=${v}`;\n })\n .filter((s) => s !== \"\")\n .join(\"&\"),\n })),\n };\n}\n"]}
|
package/dist-esm/src/index.js
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,SAAS,MAAM,aAAa,CAAC;AAEpC,cAAc,aAAa,CAAC;AAC5B,cAAc,WAAW,CAAC;AAE1B,eAAe,SAAS,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport MapsRoute from \"./mapsRoute\";\n\nexport * from \"./generated\";\nexport * from \"./helpers\";\n\nexport default MapsRoute;\n"]}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"mapsRoute.js","sourceRoot":"","sources":["../../src/mapsRoute.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAGlC,OAAO,EAIL,eAAe,EACf,iBAAiB,GAClB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,wBAAwB,EAAE,MAAM,oBAAoB,CAAC;AAE9D,OAAO,YAAY,MAAM,aAAa,CAAC;AACvC,OAAO,EAAE,+BAA+B,EAAE,MAAM,2BAA2B,CAAC;AA6D5E,MAAM,CAAC,OAAO,UAAU,SAAS,CAC/B,UAAqE,EACrE,oBAA4C,EAAE,EAC9C,eAA8B,EAAE;IAEhC,MAAM,OAAO,GAAG,OAAO,iBAAiB,KAAK,QAAQ,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,iBAAiB,CAAC;IAEzF;;;;OAIG;IACH,IAAI,iBAAiB,CAAC,UAAU,CAAC,EAAE;QACjC,MAAM,QAAQ,GAAG,OAAO,iBAAiB,KAAK,QAAQ,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,EAAE,CAAC;QAChF,IAAI,CAAC,QAAQ,EAAE;YACb,MAAM,KAAK,CAAC,yCAAyC,CAAC,CAAC;SACxD;QACD,MAAM,MAAM,GAAG,YAAY,CAAC,SAAgB,EAAE,OAAO,CAAC,CAAC;QACvD,MAAM,CAAC,QAAQ,CAAC,SAAS,CACvB,+BAA+B,CAAC;YAC9B,UAAU;YACV,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,IAAI,6BAA6B,WAAW;SACvE,CAAC,CACH,CAAC;QACF,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC,wBAAwB,CAAC,QAAQ,CAAC,CAAC,CAAC;QAC9D,OAAO,MAAM,CAAC;KACf;IAED,IAAI,eAAe,CAAC,UAAU,CAAC,EAAE;QAC/B,MAAM,MAAM,GAAG,YAAY,CAAC,SAAgB,EAAE,OAAO,CAAC,CAAC;QACvD,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC;YACxB,IAAI,EAAE,yBAAyB;YAC/B,KAAK,CAAC,WAAW,CAAC,OAAO,EAAE,IAAI;gBAC7B,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,WAAW,UAAU,CAAC,SAAS,EAAE,CAAC,CAAC;gBACxE,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC;YACvB,CAAC;SACF,CAAC,CAAC;QACH,OAAO,MAAM,CAAC;KACf;IAED,OAAO,YAAY,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;AAC3C,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { ClientOptions } from \"@azure-rest/core-client\";\nimport {\n AzureKeyCredential,\n AzureSASCredential,\n TokenCredential,\n isSASCredential,\n isTokenCredential,\n} from \"@azure/core-auth\";\nimport { createMapsClientIdPolicy } from \"@azure/maps-common\";\nimport { MapsRouteClient } from \"./generated\";\nimport createClient from \"./generated\";\nimport { bearerTokenAuthenticationPolicy } from \"@azure/core-rest-pipeline\";\n\n/**\n * Creates an instance of MapsRouteClient from a subscription key.\n *\n * @example\n * ```ts\n * import MapsRoute from \"@azure-rest/maps-route\";\n * import { AzureKeyCredential } from \"@azure/core-auth\";\n *\n * const credential = new AzureKeyCredential(\"<subscription-key>\");\n * const client = MapsRoute(credential);\n *```\n *\n * @param credential - An AzureKeyCredential instance used to authenticate requests to the service\n * @param options - Options used to configure the Route Client\n */\nexport default function MapsRoute(\n credential: AzureKeyCredential,\n options?: ClientOptions,\n): MapsRouteClient;\n/**\n * Creates an instance of MapsRoute from an Azure Identity `TokenCredential`.\n *\n * @example\n * ```ts\n * import MapsRoute from \"@azure-rest/maps-route\";\n * import { DefaultAzureCredential } from \"@azure/identity\";\n *\n * const credential = new DefaultAzureCredential();\n * const client = MapsRoute(credential, \"<maps-account-client-id>\");\n *```\n *\n * @param credential - An TokenCredential instance used to authenticate requests to the service\n * @param mapsAccountClientId - The Azure Maps client id of a specific map resource\n * @param options - Options used to configure the Route Client\n */\nexport default function MapsRoute(\n credential: TokenCredential,\n mapsAccountClientId: string,\n options?: ClientOptions,\n): MapsRouteClient;\n/**\n * Creates an instance of MapsRoute from an Azure Identity `AzureSASCredential`.\n *\n * @example\n * ```ts\n * import MapsRoute from \"@azure-rest/maps-route\";\n * import { AzureSASCredential } from \"@azure/core-auth\";\n *\n * const credential = new AzureSASCredential(\"<SAS Token>\");\n * const client = MapsRoute(credential);\n * ```\n *\n * @param credential - An AzureSASCredential instance used to authenticate requests to the service\n * @param options - Options used to configure the Route Client\n */\nexport default function MapsRoute(\n credential: AzureSASCredential,\n options?: ClientOptions,\n): MapsRouteClient;\nexport default function MapsRoute(\n credential: TokenCredential | AzureKeyCredential | AzureSASCredential,\n clientIdOrOptions: string | ClientOptions = {},\n maybeOptions: ClientOptions = {},\n): MapsRouteClient {\n const options = typeof clientIdOrOptions === \"string\" ? maybeOptions : clientIdOrOptions;\n\n /**\n * maps service requires a header \"ms-x-client-id\", which is different from the standard AAD.\n * So we need to do our own implementation.\n * This customized authentication is following by this guide: https://github.com/Azure/azure-sdk-for-js/blob/main/documentation/RLC-customization.md#custom-authentication\n */\n if (isTokenCredential(credential)) {\n const clientId = typeof clientIdOrOptions === \"string\" ? clientIdOrOptions : \"\";\n if (!clientId) {\n throw Error(\"Client id is needed for TokenCredential\");\n }\n const client = createClient(undefined as any, options);\n client.pipeline.addPolicy(\n bearerTokenAuthenticationPolicy({\n credential,\n scopes: `${options.baseUrl || \"https://atlas.microsoft.com\"}/.default`,\n }),\n );\n client.pipeline.addPolicy(createMapsClientIdPolicy(clientId));\n return client;\n }\n\n if (isSASCredential(credential)) {\n const client = createClient(undefined as any, options);\n client.pipeline.addPolicy({\n name: \"mapsSASCredentialPolicy\",\n async sendRequest(request, next) {\n request.headers.set(\"Authorization\", `jwt-sas ${credential.signature}`);\n return next(request);\n },\n });\n return client;\n }\n\n return createClient(credential, options);\n}\n"]}
|