@maxim_mazurok/gapi.client.solar-v1 0.0.20240327

package/index.d.ts

@@ -0,0 +1,383 @@
+/* Type definitions for non-npm package Solar API v1 0.0 */
+// Project: https://developers.google.com/maps/documentation/solar
+// Definitions by: Maxim Mazurok <https://github.com/Maxim-Mazurok>
+//                 Nick Amoscato <https://github.com/namoscato>
+//                 Declan Vong <https://github.com/declanvong>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+
+// IMPORTANT
+// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
+// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
+// Generated from: https://solar.googleapis.com/$discovery/rest?version=v1
+// Revision: 20240327
+
+/// <reference types="gapi.client" />
+
+declare namespace gapi.client {
+  /** Load Solar API v1 */
+  function load(
+    urlOrObject: 'https://solar.googleapis.com/$discovery/rest?version=v1'
+  ): Promise<void>;
+  /** @deprecated Please load APIs with discovery documents. */
+  function load(name: 'solar', version: 'v1'): Promise<void>;
+  /** @deprecated Please load APIs with discovery documents. */
+  function load(name: 'solar', version: 'v1', callback: () => any): void;
+
+  namespace solar {
+    interface BuildingInsights {
+      /** Administrative area 1 (e.g., in the US, the state) that contains this building. For example, in the US, the abbreviation might be "MA" or "CA." */
+      administrativeArea?: string;
+      /** The bounding box of the building. */
+      boundingBox?: LatLngBox;
+      /** A point near the center of the building. */
+      center?: LatLng;
+      /** Date that the underlying imagery was acquired. This is approximate. */
+      imageryDate?: Date;
+      /** When processing was completed on this imagery. */
+      imageryProcessedDate?: Date;
+      /** The quality of the imagery used to compute the data for this building. */
+      imageryQuality?: string;
+      /** The resource name for the building, of the format `building/`. */
+      name?: string;
+      /** Postal code (e.g., US zip code) this building is contained by. */
+      postalCode?: string;
+      /** Region code for the country (or region) this building is in. */
+      regionCode?: string;
+      /** Solar potential of the building. */
+      solarPotential?: SolarPotential;
+      /** Statistical area (e.g., US census tract) this building is in. */
+      statisticalArea?: string;
+    }
+    interface CashPurchaseSavings {
+      /** Initial cost before tax incentives: the amount that must be paid out-of-pocket. Contrast with `upfront_cost`, which is after tax incentives. */
+      outOfPocketCost?: Money;
+      /** Number of years until payback occurs. A negative value means payback never occurs within the lifetime period. */
+      paybackYears?: number;
+      /** The value of all tax rebates. */
+      rebateValue?: Money;
+      /** How much is saved (or not) over the lifetime period. */
+      savings?: SavingsOverTime;
+      /** Initial cost after tax incentives: it's the amount that must be paid during first year. Contrast with `out_of_pocket_cost`, which is before tax incentives. */
+      upfrontCost?: Money;
+    }
+    interface DataLayers {
+      /** The URL for the annual flux map (annual sunlight on roofs) of the region. Values are kWh/kW/year. This is *unmasked flux*: flux is computed for every location, not just building rooftops. Invalid locations are stored as -9999: locations outside our coverage area will be invalid, and a few locations inside the coverage area, where we were unable to calculate flux, will also be invalid. */
+      annualFluxUrl?: string;
+      /** The URL for an image of the DSM (Digital Surface Model) of the region. Values are in meters above EGM96 geoid (i.e., sea level). Invalid locations (where we don't have data) are stored as -9999. */
+      dsmUrl?: string;
+      /** Twelve URLs for hourly shade, corresponding to January...December, in order. Each GeoTIFF will contain 24 bands, corresponding to the 24 hours of the day. Each pixel is a 32 bit integer, corresponding to the (up to) 31 days of that month; a 1 bit means that the corresponding location is able to see the sun at that day, of that hour, of that month. Invalid locations are stored as -9999 (since this is negative, it has bit 31 set, and no valid value could have bit 31 set as that would correspond to the 32nd day of the month). An example may be useful. If you want to know whether a point (at pixel location (x, y)) saw sun at 4pm on the 22nd of June you would: 1. fetch the sixth URL in this list (corresponding to June). 1. look up the 17th channel (corresponding to 4pm). 1. read the 32-bit value at (x, y). 1. read bit 21 of the value (corresponding to the 22nd of the month). 1. if that bit is a 1, then that spot saw the sun at 4pm 22 June. More formally: Given `month` (1-12), `day` (1...month max; February has 28 days) and `hour` (0-23), the shade/sun for that month/day/hour at a position `(x, y)` is the bit ``` (hourly_shade[month - 1])(x, y)[hour] & (1 << (day - 1)) ``` where `(x, y)` is spatial indexing, `[month - 1]` refers to fetching the `month - 1`st URL (indexing from zero), `[hour]` is indexing into the channels, and a final non-zero result means "sunny". There are no leap days, and DST doesn't exist (all days are 24 hours long; noon is always "standard time" noon). */
+      hourlyShadeUrls?: string[];
+      /** When the source imagery (from which all the other data are derived) in this region was taken. It is necessarily somewhat approximate, as the images may have been taken over more than one day. */
+      imageryDate?: Date;
+      /** When processing was completed on this imagery. */
+      imageryProcessedDate?: Date;
+      /** The quality of the result's imagery. */
+      imageryQuality?: string;
+      /** The URL for the building mask image: one bit per pixel saying whether that pixel is considered to be part of a rooftop or not. */
+      maskUrl?: string;
+      /** The URL for the monthly flux map (sunlight on roofs, broken down by month) of the region. Values are kWh/kW/year. The GeoTIFF pointed to by this URL will contain twelve bands, corresponding to January...December, in order. */
+      monthlyFluxUrl?: string;
+      /** The URL for an image of RGB data (aerial photo) of the region. */
+      rgbUrl?: string;
+    }
+    interface Date {
+      /** Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. */
+      day?: number;
+      /** Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. */
+      month?: number;
+      /** Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. */
+      year?: number;
+    }
+    interface FinancedPurchaseSavings {
+      /** Annual loan payments. */
+      annualLoanPayment?: Money;
+      /** The interest rate on loans assumed in this set of calculations. */
+      loanInterestRate?: number;
+      /** The value of all tax rebates (including Federal Investment Tax Credit (ITC)). */
+      rebateValue?: Money;
+      /** How much is saved (or not) over the lifetime period. */
+      savings?: SavingsOverTime;
+    }
+    interface FinancialAnalysis {
+      /** How much electricity the house uses in an average month, based on the bill size and the local electricity rates. */
+      averageKwhPerMonth?: number;
+      /** Cost and benefit of buying the solar panels with cash. */
+      cashPurchaseSavings?: CashPurchaseSavings;
+      /** Whether this is the bill size selected to be the default bill for the area this building is in. Exactly one `FinancialAnalysis` in `BuildingSolarPotential` should have `default_bill` set. */
+      defaultBill?: boolean;
+      /** Cost and benefit of buying the solar panels by financing the purchase. */
+      financedPurchaseSavings?: FinancedPurchaseSavings;
+      /** Financial information that applies regardless of the financing method used. */
+      financialDetails?: FinancialDetails;
+      /** Cost and benefit of leasing the solar panels. */
+      leasingSavings?: LeasingSavings;
+      /** The monthly electric bill this analysis assumes. */
+      monthlyBill?: Money;
+      /** Index in solar_panel_configs of the optimum solar layout for this bill size. This can be -1 indicating that there is no layout. In this case, the remaining submessages will be omitted. */
+      panelConfigIndex?: number;
+    }
+    interface FinancialDetails {
+      /** Total cost of electricity the user would have paid over the lifetime period if they didn't install solar. */
+      costOfElectricityWithoutSolar?: Money;
+      /** Amount of money available from federal incentives; this applies if the user buys (with or without a loan) the panels. */
+      federalIncentive?: Money;
+      /** How many AC kWh we think the solar panels will generate in their first year. */
+      initialAcKwhPerYear?: number;
+      /** Amount of money the user will receive from Solar Renewable Energy Credits over the panel lifetime; this applies if the user buys (with or without a loan) the panels. */
+      lifetimeSrecTotal?: Money;
+      /** Whether net metering is allowed. */
+      netMeteringAllowed?: boolean;
+      /** The percentage (0-100) of solar electricity production we assumed was exported to the grid, based on the first quarter of production. This affects the calculations if net metering is not allowed. */
+      percentageExportedToGrid?: number;
+      /** Utility bill for electricity not produced by solar, for the lifetime of the panels. */
+      remainingLifetimeUtilityBill?: Money;
+      /** Percentage (0-100) of the user's power supplied by solar. Valid for the first year but approximately correct for future years. */
+      solarPercentage?: number;
+      /** Amount of money available from state incentives; this applies if the user buys (with or without a loan) the panels. */
+      stateIncentive?: Money;
+      /** Amount of money available from utility incentives; this applies if the user buys (with or without a loan) the panels. */
+      utilityIncentive?: Money;
+    }
+    interface HttpBody {
+      /** The HTTP Content-Type header value specifying the content type of the body. */
+      contentType?: string;
+      /** The HTTP request/response body as raw binary. */
+      data?: string;
+      /** Application specific response metadata. Must be set in the first response for streaming APIs. */
+      extensions?: Array<{[P in string]: any}>;
+    }
+    interface LatLng {
+      /** The latitude in degrees. It must be in the range [-90.0, +90.0]. */
+      latitude?: number;
+      /** The longitude in degrees. It must be in the range [-180.0, +180.0]. */
+      longitude?: number;
+    }
+    interface LatLngBox {
+      /** The northeast corner of the box. */
+      ne?: LatLng;
+      /** The southwest corner of the box. */
+      sw?: LatLng;
+    }
+    interface LeasingSavings {
+      /** Estimated annual leasing cost. */
+      annualLeasingCost?: Money;
+      /** Whether leases are allowed in this juristiction (leases are not allowed in some states). If this field is false, then the values in this message should probably be ignored. */
+      leasesAllowed?: boolean;
+      /** Whether leases are supported in this juristiction by the financial calculation engine. If this field is false, then the values in this message should probably be ignored. This is independent of `leases_allowed`: in some areas leases are allowed, but under conditions that aren't handled by the financial models. */
+      leasesSupported?: boolean;
+      /** How much is saved (or not) over the lifetime period. */
+      savings?: SavingsOverTime;
+    }
+    interface Money {
+      /** The three-letter currency code defined in ISO 4217. */
+      currencyCode?: string;
+      /** Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. */
+      nanos?: number;
+      /** The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. */
+      units?: string;
+    }
+    interface RoofSegmentSizeAndSunshineStats {
+      /** Compass direction the roof segment is pointing in. 0 = North, 90 = East, 180 = South. For a "flat" roof segment (`pitch_degrees` very near 0), azimuth is not well defined, so for consistency, we define it arbitrarily to be 0 (North). */
+      azimuthDegrees?: number;
+      /** The bounding box of the roof segment. */
+      boundingBox?: LatLngBox;
+      /** A point near the center of the roof segment. */
+      center?: LatLng;
+      /** Angle of the roof segment relative to the theoretical ground plane. 0 = parallel to the ground, 90 = perpendicular to the ground. */
+      pitchDegrees?: number;
+      /** The height of the roof segment plane, in meters above sea level, at the point designated by `center`. Together with the pitch, azimuth, and center location, this fully defines the roof segment plane. */
+      planeHeightAtCenterMeters?: number;
+      /** Total size and sunlight quantiles for the roof segment. */
+      stats?: SizeAndSunshineStats;
+    }
+    interface RoofSegmentSummary {
+      /** Compass direction the roof segment is pointing in. 0 = North, 90 = East, 180 = South. For a "flat" roof segment (`pitch_degrees` very near 0), azimuth is not well defined, so for consistency, we define it arbitrarily to be 0 (North). */
+      azimuthDegrees?: number;
+      /** The total number of panels on this segment. */
+      panelsCount?: number;
+      /** Angle of the roof segment relative to the theoretical ground plane. 0 = parallel to the ground, 90 = perpendicular to the ground. */
+      pitchDegrees?: number;
+      /** Index in roof_segment_stats of the corresponding `RoofSegmentSizeAndSunshineStats`. */
+      segmentIndex?: number;
+      /** How much sunlight energy this part of the layout captures over the course of a year, in DC kWh, assuming the panels described above. */
+      yearlyEnergyDcKwh?: number;
+    }
+    interface SavingsOverTime {
+      /** Indicates whether this scenario is financially viable. Will be false for scenarios with poor financial viability (e.g., money-losing). */
+      financiallyViable?: boolean;
+      /** Using the assumed discount rate, what is the present value of the cumulative lifetime savings? */
+      presentValueOfSavingsLifetime?: Money;
+      /** Using the assumed discount rate, what is the present value of the cumulative 20-year savings? */
+      presentValueOfSavingsYear20?: Money;
+      /** Savings in the entire panel lifetime. */
+      savingsLifetime?: Money;
+      /** Savings in the first year after panel installation. */
+      savingsYear1?: Money;
+      /** Savings in the first twenty years after panel installation. */
+      savingsYear20?: Money;
+    }
+    interface SizeAndSunshineStats {
+      /** The area of the roof or roof segment, in m^2. This is the roof area (accounting for tilt), not the ground footprint area. */
+      areaMeters2?: number;
+      /** The ground footprint area covered by the roof or roof segment, in m^2. */
+      groundAreaMeters2?: number;
+      /** Quantiles of the pointwise sunniness across the area. If there are N values here, this represents the (N-1)-iles. For example, if there are 5 values, then they would be the quartiles (min, 25%, 50%, 75%, max). Values are in annual kWh/kW like max_sunshine_hours_per_year. */
+      sunshineQuantiles?: number[];
+    }
+    interface SolarPanel {
+      /** The centre of the panel. */
+      center?: LatLng;
+      /** The orientation of the panel. */
+      orientation?: string;
+      /** Index in roof_segment_stats of the `RoofSegmentSizeAndSunshineStats` which corresponds to the roof segment that this panel is placed on. */
+      segmentIndex?: number;
+      /** How much sunlight energy this layout captures over the course of a year, in DC kWh. */
+      yearlyEnergyDcKwh?: number;
+    }
+    interface SolarPanelConfig {
+      /** Total number of panels. Note that this is redundant to (the sum of) the corresponding fields in roof_segment_summaries. */
+      panelsCount?: number;
+      /** Information about the production of each roof segment that is carrying at least one panel in this layout. `roof_segment_summaries[i]` describes the i-th roof segment, including its size, expected production and orientation. */
+      roofSegmentSummaries?: RoofSegmentSummary[];
+      /** How much sunlight energy this layout captures over the course of a year, in DC kWh, assuming the panels described above. */
+      yearlyEnergyDcKwh?: number;
+    }
+    interface SolarPotential {
+      /** Size and sunlight quantiles for the entire building, including parts of the roof that were not assigned to some roof segment. Because the orientations of these parts are not well characterised, the roof area estimate is unreliable, but the ground area estimate is reliable. It may be that a more reliable whole building roof area can be obtained by scaling the roof area from whole_roof_stats by the ratio of the ground areas of `building_stats` and `whole_roof_stats`. */
+      buildingStats?: SizeAndSunshineStats;
+      /** Equivalent amount of CO2 produced per MWh of grid electricity. This is a measure of the carbon intensity of grid electricity displaced by solar electricity. */
+      carbonOffsetFactorKgPerMwh?: number;
+      /** A FinancialAnalysis gives the savings from going solar assuming a given monthly bill and a given electricity provider. They are in order of increasing order of monthly bill amount. This field will be empty for buildings in areas for which the Solar API does not have enough information to perform financial computations. */
+      financialAnalyses?: FinancialAnalysis[];
+      /** Size, in square meters, of the maximum array. */
+      maxArrayAreaMeters2?: number;
+      /** Size of the maximum array - that is, the maximum number of panels that can fit on the roof. */
+      maxArrayPanelsCount?: number;
+      /** Maximum number of sunshine hours received per year, by any point on the roof. Sunshine hours are a measure of the total amount of insolation (energy) received per year. 1 sunshine hour = 1 kWh per kW (where kW refers to kW of capacity under Standard Testing Conditions). */
+      maxSunshineHoursPerYear?: number;
+      /** Capacity, in watts, of the panel used in the calculations. */
+      panelCapacityWatts?: number;
+      /** Height, in meters in portrait orientation, of the panel used in the calculations. */
+      panelHeightMeters?: number;
+      /** The expected lifetime, in years, of the solar panels. This is used in the financial calculations. */
+      panelLifetimeYears?: number;
+      /** Width, in meters in portrait orientation, of the panel used in the calculations. */
+      panelWidthMeters?: number;
+      /** Size and sunlight quantiles for each roof segment. */
+      roofSegmentStats?: RoofSegmentSizeAndSunshineStats[];
+      /** Each SolarPanelConfig describes a different arrangement of solar panels on the roof. They are in order of increasing number of panels. The `SolarPanelConfig` with panels_count=N is based on the first N panels in the `solar_panels` list. This field is only populated if at least 4 panels can fit on a roof. */
+      solarPanelConfigs?: SolarPanelConfig[];
+      /** Each SolarPanel describes a single solar panel. They are listed in the order that the panel layout algorithm placed this. This is usually, though not always, in decreasing order of annual energy production. */
+      solarPanels?: SolarPanel[];
+      /** Total size and sunlight quantiles for the part of the roof that was assigned to some roof segment. Despite the name, this may not include the entire building. See building_stats. */
+      wholeRoofStats?: SizeAndSunshineStats;
+    }
+    interface BuildingInsightsResource {
+      /** Locates the closest building to a query point. Returns an error with code `NOT_FOUND` if there are no buildings within approximately 50m of the query point. */
+      findClosest(request?: {
+        /** V1 error format. */
+        '$.xgafv'?: string;
+        /** OAuth access token. */
+        access_token?: string;
+        /** Data format for response. */
+        alt?: string;
+        /** JSONP */
+        callback?: string;
+        /** Selector specifying which fields to include in a partial response. */
+        fields?: string;
+        /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+        key?: string;
+        /** The latitude in degrees. It must be in the range [-90.0, +90.0]. */
+        'location.latitude'?: number;
+        /** The longitude in degrees. It must be in the range [-180.0, +180.0]. */
+        'location.longitude'?: number;
+        /** OAuth 2.0 token for the current user. */
+        oauth_token?: string;
+        /** Returns response with indentations and line breaks. */
+        prettyPrint?: boolean;
+        /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+        quotaUser?: string;
+        /** 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. */
+        requiredQuality?: string;
+        /** Upload protocol for media (e.g. "raw", "multipart"). */
+        upload_protocol?: string;
+        /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+        uploadType?: string;
+      }): Request<BuildingInsights>;
+    }
+    interface DataLayersResource {
+      /** Gets solar information for a region surrounding a location. Returns an error with code `NOT_FOUND` if the location is outside the coverage area. */
+      get(request?: {
+        /** V1 error format. */
+        '$.xgafv'?: string;
+        /** OAuth access token. */
+        access_token?: string;
+        /** Data format for response. */
+        alt?: string;
+        /** JSONP */
+        callback?: string;
+        /** Selector specifying which fields to include in a partial response. */
+        fields?: string;
+        /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+        key?: string;
+        /** The latitude in degrees. It must be in the range [-90.0, +90.0]. */
+        'location.latitude'?: number;
+        /** The longitude in degrees. It must be in the range [-180.0, +180.0]. */
+        'location.longitude'?: number;
+        /** OAuth 2.0 token for the current user. */
+        oauth_token?: string;
+        /** Optional. The minimum scale, in meters per pixel, of the data to return. Values of 0.1 (the default, if this field is not set explicitly), 0.25, 0.5, and 1.0 are supported. Imagery components whose normal resolution is less than `pixel_size_meters` will be returned at the resolution specified by `pixel_size_meters`; imagery components whose normal resolution is equal to or greater than `pixel_size_meters` will be returned at that normal resolution. */
+        pixelSizeMeters?: number;
+        /** Returns response with indentations and line breaks. */
+        prettyPrint?: boolean;
+        /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+        quotaUser?: string;
+        /** Required. The radius, in meters, defining the region surrounding that centre point for which data should be returned. The limitations on this value are: * Any value up to 100m can always be specified. * Values over 100m can be specified, as long as `radius_meters` <= `pixel_size_meters * 1000`. * However, for values over 175m, the `DataLayerView` in the request must not include monthly flux or hourly shade. */
+        radiusMeters?: number;
+        /** 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. */
+        requiredQuality?: string;
+        /** Upload protocol for media (e.g. "raw", "multipart"). */
+        upload_protocol?: string;
+        /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+        uploadType?: string;
+        /** Optional. The desired subset of the data to return. */
+        view?: string;
+      }): Request<DataLayers>;
+    }
+    interface GeoTiffResource {
+      /** Returns an image by its ID. */
+      get(request?: {
+        /** V1 error format. */
+        '$.xgafv'?: string;
+        /** OAuth access token. */
+        access_token?: string;
+        /** Data format for response. */
+        alt?: string;
+        /** JSONP */
+        callback?: string;
+        /** Selector specifying which fields to include in a partial response. */
+        fields?: string;
+        /** Required. The ID of the asset being requested. */
+        id?: string;
+        /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+        key?: string;
+        /** OAuth 2.0 token for the current user. */
+        oauth_token?: string;
+        /** Returns response with indentations and line breaks. */
+        prettyPrint?: boolean;
+        /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+        quotaUser?: string;
+        /** Upload protocol for media (e.g. "raw", "multipart"). */
+        upload_protocol?: string;
+        /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+        uploadType?: string;
+      }): Request<HttpBody>;
+    }
+
+    const buildingInsights: BuildingInsightsResource;
+
+    const dataLayers: DataLayersResource;
+
+    const geoTiff: GeoTiffResource;
+  }
+}

