@googlemaps/fleetengine 0.7.0 → 0.8.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.
Files changed (10) hide show
  1. package/README.md +53 -228
  2. package/build/protos/google/maps/fleetengine/v1/fleetengine.proto +32 -0
  3. package/build/protos/google/maps/fleetengine/v1/traffic.proto +3 -3
  4. package/build/protos/google/maps/fleetengine/v1/trip_api.proto +5 -5
  5. package/build/protos/google/maps/fleetengine/v1/trips.proto +3 -0
  6. package/build/protos/protos.d.ts +148 -0
  7. package/build/protos/protos.js +461 -0
  8. package/build/protos/protos.json +54 -1
  9. package/build/src/v1/trip_service_client.d.ts +4 -4
  10. package/package.json +1 -1
package/README.md CHANGED
@@ -1,24 +1,24 @@
1
1
  [//]: # "This README.md file is auto-generated, all changes to this file will be lost."
2
- [//]: # "To regenerate it, use `python -m synthtool`."
2
+ [//]: # "The comments you see below are used to generate those parts of the template in later states."
3
3
  <img src="https://avatars2.githubusercontent.com/u/2810941?v=3&s=96" alt="Google Cloud Platform logo" title="Google Cloud Platform" align="right" height="96" width="96"/>
4
4
 
5
- # [Local Rides and Deliveries API: Node.js Client](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-maps-fleetengine)
6
-
7
- [![release level](https://img.shields.io/badge/release%20level-preview-yellow.svg?style=flat)](https://cloud.google.com/terms/launch-stages)
8
- [![npm version](https://img.shields.io/npm/v/@googlemaps/fleetengine.svg)](https://www.npmjs.org/package/@googlemaps/fleetengine)
9
-
5
+ # [Local Rides and Deliveries API: Nodejs Client][homepage]
10
6
 
7
+ This library is considered to be in **preview**. This means it is still a
8
+ work-in-progress and under active development. Any release is subject to
9
+ backwards-incompatible changes at any time.
11
10
 
11
+ [![npm version](https://img.shields.io/npm/v/@googlemaps/fleetengine.svg)](https://www.npmjs.org/package/@googlemaps/fleetengine)
12
12
 
13
13
  Local Rides and Deliveries API client for Node.js
14
14
 
15
+ [//]: # "partials.introduction"
15
16
 
16
17
  A comprehensive list of changes in each version may be found in
17
- [the CHANGELOG](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-maps-fleetengine/CHANGELOG.md).
18
+ [the CHANGELOG][homepage_changelog].
18
19
 
19
- * [Local Rides and Deliveries API Node.js Client API Reference][client-docs]
20
- * [Local Rides and Deliveries API Documentation][product-docs]
21
- * [github.com/googleapis/google-cloud-node/packages/google-maps-fleetengine](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-maps-fleetengine)
20
+ * [Local Rides and Deliveries API Nodejs Client API Reference](https://cloud.google.com/nodejs/docs/reference/fleetengine/latest)
21
+ * [Local Rides and Deliveries API Documentation](https://developers.google.com/maps/documentation/transportation-logistics/mobility)
22
22
 
23
23
  Read more about the client libraries for Cloud APIs, including the older
24
24
  Google APIs Client Libraries, in [Client Libraries Explained][explained].
@@ -27,18 +27,15 @@ Google APIs Client Libraries, in [Client Libraries Explained][explained].
27
27
 
28
28
  **Table of contents:**
29
29
 
30
-
31
30
  * [Quickstart](#quickstart)
32
31
  * [Before you begin](#before-you-begin)
33
32
  * [Installing the client library](#installing-the-client-library)
34
- * [Using the client library](#using-the-client-library)
35
- * [Samples](#samples)
33
+
36
34
  * [Versioning](#versioning)
37
35
  * [Contributing](#contributing)
38
36
  * [License](#license)
39
37
 
40
38
  ## Quickstart
41
-
42
39
  ### Before you begin
43
40
 
44
41
  1. [Select or create a Cloud Platform project][projects].
@@ -46,215 +43,55 @@ Google APIs Client Libraries, in [Client Libraries Explained][explained].
46
43
  1. [Enable the Local Rides and Deliveries API API][enable_api].
47
44
  1. [Set up authentication][auth] so you can access the
48
45
  API from your local workstation.
49
-
50
46
  ### Installing the client library
51
47
 
52
48
  ```bash
53
49
  npm install @googlemaps/fleetengine
54
50
  ```
55
51
 
52
+ ## Terms of Service
56
53
 
57
- ### Using the client library
58
-
59
- ```javascript
60
- /**
61
- * This snippet has been automatically generated and should be regarded as a code template only.
62
- * It will require modifications to work.
63
- * It may require correct/in-range values for request initialization.
64
- * TODO(developer): Uncomment these variables before running the sample.
65
- */
66
- /**
67
- * The standard Fleet Engine request header.
68
- */
69
- // const header = {}
70
- /**
71
- * Required. Must be in the format `providers/{provider}`.
72
- * The provider must be the Project ID (for example, `sample-cloud-project`)
73
- * of the Google Cloud Project of which the service account making
74
- * this call is a member.
75
- */
76
- // const parent = 'abc123'
77
- /**
78
- * The maximum number of vehicles to return.
79
- * Default value: 100.
80
- */
81
- // const pageSize = 1234
82
- /**
83
- * The value of the `next_page_token` provided by a previous call to
84
- * `ListVehicles` so that you can paginate through groups of vehicles. The
85
- * value is undefined if the filter criteria of the request is not the same as
86
- * the filter criteria for the previous call to `ListVehicles`.
87
- */
88
- // const pageToken = 'abc123'
89
- /**
90
- * Specifies the required minimum capacity of the vehicle. All vehicles
91
- * returned will have a `maximum_capacity` greater than or equal to this
92
- * value. If set, must be greater or equal to 0.
93
- */
94
- // const minimumCapacity = {}
95
- /**
96
- * Restricts the response to vehicles that support at least one of the
97
- * specified trip types.
98
- */
99
- // const tripTypes = [1,2,3,4]
100
- /**
101
- * Restricts the response to vehicles that have sent location updates to Fleet
102
- * Engine within the specified duration. Stationary vehicles still
103
- * transmitting their locations are not considered stale. If present, must be
104
- * a valid positive duration.
105
- */
106
- // const maximumStaleness = {}
107
- /**
108
- * Required. Restricts the response to vehicles with one of the specified type
109
- * categories. `UNKNOWN` is not allowed.
110
- */
111
- // const vehicleTypeCategories = [1,2,3,4]
112
- /**
113
- * Callers can form complex logical operations using any combination of the
114
- * `required_attributes`, `required_one_of_attributes`, and
115
- * `required_one_of_attribute_sets` fields.
116
- * `required_attributes` is a list; `required_one_of_attributes` uses a
117
- * message which allows a list of lists. In combination, the two fields allow
118
- * the composition of this expression:
119
- * ```
120
- * (required_attributes0 AND required_attributes1 AND ...)
121
- * AND
122
- * (required_one_of_attributes0 0 OR required_one_of_attributes0 1 OR
123
- * ...)
124
- * AND
125
- * (required_one_of_attributes1 0 OR required_one_of_attributes1 1 OR
126
- * ...)
127
- * ```
128
- * Restricts the response to vehicles with the specified attributes. This
129
- * field is a conjunction/AND operation. A max of 50 required_attributes is
130
- * allowed. This matches the maximum number of attributes allowed on a
131
- * vehicle. Each repeated string should be of the format "key:value".
132
- */
133
- // const requiredAttributes = ['abc','def']
134
- /**
135
- * Restricts the response to vehicles with at least one of the specified
136
- * attributes in each `VehicleAttributeList`. Within each list, a vehicle must
137
- * match at least one of the attributes. This field is an inclusive
138
- * disjunction/OR operation in each `VehicleAttributeList` and a
139
- * conjunction/AND operation across the collection of `VehicleAttributeList`.
140
- * Each repeated string should be of the format
141
- * "key1:value1|key2:value2|key3:value3".
142
- */
143
- // const requiredOneOfAttributes = ['abc','def']
144
- /**
145
- * `required_one_of_attribute_sets` provides additional functionality.
146
- * Similar to `required_one_of_attributes`, `required_one_of_attribute_sets`
147
- * uses a message which allows a list of lists, allowing expressions such as
148
- * this one:
149
- * ```
150
- * (required_attributes0 AND required_attributes1 AND ...)
151
- * AND
152
- * (
153
- * (required_one_of_attribute_sets0 0 AND
154
- * required_one_of_attribute_sets0 1 AND
155
- * ...)
156
- * OR
157
- * (required_one_of_attribute_sets1 0 AND
158
- * required_one_of_attribute_sets1 1 AND
159
- * ...)
160
- * )
161
- * ```
162
- * Restricts the response to vehicles that match all the attributes in a
163
- * `VehicleAttributeList`. Within each list, a vehicle must match all of the
164
- * attributes. This field is a conjunction/AND operation in each
165
- * `VehicleAttributeList` and inclusive disjunction/OR operation across the
166
- * collection of `VehicleAttributeList`. Each repeated string should be of the
167
- * format "key1:value1|key2:value2|key3:value3".
168
- */
169
- // const requiredOneOfAttributeSets = ['abc','def']
170
- /**
171
- * Restricts the response to vehicles that have this vehicle state.
172
- */
173
- // const vehicleState = {}
174
- /**
175
- * Only return the vehicles with current trip(s).
176
- */
177
- // const onTripOnly = true
178
- /**
179
- * Optional. A filter query to apply when listing vehicles. See
180
- * http://aip.dev/160 for examples of the filter syntax.
181
- * This field is designed to replace the `required_attributes`,
182
- * `required_one_of_attributes`, and `required_one_of_attributes_sets` fields.
183
- * If a non-empty value is specified here, the following fields must be empty:
184
- * `required_attributes`, `required_one_of_attributes`, and
185
- * `required_one_of_attributes_sets`.
186
- * This filter functions as an AND clause with other constraints,
187
- * such as `vehicle_state` or `on_trip_only`.
188
- * Note that the only queries supported are on vehicle attributes (for
189
- * example, `attributes.<key> = <value>` or `attributes.<key1> = <value1> AND
190
- * attributes.<key2> = <value2>`). The maximum number of restrictions allowed
191
- * in a filter query is 50.
192
- * Also, all attributes are stored as strings, so the only supported
193
- * comparisons against attributes are string comparisons. In order to compare
194
- * against number or boolean values, the values must be explicitly quoted to
195
- * be treated as strings (for example, `attributes.<key> = "10"` or
196
- * `attributes.<key> = "true"`).
197
- */
198
- // const filter = 'abc123'
199
- /**
200
- * Optional. A filter that limits the vehicles returned to those whose last
201
- * known location was in the rectangular area defined by the viewport.
202
- */
203
- // const viewport = {}
204
-
205
- // Imports the Fleetengine library
206
- const {VehicleServiceClient} = require('@googlemaps/fleetengine').v1;
207
-
208
- // Instantiates a client
209
- const fleetengineClient = new VehicleServiceClient();
210
-
211
- async function callListVehicles() {
212
- // Construct request
213
- const request = {
214
- parent,
215
- vehicleTypeCategories,
216
- };
217
-
218
- // Run request
219
- const iterable = fleetengineClient.listVehiclesAsync(request);
220
- for await (const response of iterable) {
221
- console.log(response);
222
- }
223
- }
224
-
225
- callListVehicles();
226
-
227
- ```
54
+ `@googlemaps/fleetengine` uses Google Maps Platform services. Use of Google
55
+ Maps Platform services through this library is subject to the
56
+ [Google Maps Platform Terms of Service][gmp-tos].
228
57
 
58
+ This library is not a Google Maps Platform Core Service.
59
+ Therefore, the Google Maps Platform Terms of Service (e.g., Technical
60
+ Support Services, Service Level Agreements, and Deprecation Policy)
61
+ do not apply to this library.
229
62
 
63
+ ### European Economic Area (EEA) developers
230
64
 
231
- ## Samples
65
+ If your billing address is in the European Economic Area, effective on
66
+ 8 July 2025, the [Google Maps Platform EEA Terms of Service][gmp-tos-eea]
67
+ will apply to your use of the Services. Functionality varies by region.
68
+ [Learn more][gmp-tos-eea-faq].
232
69
 
233
- Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-maps-fleetengine/samples) directory. Each sample's `README.md` has instructions for running its sample.
234
-
235
- | Sample | Source Code | Try it |
236
- | --------------------------- | --------------------------------- | ------ |
237
- | Trip_service.create_trip | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-fleetengine/samples/generated/v1/trip_service.create_trip.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-maps-fleetengine/samples/generated/v1/trip_service.create_trip.js,packages/google-maps-fleetengine/samples/README.md) |
238
- | Trip_service.delete_trip | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-fleetengine/samples/generated/v1/trip_service.delete_trip.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-maps-fleetengine/samples/generated/v1/trip_service.delete_trip.js,packages/google-maps-fleetengine/samples/README.md) |
239
- | Trip_service.get_trip | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-fleetengine/samples/generated/v1/trip_service.get_trip.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-maps-fleetengine/samples/generated/v1/trip_service.get_trip.js,packages/google-maps-fleetengine/samples/README.md) |
240
- | Trip_service.report_billable_trip | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-fleetengine/samples/generated/v1/trip_service.report_billable_trip.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-maps-fleetengine/samples/generated/v1/trip_service.report_billable_trip.js,packages/google-maps-fleetengine/samples/README.md) |
241
- | Trip_service.search_trips | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-fleetengine/samples/generated/v1/trip_service.search_trips.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-maps-fleetengine/samples/generated/v1/trip_service.search_trips.js,packages/google-maps-fleetengine/samples/README.md) |
242
- | Trip_service.update_trip | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-fleetengine/samples/generated/v1/trip_service.update_trip.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-maps-fleetengine/samples/generated/v1/trip_service.update_trip.js,packages/google-maps-fleetengine/samples/README.md) |
243
- | Vehicle_service.create_vehicle | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-fleetengine/samples/generated/v1/vehicle_service.create_vehicle.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-maps-fleetengine/samples/generated/v1/vehicle_service.create_vehicle.js,packages/google-maps-fleetengine/samples/README.md) |
244
- | Vehicle_service.delete_vehicle | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-fleetengine/samples/generated/v1/vehicle_service.delete_vehicle.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-maps-fleetengine/samples/generated/v1/vehicle_service.delete_vehicle.js,packages/google-maps-fleetengine/samples/README.md) |
245
- | Vehicle_service.get_vehicle | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-fleetengine/samples/generated/v1/vehicle_service.get_vehicle.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-maps-fleetengine/samples/generated/v1/vehicle_service.get_vehicle.js,packages/google-maps-fleetengine/samples/README.md) |
246
- | Vehicle_service.list_vehicles | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-fleetengine/samples/generated/v1/vehicle_service.list_vehicles.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-maps-fleetengine/samples/generated/v1/vehicle_service.list_vehicles.js,packages/google-maps-fleetengine/samples/README.md) |
247
- | Vehicle_service.search_fuzzed_vehicles | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-fleetengine/samples/generated/v1/vehicle_service.search_fuzzed_vehicles.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-maps-fleetengine/samples/generated/v1/vehicle_service.search_fuzzed_vehicles.js,packages/google-maps-fleetengine/samples/README.md) |
248
- | Vehicle_service.search_vehicles | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-fleetengine/samples/generated/v1/vehicle_service.search_vehicles.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-maps-fleetengine/samples/generated/v1/vehicle_service.search_vehicles.js,packages/google-maps-fleetengine/samples/README.md) |
249
- | Vehicle_service.update_vehicle | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-fleetengine/samples/generated/v1/vehicle_service.update_vehicle.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-maps-fleetengine/samples/generated/v1/vehicle_service.update_vehicle.js,packages/google-maps-fleetengine/samples/README.md) |
250
- | Vehicle_service.update_vehicle_attributes | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-fleetengine/samples/generated/v1/vehicle_service.update_vehicle_attributes.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-maps-fleetengine/samples/generated/v1/vehicle_service.update_vehicle_attributes.js,packages/google-maps-fleetengine/samples/README.md) |
251
- | Vehicle_service.update_vehicle_location | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-fleetengine/samples/generated/v1/vehicle_service.update_vehicle_location.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-maps-fleetengine/samples/generated/v1/vehicle_service.update_vehicle_location.js,packages/google-maps-fleetengine/samples/README.md) |
252
- | Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-fleetengine/samples/quickstart.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-maps-fleetengine/samples/quickstart.js,packages/google-maps-fleetengine/samples/README.md) |
70
+ [gmp-tos]: https://cloud.google.com/maps-platform/terms
71
+ [gmp-tos-eea]: https://cloud.google.com/terms/maps-platform/eea
72
+ [gmp-tos-eea-faq]: https://developers.google.com/maps/comms/eea/faq
253
73
 
74
+ ## Samples
254
75
 
76
+ Samples are in the [`samples/`][homepage_samples] directory. Each sample's `README.md` has instructions for running its sample.
77
+
78
+ | Sample | Source Code |
79
+ | --------------------------- | --------------------------------- |
80
+ | fleetengine | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-fleetengine/samples/generated/v1/snippet_metadata_maps.fleetengine.v1.json) |
81
+ | create trip | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-fleetengine/samples/generated/v1/trip_service.create_trip.js) |
82
+ | delete trip | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-fleetengine/samples/generated/v1/trip_service.delete_trip.js) |
83
+ | get trip | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-fleetengine/samples/generated/v1/trip_service.get_trip.js) |
84
+ | report billable trip | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-fleetengine/samples/generated/v1/trip_service.report_billable_trip.js) |
85
+ | search trips | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-fleetengine/samples/generated/v1/trip_service.search_trips.js) |
86
+ | update trip | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-fleetengine/samples/generated/v1/trip_service.update_trip.js) |
87
+ | create vehicle | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-fleetengine/samples/generated/v1/vehicle_service.create_vehicle.js) |
88
+ | delete vehicle | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-fleetengine/samples/generated/v1/vehicle_service.delete_vehicle.js) |
89
+ | get vehicle | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-fleetengine/samples/generated/v1/vehicle_service.get_vehicle.js) |
90
+ | list vehicles | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-fleetengine/samples/generated/v1/vehicle_service.list_vehicles.js) |
91
+ | search vehicles | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-fleetengine/samples/generated/v1/vehicle_service.search_vehicles.js) |
92
+ | update vehicle | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-fleetengine/samples/generated/v1/vehicle_service.update_vehicle.js) |
93
+ | update vehicle attributes | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-fleetengine/samples/generated/v1/vehicle_service.update_vehicle_attributes.js) |
255
94
 
