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

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.
Files changed (241) hide show
  1. package/CHANGELOG.md +45 -0
  2. package/LICENSE +4 -4
  3. package/README.md +49 -35
  4. package/dist/browser/generated/clientDefinitions.d.ts +617 -0
  5. package/dist/browser/generated/clientDefinitions.d.ts.map +1 -0
  6. package/dist/browser/generated/clientDefinitions.js +4 -0
  7. package/dist/browser/generated/clientDefinitions.js.map +1 -0
  8. package/dist/browser/generated/index.d.ts +12 -0
  9. package/dist/browser/generated/index.d.ts.map +1 -0
  10. package/dist/browser/generated/index.js +14 -0
  11. package/dist/browser/generated/index.js.map +1 -0
  12. package/dist/browser/generated/isUnexpected.d.ts +7 -0
  13. package/dist/browser/generated/isUnexpected.d.ts.map +1 -0
  14. package/dist/browser/generated/isUnexpected.js +78 -0
  15. package/dist/browser/generated/isUnexpected.js.map +1 -0
  16. package/dist/browser/generated/logger.d.ts +2 -0
  17. package/dist/browser/generated/logger.d.ts.map +1 -0
  18. package/dist/browser/generated/logger.js +5 -0
  19. package/dist/browser/generated/logger.js.map +1 -0
  20. package/dist/browser/generated/mapsRouteClient.d.ts +15 -0
  21. package/dist/browser/generated/mapsRouteClient.d.ts.map +1 -0
  22. package/dist/browser/generated/mapsRouteClient.js +44 -0
  23. package/dist/browser/generated/mapsRouteClient.js.map +1 -0
  24. package/dist/browser/generated/models.d.ts +130 -0
  25. package/dist/browser/generated/models.d.ts.map +1 -0
  26. package/dist/browser/generated/models.js +4 -0
  27. package/dist/browser/generated/models.js.map +1 -0
  28. package/dist/browser/generated/outputModels.d.ts +286 -0
  29. package/dist/browser/generated/outputModels.d.ts.map +1 -0
  30. package/dist/browser/generated/outputModels.js +4 -0
  31. package/dist/browser/generated/outputModels.js.map +1 -0
  32. package/dist/browser/generated/parameters.d.ts +937 -0
  33. package/dist/browser/generated/parameters.d.ts.map +1 -0
  34. package/dist/browser/generated/parameters.js +4 -0
  35. package/dist/browser/generated/parameters.js.map +1 -0
  36. package/dist/browser/generated/pollingHelper.d.ts +76 -0
  37. package/dist/browser/generated/pollingHelper.d.ts.map +1 -0
  38. package/dist/browser/generated/pollingHelper.js +108 -0
  39. package/dist/browser/generated/pollingHelper.js.map +1 -0
  40. package/dist/browser/generated/responses.d.ts +1409 -0
  41. package/dist/browser/generated/responses.d.ts.map +1 -0
  42. package/dist/browser/generated/responses.js +4 -0
  43. package/dist/browser/generated/responses.js.map +1 -0
  44. package/dist/browser/generated/serializeHelper.d.ts +2 -0
  45. package/dist/browser/generated/serializeHelper.d.ts.map +1 -0
  46. package/dist/browser/generated/serializeHelper.js +13 -0
  47. package/dist/browser/generated/serializeHelper.js.map +1 -0
  48. package/dist/browser/helpers.d.ts +18 -0
  49. package/dist/browser/helpers.d.ts.map +1 -0
  50. package/dist/browser/helpers.js.map +1 -0
  51. package/dist/browser/index.d.ts +5 -0
  52. package/dist/browser/index.d.ts.map +1 -0
  53. package/dist/browser/index.js +7 -0
  54. package/dist/browser/index.js.map +1 -0
  55. package/dist/browser/mapsRoute.d.ts +53 -0
  56. package/dist/browser/mapsRoute.d.ts.map +1 -0
  57. package/{dist-esm/src → dist/browser}/mapsRoute.js +1 -1
  58. package/dist/browser/mapsRoute.js.map +1 -0
  59. package/dist/browser/package.json +3 -0
  60. package/dist/commonjs/generated/clientDefinitions.d.ts +617 -0
  61. package/dist/commonjs/generated/clientDefinitions.d.ts.map +1 -0
  62. package/dist/commonjs/generated/clientDefinitions.js +5 -0
  63. package/dist/commonjs/generated/clientDefinitions.js.map +1 -0
  64. package/dist/commonjs/generated/index.d.ts +12 -0
  65. package/dist/commonjs/generated/index.d.ts.map +1 -0
  66. package/dist/commonjs/generated/index.js +17 -0
  67. package/dist/commonjs/generated/index.js.map +1 -0
  68. package/dist/commonjs/generated/isUnexpected.d.ts +7 -0
  69. package/dist/commonjs/generated/isUnexpected.d.ts.map +1 -0
  70. package/dist/commonjs/generated/isUnexpected.js +81 -0
  71. package/dist/commonjs/generated/isUnexpected.js.map +1 -0
  72. package/dist/commonjs/generated/logger.d.ts +2 -0
  73. package/dist/commonjs/generated/logger.d.ts.map +1 -0
  74. package/dist/commonjs/generated/logger.js +8 -0
  75. package/dist/commonjs/generated/logger.js.map +1 -0
  76. package/dist/commonjs/generated/mapsRouteClient.d.ts +15 -0
  77. package/dist/commonjs/generated/mapsRouteClient.d.ts.map +1 -0
  78. package/dist/commonjs/generated/mapsRouteClient.js +47 -0
  79. package/dist/commonjs/generated/mapsRouteClient.js.map +1 -0
  80. package/dist/commonjs/generated/models.d.ts +130 -0
  81. package/dist/commonjs/generated/models.d.ts.map +1 -0
  82. package/dist/commonjs/generated/models.js +5 -0
  83. package/dist/commonjs/generated/models.js.map +1 -0
  84. package/dist/commonjs/generated/outputModels.d.ts +286 -0
  85. package/dist/commonjs/generated/outputModels.d.ts.map +1 -0
  86. package/dist/commonjs/generated/outputModels.js +5 -0
  87. package/dist/commonjs/generated/outputModels.js.map +1 -0
  88. package/dist/commonjs/generated/parameters.d.ts +937 -0
  89. package/dist/commonjs/generated/parameters.d.ts.map +1 -0
  90. package/dist/commonjs/generated/parameters.js +5 -0
  91. package/dist/commonjs/generated/parameters.js.map +1 -0
  92. package/dist/commonjs/generated/pollingHelper.d.ts +76 -0
  93. package/dist/commonjs/generated/pollingHelper.d.ts.map +1 -0
  94. package/dist/commonjs/generated/pollingHelper.js +111 -0
  95. package/dist/commonjs/generated/pollingHelper.js.map +1 -0
  96. package/dist/commonjs/generated/responses.d.ts +1409 -0
  97. package/dist/commonjs/generated/responses.d.ts.map +1 -0
  98. package/dist/commonjs/generated/responses.js +5 -0
  99. package/dist/commonjs/generated/responses.js.map +1 -0
  100. package/dist/commonjs/generated/serializeHelper.d.ts +2 -0
  101. package/dist/commonjs/generated/serializeHelper.d.ts.map +1 -0
  102. package/dist/commonjs/generated/serializeHelper.js +16 -0
  103. package/dist/commonjs/generated/serializeHelper.js.map +1 -0
  104. package/dist/commonjs/helpers.d.ts +18 -0
  105. package/dist/commonjs/helpers.d.ts.map +1 -0
  106. package/dist/commonjs/helpers.js +47 -0
  107. package/dist/commonjs/helpers.js.map +1 -0
  108. package/dist/commonjs/index.d.ts +5 -0
  109. package/dist/commonjs/index.d.ts.map +1 -0
  110. package/dist/commonjs/index.js +10 -0
  111. package/dist/commonjs/index.js.map +1 -0
  112. package/dist/commonjs/mapsRoute.d.ts +53 -0
  113. package/dist/commonjs/mapsRoute.d.ts.map +1 -0
  114. package/dist/commonjs/mapsRoute.js +44 -0
  115. package/dist/commonjs/mapsRoute.js.map +1 -0
  116. package/dist/commonjs/package.json +3 -0
  117. package/dist/commonjs/tsdoc-metadata.json +11 -0
  118. package/dist/esm/generated/clientDefinitions.d.ts +617 -0
  119. package/dist/esm/generated/clientDefinitions.d.ts.map +1 -0
  120. package/dist/esm/generated/clientDefinitions.js +4 -0
  121. package/dist/esm/generated/clientDefinitions.js.map +1 -0
  122. package/dist/esm/generated/index.d.ts +12 -0
  123. package/dist/esm/generated/index.d.ts.map +1 -0
  124. package/dist/esm/generated/index.js +14 -0
  125. package/dist/esm/generated/index.js.map +1 -0
  126. package/dist/esm/generated/isUnexpected.d.ts +7 -0
  127. package/dist/esm/generated/isUnexpected.d.ts.map +1 -0
  128. package/dist/esm/generated/isUnexpected.js +78 -0
  129. package/dist/esm/generated/isUnexpected.js.map +1 -0
  130. package/dist/esm/generated/logger.d.ts +2 -0
  131. package/dist/esm/generated/logger.d.ts.map +1 -0
  132. package/dist/esm/generated/logger.js +5 -0
  133. package/dist/esm/generated/logger.js.map +1 -0
  134. package/dist/esm/generated/mapsRouteClient.d.ts +15 -0
  135. package/dist/esm/generated/mapsRouteClient.d.ts.map +1 -0
  136. package/dist/esm/generated/mapsRouteClient.js +44 -0
  137. package/dist/esm/generated/mapsRouteClient.js.map +1 -0
  138. package/dist/esm/generated/models.d.ts +130 -0
  139. package/dist/esm/generated/models.d.ts.map +1 -0
  140. package/dist/esm/generated/models.js +4 -0
  141. package/dist/esm/generated/models.js.map +1 -0
  142. package/dist/esm/generated/outputModels.d.ts +286 -0
  143. package/dist/esm/generated/outputModels.d.ts.map +1 -0
  144. package/dist/esm/generated/outputModels.js +4 -0
  145. package/dist/esm/generated/outputModels.js.map +1 -0
  146. package/dist/esm/generated/parameters.d.ts +937 -0
  147. package/dist/esm/generated/parameters.d.ts.map +1 -0
  148. package/dist/esm/generated/parameters.js +4 -0
  149. package/dist/esm/generated/parameters.js.map +1 -0
  150. package/dist/esm/generated/pollingHelper.d.ts +76 -0
  151. package/dist/esm/generated/pollingHelper.d.ts.map +1 -0
  152. package/dist/esm/generated/pollingHelper.js +108 -0
  153. package/dist/esm/generated/pollingHelper.js.map +1 -0
  154. package/dist/esm/generated/responses.d.ts +1409 -0
  155. package/dist/esm/generated/responses.d.ts.map +1 -0
  156. package/dist/esm/generated/responses.js +4 -0
  157. package/dist/esm/generated/responses.js.map +1 -0
  158. package/dist/esm/generated/serializeHelper.d.ts +2 -0
  159. package/dist/esm/generated/serializeHelper.d.ts.map +1 -0
  160. package/dist/esm/generated/serializeHelper.js +13 -0
  161. package/dist/esm/generated/serializeHelper.js.map +1 -0
  162. package/dist/esm/helpers.d.ts +18 -0
  163. package/dist/esm/helpers.d.ts.map +1 -0
  164. package/dist/esm/helpers.js +43 -0
  165. package/dist/esm/helpers.js.map +1 -0
  166. package/dist/esm/index.d.ts +5 -0
  167. package/dist/esm/index.d.ts.map +1 -0
  168. package/dist/esm/index.js +7 -0
  169. package/dist/esm/index.js.map +1 -0
  170. package/dist/esm/mapsRoute.d.ts +53 -0
  171. package/dist/esm/mapsRoute.d.ts.map +1 -0
  172. package/dist/esm/mapsRoute.js +40 -0
  173. package/dist/esm/mapsRoute.js.map +1 -0
  174. package/dist/esm/package.json +3 -0
  175. package/dist/react-native/generated/clientDefinitions.d.ts +617 -0
  176. package/dist/react-native/generated/clientDefinitions.d.ts.map +1 -0
  177. package/dist/react-native/generated/clientDefinitions.js +4 -0
  178. package/dist/react-native/generated/clientDefinitions.js.map +1 -0
  179. package/dist/react-native/generated/index.d.ts +12 -0
  180. package/dist/react-native/generated/index.d.ts.map +1 -0
  181. package/dist/react-native/generated/index.js +14 -0
  182. package/dist/react-native/generated/index.js.map +1 -0
  183. package/dist/react-native/generated/isUnexpected.d.ts +7 -0
  184. package/dist/react-native/generated/isUnexpected.d.ts.map +1 -0
  185. package/dist/react-native/generated/isUnexpected.js +78 -0
  186. package/dist/react-native/generated/isUnexpected.js.map +1 -0
  187. package/dist/react-native/generated/logger.d.ts +2 -0
  188. package/dist/react-native/generated/logger.d.ts.map +1 -0
  189. package/dist/react-native/generated/logger.js +5 -0
  190. package/dist/react-native/generated/logger.js.map +1 -0
  191. package/dist/react-native/generated/mapsRouteClient.d.ts +15 -0
  192. package/dist/react-native/generated/mapsRouteClient.d.ts.map +1 -0
  193. package/dist/react-native/generated/mapsRouteClient.js +44 -0
  194. package/dist/react-native/generated/mapsRouteClient.js.map +1 -0
  195. package/dist/react-native/generated/models.d.ts +130 -0
  196. package/dist/react-native/generated/models.d.ts.map +1 -0
  197. package/dist/react-native/generated/models.js +4 -0
  198. package/dist/react-native/generated/models.js.map +1 -0
  199. package/dist/react-native/generated/outputModels.d.ts +286 -0
  200. package/dist/react-native/generated/outputModels.d.ts.map +1 -0
  201. package/dist/react-native/generated/outputModels.js +4 -0
  202. package/dist/react-native/generated/outputModels.js.map +1 -0
  203. package/dist/react-native/generated/parameters.d.ts +937 -0
  204. package/dist/react-native/generated/parameters.d.ts.map +1 -0
  205. package/dist/react-native/generated/parameters.js +4 -0
  206. package/dist/react-native/generated/parameters.js.map +1 -0
  207. package/dist/react-native/generated/pollingHelper.d.ts +76 -0
  208. package/dist/react-native/generated/pollingHelper.d.ts.map +1 -0
  209. package/dist/react-native/generated/pollingHelper.js +108 -0
  210. package/dist/react-native/generated/pollingHelper.js.map +1 -0
  211. package/dist/react-native/generated/responses.d.ts +1409 -0
  212. package/dist/react-native/generated/responses.d.ts.map +1 -0
  213. package/dist/react-native/generated/responses.js +4 -0
  214. package/dist/react-native/generated/responses.js.map +1 -0
  215. package/dist/react-native/generated/serializeHelper.d.ts +2 -0
  216. package/dist/react-native/generated/serializeHelper.d.ts.map +1 -0
  217. package/dist/react-native/generated/serializeHelper.js +13 -0
  218. package/dist/react-native/generated/serializeHelper.js.map +1 -0
  219. package/dist/react-native/helpers.d.ts +18 -0
  220. package/dist/react-native/helpers.d.ts.map +1 -0
  221. package/dist/react-native/helpers.js +43 -0
  222. package/dist/react-native/helpers.js.map +1 -0
  223. package/dist/react-native/index.d.ts +5 -0
  224. package/dist/react-native/index.d.ts.map +1 -0
  225. package/dist/react-native/index.js +7 -0
  226. package/dist/react-native/index.js.map +1 -0
  227. package/dist/react-native/mapsRoute.d.ts +53 -0
  228. package/dist/react-native/mapsRoute.d.ts.map +1 -0
  229. package/dist/react-native/mapsRoute.js +40 -0
  230. package/dist/react-native/mapsRoute.js.map +1 -0
  231. package/dist/react-native/package.json +3 -0
  232. package/package.json +84 -70
  233. package/dist/index.js +0 -340
  234. package/dist/index.js.map +0 -1
  235. package/dist-esm/src/helpers.js.map +0 -1
  236. package/dist-esm/src/index.js +0 -7
  237. package/dist-esm/src/index.js.map +0 -1
  238. package/dist-esm/src/mapsRoute.js.map +0 -1
  239. package/types/maps-route-rest.d.ts +0 -3659
  240. /package/{dist-esm/src → dist/browser}/helpers.js +0 -0
  241. /package/review/{maps-route.api.md → maps-route-node.api.md} +0 -0
