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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (240) hide show
  1. package/LICENSE +4 -4
  2. package/README.md +49 -35
  3. package/dist/browser/generated/clientDefinitions.d.ts +617 -0
  4. package/dist/browser/generated/clientDefinitions.d.ts.map +1 -0
  5. package/dist/browser/generated/clientDefinitions.js +4 -0
  6. package/dist/browser/generated/clientDefinitions.js.map +1 -0
  7. package/dist/browser/generated/index.d.ts +12 -0
  8. package/dist/browser/generated/index.d.ts.map +1 -0
  9. package/dist/browser/generated/index.js +14 -0
  10. package/dist/browser/generated/index.js.map +1 -0
  11. package/dist/browser/generated/isUnexpected.d.ts +7 -0
  12. package/dist/browser/generated/isUnexpected.d.ts.map +1 -0
  13. package/dist/browser/generated/isUnexpected.js +79 -0
  14. package/dist/browser/generated/isUnexpected.js.map +1 -0
  15. package/dist/browser/generated/logger.d.ts +2 -0
  16. package/dist/browser/generated/logger.d.ts.map +1 -0
  17. package/dist/browser/generated/logger.js +5 -0
  18. package/dist/browser/generated/logger.js.map +1 -0
  19. package/dist/browser/generated/mapsRouteClient.d.ts +15 -0
  20. package/dist/browser/generated/mapsRouteClient.d.ts.map +1 -0
  21. package/dist/browser/generated/mapsRouteClient.js +42 -0
  22. package/dist/browser/generated/mapsRouteClient.js.map +1 -0
  23. package/dist/browser/generated/models.d.ts +130 -0
  24. package/dist/browser/generated/models.d.ts.map +1 -0
  25. package/dist/browser/generated/models.js +4 -0
  26. package/dist/browser/generated/models.js.map +1 -0
  27. package/dist/browser/generated/outputModels.d.ts +286 -0
  28. package/dist/browser/generated/outputModels.d.ts.map +1 -0
  29. package/dist/browser/generated/outputModels.js +4 -0
  30. package/dist/browser/generated/outputModels.js.map +1 -0
  31. package/dist/browser/generated/parameters.d.ts +937 -0
  32. package/dist/browser/generated/parameters.d.ts.map +1 -0
  33. package/dist/browser/generated/parameters.js +4 -0
  34. package/dist/browser/generated/parameters.js.map +1 -0
  35. package/dist/browser/generated/pollingHelper.d.ts +76 -0
  36. package/dist/browser/generated/pollingHelper.d.ts.map +1 -0
  37. package/dist/browser/generated/pollingHelper.js +105 -0
  38. package/dist/browser/generated/pollingHelper.js.map +1 -0
  39. package/dist/browser/generated/responses.d.ts +1409 -0
  40. package/dist/browser/generated/responses.d.ts.map +1 -0
  41. package/dist/browser/generated/responses.js +4 -0
  42. package/dist/browser/generated/responses.js.map +1 -0
  43. package/dist/browser/generated/serializeHelper.d.ts +2 -0
  44. package/dist/browser/generated/serializeHelper.d.ts.map +1 -0
  45. package/dist/browser/generated/serializeHelper.js +13 -0
  46. package/dist/browser/generated/serializeHelper.js.map +1 -0
  47. package/dist/browser/helpers.d.ts +18 -0
  48. package/dist/browser/helpers.d.ts.map +1 -0
  49. package/dist/browser/helpers.js.map +1 -0
  50. package/dist/browser/index.d.ts +5 -0
  51. package/dist/browser/index.d.ts.map +1 -0
  52. package/dist/browser/index.js +7 -0
  53. package/dist/browser/index.js.map +1 -0
  54. package/dist/browser/mapsRoute.d.ts +53 -0
  55. package/dist/browser/mapsRoute.d.ts.map +1 -0
  56. package/{dist-esm/src → dist/browser}/mapsRoute.js +1 -1
  57. package/dist/browser/mapsRoute.js.map +1 -0
  58. package/dist/browser/package.json +3 -0
  59. package/dist/commonjs/generated/clientDefinitions.d.ts +617 -0
  60. package/dist/commonjs/generated/clientDefinitions.d.ts.map +1 -0
  61. package/dist/commonjs/generated/clientDefinitions.js +5 -0
  62. package/dist/commonjs/generated/clientDefinitions.js.map +1 -0
  63. package/dist/commonjs/generated/index.d.ts +12 -0
  64. package/dist/commonjs/generated/index.d.ts.map +1 -0
  65. package/dist/commonjs/generated/index.js +17 -0
  66. package/dist/commonjs/generated/index.js.map +1 -0
  67. package/dist/commonjs/generated/isUnexpected.d.ts +7 -0
  68. package/dist/commonjs/generated/isUnexpected.d.ts.map +1 -0
  69. package/dist/commonjs/generated/isUnexpected.js +82 -0
  70. package/dist/commonjs/generated/isUnexpected.js.map +1 -0
  71. package/dist/commonjs/generated/logger.d.ts +2 -0
  72. package/dist/commonjs/generated/logger.d.ts.map +1 -0
  73. package/dist/commonjs/generated/logger.js +8 -0
  74. package/dist/commonjs/generated/logger.js.map +1 -0
  75. package/dist/commonjs/generated/mapsRouteClient.d.ts +15 -0
  76. package/dist/commonjs/generated/mapsRouteClient.d.ts.map +1 -0
  77. package/dist/commonjs/generated/mapsRouteClient.js +45 -0
  78. package/dist/commonjs/generated/mapsRouteClient.js.map +1 -0
  79. package/dist/commonjs/generated/models.d.ts +130 -0
  80. package/dist/commonjs/generated/models.d.ts.map +1 -0
  81. package/dist/commonjs/generated/models.js +5 -0
  82. package/dist/commonjs/generated/models.js.map +1 -0
  83. package/dist/commonjs/generated/outputModels.d.ts +286 -0
  84. package/dist/commonjs/generated/outputModels.d.ts.map +1 -0
  85. package/dist/commonjs/generated/outputModels.js +5 -0
  86. package/dist/commonjs/generated/outputModels.js.map +1 -0
  87. package/dist/commonjs/generated/parameters.d.ts +937 -0
  88. package/dist/commonjs/generated/parameters.d.ts.map +1 -0
  89. package/dist/commonjs/generated/parameters.js +5 -0
  90. package/dist/commonjs/generated/parameters.js.map +1 -0
  91. package/dist/commonjs/generated/pollingHelper.d.ts +76 -0
  92. package/dist/commonjs/generated/pollingHelper.d.ts.map +1 -0
  93. package/dist/commonjs/generated/pollingHelper.js +108 -0
  94. package/dist/commonjs/generated/pollingHelper.js.map +1 -0
  95. package/dist/commonjs/generated/responses.d.ts +1409 -0
  96. package/dist/commonjs/generated/responses.d.ts.map +1 -0
  97. package/dist/commonjs/generated/responses.js +5 -0
  98. package/dist/commonjs/generated/responses.js.map +1 -0
  99. package/dist/commonjs/generated/serializeHelper.d.ts +2 -0
  100. package/dist/commonjs/generated/serializeHelper.d.ts.map +1 -0
  101. package/dist/commonjs/generated/serializeHelper.js +16 -0
  102. package/dist/commonjs/generated/serializeHelper.js.map +1 -0
  103. package/dist/commonjs/helpers.d.ts +18 -0
  104. package/dist/commonjs/helpers.d.ts.map +1 -0
  105. package/dist/commonjs/helpers.js +47 -0
  106. package/dist/commonjs/helpers.js.map +1 -0
  107. package/dist/commonjs/index.d.ts +5 -0
  108. package/dist/commonjs/index.d.ts.map +1 -0
  109. package/dist/commonjs/index.js +10 -0
  110. package/dist/commonjs/index.js.map +1 -0
  111. package/dist/commonjs/mapsRoute.d.ts +53 -0
  112. package/dist/commonjs/mapsRoute.d.ts.map +1 -0
  113. package/dist/commonjs/mapsRoute.js +44 -0
  114. package/dist/commonjs/mapsRoute.js.map +1 -0
  115. package/dist/commonjs/package.json +3 -0
  116. package/dist/commonjs/tsdoc-metadata.json +11 -0
  117. package/dist/esm/generated/clientDefinitions.d.ts +617 -0
  118. package/dist/esm/generated/clientDefinitions.d.ts.map +1 -0
  119. package/dist/esm/generated/clientDefinitions.js +4 -0
  120. package/dist/esm/generated/clientDefinitions.js.map +1 -0
  121. package/dist/esm/generated/index.d.ts +12 -0
  122. package/dist/esm/generated/index.d.ts.map +1 -0
  123. package/dist/esm/generated/index.js +14 -0
  124. package/dist/esm/generated/index.js.map +1 -0
  125. package/dist/esm/generated/isUnexpected.d.ts +7 -0
  126. package/dist/esm/generated/isUnexpected.d.ts.map +1 -0
  127. package/dist/esm/generated/isUnexpected.js +79 -0
  128. package/dist/esm/generated/isUnexpected.js.map +1 -0
  129. package/dist/esm/generated/logger.d.ts +2 -0
  130. package/dist/esm/generated/logger.d.ts.map +1 -0
  131. package/dist/esm/generated/logger.js +5 -0
  132. package/dist/esm/generated/logger.js.map +1 -0
  133. package/dist/esm/generated/mapsRouteClient.d.ts +15 -0
  134. package/dist/esm/generated/mapsRouteClient.d.ts.map +1 -0
  135. package/dist/esm/generated/mapsRouteClient.js +42 -0
  136. package/dist/esm/generated/mapsRouteClient.js.map +1 -0
  137. package/dist/esm/generated/models.d.ts +130 -0
  138. package/dist/esm/generated/models.d.ts.map +1 -0
  139. package/dist/esm/generated/models.js +4 -0
  140. package/dist/esm/generated/models.js.map +1 -0
  141. package/dist/esm/generated/outputModels.d.ts +286 -0
  142. package/dist/esm/generated/outputModels.d.ts.map +1 -0
  143. package/dist/esm/generated/outputModels.js +4 -0
  144. package/dist/esm/generated/outputModels.js.map +1 -0
  145. package/dist/esm/generated/parameters.d.ts +937 -0
  146. package/dist/esm/generated/parameters.d.ts.map +1 -0
  147. package/dist/esm/generated/parameters.js +4 -0
  148. package/dist/esm/generated/parameters.js.map +1 -0
  149. package/dist/esm/generated/pollingHelper.d.ts +76 -0
  150. package/dist/esm/generated/pollingHelper.d.ts.map +1 -0
  151. package/dist/esm/generated/pollingHelper.js +105 -0
  152. package/dist/esm/generated/pollingHelper.js.map +1 -0
  153. package/dist/esm/generated/responses.d.ts +1409 -0
  154. package/dist/esm/generated/responses.d.ts.map +1 -0
  155. package/dist/esm/generated/responses.js +4 -0
  156. package/dist/esm/generated/responses.js.map +1 -0
  157. package/dist/esm/generated/serializeHelper.d.ts +2 -0
  158. package/dist/esm/generated/serializeHelper.d.ts.map +1 -0
  159. package/dist/esm/generated/serializeHelper.js +13 -0
  160. package/dist/esm/generated/serializeHelper.js.map +1 -0
  161. package/dist/esm/helpers.d.ts +18 -0
  162. package/dist/esm/helpers.d.ts.map +1 -0
  163. package/dist/esm/helpers.js +43 -0
  164. package/dist/esm/helpers.js.map +1 -0
  165. package/dist/esm/index.d.ts +5 -0
  166. package/dist/esm/index.d.ts.map +1 -0
  167. package/dist/esm/index.js +7 -0
  168. package/dist/esm/index.js.map +1 -0
  169. package/dist/esm/mapsRoute.d.ts +53 -0
  170. package/dist/esm/mapsRoute.d.ts.map +1 -0
  171. package/dist/esm/mapsRoute.js +40 -0
  172. package/dist/esm/mapsRoute.js.map +1 -0
  173. package/dist/esm/package.json +3 -0
  174. package/dist/react-native/generated/clientDefinitions.d.ts +617 -0
  175. package/dist/react-native/generated/clientDefinitions.d.ts.map +1 -0
  176. package/dist/react-native/generated/clientDefinitions.js +4 -0
  177. package/dist/react-native/generated/clientDefinitions.js.map +1 -0
  178. package/dist/react-native/generated/index.d.ts +12 -0
  179. package/dist/react-native/generated/index.d.ts.map +1 -0
  180. package/dist/react-native/generated/index.js +14 -0
  181. package/dist/react-native/generated/index.js.map +1 -0
  182. package/dist/react-native/generated/isUnexpected.d.ts +7 -0
  183. package/dist/react-native/generated/isUnexpected.d.ts.map +1 -0
  184. package/dist/react-native/generated/isUnexpected.js +79 -0
  185. package/dist/react-native/generated/isUnexpected.js.map +1 -0
  186. package/dist/react-native/generated/logger.d.ts +2 -0
  187. package/dist/react-native/generated/logger.d.ts.map +1 -0
  188. package/dist/react-native/generated/logger.js +5 -0
  189. package/dist/react-native/generated/logger.js.map +1 -0
  190. package/dist/react-native/generated/mapsRouteClient.d.ts +15 -0
  191. package/dist/react-native/generated/mapsRouteClient.d.ts.map +1 -0
  192. package/dist/react-native/generated/mapsRouteClient.js +42 -0
  193. package/dist/react-native/generated/mapsRouteClient.js.map +1 -0
  194. package/dist/react-native/generated/models.d.ts +130 -0
  195. package/dist/react-native/generated/models.d.ts.map +1 -0
  196. package/dist/react-native/generated/models.js +4 -0
  197. package/dist/react-native/generated/models.js.map +1 -0
  198. package/dist/react-native/generated/outputModels.d.ts +286 -0
  199. package/dist/react-native/generated/outputModels.d.ts.map +1 -0
  200. package/dist/react-native/generated/outputModels.js +4 -0
  201. package/dist/react-native/generated/outputModels.js.map +1 -0
  202. package/dist/react-native/generated/parameters.d.ts +937 -0
  203. package/dist/react-native/generated/parameters.d.ts.map +1 -0
  204. package/dist/react-native/generated/parameters.js +4 -0
  205. package/dist/react-native/generated/parameters.js.map +1 -0
  206. package/dist/react-native/generated/pollingHelper.d.ts +76 -0
  207. package/dist/react-native/generated/pollingHelper.d.ts.map +1 -0
  208. package/dist/react-native/generated/pollingHelper.js +105 -0
  209. package/dist/react-native/generated/pollingHelper.js.map +1 -0
  210. package/dist/react-native/generated/responses.d.ts +1409 -0
  211. package/dist/react-native/generated/responses.d.ts.map +1 -0
  212. package/dist/react-native/generated/responses.js +4 -0
  213. package/dist/react-native/generated/responses.js.map +1 -0
  214. package/dist/react-native/generated/serializeHelper.d.ts +2 -0
  215. package/dist/react-native/generated/serializeHelper.d.ts.map +1 -0
  216. package/dist/react-native/generated/serializeHelper.js +13 -0
  217. package/dist/react-native/generated/serializeHelper.js.map +1 -0
  218. package/dist/react-native/helpers.d.ts +18 -0
  219. package/dist/react-native/helpers.d.ts.map +1 -0
  220. package/dist/react-native/helpers.js +43 -0
  221. package/dist/react-native/helpers.js.map +1 -0
  222. package/dist/react-native/index.d.ts +5 -0
  223. package/dist/react-native/index.d.ts.map +1 -0
  224. package/dist/react-native/index.js +7 -0
  225. package/dist/react-native/index.js.map +1 -0
  226. package/dist/react-native/mapsRoute.d.ts +53 -0
  227. package/dist/react-native/mapsRoute.d.ts.map +1 -0
  228. package/dist/react-native/mapsRoute.js +40 -0
  229. package/dist/react-native/mapsRoute.js.map +1 -0
  230. package/dist/react-native/package.json +3 -0
  231. package/package.json +70 -49
  232. package/dist/index.js +0 -340
  233. package/dist/index.js.map +0 -1
  234. package/dist-esm/src/helpers.js.map +0 -1
  235. package/dist-esm/src/index.js +0 -7
  236. package/dist-esm/src/index.js.map +0 -1
  237. package/dist-esm/src/mapsRoute.js.map +0 -1
  238. package/review/maps-route.api.md +0 -934
  239. package/types/maps-route-rest.d.ts +0 -3659
  240. /package/{dist-esm/src → dist/browser}/helpers.js +0 -0
