@google-cloud/geocode 0.1.1

package/build/src/v4/gapic_metadata.json

@@ -0,0 +1,77 @@
+{
+    "schema": "1.0",
+    "comment": "This file maps proto services/RPCs to the corresponding library clients/methods",
+    "language": "typescript",
+    "protoPackage": "google.maps.geocode.v4",
+    "libraryPackage": "@google-cloud/geocode",
+    "services": {
+        "DestinationService": {
+            "clients": {
+                "grpc": {
+                    "libraryClient": "DestinationServiceClient",
+                    "rpcs": {
+                        "SearchDestinations": {
+                            "methods": [
+                                "searchDestinations"
+                            ]
+                        }
+                    }
+                },
+                "grpc-fallback": {
+                    "libraryClient": "DestinationServiceClient",
+                    "rpcs": {
+                        "SearchDestinations": {
+                            "methods": [
+                                "searchDestinations"
+                            ]
+                        }
+                    }
+                }
+            }
+        },
+        "GeocodeService": {
+            "clients": {
+                "grpc": {
+                    "libraryClient": "GeocodeServiceClient",
+                    "rpcs": {
+                        "GeocodeAddress": {
+                            "methods": [
+                                "geocodeAddress"
+                            ]
+                        },
+                        "GeocodeLocation": {
+                            "methods": [
+                                "geocodeLocation"
+                            ]
+                        },
+                        "GeocodePlace": {
+                            "methods": [
+                                "geocodePlace"
+                            ]
+                        }
+                    }
+                },
+                "grpc-fallback": {
+                    "libraryClient": "GeocodeServiceClient",
+                    "rpcs": {
+                        "GeocodeAddress": {
+                            "methods": [
+                                "geocodeAddress"
+                            ]
+                        },
+                        "GeocodeLocation": {
+                            "methods": [
+                                "geocodeLocation"
+                            ]
+                        },
+                        "GeocodePlace": {
+                            "methods": [
+                                "geocodePlace"
+                            ]
+                        }
+                    }
+                }
+            }
+        }
+    }
+}

package/build/src/v4/geocode_service_client.d.ts