256
- The [Local Rides and Deliveries API Node.js Client API Reference][client-docs] documentation
257
- also contains samples.
258
95
 
259
96
  ## Supported Node.js Versions
260
97
 
@@ -281,41 +118,29 @@ for versions compatible with Node.js 8.
281
118
 
282
119
  This library follows [Semantic Versioning](http://semver.org/).
283
120
 
284
-
285
-
286
-
287
-
288
-
289
-
290
- This library is considered to be in **preview**. This means it is still a
291
- work-in-progress and under active development. Any release is subject to
292
- backwards-incompatible changes at any time.
293
-
294
-
295
121
  More Information: [Google Cloud Platform Launch Stages][launch_stages]
296
122
 
297
123
  [launch_stages]: https://cloud.google.com/terms/launch-stages
298
124
 
299
125
  ## Contributing
300
126
 
301
- Contributions welcome! See the [Contributing Guide](https://github.com/googleapis/google-cloud-node/blob/main/CONTRIBUTING.md).
127
+ Contributions welcome! See the [Contributing Guide](https://github.com/googleapis/google-cloud-node/blob/main/packages/maps-fleetengine/CONTRIBUTING.md).
302
128
 
303
- Please note that this `README.md`, the `samples/README.md`,
129
+ Please note that this `README.md`
304
130
  and a variety of configuration files in this repository (including `.nycrc` and `tsconfig.json`)
305
- are generated from a central template. To edit one of these files, make an edit
306
- to its templates in
307
- [directory](https://github.com/googleapis/synthtool).
131
+ are generated from a central template.
308
132
 
309
133
  ## License
310
134
 
311
135
  Apache Version 2.0
312
136
 
313
- See [LICENSE](https://github.com/googleapis/google-cloud-node/blob/main/LICENSE)
137
+ See [LICENSE](https://github.com/googleapis/google-cloud-node/blob/main/packages/maps-fleetengine/LICENSE)
314
138
 
315
- [client-docs]: https://cloud.google.com/nodejs/docs/reference/fleetengine/latest
316
- [product-docs]: https://developers.google.com/maps/documentation/transportation-logistics/mobility
317
139
  [shell_img]: https://gstatic.com/cloudssh/images/open-btn.png
318
140
  [projects]: https://console.cloud.google.com/project
319
141
  [billing]: https://support.google.com/cloud/answer/6293499#enable-billing
320
142
  [enable_api]: https://console.cloud.google.com/flows/enableapi?apiid=fleetengine.googleapis.com
321
143
  [auth]: https://cloud.google.com/docs/authentication/external/set-up-adc-local
144
+ [homepage_samples]: https://github.com/googleapis/google-cloud-node/blob/main/packages/maps-fleetengine/samples
145
+ [homepage_changelog]: https://github.com/googleapis/google-cloud-node/blob/main/packages/maps-fleetengine/CHANGELOG.md
146
+ [homepage]: https://github.com/googleapis/google-cloud-node/blob/main/packages/maps-fleetengine
package/build/protos/google/maps/fleetengine/v1/fleetengine.proto CHANGED
@@ -282,6 +282,19 @@ message VehicleLocation {
282
282
  // Accuracy of `raw_location` as a radius, in meters.
283
283
  google.protobuf.DoubleValue raw_location_accuracy = 25;
284
284
 
285
+ // The location from Android's Fused Location Provider.
286
+ google.type.LatLng flp_location = 29;
287
+
288
+ // Update timestamp of `flp_location`.
289
+ google.protobuf.Timestamp flp_update_time = 30;
290
+
291
+ // Accuracy of `flp_location` in meters as a radius.
292
+ google.protobuf.DoubleValue flp_latlng_accuracy_meters = 31;
293
+
294
+ // Direction the vehicle is moving in degrees, as determined by the Fused
295
+ // Location Provider. 0 represents North. The valid range is [0,360).
296
+ google.protobuf.Int32Value flp_heading_degrees = 32;
297
+
285
298
  // Supplemental location provided by the integrating app.
286
299
  google.type.LatLng supplemental_location = 18;
287
300
 
@@ -335,3 +348,22 @@ enum LocationSensor {
335
348
  // The location provider on Apple operating systems.
336
349
  CORE_LOCATION = 200;
337
350
  }
351
+
352
+ // Describes a trip attribute as a key-value pair. The "key:value" string length
353
+ // cannot exceed 256 characters.
354
+ message TripAttribute {
355
+ // The attribute's key. Keys may not contain the colon character (:).
356
+ string key = 1;
357
+
358
+ // The attribute's value, can be in string, bool, or double type.
359
+ oneof trip_attribute_value {
360
+ // String typed attribute value.
361
+ string string_value = 2;
362
+
363
+ // Boolean typed attribute value.
364
+ bool bool_value = 3;
365
+
366
+ // Double typed attribute value.
367
+ double number_value = 4;
368
+ }
369
+ }
package/build/protos/google/maps/fleetengine/v1/traffic.proto CHANGED
@@ -34,13 +34,13 @@ message SpeedReadingInterval {
34
34
  // Default value. This value is unused.
35
35
  SPEED_UNSPECIFIED = 0;
36
36
 
37
- // Normal speed, no slowdown is detected.
37
+ // Normal speed, no traffic delays.
38
38
  NORMAL = 1;
39
39
 
40
- // Slowdown detected, but no traffic jam formed.
40
+ // Slowdown detected, medium amount of traffic.
41
41
  SLOW = 2;
42
42
 
43
- // Traffic jam detected.
43
+ // Traffic delays.
44
44
  TRAFFIC_JAM = 3;
45
45
  }
46
46
 
package/build/protos/google/maps/fleetengine/v1/trip_api.proto CHANGED
@@ -222,11 +222,11 @@ message GetTripRequest {
222
222
  // If a minimum is unspecified, the route data are always retrieved.
223
223
  google.protobuf.Timestamp current_route_segment_version = 6;
224
224
 
225
- // Indicates the minimum timestamp (exclusive) for which
226
- // `Trip.remaining_waypoints` are retrieved. If they are unchanged since this
227
- // timestamp, the `remaining_waypoints` are not set in the response. If this
228
- // field is unspecified, `remaining_waypoints` is always retrieved.
229
- google.protobuf.Timestamp remaining_waypoints_version = 7;
225
+ // Deprecated: `Trip.remaining_waypoints` are always retrieved. Use
226
+ // `remaining_waypoints_route_version` to control when
227
+ // `Trip.remaining_waypoints.traffic_to_waypoint` and
228
+ // `Trip.remaining_waypoints.path_to_waypoint` data are retrieved.
229
+ google.protobuf.Timestamp remaining_waypoints_version = 7 [deprecated = true];
230
230
 
231
231
  // The returned current route format, `LAT_LNG_LIST_TYPE` (in `Trip.route`),
232
232
  // or `ENCODED_POLYLINE_TYPE` (in `Trip.current_route_segment`). The default
package/build/protos/google/maps/fleetengine/v1/trips.proto CHANGED
@@ -224,6 +224,9 @@ message Trip {
224
224
  // The subset of Trip fields that are populated and how they should be
225
225
  // interpreted.
226
226
  TripView view = 31;
227
+
228
+ // A list of custom Trip attributes. Each attribute must have a unique key.
229
+ repeated TripAttribute attributes = 35;
227
230
  }
228
231
 
229
232
  // The actual location where a stop (pickup/dropoff) happened.
package/build/protos/protos.d.ts CHANGED
@@ -628,6 +628,18 @@ export namespace maps {
628
628
  /** VehicleLocation rawLocationAccuracy */
629
629
  rawLocationAccuracy?: (google.protobuf.IDoubleValue|null);
630
630
 
631
+ /** VehicleLocation flpLocation */
632
+ flpLocation?: (google.type.ILatLng|null);
633
+
634
+ /** VehicleLocation flpUpdateTime */
635
+ flpUpdateTime?: (google.protobuf.ITimestamp|null);
636
+
637
+ /** VehicleLocation flpLatlngAccuracyMeters */
638
+ flpLatlngAccuracyMeters?: (google.protobuf.IDoubleValue|null);
639
+
640
+ /** VehicleLocation flpHeadingDegrees */
641
+ flpHeadingDegrees?: (google.protobuf.IInt32Value|null);
642
+
631
643
  /** VehicleLocation supplementalLocation */
632
644
  supplementalLocation?: (google.type.ILatLng|null);
633
645
 
@@ -722,6 +734,18 @@ export namespace maps {
722
734
  /** VehicleLocation rawLocationAccuracy. */
723
735
  public rawLocationAccuracy?: (google.protobuf.IDoubleValue|null);
724
736
 
737
+ /** VehicleLocation flpLocation. */
738
+ public flpLocation?: (google.type.ILatLng|null);
739
+
740
+ /** VehicleLocation flpUpdateTime. */
741
+ public flpUpdateTime?: (google.protobuf.ITimestamp|null);
742
+
743
+ /** VehicleLocation flpLatlngAccuracyMeters. */
744
+ public flpLatlngAccuracyMeters?: (google.protobuf.IDoubleValue|null);
745
+
746
+ /** VehicleLocation flpHeadingDegrees. */
747
+ public flpHeadingDegrees?: (google.protobuf.IInt32Value|null);
748
+
725
749
  /** VehicleLocation supplementalLocation. */
726
750
  public supplementalLocation?: (google.type.ILatLng|null);
727
751
 
@@ -828,6 +852,124 @@ export namespace maps {
828
852
  CORE_LOCATION = 200
829
853
  }
830
854
 
855
+ /** Properties of a TripAttribute. */
856
+ interface ITripAttribute {
857
+
858
+ /** TripAttribute key */
859
+ key?: (string|null);
860
+
861
+ /** TripAttribute stringValue */
862
+ stringValue?: (string|null);
863
+
864
+ /** TripAttribute boolValue */
865
+ boolValue?: (boolean|null);
866
+
867
+ /** TripAttribute numberValue */
868
+ numberValue?: (number|null);
869
+ }
870
+
871
+ /** Represents a TripAttribute. */
872
+ class TripAttribute implements ITripAttribute {
873
+
874
+ /**
875
+ * Constructs a new TripAttribute.
876
+ * @param [properties] Properties to set
877
+ */
878
+ constructor(properties?: maps.fleetengine.v1.ITripAttribute);
879
+
880
+ /** TripAttribute key. */
881
+ public key: string;
882
+
883
+ /** TripAttribute stringValue. */
884
+ public stringValue?: (string|null);
885
+
886
+ /** TripAttribute boolValue. */
887
+ public boolValue?: (boolean|null);
888
+
889
+ /** TripAttribute numberValue. */
890
+ public numberValue?: (number|null);
891
+
892
+ /** TripAttribute tripAttributeValue. */
893
+ public tripAttributeValue?: ("stringValue"|"boolValue"|"numberValue");
894
+
895
+ /**
896
+ * Creates a new TripAttribute instance using the specified properties.
897
+ * @param [properties] Properties to set
898
+ * @returns TripAttribute instance
899
+ */
900
+ public static create(properties?: maps.fleetengine.v1.ITripAttribute): maps.fleetengine.v1.TripAttribute;
901
+
902
+ /**
903
+ * Encodes the specified TripAttribute message. Does not implicitly {@link maps.fleetengine.v1.TripAttribute.verify|verify} messages.
904
+ * @param message TripAttribute message or plain object to encode
905
+ * @param [writer] Writer to encode to
906
+ * @returns Writer
907
+ */
908
+ public static encode(message: maps.fleetengine.v1.ITripAttribute, writer?: $protobuf.Writer): $protobuf.Writer;
909
+
910
+ /**
911
+ * Encodes the specified TripAttribute message, length delimited. Does not implicitly {@link maps.fleetengine.v1.TripAttribute.verify|verify} messages.
912
+ * @param message TripAttribute message or plain object to encode
913
+ * @param [writer] Writer to encode to
914
+ * @returns Writer
915
+ */
916
+ public static encodeDelimited(message: maps.fleetengine.v1.ITripAttribute, writer?: $protobuf.Writer): $protobuf.Writer;
917
+
918
+ /**
919
+ * Decodes a TripAttribute message from the specified reader or buffer.
920
+ * @param reader Reader or buffer to decode from
921
+ * @param [length] Message length if known beforehand
922
+ * @returns TripAttribute
923
+ * @throws {Error} If the payload is not a reader or valid buffer
924
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
925
+ */
926
+ public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): maps.fleetengine.v1.TripAttribute;
927
+
928
+ /**
929
+ * Decodes a TripAttribute message from the specified reader or buffer, length delimited.
930
+ * @param reader Reader or buffer to decode from
931
+ * @returns TripAttribute
932
+ * @throws {Error} If the payload is not a reader or valid buffer
933
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
934
+ */
935
+ public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): maps.fleetengine.v1.TripAttribute;
936
+
937
+ /**
938
+ * Verifies a TripAttribute message.
939
+ * @param message Plain object to verify
940
+ * @returns `null` if valid, otherwise the reason why it is not
941
+ */
942
+ public static verify(message: { [k: string]: any }): (string|null);
943
+
944
+ /**
945
+ * Creates a TripAttribute message from a plain object. Also converts values to their respective internal types.
946
+ * @param object Plain object
947
+ * @returns TripAttribute
948
+ */
949
+ public static fromObject(object: { [k: string]: any }): maps.fleetengine.v1.TripAttribute;
950
+
951
+ /**
952
+ * Creates a plain object from a TripAttribute message. Also converts values to other types if specified.
953
+ * @param message TripAttribute
954
+ * @param [options] Conversion options
955
+ * @returns Plain object
956
+ */
957
+ public static toObject(message: maps.fleetengine.v1.TripAttribute, options?: $protobuf.IConversionOptions): { [k: string]: any };
958
+
959
+ /**
960
+ * Converts this TripAttribute to JSON.
961
+ * @returns JSON object
962
+ */
963
+ public toJSON(): { [k: string]: any };
964
+
965
+ /**
966
+ * Gets the default type url for TripAttribute
967
+ * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
968
+ * @returns The default type url
969
+ */
970
+ public static getTypeUrl(typeUrlPrefix?: string): string;
971
+ }
972
+
831
973
  /** Properties of a SpeedReadingInterval. */
832
974
  interface ISpeedReadingInterval {
833
975
 
@@ -2322,6 +2464,9 @@ export namespace maps {
2322
2464
 
2323
2465
  /** Trip view */
2324
2466
  view?: (maps.fleetengine.v1.TripView|keyof typeof maps.fleetengine.v1.TripView|null);
2467
+
2468
+ /** Trip attributes */
2469
+ attributes?: (maps.fleetengine.v1.ITripAttribute[]|null);
2325
2470
  }
2326
2471
 
2327
2472
  /** Represents a Trip. */
@@ -2432,6 +2577,9 @@ export namespace maps {
2432
2577
  /** Trip view. */
2433
2578
  public view: (maps.fleetengine.v1.TripView|keyof typeof maps.fleetengine.v1.TripView);
2434
2579
 
2580
+ /** Trip attributes. */
2581
+ public attributes: maps.fleetengine.v1.ITripAttribute[];
2582
+
2435
2583
  /**
2436
2584
  * Creates a new Trip instance using the specified properties.
2437
2585
  * @param [properties] Properties to set