@@ -0,0 +1,286 @@
1
+ /** 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. */
2
+ export interface RouteMatrixResultOutput {
3
+ /** Format Version property */
4
+ readonly formatVersion?: string;
5
+ /** Results as a 2 dimensional array of route summaries. */
6
+ readonly matrix: Array<Array<RouteMatrixOutput>>;
7
+ /** Summary object */
8
+ readonly summary: RouteMatrixSummaryOutput;
9
+ }
10
+ /** Matrix result object */
11
+ export interface RouteMatrixOutput {
12
+ /** StatusCode property for the current cell in the input matrix. */
13
+ readonly statusCode: number;
14
+ /** Response object of the current cell in the input matrix. */
15
+ readonly response?: RouteMatrixResultResponseOutput;
16
+ }
17
+ /** Response object of the current cell in the input matrix. */
18
+ export interface RouteMatrixResultResponseOutput {
19
+ /** Summary object */
20
+ readonly routeSummary?: RouteSummaryOutput;
21
+ }
22
+ /** Summary object */
23
+ export interface RouteSummaryOutput {
24
+ /** Length In Meters property */
25
+ readonly lengthInMeters: number;
26
+ /** 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. */
27
+ readonly travelTimeInSeconds: number;
28
+ /** 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. */
29
+ readonly trafficDelayInSeconds: number;
30
+ /** The estimated departure time for the route or leg. Time is in UTC. */
31
+ readonly departureTime: string;
32
+ /** The estimated arrival time for the route or leg. Time is in UTC. */
33
+ readonly arrivalTime: string;
34
+ }
35
+ /** Summary object */
36
+ export interface RouteMatrixSummaryOutput {
37
+ /** Number of successful routes in the response. */
38
+ readonly successfulRoutes: number;
39
+ /** Total number of routes requested. Number of cells in the input matrix. */
40
+ readonly totalRoutes: number;
41
+ }
42
+ /** Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.). */
43
+ export interface ErrorResponseOutput {
44
+ /** The error object. */
45
+ error?: ErrorDetailOutput;
46
+ }
47
+ /** The error detail. */
48
+ export interface ErrorDetailOutput {
49
+ /** The error code. */
50
+ readonly code?: string;
51
+ /** The error message. */
52
+ readonly message?: string;
53
+ }
54
+ /** This object is returned from a successful Route Directions call */
55
+ export interface RouteDirectionsOutput {
56
+ /** Format Version property */
57
+ readonly formatVersion?: string;
58
+ /** Routes array */
59
+ readonly routes: Array<RouteOutput>;
60
+ /**
61
+ * Optimized sequence of waypoints. It shows the index from the user provided waypoint sequence for the original and optimized list. For instance, a response:
62
+ *
63
+ * ```
64
+ * <optimizedWaypoints>
65
+ * <waypoint providedIndex="0" optimizedIndex="1"/>
66
+ * <waypoint providedIndex="1" optimizedIndex="2"/>
67
+ * <waypoint providedIndex="2" optimizedIndex="0"/>
68
+ * </optimizedWaypoints>
69
+ * ```
70
+ *
71
+ * 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".
72
+ */
73
+ readonly optimizedWaypoints?: Array<RouteOptimizedWaypointOutput>;
74
+ /** Reports the effective settings used in the current call. */
75
+ report?: RouteReportOutput;
76
+ }
77
+ export interface RouteOutput {
78
+ /** Summary object */
79
+ readonly summary: RouteSummaryOutput;
80
+ /** Legs array */
81
+ readonly legs: Array<RouteLegOutput>;
82
+ /** Sections array */
83
+ readonly sections?: Array<RouteSectionOutput>;
84
+ /** Contains guidance related elements. This field is present only when guidance was requested and is available. */
85
+ readonly guidance?: RouteGuidanceOutput;
86
+ }
87
+ /** 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. */
88
+ export interface RouteLegOutput {
89
+ /** Summary object */
90
+ readonly summary: RouteSummaryOutput;
91
+ /** Points array */
92
+ readonly points: Array<LatLongPairOutput>;
93
+ }
94
+ /** A location represented as a latitude and longitude. */
95
+ export interface LatLongPairOutput {
96
+ /** Latitude property */
97
+ latitude: number;
98
+ /** Longitude property */
99
+ longitude: number;
100
+ }
101
+ /** Route sections contain additional information about parts of a route. Each section contains at least the elements `startPointIndex`, `endPointIndex`, and `sectionType`. */
102
+ export interface RouteSectionOutput {
103
+ /** Index of the first point (offset 0) in the route this section applies to. */
104
+ readonly startPointIndex: number;
105
+ /** Index of the last point (offset 0) in the route this section applies to. */
106
+ readonly endPointIndex: number;
107
+ /** Section types of the reported route response */
108
+ readonly sectionType: "CAR_TRAIN" | "COUNTRY" | "FERRY" | "MOTORWAY" | "PEDESTRIAN" | "TOLL_ROAD" | "TOLL_VIGNETTE" | "TRAFFIC" | "TRAVEL_MODE" | "TUNNEL" | "CARPOOL" | "URBAN";
109
+ /** 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 */
110
+ readonly travelMode?: "car" | "truck" | "taxi" | "bus" | "van" | "motorcycle" | "bicycle" | "pedestrian" | "other";
111
+ /** Type of the incident. Can currently be JAM, ROAD_WORK, ROAD_CLOSURE, or OTHER. See "tec" for detailed information. */
112
+ readonly simpleCategory?: "JAM" | "ROAD_WORK" | "ROAD_CLOSURE" | "OTHER";
113
+ /** Effective speed of the incident in km/h, averaged over its entire length. */
114
+ readonly effectiveSpeedInKmh?: number;
115
+ /** Delay in seconds caused by the incident. */
116
+ readonly delayInSeconds?: number;
117
+ /** 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). */
118
+ readonly magnitudeOfDelay?: "0" | "1" | "2" | "3" | "4";
119
+ /** 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. */
120
+ tec?: RouteSectionTecOutput;
121
+ }
122
+ /** 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. */
123
+ export interface RouteSectionTecOutput {
124
+ /** 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. */
125
+ readonly effectCode?: number;
126
+ /** Causes array */
127
+ causes?: Array<RouteSectionTecCauseOutput>;
128
+ }
129
+ /** The cause of the traffic event. Can contain mainCauseCode and subCauseCode elements. Can be used to define iconography and descriptions. */
130
+ export interface RouteSectionTecCauseOutput {
131
+ /** 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. */
132
+ readonly mainCauseCode?: number;
133
+ /** 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. */
134
+ readonly subCauseCode?: number;
135
+ }
136
+ /** Contains guidance related elements. This field is present only when guidance was requested and is available. */
137
+ export interface RouteGuidanceOutput {
138
+ /** A list of instructions describing maneuvers. */
139
+ readonly instructions: Array<RouteInstructionOutput>;
140
+ /** Groups a sequence of instruction elements which are related to each other. */
141
+ readonly instructionGroups: Array<RouteInstructionGroupOutput>;
142
+ }
143
+ /** A set of attributes describing a maneuver, e.g. 'Turn right', 'Keep left', 'Take the ferry', 'Take the motorway', 'Arrive'. */
144
+ export interface RouteInstructionOutput {
145
+ /** Distance from the start of the route to the point of the instruction. */
146
+ readonly routeOffsetInMeters?: number;
147
+ /** Estimated travel time up to the point corresponding to routeOffsetInMeters. */
148
+ readonly travelTimeInSeconds?: number;
149
+ /** A location represented as a latitude and longitude. */
150
+ point?: LatLongPairOutput;
151
+ /** The index of the point in the list of polyline "points" corresponding to the point of the instruction. */
152
+ readonly pointIndex?: number;
153
+ /** Type of the instruction, e.g., turn or change of road form. */
154
+ instructionType?: "TURN" | "ROAD_CHANGE" | "LOCATION_DEPARTURE" | "LOCATION_ARRIVAL" | "DIRECTION_INFO" | "LOCATION_WAYPOINT";
155
+ /** 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"] */
156
+ readonly roadNumbers?: Array<string>;
157
+ /** 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". */
158
+ readonly exitNumber?: string;
159
+ /** Street name of the next significant road segment after the maneuver, or of the street that should be followed. */
160
+ readonly street?: string;
161
+ /** The text on a signpost which is most relevant to the maneuver, or to the direction that should be followed. */
162
+ readonly signpostText?: string;
163
+ /** 3-character [ISO 3166-1](https://www.iso.org/iso-3166-country-codes.html) alpha-3 country code. E.g. USA. */
164
+ readonly countryCode?: string;
165
+ /** 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. */
166
+ readonly stateCode?: string;
167
+ /** The type of the junction where the maneuver takes place. For larger roundabouts, two separate instructions are generated for entering and leaving the roundabout. */
168
+ readonly junctionType?: "REGULAR" | "ROUNDABOUT" | "BIFURCATION";
169
+ /**
170
+ * Indicates the direction of an instruction. If junctionType indicates a turn instruction:
171
+ *
172
+ * * 180 = U-turn
173
+ * * [-179, -1] = Left turn
174
+ * * 0 = Straight on (a '0 degree' turn)
175
+ * * [1, 179] = Right turn
176
+ *
177
+ * If junctionType indicates a bifurcation instruction:
178
+ *
179
+ * * <0 - keep left
180
+ * * \>0 - keep right
181
+ */
182
+ readonly turnAngleInDecimalDegrees?: number;
183
+ /** This indicates which exit to take at a roundabout. */
184
+ readonly roundaboutExitNumber?: number;
185
+ /** 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". */
186
+ readonly possibleCombineWithNext?: boolean;
187
+ /** Indicates left-hand vs. right-hand side driving at the point of the maneuver. */
188
+ readonly drivingSide?: "LEFT" | "RIGHT";
189
+ /** A code identifying the maneuver. */
190
+ 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";
191
+ /** A human-readable message for the maneuver. */
192
+ readonly message?: string;
193
+ /**
194
+ * 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:
195
+ *
196
+ * ```
197
+ * 10. Turn left onto Einsteinweg/A10/E22 towards Ring Amsterdam
198
+ * 11. Follow Einsteinweg/A10/E22 towards Ring Amsterdam
199
+ * ```
200
+ *
201
+ * 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:
202
+ *
203
+ * ```
204
+ * Turn left onto Einsteinweg/A10/E22 towards Ring Amsterdam
205
+ * then follow Einsteinweg/A10/E22 towards Ring Amsterdam.
206
+ * ```
207
+ */
208
+ readonly combinedMessage?: string;
209
+ }
210
+ /** 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. */
211
+ export interface RouteInstructionGroupOutput {
212
+ /** Index of the first instruction in the instructions and belonging to this group. */
213
+ readonly firstInstructionIndex?: number;
214
+ /** Index of the last instruction in the instructions and belonging to this group. */
215
+ readonly lastInstructionIndex?: number;
216
+ /** Length of the group. */
217
+ readonly groupLengthInMeters?: number;
218
+ /** Summary message when human-readable text messages are requested for guidance (instructionType=text or tagged). */
219
+ readonly groupMessage?: string;
220
+ }
221
+ /** Optimized way point object. */
222
+ export interface RouteOptimizedWaypointOutput {
223
+ /** Way point index provided by the user. */
224
+ readonly providedIndex: number;
225
+ /** Optimized way point index from the system. */
226
+ readonly optimizedIndex: number;
227
+ }
228
+ /** Reports the effective settings used in the current call. */
229
+ export interface RouteReportOutput {
230
+ /** Effective parameters or data used when calling this Route API. */
231
+ readonly effectiveSettings: Array<EffectiveSettingOutput>;
232
+ }
233
+ /** Effective parameter or data used when calling this Route API. */
234
+ export interface EffectiveSettingOutput {
235
+ /** Name of the parameter used. */
236
+ readonly key: string;
237
+ /** Value of the parameter used. */
238
+ readonly value: string;
239
+ }
240
+ /** This object is returned from a successful Route Reachable Range call */
241
+ export interface RouteRangeResultOutput {
242
+ /** Format Version property */
243
+ readonly formatVersion?: string;
244
+ /** Reachable Range */
245
+ reachableRange: RouteRangeOutput;
246
+ /** Reports the effective settings used in the current call. */
247
+ report?: RouteReportOutput;
248
+ }
249
+ /** Reachable Range */
250
+ export interface RouteRangeOutput {
251
+ /** Center point of the reachable range */
252
+ center: LatLongPairOutput;
253
+ /** Polygon boundary of the reachable range represented as a list of points. */
254
+ readonly boundary: Array<LatLongPairOutput>;
255
+ }
256
+ /** This object is returned from a successful Route Directions Batch service call. */
257
+ export interface RouteDirectionsBatchResultOutput extends BatchResultOutput {
258
+ /** Array containing the batch results. */
259
+ readonly batchItems: Array<RouteDirectionsBatchItemOutput>;
260
+ }
261
+ /** An item returned from Route Directions Batch service call. */
262
+ export interface RouteDirectionsBatchItemOutput extends BatchResultItemOutput {
263
+ /** The result of the query. RouteDirections if the query completed successfully, ErrorResponse otherwise. */
264
+ readonly response: RouteDirectionsBatchItemResponseOutput;
265
+ }
266
+ /** The result of the query. RouteDirections if the query completed successfully, ErrorResponse otherwise. */
267
+ export interface RouteDirectionsBatchItemResponseOutput extends RouteDirectionsOutput, ErrorResponseOutput {
268
+ }
269
+ /** An item returned from Batch API. Extend with 'response' property. */
270
+ export interface BatchResultItemOutput {
271
+ /** HTTP request status code. */
272
+ readonly statusCode: number;
273
+ }
274
+ /** This object is returned from a successful Batch service call. Extend with 'batchItems' property. */
275
+ export interface BatchResultOutput {
276
+ /** Summary of the results for the batch request */
277
+ readonly summary: BatchResultSummaryOutput;
278
+ }
279
+ /** Summary of the results for the batch request */
280
+ export interface BatchResultSummaryOutput {
281
+ /** Number of successful requests in the batch */
282
+ readonly successfulRequests: number;
283
+ /** Total number of requests in the batch */
284
+ readonly totalRequests: number;
285
+ }
286
+ //# sourceMappingURL=outputModels.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"outputModels.d.ts","sourceRoot":"","sources":["../../../src/generated/outputModels.ts"],"names":[],"mappings":"AAGA,mPAAmP;AACnP,MAAM,WAAW,uBAAuB;IACtC,8BAA8B;IAC9B,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;IAChC,2DAA2D;IAC3D,QAAQ,CAAC,MAAM,EAAE,KAAK,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,CAAC;IACjD,qBAAqB;IACrB,QAAQ,CAAC,OAAO,EAAE,wBAAwB,CAAC;CAC5C;AAED,2BAA2B;AAC3B,MAAM,WAAW,iBAAiB;IAChC,oEAAoE;IACpE,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,+DAA+D;IAC/D,QAAQ,CAAC,QAAQ,CAAC,EAAE,+BAA+B,CAAC;CACrD;AAED,+DAA+D;AAC/D,MAAM,WAAW,+BAA+B;IAC9C,qBAAqB;IACrB,QAAQ,CAAC,YAAY,CAAC,EAAE,kBAAkB,CAAC;CAC5C;AAED,qBAAqB;AACrB,MAAM,WAAW,kBAAkB;IACjC,gCAAgC;IAChC,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;IAChC,qSAAqS;IACrS,QAAQ,CAAC,mBAAmB,EAAE,MAAM,CAAC;IACrC,uTAAuT;IACvT,QAAQ,CAAC,qBAAqB,EAAE,MAAM,CAAC;IACvC,yEAAyE;IACzE,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;IAC/B,uEAAuE;IACvE,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;CAC9B;AAED,qBAAqB;AACrB,MAAM,WAAW,wBAAwB;IACvC,mDAAmD;IACnD,QAAQ,CAAC,gBAAgB,EAAE,MAAM,CAAC;IAClC,6EAA6E;IAC7E,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;CAC9B;AAED,qKAAqK;AACrK,MAAM,WAAW,mBAAmB;IAClC,wBAAwB;IACxB,KAAK,CAAC,EAAE,iBAAiB,CAAC;CAC3B;AAED,wBAAwB;AACxB,MAAM,WAAW,iBAAiB;IAChC,sBAAsB;IACtB,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,yBAAyB;IACzB,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,sEAAsE;AACtE,MAAM,WAAW,qBAAqB;IACpC,8BAA8B;IAC9B,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;IAChC,mBAAmB;IACnB,QAAQ,CAAC,MAAM,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;IACpC;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,kBAAkB,CAAC,EAAE,KAAK,CAAC,4BAA4B,CAAC,CAAC;IAClE,+DAA+D;IAC/D,MAAM,CAAC,EAAE,iBAAiB,CAAC;CAC5B;AAED,MAAM,WAAW,WAAW;IAC1B,qBAAqB;IACrB,QAAQ,CAAC,OAAO,EAAE,kBAAkB,CAAC;IACrC,iBAAiB;IACjB,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC;IACrC,qBAAqB;IACrB,QAAQ,CAAC,QAAQ,CAAC,EAAE,KAAK,CAAC,kBAAkB,CAAC,CAAC;IAC9C,mHAAmH;IACnH,QAAQ,CAAC,QAAQ,CAAC,EAAE,mBAAmB,CAAC;CACzC;AAED,kLAAkL;AAClL,MAAM,WAAW,cAAc;IAC7B,qBAAqB;IACrB,QAAQ,CAAC,OAAO,EAAE,kBAAkB,CAAC;IACrC,mBAAmB;IACnB,QAAQ,CAAC,MAAM,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC;CAC3C;AAED,0DAA0D;AAC1D,MAAM,WAAW,iBAAiB;IAChC,wBAAwB;IACxB,QAAQ,EAAE,MAAM,CAAC;IACjB,yBAAyB;IACzB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,+KAA+K;AAC/K,MAAM,WAAW,kBAAkB;IACjC,gFAAgF;IAChF,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC;IACjC,+EAA+E;IAC/E,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;IAC/B,mDAAmD;IACnD,QAAQ,CAAC,WAAW,EAChB,WAAW,GACX,SAAS,GACT,OAAO,GACP,UAAU,GACV,YAAY,GACZ,WAAW,GACX,eAAe,GACf,SAAS,GACT,aAAa,GACb,QAAQ,GACR,SAAS,GACT,OAAO,CAAC;IACZ,gJAAgJ;IAChJ,QAAQ,CAAC,UAAU,CAAC,EAChB,KAAK,GACL,OAAO,GACP,MAAM,GACN,KAAK,GACL,KAAK,GACL,YAAY,GACZ,SAAS,GACT,YAAY,GACZ,OAAO,CAAC;IACZ,yHAAyH;IACzH,QAAQ,CAAC,cAAc,CAAC,EAAE,KAAK,GAAG,WAAW,GAAG,cAAc,GAAG,OAAO,CAAC;IACzE,gFAAgF;IAChF,QAAQ,CAAC,mBAAmB,CAAC,EAAE,MAAM,CAAC;IACtC,+CAA+C;IAC/C,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;IACjC,yOAAyO;IACzO,QAAQ,CAAC,gBAAgB,CAAC,EAAE,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,CAAC;IACxD,wKAAwK;IACxK,GAAG,CAAC,EAAE,qBAAqB,CAAC;CAC7B;AAED,wKAAwK;AACxK,MAAM,WAAW,qBAAqB;IACpC,wOAAwO;IACxO,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAC7B,mBAAmB;IACnB,MAAM,CAAC,EAAE,KAAK,CAAC,0BAA0B,CAAC,CAAC;CAC5C;AAED,+IAA+I;AAC/I,MAAM,WAAW,0BAA0B;IACzC,4KAA4K;IAC5K,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;IAChC,gMAAgM;IAChM,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,mHAAmH;AACnH,MAAM,WAAW,mBAAmB;IAClC,mDAAmD;IACnD,QAAQ,CAAC,YAAY,EAAE,KAAK,CAAC,sBAAsB,CAAC,CAAC;IACrD,iFAAiF;IACjF,QAAQ,CAAC,iBAAiB,EAAE,KAAK,CAAC,2BAA2B,CAAC,CAAC;CAChE;AAED,kIAAkI;AAClI,MAAM,WAAW,sBAAsB;IACrC,4EAA4E;IAC5E,QAAQ,CAAC,mBAAmB,CAAC,EAAE,MAAM,CAAC;IACtC,kFAAkF;IAClF,QAAQ,CAAC,mBAAmB,CAAC,EAAE,MAAM,CAAC;IACtC,0DAA0D;IAC1D,KAAK,CAAC,EAAE,iBAAiB,CAAC;IAC1B,6GAA6G;IAC7G,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAC7B,kEAAkE;IAClE,eAAe,CAAC,EACZ,MAAM,GACN,aAAa,GACb,oBAAoB,GACpB,kBAAkB,GAClB,gBAAgB,GAChB,mBAAmB,CAAC;IACxB,gJAAgJ;IAChJ,QAAQ,CAAC,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACrC,4LAA4L;IAC5L,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAC7B,qHAAqH;IACrH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,kHAAkH;IAClH,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;IAC/B,gHAAgH;IAChH,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,sOAAsO;IACtO,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,wKAAwK;IACxK,QAAQ,CAAC,YAAY,CAAC,EAAE,SAAS,GAAG,YAAY,GAAG,aAAa,CAAC;IACjE;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,yBAAyB,CAAC,EAAE,MAAM,CAAC;IAC5C,yDAAyD;IACzD,QAAQ,CAAC,oBAAoB,CAAC,EAAE,MAAM,CAAC;IACvC,uJAAuJ;IACvJ,QAAQ,CAAC,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAC3C,oFAAoF;IACpF,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IACxC,uCAAuC;IACvC,QAAQ,CAAC,QAAQ,CAAC,EACd,QAAQ,GACR,aAAa,GACb,cAAc,GACd,QAAQ,GACR,UAAU,GACV,YAAY,GACZ,YAAY,GACZ,YAAY,GACZ,aAAa,GACb,WAAW,GACX,WAAW,GACX,WAAW,GACX,YAAY,GACZ,YAAY,GACZ,gBAAgB,GAChB,eAAe,GACf,eAAe,GACf,WAAW,GACX,oBAAoB,GACpB,qBAAqB,GACrB,YAAY,GACZ,kBAAkB,GAClB,kBAAkB,GAClB,iBAAiB,GACjB,iBAAiB,GACjB,gBAAgB,GAChB,QAAQ,GACR,sBAAsB,GACtB,kBAAkB,GAClB,eAAe,GACf,eAAe,GACf,gBAAgB,GAChB,kBAAkB,CAAC;IACvB,iDAAiD;IACjD,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CAAC,eAAe,CAAC,EAAE,MAAM,CAAC;CACnC;AAED,gVAAgV;AAChV,MAAM,WAAW,2BAA2B;IAC1C,sFAAsF;IACtF,QAAQ,CAAC,qBAAqB,CAAC,EAAE,MAAM,CAAC;IACxC,qFAAqF;IACrF,QAAQ,CAAC,oBAAoB,CAAC,EAAE,MAAM,CAAC;IACvC,2BAA2B;IAC3B,QAAQ,CAAC,mBAAmB,CAAC,EAAE,MAAM,CAAC;IACtC,qHAAqH;IACrH,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,kCAAkC;AAClC,MAAM,WAAW,4BAA4B;IAC3C,4CAA4C;IAC5C,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;IAC/B,iDAAiD;IACjD,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;CACjC;AAED,+DAA+D;AAC/D,MAAM,WAAW,iBAAiB;IAChC,qEAAqE;IACrE,QAAQ,CAAC,iBAAiB,EAAE,KAAK,CAAC,sBAAsB,CAAC,CAAC;CAC3D;AAED,oEAAoE;AACpE,MAAM,WAAW,sBAAsB;IACrC,kCAAkC;IAClC,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,mCAAmC;IACnC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;CACxB;AAED,2EAA2E;AAC3E,MAAM,WAAW,sBAAsB;IACrC,8BAA8B;IAC9B,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;IAChC,sBAAsB;IACtB,cAAc,EAAE,gBAAgB,CAAC;IACjC,+DAA+D;IAC/D,MAAM,CAAC,EAAE,iBAAiB,CAAC;CAC5B;AAED,sBAAsB;AACtB,MAAM,WAAW,gBAAgB;IAC/B,0CAA0C;IAC1C,MAAM,EAAE,iBAAiB,CAAC;IAC1B,+EAA+E;IAC/E,QAAQ,CAAC,QAAQ,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC;CAC7C;AAED,qFAAqF;AACrF,MAAM,WAAW,gCAAiC,SAAQ,iBAAiB;IACzE,0CAA0C;IAC1C,QAAQ,CAAC,UAAU,EAAE,KAAK,CAAC,8BAA8B,CAAC,CAAC;CAC5D;AAED,iEAAiE;AACjE,MAAM,WAAW,8BAA+B,SAAQ,qBAAqB;IAC3E,6GAA6G;IAC7G,QAAQ,CAAC,QAAQ,EAAE,sCAAsC,CAAC;CAC3D;AAED,6GAA6G;AAC7G,MAAM,WAAW,sCACf,SAAQ,qBAAqB,EAC3B,mBAAmB;CAAG;AAE1B,wEAAwE;AACxE,MAAM,WAAW,qBAAqB;IACpC,gCAAgC;IAChC,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;CAC7B;AAED,uGAAuG;AACvG,MAAM,WAAW,iBAAiB;IAChC,mDAAmD;IACnD,QAAQ,CAAC,OAAO,EAAE,wBAAwB,CAAC;CAC5C;AAED,mDAAmD;AACnD,MAAM,WAAW,wBAAwB;IACvC,iDAAiD;IACjD,QAAQ,CAAC,kBAAkB,EAAE,MAAM,CAAC;IACpC,4CAA4C;IAC5C,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;CAChC"}
@@ -0,0 +1,4 @@
1
+ // Copyright (c) Microsoft Corporation.
2
+ // Licensed under the MIT License.
3
+ export {};
4
+ //# sourceMappingURL=outputModels.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"outputModels.js","sourceRoot":"","sources":["../../../src/generated/outputModels.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\n/** 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. */\nexport interface RouteMatrixResultOutput {\n /** Format Version property */\n readonly formatVersion?: string;\n /** Results as a 2 dimensional array of route summaries. */\n readonly matrix: Array<Array<RouteMatrixOutput>>;\n /** Summary object */\n readonly summary: RouteMatrixSummaryOutput;\n}\n\n/** Matrix result object */\nexport interface RouteMatrixOutput {\n /** StatusCode property for the current cell in the input matrix. */\n readonly statusCode: number;\n /** Response object of the current cell in the input matrix. */\n readonly response?: RouteMatrixResultResponseOutput;\n}\n\n/** Response object of the current cell in the input matrix. */\nexport interface RouteMatrixResultResponseOutput {\n /** Summary object */\n readonly routeSummary?: RouteSummaryOutput;\n}\n\n/** Summary object */\nexport interface RouteSummaryOutput {\n /** Length In Meters property */\n readonly lengthInMeters: number;\n /** 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. */\n readonly travelTimeInSeconds: number;\n /** 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. */\n readonly trafficDelayInSeconds: number;\n /** The estimated departure time for the route or leg. Time is in UTC. */\n readonly departureTime: string;\n /** The estimated arrival time for the route or leg. Time is in UTC. */\n readonly arrivalTime: string;\n}\n\n/** Summary object */\nexport interface RouteMatrixSummaryOutput {\n /** Number of successful routes in the response. */\n readonly successfulRoutes: number;\n /** Total number of routes requested. Number of cells in the input matrix. */\n readonly totalRoutes: number;\n}\n\n/** Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.). */\nexport interface ErrorResponseOutput {\n /** The error object. */\n error?: ErrorDetailOutput;\n}\n\n/** The error detail. */\nexport interface ErrorDetailOutput {\n /** The error code. */\n readonly code?: string;\n /** The error message. */\n readonly message?: string;\n}\n\n/** This object is returned from a successful Route Directions call */\nexport interface RouteDirectionsOutput {\n /** Format Version property */\n readonly formatVersion?: string;\n /** Routes array */\n readonly routes: Array<RouteOutput>;\n /**\n * Optimized sequence of waypoints. It shows the index from the user provided waypoint sequence for the original and optimized list. For instance, a response:\n *\n * ```\n * <optimizedWaypoints>\n * <waypoint providedIndex=\"0\" optimizedIndex=\"1\"/>\n * <waypoint providedIndex=\"1\" optimizedIndex=\"2\"/>\n * <waypoint providedIndex=\"2\" optimizedIndex=\"0\"/>\n * </optimizedWaypoints>\n * ```\n *\n * 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\".\n */\n readonly optimizedWaypoints?: Array<RouteOptimizedWaypointOutput>;\n /** Reports the effective settings used in the current call. */\n report?: RouteReportOutput;\n}\n\nexport interface RouteOutput {\n /** Summary object */\n readonly summary: RouteSummaryOutput;\n /** Legs array */\n readonly legs: Array<RouteLegOutput>;\n /** Sections array */\n readonly sections?: Array<RouteSectionOutput>;\n /** Contains guidance related elements. This field is present only when guidance was requested and is available. */\n readonly guidance?: RouteGuidanceOutput;\n}\n\n/** 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. */\nexport interface RouteLegOutput {\n /** Summary object */\n readonly summary: RouteSummaryOutput;\n /** Points array */\n readonly points: Array<LatLongPairOutput>;\n}\n\n/** A location represented as a latitude and longitude. */\nexport interface LatLongPairOutput {\n /** Latitude property */\n latitude: number;\n /** Longitude property */\n longitude: number;\n}\n\n/** Route sections contain additional information about parts of a route. Each section contains at least the elements `startPointIndex`, `endPointIndex`, and `sectionType`. */\nexport interface RouteSectionOutput {\n /** Index of the first point (offset 0) in the route this section applies to. */\n readonly startPointIndex: number;\n /** Index of the last point (offset 0) in the route this section applies to. */\n readonly endPointIndex: number;\n /** Section types of the reported route response */\n readonly sectionType:\n | \"CAR_TRAIN\"\n | \"COUNTRY\"\n | \"FERRY\"\n | \"MOTORWAY\"\n | \"PEDESTRIAN\"\n | \"TOLL_ROAD\"\n | \"TOLL_VIGNETTE\"\n | \"TRAFFIC\"\n | \"TRAVEL_MODE\"\n | \"TUNNEL\"\n | \"CARPOOL\"\n | \"URBAN\";\n /** 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 */\n readonly travelMode?:\n | \"car\"\n | \"truck\"\n | \"taxi\"\n | \"bus\"\n | \"van\"\n | \"motorcycle\"\n | \"bicycle\"\n | \"pedestrian\"\n | \"other\";\n /** Type of the incident. Can currently be JAM, ROAD_WORK, ROAD_CLOSURE, or OTHER. See \"tec\" for detailed information. */\n readonly simpleCategory?: \"JAM\" | \"ROAD_WORK\" | \"ROAD_CLOSURE\" | \"OTHER\";\n /** Effective speed of the incident in km/h, averaged over its entire length. */\n readonly effectiveSpeedInKmh?: number;\n /** Delay in seconds caused by the incident. */\n readonly delayInSeconds?: number;\n /** 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). */\n readonly magnitudeOfDelay?: \"0\" | \"1\" | \"2\" | \"3\" | \"4\";\n /** 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. */\n tec?: RouteSectionTecOutput;\n}\n\n/** 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. */\nexport interface RouteSectionTecOutput {\n /** 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. */\n readonly effectCode?: number;\n /** Causes array */\n causes?: Array<RouteSectionTecCauseOutput>;\n}\n\n/** The cause of the traffic event. Can contain mainCauseCode and subCauseCode elements. Can be used to define iconography and descriptions. */\nexport interface RouteSectionTecCauseOutput {\n /** 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. */\n readonly mainCauseCode?: number;\n /** 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. */\n readonly subCauseCode?: number;\n}\n\n/** Contains guidance related elements. This field is present only when guidance was requested and is available. */\nexport interface RouteGuidanceOutput {\n /** A list of instructions describing maneuvers. */\n readonly instructions: Array<RouteInstructionOutput>;\n /** Groups a sequence of instruction elements which are related to each other. */\n readonly instructionGroups: Array<RouteInstructionGroupOutput>;\n}\n\n/** A set of attributes describing a maneuver, e.g. 'Turn right', 'Keep left', 'Take the ferry', 'Take the motorway', 'Arrive'. */\nexport interface RouteInstructionOutput {\n /** Distance from the start of the route to the point of the instruction. */\n readonly routeOffsetInMeters?: number;\n /** Estimated travel time up to the point corresponding to routeOffsetInMeters. */\n readonly travelTimeInSeconds?: number;\n /** A location represented as a latitude and longitude. */\n point?: LatLongPairOutput;\n /** The index of the point in the list of polyline \"points\" corresponding to the point of the instruction. */\n readonly pointIndex?: number;\n /** Type of the instruction, e.g., turn or change of road form. */\n instructionType?:\n | \"TURN\"\n | \"ROAD_CHANGE\"\n | \"LOCATION_DEPARTURE\"\n | \"LOCATION_ARRIVAL\"\n | \"DIRECTION_INFO\"\n | \"LOCATION_WAYPOINT\";\n /** 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\"] */\n readonly roadNumbers?: Array<string>;\n /** 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\". */\n readonly exitNumber?: string;\n /** Street name of the next significant road segment after the maneuver, or of the street that should be followed. */\n readonly street?: string;\n /** The text on a signpost which is most relevant to the maneuver, or to the direction that should be followed. */\n readonly signpostText?: string;\n /** 3-character [ISO 3166-1](https://www.iso.org/iso-3166-country-codes.html) alpha-3 country code. E.g. USA. */\n readonly countryCode?: string;\n /** 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. */\n readonly stateCode?: string;\n /** The type of the junction where the maneuver takes place. For larger roundabouts, two separate instructions are generated for entering and leaving the roundabout. */\n readonly junctionType?: \"REGULAR\" | \"ROUNDABOUT\" | \"BIFURCATION\";\n /**\n * Indicates the direction of an instruction. If junctionType indicates a turn instruction:\n *\n * * 180 = U-turn\n * * [-179, -1] = Left turn\n * * 0 = Straight on (a '0 degree' turn)\n * * [1, 179] = Right turn\n *\n * If junctionType indicates a bifurcation instruction:\n *\n * * <0 - keep left\n * * \\>0 - keep right\n */\n readonly turnAngleInDecimalDegrees?: number;\n /** This indicates which exit to take at a roundabout. */\n readonly roundaboutExitNumber?: number;\n /** 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\". */\n readonly possibleCombineWithNext?: boolean;\n /** Indicates left-hand vs. right-hand side driving at the point of the maneuver. */\n readonly drivingSide?: \"LEFT\" | \"RIGHT\";\n /** A code identifying the maneuver. */\n readonly maneuver?:\n | \"ARRIVE\"\n | \"ARRIVE_LEFT\"\n | \"ARRIVE_RIGHT\"\n | \"DEPART\"\n | \"STRAIGHT\"\n | \"KEEP_RIGHT\"\n | \"BEAR_RIGHT\"\n | \"TURN_RIGHT\"\n | \"SHARP_RIGHT\"\n | \"KEEP_LEFT\"\n | \"BEAR_LEFT\"\n | \"TURN_LEFT\"\n | \"SHARP_LEFT\"\n | \"MAKE_UTURN\"\n | \"ENTER_MOTORWAY\"\n | \"ENTER_FREEWAY\"\n | \"ENTER_HIGHWAY\"\n | \"TAKE_EXIT\"\n | \"MOTORWAY_EXIT_LEFT\"\n | \"MOTORWAY_EXIT_RIGHT\"\n | \"TAKE_FERRY\"\n | \"ROUNDABOUT_CROSS\"\n | \"ROUNDABOUT_RIGHT\"\n | \"ROUNDABOUT_LEFT\"\n | \"ROUNDABOUT_BACK\"\n | \"TRY_MAKE_UTURN\"\n | \"FOLLOW\"\n | \"SWITCH_PARALLEL_ROAD\"\n | \"SWITCH_MAIN_ROAD\"\n | \"ENTRANCE_RAMP\"\n | \"WAYPOINT_LEFT\"\n | \"WAYPOINT_RIGHT\"\n | \"WAYPOINT_REACHED\";\n /** A human-readable message for the maneuver. */\n readonly message?: string;\n /**\n * 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:\n *\n * ```\n * 10. Turn left onto Einsteinweg/A10/E22 towards Ring Amsterdam\n * 11. Follow Einsteinweg/A10/E22 towards Ring Amsterdam\n * ```\n *\n * 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:\n *\n * ```\n * Turn left onto Einsteinweg/A10/E22 towards Ring Amsterdam\n * then follow Einsteinweg/A10/E22 towards Ring Amsterdam.\n * ```\n */\n readonly combinedMessage?: string;\n}\n\n/** 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. */\nexport interface RouteInstructionGroupOutput {\n /** Index of the first instruction in the instructions and belonging to this group. */\n readonly firstInstructionIndex?: number;\n /** Index of the last instruction in the instructions and belonging to this group. */\n readonly lastInstructionIndex?: number;\n /** Length of the group. */\n readonly groupLengthInMeters?: number;\n /** Summary message when human-readable text messages are requested for guidance (instructionType=text or tagged). */\n readonly groupMessage?: string;\n}\n\n/** Optimized way point object. */\nexport interface RouteOptimizedWaypointOutput {\n /** Way point index provided by the user. */\n readonly providedIndex: number;\n /** Optimized way point index from the system. */\n readonly optimizedIndex: number;\n}\n\n/** Reports the effective settings used in the current call. */\nexport interface RouteReportOutput {\n /** Effective parameters or data used when calling this Route API. */\n readonly effectiveSettings: Array<EffectiveSettingOutput>;\n}\n\n/** Effective parameter or data used when calling this Route API. */\nexport interface EffectiveSettingOutput {\n /** Name of the parameter used. */\n readonly key: string;\n /** Value of the parameter used. */\n readonly value: string;\n}\n\n/** This object is returned from a successful Route Reachable Range call */\nexport interface RouteRangeResultOutput {\n /** Format Version property */\n readonly formatVersion?: string;\n /** Reachable Range */\n reachableRange: RouteRangeOutput;\n /** Reports the effective settings used in the current call. */\n report?: RouteReportOutput;\n}\n\n/** Reachable Range */\nexport interface RouteRangeOutput {\n /** Center point of the reachable range */\n center: LatLongPairOutput;\n /** Polygon boundary of the reachable range represented as a list of points. */\n readonly boundary: Array<LatLongPairOutput>;\n}\n\n/** This object is returned from a successful Route Directions Batch service call. */\nexport interface RouteDirectionsBatchResultOutput extends BatchResultOutput {\n /** Array containing the batch results. */\n readonly batchItems: Array<RouteDirectionsBatchItemOutput>;\n}\n\n/** An item returned from Route Directions Batch service call. */\nexport interface RouteDirectionsBatchItemOutput extends BatchResultItemOutput {\n /** The result of the query. RouteDirections if the query completed successfully, ErrorResponse otherwise. */\n readonly response: RouteDirectionsBatchItemResponseOutput;\n}\n\n/** The result of the query. RouteDirections if the query completed successfully, ErrorResponse otherwise. */\nexport interface RouteDirectionsBatchItemResponseOutput\n extends RouteDirectionsOutput,\n ErrorResponseOutput {}\n\n/** An item returned from Batch API. Extend with 'response' property. */\nexport interface BatchResultItemOutput {\n /** HTTP request status code. */\n readonly statusCode: number;\n}\n\n/** This object is returned from a successful Batch service call. Extend with 'batchItems' property. */\nexport interface BatchResultOutput {\n /** Summary of the results for the batch request */\n readonly summary: BatchResultSummaryOutput;\n}\n\n/** Summary of the results for the batch request */\nexport interface BatchResultSummaryOutput {\n /** Number of successful requests in the batch */\n readonly successfulRequests: number;\n /** Total number of requests in the batch */\n readonly totalRequests: number;\n}\n"]}