@@ -0,0 +1,227 @@
+import type * as gax from 'google-gax';
+import type { Callback, CallOptions, Descriptors, ClientOptions } from 'google-gax';
+import * as protos from '../../protos/protos';
+/**
+ *  A service for performing geocoding.
+ * @class
+ * @memberof v4
+ */
+export declare class GeocodeServiceClient {
+    private _terminated;
+    private _opts;
+    private _providedCustomServicePath;
+    private _gaxModule;
+    private _gaxGrpc;
+    private _protos;
+    private _defaults;
+    private _universeDomain;
+    private _servicePath;
+    private _log;
+    auth: gax.GoogleAuth;
+    descriptors: Descriptors;
+    warn: (code: string, message: string, warnType?: string) => void;
+    innerApiCalls: {
+        [name: string]: Function;
+    };
+    geocodeServiceStub?: Promise<{
+        [name: string]: Function;
+    }>;
+    /**
+     * Construct an instance of GeocodeServiceClient.
+     *
+     * @param {object} [options] - The configuration object.
+     * The options accepted by the constructor are described in detail
+     * in [this document](https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#creating-the-client-instance).
+     * The common options are:
+     * @param {object} [options.credentials] - Credentials object.
+     * @param {string} [options.credentials.client_email]
+     * @param {string} [options.credentials.private_key]
+     * @param {string} [options.email] - Account email address. Required when
+     *     using a .pem or .p12 keyFilename.
+     * @param {string} [options.keyFilename] - Full path to the a .json, .pem, or
+     *     .p12 key downloaded from the Google Developers Console. If you provide
+     *     a path to a JSON file, the projectId option below is not necessary.
+     *     NOTE: .pem and .p12 require you to specify options.email as well.
+     * @param {number} [options.port] - The port on which to connect to
+     *     the remote host.
+     * @param {string} [options.projectId] - The project ID from the Google
+     *     Developer's Console, e.g. 'grape-spaceship-123'. We will also check
+     *     the environment variable GCLOUD_PROJECT for your project ID. If your
+     *     app is running in an environment which supports
+     *     {@link https://cloud.google.com/docs/authentication/application-default-credentials Application Default Credentials},
+     *     your project ID will be detected automatically.
+     * @param {string} [options.apiEndpoint] - The domain name of the
+     *     API remote host.
+     * @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
+     *     Follows the structure of {@link gapicConfig}.
+     * @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode.
+     *     For more information, please check the
+     *     {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
+     * @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
+     *     need to avoid loading the default gRPC version and want to use the fallback
+     *     HTTP implementation. Load only fallback version and pass it to the constructor:
+     *     ```
+     *     const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
+     *     const client = new GeocodeServiceClient({fallback: true}, gax);
+     *     ```
+     */
+    constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
+    /**
+     * Initialize the client.
+     * Performs asynchronous operations (such as authentication) and prepares the client.
+     * This function will be called automatically when any class method is called for the
+     * first time, but if you need to initialize it before calling an actual method,
+     * feel free to call initialize() directly.
+     *
+     * You can await on this method if you want to make sure the client is initialized.
+     *
+     * @returns {Promise} A promise that resolves to an authenticated service stub.
+     */
+    initialize(): Promise<{
+        [name: string]: Function;
+    }>;
+    /**
+     * The DNS address for this API service.
+     * @deprecated Use the apiEndpoint method of the client instance.
+     * @returns {string} The DNS address for this service.
+     */
+    static get servicePath(): string;
+    /**
+     * The DNS address for this API service - same as servicePath.
+     * @deprecated Use the apiEndpoint method of the client instance.
+     * @returns {string} The DNS address for this service.
+     */
+    static get apiEndpoint(): string;
+    /**
+     * The DNS address for this API service.
+     * @returns {string} The DNS address for this service.
+     */
+    get apiEndpoint(): string;
+    get universeDomain(): string;
+    /**
+     * The port for this API service.
+     * @returns {number} The default port for this service.
+     */
+    static get port(): number;
+    /**
+     * The scopes needed to make gRPC calls for every method defined
+     * in this service.
+     * @returns {string[]} List of default scopes.
+     */
+    static get scopes(): string[];
+    getProjectId(): Promise<string>;
+    getProjectId(callback: Callback<string, undefined, undefined>): void;
+    /**
+     * This method performs an address geocode, which maps an address to a
+     * LatLng. It also provides structured information about the address.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.addressQuery
+     *   The unstructured address to geocode.
+     * @param {google.type.PostalAddress} request.address
+     *   The structured address to geocode in postal address format.
+     * @param {google.maps.geocode.v4.GeocodeAddressRequest.LocationBias} [request.locationBias]
+     *   Optional. The region to search. This location serves as a bias which means
+     *   results around the given location are preferred.
+     * @param {string} [request.languageCode]
+     *   Optional. Language in which the results should be returned.
+     * @param {string} [request.regionCode]
+     *   Optional. Region code. The region code, specified as a ccTLD ("top-level
+     *   domain") two-character value. The parameter affects results based on
+     *   applicable law. This parameter will also influence, but not fully restrict,
+     *   results from the service.
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Promise} - The promise which resolves to an array.
+     *   The first element of the array is an object representing {@link protos.google.maps.geocode.v4.GeocodeAddressResponse|GeocodeAddressResponse}.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v4/geocode_service.geocode_address.js</caption>
+     * region_tag:geocoding-backend_v4_generated_GeocodeService_GeocodeAddress_async
+     */
+    geocodeAddress(request?: protos.google.maps.geocode.v4.IGeocodeAddressRequest, options?: CallOptions): Promise<[
+        protos.google.maps.geocode.v4.IGeocodeAddressResponse,
+        protos.google.maps.geocode.v4.IGeocodeAddressRequest | undefined,
+        {} | undefined
+    ]>;
+    geocodeAddress(request: protos.google.maps.geocode.v4.IGeocodeAddressRequest, options: CallOptions, callback: Callback<protos.google.maps.geocode.v4.IGeocodeAddressResponse, protos.google.maps.geocode.v4.IGeocodeAddressRequest | null | undefined, {} | null | undefined>): void;
+    geocodeAddress(request: protos.google.maps.geocode.v4.IGeocodeAddressRequest, callback: Callback<protos.google.maps.geocode.v4.IGeocodeAddressResponse, protos.google.maps.geocode.v4.IGeocodeAddressRequest | null | undefined, {} | null | undefined>): void;
+    /**
+     * This method performs a location geocode, which maps a LatLng to an
+     * address. It also provides structured information about the address.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.locationQuery
+     *   The location in the format of "lat,lng" string. For example,
+     *   "64.7611872,-18.4705364".
+     * @param {google.type.LatLng} request.location
+     *   The location in the structured format.
+     * @param {string} [request.languageCode]
+     *   Optional. Language in which the results should be returned.
+     * @param {string} [request.regionCode]
+     *   Optional. Region code. The region code, specified as a ccTLD ("top-level
+     *   domain") two-character value. The parameter affects results based on
+     *   applicable law.
+     * @param {string[]} [request.types]
+     *   Optional. A set of type tags to restrict the results. Results that do not
+     *   have any of the specified types are removed.
+     *
+     *   For the complete list of possible values, see Table A and Table B at
+     *   https://developers.google.com/maps/documentation/places/web-service/place-types.
+     * @param {number[]} [request.granularity]
+     *   Optional. A filter of one or more location granularity enums.
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Promise} - The promise which resolves to an array.
+     *   The first element of the array is an object representing {@link protos.google.maps.geocode.v4.GeocodeLocationResponse|GeocodeLocationResponse}.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v4/geocode_service.geocode_location.js</caption>
+     * region_tag:geocoding-backend_v4_generated_GeocodeService_GeocodeLocation_async
+     */
+    geocodeLocation(request?: protos.google.maps.geocode.v4.IGeocodeLocationRequest, options?: CallOptions): Promise<[
+        protos.google.maps.geocode.v4.IGeocodeLocationResponse,
+        protos.google.maps.geocode.v4.IGeocodeLocationRequest | undefined,
+        {} | undefined
+    ]>;
+    geocodeLocation(request: protos.google.maps.geocode.v4.IGeocodeLocationRequest, options: CallOptions, callback: Callback<protos.google.maps.geocode.v4.IGeocodeLocationResponse, protos.google.maps.geocode.v4.IGeocodeLocationRequest | null | undefined, {} | null | undefined>): void;
+    geocodeLocation(request: protos.google.maps.geocode.v4.IGeocodeLocationRequest, callback: Callback<protos.google.maps.geocode.v4.IGeocodeLocationResponse, protos.google.maps.geocode.v4.IGeocodeLocationRequest | null | undefined, {} | null | undefined>): void;
+    /**
+     * This method performs a geocode lookup using a place ID.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.place
+     *   Required. Place identifier to geocode in the format of places/{place}.
+     * @param {string} [request.languageCode]
+     *   Optional. Language in which the results should be returned.
+     * @param {string} [request.regionCode]
+     *   Optional. Region code. The region code, specified as a ccTLD ("top-level
+     *   domain") two-character value. The parameter affects results based on
+     *   applicable law.
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Promise} - The promise which resolves to an array.
+     *   The first element of the array is an object representing {@link protos.google.maps.geocode.v4.GeocodeResult|GeocodeResult}.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v4/geocode_service.geocode_place.js</caption>
+     * region_tag:geocoding-backend_v4_generated_GeocodeService_GeocodePlace_async
+     */
+    geocodePlace(request?: protos.google.maps.geocode.v4.IGeocodePlaceRequest, options?: CallOptions): Promise<[
+        protos.google.maps.geocode.v4.IGeocodeResult,
+        protos.google.maps.geocode.v4.IGeocodePlaceRequest | undefined,
+        {} | undefined
+    ]>;
+    geocodePlace(request: protos.google.maps.geocode.v4.IGeocodePlaceRequest, options: CallOptions, callback: Callback<protos.google.maps.geocode.v4.IGeocodeResult, protos.google.maps.geocode.v4.IGeocodePlaceRequest | null | undefined, {} | null | undefined>): void;
+    geocodePlace(request: protos.google.maps.geocode.v4.IGeocodePlaceRequest, callback: Callback<protos.google.maps.geocode.v4.IGeocodeResult, protos.google.maps.geocode.v4.IGeocodePlaceRequest | null | undefined, {} | null | undefined>): void;
+    /**
+     * Terminate the gRPC channel and close the client.
+     *
+     * The client will no longer be usable and all future behavior is undefined.
+     * @returns {Promise} A promise that resolves when the client is closed.
+     */
+    close(): Promise<void>;
+}