@googlemaps/fleetengine-delivery 0.4.1 → 0.6.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.
@@ -156,7 +156,7 @@ export declare class DeliveryServiceClient {
156
156
  */
157
157
  createDeliveryVehicle(request?: protos.maps.fleetengine.delivery.v1.ICreateDeliveryVehicleRequest, options?: CallOptions): Promise<[
158
158
  protos.maps.fleetengine.delivery.v1.IDeliveryVehicle,
159
- (protos.maps.fleetengine.delivery.v1.ICreateDeliveryVehicleRequest | undefined),
159
+ protos.maps.fleetengine.delivery.v1.ICreateDeliveryVehicleRequest | undefined,
160
160
  {} | undefined
161
161
  ]>;
162
162
  createDeliveryVehicle(request: protos.maps.fleetengine.delivery.v1.ICreateDeliveryVehicleRequest, options: CallOptions, callback: Callback<protos.maps.fleetengine.delivery.v1.IDeliveryVehicle, protos.maps.fleetengine.delivery.v1.ICreateDeliveryVehicleRequest | null | undefined, {} | null | undefined>): void;
@@ -184,7 +184,7 @@ export declare class DeliveryServiceClient {
184
184
  */
185
185
  getDeliveryVehicle(request?: protos.maps.fleetengine.delivery.v1.IGetDeliveryVehicleRequest, options?: CallOptions): Promise<[
186
186
  protos.maps.fleetengine.delivery.v1.IDeliveryVehicle,
187
- (protos.maps.fleetengine.delivery.v1.IGetDeliveryVehicleRequest | undefined),
187
+ protos.maps.fleetengine.delivery.v1.IGetDeliveryVehicleRequest | undefined,
188
188
  {} | undefined
189
189
  ]>;
190
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;
@@ -215,7 +215,7 @@ export declare class DeliveryServiceClient {
215
215
  */
216
216
  deleteDeliveryVehicle(request?: protos.maps.fleetengine.delivery.v1.IDeleteDeliveryVehicleRequest, options?: CallOptions): Promise<[
217
217
  protos.google.protobuf.IEmpty,
218
- (protos.maps.fleetengine.delivery.v1.IDeleteDeliveryVehicleRequest | undefined),
218
+ protos.maps.fleetengine.delivery.v1.IDeleteDeliveryVehicleRequest | undefined,
219
219
  {} | undefined
220
220
  ]>;
221
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;
@@ -253,7 +253,7 @@ export declare class DeliveryServiceClient {
253
253
  */
254
254
  updateDeliveryVehicle(request?: protos.maps.fleetengine.delivery.v1.IUpdateDeliveryVehicleRequest, options?: CallOptions): Promise<[
255
255
  protos.maps.fleetengine.delivery.v1.IDeliveryVehicle,
256
- (protos.maps.fleetengine.delivery.v1.IUpdateDeliveryVehicleRequest | undefined),
256
+ protos.maps.fleetengine.delivery.v1.IUpdateDeliveryVehicleRequest | undefined,
257
257
  {} | undefined
258
258
  ]>;
259
259
  updateDeliveryVehicle(request: protos.maps.fleetengine.delivery.v1.IUpdateDeliveryVehicleRequest, options: CallOptions, callback: Callback<protos.maps.fleetengine.delivery.v1.IDeliveryVehicle, protos.maps.fleetengine.delivery.v1.IUpdateDeliveryVehicleRequest | null | undefined, {} | null | undefined>): void;
@@ -477,50 +477,50 @@ export declare class DeliveryServiceClient {
477
477
  */
478
478
  getTaskTrackingInfo(request?: protos.maps.fleetengine.delivery.v1.IGetTaskTrackingInfoRequest, options?: CallOptions): Promise<[
479
479
  protos.maps.fleetengine.delivery.v1.ITaskTrackingInfo,
480
- (protos.maps.fleetengine.delivery.v1.IGetTaskTrackingInfoRequest | undefined),
480
+ protos.maps.fleetengine.delivery.v1.IGetTaskTrackingInfoRequest | undefined,
481
481
  {} | undefined
482
482
  ]>;
483
483
  getTaskTrackingInfo(request: protos.maps.fleetengine.delivery.v1.IGetTaskTrackingInfoRequest, options: CallOptions, callback: Callback<protos.maps.fleetengine.delivery.v1.ITaskTrackingInfo, protos.maps.fleetengine.delivery.v1.IGetTaskTrackingInfoRequest | null | undefined, {} | null | undefined>): void;
484
484
  getTaskTrackingInfo(request: protos.maps.fleetengine.delivery.v1.IGetTaskTrackingInfoRequest, callback: Callback<protos.maps.fleetengine.delivery.v1.ITaskTrackingInfo, protos.maps.fleetengine.delivery.v1.IGetTaskTrackingInfoRequest | null | undefined, {} | null | undefined>): void;
485
485
  /**
486
- * Gets all `Task`s that meet the specified filtering criteria.
487
- *
488
- * @param {Object} request
489
- * The request object that will be sent.
490
- * @param {maps.fleetengine.delivery.v1.DeliveryRequestHeader} [request.header]
491
- * Optional. The standard Delivery API request header.
492
- * @param {string} request.parent
493
- * Required. Must be in the format `providers/{provider}`.
494
- * The `provider` must be the Google Cloud Project ID. For example,
495
- * `sample-cloud-project`.
496
- * @param {number} [request.pageSize]
497
- * Optional. The maximum number of Tasks to return. The service may return
498
- * fewer than this value. If you don't specify this value, then the server
499
- * determines the number of results to return.
500
- * @param {string} [request.pageToken]
501
- * Optional. A page token received from a previous `ListTasks` call.
502
- * You can provide this to retrieve the subsequent page.
503
- *
504
- * When paginating, all other parameters provided to `ListTasks` must match
505
- * the call that provided the page token.
506
- * @param {string} [request.filter]
507
- * Optional. A filter query to apply when listing Tasks. See
508
- * http://aip.dev/160 for examples of filter syntax. If you don't specify a
509
- * value, or if you filter on an empty string, then all Tasks are returned.
510
- * For information about the Task properties that you can filter on, see [List
511
- * tasks](https://developers.google.com/maps/documentation/mobility/fleet-engine/journeys/tasks/find-tasks#filter_listed_tasks).
512
- * @param {object} [options]
513
- * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
514
- * @returns {Promise} - The promise which resolves to an array.
515
- * The first element of the array is Array of {@link protos.maps.fleetengine.delivery.v1.Task|Task}.
516
- * The client library will perform auto-pagination by default: it will call the API as many
517
- * times as needed and will merge results from all the pages into this array.
518
- * Note that it can affect your quota.
519
- * We recommend using `listTasksAsync()`
520
- * method described below for async iteration which you can stop as needed.
521
- * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
522
- * for more details and examples.
523
- */
486
+ * Gets all `Task`s that meet the specified filtering criteria.
487
+ *
488
+ * @param {Object} request
489
+ * The request object that will be sent.
490
+ * @param {maps.fleetengine.delivery.v1.DeliveryRequestHeader} [request.header]
491
+ * Optional. The standard Delivery API request header.
492
+ * @param {string} request.parent
493
+ * Required. Must be in the format `providers/{provider}`.
494
+ * The `provider` must be the Google Cloud Project ID. For example,
495
+ * `sample-cloud-project`.
496
+ * @param {number} [request.pageSize]
497
+ * Optional. The maximum number of Tasks to return. The service may return
498
+ * fewer than this value. If you don't specify this value, then the server
499
+ * determines the number of results to return.
500
+ * @param {string} [request.pageToken]
501
+ * Optional. A page token received from a previous `ListTasks` call.
502
+ * You can provide this to retrieve the subsequent page.
503
+ *
504
+ * When paginating, all other parameters provided to `ListTasks` must match
505
+ * the call that provided the page token.
506
+ * @param {string} [request.filter]
507
+ * Optional. A filter query to apply when listing Tasks. See
508
+ * http://aip.dev/160 for examples of filter syntax. If you don't specify a
509
+ * value, or if you filter on an empty string, then all Tasks are returned.
510
+ * For information about the Task properties that you can filter on, see [List
511
+ * tasks](https://developers.google.com/maps/documentation/mobility/fleet-engine/journeys/tasks/find-tasks#filter_listed_tasks).
512
+ * @param {object} [options]
513
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
514
+ * @returns {Promise} - The promise which resolves to an array.
515
+ * The first element of the array is Array of {@link protos.maps.fleetengine.delivery.v1.Task|Task}.
516
+ * The client library will perform auto-pagination by default: it will call the API as many
517
+ * times as needed and will merge results from all the pages into this array.
518
+ * Note that it can affect your quota.
519
+ * We recommend using `listTasksAsync()`
520
+ * method described below for async iteration which you can stop as needed.
521
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
522
+ * for more details and examples.
523
+ */
524
524
  listTasks(request?: protos.maps.fleetengine.delivery.v1.IListTasksRequest, options?: CallOptions): Promise<[
525
525
  protos.maps.fleetengine.delivery.v1.ITask[],
526
526
  protos.maps.fleetengine.delivery.v1.IListTasksRequest | null,
@@ -608,60 +608,60 @@ export declare class DeliveryServiceClient {
608
608
  */
609
609
  listTasksAsync(request?: protos.maps.fleetengine.delivery.v1.IListTasksRequest, options?: CallOptions): AsyncIterable<protos.maps.fleetengine.delivery.v1.ITask>;
610
610
  /**
611
- * Gets all `DeliveryVehicle`s that meet the specified filtering criteria.
612
- *
613
- * @param {Object} request
614
- * The request object that will be sent.
615
- * @param {maps.fleetengine.delivery.v1.DeliveryRequestHeader} [request.header]
616
- * Optional. The standard Delivery API request header.
617
- * @param {string} request.parent
618
- * Required. Must be in the format `providers/{provider}`.
619
- * The `provider` must be the Google Cloud Project ID.
620
- * For example, `sample-cloud-project`.
621
- * @param {number} [request.pageSize]
622
- * Optional. The maximum number of vehicles to return. The service may return
623
- * fewer than this number. If you don't specify this number, then the server
624
- * determines the number of results to return.
625
- * @param {string} [request.pageToken]
626
- * Optional. A page token, received from a previous `ListDeliveryVehicles`
627
- * call. You must provide this in order to retrieve the subsequent page.
628
- *
629
- * When paginating, all other parameters provided to `ListDeliveryVehicles`
630
- * must match the call that provided the page token.
631
- * @param {string} [request.filter]
632
- * Optional. A filter query to apply when listing delivery vehicles. See
633
- * http://aip.dev/160 for examples of the filter syntax. If you don't specify
634
- * a value, or if you specify an empty string for the filter, then all
635
- * delivery vehicles are returned.
636
- *
637
- * Note that the only queries supported for `ListDeliveryVehicles` are
638
- * on vehicle attributes (for example, `attributes.<key> = <value>` or
639
- * `attributes.<key1> = <value1> AND attributes.<key2> = <value2>`). Also, all
640
- * attributes are stored as strings, so the only supported comparisons against
641
- * attributes are string comparisons. In order to compare against number or
642
- * boolean values, the values must be explicitly quoted to be treated as
643
- * strings (for example, `attributes.<key> = "10"` or
644
- * `attributes.<key> = "true"`).
645
- *
646
- * The maximum number of restrictions allowed in a filter query is 50. A
647
- * restriction is a part of the query of the form
648
- * `attribute.<KEY> <COMPARATOR> <VALUE>`, for example `attributes.foo = bar`
649
- * is 1 restriction.
650
- * @param {google.geo.type.Viewport} [request.viewport]
651
- * Optional. A filter that limits the vehicles returned to those whose last
652
- * known location was in the rectangular area defined by the viewport.
653
- * @param {object} [options]
654
- * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
655
- * @returns {Promise} - The promise which resolves to an array.
656
- * The first element of the array is Array of {@link protos.maps.fleetengine.delivery.v1.DeliveryVehicle|DeliveryVehicle}.
657
- * The client library will perform auto-pagination by default: it will call the API as many
658
- * times as needed and will merge results from all the pages into this array.
659
- * Note that it can affect your quota.
660
- * We recommend using `listDeliveryVehiclesAsync()`
661
- * method described below for async iteration which you can stop as needed.
662
- * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
663
- * for more details and examples.
664
- */
611
+ * Gets all `DeliveryVehicle`s that meet the specified filtering criteria.
612
+ *
613
+ * @param {Object} request
614
+ * The request object that will be sent.
615
+ * @param {maps.fleetengine.delivery.v1.DeliveryRequestHeader} [request.header]
616
+ * Optional. The standard Delivery API request header.
617
+ * @param {string} request.parent
618
+ * Required. Must be in the format `providers/{provider}`.
619
+ * The `provider` must be the Google Cloud Project ID.
620
+ * For example, `sample-cloud-project`.
621
+ * @param {number} [request.pageSize]
622
+ * Optional. The maximum number of vehicles to return. The service may return
623
+ * fewer than this number. If you don't specify this number, then the server
624
+ * determines the number of results to return.
625
+ * @param {string} [request.pageToken]
626
+ * Optional. A page token, received from a previous `ListDeliveryVehicles`
627
+ * call. You must provide this in order to retrieve the subsequent page.
628
+ *
629
+ * When paginating, all other parameters provided to `ListDeliveryVehicles`
630
+ * must match the call that provided the page token.
631
+ * @param {string} [request.filter]
632
+ * Optional. A filter query to apply when listing delivery vehicles. See
633
+ * http://aip.dev/160 for examples of the filter syntax. If you don't specify
634
+ * a value, or if you specify an empty string for the filter, then all
635
+ * delivery vehicles are returned.
636
+ *
637
+ * Note that the only queries supported for `ListDeliveryVehicles` are
638
+ * on vehicle attributes (for example, `attributes.<key> = <value>` or
639
+ * `attributes.<key1> = <value1> AND attributes.<key2> = <value2>`). Also, all
640
+ * attributes are stored as strings, so the only supported comparisons against
641
+ * attributes are string comparisons. In order to compare against number or
642
+ * boolean values, the values must be explicitly quoted to be treated as
643
+ * strings (for example, `attributes.<key> = "10"` or
644
+ * `attributes.<key> = "true"`).
645
+ *
646
+ * The maximum number of restrictions allowed in a filter query is 50. A
647
+ * restriction is a part of the query of the form
648
+ * `attribute.<KEY> <COMPARATOR> <VALUE>`, for example `attributes.foo = bar`
649
+ * is 1 restriction.
650
+ * @param {google.geo.type.Viewport} [request.viewport]
651
+ * Optional. A filter that limits the vehicles returned to those whose last
652
+ * known location was in the rectangular area defined by the viewport.
653
+ * @param {object} [options]
654
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
655
+ * @returns {Promise} - The promise which resolves to an array.
656
+ * The first element of the array is Array of {@link protos.maps.fleetengine.delivery.v1.DeliveryVehicle|DeliveryVehicle}.
657
+ * The client library will perform auto-pagination by default: it will call the API as many
658
+ * times as needed and will merge results from all the pages into this array.
659
+ * Note that it can affect your quota.
660
+ * We recommend using `listDeliveryVehiclesAsync()`
661
+ * method described below for async iteration which you can stop as needed.
662
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
663
+ * for more details and examples.
664
+ */
665
665
  listDeliveryVehicles(request?: protos.maps.fleetengine.delivery.v1.IListDeliveryVehiclesRequest, options?: CallOptions): Promise<[
666
666
  protos.maps.fleetengine.delivery.v1.IDeliveryVehicle[],
667
667
  protos.maps.fleetengine.delivery.v1.IListDeliveryVehiclesRequest | null,