package/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "@maxim_mazurok/gapi.client.solar-v1",
+  "version": "0.0.20240327",
+  "description": "TypeScript typings for Solar API v1",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Maxim-Mazurok/google-api-typings-generator.git"
+  },
+  "license": "MIT",
+  "author": {
+    "name": "Maxim Mazurok",
+    "email": "maxim@mazurok.com",
+    "url": "https://maxim.mazurok.com"
+  },
+  "types": "index.d.ts",
+  "dependencies": {
+    "@types/gapi.client": "*",
+    "@types/gapi.client.discovery-v1": "*"
+  }
+}

package/readme.md

@@ -0,0 +1,86 @@
+# TypeScript typings for Solar API v1
+
+Solar API.
+For detailed description please check [documentation](https://developers.google.com/maps/documentation/solar).
+
+## Installing
+
+Install typings for Solar API:
+
+```
+npm install @types/gapi.client.solar-v1 --save-dev
+```
+
+## Usage
+
+You need to initialize Google API client in your code:
+
+```typescript
+gapi.load('client', () => {
+  // now we can use gapi.client
+  // ...
+});
+```
+
+Then load api client wrapper:
+
+```typescript
+gapi.client.load(
+  'https://solar.googleapis.com/$discovery/rest?version=v1',
+  () => {
+    // now we can use:
+    // gapi.client.solar
+  }
+);
+```
+
+```typescript
+// Deprecated, use discovery document URL, see https://github.com/google/google-api-javascript-client/blob/master/docs/reference.md#----gapiclientloadname----version----callback--
+gapi.client.load('solar', 'v1', () => {
+  // now we can use:
+  // gapi.client.solar
+});
+```
+
+Don't forget to authenticate your client before sending any request to resources:
+
+```typescript
+// declare client_id registered in Google Developers Console
+var client_id = '',
+  scope = [
+    // See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account.
+    'https://www.googleapis.com/auth/cloud-platform',
+  ],
+  immediate = true;
+// ...
+
+gapi.auth.authorize(
+  {client_id: client_id, scope: scope, immediate: immediate},
+  authResult => {
+    if (authResult && !authResult.error) {
+      /* handle successful authorization */
+    } else {
+      /* handle authorization error */
+    }
+  }
+);
+```
+
+After that you can use Solar API resources: <!-- TODO: make this work for multiple namespaces -->
+
+```typescript
+/*
+Locates the closest building to a query point. Returns an error with code `NOT_FOUND` if there are no buildings within approximately 50m of the query point.
+*/
+await gapi.client.solar.buildingInsights.findClosest({});
+
+/*
+Gets solar information for a region surrounding a location. Returns an error with code `NOT_FOUND` if the location is outside the coverage area.
+*/
+await gapi.client.solar.dataLayers.get({});
+
+/*
+Returns an image by its ID.
+*/
+await gapi.client.solar.geoTiff.get({});
+```