@googlemaps/solar 0.5.0 → 0.5.1

package/README.md

@@ -1,24 +1,24 @@
 [//]: # "This README.md file is auto-generated, all changes to this file will be lost."
-[//]: # "To regenerate it, use `python -m synthtool`."
+[//]: # "The comments you see below are used to generate those parts of the template in later states."
 <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"/>
 
-# [Solar API: Node.js Client](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-maps-solar)
-
-[![release level](https://img.shields.io/badge/release%20level-preview-yellow.svg?style=flat)](https://cloud.google.com/terms/launch-stages)
-[![npm version](https://img.shields.io/npm/v/@googlemaps/solar.svg)](https://www.npmjs.org/package/@googlemaps/solar)
-
+# [Solar API: Nodejs Client][homepage]
 
+This library is considered to be in **preview**. This means it is still a
+work-in-progress and under active development. Any release is subject to
+backwards-incompatible changes at any time.
 
+[![npm version](https://img.shields.io/npm/v/@googlemaps/solar.svg)](https://www.npmjs.org/package/@googlemaps/solar)
 
 Solar API client for Node.js
 
+[//]: # "partials.introduction"
 
 A comprehensive list of changes in each version may be found in
-[the CHANGELOG](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-maps-solar/CHANGELOG.md).
+[the CHANGELOG][homepage_changelog].
 
-* [Solar API Node.js Client API Reference][client-docs]
-* [Solar API Documentation][product-docs]
-* [github.com/googleapis/google-cloud-node/packages/google-maps-solar](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-maps-solar)
+* [Solar API Nodejs Client API Reference](https://cloud.google.com/nodejs/docs/reference/solar/latest)
+* [Solar API Documentation](https://developers.google.com/maps/documentation/solar/overview)
 
 Read more about the client libraries for Cloud APIs, including the older
 Google APIs Client Libraries, in [Client Libraries Explained][explained].
@@ -27,18 +27,15 @@ Google APIs Client Libraries, in [Client Libraries Explained][explained].
 
 **Table of contents:**
 
-
 * [Quickstart](#quickstart)
   * [Before you begin](#before-you-begin)
   * [Installing the client library](#installing-the-client-library)
-  * [Using the client library](#using-the-client-library)
-* [Samples](#samples)
+
 * [Versioning](#versioning)
 * [Contributing](#contributing)
 * [License](#license)
 
 ## Quickstart
-
 ### Before you begin
 
 1.  [Select or create a Cloud Platform project][projects].
@@ -46,87 +43,45 @@ Google APIs Client Libraries, in [Client Libraries Explained][explained].
 1.  [Enable the Solar API API][enable_api].
 1.  [Set up authentication][auth] so you can access the
     API from your local workstation.
-
 ### Installing the client library
 
 ```bash
 npm install @googlemaps/solar
 ```
 
+## Terms of Service
 
-### Using the client library
-
-```javascript
-/**
- * This snippet has been automatically generated and should be regarded as a code template only.
- * It will require modifications to work.
- * It may require correct/in-range values for request initialization.
- * TODO(developer): Uncomment these variables before running the sample.
- */
-/**
- *  Required. The longitude and latitude from which the API looks for the
- *  nearest known building.
- */
-// const location = {
-//   latitude: 37.7900161,
-//   longitude: -122.3900146,
-// };
-/**
- *  Optional. The minimum quality level allowed in the results. No result with
- *  lower quality than this will be returned. Not specifying this is
- *  equivalent to restricting to HIGH quality only.
- */
-// const requiredQuality = {}
-/**
- *  Optional. Whether to require exact quality of the imagery.
- *  If set to false, the `required_quality` field is interpreted as the minimum
- *  required quality, such that HIGH quality imagery may be returned when
- *  `required_quality` is set to MEDIUM.  If set to true, `required_quality`
- *  is interpreted as the exact required quality and only `MEDIUM` quality
- *  imagery is returned if `required_quality` is set to `MEDIUM`.
- */
-// const exactQualityRequired = true
-
-// Imports the Solar library
-const {SolarClient} = require('@googlemaps/solar').v1;
-
-// Instantiates a client
-const solarClient = new SolarClient();
-
-async function callFindClosestBuildingInsights() {
-  // Construct request
-  const request = {
-    location,
-    requiredQuality,
-    exactQualityRequired,
-  };
-
-  // Run request
-  const response = await solarClient.findClosestBuildingInsights(request);
-  console.log(response);
-}
-
-callFindClosestBuildingInsights();
-
-```
+`@googlemaps/solar` uses Google Maps Platform services. Use of Google
+Maps Platform services through this library is subject to the
+[Google Maps Platform Terms of Service][gmp-tos].
 
+This library is not a Google Maps Platform Core Service.
+Therefore, the Google Maps Platform Terms of Service (e.g., Technical
+Support Services, Service Level Agreements, and Deprecation Policy)
+do not apply to this library.
 
+### European Economic Area (EEA) developers
 
-## Samples
+If your billing address is in the European Economic Area, effective on
+8 July 2025, the [Google Maps Platform EEA Terms of Service][gmp-tos-eea]
+will apply to your use of the Services. Functionality varies by region.
+[Learn more][gmp-tos-eea-faq].
 
-Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-maps-solar/samples) directory. Each sample's `README.md` has instructions for running its sample.
+[gmp-tos]: https://cloud.google.com/maps-platform/terms
+[gmp-tos-eea]: https://cloud.google.com/terms/maps-platform/eea
+[gmp-tos-eea-faq]: https://developers.google.com/maps/comms/eea/faq
 
-| Sample                      | Source Code                       | Try it |
-| --------------------------- | --------------------------------- | ------ |
-| Solar.find_closest_building_insights | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-solar/samples/generated/v1/solar.find_closest_building_insights.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-solar/samples/generated/v1/solar.find_closest_building_insights.js,packages/google-maps-solar/samples/README.md) |
-| Solar.get_data_layers | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-solar/samples/generated/v1/solar.get_data_layers.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-solar/samples/generated/v1/solar.get_data_layers.js,packages/google-maps-solar/samples/README.md) |
-| Solar.get_geo_tiff | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-solar/samples/generated/v1/solar.get_geo_tiff.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-solar/samples/generated/v1/solar.get_geo_tiff.js,packages/google-maps-solar/samples/README.md) |
-| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-solar/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-solar/samples/quickstart.js,packages/google-maps-solar/samples/README.md) |
+## Samples
 
+Samples are in the [`samples/`][homepage_samples] directory. Each sample's `README.md` has instructions for running its sample.
 
+| Sample                      | Source Code                       |
+| --------------------------- | --------------------------------- |
+| maps | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-solar/samples/generated/v1/snippet_metadata_google.maps.solar.v1.json) |
+| find closest building insights | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-solar/samples/generated/v1/solar.find_closest_building_insights.js) |
+| get data layers | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-solar/samples/generated/v1/solar.get_data_layers.js) |
+| get geo tiff | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-solar/samples/generated/v1/solar.get_geo_tiff.js) |
 
-The [Solar API Node.js Client API Reference][client-docs] documentation
-also contains samples.
 
 ## Supported Node.js Versions
 
@@ -153,41 +108,29 @@ for versions compatible with Node.js 8.
 
 This library follows [Semantic Versioning](http://semver.org/).
 
-
-
-
-
-
-
-This library is considered to be in **preview**. This means it is still a
-work-in-progress and under active development. Any release is subject to
-backwards-incompatible changes at any time.
-
-
 More Information: [Google Cloud Platform Launch Stages][launch_stages]
 
 [launch_stages]: https://cloud.google.com/terms/launch-stages
 
 ## Contributing
 
-Contributions welcome! See the [Contributing Guide](https://github.com/googleapis/google-cloud-node/blob/main/CONTRIBUTING.md).
+Contributions welcome! See the [Contributing Guide](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-solar/CONTRIBUTING.md).
 
-Please note that this `README.md`, the `samples/README.md`,
+Please note that this `README.md`
 and a variety of configuration files in this repository (including `.nycrc` and `tsconfig.json`)
-are generated from a central template. To edit one of these files, make an edit
-to its templates in
-[directory](https://github.com/googleapis/synthtool).
+are generated from a central template.
 
 ## License
 
 Apache Version 2.0
 
-See [LICENSE](https://github.com/googleapis/google-cloud-node/blob/main/LICENSE)
+See [LICENSE](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-solar/LICENSE)
 
-[client-docs]: https://cloud.google.com/nodejs/docs/reference/solar/latest
-[product-docs]: https://developers.google.com/maps/documentation/solar/overview
 [shell_img]: https://gstatic.com/cloudssh/images/open-btn.png
 [projects]: https://console.cloud.google.com/project
 [billing]: https://support.google.com/cloud/answer/6293499#enable-billing
 [enable_api]: https://console.cloud.google.com/flows/enableapi?apiid=solar.googleapis.com
 [auth]: https://cloud.google.com/docs/authentication/external/set-up-adc-local
+[homepage_samples]: https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-solar/samples
+[homepage_changelog]: https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-solar/CHANGELOG.md
+[homepage]: https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-solar