@googlemaps/routing 0.2.1 → 0.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,20 @@
1
1
  # Changelog
2
2
 
3
+ ## [0.3.1](https://github.com/googleapis/google-cloud-node/compare/routing-v0.3.0...routing-v0.3.1) (2023-02-15)
4
+
5
+
6
+ ### Bug Fixes
7
+
8
+ * [Many APIs] changing format of the jsdoc links ([#3991](https://github.com/googleapis/google-cloud-node/issues/3991)) ([c6326d9](https://github.com/googleapis/google-cloud-node/commit/c6326d90abb9b649b25052e4afe7b3eb0f65bcb4))
9
+
10
+ ## [0.3.0](https://github.com/googleapis/google-cloud-node/compare/routing-v0.2.1...routing-v0.3.0) (2023-01-28)
11
+
12
+
13
+ ### Features
14
+
15
+ * Add ExtraComputations feature to ComputeRoutes and ComputeRouteMatrix ([#3868](https://github.com/googleapis/google-cloud-node/issues/3868)) ([3b646fa](https://github.com/googleapis/google-cloud-node/commit/3b646fabd5aa4f29a176817d5ed6a23de9583ccb))
16
+ * Added SuggestConversationSummary RPC ([#3854](https://github.com/googleapis/google-cloud-node/issues/3854)) ([9e4b7f8](https://github.com/googleapis/google-cloud-node/commit/9e4b7f8d27dbb1ac011267f9b96ce90d2ff7a74b))
17
+
3
18
  ## [0.2.1](https://github.com/googleapis/google-cloud-node/compare/routing-v0.2.0...routing-v0.2.1) (2022-11-10)
4
19
 
5
20
 
@@ -86,6 +86,10 @@ message Route {
86
86
  // and in the event of rerouting honor the original intention when Routes
87
87
  // ComputeRoutes is called. Customers should treat this token as an
88
88
  // opaque blob.
89
+ // NOTE: `Route.route_token` is only available for requests that have set
90
+ // `ComputeRoutesRequest.routing_preference` to `TRAFFIC_AWARE` or
91
+ // `TRAFFIC_AWARE_OPTIMAL`. `Route.route_token` is also not supported for
92
+ // requests that have Via waypoints.
89
93
  string route_token = 12;
90
94
  }
91
95
 
@@ -27,6 +27,10 @@ option php_namespace = "Google\\Maps\\Routing\\V2";
27
27
  option ruby_package = "Google::Maps::Routing::V2";
28
28
 
29
29
  // A set of values used to specify the mode of travel.
30
+ // NOTE: WALK, BICYCLE, and TWO_WHEELER routes are in beta and might sometimes
31
+ // be missing clear sidewalks, pedestrian paths, or bicycling paths.
32
+ // You must display this warning to the user for all walking, bicycling, and
33
+ // two-wheel routes that you display in your app.
30
34
  enum RouteTravelMode {
31
35
  // No travel mode specified. Defaults to `DRIVE`.
32
36
  TRAVEL_MODE_UNSPECIFIED = 0;
@@ -122,7 +122,8 @@ service Routes {
122
122
  // be automatically included in the response.
123
123
  // * Selecting only the fields that you need results in a smaller response
124
124
  // size, and thus higher network throughput.
125
- rpc ComputeRouteMatrix(ComputeRouteMatrixRequest) returns (stream RouteMatrixElement) {
125
+ rpc ComputeRouteMatrix(ComputeRouteMatrixRequest)
126
+ returns (stream RouteMatrixElement) {
126
127
  option (google.api.http) = {
127
128
  post: "/distanceMatrix/v2:computeRouteMatrix"
128
129
  body: "*"
@@ -142,6 +143,21 @@ message ComputeRoutesRequest {
142
143
  FUEL_EFFICIENT = 1;
143
144
  }
144
145
 
146
+ // Extra computations to perform while completing the request.
147
+ enum ExtraComputation {
148
+ // Not used. Requests containing this value will fail.
149
+ EXTRA_COMPUTATION_UNSPECIFIED = 0;
150
+
151
+ // Toll information for the route(s).
152
+ TOLLS = 1;
153
+
154
+ // Estimated fuel consumption for the route(s).
155
+ FUEL_CONSUMPTION = 2;
156
+
157
+ // Traffic aware polylines for the route(s).
158
+ TRAFFIC_ON_POLYLINE = 3;
159
+ }
160
+
145
161
  // Required. Origin waypoint.
146
162
  Waypoint origin = 1 [(google.api.field_behavior) = REQUIRED];
147
163
 
@@ -159,24 +175,26 @@ message ComputeRoutesRequest {
159
175
  // Optional. Specifies how to compute the route. The server
160
176
  // attempts to use the selected routing preference to compute the route. If
161
177
  // the routing preference results in an error or an extra long latency, then
162
- // an error is returned. In the future, we might implement a fallback
163
- // mechanism to use a different option when the preferred option does not give
164
- // a valid result. You can specify this option only when the `travel_mode` is
165
- // `DRIVE` or `TWO_WHEELER`, otherwise the request fails.
166
- RoutingPreference routing_preference = 5 [(google.api.field_behavior) = OPTIONAL];
178
+ // an error is returned. You can specify this option only when the
179
+ // `travel_mode` is `DRIVE` or `TWO_WHEELER`, otherwise the request fails.
180
+ RoutingPreference routing_preference = 5
181
+ [(google.api.field_behavior) = OPTIONAL];
167
182
 
168
183
  // Optional. Specifies your preference for the quality of the polyline.
169
184
  PolylineQuality polyline_quality = 6 [(google.api.field_behavior) = OPTIONAL];
170
185
 
171
186
  // Optional. Specifies the preferred encoding for the polyline.
172
- PolylineEncoding polyline_encoding = 12 [(google.api.field_behavior) = OPTIONAL];
187
+ PolylineEncoding polyline_encoding = 12
188
+ [(google.api.field_behavior) = OPTIONAL];
173
189
 
174
190
  // Optional. The departure time. If you don't set this value, then this value
175
191
  // defaults to the time that you made the request. If you set this value to a
176
192
  // time that has already occurred, then the request fails.
177
- google.protobuf.Timestamp departure_time = 7 [(google.api.field_behavior) = OPTIONAL];
193
+ google.protobuf.Timestamp departure_time = 7
194
+ [(google.api.field_behavior) = OPTIONAL];
178
195
 
179
- // Optional. Specifies whether to calculate alternate routes in addition to the route.
196
+ // Optional. Specifies whether to calculate alternate routes in addition to
197
+ // the route.
180
198
  bool compute_alternative_routes = 8 [(google.api.field_behavior) = OPTIONAL];
181
199
 
182
200
  // Optional. A set of conditions to satisfy that affect the way routes are
@@ -198,13 +216,20 @@ message ComputeRoutesRequest {
198
216
  // units are inferred from the location of the request.
199
217
  Units units = 11 [(google.api.field_behavior) = OPTIONAL];
200
218
 
201
- // Optional. Specifies what reference routes to calculate as part of the request in
202
- // addition to the default route.
203
- // A reference route is a route with a different route calculation objective
204
- // than the default route. For example an FUEL_EFFICIENT reference route
205
- // calculation takes into account various parameters that would generate an
206
- // optimal fuel efficient route.
207
- repeated ReferenceRoute requested_reference_routes = 14 [(google.api.field_behavior) = OPTIONAL];
219
+ // Optional. Specifies what reference routes to calculate as part of the
220
+ // request in addition to the default route. A reference route is a route with
221
+ // a different route calculation objective than the default route. For example
222
+ // an FUEL_EFFICIENT reference route calculation takes into account various
223
+ // parameters that would generate an optimal fuel efficient route.
224
+ repeated ReferenceRoute requested_reference_routes = 14
225
+ [(google.api.field_behavior) = OPTIONAL];
226
+
227
+ // Optional. A list of extra computations which may be used to complete the
228
+ // request. Note: These extra computations may return extra fields on the
229
+ // response. These extra fields must also be specified in the field mask to be
230
+ // returned in the response.
231
+ repeated ExtraComputation extra_computations = 15
232
+ [(google.api.field_behavior) = OPTIONAL];
208
233
  }
209
234
 
210
235
  // ComputeRoutes the response message.
@@ -225,8 +250,17 @@ message ComputeRoutesResponse {
225
250
 
226
251
  // ComputeRouteMatrix request message
227
252
  message ComputeRouteMatrixRequest {
228
- // Required. Array of origins, which determines the rows of the response matrix.
229
- // Several size restrictions apply to the cardinality of origins and
253
+ // Extra computations to perform while completing the request.
254
+ enum ExtraComputation {
255
+ // Not used. Requests containing this value will fail.
256
+ EXTRA_COMPUTATION_UNSPECIFIED = 0;
257
+
258
+ // Toll information for the matrix element(s).
259
+ TOLLS = 1;
260
+ }
261
+
262
+ // Required. Array of origins, which determines the rows of the response
263
+ // matrix. Several size restrictions apply to the cardinality of origins and
230
264
  // destinations:
231
265
  //
232
266
  // * The number of elements (origins × destinations) must be no greater than
@@ -235,27 +269,37 @@ message ComputeRouteMatrixRequest {
235
269
  // 100 if routing_preference is set to `TRAFFIC_AWARE_OPTIMAL`.
236
270
  // * The number of waypoints (origins + destinations) specified as `place_id`
237
271
  // must be no greater than 50.
238
- repeated RouteMatrixOrigin origins = 1 [(google.api.field_behavior) = REQUIRED];
272
+ repeated RouteMatrixOrigin origins = 1
273
+ [(google.api.field_behavior) = REQUIRED];
239
274
 
240
- // Required. Array of destinations, which determines the columns of the response matrix.
241
- repeated RouteMatrixDestination destinations = 2 [(google.api.field_behavior) = REQUIRED];
275
+ // Required. Array of destinations, which determines the columns of the
276
+ // response matrix.
277
+ repeated RouteMatrixDestination destinations = 2
278
+ [(google.api.field_behavior) = REQUIRED];
242
279
 
243
280
  // Optional. Specifies the mode of transportation.
244
281
  RouteTravelMode travel_mode = 3 [(google.api.field_behavior) = OPTIONAL];
245
282
 
246
- // Optional. Specifies how to compute the route. The server attempts to use the selected
247
- // routing preference to compute the route. If the routing preference results
248
- // in an error or an extra long latency, an error is returned. In the future,
249
- // we might implement a fallback mechanism to use a different option when the
250
- // preferred option does not give a valid result. You can specify this option
251
- // only when the `travel_mode` is `DRIVE` or `TWO_WHEELER`, otherwise the
252
- // request fails.
253
- RoutingPreference routing_preference = 4 [(google.api.field_behavior) = OPTIONAL];
254
-
255
- // Optional. The departure time. If you don't set this value, this defaults to the time
256
- // that you made the request. If you set this value to a time that has already
257
- // occurred, the request fails.
258
- google.protobuf.Timestamp departure_time = 5 [(google.api.field_behavior) = OPTIONAL];
283
+ // Optional. Specifies how to compute the route. The server attempts to use
284
+ // the selected routing preference to compute the route. If the routing
285
+ // preference results in an error or an extra long latency, an error is
286
+ // returned. You can specify this option only when the `travel_mode` is
287
+ // `DRIVE` or `TWO_WHEELER`, otherwise the request fails.
288
+ RoutingPreference routing_preference = 4
289
+ [(google.api.field_behavior) = OPTIONAL];
290
+
291
+ // Optional. The departure time. If you don't set this value, this defaults to
292
+ // the time that you made the request. If you set this value to a time that
293
+ // has already occurred, the request fails.
294
+ google.protobuf.Timestamp departure_time = 5
295
+ [(google.api.field_behavior) = OPTIONAL];
296
+
297
+ // Optional. A list of extra computations which may be used to complete the
298
+ // request. Note: These extra computations may return extra fields on the
299
+ // response. These extra fields must also be specified in the field mask to be
300
+ // returned in the response.
301
+ repeated ExtraComputation extra_computations = 8
302
+ [(google.api.field_behavior) = OPTIONAL];
259
303
  }
260
304
 
261
305
  // A single origin for ComputeRouteMatrixRequest