@@ -1,3659 +0,0 @@
1
- import { AbortSignalLike } from '@azure/abort-controller';
2
- import type { AzureKeyCredential } from '@azure/core-auth';
3
- import type { AzureSASCredential } from '@azure/core-auth';
4
- import { CancelOnProgress } from '@azure/core-lro';
5
- import { Client } from '@azure-rest/core-client';
6
- import { ClientOptions } from '@azure-rest/core-client';
7
- import { CreateHttpPollerOptions } from '@azure/core-lro';
8
- import { HttpResponse } from '@azure-rest/core-client';
9
- import type { LatLon } from '@azure/maps-common';
10
- import { OperationState } from '@azure/core-lro';
11
- import { RawHttpHeaders } from '@azure/core-rest-pipeline';
12
- import { RequestParameters } from '@azure-rest/core-client';
13
- import { StreamableMethod } from '@azure-rest/core-client';
14
- import type { TokenCredential } from '@azure/core-auth';
15
-
16
- /** This type represents the request body for the Batch service. */
17
- export declare interface BatchRequest {
18
- /** The list of queries to process. */
19
- batchItems?: Array<BatchRequestItem>;
20
- }
21
-
22
- /** Batch request object */
23
- export declare interface BatchRequestItem {
24
- /** This parameter contains a query string used to perform an unstructured geocoding operation. The query string will be passed verbatim to the search API for processing. */
25
- query?: string;
26
- }
27
-
28
- /** An item returned from Batch API. Extend with 'response' property. */
29
- export declare interface BatchResultItemOutput {
30
- /** HTTP request status code. */
31
- readonly statusCode: number;
32
- }
33
-
34
- /** This object is returned from a successful Batch service call. Extend with 'batchItems' property. */
35
- export declare interface BatchResultOutput {
36
- /** Summary of the results for the batch request */
37
- readonly summary: BatchResultSummaryOutput;
38
- }
39
-
40
- /** Summary of the results for the batch request */
41
- export declare interface BatchResultSummaryOutput {
42
- /** Number of successful requests in the batch */
43
- readonly successfulRequests: number;
44
- /** Total number of requests in the batch */
45
- readonly totalRequests: number;
46
- }
47
-
48
- export declare function buildMultiCollection(items: string[], parameterName: string): string;
49
-
50
- /**
51
- * Create a batch request body of a bunch of route direction requests.
52
- *
53
- * @param queryParamProperties - An object of the query parameters for a route direction request
54
- * @returns The composed batch request.
55
- */
56
- export declare function createRouteDirectionsBatchRequest(queryParamProperties: RouteGetRouteDirectionsQueryParamProperties[]): BatchRequest;
57
-
58
- /** Effective parameter or data used when calling this Route API. */
59
- export declare interface EffectiveSettingOutput {
60
- /** Name of the parameter used. */
61
- readonly key: string;
62
- /** Value of the parameter used. */
63
- readonly value: string;
64
- }
65
-
66
- /** The error detail. */
67
- export declare interface ErrorDetailOutput {
68
- /** The error code. */
69
- readonly code?: string;
70
- /** The error message. */
71
- readonly message?: string;
72
- }
73
-
74
- /** Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.). */
75
- export declare interface ErrorResponseOutput {
76
- /** The error object. */
77
- error?: ErrorDetailOutput;
78
- }
79
-
80
- /** A valid `GeoJSON Feature` object type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.2) for details. */
81
- export declare interface GeoJsonFeature extends GeoJsonObjectParent, GeoJsonFeatureData {
82
- type: "Feature";
83
- }
84
-
85
- /** A valid `GeoJSON FeatureCollection` object type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.3) for details. */
86
- export declare interface GeoJsonFeatureCollection extends GeoJsonObjectParent, GeoJsonFeatureCollectionData {
87
- type: "FeatureCollection";
88
- }
89
-
90
- export declare interface GeoJsonFeatureCollectionData {
91
- /** Contains a list of valid `GeoJSON Feature` objects. */
92
- features: Array<GeoJsonFeature>;
93
- }
94
-
95
- export declare interface GeoJsonFeatureData {
96
- /** A valid `GeoJSON` geometry object. The type must be one of the seven valid GeoJSON geometry types - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon and GeometryCollection. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1) for details. */
97
- geometry: GeoJsonGeometry;
98
- /** Properties can contain any additional metadata about the `Feature`. Value can be any JSON object or a JSON null value */
99
- properties?: Record<string, unknown>;
100
- /** Identifier for the feature. */
101
- id?: string;
102
- /** The type of the feature. The value depends on the data model the current feature is part of. Some data models may have an empty value. */
103
- featureType?: string;
104
- }
105
-
106
- /** A valid `GeoJSON` geometry object. The type must be one of the seven valid GeoJSON geometry types - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon and GeometryCollection. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1) for details. */
107
- export declare type GeoJsonGeometry = GeoJsonGeometryParent | GeoJsonMultiPoint | GeoJsonMultiPolygon | GeoJsonPoint | GeoJsonLineString | GeoJsonMultiLineString | GeoJsonPolygon | GeoJsonGeometryCollection;
108
-
109
- /** A valid `GeoJSON GeometryCollection` object type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1.8) for details. */
110
- export declare interface GeoJsonGeometryCollection extends GeoJsonGeometryParent, GeoJsonGeometryCollectionData {
111
- type: "GeometryCollection";
112
- }
113
-
114
- export declare interface GeoJsonGeometryCollectionData {
115
- /** Contains a list of valid `GeoJSON` geometry objects. **Note** that coordinates in GeoJSON are in x, y order (longitude, latitude). */
116
- geometries: Array<GeoJsonGeometry>;
117
- }
118
-
119
- /** A valid `GeoJSON` geometry object. The type must be one of the seven valid GeoJSON geometry types - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon and GeometryCollection. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1) for details. */
120
- export declare interface GeoJsonGeometryParent extends GeoJsonObjectParent {
121
- type: "GeoJsonGeometry" | "MultiPoint" | "MultiPolygon" | "Point" | "LineString" | "MultiLineString" | "Polygon" | "GeometryCollection";
122
- }
123
-
124
- /** A valid `GeoJSON LineString` geometry type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1.4) for details. */
125
- export declare interface GeoJsonLineString extends GeoJsonGeometryParent, GeoJsonLineStringData {
126
- type: "LineString";
127
- }
128
-
129
- export declare interface GeoJsonLineStringData {
130
- /** Coordinates for the `GeoJson LineString` geometry. */
131
- coordinates: Array<Array<number>>;
132
- }
133
-
134
- /** A valid `GeoJSON MultiLineString` geometry type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1.5) for details. */
135
- export declare interface GeoJsonMultiLineString extends GeoJsonGeometryParent, GeoJsonMultiLineStringData {
136
- type: "MultiLineString";
137
- }
138
-
139
- export declare interface GeoJsonMultiLineStringData {
140
- /** Coordinates for the `GeoJson MultiLineString` geometry. */
141
- coordinates: Array<Array<Array<number>>>;
142
- }
143
-
144
- /** A valid `GeoJSON MultiPoint` geometry type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1.3) for details. */
145
- export declare interface GeoJsonMultiPoint extends GeoJsonGeometryParent, GeoJsonMultiPointData {
146
- type: "MultiPoint";
147
- }
148
-
149
- /** Data contained by a `GeoJson MultiPoint`. */
150
- export declare interface GeoJsonMultiPointData {
151
- /** Coordinates for the `GeoJson MultiPoint` geometry. */
152
- coordinates: Array<Array<number>>;
153
- }
154
-
155
- /** A valid `GeoJSON MultiPolygon` object type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1.7) for details. */
156
- export declare interface GeoJsonMultiPolygon extends GeoJsonGeometryParent, GeoJsonMultiPolygonData {
157
- type: "MultiPolygon";
158
- }
159
-
160
- export declare interface GeoJsonMultiPolygonData {
161
- /** Contains a list of valid `GeoJSON Polygon` objects. **Note** that coordinates in GeoJSON are in x, y order (longitude, latitude). */
162
- coordinates: Array<Array<Array<Array<number>>>>;
163
- }
164
-
165
- /** A valid `GeoJSON` object. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3) for details. */
166
- export declare type GeoJsonObject = GeoJsonGeometry | GeoJsonMultiPoint | GeoJsonMultiPolygon | GeoJsonPoint | GeoJsonLineString | GeoJsonMultiLineString | GeoJsonPolygon | GeoJsonGeometryCollection | GeoJsonFeature | GeoJsonFeatureCollection;
167
-
168
- /** A valid `GeoJSON` object. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3) for details. */
169
- export declare interface GeoJsonObjectParent {
170
- type: "GeoJsonObject" | "GeoJsonGeometry" | "MultiPoint" | "MultiPolygon" | "Point" | "LineString" | "MultiLineString" | "Polygon" | "GeometryCollection" | "Feature" | "FeatureCollection";
171
- }
172
-
173
- /** A valid `GeoJSON Point` geometry type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1.2) for details. */
174
- export declare interface GeoJsonPoint extends GeoJsonGeometryParent, GeoJsonPointData {
175
- type: "Point";
176
- }
177
-
178
- /** Data contained by a `GeoJson Point`. */
179
- export declare interface GeoJsonPointData {
180
- /** A `Position` is an array of numbers with two or more elements. The first two elements are _longitude_ and _latitude_, precisely in that order. _Altitude/Elevation_ is an optional third element. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1.1) for details. */
181
- coordinates: Array<number>;
182
- }
183
-
184
- /** A valid `GeoJSON Polygon` geometry type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1.6) for details. */
185
- export declare interface GeoJsonPolygon extends GeoJsonGeometryParent, GeoJsonPolygonData {
186
- type: "Polygon";
187
- }
188
-
189
- export declare interface GeoJsonPolygonData {
190
- /** Coordinates for the `GeoJson Polygon` geometry type. */
191
- coordinates: Array<Array<Array<number>>>;
192
- }
193
-
194
- /**
195
- * Helper function that builds a Poller object to help polling a long running operation.
196
- * @param client - Client to use for sending the request to get additional pages.
197
- * @param initialResponse - The initial response.
198
- * @param options - Options to set a resume state or custom polling interval.
199
- * @returns - A poller object to poll for operation state updates and eventually get the final response.
200
- */
201
- export declare function getLongRunningPoller<TResult extends HttpResponse>(client: Client, initialResponse: TResult, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>;
202
-
203
- export declare interface GetRouteDirections {
204
- /**
205
- *
206
- * 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.
207
- *
208
- * 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.
209
- *
210
- * 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).
211
- */
212
- get(options: RouteGetRouteDirectionsParameters): StreamableMethod<RouteGetRouteDirections200Response | RouteGetRouteDirectionsDefaultResponse>;
213
- /**
214
- *
215
- * 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.
216
- *
217
- * 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.
218
- *
219
- * 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.
220
- */
221
- post(options: RouteGetRouteDirectionsWithAdditionalParametersParameters): StreamableMethod<RouteGetRouteDirectionsWithAdditionalParameters200Response | RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse>;
222
- }
223
-
224
- export declare interface GetRouteRange {
225
- /**
226
- *
227
- * 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.
228
- *
229
- * 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.
230
- */
231
- get(options: RouteGetRouteRangeParameters): StreamableMethod<RouteGetRouteRange200Response | RouteGetRouteRangeDefaultResponse>;
232
- }
233
-
234
- export declare function isUnexpected(response: RouteRequestRouteMatrixSync200Response | RouteRequestRouteMatrixSync408Response | RouteRequestRouteMatrixSyncDefaultResponse): response is RouteRequestRouteMatrixSync408Response;
235
-
236
- export declare function isUnexpected(response: RouteGetRouteDirections200Response | RouteGetRouteDirectionsDefaultResponse): response is RouteGetRouteDirectionsDefaultResponse;
237
-
238
- export declare function isUnexpected(response: RouteGetRouteDirectionsWithAdditionalParameters200Response | RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse): response is RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse;
239
-
240
- export declare function isUnexpected(response: RouteGetRouteRange200Response | RouteGetRouteRangeDefaultResponse): response is RouteGetRouteRangeDefaultResponse;
241
-
242
- export declare function isUnexpected(response: RouteRequestRouteDirectionsBatchSync200Response | RouteRequestRouteDirectionsBatchSync408Response | RouteRequestRouteDirectionsBatchSyncDefaultResponse): response is RouteRequestRouteDirectionsBatchSync408Response;
243
-
244
- /** A location represented as a latitude and longitude. */
245
- export declare interface LatLongPairOutput {
246
- /** Latitude property */
247
- latitude: number;
248
- /** Longitude property */
249
- longitude: number;
250
- }
251
-
252
- /**
253
- * Creates an instance of MapsRouteClient from a subscription key.
254
- *
255
- * @example
256
- * ```ts
257
- * import MapsRoute from "@azure-rest/maps-route";
258
- * import { AzureKeyCredential } from "@azure/core-auth";
259
- *
260
- * const credential = new AzureKeyCredential("<subscription-key>");
261
- * const client = MapsRoute(credential);
262
- *```
263
- *
264
- * @param credential - An AzureKeyCredential instance used to authenticate requests to the service
265
- * @param options - Options used to configure the Route Client
266
- */
267
- declare function MapsRoute(credential: AzureKeyCredential, options?: ClientOptions): MapsRouteClient;
268
-
269
- /**
270
- * Creates an instance of MapsRoute from an Azure Identity `TokenCredential`.
271
- *
272
- * @example
273
- * ```ts
274
- * import MapsRoute from "@azure-rest/maps-route";
275
- * import { DefaultAzureCredential } from "@azure/identity";
276
- *
277
- * const credential = new DefaultAzureCredential();
278
- * const client = MapsRoute(credential, "<maps-account-client-id>");
279
- *```
280
- *
281
- * @param credential - An TokenCredential instance used to authenticate requests to the service
282
- * @param mapsAccountClientId - The Azure Maps client id of a specific map resource
283
- * @param options - Options used to configure the Route Client
284
- */
285
- declare function MapsRoute(credential: TokenCredential, mapsAccountClientId: string, options?: ClientOptions): MapsRouteClient;
286
-
287
- /**
288
- * Creates an instance of MapsRoute from an Azure Identity `AzureSASCredential`.
289
- *
290
- * @example
291
- * ```ts
292
- * import MapsRoute from "@azure-rest/maps-route";
293
- * import { AzureSASCredential } from "@azure/core-auth";
294
- *
295
- * const credential = new AzureSASCredential("<SAS Token>");
296
- * const client = MapsRoute(credential);
297
- * ```
298
- *
299
- * @param credential - An AzureSASCredential instance used to authenticate requests to the service
300
- * @param options - Options used to configure the Route Client
301
- */
302
- declare function MapsRoute(credential: AzureSASCredential, options?: ClientOptions): MapsRouteClient;
303
- export default MapsRoute;
304
-
305
- export declare type MapsRouteClient = Client & {
306
- path: Routes;
307
- };
308
-
309
- /** The optional parameters for the client */
310
- export declare interface MapsRouteClientOptions extends ClientOptions {
311
- /** The api version option of the client */
312
- apiVersion?: string;
313
- }
314
-
315
- export declare interface RequestRouteDirectionsBatch {
316
- /**
317
- *
318
- * 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).
319
- *
320
- * ### Submit Asynchronous Batch Request
321
- * The Asynchronous API is appropriate for processing big volumes of relatively complex route requests
322
- * - It allows the retrieval of results in a separate call (multiple downloads are possible).
323
- * - The asynchronous API is optimized for reliability and is not expected to run into a timeout.
324
- * - The number of batch items is limited to **700** for this API.
325
- *
326
- * 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.
327
- * The asynchronous responses are stored for **24** hours. The redirect URL returns a 404 response if used after the expiration period.
328
- *
329
- * Please note that asynchronous batch request is a long-running operation. Here's a typical sequence of operations:
330
- * 1. Client sends a Route Directions Batch `POST` request to Azure Maps.
331
- * ```
332
- * POST https://atlas.microsoft.com/route/directions/batch/json?api-version=1.0&subscription-key={subscription-key}
333
- * ```
334
- * 2. The server will respond with one of the following:
335
- *
336
- * > HTTP `202 Accepted` - Batch request has been accepted.
337
- *
338
- * > HTTP `Error` - There was an error processing your Batch request. This could either be a `400 Bad Request` or any other `Error` status code.
339
- *
340
- * 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.
341
- * This status URI looks like following:
342
- * ```
343
- * GET https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
344
- * ```
345
- * 4. Client issues a `GET` request on the _download URL_ obtained in Step 3 to download the batch results.
346
- *
347
- * ### POST Body for Batch Request
348
- * 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:
349
- *
350
- *
351
- * ```json
352
- * {
353
- * "batchItems": [
354
- * { "query": "?query=47.620659,-122.348934:47.610101,-122.342015&travelMode=bicycle&routeType=eco&traffic=false" },
355
- * { "query": "?query=40.759856,-73.985108:40.771136,-73.973506&travelMode=pedestrian&routeType=shortest" },
356
- * { "query": "?query=48.923159,-122.557362:32.621279,-116.840362" }
357
- * ]
358
- * }
359
- * ```
360
- *
361
- * 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.
362
- *
363
- *
364
- * 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.
365
- *
366
- *
367
- * ### Download Asynchronous Batch Results
368
- * 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:
369
- *
370
- * ```
371
- * https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
372
- * ```
373
- * Here's the typical sequence of operations for downloading the batch results:
374
- * 1. Client sends a `GET` request using the _download URL_.
375
- * 2. The server will respond with one of the following:
376
- *
377
- * > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time.
378
- *
379
- * > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results.
380
- *
381
- *
382
- *
383
- * ### Batch Response Model
384
- * 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:
385
- *
386
- * - [`RouteDirections`](https://docs.microsoft.com/rest/api/maps/route/getroutedirections#routedirections) - If the query completed successfully.
387
- *
388
- * - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.
389
- *
390
- *
391
- * Here's a sample Batch Response with 1 _successful_ and 1 _failed_ result:
392
- *
393
- *
394
- * ```json
395
- * {
396
- * "summary": {
397
- * "successfulRequests": 1,
398
- * "totalRequests": 2
399
- * },
400
- * "batchItems": [
401
- * {
402
- * "statusCode": 200,
403
- * "response": {
404
- * "routes": [
405
- * {
406
- * "summary": {
407
- * "lengthInMeters": 1758,
408
- * "travelTimeInSeconds": 387,
409
- * "trafficDelayInSeconds": 0,
410
- * "departureTime": "2018-07-17T00:49:56+00:00",
411
- * "arrivalTime": "2018-07-17T00:56:22+00:00"
412
- * },
413
- * "legs": [
414
- * {
415
- * "summary": {
416
- * "lengthInMeters": 1758,
417
- * "travelTimeInSeconds": 387,
418
- * "trafficDelayInSeconds": 0,
419
- * "departureTime": "2018-07-17T00:49:56+00:00",
420
- * "arrivalTime": "2018-07-17T00:56:22+00:00"
421
- * },
422
- * "points": [
423
- * {
424
- * "latitude": 47.62094,
425
- * "longitude": -122.34892
426
- * },
427
- * {
428
- * "latitude": 47.62094,
429
- * "longitude": -122.3485
430
- * },
431
- * {
432
- * "latitude": 47.62095,
433
- * "longitude": -122.3476
434
- * }
435
- * ]
436
- * }
437
- * ],
438
- * "sections": [
439
- * {
440
- * "startPointIndex": 0,
441
- * "endPointIndex": 40,
442
- * "sectionType": "TRAVEL_MODE",
443
- * "travelMode": "bicycle"
444
- * }
445
- * ]
446
- * }
447
- * ]
448
- * }
449
- * },
450
- * {
451
- * "statusCode": 400,
452
- * "response":
453
- * {
454
- * "error":
455
- * {
456
- * "code": "400 BadRequest",
457
- * "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
458
- * }
459
- * }
460
- * }
461
- * ]
462
- * }
463
- * ```
464
- */
465
- post(options: RouteRequestRouteDirectionsBatchParameters): StreamableMethod<RouteRequestRouteDirectionsBatch200Response | RouteRequestRouteDirectionsBatch202Response>;
466
- /**
467
- *
468
- * 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.
469
- *
470
- * ### Download Asynchronous Batch Results
471
- * 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:
472
- *
473
- * ```
474
- * https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
475
- * ```
476
- * Here's the typical sequence of operations for downloading the batch results:
477
- * 1. Client sends a `GET` request using the _download URL_.
478
- * 2. The server will respond with one of the following:
479
- *
480
- * > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time.
481
- *
482
- * > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results.
483
- *
484
- *
485
- *
486
- * ### Batch Response Model
487
- * 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:
488
- *
489
- * - [`RouteDirections`](https://docs.microsoft.com/rest/api/maps/route/getroutedirections#routedirections) - If the query completed successfully.
490
- *
491
- * - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.
492
- *
493
- *
494
- * Here's a sample Batch Response with 1 _successful_ and 1 _failed_ result:
495
- *
496
- *
497
- * ```json
498
- * {
499
- * "summary": {
500
- * "successfulRequests": 1,
501
- * "totalRequests": 2
502
- * },
503
- * "batchItems": [
504
- * {
505
- * "statusCode": 200,
506
- * "response": {
507
- * "routes": [
508
- * {
509
- * "summary": {
510
- * "lengthInMeters": 1758,
511
- * "travelTimeInSeconds": 387,
512
- * "trafficDelayInSeconds": 0,
513
- * "departureTime": "2018-07-17T00:49:56+00:00",
514
- * "arrivalTime": "2018-07-17T00:56:22+00:00"
515
- * },
516
- * "legs": [
517
- * {
518
- * "summary": {
519
- * "lengthInMeters": 1758,
520
- * "travelTimeInSeconds": 387,
521
- * "trafficDelayInSeconds": 0,
522
- * "departureTime": "2018-07-17T00:49:56+00:00",
523
- * "arrivalTime": "2018-07-17T00:56:22+00:00"
524
- * },
525
- * "points": [
526
- * {
527
- * "latitude": 47.62094,
528
- * "longitude": -122.34892
529
- * },
530
- * {
531
- * "latitude": 47.62094,
532
- * "longitude": -122.3485
533
- * },
534
- * {
535
- * "latitude": 47.62095,
536
- * "longitude": -122.3476
537
- * }
538
- * ]
539
- * }
540
- * ],
541
- * "sections": [
542
- * {
543
- * "startPointIndex": 0,
544
- * "endPointIndex": 40,
545
- * "sectionType": "TRAVEL_MODE",
546
- * "travelMode": "bicycle"
547
- * }
548
- * ]
549
- * }
550
- * ]
551
- * }
552
- * },
553
- * {
554
- * "statusCode": 400,
555
- * "response":
556
- * {
557
- * "error":
558
- * {
559
- * "code": "400 BadRequest",
560
- * "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
561
- * }
562
- * }
563
- * }
564
- * ]
565
- * }
566
- * ```
567
- */
568
- get(options?: RouteGetRouteDirectionsBatchParameters): StreamableMethod<RouteGetRouteDirectionsBatch200Response | RouteGetRouteDirectionsBatch202Response>;
569
- }
570
-
571
- export declare interface RequestRouteDirectionsBatchSync {
572
- /**
573
- *
574
- * 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).
575
- * ### Submit Synchronous Batch Request
576
- * 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.
577
- * ```
578
- * POST https://atlas.microsoft.com/route/directions/batch/sync/json?api-version=1.0&subscription-key={subscription-key}
579
- * ```
580
- * ### Batch Response Model
581
- * 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:
582
- *
583
- * - [`RouteDirections`](https://docs.microsoft.com/rest/api/maps/route/getroutedirections#routedirections) - If the query completed successfully.
584
- *
585
- * - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.
586
- *
587
- *
588
- * Here's a sample Batch Response with 1 _successful_ and 1 _failed_ result:
589
- *
590
- *
591
- * ```json
592
- * {
593
- * "summary": {
594
- * "successfulRequests": 1,
595
- * "totalRequests": 2
596
- * },
597
- * "batchItems": [
598
- * {
599
- * "statusCode": 200,
600
- * "response": {
601
- * "routes": [
602
- * {
603
- * "summary": {
604
- * "lengthInMeters": 1758,
605
- * "travelTimeInSeconds": 387,
606
- * "trafficDelayInSeconds": 0,
607
- * "departureTime": "2018-07-17T00:49:56+00:00",
608
- * "arrivalTime": "2018-07-17T00:56:22+00:00"
609
- * },
610
- * "legs": [
611
- * {
612
- * "summary": {
613
- * "lengthInMeters": 1758,
614
- * "travelTimeInSeconds": 387,
615
- * "trafficDelayInSeconds": 0,
616
- * "departureTime": "2018-07-17T00:49:56+00:00",
617
- * "arrivalTime": "2018-07-17T00:56:22+00:00"
618
- * },
619
- * "points": [
620
- * {
621
- * "latitude": 47.62094,
622
- * "longitude": -122.34892
623
- * },
624
- * {
625
- * "latitude": 47.62094,
626
- * "longitude": -122.3485
627
- * },
628
- * {
629
- * "latitude": 47.62095,
630
- * "longitude": -122.3476
631
- * }
632
- * ]
633
- * }
634
- * ],
635
- * "sections": [
636
- * {
637
- * "startPointIndex": 0,
638
- * "endPointIndex": 40,
639
- * "sectionType": "TRAVEL_MODE",
640
- * "travelMode": "bicycle"
641
- * }
642
- * ]
643
- * }
644
- * ]
645
- * }
646
- * },
647
- * {
648
- * "statusCode": 400,
649
- * "response":
650
- * {
651
- * "error":
652
- * {
653
- * "code": "400 BadRequest",
654
- * "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
655
- * }
656
- * }
657
- * }
658
- * ]
659
- * }
660
- * ```
661
- */
662
- post(options: RouteRequestRouteDirectionsBatchSyncParameters): StreamableMethod<RouteRequestRouteDirectionsBatchSync200Response | RouteRequestRouteDirectionsBatchSync408Response | RouteRequestRouteDirectionsBatchSyncDefaultResponse>;
663
- }
664
-
665
- export declare interface RequestRouteMatrix {
666
- /**
667
- *
668
- * 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.
669
- *
670
- *
671
- * 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.
672
- *
673
- *
674
- * 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).
675
- *
676
- * > [!NOTE]
677
- * > 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.
678
- *
679
- *
680
- *
681
- * ### Submit Synchronous Route Matrix Request
682
- * 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).
683
- *
684
- * ```
685
- * POST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}
686
- * ```
687
- *
688
- * ### Submit Asynchronous Route Matrix Request
689
- * 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.
690
- *
691
- *
692
- * 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).
693
- *
694
- *
695
- * The asynchronous responses are stored for **24** hours. The redirect URL returns a 404 response if used after the expiration period.
696
- *
697
- *
698
- *
699
- *
700
- * ```
701
- * POST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}
702
- * ```
703
- *
704
- * Here's a typical sequence of asynchronous operations:
705
- * 1. Client sends a Route Matrix POST request to Azure Maps
706
- *
707
- * 2. The server will respond with one of the following:
708
- *
709
- * > HTTP `202 Accepted` - Route Matrix request has been accepted.
710
- *
711
- * > 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.
712
- *
713
- *
714
- * 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:
715
- *
716
- * ```
717
- * GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
718
- * ```
719
- *
720
- *
721
- * 4. Client issues a GET request on the download URL obtained in Step 3 to download the results
722
- *
723
- * ### Download Sync Results
724
- * 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.
725
- *
726
- * ### Download Async Results
727
- * 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:
728
- * ```
729
- * GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
730
- * ```
731
- *
732
- * The URL provided by the location header will return the following responses when a `GET` request is issued.
733
- *
734
- * > HTTP `202 Accepted` - Matrix request was accepted but is still being processed. Please try again in some time.
735
- *
736
- * > HTTP `200 OK` - Matrix request successfully processed. The response body contains all of the results.
737
- */
738
- post(options: RouteRequestRouteMatrixParameters): StreamableMethod<RouteRequestRouteMatrix200Response | RouteRequestRouteMatrix202Response>;
739
- /**
740
- *
741
- * 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).
742
- *
743
- * 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.
744
- *
745
- *
746
- * 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.
747
- *
748
- *
749
- * 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).
750
- *
751
- *
752
- *
753
- * ### Submit Synchronous Route Matrix Request
754
- * 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).
755
- *
756
- * ```
757
- * GET https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}
758
- * ```
759
- *
760
- * ### Submit Asynchronous Route Matrix Request
761
- * 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.
762
- *
763
- *
764
- * 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).
765
- *
766
- *
767
- * The asynchronous responses are stored for **24** hours. The redirect URL returns a 404 response if used after the expiration period.
768
- *
769
- *
770
- *
771
- *
772
- * ```
773
- * GET https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}
774
- * ```
775
- *
776
- * Here's a typical sequence of asynchronous operations:
777
- * 1. Client sends a Route Matrix GET request to Azure Maps
778
- *
779
- * 2. The server will respond with one of the following:
780
- *
781
- * > HTTP `202 Accepted` - Route Matrix request has been accepted.
782
- *
783
- * > 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.
784
- *
785
- *
786
- * 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:
787
- *
788
- * ```
789
- * GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
790
- * ```
791
- *
792
- *
793
- * 4. Client issues a GET request on the download URL obtained in Step 3 to download the results
794
- *
795
- * ### Download Sync Results
796
- * 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.
797
- *
798
- * ### Download Async Results
799
- * 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:
800
- * ```
801
- * GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
802
- * ```
803
- *
804
- * The URL provided by the location header will return the following responses when a `GET` request is issued.
805
- *
806
- * > HTTP `202 Accepted` - Matrix request was accepted but is still being processed. Please try again in some time.
807
- *
808
- * > HTTP `200 OK` - Matrix request successfully processed. The response body contains all of the results.
809
- */
810
- get(options?: RouteGetRouteMatrixParameters): StreamableMethod<RouteGetRouteMatrix200Response | RouteGetRouteMatrix202Response>;
811
- }
812
-
813
- export declare interface RequestRouteMatrixSync {
814
- /**
815
- *
816
- * 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.
817
- *
818
- *
819
- * 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.
820
- *
821
- *
822
- * 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).
823
- *
824
- *
825
- *
826
- * ### Submit Synchronous Route Matrix Request
827
- * 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).
828
- *
829
- * ```
830
- * POST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}
831
- * ```
832
- *
833
- * ### Submit Asynchronous Route Matrix Request
834
- * 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.
835
- *
836
- *
837
- * 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).
838
- *
839
- *
840
- * The asynchronous responses are stored for **24** hours. The redirect URL returns a 404 response if used after the expiration period.
841
- *
842
- *
843
- *
844
- *
845
- * ```
846
- * POST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}
847
- * ```
848
- *
849
- * Here's a typical sequence of asynchronous operations:
850
- * 1. Client sends a Route Matrix POST request to Azure Maps
851
- *
852
- * 2. The server will respond with one of the following:
853
- *
854
- * > HTTP `202 Accepted` - Route Matrix request has been accepted.
855
- *
856
- * > 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.
857
- *
858
- *
859
- * 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:
860
- *
861
- * ```
862
- * GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
863
- * ```
864
- *
865
- *
866
- * 4. Client issues a GET request on the download URL obtained in Step 3 to download the results
867
- *
868
- * ### Download Sync Results
869
- * 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.
870
- *
871
- * ### Download Async Results
872
- * 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:
873
- * ```
874
- * GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
875
- * ```
876
- *
877
- * The URL provided by the location header will return the following responses when a `GET` request is issued.
878
- *
879
- * > HTTP `202 Accepted` - Matrix request was accepted but is still being processed. Please try again in some time.
880
- *
881
- * > HTTP `200 OK` - Matrix request successfully processed. The response body contains all of the results.
882
- */
883
- post(options: RouteRequestRouteMatrixSyncParameters): StreamableMethod<RouteRequestRouteMatrixSync200Response | RouteRequestRouteMatrixSync408Response | RouteRequestRouteMatrixSyncDefaultResponse>;
884
- }
885
-
886
- /** Post body parameters for Route directions. */
887
- export declare interface RouteDirectionParameters {
888
- /**
889
- * A GeoJSON Geometry collection representing sequence of coordinates used as input for route reconstruction and for calculating zero or more alternative routes to this reference route.
890
- * - The provided sequence of supporting points is used as input for route reconstruction.
891
- * - The alternative routes are calculated between the origin and destination points specified in the base path parameter locations.
892
- * - If both _minDeviationDistance_ and _minDeviationTime_ are set to zero, then these origin and destination points are
893
- * expected to be at (or very near) the beginning and end of the reference route, respectively.
894
- * - Intermediate locations (_waypoints_) are not supported when using <_supportingPoints_>.
895
- * - The reference route may contain traffic incidents of type _ROAD_CLOSURE_, which are
896
- * ignored for the calculation of the reference route's travel time and traffic delay.
897
- */
898
- supportingPoints?: Record<string, unknown>;
899
- /** This is a list of 3-character, ISO 3166-1, alpha-3 country codes of countries/regions in which all toll roads with vignettes are to be avoided, e.g. "AUS,CHE". Toll roads with vignettes in countries/regions not in the list are unaffected. Note: It is an error to specify both **avoidVignette** and **allowVignette**. */
900
- avoidVignette?: Array<string>;
901
- /** This is a list of 3-character, ISO 3166-1, alpha-3 country codes of countries/regions in which toll roads with vignettes are allowed, e.g. "AUS,CHE". Specifying **allowVignette** with some countries/regions X is equivalent to specifying **avoidVignette** with all countries/regions but X. Specifying **allowVignette** with an empty list is the same as avoiding all toll roads with vignettes. Note: It is an error to specify both **avoidVignette** and **allowVignette**. */
902
- allowVignette?: Array<string>;
903
- /** A GeoJSON MultiPolygon representing list of areas to avoid. Only rectangle polygons are supported. The maximum size of a rectangle is about 160x160 km. Maximum number of avoided areas is **10**. It cannot cross the 180th meridian. It must be between -80 and +80 degrees of latitude. */
904
- avoidAreas?: GeoJsonMultiPolygon;
905
- }
906
-
907
- /** An item returned from Route Directions Batch service call. */
908
- export declare interface RouteDirectionsBatchItemOutput extends BatchResultItemOutput {
909
- /** The result of the query. RouteDirections if the query completed successfully, ErrorResponse otherwise. */
910
- readonly response: RouteDirectionsBatchItemResponseOutput;
911
- }
912
-
913
- /** The result of the query. RouteDirections if the query completed successfully, ErrorResponse otherwise. */
914
- export declare interface RouteDirectionsBatchItemResponseOutput extends RouteDirectionsOutput, ErrorResponseOutput {
915
- }
916
-
917
- /** This object is returned from a successful Route Directions Batch service call. */
918
- export declare interface RouteDirectionsBatchResultOutput extends BatchResultOutput {
919
- /** Array containing the batch results. */
920
- readonly batchItems: Array<RouteDirectionsBatchItemOutput>;
921
- }
922
-
923
- /** This object is returned from a successful Route Directions call */
924
- export declare interface RouteDirectionsOutput {
925
- /** Format Version property */
926
- readonly formatVersion?: string;
927
- /** Routes array */
928
- readonly routes: Array<RouteOutput>;
929
- /**
930
- * Optimized sequence of waypoints. It shows the index from the user provided waypoint sequence for the original and optimized list. For instance, a response:
931
- *
932
- * ```
933
- * <optimizedWaypoints>
934
- * <waypoint providedIndex="0" optimizedIndex="1"/>
935
- * <waypoint providedIndex="1" optimizedIndex="2"/>
936
- * <waypoint providedIndex="2" optimizedIndex="0"/>
937
- * </optimizedWaypoints>
938
- * ```
939
- *
940
- * means that the original sequence is [0, 1, 2] and optimized sequence is [1, 2, 0]. Since the index starts by 0 the original is "first, second, third" while the optimized is "second, third, first".
941
- */
942
- readonly optimizedWaypoints?: Array<RouteOptimizedWaypointOutput>;
943
- /** Reports the effective settings used in the current call. */
944
- report?: RouteReportOutput;
945
- }
946
-
947
- /**
948
- *
949
- * 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.
950
- *
951
- * 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.
952
- *
953
- * 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).
954
- */
955
- export declare interface RouteGetRouteDirections200Response extends HttpResponse {
956
- status: "200";
957
- body: RouteDirectionsOutput;
958
- }
959
-
960
- /**
961
- *
962
- * 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.
963
- *
964
- * ### Download Asynchronous Batch Results
965
- * 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:
966
- *
967
- * ```
968
- * https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
969
- * ```
970
- * Here's the typical sequence of operations for downloading the batch results:
971
- * 1. Client sends a `GET` request using the _download URL_.
972
- * 2. The server will respond with one of the following:
973
- *
974
- * > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time.
975
- *
976
- * > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results.
977
- *
978
- *
979
- *
980
- * ### Batch Response Model
981
- * 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:
982
- *
983
- * - [`RouteDirections`](https://docs.microsoft.com/rest/api/maps/route/getroutedirections#routedirections) - If the query completed successfully.
984
- *
985
- * - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.
986
- *
987
- *
988
- * Here's a sample Batch Response with 1 _successful_ and 1 _failed_ result:
989
- *
990
- *
991
- * ```json
992
- * {
993
- * "summary": {
994
- * "successfulRequests": 1,
995
- * "totalRequests": 2
996
- * },
997
- * "batchItems": [
998
- * {
999
- * "statusCode": 200,
1000
- * "response": {
1001
- * "routes": [
1002
- * {
1003
- * "summary": {
1004
- * "lengthInMeters": 1758,
1005
- * "travelTimeInSeconds": 387,
1006
- * "trafficDelayInSeconds": 0,
1007
- * "departureTime": "2018-07-17T00:49:56+00:00",
1008
- * "arrivalTime": "2018-07-17T00:56:22+00:00"
1009
- * },
1010
- * "legs": [
1011
- * {
1012
- * "summary": {
1013
- * "lengthInMeters": 1758,
1014
- * "travelTimeInSeconds": 387,
1015
- * "trafficDelayInSeconds": 0,
1016
- * "departureTime": "2018-07-17T00:49:56+00:00",
1017
- * "arrivalTime": "2018-07-17T00:56:22+00:00"
1018
- * },
1019
- * "points": [
1020
- * {
1021
- * "latitude": 47.62094,
1022
- * "longitude": -122.34892
1023
- * },
1024
- * {
1025
- * "latitude": 47.62094,
1026
- * "longitude": -122.3485
1027
- * },
1028
- * {
1029
- * "latitude": 47.62095,
1030
- * "longitude": -122.3476
1031
- * }
1032
- * ]
1033
- * }
1034
- * ],
1035
- * "sections": [
1036
- * {
1037
- * "startPointIndex": 0,
1038
- * "endPointIndex": 40,
1039
- * "sectionType": "TRAVEL_MODE",
1040
- * "travelMode": "bicycle"
1041
- * }
1042
- * ]
1043
- * }
1044
- * ]
1045
- * }
1046
- * },
1047
- * {
1048
- * "statusCode": 400,
1049
- * "response":
1050
- * {
1051
- * "error":
1052
- * {
1053
- * "code": "400 BadRequest",
1054
- * "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
1055
- * }
1056
- * }
1057
- * }
1058
- * ]
1059
- * }
1060
- * ```
1061
- */
1062
- export declare interface RouteGetRouteDirectionsBatch200Response extends HttpResponse {
1063
- status: "200";
1064
- body: RouteDirectionsBatchResultOutput;
1065
- }
1066
-
1067
- export declare interface RouteGetRouteDirectionsBatch202Headers {
1068
- /** New URL to check for the results of the long-running operation. */
1069
- location?: string;
1070
- }
1071
-
1072
- /**
1073
- *
1074
- * 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.
1075
- *
1076
- * ### Download Asynchronous Batch Results
1077
- * 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:
1078
- *
1079
- * ```
1080
- * https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
1081
- * ```
1082
- * Here's the typical sequence of operations for downloading the batch results:
1083
- * 1. Client sends a `GET` request using the _download URL_.
1084
- * 2. The server will respond with one of the following:
1085
- *
1086
- * > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time.
1087
- *
1088
- * > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results.
1089
- *
1090
- *
1091
- *
1092
- * ### Batch Response Model
1093
- * 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:
1094
- *
1095
- * - [`RouteDirections`](https://docs.microsoft.com/rest/api/maps/route/getroutedirections#routedirections) - If the query completed successfully.
1096
- *
1097
- * - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.
1098
- *
1099
- *
1100
- * Here's a sample Batch Response with 1 _successful_ and 1 _failed_ result:
1101
- *
1102
- *
1103
- * ```json
1104
- * {
1105
- * "summary": {
1106
- * "successfulRequests": 1,
1107
- * "totalRequests": 2
1108
- * },
1109
- * "batchItems": [
1110
- * {
1111
- * "statusCode": 200,
1112
- * "response": {
1113
- * "routes": [
1114
- * {
1115
- * "summary": {
1116
- * "lengthInMeters": 1758,
1117
- * "travelTimeInSeconds": 387,
1118
- * "trafficDelayInSeconds": 0,
1119
- * "departureTime": "2018-07-17T00:49:56+00:00",
1120
- * "arrivalTime": "2018-07-17T00:56:22+00:00"
1121
- * },
1122
- * "legs": [
1123
- * {
1124
- * "summary": {
1125
- * "lengthInMeters": 1758,
1126
- * "travelTimeInSeconds": 387,
1127
- * "trafficDelayInSeconds": 0,
1128
- * "departureTime": "2018-07-17T00:49:56+00:00",
1129
- * "arrivalTime": "2018-07-17T00:56:22+00:00"
1130
- * },
1131
- * "points": [
1132
- * {
1133
- * "latitude": 47.62094,
1134
- * "longitude": -122.34892
1135
- * },
1136
- * {
1137
- * "latitude": 47.62094,
1138
- * "longitude": -122.3485
1139
- * },
1140
- * {
1141
- * "latitude": 47.62095,
1142
- * "longitude": -122.3476
1143
- * }
1144
- * ]
1145
- * }
1146
- * ],
1147
- * "sections": [
1148
- * {
1149
- * "startPointIndex": 0,
1150
- * "endPointIndex": 40,
1151
- * "sectionType": "TRAVEL_MODE",
1152
- * "travelMode": "bicycle"
1153
- * }
1154
- * ]
1155
- * }
1156
- * ]
1157
- * }
1158
- * },
1159
- * {
1160
- * "statusCode": 400,
1161
- * "response":
1162
- * {
1163
- * "error":
1164
- * {
1165
- * "code": "400 BadRequest",
1166
- * "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
1167
- * }
1168
- * }
1169
- * }
1170
- * ]
1171
- * }
1172
- * ```
1173
- */
1174
- export declare interface RouteGetRouteDirectionsBatch202Response extends HttpResponse {
1175
- status: "202";
1176
- headers: RawHttpHeaders & RouteGetRouteDirectionsBatch202Headers;
1177
- }
1178
-
1179
- export declare type RouteGetRouteDirectionsBatchParameters = RequestParameters;
1180
-
1181
- /**
1182
- *
1183
- * 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.
1184
- *
1185
- * 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.
1186
- *
1187
- * 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).
1188
- */
1189
- export declare interface RouteGetRouteDirectionsDefaultResponse extends HttpResponse {
1190
- status: string;
1191
- body: ErrorResponseOutput;
1192
- }
1193
-
1194
- export declare type RouteGetRouteDirectionsParameters = RouteGetRouteDirectionsQueryParam & RequestParameters;
1195
-
1196
- export declare interface RouteGetRouteDirectionsQueryParam {
1197
- queryParameters: RouteGetRouteDirectionsQueryParamProperties;
1198
- }
1199
-
1200
- export declare interface RouteGetRouteDirectionsQueryParamProperties {
1201
- /** The Coordinates through which the route is calculated, delimited by a colon. A minimum of two coordinates is required. The first one is the origin and the last is the destination of the route. Optional coordinates in-between act as WayPoints in the route. You can pass up to 150 WayPoints. */
1202
- query: string;
1203
- /** Number of desired alternative routes to be calculated. Default: 0, minimum: 0 and maximum: 5 */
1204
- maxAlternatives?: number;
1205
- /** Controls the optimality, with respect to the given planning criteria, of the calculated alternatives compared to the reference route. */
1206
- alternativeType?: "anyRoute" | "betterRoute";
1207
- /** All alternative routes returned will follow the reference route (see section POST Requests) from the origin point of the calculateRoute request for at least this number of meters. Can only be used when reconstructing a route. The minDeviationDistance parameter cannot be used in conjunction with arriveAt */
1208
- minDeviationDistance?: number;
1209
- /**
1210
- * The date and time of arrival at the destination point formatted as a `dateTime` value as defined in [RFC 3339, section 5.6](https://www.rfc-editor.org/rfc/rfc3339#section-5.6), with an optional time zone offset. When a time zone offset is not specified it will be assumed to be that of the destination point.
1211
- *
1212
- * Examples:
1213
- * * 2023-12-19T16:39:57
1214
- * * 2023-12-19T16:39:57-08:00
1215
- *
1216
- * The `arriveAt` parameter cannot be used in conjunction with `departAt`, `minDeviationDistance` or `minDeviationTime`.
1217
- */
1218
- arriveAt?: Date | string;
1219
- /**
1220
- * The date and time of departure from the origin point formatted as a `dateTime` value as defined in [RFC 3339, section 5.6](https://www.rfc-editor.org/rfc/rfc3339#section-5.6), with an optional time zone offset. When a time zone offset is not specified, it will be assumed to be that of the origin point.
1221
- * * Default value: now
1222
- * * Other value: `dateTime`
1223
- *
1224
- * Examples:
1225
- * * 2023-12-19T16:39:57
1226
- * * 2023-12-19T16:39:57-08:00
1227
- *
1228
- * The `departAt` parameter cannot be used in conjunction with `arriveAt`.
1229
- */
1230
- departAt?: Date | string;
1231
- /**
1232
- * All alternative routes returned will follow the reference route (see section POST Requests) from the origin point of the calculateRoute request for at least this number of seconds. Can only be used when reconstructing a route. The minDeviationTime parameter cannot be used in conjunction with arriveAt. Default value is 0. Setting )minDeviationTime_ to a value greater than zero has the following consequences:
1233
- * - The origin point of the _calculateRoute_ Request must be on
1234
- * (or very near) the input reference route.
1235
- * - If this is not the case, an error is returned.
1236
- * - However, the origin point does not need to be at the beginning
1237
- * of the input reference route (it can be thought of as the current
1238
- * vehicle position on the reference route).
1239
- * - The reference route, returned as the first route in the _calculateRoute_
1240
- * Response, will start at the origin point specified in the _calculateRoute_
1241
- * Request. The initial part of the input reference route up until the origin
1242
- * point will be excluded from the Response.
1243
- * - The values of _minDeviationDistance_ and _minDeviationTime_ determine
1244
- * how far alternative routes will be guaranteed to follow the reference
1245
- * route from the origin point onwards.
1246
- * - The route must use _departAt_.
1247
- * - The _vehicleHeading_ is ignored.
1248
- */
1249
- minDeviationTime?: number;
1250
- /** If specified, guidance instructions will be returned. Note that the instructionsType parameter cannot be used in conjunction with routeRepresentation=none. */
1251
- instructionsType?: "coded" | "text" | "tagged";
1252
- /**
1253
- * The language parameter determines the language of the guidance messages. Proper nouns (the names of streets, plazas, etc.) are returned in the specified language, or if that is not available, they are returned in an available language that is close to it. Allowed values are (a subset of) the IETF language tags. The currently supported languages are listed in the [Supported languages section](https://docs.microsoft.com/azure/azure-maps/supported-languages).
1254
- *
1255
- * Default value: en-GB
1256
- */
1257
- language?: string;
1258
- /** Re-order the route waypoints using a fast heuristic algorithm to reduce the route length. Yields best results when used in conjunction with routeType _shortest_. Notice that origin and destination are excluded from the optimized waypoint indices. To include origin and destination in the response, please increase all the indices by 1 to account for the origin, and then add the destination as the final index. Possible values are true or false. True computes a better order if possible, but is not allowed to be used in conjunction with maxAlternatives value greater than 0 or in conjunction with circle waypoints. False will use the locations in the given order and not allowed to be used in conjunction with routeRepresentation _none_. */
1259
- computeBestOrder?: boolean;
1260
- /** Specifies the representation of the set of routes provided as response. */
1261
- routeRepresentation?: "polyline" | "summaryOnly" | "none";
1262
- /** Specifies whether to return additional travel times using different types of traffic information (none, historic, live) as well as the default best-estimate travel time. */
1263
- computeTravelTimeFor?: "none" | "all";
1264
- /** The directional heading of the vehicle in degrees starting at true North and continuing in clockwise direction. North is 0 degrees, east is 90 degrees, south is 180 degrees, west is 270 degrees. Possible values 0-359 */
1265
- vehicleHeading?: number;
1266
- /** Specifies which data should be reported for diagnosis purposes. The only possible value is _effectiveSettings_. Reports the effective parameters or data used when calling the API. In the case of defaulted parameters the default will be reflected where the parameter was not specified by the caller. */
1267
- report?: "effectiveSettings";
1268
- /** Specifies which of the section types is reported in the route response. <br><br>For example if sectionType = pedestrian the sections which are suited for pedestrians only are returned. Can be specified multiple times in one request, for example, '&sectionType=carTrain&sectionType=pedestrian&sectionType=motorway'. The default sectionType refers to the travelMode input. By default travelMode is set to car */
1269
- sectionType?: Array<"carTrain" | "country" | "ferry" | "motorway" | "pedestrian" | "tollRoad" | "tollVignette" | "traffic" | "travelMode" | "tunnel" | "carpool" | "urban">;
1270
- /** Weight per axle of the vehicle in kg. A value of 0 means that weight restrictions per axle are not considered. */
1271
- vehicleAxleWeight?: number;
1272
- /** Width of the vehicle in meters. A value of 0 means that width restrictions are not considered. */
1273
- vehicleWidth?: number;
1274
- /** Height of the vehicle in meters. A value of 0 means that height restrictions are not considered. */
1275
- vehicleHeight?: number;
1276
- /** Length of the vehicle in meters. A value of 0 means that length restrictions are not considered. */
1277
- vehicleLength?: number;
1278
- /**
1279
- * Maximum speed of the vehicle in km/hour. The max speed in the vehicle profile is used to check whether a vehicle is allowed on motorways.
1280
- *
1281
- * * A value of 0 means that an appropriate value for the vehicle will be determined and applied during route planning.
1282
- *
1283
- * * A non-zero value may be overridden during route planning. For example, the current traffic flow is 60 km/hour. If the vehicle maximum speed is set to 50 km/hour, the routing engine will consider 60 km/hour as this is the current situation. If the maximum speed of the vehicle is provided as 80 km/hour but the current traffic flow is 60 km/hour, then routing engine will again use 60 km/hour.
1284
- */
1285
- vehicleMaxSpeed?: number;
1286
- /**
1287
- * Weight of the vehicle in kilograms.
1288
- *
1289
- * * It is mandatory if any of the *Efficiency parameters are set.
1290
- *
1291
- * * It must be strictly positive when used in the context of the Consumption Model. Weight restrictions are considered.
1292
- *
1293
- * * If no detailed **Consumption Model** is specified and the value of **vehicleWeight** is non-zero, then weight restrictions are considered.
1294
- *
1295
- * * In all other cases, this parameter is ignored.
1296
- *
1297
- * Sensible Values : for **Combustion Model** : 1600, for **Electric Model** : 1900
1298
- */
1299
- vehicleWeight?: number;
1300
- /** Whether the vehicle is used for commercial purposes. Commercial vehicles may not be allowed to drive on some roads. */
1301
- vehicleCommercial?: boolean;
1302
- /** Level of turns for thrilling route. This parameter can only be used in conjunction with `routeType`=thrilling. */
1303
- windingness?: "low" | "normal" | "high";
1304
- /** Degree of hilliness for thrilling route. This parameter can only be used in conjunction with `routeType`=thrilling. */
1305
- hilliness?: "low" | "normal" | "high";
1306
- /** The mode of travel for the requested route. If not defined, default is 'car'. Note that the requested travelMode may not be available for the entire route. Where the requested travelMode is not available for a particular section, the travelMode element of the response for that section will be "other". Note that travel modes bus, motorcycle, taxi and van are BETA functionality. Full restriction data is not available in all areas. */
1307
- travelMode?: "car" | "truck" | "taxi" | "bus" | "van" | "motorcycle" | "bicycle" | "pedestrian";
1308
- /** Specifies something that the route calculation should try to avoid when determining the route. Can be specified multiple times in one request, for example, '&avoid=motorways&avoid=tollRoads&avoid=ferries'. In Route Range requests, the value alreadyUsedRoads must not be used. */
1309
- avoid?: Array<"tollRoads" | "motorways" | "ferries" | "unpavedRoads" | "carpools" | "alreadyUsedRoads" | "borderCrossings">;
1310
- /**
1311
- * Possible values:
1312
- * * true - Do consider all available traffic information during routing
1313
- * * false - Ignore current traffic data during routing. Note that although the current traffic data is ignored
1314
- * during routing, the effect of historic traffic on effective road speeds is still incorporated.
1315
- */
1316
- traffic?: boolean;
1317
- /** The type of route requested. */
1318
- routeType?: "fastest" | "shortest" | "eco" | "thrilling";
1319
- /** Types of cargo that may be classified as hazardous materials and restricted from some roads. Available vehicleLoadType values are US Hazmat classes 1 through 9, plus generic classifications for use in other countries/regions. Values beginning with USHazmat are for US routing while otherHazmat should be used for all other countries/regions. vehicleLoadType can be specified multiple times. This parameter is currently only considered for travelMode=truck. */
1320
- vehicleLoadType?: "USHazmatClass1" | "USHazmatClass2" | "USHazmatClass3" | "USHazmatClass4" | "USHazmatClass5" | "USHazmatClass6" | "USHazmatClass7" | "USHazmatClass8" | "USHazmatClass9" | "otherHazmatExplosive" | "otherHazmatGeneral" | "otherHazmatHarmfulToWater";
1321
- /** Engine type of the vehicle. When a detailed Consumption Model is specified, it must be consistent with the value of **vehicleEngineType**. */
1322
- vehicleEngineType?: "combustion" | "electric";
1323
- /**
1324
- *
1325
- * Specifies the speed-dependent component of consumption.
1326
- *
1327
- * Provided as an unordered list of colon-delimited speed & consumption-rate pairs. The list defines points on a consumption curve. Consumption rates for speeds not in the list are found as follows:
1328
- *
1329
- * * by linear interpolation, if the given speed lies in between two speeds in the list
1330
- *
1331
- * * by linear extrapolation otherwise, assuming a constant (ΔConsumption/ΔSpeed) determined by the nearest two points in the list
1332
- *
1333
- * The list must contain between 1 and 25 points (inclusive), and may not contain duplicate points for the same speed. If it only contains a single point, then the consumption rate of that point is used without further processing.
1334
- *
1335
- * Consumption specified for the largest speed must be greater than or equal to that of the penultimate largest speed. This ensures that extrapolation does not lead to negative consumption rates.
1336
- *
1337
- * Similarly, consumption values specified for the two smallest speeds in the list cannot lead to a negative consumption rate for any smaller speed.
1338
- *
1339
- * The valid range for the consumption values(expressed in l/100km) is between 0.01 and 100000.0.
1340
- *
1341
- * Sensible Values : 50,6.3:130,11.5
1342
- *
1343
- * **Note** : This parameter is required for **The Combustion Consumption Model**.
1344
- */
1345
- constantSpeedConsumptionInLitersPerHundredkm?: string;
1346
- /**
1347
- * Specifies the current supply of fuel in liters.
1348
- *
1349
- * Sensible Values : 55
1350
- */
1351
- currentFuelInLiters?: number;
1352
- /**
1353
- * Specifies the amount of fuel consumed for sustaining auxiliary systems of the vehicle, in liters per hour.
1354
- *
1355
- * It can be used to specify consumption due to devices and systems such as AC systems, radio, heating, etc.
1356
- *
1357
- * Sensible Values : 0.2
1358
- */
1359
- auxiliaryPowerInLitersPerHour?: number;
1360
- /**
1361
- * Specifies the amount of chemical energy stored in one liter of fuel in megajoules (MJ). It is used in conjunction with the ***Efficiency** parameters for conversions between saved or consumed energy and fuel. For example, energy density is 34.2 MJ/l for gasoline, and 35.8 MJ/l for Diesel fuel.
1362
- *
1363
- * This parameter is required if any ***Efficiency** parameter is set.
1364
- *
1365
- * Sensible Values : 34.2
1366
- */
1367
- fuelEnergyDensityInMJoulesPerLiter?: number;
1368
- /**
1369
- * Specifies the efficiency of converting chemical energy stored in fuel to kinetic energy when the vehicle accelerates _(i.e. KineticEnergyGained/ChemicalEnergyConsumed). ChemicalEnergyConsumed_ is obtained by converting consumed fuel to chemical energy using **fuelEnergyDensityInMJoulesPerLiter**.
1370
- *
1371
- * Must be paired with **decelerationEfficiency**.
1372
- *
1373
- * The range of values allowed are 0.0 to 1/**decelerationEfficiency**.
1374
- *
1375
- * Sensible Values : for **Combustion Model** : 0.33, for **Electric Model** : 0.66
1376
- */
1377
- accelerationEfficiency?: number;
1378
- /**
1379
- * Specifies the efficiency of converting kinetic energy to saved (not consumed) fuel when the vehicle decelerates _(i.e. ChemicalEnergySaved/KineticEnergyLost). ChemicalEnergySaved_ is obtained by converting saved (not consumed) fuel to energy using **fuelEnergyDensityInMJoulesPerLiter**.
1380
- *
1381
- * Must be paired with **accelerationEfficiency**.
1382
- *
1383
- * The range of values allowed are 0.0 to 1/**accelerationEfficiency**.
1384
- *
1385
- * Sensible Values : for **Combustion Model** : 0.83, for **Electric Model** : 0.91
1386
- */
1387
- decelerationEfficiency?: number;
1388
- /**
1389
- * Specifies the efficiency of converting chemical energy stored in fuel to potential energy when the vehicle gains elevation _(i.e. PotentialEnergyGained/ChemicalEnergyConsumed). ChemicalEnergyConsumed_ is obtained by converting consumed fuel to chemical energy using **fuelEnergyDensityInMJoulesPerLiter**.
1390
- *
1391
- * Must be paired with **downhillEfficiency**.
1392
- *
1393
- * The range of values allowed are 0.0 to 1/**downhillEfficiency**.
1394
- *
1395
- * Sensible Values : for **Combustion Model** : 0.27, for **Electric Model** : 0.74
1396
- */
1397
- uphillEfficiency?: number;
1398
- /**
1399
- * Specifies the efficiency of converting potential energy to saved (not consumed) fuel when the vehicle loses elevation _(i.e. ChemicalEnergySaved/PotentialEnergyLost). ChemicalEnergySaved_ is obtained by converting saved (not consumed) fuel to energy using **fuelEnergyDensityInMJoulesPerLiter**.
1400
- *
1401
- * Must be paired with **uphillEfficiency**.
1402
- *
1403
- * The range of values allowed are 0.0 to 1/**uphillEfficiency**.
1404
- *
1405
- * Sensible Values : for **Combustion Model** : 0.51, for **Electric Model** : 0.73
1406
- */
1407
- downhillEfficiency?: number;
1408
- /**
1409
- * Specifies the speed-dependent component of consumption.
1410
- *
1411
- * Provided as an unordered list of speed/consumption-rate pairs. The list defines points on a consumption curve. Consumption rates for speeds not in the list are found as follows:
1412
- *
1413
- * * by linear interpolation, if the given speed lies in between two speeds in the list
1414
- *
1415
- * * by linear extrapolation otherwise, assuming a constant (ΔConsumption/ΔSpeed) determined by the nearest two points in the list
1416
- *
1417
- * The list must contain between 1 and 25 points (inclusive), and may not contain duplicate points for the same speed. If it only contains a single point, then the consumption rate of that point is used without further processing.
1418
- *
1419
- * Consumption specified for the largest speed must be greater than or equal to that of the penultimate largest speed. This ensures that extrapolation does not lead to negative consumption rates.
1420
- *
1421
- * Similarly, consumption values specified for the two smallest speeds in the list cannot lead to a negative consumption rate for any smaller speed.
1422
- *
1423
- * The valid range for the consumption values(expressed in kWh/100km) is between 0.01 and 100000.0.
1424
- *
1425
- * Sensible Values : 50,8.2:130,21.3
1426
- *
1427
- * This parameter is required for **Electric consumption model**.
1428
- */
1429
- constantSpeedConsumptionInkWhPerHundredkm?: string;
1430
- /**
1431
- * Specifies the current electric energy supply in kilowatt hours (kWh).
1432
- *
1433
- * This parameter co-exists with **maxChargeInkWh** parameter.
1434
- *
1435
- * The range of values allowed are 0.0 to **maxChargeInkWh**.
1436
- *
1437
- * Sensible Values : 43
1438
- */
1439
- currentChargeInkWh?: number;
1440
- /**
1441
- * Specifies the maximum electric energy supply in kilowatt hours (kWh) that may be stored in the vehicle's battery.
1442
- *
1443
- * This parameter co-exists with **currentChargeInkWh** parameter.
1444
- *
1445
- * Minimum value has to be greater than or equal to **currentChargeInkWh**.
1446
- *
1447
- * Sensible Values : 85
1448
- */
1449
- maxChargeInkWh?: number;
1450
- /**
1451
- * Specifies the amount of power consumed for sustaining auxiliary systems, in kilowatts (kW).
1452
- *
1453
- * It can be used to specify consumption due to devices and systems such as AC systems, radio, heating, etc.
1454
- *
1455
- * Sensible Values : 1.7
1456
- */
1457
- auxiliaryPowerInkW?: number;
1458
- }
1459
-
1460
- /**
1461
- *
1462
- * 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.
1463
- *
1464
- * 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.
1465
- *
1466
- * 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.
1467
- */
1468
- export declare interface RouteGetRouteDirectionsWithAdditionalParameters200Response extends HttpResponse {
1469
- status: "200";
1470
- body: RouteDirectionsOutput;
1471
- }
1472
-
1473
- export declare interface RouteGetRouteDirectionsWithAdditionalParametersBodyParam {
1474
- /**
1475
- * Used for reconstructing a route and for calculating zero or more alternative routes to this reference route. The provided sequence of coordinates is used as input for route reconstruction. The alternative routes are calculated between the origin and destination points specified in the base path parameter locations. If both minDeviationDistance and minDeviationTime are set to zero, then these origin and destination points are expected to be at (or very near) the beginning and end of the reference route, respectively. Intermediate locations (waypoints) are not supported when using supportingPoints.
1476
- *
1477
- * Setting at least one of minDeviationDistance or minDeviationTime to a value greater than zero has the following consequences:
1478
- *
1479
- * * The origin point of the calculateRoute request must be on (or very near) the input reference route. If this is not the case, an error is returned. However, the origin point does not need to be at the beginning of the input reference route (it can be thought of as the current vehicle position on the reference route).
1480
- * * The reference route, returned as the first route in the calculateRoute response, will start at the origin point specified in the calculateRoute request. The initial part of the input reference route up until the origin point will be excluded from the response.
1481
- * * The values of minDeviationDistance and minDeviationTime determine how far alternative routes will be guaranteed to follow the reference route from the origin point onwards.
1482
- * * The route must use departAt.
1483
- * * The vehicleHeading is ignored.
1484
- */
1485
- body: RouteDirectionParameters;
1486
- }
1487
-
1488
- /**
1489
- *
1490
- * 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.
1491
- *
1492
- * 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.
1493
- *
1494
- * 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.
1495
- */
1496
- export declare interface RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse extends HttpResponse {
1497
- status: string;
1498
- body: ErrorResponseOutput;
1499
- }
1500
-
1501
- export declare interface RouteGetRouteDirectionsWithAdditionalParametersMediaTypesParam {
1502
- /** Request content type */
1503
- contentType?: "application/json";
1504
- }
1505
-
1506
- export declare type RouteGetRouteDirectionsWithAdditionalParametersParameters = RouteGetRouteDirectionsWithAdditionalParametersQueryParam & RouteGetRouteDirectionsWithAdditionalParametersMediaTypesParam & RouteGetRouteDirectionsWithAdditionalParametersBodyParam & RequestParameters;
1507
-
1508
- export declare interface RouteGetRouteDirectionsWithAdditionalParametersQueryParam {
1509
- queryParameters: RouteGetRouteDirectionsWithAdditionalParametersQueryParamProperties;
1510
- }
1511
-
1512
- export declare interface RouteGetRouteDirectionsWithAdditionalParametersQueryParamProperties {
1513
- /** The Coordinates through which the route is calculated, delimited by a colon. A minimum of two coordinates is required. The first one is the origin and the last is the destination of the route. Optional coordinates in-between act as WayPoints in the route. You can pass up to 150 WayPoints. */
1514
- query: string;
1515
- /** Number of desired alternative routes to be calculated. Default: 0, minimum: 0 and maximum: 5 */
1516
- maxAlternatives?: number;
1517
- /** Controls the optimality, with respect to the given planning criteria, of the calculated alternatives compared to the reference route. */
1518
- alternativeType?: "anyRoute" | "betterRoute";
1519
- /** All alternative routes returned will follow the reference route (see section POST Requests) from the origin point of the calculateRoute request for at least this number of meters. Can only be used when reconstructing a route. The minDeviationDistance parameter cannot be used in conjunction with arriveAt */
1520
- minDeviationDistance?: number;
1521
- /**
1522
- * All alternative routes returned will follow the reference route (see section POST Requests) from the origin point of the calculateRoute request for at least this number of seconds. Can only be used when reconstructing a route. The minDeviationTime parameter cannot be used in conjunction with arriveAt. Default value is 0. Setting )minDeviationTime_ to a value greater than zero has the following consequences:
1523
- * - The origin point of the _calculateRoute_ Request must be on
1524
- * (or very near) the input reference route.
1525
- * - If this is not the case, an error is returned.
1526
- * - However, the origin point does not need to be at the beginning
1527
- * of the input reference route (it can be thought of as the current
1528
- * vehicle position on the reference route).
1529
- * - The reference route, returned as the first route in the _calculateRoute_
1530
- * Response, will start at the origin point specified in the _calculateRoute_
1531
- * Request. The initial part of the input reference route up until the origin
1532
- * point will be excluded from the Response.
1533
- * - The values of _minDeviationDistance_ and _minDeviationTime_ determine
1534
- * how far alternative routes will be guaranteed to follow the reference
1535
- * route from the origin point onwards.
1536
- * - The route must use _departAt_.
1537
- * - The _vehicleHeading_ is ignored.
1538
- */
1539
- minDeviationTime?: number;
1540
- /** If specified, guidance instructions will be returned. Note that the instructionsType parameter cannot be used in conjunction with routeRepresentation=none. */
1541
- instructionsType?: "coded" | "text" | "tagged";
1542
- /** The language parameter determines the language of the guidance messages. It does not affect proper nouns (the names of streets, plazas, etc.) It has no effect when instructionsType=coded. Allowed values are (a subset of) the IETF language tags described */
1543
- language?: string;
1544
- /** Re-order the route waypoints using a fast heuristic algorithm to reduce the route length. Yields best results when used in conjunction with routeType _shortest_. Notice that origin and destination are excluded from the optimized waypoint indices. To include origin and destination in the response, please increase all the indices by 1 to account for the origin, and then add the destination as the final index. Possible values are true or false. True computes a better order if possible, but is not allowed to be used in conjunction with maxAlternatives value greater than 0 or in conjunction with circle waypoints. False will use the locations in the given order and not allowed to be used in conjunction with routeRepresentation _none_. */
1545
- computeBestOrder?: boolean;
1546
- /** Specifies the representation of the set of routes provided as response. */
1547
- routeRepresentation?: "polyline" | "summaryOnly" | "none";
1548
- /** Specifies whether to return additional travel times using different types of traffic information (none, historic, live) as well as the default best-estimate travel time. */
1549
- computeTravelTimeFor?: "none" | "all";
1550
- /** The directional heading of the vehicle in degrees starting at true North and continuing in clockwise direction. North is 0 degrees, east is 90 degrees, south is 180 degrees, west is 270 degrees. Possible values 0-359 */
1551
- vehicleHeading?: number;
1552
- /** Specifies which data should be reported for diagnosis purposes. The only possible value is _effectiveSettings_. Reports the effective parameters or data used when calling the API. In the case of defaulted parameters the default will be reflected where the parameter was not specified by the caller. */
1553
- report?: "effectiveSettings";
1554
- /** Specifies which of the section types is reported in the route response. <br><br>For example if sectionType = pedestrian the sections which are suited for pedestrians only are returned. Can be specified multiple times in one request, for example, '&sectionType=carTrain&sectionType=pedestrian&sectionType=motorway'. The default sectionType refers to the travelMode input. By default travelMode is set to car */
1555
- sectionType?: Array<"carTrain" | "country" | "ferry" | "motorway" | "pedestrian" | "tollRoad" | "tollVignette" | "traffic" | "travelMode" | "tunnel" | "carpool" | "urban">;
1556
- /**
1557
- * The date and time of arrival at the destination point formatted as a `dateTime` value as defined in [RFC 3339, section 5.6](https://www.rfc-editor.org/rfc/rfc3339#section-5.6), with an optional time zone offset. When a time zone offset is not specified it will be assumed to be that of the destination point.
1558
- *
1559
- * Examples:
1560
- * * 2023-12-19T16:39:57
1561
- * * 2023-12-19T16:39:57-08:00
1562
- *
1563
- * The `arriveAt` parameter cannot be used in conjunction with `departAt`, `minDeviationDistance` or `minDeviationTime`.
1564
- */
1565
- arriveAt?: Date | string;
1566
- /**
1567
- * The date and time of departure from the origin point formatted as a `dateTime` value as defined in [RFC 3339, section 5.6](https://www.rfc-editor.org/rfc/rfc3339#section-5.6), with an optional time zone offset. When a time zone offset is not specified, it will be assumed to be that of the origin point.
1568
- * * Default value: now
1569
- * * Other value: `dateTime`
1570
- *
1571
- * Examples:
1572
- * * 2023-12-19T16:39:57
1573
- * * 2023-12-19T16:39:57-08:00
1574
- *
1575
- * The `departAt` parameter cannot be used in conjunction with `arriveAt`.
1576
- */
1577
- departAt?: Date | string;
1578
- /** Weight per axle of the vehicle in kg. A value of 0 means that weight restrictions per axle are not considered. */
1579
- vehicleAxleWeight?: number;
1580
- /** Length of the vehicle in meters. A value of 0 means that length restrictions are not considered. */
1581
- vehicleLength?: number;
1582
- /** Height of the vehicle in meters. A value of 0 means that height restrictions are not considered. */
1583
- vehicleHeight?: number;
1584
- /** Width of the vehicle in meters. A value of 0 means that width restrictions are not considered. */
1585
- vehicleWidth?: number;
1586
- /**
1587
- * Maximum speed of the vehicle in km/hour. The max speed in the vehicle profile is used to check whether a vehicle is allowed on motorways.
1588
- *
1589
- * * A value of 0 means that an appropriate value for the vehicle will be determined and applied during route planning.
1590
- *
1591
- * * A non-zero value may be overridden during route planning. For example, the current traffic flow is 60 km/hour. If the vehicle maximum speed is set to 50 km/hour, the routing engine will consider 60 km/hour as this is the current situation. If the maximum speed of the vehicle is provided as 80 km/hour but the current traffic flow is 60 km/hour, then routing engine will again use 60 km/hour.
1592
- */
1593
- vehicleMaxSpeed?: number;
1594
- /**
1595
- * Weight of the vehicle in kilograms.
1596
- *
1597
- * * It is mandatory if any of the *Efficiency parameters are set.
1598
- *
1599
- * * It must be strictly positive when used in the context of the Consumption Model. Weight restrictions are considered.
1600
- *
1601
- * * If no detailed **Consumption Model** is specified and the value of **vehicleWeight** is non-zero, then weight restrictions are considered.
1602
- *
1603
- * * In all other cases, this parameter is ignored.
1604
- *
1605
- * Sensible Values : for **Combustion Model** : 1600, for **Electric Model** : 1900
1606
- */
1607
- vehicleWeight?: number;
1608
- /** Whether the vehicle is used for commercial purposes. Commercial vehicles may not be allowed to drive on some roads. */
1609
- vehicleCommercial?: boolean;
1610
- /** Level of turns for thrilling route. This parameter can only be used in conjunction with `routeType`=thrilling. */
1611
- windingness?: "low" | "normal" | "high";
1612
- /** Degree of hilliness for thrilling route. This parameter can only be used in conjunction with `routeType`=thrilling. */
1613
- hilliness?: "low" | "normal" | "high";
1614
- /** The mode of travel for the requested route. If not defined, default is 'car'. Note that the requested travelMode may not be available for the entire route. Where the requested travelMode is not available for a particular section, the travelMode element of the response for that section will be "other". Note that travel modes bus, motorcycle, taxi and van are BETA functionality. Full restriction data is not available in all areas. */
1615
- travelMode?: "car" | "truck" | "taxi" | "bus" | "van" | "motorcycle" | "bicycle" | "pedestrian";
1616
- /** Specifies something that the route calculation should try to avoid when determining the route. Can be specified multiple times in one request, for example, '&avoid=motorways&avoid=tollRoads&avoid=ferries'. In Route Range requests, the value alreadyUsedRoads must not be used. */
1617
- avoid?: Array<"tollRoads" | "motorways" | "ferries" | "unpavedRoads" | "carpools" | "alreadyUsedRoads" | "borderCrossings">;
1618
- /**
1619
- * Possible values:
1620
- * * true - Do consider all available traffic information during routing
1621
- * * false - Ignore current traffic data during routing. Note that although the current traffic data is ignored
1622
- * during routing, the effect of historic traffic on effective road speeds is still incorporated.
1623
- */
1624
- traffic?: boolean;
1625
- /** The type of route requested. */
1626
- routeType?: "fastest" | "shortest" | "eco" | "thrilling";
1627
- /** Types of cargo that may be classified as hazardous materials and restricted from some roads. Available vehicleLoadType values are US Hazmat classes 1 through 9, plus generic classifications for use in other countries/regions. Values beginning with USHazmat are for US routing while otherHazmat should be used for all other countries/regions. vehicleLoadType can be specified multiple times. This parameter is currently only considered for travelMode=truck. */
1628
- vehicleLoadType?: "USHazmatClass1" | "USHazmatClass2" | "USHazmatClass3" | "USHazmatClass4" | "USHazmatClass5" | "USHazmatClass6" | "USHazmatClass7" | "USHazmatClass8" | "USHazmatClass9" | "otherHazmatExplosive" | "otherHazmatGeneral" | "otherHazmatHarmfulToWater";
1629
- /** Engine type of the vehicle. When a detailed Consumption Model is specified, it must be consistent with the value of **vehicleEngineType**. */
1630
- vehicleEngineType?: "combustion" | "electric";
1631
- /**
1632
- *
1633
- * Specifies the speed-dependent component of consumption.
1634
- *
1635
- * Provided as an unordered list of colon-delimited speed & consumption-rate pairs. The list defines points on a consumption curve. Consumption rates for speeds not in the list are found as follows:
1636
- *
1637
- * * by linear interpolation, if the given speed lies in between two speeds in the list
1638
- *
1639
- * * by linear extrapolation otherwise, assuming a constant (ΔConsumption/ΔSpeed) determined by the nearest two points in the list
1640
- *
1641
- * The list must contain between 1 and 25 points (inclusive), and may not contain duplicate points for the same speed. If it only contains a single point, then the consumption rate of that point is used without further processing.
1642
- *
1643
- * Consumption specified for the largest speed must be greater than or equal to that of the penultimate largest speed. This ensures that extrapolation does not lead to negative consumption rates.
1644
- *
1645
- * Similarly, consumption values specified for the two smallest speeds in the list cannot lead to a negative consumption rate for any smaller speed.
1646
- *
1647
- * The valid range for the consumption values(expressed in l/100km) is between 0.01 and 100000.0.
1648
- *
1649
- * Sensible Values : 50,6.3:130,11.5
1650
- *
1651
- * **Note** : This parameter is required for **The Combustion Consumption Model**.
1652
- */
1653
- constantSpeedConsumptionInLitersPerHundredkm?: string;
1654
- /**
1655
- * Specifies the current supply of fuel in liters.
1656
- *
1657
- * Sensible Values : 55
1658
- */
1659
- currentFuelInLiters?: number;
1660
- /**
1661
- * Specifies the amount of fuel consumed for sustaining auxiliary systems of the vehicle, in liters per hour.
1662
- *
1663
- * It can be used to specify consumption due to devices and systems such as AC systems, radio, heating, etc.
1664
- *
1665
- * Sensible Values : 0.2
1666
- */
1667
- auxiliaryPowerInLitersPerHour?: number;
1668
- /**
1669
- * Specifies the amount of chemical energy stored in one liter of fuel in megajoules (MJ). It is used in conjunction with the ***Efficiency** parameters for conversions between saved or consumed energy and fuel. For example, energy density is 34.2 MJ/l for gasoline, and 35.8 MJ/l for Diesel fuel.
1670
- *
1671
- * This parameter is required if any ***Efficiency** parameter is set.
1672
- *
1673
- * Sensible Values : 34.2
1674
- */
1675
- fuelEnergyDensityInMJoulesPerLiter?: number;
1676
- /**
1677
- * Specifies the efficiency of converting chemical energy stored in fuel to kinetic energy when the vehicle accelerates _(i.e. KineticEnergyGained/ChemicalEnergyConsumed). ChemicalEnergyConsumed_ is obtained by converting consumed fuel to chemical energy using **fuelEnergyDensityInMJoulesPerLiter**.
1678
- *
1679
- * Must be paired with **decelerationEfficiency**.
1680
- *
1681
- * The range of values allowed are 0.0 to 1/**decelerationEfficiency**.
1682
- *
1683
- * Sensible Values : for **Combustion Model** : 0.33, for **Electric Model** : 0.66
1684
- */
1685
- accelerationEfficiency?: number;
1686
- /**
1687
- * Specifies the efficiency of converting kinetic energy to saved (not consumed) fuel when the vehicle decelerates _(i.e. ChemicalEnergySaved/KineticEnergyLost). ChemicalEnergySaved_ is obtained by converting saved (not consumed) fuel to energy using **fuelEnergyDensityInMJoulesPerLiter**.
1688
- *
1689
- * Must be paired with **accelerationEfficiency**.
1690
- *
1691
- * The range of values allowed are 0.0 to 1/**accelerationEfficiency**.
1692
- *
1693
- * Sensible Values : for **Combustion Model** : 0.83, for **Electric Model** : 0.91
1694
- */
1695
- decelerationEfficiency?: number;
1696
- /**
1697
- * Specifies the efficiency of converting chemical energy stored in fuel to potential energy when the vehicle gains elevation _(i.e. PotentialEnergyGained/ChemicalEnergyConsumed). ChemicalEnergyConsumed_ is obtained by converting consumed fuel to chemical energy using **fuelEnergyDensityInMJoulesPerLiter**.
1698
- *
1699
- * Must be paired with **downhillEfficiency**.
1700
- *
1701
- * The range of values allowed are 0.0 to 1/**downhillEfficiency**.
1702
- *
1703
- * Sensible Values : for **Combustion Model** : 0.27, for **Electric Model** : 0.74
1704
- */
1705
- uphillEfficiency?: number;
1706
- /**
1707
- * Specifies the efficiency of converting potential energy to saved (not consumed) fuel when the vehicle loses elevation _(i.e. ChemicalEnergySaved/PotentialEnergyLost). ChemicalEnergySaved_ is obtained by converting saved (not consumed) fuel to energy using **fuelEnergyDensityInMJoulesPerLiter**.
1708
- *
1709
- * Must be paired with **uphillEfficiency**.
1710
- *
1711
- * The range of values allowed are 0.0 to 1/**uphillEfficiency**.
1712
- *
1713
- * Sensible Values : for **Combustion Model** : 0.51, for **Electric Model** : 0.73
1714
- */
1715
- downhillEfficiency?: number;
1716
- /**
1717
- * Specifies the speed-dependent component of consumption.
1718
- *
1719
- * Provided as an unordered list of speed/consumption-rate pairs. The list defines points on a consumption curve. Consumption rates for speeds not in the list are found as follows:
1720
- *
1721
- * * by linear interpolation, if the given speed lies in between two speeds in the list
1722
- *
1723
- * * by linear extrapolation otherwise, assuming a constant (ΔConsumption/ΔSpeed) determined by the nearest two points in the list
1724
- *
1725
- * The list must contain between 1 and 25 points (inclusive), and may not contain duplicate points for the same speed. If it only contains a single point, then the consumption rate of that point is used without further processing.
1726
- *
1727
- * Consumption specified for the largest speed must be greater than or equal to that of the penultimate largest speed. This ensures that extrapolation does not lead to negative consumption rates.
1728
- *
1729
- * Similarly, consumption values specified for the two smallest speeds in the list cannot lead to a negative consumption rate for any smaller speed.
1730
- *
1731
- * The valid range for the consumption values(expressed in kWh/100km) is between 0.01 and 100000.0.
1732
- *
1733
- * Sensible Values : 50,8.2:130,21.3
1734
- *
1735
- * This parameter is required for **Electric consumption model**.
1736
- */
1737
- constantSpeedConsumptionInkWhPerHundredkm?: string;
1738
- /**
1739
- * Specifies the current electric energy supply in kilowatt hours (kWh).
1740
- *
1741
- * This parameter co-exists with **maxChargeInkWh** parameter.
1742
- *
1743
- * The range of values allowed are 0.0 to **maxChargeInkWh**.
1744
- *
1745
- * Sensible Values : 43
1746
- */
1747
- currentChargeInkWh?: number;
1748
- /**
1749
- * Specifies the maximum electric energy supply in kilowatt hours (kWh) that may be stored in the vehicle's battery.
1750
- *
1751
- * This parameter co-exists with **currentChargeInkWh** parameter.
1752
- *
1753
- * Minimum value has to be greater than or equal to **currentChargeInkWh**.
1754
- *
1755
- * Sensible Values : 85
1756
- */
1757
- maxChargeInkWh?: number;
1758
- /**
1759
- * Specifies the amount of power consumed for sustaining auxiliary systems, in kilowatts (kW).
1760
- *
1761
- * It can be used to specify consumption due to devices and systems such as AC systems, radio, heating, etc.
1762
- *
1763
- * Sensible Values : 1.7
1764
- */
1765
- auxiliaryPowerInkW?: number;
1766
- }
1767
-
1768
- /**
1769
- *
1770
- * 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).
1771
- *
1772
- * 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.
1773
- *
1774
- *
1775
- * 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.
1776
- *
1777
- *
1778
- * 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).
1779
- *
1780
- *
1781
- *
1782
- * ### Submit Synchronous Route Matrix Request
1783
- * 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).
1784
- *
1785
- * ```
1786
- * GET https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}
1787
- * ```
1788
- *
1789
- * ### Submit Asynchronous Route Matrix Request
1790
- * 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.
1791
- *
1792
- *
1793
- * 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).
1794
- *
1795
- *
1796
- * The asynchronous responses are stored for **24** hours. The redirect URL returns a 404 response if used after the expiration period.
1797
- *
1798
- *
1799
- *
1800
- *
1801
- * ```
1802
- * GET https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}
1803
- * ```
1804
- *
1805
- * Here's a typical sequence of asynchronous operations:
1806
- * 1. Client sends a Route Matrix GET request to Azure Maps
1807
- *
1808
- * 2. The server will respond with one of the following:
1809
- *
1810
- * > HTTP `202 Accepted` - Route Matrix request has been accepted.
1811
- *
1812
- * > 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.
1813
- *
1814
- *
1815
- * 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:
1816
- *
1817
- * ```
1818
- * GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
1819
- * ```
1820
- *
1821
- *
1822
- * 4. Client issues a GET request on the download URL obtained in Step 3 to download the results
1823
- *
1824
- * ### Download Sync Results
1825
- * 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.
1826
- *
1827
- * ### Download Async Results
1828
- * 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:
1829
- * ```
1830
- * GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
1831
- * ```
1832
- *
1833
- * The URL provided by the location header will return the following responses when a `GET` request is issued.
1834
- *
1835
- * > HTTP `202 Accepted` - Matrix request was accepted but is still being processed. Please try again in some time.
1836
- *
1837
- * > HTTP `200 OK` - Matrix request successfully processed. The response body contains all of the results.
1838
- */
1839
- export declare interface RouteGetRouteMatrix200Response extends HttpResponse {
1840
- status: "200";
1841
- body: RouteMatrixResultOutput;
1842
- }
1843
-
1844
- export declare interface RouteGetRouteMatrix202Headers {
1845
- /** New URL to check for the results of the long-running operation. */
1846
- location?: string;
1847
- }
1848
-
1849
- /**
1850
- *
1851
- * 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).
1852
- *
1853
- * 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.
1854
- *
1855
- *
1856
- * 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.
1857
- *
1858
- *
1859
- * 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).
1860
- *
1861
- *
1862
- *
1863
- * ### Submit Synchronous Route Matrix Request
1864
- * 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).
1865
- *
1866
- * ```
1867
- * GET https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}
1868
- * ```
1869
- *
1870
- * ### Submit Asynchronous Route Matrix Request
1871
- * 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.
1872
- *
1873
- *
1874
- * 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).
1875
- *
1876
- *
1877
- * The asynchronous responses are stored for **24** hours. The redirect URL returns a 404 response if used after the expiration period.
1878
- *
1879
- *
1880
- *
1881
- *
1882
- * ```
1883
- * GET https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}
1884
- * ```
1885
- *
1886
- * Here's a typical sequence of asynchronous operations:
1887
- * 1. Client sends a Route Matrix GET request to Azure Maps
1888
- *
1889
- * 2. The server will respond with one of the following:
1890
- *
1891
- * > HTTP `202 Accepted` - Route Matrix request has been accepted.
1892
- *
1893
- * > 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.
1894
- *
1895
- *
1896
- * 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:
1897
- *
1898
- * ```
1899
- * GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
1900
- * ```
1901
- *
1902
- *
1903
- * 4. Client issues a GET request on the download URL obtained in Step 3 to download the results
1904
- *
1905
- * ### Download Sync Results
1906
- * 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.
1907
- *
1908
- * ### Download Async Results
1909
- * 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:
1910
- * ```
1911
- * GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
1912
- * ```
1913
- *
1914
- * The URL provided by the location header will return the following responses when a `GET` request is issued.
1915
- *
1916
- * > HTTP `202 Accepted` - Matrix request was accepted but is still being processed. Please try again in some time.
1917
- *
1918
- * > HTTP `200 OK` - Matrix request successfully processed. The response body contains all of the results.
1919
- */
1920
- export declare interface RouteGetRouteMatrix202Response extends HttpResponse {
1921
- status: "202";
1922
- headers: RawHttpHeaders & RouteGetRouteMatrix202Headers;
1923
- }
1924
-
1925
- export declare type RouteGetRouteMatrixParameters = RequestParameters;
1926
-
1927
- /**
1928
- *
1929
- * 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.
1930
- *
1931
- * 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.
1932
- */
1933
- export declare interface RouteGetRouteRange200Response extends HttpResponse {
1934
- status: "200";
1935
- body: RouteRangeResultOutput;
1936
- }
1937
-
1938
- /**
1939
- *
1940
- * 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.
1941
- *
1942
- * 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.
1943
- */
1944
- export declare interface RouteGetRouteRangeDefaultResponse extends HttpResponse {
1945
- status: string;
1946
- body: ErrorResponseOutput;
1947
- }
1948
-
1949
- export declare type RouteGetRouteRangeParameters = RouteGetRouteRangeQueryParam & RequestParameters;
1950
-
1951
- export declare interface RouteGetRouteRangeQueryParam {
1952
- queryParameters: RouteGetRouteRangeQueryParamProperties;
1953
- }
1954
-
1955
- export declare interface RouteGetRouteRangeQueryParamProperties {
1956
- /** The Coordinate from which the range calculation should start. */
1957
- query: Array<number>;
1958
- /** Fuel budget in liters that determines maximal range which can be travelled using the specified Combustion Consumption Model.<br> When fuelBudgetInLiters is used, it is mandatory to specify a detailed Combustion Consumption Model.<br> Exactly one budget (fuelBudgetInLiters, energyBudgetInkWh, timeBudgetInSec, or distanceBudgetInMeters) must be used. */
1959
- fuelBudgetInLiters?: number;
1960
- /** Electric energy budget in kilowatt hours (kWh) that determines maximal range which can be travelled using the specified Electric Consumption Model.<br> When energyBudgetInkWh is used, it is mandatory to specify a detailed Electric Consumption Model.<br> Exactly one budget (fuelBudgetInLiters, energyBudgetInkWh, timeBudgetInSec, or distanceBudgetInMeters) must be used. */
1961
- energyBudgetInkWh?: number;
1962
- /** Time budget in seconds that determines maximal range which can be travelled using driving time. The Consumption Model will only affect the range when routeType is eco.<br> Exactly one budget (fuelBudgetInLiters, energyBudgetInkWh, timeBudgetInSec, or distanceBudgetInMeters) must be used. */
1963
- timeBudgetInSec?: number;
1964
- /** Distance budget in meters that determines maximal range which can be travelled using driving distance. The Consumption Model will only affect the range when routeType is eco.<br> Exactly one budget (fuelBudgetInLiters, energyBudgetInkWh, timeBudgetInSec, or distanceBudgetInMeters) must be used. */
1965
- distanceBudgetInMeters?: number;
1966
- /**
1967
- * The date and time of departure from the origin point formatted as a `dateTime` value as defined in [RFC 3339, section 5.6](https://www.rfc-editor.org/rfc/rfc3339#section-5.6), with an optional time zone offset. When a time zone offset is not specified, it will be assumed to be that of the origin point.
1968
- * * Default value: now
1969
- * * Other value: `dateTime`
1970
- *
1971
- * Examples:
1972
- * * 2023-12-19T16:39:57
1973
- * * 2023-12-19T16:39:57-08:00
1974
- *
1975
- * The `departAt` parameter cannot be used in conjunction with `arriveAt`.
1976
- */
1977
- departAt?: Date | string;
1978
- /** The type of route requested. */
1979
- routeType?: "fastest" | "shortest" | "eco" | "thrilling";
1980
- /**
1981
- * Possible values:
1982
- * * true - Do consider all available traffic information during routing
1983
- * * false - Ignore current traffic data during routing. Note that although the current traffic data is ignored
1984
- * during routing, the effect of historic traffic on effective road speeds is still incorporated.
1985
- */
1986
- traffic?: boolean;
1987
- /** Specifies something that the route calculation should try to avoid when determining the route. Can be specified multiple times in one request, for example, '&avoid=motorways&avoid=tollRoads&avoid=ferries'. In Route Range requests, the value alreadyUsedRoads must not be used. */
1988
- avoid?: Array<"tollRoads" | "motorways" | "ferries" | "unpavedRoads" | "carpools" | "alreadyUsedRoads" | "borderCrossings">;
1989
- /** The mode of travel for the requested route. If not defined, default is 'car'. Note that the requested travelMode may not be available for the entire route. Where the requested travelMode is not available for a particular section, the travelMode element of the response for that section will be "other". Note that travel modes bus, motorcycle, taxi and van are BETA functionality. Full restriction data is not available in all areas. */
1990
- travelMode?: "car" | "truck" | "taxi" | "bus" | "van" | "motorcycle" | "bicycle" | "pedestrian";
1991
- /** Degree of hilliness for thrilling route. This parameter can only be used in conjunction with `routeType`=thrilling. */
1992
- hilliness?: "low" | "normal" | "high";
1993
- /** Level of turns for thrilling route. This parameter can only be used in conjunction with `routeType`=thrilling. */
1994
- windingness?: "low" | "normal" | "high";
1995
- /** Weight per axle of the vehicle in kg. A value of 0 means that weight restrictions per axle are not considered. */
1996
- vehicleAxleWeight?: number;
1997
- /** Width of the vehicle in meters. A value of 0 means that width restrictions are not considered. */
1998
- vehicleWidth?: number;
1999
- /** Height of the vehicle in meters. A value of 0 means that height restrictions are not considered. */
2000
- vehicleHeight?: number;
2001
- /** Length of the vehicle in meters. A value of 0 means that length restrictions are not considered. */
2002
- vehicleLength?: number;
2003
- /**
2004
- * Maximum speed of the vehicle in km/hour. The max speed in the vehicle profile is used to check whether a vehicle is allowed on motorways.
2005
- *
2006
- * * A value of 0 means that an appropriate value for the vehicle will be determined and applied during route planning.
2007
- *
2008
- * * A non-zero value may be overridden during route planning. For example, the current traffic flow is 60 km/hour. If the vehicle maximum speed is set to 50 km/hour, the routing engine will consider 60 km/hour as this is the current situation. If the maximum speed of the vehicle is provided as 80 km/hour but the current traffic flow is 60 km/hour, then routing engine will again use 60 km/hour.
2009
- */
2010
- vehicleMaxSpeed?: number;
2011
- /**
2012
- * Weight of the vehicle in kilograms.
2013
- *
2014
- * * It is mandatory if any of the *Efficiency parameters are set.
2015
- *
2016
- * * It must be strictly positive when used in the context of the Consumption Model. Weight restrictions are considered.
2017
- *
2018
- * * If no detailed **Consumption Model** is specified and the value of **vehicleWeight** is non-zero, then weight restrictions are considered.
2019
- *
2020
- * * In all other cases, this parameter is ignored.
2021
- *
2022
- * Sensible Values : for **Combustion Model** : 1600, for **Electric Model** : 1900
2023
- */
2024
- vehicleWeight?: number;
2025
- /** Whether the vehicle is used for commercial purposes. Commercial vehicles may not be allowed to drive on some roads. */
2026
- vehicleCommercial?: boolean;
2027
- /** Types of cargo that may be classified as hazardous materials and restricted from some roads. Available vehicleLoadType values are US Hazmat classes 1 through 9, plus generic classifications for use in other countries/regions. Values beginning with USHazmat are for US routing while otherHazmat should be used for all other countries/regions. vehicleLoadType can be specified multiple times. This parameter is currently only considered for travelMode=truck. */
2028
- vehicleLoadType?: "USHazmatClass1" | "USHazmatClass2" | "USHazmatClass3" | "USHazmatClass4" | "USHazmatClass5" | "USHazmatClass6" | "USHazmatClass7" | "USHazmatClass8" | "USHazmatClass9" | "otherHazmatExplosive" | "otherHazmatGeneral" | "otherHazmatHarmfulToWater";
2029
- /** Engine type of the vehicle. When a detailed Consumption Model is specified, it must be consistent with the value of **vehicleEngineType**. */
2030
- vehicleEngineType?: "combustion" | "electric";
2031
- /**
2032
- *
2033
- * Specifies the speed-dependent component of consumption.
2034
- *
2035
- * Provided as an unordered list of colon-delimited speed & consumption-rate pairs. The list defines points on a consumption curve. Consumption rates for speeds not in the list are found as follows:
2036
- *
2037
- * * by linear interpolation, if the given speed lies in between two speeds in the list
2038
- *
2039
- * * by linear extrapolation otherwise, assuming a constant (ΔConsumption/ΔSpeed) determined by the nearest two points in the list
2040
- *
2041
- * The list must contain between 1 and 25 points (inclusive), and may not contain duplicate points for the same speed. If it only contains a single point, then the consumption rate of that point is used without further processing.
2042
- *
2043
- * Consumption specified for the largest speed must be greater than or equal to that of the penultimate largest speed. This ensures that extrapolation does not lead to negative consumption rates.
2044
- *
2045
- * Similarly, consumption values specified for the two smallest speeds in the list cannot lead to a negative consumption rate for any smaller speed.
2046
- *
2047
- * The valid range for the consumption values(expressed in l/100km) is between 0.01 and 100000.0.
2048
- *
2049
- * Sensible Values : 50,6.3:130,11.5
2050
- *
2051
- * **Note** : This parameter is required for **The Combustion Consumption Model**.
2052
- */
2053
- constantSpeedConsumptionInLitersPerHundredkm?: string;
2054
- /**
2055
- * Specifies the current supply of fuel in liters.
2056
- *
2057
- * Sensible Values : 55
2058
- */
2059
- currentFuelInLiters?: number;
2060
- /**
2061
- * Specifies the amount of fuel consumed for sustaining auxiliary systems of the vehicle, in liters per hour.
2062
- *
2063
- * It can be used to specify consumption due to devices and systems such as AC systems, radio, heating, etc.
2064
- *
2065
- * Sensible Values : 0.2
2066
- */
2067
- auxiliaryPowerInLitersPerHour?: number;
2068
- /**
2069
- * Specifies the amount of chemical energy stored in one liter of fuel in megajoules (MJ). It is used in conjunction with the ***Efficiency** parameters for conversions between saved or consumed energy and fuel. For example, energy density is 34.2 MJ/l for gasoline, and 35.8 MJ/l for Diesel fuel.
2070
- *
2071
- * This parameter is required if any ***Efficiency** parameter is set.
2072
- *
2073
- * Sensible Values : 34.2
2074
- */
2075
- fuelEnergyDensityInMJoulesPerLiter?: number;
2076
- /**
2077
- * Specifies the efficiency of converting chemical energy stored in fuel to kinetic energy when the vehicle accelerates _(i.e. KineticEnergyGained/ChemicalEnergyConsumed). ChemicalEnergyConsumed_ is obtained by converting consumed fuel to chemical energy using **fuelEnergyDensityInMJoulesPerLiter**.
2078
- *
2079
- * Must be paired with **decelerationEfficiency**.
2080
- *
2081
- * The range of values allowed are 0.0 to 1/**decelerationEfficiency**.
2082
- *
2083
- * Sensible Values : for **Combustion Model** : 0.33, for **Electric Model** : 0.66
2084
- */
2085
- accelerationEfficiency?: number;
2086
- /**
2087
- * Specifies the efficiency of converting kinetic energy to saved (not consumed) fuel when the vehicle decelerates _(i.e. ChemicalEnergySaved/KineticEnergyLost). ChemicalEnergySaved_ is obtained by converting saved (not consumed) fuel to energy using **fuelEnergyDensityInMJoulesPerLiter**.
2088
- *
2089
- * Must be paired with **accelerationEfficiency**.
2090
- *
2091
- * The range of values allowed are 0.0 to 1/**accelerationEfficiency**.
2092
- *
2093
- * Sensible Values : for **Combustion Model** : 0.83, for **Electric Model** : 0.91
2094
- */
2095
- decelerationEfficiency?: number;
2096
- /**
2097
- * Specifies the efficiency of converting chemical energy stored in fuel to potential energy when the vehicle gains elevation _(i.e. PotentialEnergyGained/ChemicalEnergyConsumed). ChemicalEnergyConsumed_ is obtained by converting consumed fuel to chemical energy using **fuelEnergyDensityInMJoulesPerLiter**.
2098
- *
2099
- * Must be paired with **downhillEfficiency**.
2100
- *
2101
- * The range of values allowed are 0.0 to 1/**downhillEfficiency**.
2102
- *
2103
- * Sensible Values : for **Combustion Model** : 0.27, for **Electric Model** : 0.74
2104
- */
2105
- uphillEfficiency?: number;
2106
- /**
2107
- * Specifies the efficiency of converting potential energy to saved (not consumed) fuel when the vehicle loses elevation _(i.e. ChemicalEnergySaved/PotentialEnergyLost). ChemicalEnergySaved_ is obtained by converting saved (not consumed) fuel to energy using **fuelEnergyDensityInMJoulesPerLiter**.
2108
- *
2109
- * Must be paired with **uphillEfficiency**.
2110
- *
2111
- * The range of values allowed are 0.0 to 1/**uphillEfficiency**.
2112
- *
2113
- * Sensible Values : for **Combustion Model** : 0.51, for **Electric Model** : 0.73
2114
- */
2115
- downhillEfficiency?: number;
2116
- /**
2117
- * Specifies the speed-dependent component of consumption.
2118
- *
2119
- * Provided as an unordered list of speed/consumption-rate pairs. The list defines points on a consumption curve. Consumption rates for speeds not in the list are found as follows:
2120
- *
2121
- * * by linear interpolation, if the given speed lies in between two speeds in the list
2122
- *
2123
- * * by linear extrapolation otherwise, assuming a constant (ΔConsumption/ΔSpeed) determined by the nearest two points in the list
2124
- *
2125
- * The list must contain between 1 and 25 points (inclusive), and may not contain duplicate points for the same speed. If it only contains a single point, then the consumption rate of that point is used without further processing.
2126
- *
2127
- * Consumption specified for the largest speed must be greater than or equal to that of the penultimate largest speed. This ensures that extrapolation does not lead to negative consumption rates.
2128
- *
2129
- * Similarly, consumption values specified for the two smallest speeds in the list cannot lead to a negative consumption rate for any smaller speed.
2130
- *
2131
- * The valid range for the consumption values(expressed in kWh/100km) is between 0.01 and 100000.0.
2132
- *
2133
- * Sensible Values : 50,8.2:130,21.3
2134
- *
2135
- * This parameter is required for **Electric consumption model**.
2136
- */
2137
- constantSpeedConsumptionInkWhPerHundredkm?: string;
2138
- /**
2139
- * Specifies the current electric energy supply in kilowatt hours (kWh).
2140
- *
2141
- * This parameter co-exists with **maxChargeInkWh** parameter.
2142
- *
2143
- * The range of values allowed are 0.0 to **maxChargeInkWh**.
2144
- *
2145
- * Sensible Values : 43
2146
- */
2147
- currentChargeInkWh?: number;
2148
- /**
2149
- * Specifies the maximum electric energy supply in kilowatt hours (kWh) that may be stored in the vehicle's battery.
2150
- *
2151
- * This parameter co-exists with **currentChargeInkWh** parameter.
2152
- *
2153
- * Minimum value has to be greater than or equal to **currentChargeInkWh**.
2154
- *
2155
- * Sensible Values : 85
2156
- */
2157
- maxChargeInkWh?: number;
2158
- /**
2159
- * Specifies the amount of power consumed for sustaining auxiliary systems, in kilowatts (kW).
2160
- *
2161
- * It can be used to specify consumption due to devices and systems such as AC systems, radio, heating, etc.
2162
- *
2163
- * Sensible Values : 1.7
2164
- */
2165
- auxiliaryPowerInkW?: number;
2166
- }
2167
-
2168
- /** Contains guidance related elements. This field is present only when guidance was requested and is available. */
2169
- export declare interface RouteGuidanceOutput {
2170
- /** A list of instructions describing maneuvers. */
2171
- readonly instructions: Array<RouteInstructionOutput>;
2172
- /** Groups a sequence of instruction elements which are related to each other. */
2173
- readonly instructionGroups: Array<RouteInstructionGroupOutput>;
2174
- }
2175
-
2176
- /** Groups a sequence of instruction elements which are related to each other. The sequence range is constrained with firstInstructionIndex and lastInstructionIndex. When human-readable text messages are requested for guidance (instructionType=text or tagged), then the instructionGroup has a summary message returned when available. */
2177
- export declare interface RouteInstructionGroupOutput {
2178
- /** Index of the first instruction in the instructions and belonging to this group. */
2179
- readonly firstInstructionIndex?: number;
2180
- /** Index of the last instruction in the instructions and belonging to this group. */
2181
- readonly lastInstructionIndex?: number;
2182
- /** Length of the group. */
2183
- readonly groupLengthInMeters?: number;
2184
- /** Summary message when human-readable text messages are requested for guidance (instructionType=text or tagged). */
2185
- readonly groupMessage?: string;
2186
- }
2187
-
2188
- /** A set of attributes describing a maneuver, e.g. 'Turn right', 'Keep left', 'Take the ferry', 'Take the motorway', 'Arrive'. */
2189
- export declare interface RouteInstructionOutput {
2190
- /** Distance from the start of the route to the point of the instruction. */
2191
- readonly routeOffsetInMeters?: number;
2192
- /** Estimated travel time up to the point corresponding to routeOffsetInMeters. */
2193
- readonly travelTimeInSeconds?: number;
2194
- /** A location represented as a latitude and longitude. */
2195
- point?: LatLongPairOutput;
2196
- /** The index of the point in the list of polyline "points" corresponding to the point of the instruction. */
2197
- readonly pointIndex?: number;
2198
- /** Type of the instruction, e.g., turn or change of road form. */
2199
- instructionType?: "TURN" | "ROAD_CHANGE" | "LOCATION_DEPARTURE" | "LOCATION_ARRIVAL" | "DIRECTION_INFO" | "LOCATION_WAYPOINT";
2200
- /** The road number(s) of the next significant road segment(s) after the maneuver, or of the road(s) to be followed. Example: ["E34", "N205"] */
2201
- readonly roadNumbers?: Array<string>;
2202
- /** The number(s) of a highway exit taken by the current maneuver. If an exit has multiple exit numbers, they will be separated by "," and possibly aggregated by "-", e.g., "10, 13-15". */
2203
- readonly exitNumber?: string;
2204
- /** Street name of the next significant road segment after the maneuver, or of the street that should be followed. */
2205
- readonly street?: string;
2206
- /** The text on a signpost which is most relevant to the maneuver, or to the direction that should be followed. */
2207
- readonly signpostText?: string;
2208
- /** 3-character [ISO 3166-1](https://www.iso.org/iso-3166-country-codes.html) alpha-3 country code. E.g. USA. */
2209
- readonly countryCode?: string;
2210
- /** A subdivision (e.g., state) of the country, represented by the second part of an [ISO 3166-2](https://www.iso.org/standard/63546.html) code. This is only available for some countries/regions like the US, Canada, and Mexico. */
2211
- readonly stateCode?: string;
2212
- /** The type of the junction where the maneuver takes place. For larger roundabouts, two separate instructions are generated for entering and leaving the roundabout. */
2213
- readonly junctionType?: "REGULAR" | "ROUNDABOUT" | "BIFURCATION";
2214
- /**
2215
- * Indicates the direction of an instruction. If junctionType indicates a turn instruction:
2216
- *
2217
- * * 180 = U-turn
2218
- * * [-179, -1] = Left turn
2219
- * * 0 = Straight on (a '0 degree' turn)
2220
- * * [1, 179] = Right turn
2221
- *
2222
- * If junctionType indicates a bifurcation instruction:
2223
- *
2224
- * * <0 - keep left
2225
- * * \>0 - keep right
2226
- */
2227
- readonly turnAngleInDecimalDegrees?: number;
2228
- /** This indicates which exit to take at a roundabout. */
2229
- readonly roundaboutExitNumber?: number;
2230
- /** It is possible to optionally combine the instruction with the next one. This can be used to build messages like "Turn left and then turn right". */
2231
- readonly possibleCombineWithNext?: boolean;
2232
- /** Indicates left-hand vs. right-hand side driving at the point of the maneuver. */
2233
- readonly drivingSide?: "LEFT" | "RIGHT";
2234
- /** A code identifying the maneuver. */
2235
- readonly maneuver?: "ARRIVE" | "ARRIVE_LEFT" | "ARRIVE_RIGHT" | "DEPART" | "STRAIGHT" | "KEEP_RIGHT" | "BEAR_RIGHT" | "TURN_RIGHT" | "SHARP_RIGHT" | "KEEP_LEFT" | "BEAR_LEFT" | "TURN_LEFT" | "SHARP_LEFT" | "MAKE_UTURN" | "ENTER_MOTORWAY" | "ENTER_FREEWAY" | "ENTER_HIGHWAY" | "TAKE_EXIT" | "MOTORWAY_EXIT_LEFT" | "MOTORWAY_EXIT_RIGHT" | "TAKE_FERRY" | "ROUNDABOUT_CROSS" | "ROUNDABOUT_RIGHT" | "ROUNDABOUT_LEFT" | "ROUNDABOUT_BACK" | "TRY_MAKE_UTURN" | "FOLLOW" | "SWITCH_PARALLEL_ROAD" | "SWITCH_MAIN_ROAD" | "ENTRANCE_RAMP" | "WAYPOINT_LEFT" | "WAYPOINT_RIGHT" | "WAYPOINT_REACHED";
2236
- /** A human-readable message for the maneuver. */
2237
- readonly message?: string;
2238
- /**
2239
- * A human-readable message for the maneuver combined with the message from the next instruction. Sometimes it is possible to combine two successive instructions into a single instruction making it easier to follow. When this is the case the possibleCombineWithNext flag will be true. For example:
2240
- *
2241
- * ```
2242
- * 10. Turn left onto Einsteinweg/A10/E22 towards Ring Amsterdam
2243
- * 11. Follow Einsteinweg/A10/E22 towards Ring Amsterdam
2244
- * ```
2245
- *
2246
- * The possibleCombineWithNext flag on instruction 10 is true. This indicates to the clients of coded guidance that it can be combined with instruction 11. The instructions will be combined automatically for clients requesting human-readable guidance. The combinedMessage field contains the combined message:
2247
- *
2248
- * ```
2249
- * Turn left onto Einsteinweg/A10/E22 towards Ring Amsterdam
2250
- * then follow Einsteinweg/A10/E22 towards Ring Amsterdam.
2251
- * ```
2252
- */
2253
- readonly combinedMessage?: string;
2254
- }
2255
-
2256
- /** A description of a part of a route, comprised of a list of points. Each additional waypoint provided in the request will result in an additional leg in the returned route. */
2257
- export declare interface RouteLegOutput {
2258
- /** Summary object */
2259
- readonly summary: RouteSummaryOutput;
2260
- /** Points array */
2261
- readonly points: Array<LatLongPairOutput>;
2262
- }
2263
-
2264
- /** Matrix result object */
2265
- export declare interface RouteMatrixOutput {
2266
- /** StatusCode property for the current cell in the input matrix. */
2267
- readonly statusCode: number;
2268
- /** Response object of the current cell in the input matrix. */
2269
- readonly response?: RouteMatrixResultResponseOutput;
2270
- }
2271
-
2272
- /** An object with a matrix of coordinates. */
2273
- export declare interface RouteMatrixQuery {
2274
- /** A valid `GeoJSON MultiPoint` geometry type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1.3) for details. */
2275
- origins: GeoJsonMultiPoint;
2276
- /** A valid `GeoJSON MultiPoint` geometry type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1.3) for details. */
2277
- destinations: GeoJsonMultiPoint;
2278
- }
2279
-
2280
- /** This object is returned from a successful Route Matrix call. For ex, if 2 origins and 3 destinations are provided, there are going to 2 arrays with 3 elements in each. Each element's content depends on the options provided in the query. */
2281
- export declare interface RouteMatrixResultOutput {
2282
- /** Format Version property */
2283
- readonly formatVersion?: string;
2284
- /** Results as a 2 dimensional array of route summaries. */
2285
- readonly matrix: Array<Array<RouteMatrixOutput>>;
2286
- /** Summary object */
2287
- readonly summary: RouteMatrixSummaryOutput;
2288
- }
2289
-
2290
- /** Response object of the current cell in the input matrix. */
2291
- export declare interface RouteMatrixResultResponseOutput {
2292
- /** Summary object */
2293
- readonly routeSummary?: RouteSummaryOutput;
2294
- }
2295
-
2296
- /** Summary object */
2297
- export declare interface RouteMatrixSummaryOutput {
2298
- /** Number of successful routes in the response. */
2299
- readonly successfulRoutes: number;
2300
- /** Total number of routes requested. Number of cells in the input matrix. */
2301
- readonly totalRoutes: number;
2302
- }
2303
-
2304
- /** Optimized way point object. */
2305
- export declare interface RouteOptimizedWaypointOutput {
2306
- /** Way point index provided by the user. */
2307
- readonly providedIndex: number;
2308
- /** Optimized way point index from the system. */
2309
- readonly optimizedIndex: number;
2310
- }
2311
-
2312
- export declare interface RouteOutput {
2313
- /** Summary object */
2314
- readonly summary: RouteSummaryOutput;
2315
- /** Legs array */
2316
- readonly legs: Array<RouteLegOutput>;
2317
- /** Sections array */
2318
- readonly sections?: Array<RouteSectionOutput>;
2319
- /** Contains guidance related elements. This field is present only when guidance was requested and is available. */
2320
- readonly guidance?: RouteGuidanceOutput;
2321
- }
2322
-
2323
- /** Reachable Range */
2324
- export declare interface RouteRangeOutput {
2325
- /** Center point of the reachable range */
2326
- center: LatLongPairOutput;
2327
- /** Polygon boundary of the reachable range represented as a list of points. */
2328
- readonly boundary: Array<LatLongPairOutput>;
2329
- }
2330
-
2331
- /** This object is returned from a successful Route Reachable Range call */
2332
- export declare interface RouteRangeResultOutput {
2333
- /** Format Version property */
2334
- readonly formatVersion?: string;
2335
- /** Reachable Range */
2336
- reachableRange: RouteRangeOutput;
2337
- /** Reports the effective settings used in the current call. */
2338
- report?: RouteReportOutput;
2339
- }
2340
-
2341
- /** Reports the effective settings used in the current call. */
2342
- export declare interface RouteReportOutput {
2343
- /** Effective parameters or data used when calling this Route API. */
2344
- readonly effectiveSettings: Array<EffectiveSettingOutput>;
2345
- }
2346
-
2347
- /**
2348
- *
2349
- * 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).
2350
- *
2351
- * ### Submit Asynchronous Batch Request
2352
- * The Asynchronous API is appropriate for processing big volumes of relatively complex route requests
2353
- * - It allows the retrieval of results in a separate call (multiple downloads are possible).
2354
- * - The asynchronous API is optimized for reliability and is not expected to run into a timeout.
2355
- * - The number of batch items is limited to **700** for this API.
2356
- *
2357
- * 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.
2358
- * The asynchronous responses are stored for **24** hours. The redirect URL returns a 404 response if used after the expiration period.
2359
- *
2360
- * Please note that asynchronous batch request is a long-running operation. Here's a typical sequence of operations:
2361
- * 1. Client sends a Route Directions Batch `POST` request to Azure Maps.
2362
- * ```
2363
- * POST https://atlas.microsoft.com/route/directions/batch/json?api-version=1.0&subscription-key={subscription-key}
2364
- * ```
2365
- * 2. The server will respond with one of the following:
2366
- *
2367
- * > HTTP `202 Accepted` - Batch request has been accepted.
2368
- *
2369
- * > HTTP `Error` - There was an error processing your Batch request. This could either be a `400 Bad Request` or any other `Error` status code.
2370
- *
2371
- * 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.
2372
- * This status URI looks like following:
2373
- * ```
2374
- * GET https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
2375
- * ```
2376
- * 4. Client issues a `GET` request on the _download URL_ obtained in Step 3 to download the batch results.
2377
- *
2378
- * ### POST Body for Batch Request
2379
- * 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:
2380
- *
2381
- *
2382
- * ```json
2383
- * {
2384
- * "batchItems": [
2385
- * { "query": "?query=47.620659,-122.348934:47.610101,-122.342015&travelMode=bicycle&routeType=eco&traffic=false" },
2386
- * { "query": "?query=40.759856,-73.985108:40.771136,-73.973506&travelMode=pedestrian&routeType=shortest" },
2387
- * { "query": "?query=48.923159,-122.557362:32.621279,-116.840362" }
2388
- * ]
2389
- * }
2390
- * ```
2391
- *
2392
- * 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.
2393
- *
2394
- *
2395
- * 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.
2396
- *
2397
- *
2398
- * ### Download Asynchronous Batch Results
2399
- * 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:
2400
- *
2401
- * ```
2402
- * https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
2403
- * ```
2404
- * Here's the typical sequence of operations for downloading the batch results:
2405
- * 1. Client sends a `GET` request using the _download URL_.
2406
- * 2. The server will respond with one of the following:
2407
- *
2408
- * > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time.
2409
- *
2410
- * > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results.
2411
- *
2412
- *
2413
- *
2414
- * ### Batch Response Model
2415
- * 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:
2416
- *
2417
- * - [`RouteDirections`](https://docs.microsoft.com/rest/api/maps/route/getroutedirections#routedirections) - If the query completed successfully.
2418
- *
2419
- * - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.
2420
- *
2421
- *
2422
- * Here's a sample Batch Response with 1 _successful_ and 1 _failed_ result:
2423
- *
2424
- *
2425
- * ```json
2426
- * {
2427
- * "summary": {
2428
- * "successfulRequests": 1,
2429
- * "totalRequests": 2
2430
- * },
2431
- * "batchItems": [
2432
- * {
2433
- * "statusCode": 200,
2434
- * "response": {
2435
- * "routes": [
2436
- * {
2437
- * "summary": {
2438
- * "lengthInMeters": 1758,
2439
- * "travelTimeInSeconds": 387,
2440
- * "trafficDelayInSeconds": 0,
2441
- * "departureTime": "2018-07-17T00:49:56+00:00",
2442
- * "arrivalTime": "2018-07-17T00:56:22+00:00"
2443
- * },
2444
- * "legs": [
2445
- * {
2446
- * "summary": {
2447
- * "lengthInMeters": 1758,
2448
- * "travelTimeInSeconds": 387,
2449
- * "trafficDelayInSeconds": 0,
2450
- * "departureTime": "2018-07-17T00:49:56+00:00",
2451
- * "arrivalTime": "2018-07-17T00:56:22+00:00"
2452
- * },
2453
- * "points": [
2454
- * {
2455
- * "latitude": 47.62094,
2456
- * "longitude": -122.34892
2457
- * },
2458
- * {
2459
- * "latitude": 47.62094,
2460
- * "longitude": -122.3485
2461
- * },
2462
- * {
2463
- * "latitude": 47.62095,
2464
- * "longitude": -122.3476
2465
- * }
2466
- * ]
2467
- * }
2468
- * ],
2469
- * "sections": [
2470
- * {
2471
- * "startPointIndex": 0,
2472
- * "endPointIndex": 40,
2473
- * "sectionType": "TRAVEL_MODE",
2474
- * "travelMode": "bicycle"
2475
- * }
2476
- * ]
2477
- * }
2478
- * ]
2479
- * }
2480
- * },
2481
- * {
2482
- * "statusCode": 400,
2483
- * "response":
2484
- * {
2485
- * "error":
2486
- * {
2487
- * "code": "400 BadRequest",
2488
- * "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
2489
- * }
2490
- * }
2491
- * }
2492
- * ]
2493
- * }
2494
- * ```
2495
- */
2496
- export declare interface RouteRequestRouteDirectionsBatch200Response extends HttpResponse {
2497
- status: "200";
2498
- body: RouteDirectionsBatchResultOutput;
2499
- }
2500
-
2501
- export declare interface RouteRequestRouteDirectionsBatch202Headers {
2502
- /** New URL to check for the results of the long-running operation. */
2503
- location?: string;
2504
- }
2505
-
2506
- /**
2507
- *
2508
- * 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).
2509
- *
2510
- * ### Submit Asynchronous Batch Request
2511
- * The Asynchronous API is appropriate for processing big volumes of relatively complex route requests
2512
- * - It allows the retrieval of results in a separate call (multiple downloads are possible).
2513
- * - The asynchronous API is optimized for reliability and is not expected to run into a timeout.
2514
- * - The number of batch items is limited to **700** for this API.
2515
- *
2516
- * 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.
2517
- * The asynchronous responses are stored for **24** hours. The redirect URL returns a 404 response if used after the expiration period.
2518
- *
2519
- * Please note that asynchronous batch request is a long-running operation. Here's a typical sequence of operations:
2520
- * 1. Client sends a Route Directions Batch `POST` request to Azure Maps.
2521
- * ```
2522
- * POST https://atlas.microsoft.com/route/directions/batch/json?api-version=1.0&subscription-key={subscription-key}
2523
- * ```
2524
- * 2. The server will respond with one of the following:
2525
- *
2526
- * > HTTP `202 Accepted` - Batch request has been accepted.
2527
- *
2528
- * > HTTP `Error` - There was an error processing your Batch request. This could either be a `400 Bad Request` or any other `Error` status code.
2529
- *
2530
- * 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.
2531
- * This status URI looks like following:
2532
- * ```
2533
- * GET https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
2534
- * ```
2535
- * 4. Client issues a `GET` request on the _download URL_ obtained in Step 3 to download the batch results.
2536
- *
2537
- * ### POST Body for Batch Request
2538
- * 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:
2539
- *
2540
- *
2541
- * ```json
2542
- * {
2543
- * "batchItems": [
2544
- * { "query": "?query=47.620659,-122.348934:47.610101,-122.342015&travelMode=bicycle&routeType=eco&traffic=false" },
2545
- * { "query": "?query=40.759856,-73.985108:40.771136,-73.973506&travelMode=pedestrian&routeType=shortest" },
2546
- * { "query": "?query=48.923159,-122.557362:32.621279,-116.840362" }
2547
- * ]
2548
- * }
2549
- * ```
2550
- *
2551
- * 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.
2552
- *
2553
- *
2554
- * 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.
2555
- *
2556
- *
2557
- * ### Download Asynchronous Batch Results
2558
- * 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:
2559
- *
2560
- * ```
2561
- * https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
2562
- * ```
2563
- * Here's the typical sequence of operations for downloading the batch results:
2564
- * 1. Client sends a `GET` request using the _download URL_.
2565
- * 2. The server will respond with one of the following:
2566
- *
2567
- * > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time.
2568
- *
2569
- * > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results.
2570
- *
2571
- *
2572
- *
2573
- * ### Batch Response Model
2574
- * 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:
2575
- *
2576
- * - [`RouteDirections`](https://docs.microsoft.com/rest/api/maps/route/getroutedirections#routedirections) - If the query completed successfully.
2577
- *
2578
- * - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.
2579
- *
2580
- *
2581
- * Here's a sample Batch Response with 1 _successful_ and 1 _failed_ result:
2582
- *
2583
- *
2584
- * ```json
2585
- * {
2586
- * "summary": {
2587
- * "successfulRequests": 1,
2588
- * "totalRequests": 2
2589
- * },
2590
- * "batchItems": [
2591
- * {
2592
- * "statusCode": 200,
2593
- * "response": {
2594
- * "routes": [
2595
- * {
2596
- * "summary": {
2597
- * "lengthInMeters": 1758,
2598
- * "travelTimeInSeconds": 387,
2599
- * "trafficDelayInSeconds": 0,
2600
- * "departureTime": "2018-07-17T00:49:56+00:00",
2601
- * "arrivalTime": "2018-07-17T00:56:22+00:00"
2602
- * },
2603
- * "legs": [
2604
- * {
2605
- * "summary": {
2606
- * "lengthInMeters": 1758,
2607
- * "travelTimeInSeconds": 387,
2608
- * "trafficDelayInSeconds": 0,
2609
- * "departureTime": "2018-07-17T00:49:56+00:00",
2610
- * "arrivalTime": "2018-07-17T00:56:22+00:00"
2611
- * },
2612
- * "points": [
2613
- * {
2614
- * "latitude": 47.62094,
2615
- * "longitude": -122.34892
2616
- * },
2617
- * {
2618
- * "latitude": 47.62094,
2619
- * "longitude": -122.3485
2620
- * },
2621
- * {
2622
- * "latitude": 47.62095,
2623
- * "longitude": -122.3476
2624
- * }
2625
- * ]
2626
- * }
2627
- * ],
2628
- * "sections": [
2629
- * {
2630
- * "startPointIndex": 0,
2631
- * "endPointIndex": 40,
2632
- * "sectionType": "TRAVEL_MODE",
2633
- * "travelMode": "bicycle"
2634
- * }
2635
- * ]
2636
- * }
2637
- * ]
2638
- * }
2639
- * },
2640
- * {
2641
- * "statusCode": 400,
2642
- * "response":
2643
- * {
2644
- * "error":
2645
- * {
2646
- * "code": "400 BadRequest",
2647
- * "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
2648
- * }
2649
- * }
2650
- * }
2651
- * ]
2652
- * }
2653
- * ```
2654
- */
2655
- export declare interface RouteRequestRouteDirectionsBatch202Response extends HttpResponse {
2656
- status: "202";
2657
- headers: RawHttpHeaders & RouteRequestRouteDirectionsBatch202Headers;
2658
- }
2659
-
2660
- export declare interface RouteRequestRouteDirectionsBatchBodyParam {
2661
- /** The list of route directions queries/requests to process. The list can contain a max of 700 queries for async and 100 queries for sync version and must contain at least 1 query. */
2662
- body: BatchRequest;
2663
- }
2664
-
2665
- export declare interface RouteRequestRouteDirectionsBatchMediaTypesParam {
2666
- /** Request content type */
2667
- contentType?: "application/json";
2668
- }
2669
-
2670
- export declare type RouteRequestRouteDirectionsBatchParameters = RouteRequestRouteDirectionsBatchMediaTypesParam & RouteRequestRouteDirectionsBatchBodyParam & RequestParameters;
2671
-
2672
- /**
2673
- *
2674
- * 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).
2675
- * ### Submit Synchronous Batch Request
2676
- * 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.
2677
- * ```
2678
- * POST https://atlas.microsoft.com/route/directions/batch/sync/json?api-version=1.0&subscription-key={subscription-key}
2679
- * ```
2680
- * ### Batch Response Model
2681
- * 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:
2682
- *
2683
- * - [`RouteDirections`](https://docs.microsoft.com/rest/api/maps/route/getroutedirections#routedirections) - If the query completed successfully.
2684
- *
2685
- * - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.
2686
- *
2687
- *
2688
- * Here's a sample Batch Response with 1 _successful_ and 1 _failed_ result:
2689
- *
2690
- *
2691
- * ```json
2692
- * {
2693
- * "summary": {
2694
- * "successfulRequests": 1,
2695
- * "totalRequests": 2
2696
- * },
2697
- * "batchItems": [
2698
- * {
2699
- * "statusCode": 200,
2700
- * "response": {
2701
- * "routes": [
2702
- * {
2703
- * "summary": {
2704
- * "lengthInMeters": 1758,
2705
- * "travelTimeInSeconds": 387,
2706
- * "trafficDelayInSeconds": 0,
2707
- * "departureTime": "2018-07-17T00:49:56+00:00",
2708
- * "arrivalTime": "2018-07-17T00:56:22+00:00"
2709
- * },
2710
- * "legs": [
2711
- * {
2712
- * "summary": {
2713
- * "lengthInMeters": 1758,
2714
- * "travelTimeInSeconds": 387,
2715
- * "trafficDelayInSeconds": 0,
2716
- * "departureTime": "2018-07-17T00:49:56+00:00",
2717
- * "arrivalTime": "2018-07-17T00:56:22+00:00"
2718
- * },
2719
- * "points": [
2720
- * {
2721
- * "latitude": 47.62094,
2722
- * "longitude": -122.34892
2723
- * },
2724
- * {
2725
- * "latitude": 47.62094,
2726
- * "longitude": -122.3485
2727
- * },
2728
- * {
2729
- * "latitude": 47.62095,
2730
- * "longitude": -122.3476
2731
- * }
2732
- * ]
2733
- * }
2734
- * ],
2735
- * "sections": [
2736
- * {
2737
- * "startPointIndex": 0,
2738
- * "endPointIndex": 40,
2739
- * "sectionType": "TRAVEL_MODE",
2740
- * "travelMode": "bicycle"
2741
- * }
2742
- * ]
2743
- * }
2744
- * ]
2745
- * }
2746
- * },
2747
- * {
2748
- * "statusCode": 400,
2749
- * "response":
2750
- * {
2751
- * "error":
2752
- * {
2753
- * "code": "400 BadRequest",
2754
- * "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
2755
- * }
2756
- * }
2757
- * }
2758
- * ]
2759
- * }
2760
- * ```
2761
- */
2762
- export declare interface RouteRequestRouteDirectionsBatchSync200Response extends HttpResponse {
2763
- status: "200";
2764
- body: RouteDirectionsBatchResultOutput;
2765
- }
2766
-
2767
- /**
2768
- *
2769
- * 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).
2770
- * ### Submit Synchronous Batch Request
2771
- * 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.
2772
- * ```
2773
- * POST https://atlas.microsoft.com/route/directions/batch/sync/json?api-version=1.0&subscription-key={subscription-key}
2774
- * ```
2775
- * ### Batch Response Model
2776
- * 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:
2777
- *
2778
- * - [`RouteDirections`](https://docs.microsoft.com/rest/api/maps/route/getroutedirections#routedirections) - If the query completed successfully.
2779
- *
2780
- * - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.
2781
- *
2782
- *
2783
- * Here's a sample Batch Response with 1 _successful_ and 1 _failed_ result:
2784
- *
2785
- *
2786
- * ```json
2787
- * {
2788
- * "summary": {
2789
- * "successfulRequests": 1,
2790
- * "totalRequests": 2
2791
- * },
2792
- * "batchItems": [
2793
- * {
2794
- * "statusCode": 200,
2795
- * "response": {
2796
- * "routes": [
2797
- * {
2798
- * "summary": {
2799
- * "lengthInMeters": 1758,
2800
- * "travelTimeInSeconds": 387,
2801
- * "trafficDelayInSeconds": 0,
2802
- * "departureTime": "2018-07-17T00:49:56+00:00",
2803
- * "arrivalTime": "2018-07-17T00:56:22+00:00"
2804
- * },
2805
- * "legs": [
2806
- * {
2807
- * "summary": {
2808
- * "lengthInMeters": 1758,
2809
- * "travelTimeInSeconds": 387,
2810
- * "trafficDelayInSeconds": 0,
2811
- * "departureTime": "2018-07-17T00:49:56+00:00",
2812
- * "arrivalTime": "2018-07-17T00:56:22+00:00"
2813
- * },
2814
- * "points": [
2815
- * {
2816
- * "latitude": 47.62094,
2817
- * "longitude": -122.34892
2818
- * },
2819
- * {
2820
- * "latitude": 47.62094,
2821
- * "longitude": -122.3485
2822
- * },
2823
- * {
2824
- * "latitude": 47.62095,
2825
- * "longitude": -122.3476
2826
- * }
2827
- * ]
2828
- * }
2829
- * ],
2830
- * "sections": [
2831
- * {
2832
- * "startPointIndex": 0,
2833
- * "endPointIndex": 40,
2834
- * "sectionType": "TRAVEL_MODE",
2835
- * "travelMode": "bicycle"
2836
- * }
2837
- * ]
2838
- * }
2839
- * ]
2840
- * }
2841
- * },
2842
- * {
2843
- * "statusCode": 400,
2844
- * "response":
2845
- * {
2846
- * "error":
2847
- * {
2848
- * "code": "400 BadRequest",
2849
- * "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
2850
- * }
2851
- * }
2852
- * }
2853
- * ]
2854
- * }
2855
- * ```
2856
- */
2857
- export declare interface RouteRequestRouteDirectionsBatchSync408Response extends HttpResponse {
2858
- status: "408";
2859
- body: ErrorResponseOutput;
2860
- }
2861
-
2862
- export declare interface RouteRequestRouteDirectionsBatchSyncBodyParam {
2863
- /** The list of route directions queries/requests to process. The list can contain a max of 700 queries for async and 100 queries for sync version and must contain at least 1 query. */
2864
- body: BatchRequest;
2865
- }
2866
-
2867
- /**
2868
- *
2869
- * 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).
2870
- * ### Submit Synchronous Batch Request
2871
- * 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.
2872
- * ```
2873
- * POST https://atlas.microsoft.com/route/directions/batch/sync/json?api-version=1.0&subscription-key={subscription-key}
2874
- * ```
2875
- * ### Batch Response Model
2876
- * 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:
2877
- *
2878
- * - [`RouteDirections`](https://docs.microsoft.com/rest/api/maps/route/getroutedirections#routedirections) - If the query completed successfully.
2879
- *
2880
- * - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.
2881
- *
2882
- *
2883
- * Here's a sample Batch Response with 1 _successful_ and 1 _failed_ result:
2884
- *
2885
- *
2886
- * ```json
2887
- * {
2888
- * "summary": {
2889
- * "successfulRequests": 1,
2890
- * "totalRequests": 2
2891
- * },
2892
- * "batchItems": [
2893
- * {
2894
- * "statusCode": 200,
2895
- * "response": {
2896
- * "routes": [
2897
- * {
2898
- * "summary": {
2899
- * "lengthInMeters": 1758,
2900
- * "travelTimeInSeconds": 387,
2901
- * "trafficDelayInSeconds": 0,
2902
- * "departureTime": "2018-07-17T00:49:56+00:00",
2903
- * "arrivalTime": "2018-07-17T00:56:22+00:00"
2904
- * },
2905
- * "legs": [
2906
- * {
2907
- * "summary": {
2908
- * "lengthInMeters": 1758,
2909
- * "travelTimeInSeconds": 387,
2910
- * "trafficDelayInSeconds": 0,
2911
- * "departureTime": "2018-07-17T00:49:56+00:00",
2912
- * "arrivalTime": "2018-07-17T00:56:22+00:00"
2913
- * },
2914
- * "points": [
2915
- * {
2916
- * "latitude": 47.62094,
2917
- * "longitude": -122.34892
2918
- * },
2919
- * {
2920
- * "latitude": 47.62094,
2921
- * "longitude": -122.3485
2922
- * },
2923
- * {
2924
- * "latitude": 47.62095,
2925
- * "longitude": -122.3476
2926
- * }
2927
- * ]
2928
- * }
2929
- * ],
2930
- * "sections": [
2931
- * {
2932
- * "startPointIndex": 0,
2933
- * "endPointIndex": 40,
2934
- * "sectionType": "TRAVEL_MODE",
2935
- * "travelMode": "bicycle"
2936
- * }
2937
- * ]
2938
- * }
2939
- * ]
2940
- * }
2941
- * },
2942
- * {
2943
- * "statusCode": 400,
2944
- * "response":
2945
- * {
2946
- * "error":
2947
- * {
2948
- * "code": "400 BadRequest",
2949
- * "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
2950
- * }
2951
- * }
2952
- * }
2953
- * ]
2954
- * }
2955
- * ```
2956
- */
2957
- export declare interface RouteRequestRouteDirectionsBatchSyncDefaultResponse extends HttpResponse {
2958
- status: string;
2959
- body: ErrorResponseOutput;
2960
- }
2961
-
2962
- export declare interface RouteRequestRouteDirectionsBatchSyncMediaTypesParam {
2963
- /** Request content type */
2964
- contentType?: "application/json";
2965
- }
2966
-
2967
- export declare type RouteRequestRouteDirectionsBatchSyncParameters = RouteRequestRouteDirectionsBatchSyncMediaTypesParam & RouteRequestRouteDirectionsBatchSyncBodyParam & RequestParameters;
2968
-
2969
- /**
2970
- *
2971
- * 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.
2972
- *
2973
- *
2974
- * 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.
2975
- *
2976
- *
2977
- * 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).
2978
- *
2979
- * > [!NOTE]
2980
- * > 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.
2981
- *
2982
- *
2983
- *
2984
- * ### Submit Synchronous Route Matrix Request
2985
- * 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).
2986
- *
2987
- * ```
2988
- * POST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}
2989
- * ```
2990
- *
2991
- * ### Submit Asynchronous Route Matrix Request
2992
- * 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.
2993
- *
2994
- *
2995
- * 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).
2996
- *
2997
- *
2998
- * The asynchronous responses are stored for **24** hours. The redirect URL returns a 404 response if used after the expiration period.
2999
- *
3000
- *
3001
- *
3002
- *
3003
- * ```
3004
- * POST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}
3005
- * ```
3006
- *
3007
- * Here's a typical sequence of asynchronous operations:
3008
- * 1. Client sends a Route Matrix POST request to Azure Maps
3009
- *
3010
- * 2. The server will respond with one of the following:
3011
- *
3012
- * > HTTP `202 Accepted` - Route Matrix request has been accepted.
3013
- *
3014
- * > 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.
3015
- *
3016
- *
3017
- * 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:
3018
- *
3019
- * ```
3020
- * GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
3021
- * ```
3022
- *
3023
- *
3024
- * 4. Client issues a GET request on the download URL obtained in Step 3 to download the results
3025
- *
3026
- * ### Download Sync Results
3027
- * 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.
3028
- *
3029
- * ### Download Async Results
3030
- * 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:
3031
- * ```
3032
- * GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
3033
- * ```
3034
- *
3035
- * The URL provided by the location header will return the following responses when a `GET` request is issued.
3036
- *
3037
- * > HTTP `202 Accepted` - Matrix request was accepted but is still being processed. Please try again in some time.
3038
- *
3039
- * > HTTP `200 OK` - Matrix request successfully processed. The response body contains all of the results.
3040
- */
3041
- export declare interface RouteRequestRouteMatrix200Response extends HttpResponse {
3042
- status: "200";
3043
- body: RouteMatrixResultOutput;
3044
- }
3045
-
3046
- export declare interface RouteRequestRouteMatrix202Headers {
3047
- /** New URL to check for the results of the long-running operation. */
3048
- location?: string;
3049
- }
3050
-
3051
- /**
3052
- *
3053
- * 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.
3054
- *
3055
- *
3056
- * 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.
3057
- *
3058
- *
3059
- * 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).
3060
- *
3061
- * > [!NOTE]
3062
- * > 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.
3063
- *
3064
- *
3065
- *
3066
- * ### Submit Synchronous Route Matrix Request
3067
- * 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).
3068
- *
3069
- * ```
3070
- * POST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}
3071
- * ```
3072
- *
3073
- * ### Submit Asynchronous Route Matrix Request
3074
- * 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.
3075
- *
3076
- *
3077
- * 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).
3078
- *
3079
- *
3080
- * The asynchronous responses are stored for **24** hours. The redirect URL returns a 404 response if used after the expiration period.
3081
- *
3082
- *
3083
- *
3084
- *
3085
- * ```
3086
- * POST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}
3087
- * ```
3088
- *
3089
- * Here's a typical sequence of asynchronous operations:
3090
- * 1. Client sends a Route Matrix POST request to Azure Maps
3091
- *
3092
- * 2. The server will respond with one of the following:
3093
- *
3094
- * > HTTP `202 Accepted` - Route Matrix request has been accepted.
3095
- *
3096
- * > 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.
3097
- *
3098
- *
3099
- * 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:
3100
- *
3101
- * ```
3102
- * GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
3103
- * ```
3104
- *
3105
- *
3106
- * 4. Client issues a GET request on the download URL obtained in Step 3 to download the results
3107
- *
3108
- * ### Download Sync Results
3109
- * 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.
3110
- *
3111
- * ### Download Async Results
3112
- * 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:
3113
- * ```
3114
- * GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
3115
- * ```
3116
- *
3117
- * The URL provided by the location header will return the following responses when a `GET` request is issued.
3118
- *
3119
- * > HTTP `202 Accepted` - Matrix request was accepted but is still being processed. Please try again in some time.
3120
- *
3121
- * > HTTP `200 OK` - Matrix request successfully processed. The response body contains all of the results.
3122
- */
3123
- export declare interface RouteRequestRouteMatrix202Response extends HttpResponse {
3124
- status: "202";
3125
- headers: RawHttpHeaders & RouteRequestRouteMatrix202Headers;
3126
- }
3127
-
3128
- export declare interface RouteRequestRouteMatrixBodyParam {
3129
- /** The matrix of origin and destination coordinates to compute the route distance, travel time and other summary for each cell of the matrix based on the input parameters. The minimum and the maximum cell count supported are 1 and **700** for async and **100** for sync respectively. For example, it can be 35 origins and 20 destinations or 25 origins and 25 destinations for async API. */
3130
- body: RouteMatrixQuery;
3131
- }
3132
-
3133
- export declare interface RouteRequestRouteMatrixMediaTypesParam {
3134
- /** Request content type */
3135
- contentType?: "application/json";
3136
- }
3137
-
3138
- export declare type RouteRequestRouteMatrixParameters = RouteRequestRouteMatrixQueryParam & RouteRequestRouteMatrixMediaTypesParam & RouteRequestRouteMatrixBodyParam & RequestParameters;
3139
-
3140
- export declare interface RouteRequestRouteMatrixQueryParam {
3141
- queryParameters?: RouteRequestRouteMatrixQueryParamProperties;
3142
- }
3143
-
3144
- export declare interface RouteRequestRouteMatrixQueryParamProperties {
3145
- /** Boolean to indicate whether to execute the request synchronously. If set to true, user will get a 200 response if the request is finished under 120 seconds. Otherwise, user will get a 202 response right away. Please refer to the API description for more details on 202 response. **Supported only for async request**. */
3146
- waitForResults?: boolean;
3147
- /** Specifies whether to return additional travel times using different types of traffic information (none, historic, live) as well as the default best-estimate travel time. */
3148
- computeTravelTimeFor?: "none" | "all";
3149
- /** Specifies which of the section types is reported in the route response. <br><br>For example if sectionType = pedestrian the sections which are suited for pedestrians only are returned. Can be specified multiple times in one request, for example, '&sectionType=carTrain&sectionType=pedestrian&sectionType=motorway'. The default sectionType refers to the travelMode input. By default travelMode is set to car */
3150
- sectionType?: Array<"carTrain" | "country" | "ferry" | "motorway" | "pedestrian" | "tollRoad" | "tollVignette" | "traffic" | "travelMode" | "tunnel" | "carpool" | "urban">;
3151
- /**
3152
- * The date and time of arrival at the destination point formatted as a `dateTime` value as defined in [RFC 3339, section 5.6](https://www.rfc-editor.org/rfc/rfc3339#section-5.6), with an optional time zone offset. When a time zone offset is not specified it will be assumed to be that of the destination point.
3153
- *
3154
- * Examples:
3155
- * * 2023-12-19T16:39:57
3156
- * * 2023-12-19T16:39:57-08:00
3157
- *
3158
- * The `arriveAt` parameter cannot be used in conjunction with `departAt`, `minDeviationDistance` or `minDeviationTime`.
3159
- */
3160
- arriveAt?: Date | string;
3161
- /**
3162
- * The date and time of departure from the origin point formatted as a `dateTime` value as defined in [RFC 3339, section 5.6](https://www.rfc-editor.org/rfc/rfc3339#section-5.6), with an optional time zone offset. When a time zone offset is not specified, it will be assumed to be that of the origin point.
3163
- * * Default value: now
3164
- * * Other value: `dateTime`
3165
- *
3166
- * Examples:
3167
- * * 2023-12-19T16:39:57
3168
- * * 2023-12-19T16:39:57-08:00
3169
- *
3170
- * The `departAt` parameter cannot be used in conjunction with `arriveAt`.
3171
- */
3172
- departAt?: Date | string;
3173
- /** Weight per axle of the vehicle in kg. A value of 0 means that weight restrictions per axle are not considered. */
3174
- vehicleAxleWeight?: number;
3175
- /** Length of the vehicle in meters. A value of 0 means that length restrictions are not considered. */
3176
- vehicleLength?: number;
3177
- /** Height of the vehicle in meters. A value of 0 means that height restrictions are not considered. */
3178
- vehicleHeight?: number;
3179
- /** Width of the vehicle in meters. A value of 0 means that width restrictions are not considered. */
3180
- vehicleWidth?: number;
3181
- /**
3182
- * Maximum speed of the vehicle in km/hour. The max speed in the vehicle profile is used to check whether a vehicle is allowed on motorways.
3183
- *
3184
- * * A value of 0 means that an appropriate value for the vehicle will be determined and applied during route planning.
3185
- *
3186
- * * A non-zero value may be overridden during route planning. For example, the current traffic flow is 60 km/hour. If the vehicle maximum speed is set to 50 km/hour, the routing engine will consider 60 km/hour as this is the current situation. If the maximum speed of the vehicle is provided as 80 km/hour but the current traffic flow is 60 km/hour, then routing engine will again use 60 km/hour.
3187
- */
3188
- vehicleMaxSpeed?: number;
3189
- /** Weight of the vehicle in kilograms. */
3190
- vehicleWeight?: number;
3191
- /** Level of turns for thrilling route. This parameter can only be used in conjunction with `routeType`=thrilling. */
3192
- windingness?: "low" | "normal" | "high";
3193
- /** Degree of hilliness for thrilling route. This parameter can only be used in conjunction with `routeType`=thrilling. */
3194
- hilliness?: "low" | "normal" | "high";
3195
- /** The mode of travel for the requested route. If not defined, default is 'car'. Note that the requested travelMode may not be available for the entire route. Where the requested travelMode is not available for a particular section, the travelMode element of the response for that section will be "other". Note that travel modes bus, motorcycle, taxi and van are BETA functionality. Full restriction data is not available in all areas. */
3196
- travelMode?: "car" | "truck" | "taxi" | "bus" | "van" | "motorcycle" | "bicycle" | "pedestrian";
3197
- /** Specifies something that the route calculation should try to avoid when determining the route. Can be specified multiple times in one request, for example, '&avoid=motorways&avoid=tollRoads&avoid=ferries'. In Route Range requests, the value alreadyUsedRoads must not be used. */
3198
- avoid?: Array<"tollRoads" | "motorways" | "ferries" | "unpavedRoads" | "carpools" | "alreadyUsedRoads" | "borderCrossings">;
3199
- /**
3200
- * Possible values:
3201
- * * true - Do consider all available traffic information during routing
3202
- * * false - Ignore current traffic data during routing. Note that although the current traffic data is ignored
3203
- * during routing, the effect of historic traffic on effective road speeds is still incorporated.
3204
- */
3205
- traffic?: boolean;
3206
- /** The type of route requested. */
3207
- routeType?: "fastest" | "shortest" | "eco" | "thrilling";
3208
- /** Types of cargo that may be classified as hazardous materials and restricted from some roads. Available vehicleLoadType values are US Hazmat classes 1 through 9, plus generic classifications for use in other countries/regions. Values beginning with USHazmat are for US routing while otherHazmat should be used for all other countries/regions. vehicleLoadType can be specified multiple times. This parameter is currently only considered for travelMode=truck. */
3209
- vehicleLoadType?: "USHazmatClass1" | "USHazmatClass2" | "USHazmatClass3" | "USHazmatClass4" | "USHazmatClass5" | "USHazmatClass6" | "USHazmatClass7" | "USHazmatClass8" | "USHazmatClass9" | "otherHazmatExplosive" | "otherHazmatGeneral" | "otherHazmatHarmfulToWater";
3210
- }
3211
-
3212
- /**
3213
- *
3214
- * 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.
3215
- *
3216
- *
3217
- * 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.
3218
- *
3219
- *
3220
- * 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).
3221
- *
3222
- *
3223
- *
3224
- * ### Submit Synchronous Route Matrix Request
3225
- * 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).
3226
- *
3227
- * ```
3228
- * POST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}
3229
- * ```
3230
- *
3231
- * ### Submit Asynchronous Route Matrix Request
3232
- * 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.
3233
- *
3234
- *
3235
- * 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).
3236
- *
3237
- *
3238
- * The asynchronous responses are stored for **24** hours. The redirect URL returns a 404 response if used after the expiration period.
3239
- *
3240
- *
3241
- *
3242
- *
3243
- * ```
3244
- * POST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}
3245
- * ```
3246
- *
3247
- * Here's a typical sequence of asynchronous operations:
3248
- * 1. Client sends a Route Matrix POST request to Azure Maps
3249
- *
3250
- * 2. The server will respond with one of the following:
3251
- *
3252
- * > HTTP `202 Accepted` - Route Matrix request has been accepted.
3253
- *
3254
- * > 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.
3255
- *
3256
- *
3257
- * 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:
3258
- *
3259
- * ```
3260
- * GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
3261
- * ```
3262
- *
3263
- *
3264
- * 4. Client issues a GET request on the download URL obtained in Step 3 to download the results
3265
- *
3266
- * ### Download Sync Results
3267
- * 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.
3268
- *
3269
- * ### Download Async Results
3270
- * 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:
3271
- * ```
3272
- * GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
3273
- * ```
3274
- *
3275
- * The URL provided by the location header will return the following responses when a `GET` request is issued.
3276
- *
3277
- * > HTTP `202 Accepted` - Matrix request was accepted but is still being processed. Please try again in some time.
3278
- *
3279
- * > HTTP `200 OK` - Matrix request successfully processed. The response body contains all of the results.
3280
- */
3281
- export declare interface RouteRequestRouteMatrixSync200Response extends HttpResponse {
3282
- status: "200";
3283
- body: RouteMatrixResultOutput;
3284
- }
3285
-
3286
- /**
3287
- *
3288
- * 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.
3289
- *
3290
- *
3291
- * 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.
3292
- *
3293
- *
3294
- * 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).
3295
- *
3296
- *
3297
- *
3298
- * ### Submit Synchronous Route Matrix Request
3299
- * 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).
3300
- *
3301
- * ```
3302
- * POST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}
3303
- * ```
3304
- *
3305
- * ### Submit Asynchronous Route Matrix Request
3306
- * 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.
3307
- *
3308
- *
3309
- * 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).
3310
- *
3311
- *
3312
- * The asynchronous responses are stored for **24** hours. The redirect URL returns a 404 response if used after the expiration period.
3313
- *
3314
- *
3315
- *
3316
- *
3317
- * ```
3318
- * POST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}
3319
- * ```
3320
- *
3321
- * Here's a typical sequence of asynchronous operations:
3322
- * 1. Client sends a Route Matrix POST request to Azure Maps
3323
- *
3324
- * 2. The server will respond with one of the following:
3325
- *
3326
- * > HTTP `202 Accepted` - Route Matrix request has been accepted.
3327
- *
3328
- * > 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.
3329
- *
3330
- *
3331
- * 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:
3332
- *
3333
- * ```
3334
- * GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
3335
- * ```
3336
- *
3337
- *
3338
- * 4. Client issues a GET request on the download URL obtained in Step 3 to download the results
3339
- *
3340
- * ### Download Sync Results
3341
- * 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.
3342
- *
3343
- * ### Download Async Results
3344
- * 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:
3345
- * ```
3346
- * GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
3347
- * ```
3348
- *
3349
- * The URL provided by the location header will return the following responses when a `GET` request is issued.
3350
- *
3351
- * > HTTP `202 Accepted` - Matrix request was accepted but is still being processed. Please try again in some time.
3352
- *
3353
- * > HTTP `200 OK` - Matrix request successfully processed. The response body contains all of the results.
3354
- */
3355
- export declare interface RouteRequestRouteMatrixSync408Response extends HttpResponse {
3356
- status: "408";
3357
- body: ErrorResponseOutput;
3358
- }
3359
-
3360
- export declare interface RouteRequestRouteMatrixSyncBodyParam {
3361
- /** The matrix of origin and destination coordinates to compute the route distance, travel time and other summary for each cell of the matrix based on the input parameters. The minimum and the maximum cell count supported are 1 and **700** for async and **100** for sync respectively. For example, it can be 35 origins and 20 destinations or 25 origins and 25 destinations for async API. */
3362
- body: RouteMatrixQuery;
3363
- }
3364
-
3365
- /**
3366
- *
3367
- * 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.
3368
- *
3369
- *
3370
- * 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.
3371
- *
3372
- *
3373
- * 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).
3374
- *
3375
- *
3376
- *
3377
- * ### Submit Synchronous Route Matrix Request
3378
- * 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).
3379
- *
3380
- * ```
3381
- * POST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}
3382
- * ```
3383
- *
3384
- * ### Submit Asynchronous Route Matrix Request
3385
- * 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.
3386
- *
3387
- *
3388
- * 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).
3389
- *
3390
- *
3391
- * The asynchronous responses are stored for **24** hours. The redirect URL returns a 404 response if used after the expiration period.
3392
- *
3393
- *
3394
- *
3395
- *
3396
- * ```
3397
- * POST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}
3398
- * ```
3399
- *
3400
- * Here's a typical sequence of asynchronous operations:
3401
- * 1. Client sends a Route Matrix POST request to Azure Maps
3402
- *
3403
- * 2. The server will respond with one of the following:
3404
- *
3405
- * > HTTP `202 Accepted` - Route Matrix request has been accepted.
3406
- *
3407
- * > 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.
3408
- *
3409
- *
3410
- * 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:
3411
- *
3412
- * ```
3413
- * GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
3414
- * ```
3415
- *
3416
- *
3417
- * 4. Client issues a GET request on the download URL obtained in Step 3 to download the results
3418
- *
3419
- * ### Download Sync Results
3420
- * 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.
3421
- *
3422
- * ### Download Async Results
3423
- * 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:
3424
- * ```
3425
- * GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
3426
- * ```
3427
- *
3428
- * The URL provided by the location header will return the following responses when a `GET` request is issued.
3429
- *
3430
- * > HTTP `202 Accepted` - Matrix request was accepted but is still being processed. Please try again in some time.
3431
- *
3432
- * > HTTP `200 OK` - Matrix request successfully processed. The response body contains all of the results.
3433
- */
3434
- export declare interface RouteRequestRouteMatrixSyncDefaultResponse extends HttpResponse {
3435
- status: string;
3436
- body: ErrorResponseOutput;
3437
- }
3438
-
3439
- export declare interface RouteRequestRouteMatrixSyncMediaTypesParam {
3440
- /** Request content type */
3441
- contentType?: "application/json";
3442
- }
3443
-
3444
- export declare type RouteRequestRouteMatrixSyncParameters = RouteRequestRouteMatrixSyncQueryParam & RouteRequestRouteMatrixSyncMediaTypesParam & RouteRequestRouteMatrixSyncBodyParam & RequestParameters;
3445
-
3446
- export declare interface RouteRequestRouteMatrixSyncQueryParam {
3447
- queryParameters?: RouteRequestRouteMatrixSyncQueryParamProperties;
3448
- }
3449
-
3450
- export declare interface RouteRequestRouteMatrixSyncQueryParamProperties {
3451
- /** Boolean to indicate whether to execute the request synchronously. If set to true, user will get a 200 response if the request is finished under 120 seconds. Otherwise, user will get a 202 response right away. Please refer to the API description for more details on 202 response. **Supported only for async request**. */
3452
- waitForResults?: boolean;
3453
- /** Specifies whether to return additional travel times using different types of traffic information (none, historic, live) as well as the default best-estimate travel time. */
3454
- computeTravelTimeFor?: "none" | "all";
3455
- /** Specifies which of the section types is reported in the route response. <br><br>For example if sectionType = pedestrian the sections which are suited for pedestrians only are returned. Can be specified multiple times in one request, for example, '&sectionType=carTrain&sectionType=pedestrian&sectionType=motorway'. The default sectionType refers to the travelMode input. By default travelMode is set to car */
3456
- sectionType?: Array<"carTrain" | "country" | "ferry" | "motorway" | "pedestrian" | "tollRoad" | "tollVignette" | "traffic" | "travelMode" | "tunnel" | "carpool" | "urban">;
3457
- /**
3458
- * The date and time of arrival at the destination point formatted as a `dateTime` value as defined in [RFC 3339, section 5.6](https://www.rfc-editor.org/rfc/rfc3339#section-5.6), with an optional time zone offset. When a time zone offset is not specified it will be assumed to be that of the destination point.
3459
- *
3460
- * Examples:
3461
- * * 2023-12-19T16:39:57
3462
- * * 2023-12-19T16:39:57-08:00
3463
- *
3464
- * The `arriveAt` parameter cannot be used in conjunction with `departAt`, `minDeviationDistance` or `minDeviationTime`.
3465
- */
3466
- arriveAt?: Date | string;
3467
- /**
3468
- * The date and time of departure from the origin point formatted as a `dateTime` value as defined in [RFC 3339, section 5.6](https://www.rfc-editor.org/rfc/rfc3339#section-5.6), with an optional time zone offset. When a time zone offset is not specified, it will be assumed to be that of the origin point.
3469
- * * Default value: now
3470
- * * Other value: `dateTime`
3471
- *
3472
- * Examples:
3473
- * * 2023-12-19T16:39:57
3474
- * * 2023-12-19T16:39:57-08:00
3475
- *
3476
- * The `departAt` parameter cannot be used in conjunction with `arriveAt`.
3477
- */
3478
- departAt?: Date | string;
3479
- /** Weight per axle of the vehicle in kg. A value of 0 means that weight restrictions per axle are not considered. */
3480
- vehicleAxleWeight?: number;
3481
- /** Length of the vehicle in meters. A value of 0 means that length restrictions are not considered. */
3482
- vehicleLength?: number;
3483
- /** Height of the vehicle in meters. A value of 0 means that height restrictions are not considered. */
3484
- vehicleHeight?: number;
3485
- /** Width of the vehicle in meters. A value of 0 means that width restrictions are not considered. */
3486
- vehicleWidth?: number;
3487
- /**
3488
- * Maximum speed of the vehicle in km/hour. The max speed in the vehicle profile is used to check whether a vehicle is allowed on motorways.
3489
- *
3490
- * * A value of 0 means that an appropriate value for the vehicle will be determined and applied during route planning.
3491
- *
3492
- * * A non-zero value may be overridden during route planning. For example, the current traffic flow is 60 km/hour. If the vehicle maximum speed is set to 50 km/hour, the routing engine will consider 60 km/hour as this is the current situation. If the maximum speed of the vehicle is provided as 80 km/hour but the current traffic flow is 60 km/hour, then routing engine will again use 60 km/hour.
3493
- */
3494
- vehicleMaxSpeed?: number;
3495
- /** Weight of the vehicle in kilograms. */
3496
- vehicleWeight?: number;
3497
- /** Level of turns for thrilling route. This parameter can only be used in conjunction with `routeType`=thrilling. */
3498
- windingness?: "low" | "normal" | "high";
3499
- /** Degree of hilliness for thrilling route. This parameter can only be used in conjunction with `routeType`=thrilling. */
3500
- hilliness?: "low" | "normal" | "high";
3501
- /** The mode of travel for the requested route. If not defined, default is 'car'. Note that the requested travelMode may not be available for the entire route. Where the requested travelMode is not available for a particular section, the travelMode element of the response for that section will be "other". Note that travel modes bus, motorcycle, taxi and van are BETA functionality. Full restriction data is not available in all areas. */
3502
- travelMode?: "car" | "truck" | "taxi" | "bus" | "van" | "motorcycle" | "bicycle" | "pedestrian";
3503
- /** Specifies something that the route calculation should try to avoid when determining the route. Can be specified multiple times in one request, for example, '&avoid=motorways&avoid=tollRoads&avoid=ferries'. In Route Range requests, the value alreadyUsedRoads must not be used. */
3504
- avoid?: Array<"tollRoads" | "motorways" | "ferries" | "unpavedRoads" | "carpools" | "alreadyUsedRoads" | "borderCrossings">;
3505
- /**
3506
- * Possible values:
3507
- * * true - Do consider all available traffic information during routing
3508
- * * false - Ignore current traffic data during routing. Note that although the current traffic data is ignored
3509
- * during routing, the effect of historic traffic on effective road speeds is still incorporated.
3510
- */
3511
- traffic?: boolean;
3512
- /** The type of route requested. */
3513
- routeType?: "fastest" | "shortest" | "eco" | "thrilling";
3514
- /** Types of cargo that may be classified as hazardous materials and restricted from some roads. Available vehicleLoadType values are US Hazmat classes 1 through 9, plus generic classifications for use in other countries/regions. Values beginning with USHazmat are for US routing while otherHazmat should be used for all other countries/regions. vehicleLoadType can be specified multiple times. This parameter is currently only considered for travelMode=truck. */
3515
- vehicleLoadType?: "USHazmatClass1" | "USHazmatClass2" | "USHazmatClass3" | "USHazmatClass4" | "USHazmatClass5" | "USHazmatClass6" | "USHazmatClass7" | "USHazmatClass8" | "USHazmatClass9" | "otherHazmatExplosive" | "otherHazmatGeneral" | "otherHazmatHarmfulToWater";
3516
- }
3517
-
3518
- export declare interface Routes {
3519
- /** Resource for '/route/matrix/\{format\}' has methods for the following verbs: post, get */
3520
- (path: "/route/matrix/{format}", format: "json"): RequestRouteMatrix;
3521
- /** Resource for '/route/matrix/sync/\{format\}' has methods for the following verbs: post */
3522
- (path: "/route/matrix/sync/{format}", format: "json"): RequestRouteMatrixSync;
3523
- /** Resource for '/route/directions/\{format\}' has methods for the following verbs: get, post */
3524
- (path: "/route/directions/{format}", format: "json" | "xml"): GetRouteDirections;
3525
- /** Resource for '/route/range/\{format\}' has methods for the following verbs: get */
3526
- (path: "/route/range/{format}", format: "json" | "xml"): GetRouteRange;
3527
- /** Resource for '/route/directions/batch/\{format\}' has methods for the following verbs: post, get */
3528
- (path: "/route/directions/batch/{format}", format: "json"): RequestRouteDirectionsBatch;
3529
- /** Resource for '/route/directions/batch/sync/\{format\}' has methods for the following verbs: post */
3530
- (path: "/route/directions/batch/sync/{format}", format: "json"): RequestRouteDirectionsBatchSync;
3531
- }
3532
-
3533
- /** Route sections contain additional information about parts of a route. Each section contains at least the elements `startPointIndex`, `endPointIndex`, and `sectionType`. */
3534
- export declare interface RouteSectionOutput {
3535
- /** Index of the first point (offset 0) in the route this section applies to. */
3536
- readonly startPointIndex: number;
3537
- /** Index of the last point (offset 0) in the route this section applies to. */
3538
- readonly endPointIndex: number;
3539
- /** Section types of the reported route response */
3540
- readonly sectionType: "CAR_TRAIN" | "COUNTRY" | "FERRY" | "MOTORWAY" | "PEDESTRIAN" | "TOLL_ROAD" | "TOLL_VIGNETTE" | "TRAFFIC" | "TRAVEL_MODE" | "TUNNEL" | "CARPOOL" | "URBAN";
3541
- /** Travel mode for the calculated route. The value will be set to `other` if the requested mode of transport is not possible in this section */
3542
- readonly travelMode?: "car" | "truck" | "taxi" | "bus" | "van" | "motorcycle" | "bicycle" | "pedestrian" | "other";
3543
- /** Type of the incident. Can currently be JAM, ROAD_WORK, ROAD_CLOSURE, or OTHER. See "tec" for detailed information. */
3544
- readonly simpleCategory?: "JAM" | "ROAD_WORK" | "ROAD_CLOSURE" | "OTHER";
3545
- /** Effective speed of the incident in km/h, averaged over its entire length. */
3546
- readonly effectiveSpeedInKmh?: number;
3547
- /** Delay in seconds caused by the incident. */
3548
- readonly delayInSeconds?: number;
3549
- /** The magnitude of delay caused by the incident. These values correspond to the values of the response field ty of the [Get Traffic Incident Detail API](https://docs.microsoft.com/rest/api/maps/traffic/gettrafficincidentdetail). */
3550
- readonly magnitudeOfDelay?: "0" | "1" | "2" | "3" | "4";
3551
- /** Details of the traffic event, using definitions in the [TPEG2-TEC](https://www.iso.org/standard/63116.html) standard. Can contain effectCode and causes elements. */
3552
- tec?: RouteSectionTecOutput;
3553
- }
3554
-
3555
- /** The cause of the traffic event. Can contain mainCauseCode and subCauseCode elements. Can be used to define iconography and descriptions. */
3556
- export declare interface RouteSectionTecCauseOutput {
3557
- /** The main cause of the traffic event. Contains a value in the tec002:CauseCode table, as defined in the [TPEG2-TEC](https://www.iso.org/standard/63116.html) standard. */
3558
- readonly mainCauseCode?: number;
3559
- /** The subcause of the traffic event. Contains a value in the sub cause table defined by the mainCauseCode, as defined in the [TPEG2-TEC](https://www.iso.org/standard/63116.html) standard. */
3560
- readonly subCauseCode?: number;
3561
- }
3562
-
3563
- /** Details of the traffic event, using definitions in the [TPEG2-TEC](https://www.iso.org/standard/63116.html) standard. Can contain effectCode and causes elements. */
3564
- export declare interface RouteSectionTecOutput {
3565
- /** The effect on the traffic flow. Contains a value in the tec001:EffectCode table, as defined in the [TPEG2-TEC](https://www.iso.org/standard/63116.html) standard. Can be used to color-code traffic events according to severity. */
3566
- readonly effectCode?: number;
3567
- /** Causes array */
3568
- causes?: Array<RouteSectionTecCauseOutput>;
3569
- }
3570
-
3571
- /** Summary object */
3572
- export declare interface RouteSummaryOutput {
3573
- /** Length In Meters property */
3574
- readonly lengthInMeters: number;
3575
- /** Estimated travel time in seconds property that includes the delay due to real-time traffic. Note that even when traffic=false travelTimeInSeconds still includes the delay due to traffic. If DepartAt is in the future, travel time is calculated using time-dependent historic traffic data. */
3576
- readonly travelTimeInSeconds: number;
3577
- /** Estimated delay in seconds caused by the real-time incident(s) according to traffic information. For routes planned with departure time in the future, delays is always 0. To return additional travel times using different types of traffic information, parameter computeTravelTimeFor=all needs to be added. */
3578
- readonly trafficDelayInSeconds: number;
3579
- /** The estimated departure time for the route or leg. Time is in UTC. */
3580
- readonly departureTime: string;
3581
- /** The estimated arrival time for the route or leg. Time is in UTC. */
3582
- readonly arrivalTime: string;
3583
- }
3584
-
3585
- /**
3586
- * A simple poller that can be used to poll a long running operation.
3587
- */
3588
- export declare interface SimplePollerLike<TState extends OperationState<TResult>, TResult> {
3589
- /**
3590
- * Returns true if the poller has finished polling.
3591
- */
3592
- isDone(): boolean;
3593
- /**
3594
- * Returns the state of the operation.
3595
- */
3596
- getOperationState(): TState;
3597
- /**
3598
- * Returns the result value of the operation,
3599
- * regardless of the state of the poller.
3600
- * It can return undefined or an incomplete form of the final TResult value
3601
- * depending on the implementation.
3602
- */
3603
- getResult(): TResult | undefined;
3604
- /**
3605
- * Returns a promise that will resolve once a single polling request finishes.
3606
- * It does this by calling the update method of the Poller's operation.
3607
- */
3608
- poll(options?: {
3609
- abortSignal?: AbortSignalLike;
3610
- }): Promise<TState>;
3611
- /**
3612
- * Returns a promise that will resolve once the underlying operation is completed.
3613
- */
3614
- pollUntilDone(pollOptions?: {
3615
- abortSignal?: AbortSignalLike;
3616
- }): Promise<TResult>;
3617
- /**
3618
- * Invokes the provided callback after each polling is completed,
3619
- * sending the current state of the poller's operation.
3620
- *
3621
- * It returns a method that can be used to stop receiving updates on the given callback function.
3622
- */
3623
- onProgress(callback: (state: TState) => void): CancelOnProgress;
3624
- /**
3625
- * Returns a promise that could be used for serialized version of the poller's operation
3626
- * by invoking the operation's serialize method.
3627
- */
3628
- serialize(): Promise<string>;
3629
- /**
3630
- * Wait the poller to be submitted.
3631
- */
3632
- submitted(): Promise<void>;
3633
- /**
3634
- * Returns a string representation of the poller's operation. Similar to serialize but returns a string.
3635
- * @deprecated Use serialize() instead.
3636
- */
3637
- toString(): string;
3638
- /**
3639
- * Stops the poller from continuing to poll. Please note this will only stop the client-side polling
3640
- * @deprecated Use abortSignal to stop polling instead.
3641
- */
3642
- stopPolling(): void;
3643
- /**
3644
- * Returns true if the poller is stopped.
3645
- * @deprecated Use abortSignal status to track this instead.
3646
- */
3647
- isStopped(): boolean;
3648
- }
3649
-
3650
- /**
3651
- * Transform an array of [Latitude, Longtitute] to a string in the following format:
3652
- * "Latitude_1,Longtitute_1:Latitude_2,Longtitute_2:..."
3653
- *
3654
- * @param coordinates - An array of Latitude/Longtitute pair to transform.
3655
- * @returns The transformed string.
3656
- */
3657
- export declare function toColonDelimitedLatLonString(coordinates: LatLon[]): string;
3658
-
3659
- export { }