@googlemaps/fleetengine-delivery 0.2.0 → 0.4.0
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 +30 -0
- package/README.md +4 -2
- package/build/protos/google/geo/type/viewport.proto +1 -1
- package/build/protos/google/maps/fleetengine/delivery/v1/common.proto +1 -1
- package/build/protos/google/maps/fleetengine/delivery/v1/delivery_api.proto +76 -1
- package/build/protos/google/maps/fleetengine/delivery/v1/delivery_vehicles.proto +9 -1
- package/build/protos/google/maps/fleetengine/delivery/v1/header.proto +1 -1
- package/build/protos/google/maps/fleetengine/delivery/v1/task_tracking_info.proto +1 -1
- package/build/protos/google/maps/fleetengine/delivery/v1/tasks.proto +1 -1
- package/build/protos/protos.d.ts +345 -0
- package/build/protos/protos.js +846 -97
- package/build/protos/protos.json +105 -3
- package/build/src/v1/delivery_service_client.d.ts +71 -3
- package/build/src/v1/delivery_service_client.js +277 -60
- package/build/src/v1/delivery_service_client.js.map +1 -1
- package/build/src/v1/delivery_service_client_config.json +8 -0
- package/build/src/v1/delivery_service_proto_list.json +9 -0
- package/build/src/v1/gapic_metadata.json +151 -0
- package/package.json +16 -16
package/build/protos/protos.json
CHANGED
|
@@ -1,7 +1,4 @@
|
|
|
1
1
|
{
|
|
2
|
-
"options": {
|
|
3
|
-
"syntax": "proto3"
|
|
4
|
-
},
|
|
5
2
|
"nested": {
|
|
6
3
|
"maps": {
|
|
7
4
|
"nested": {
|
|
@@ -333,6 +330,34 @@
|
|
|
333
330
|
}
|
|
334
331
|
]
|
|
335
332
|
},
|
|
333
|
+
"DeleteDeliveryVehicle": {
|
|
334
|
+
"requestType": "DeleteDeliveryVehicleRequest",
|
|
335
|
+
"responseType": "google.protobuf.Empty",
|
|
336
|
+
"options": {
|
|
337
|
+
"(google.api.http).delete": "/v1/{name=providers/*/deliveryVehicles/*}",
|
|
338
|
+
"(google.api.routing).routing_parameters.field": "name",
|
|
339
|
+
"(google.api.routing).routing_parameters.path_template": "{provider_id=providers/*}",
|
|
340
|
+
"(google.api.method_signature)": "name"
|
|
341
|
+
},
|
|
342
|
+
"parsedOptions": [
|
|
343
|
+
{
|
|
344
|
+
"(google.api.http)": {
|
|
345
|
+
"delete": "/v1/{name=providers/*/deliveryVehicles/*}"
|
|
346
|
+
}
|
|
347
|
+
},
|
|
348
|
+
{
|
|
349
|
+
"(google.api.routing)": {
|
|
350
|
+
"routing_parameters": {
|
|
351
|
+
"field": "name",
|
|
352
|
+
"path_template": "{provider_id=providers/*}"
|
|
353
|
+
}
|
|
354
|
+
}
|
|
355
|
+
},
|
|
356
|
+
{
|
|
357
|
+
"(google.api.method_signature)": "name"
|
|
358
|
+
}
|
|
359
|
+
]
|
|
360
|
+
},
|
|
336
361
|
"UpdateDeliveryVehicle": {
|
|
337
362
|
"requestType": "UpdateDeliveryVehicleRequest",
|
|
338
363
|
"responseType": "DeliveryVehicle",
|
|
@@ -447,6 +472,34 @@
|
|
|
447
472
|
}
|
|
448
473
|
]
|
|
449
474
|
},
|
|
475
|
+
"DeleteTask": {
|
|
476
|
+
"requestType": "DeleteTaskRequest",
|
|
477
|
+
"responseType": "google.protobuf.Empty",
|
|
478
|
+
"options": {
|
|
479
|
+
"(google.api.http).delete": "/v1/{name=providers/*/tasks/*}",
|
|
480
|
+
"(google.api.routing).routing_parameters.field": "name",
|
|
481
|
+
"(google.api.routing).routing_parameters.path_template": "{provider_id=providers/*}",
|
|
482
|
+
"(google.api.method_signature)": "name"
|
|
483
|
+
},
|
|
484
|
+
"parsedOptions": [
|
|
485
|
+
{
|
|
486
|
+
"(google.api.http)": {
|
|
487
|
+
"delete": "/v1/{name=providers/*/tasks/*}"
|
|
488
|
+
}
|
|
489
|
+
},
|
|
490
|
+
{
|
|
491
|
+
"(google.api.routing)": {
|
|
492
|
+
"routing_parameters": {
|
|
493
|
+
"field": "name",
|
|
494
|
+
"path_template": "{provider_id=providers/*}"
|
|
495
|
+
}
|
|
496
|
+
}
|
|
497
|
+
},
|
|
498
|
+
{
|
|
499
|
+
"(google.api.method_signature)": "name"
|
|
500
|
+
}
|
|
501
|
+
]
|
|
502
|
+
},
|
|
450
503
|
"UpdateTask": {
|
|
451
504
|
"requestType": "UpdateTaskRequest",
|
|
452
505
|
"responseType": "Task",
|
|
@@ -614,6 +667,25 @@
|
|
|
614
667
|
}
|
|
615
668
|
}
|
|
616
669
|
},
|
|
670
|
+
"DeleteDeliveryVehicleRequest": {
|
|
671
|
+
"fields": {
|
|
672
|
+
"header": {
|
|
673
|
+
"type": "DeliveryRequestHeader",
|
|
674
|
+
"id": 1,
|
|
675
|
+
"options": {
|
|
676
|
+
"(google.api.field_behavior)": "OPTIONAL"
|
|
677
|
+
}
|
|
678
|
+
},
|
|
679
|
+
"name": {
|
|
680
|
+
"type": "string",
|
|
681
|
+
"id": 2,
|
|
682
|
+
"options": {
|
|
683
|
+
"(google.api.field_behavior)": "REQUIRED",
|
|
684
|
+
"(google.api.resource_reference).type": "fleetengine.googleapis.com/DeliveryVehicle"
|
|
685
|
+
}
|
|
686
|
+
}
|
|
687
|
+
}
|
|
688
|
+
},
|
|
617
689
|
"ListDeliveryVehiclesRequest": {
|
|
618
690
|
"fields": {
|
|
619
691
|
"header": {
|
|
@@ -790,6 +862,25 @@
|
|
|
790
862
|
}
|
|
791
863
|
}
|
|
792
864
|
},
|
|
865
|
+
"DeleteTaskRequest": {
|
|
866
|
+
"fields": {
|
|
867
|
+
"header": {
|
|
868
|
+
"type": "DeliveryRequestHeader",
|
|
869
|
+
"id": 1,
|
|
870
|
+
"options": {
|
|
871
|
+
"(google.api.field_behavior)": "OPTIONAL"
|
|
872
|
+
}
|
|
873
|
+
},
|
|
874
|
+
"name": {
|
|
875
|
+
"type": "string",
|
|
876
|
+
"id": 2,
|
|
877
|
+
"options": {
|
|
878
|
+
"(google.api.field_behavior)": "REQUIRED",
|
|
879
|
+
"(google.api.resource_reference).type": "fleetengine.googleapis.com/Task"
|
|
880
|
+
}
|
|
881
|
+
}
|
|
882
|
+
}
|
|
883
|
+
},
|
|
793
884
|
"UpdateTaskRequest": {
|
|
794
885
|
"fields": {
|
|
795
886
|
"header": {
|
|
@@ -905,6 +996,14 @@
|
|
|
905
996
|
"type": "DeliveryVehicleLocation",
|
|
906
997
|
"id": 2
|
|
907
998
|
},
|
|
999
|
+
"pastLocations": {
|
|
1000
|
+
"rule": "repeated",
|
|
1001
|
+
"type": "DeliveryVehicleLocation",
|
|
1002
|
+
"id": 12,
|
|
1003
|
+
"options": {
|
|
1004
|
+
"(google.api.field_behavior)": "INPUT_ONLY"
|
|
1005
|
+
}
|
|
1006
|
+
},
|
|
908
1007
|
"navigationStatus": {
|
|
909
1008
|
"type": "DeliveryVehicleNavigationStatus",
|
|
910
1009
|
"id": 3
|
|
@@ -3339,6 +3438,9 @@
|
|
|
3339
3438
|
}
|
|
3340
3439
|
}
|
|
3341
3440
|
},
|
|
3441
|
+
"Empty": {
|
|
3442
|
+
"fields": {}
|
|
3443
|
+
},
|
|
3342
3444
|
"FieldMask": {
|
|
3343
3445
|
"fields": {
|
|
3344
3446
|
"paths": {
|
|
@@ -17,6 +17,7 @@ export declare class DeliveryServiceClient {
|
|
|
17
17
|
private _defaults;
|
|
18
18
|
private _universeDomain;
|
|
19
19
|
private _servicePath;
|
|
20
|
+
private _log;
|
|
20
21
|
auth: gax.GoogleAuth;
|
|
21
22
|
descriptors: Descriptors;
|
|
22
23
|
warn: (code: string, message: string, warnType?: string) => void;
|
|
@@ -51,7 +52,7 @@ export declare class DeliveryServiceClient {
|
|
|
51
52
|
* Developer's Console, e.g. 'grape-spaceship-123'. We will also check
|
|
52
53
|
* the environment variable GCLOUD_PROJECT for your project ID. If your
|
|
53
54
|
* app is running in an environment which supports
|
|
54
|
-
* {@link https://
|
|
55
|
+
* {@link https://cloud.google.com/docs/authentication/application-default-credentials Application Default Credentials},
|
|
55
56
|
* your project ID will be detected automatically.
|
|
56
57
|
* @param {string} [options.apiEndpoint] - The domain name of the
|
|
57
58
|
* API remote host.
|
|
@@ -188,6 +189,37 @@ export declare class DeliveryServiceClient {
|
|
|
188
189
|
]>;
|
|
189
190
|
getDeliveryVehicle(request: protos.maps.fleetengine.delivery.v1.IGetDeliveryVehicleRequest, options: CallOptions, callback: Callback<protos.maps.fleetengine.delivery.v1.IDeliveryVehicle, protos.maps.fleetengine.delivery.v1.IGetDeliveryVehicleRequest | null | undefined, {} | null | undefined>): void;
|
|
190
191
|
getDeliveryVehicle(request: protos.maps.fleetengine.delivery.v1.IGetDeliveryVehicleRequest, callback: Callback<protos.maps.fleetengine.delivery.v1.IDeliveryVehicle, protos.maps.fleetengine.delivery.v1.IGetDeliveryVehicleRequest | null | undefined, {} | null | undefined>): void;
|
|
192
|
+
/**
|
|
193
|
+
* Deletes a DeliveryVehicle from the Fleet Engine.
|
|
194
|
+
*
|
|
195
|
+
* Returns FAILED_PRECONDITION if the DeliveryVehicle has OPEN Tasks
|
|
196
|
+
* assigned to it.
|
|
197
|
+
*
|
|
198
|
+
* @param {Object} request
|
|
199
|
+
* The request object that will be sent.
|
|
200
|
+
* @param {maps.fleetengine.delivery.v1.DeliveryRequestHeader} [request.header]
|
|
201
|
+
* Optional. The standard Delivery API request header.
|
|
202
|
+
* @param {string} request.name
|
|
203
|
+
* Required. Must be in the format
|
|
204
|
+
* `providers/{provider}/deliveryVehicles/{delivery_vehicle}`.
|
|
205
|
+
* The `provider` must be the Google Cloud Project ID. For example,
|
|
206
|
+
* `sample-cloud-project`.
|
|
207
|
+
* @param {object} [options]
|
|
208
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
209
|
+
* @returns {Promise} - The promise which resolves to an array.
|
|
210
|
+
* The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}.
|
|
211
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
|
212
|
+
* for more details and examples.
|
|
213
|
+
* @example <caption>include:samples/generated/v1/delivery_service.delete_delivery_vehicle.js</caption>
|
|
214
|
+
* region_tag:fleetengine_v1_generated_DeliveryService_DeleteDeliveryVehicle_async
|
|
215
|
+
*/
|
|
216
|
+
deleteDeliveryVehicle(request?: protos.maps.fleetengine.delivery.v1.IDeleteDeliveryVehicleRequest, options?: CallOptions): Promise<[
|
|
217
|
+
protos.google.protobuf.IEmpty,
|
|
218
|
+
(protos.maps.fleetengine.delivery.v1.IDeleteDeliveryVehicleRequest | undefined),
|
|
219
|
+
{} | undefined
|
|
220
|
+
]>;
|
|
221
|
+
deleteDeliveryVehicle(request: protos.maps.fleetengine.delivery.v1.IDeleteDeliveryVehicleRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.maps.fleetengine.delivery.v1.IDeleteDeliveryVehicleRequest | null | undefined, {} | null | undefined>): void;
|
|
222
|
+
deleteDeliveryVehicle(request: protos.maps.fleetengine.delivery.v1.IDeleteDeliveryVehicleRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.maps.fleetengine.delivery.v1.IDeleteDeliveryVehicleRequest | null | undefined, {} | null | undefined>): void;
|
|
191
223
|
/**
|
|
192
224
|
* Writes updated `DeliveryVehicle` data to Fleet Engine, and assigns
|
|
193
225
|
* `Tasks` to the `DeliveryVehicle`. You cannot update the name of the
|
|
@@ -294,6 +326,12 @@ export declare class DeliveryServiceClient {
|
|
|
294
326
|
* * `planned_location` (optional for `UNAVAILABLE` tasks)
|
|
295
327
|
* * `task_duration`
|
|
296
328
|
*
|
|
329
|
+
* The following fields can be optionally set:
|
|
330
|
+
*
|
|
331
|
+
* * `target_time_window`
|
|
332
|
+
* * `task_tracking_view_config`
|
|
333
|
+
* * `attributes`
|
|
334
|
+
*
|
|
297
335
|
* Note: The Task's `name` field is ignored. All other Task fields must not be
|
|
298
336
|
* set; otherwise, an error is returned.
|
|
299
337
|
* @param {object} [options]
|
|
@@ -339,6 +377,36 @@ export declare class DeliveryServiceClient {
|
|
|
339
377
|
]>;
|
|
340
378
|
getTask(request: protos.maps.fleetengine.delivery.v1.IGetTaskRequest, options: CallOptions, callback: Callback<protos.maps.fleetengine.delivery.v1.ITask, protos.maps.fleetengine.delivery.v1.IGetTaskRequest | null | undefined, {} | null | undefined>): void;
|
|
341
379
|
getTask(request: protos.maps.fleetengine.delivery.v1.IGetTaskRequest, callback: Callback<protos.maps.fleetengine.delivery.v1.ITask, protos.maps.fleetengine.delivery.v1.IGetTaskRequest | null | undefined, {} | null | undefined>): void;
|
|
380
|
+
/**
|
|
381
|
+
* Deletes a single Task.
|
|
382
|
+
*
|
|
383
|
+
* Returns FAILED_PRECONDITION if the Task is OPEN and assigned to a
|
|
384
|
+
* DeliveryVehicle.
|
|
385
|
+
*
|
|
386
|
+
* @param {Object} request
|
|
387
|
+
* The request object that will be sent.
|
|
388
|
+
* @param {maps.fleetengine.delivery.v1.DeliveryRequestHeader} [request.header]
|
|
389
|
+
* Optional. The standard Delivery API request header.
|
|
390
|
+
* @param {string} request.name
|
|
391
|
+
* Required. Must be in the format `providers/{provider}/tasks/{task}`. The
|
|
392
|
+
* `provider` must be the Google Cloud Project ID. For example,
|
|
393
|
+
* `sample-cloud-project`.
|
|
394
|
+
* @param {object} [options]
|
|
395
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
396
|
+
* @returns {Promise} - The promise which resolves to an array.
|
|
397
|
+
* The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}.
|
|
398
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
|
399
|
+
* for more details and examples.
|
|
400
|
+
* @example <caption>include:samples/generated/v1/delivery_service.delete_task.js</caption>
|
|
401
|
+
* region_tag:fleetengine_v1_generated_DeliveryService_DeleteTask_async
|
|
402
|
+
*/
|
|
403
|
+
deleteTask(request?: protos.maps.fleetengine.delivery.v1.IDeleteTaskRequest, options?: CallOptions): Promise<[
|
|
404
|
+
protos.google.protobuf.IEmpty,
|
|
405
|
+
protos.maps.fleetengine.delivery.v1.IDeleteTaskRequest | undefined,
|
|
406
|
+
{} | undefined
|
|
407
|
+
]>;
|
|
408
|
+
deleteTask(request: protos.maps.fleetengine.delivery.v1.IDeleteTaskRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.maps.fleetengine.delivery.v1.IDeleteTaskRequest | null | undefined, {} | null | undefined>): void;
|
|
409
|
+
deleteTask(request: protos.maps.fleetengine.delivery.v1.IDeleteTaskRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.maps.fleetengine.delivery.v1.IDeleteTaskRequest | null | undefined, {} | null | undefined>): void;
|
|
342
410
|
/**
|
|
343
411
|
* Updates `Task` data.
|
|
344
412
|
*
|
|
@@ -461,7 +529,7 @@ export declare class DeliveryServiceClient {
|
|
|
461
529
|
listTasks(request: protos.maps.fleetengine.delivery.v1.IListTasksRequest, options: CallOptions, callback: PaginationCallback<protos.maps.fleetengine.delivery.v1.IListTasksRequest, protos.maps.fleetengine.delivery.v1.IListTasksResponse | null | undefined, protos.maps.fleetengine.delivery.v1.ITask>): void;
|
|
462
530
|
listTasks(request: protos.maps.fleetengine.delivery.v1.IListTasksRequest, callback: PaginationCallback<protos.maps.fleetengine.delivery.v1.IListTasksRequest, protos.maps.fleetengine.delivery.v1.IListTasksResponse | null | undefined, protos.maps.fleetengine.delivery.v1.ITask>): void;
|
|
463
531
|
/**
|
|
464
|
-
* Equivalent to `
|
|
532
|
+
* Equivalent to `listTasks`, but returns a NodeJS Stream object.
|
|
465
533
|
* @param {Object} request
|
|
466
534
|
* The request object that will be sent.
|
|
467
535
|
* @param {maps.fleetengine.delivery.v1.DeliveryRequestHeader} [request.header]
|
|
@@ -602,7 +670,7 @@ export declare class DeliveryServiceClient {
|
|
|
602
670
|
listDeliveryVehicles(request: protos.maps.fleetengine.delivery.v1.IListDeliveryVehiclesRequest, options: CallOptions, callback: PaginationCallback<protos.maps.fleetengine.delivery.v1.IListDeliveryVehiclesRequest, protos.maps.fleetengine.delivery.v1.IListDeliveryVehiclesResponse | null | undefined, protos.maps.fleetengine.delivery.v1.IDeliveryVehicle>): void;
|
|
603
671
|
listDeliveryVehicles(request: protos.maps.fleetengine.delivery.v1.IListDeliveryVehiclesRequest, callback: PaginationCallback<protos.maps.fleetengine.delivery.v1.IListDeliveryVehiclesRequest, protos.maps.fleetengine.delivery.v1.IListDeliveryVehiclesResponse | null | undefined, protos.maps.fleetengine.delivery.v1.IDeliveryVehicle>): void;
|
|
604
672
|
/**
|
|
605
|
-
* Equivalent to `
|
|
673
|
+
* Equivalent to `listDeliveryVehicles`, but returns a NodeJS Stream object.
|
|
606
674
|
* @param {Object} request
|
|
607
675
|
* The request object that will be sent.
|
|
608
676
|
* @param {maps.fleetengine.delivery.v1.DeliveryRequestHeader} [request.header]
|