googleapis/build/src/apis/proximitybeacon/v1beta1.d.ts

Google APIs Client Library for Node.js

/**
 * Copyright 2019 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
import { OAuth2Client, JWT, Compute, UserRefreshClient } from 'google-auth-library';
import { GoogleConfigurable, MethodOptions, GlobalOptions, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { GaxiosPromise } from 'gaxios';
export declare namespace proximitybeacon_v1beta1 {
    interface Options extends GlobalOptions {
        version: 'v1beta1';
    }
    interface StandardParameters {
        /**
         * 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;
        /**
         * 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;
        /**
         * Legacy upload protocol for media (e.g. "media", "multipart").
         */
        uploadType?: string;
        /**
         * Upload protocol for media (e.g. "raw", "multipart").
         */
        upload_protocol?: string;
    }
    /**
     * Proximity Beacon API
     *
     * Registers, manages, indexes, and searches beacons.
     *
     * @example
     * const {google} = require('googleapis');
     * const proximitybeacon = google.proximitybeacon('v1beta1');
     *
     * @namespace proximitybeacon
     * @type {Function}
     * @version v1beta1
     * @variation v1beta1
     * @param {object=} options Options for Proximitybeacon
     */
    class Proximitybeacon {
        context: APIRequestContext;
        beaconinfo: Resource$Beaconinfo;
        beacons: Resource$Beacons;
        namespaces: Resource$Namespaces;
        v1beta1: Resource$V1beta1;
        constructor(options: GlobalOptions, google?: GoogleConfigurable);
    }
    /**
     * Defines a unique identifier of a beacon as broadcast by the device.
     */
    interface Schema$AdvertisedId {
        /**
         * The actual beacon identifier, as broadcast by the beacon hardware. Must be [base64](http://tools.ietf.org/html/rfc4648#section-4) encoded in HTTP requests, and will be so encoded (with padding) in responses. The base64 encoding should be of the binary byte-stream and not any textual (such as hex) representation thereof. Required.
         */
        id?: string;
        /**
         * Specifies the identifier type. Required.
         */
        type?: string;
    }
    /**
     * A subset of attachment information served via the `beaconinfo.getforobserved` method, used when your users encounter your beacons.
     */
    interface Schema$AttachmentInfo {
        /**
         * An opaque data container for client-provided data.
         */
        data?: string;
        /**
         * The distance away from the beacon at which this attachment should be delivered to a mobile app.  Setting this to a value greater than zero indicates that the app should behave as if the beacon is "seen" when the mobile device is less than this distance away from the beacon.  Different attachments on the same beacon can have different max distances.  Note that even though this value is expressed with fractional meter precision, real-world behavior is likley to be much less precise than one meter, due to the nature of current Bluetooth radio technology.  Optional. When not set or zero, the attachment should be delivered at the beacon's outer limit of detection.
         */
        maxDistanceMeters?: number;
        /**
         * Specifies what kind of attachment this is. Tells a client how to interpret the `data` field. Format is <var>namespace/type</var>, for example <code>scrupulous-wombat-12345/welcome-message</code>
         */
        namespacedType?: string;
    }
    /**
     * Details of a beacon device.
     */
    interface Schema$Beacon {
        /**
         * The identifier of a beacon as advertised by it. This field must be populated when registering. It may be empty when updating a beacon record because it is ignored in updates.  When registering a beacon that broadcasts Eddystone-EID, this field should contain a "stable" Eddystone-UID that identifies the beacon and links it to its attachments. The stable Eddystone-UID is only used for administering the beacon.
         */
        advertisedId?: Schema$AdvertisedId;
        /**
         * Resource name of this beacon. A beacon name has the format "beacons/N!beaconId" where the beaconId is the base16 ID broadcast by the beacon and N is a code for the beacon's type. Possible values are `3` for Eddystone, `1` for iBeacon, or `5` for AltBeacon.  This field must be left empty when registering. After reading a beacon, clients can use the name for future operations.
         */
        beaconName?: string;
        /**
         * Free text used to identify and describe the beacon. Maximum length 140 characters. Optional.
         */
        description?: string;
        /**
         * Write-only registration parameters for beacons using Eddystone-EID (remotely resolved ephemeral ID) format. This information will not be populated in API responses. When submitting this data, the `advertised_id` field must contain an ID of type Eddystone-UID. Any other ID type will result in an error.
         */
        ephemeralIdRegistration?: Schema$EphemeralIdRegistration;
        /**
         * Expected location stability. This is set when the beacon is registered or updated, not automatically detected in any way. Optional.
         */
        expectedStability?: string;
        /**
         * The indoor level information for this beacon, if known. As returned by the Google Maps API. Optional.
         */
        indoorLevel?: Schema$IndoorLevel;
        /**
         * The location of the beacon, expressed as a latitude and longitude pair. This location is given when the beacon is registered or updated. It does not necessarily indicate the actual current location of the beacon. Optional.
         */
        latLng?: Schema$LatLng;
        /**
         * The [Google Places API](/places/place-id) Place ID of the place where the beacon is deployed. This is given when the beacon is registered or updated, not automatically detected in any way. Optional.
         */
        placeId?: string;
        /**
         * Properties of the beacon device, for example battery type or firmware version. Optional.
         */
        properties?: {
            [key: string]: string;
        };
        /**
         * Some beacons may require a user to provide an authorization key before changing any of its configuration (e.g. broadcast frames, transmit power). This field provides a place to store and control access to that key. This field is populated in responses to `GET /v1beta1/beacons/3!beaconId` from users with write access to the given beacon. That is to say: If the user is authorized to write the beacon's confidential data in the service, the service considers them authorized to configure the beacon. Note that this key grants nothing on the service, only on the beacon itself.
         */
        provisioningKey?: string;
        /**
         * Current status of the beacon. Required.
         */
        status?: string;
    }
    /**
     * Project-specific data associated with a beacon.
     */
    interface Schema$BeaconAttachment {
        /**
         * Resource name of this attachment. Attachment names have the format: <code>beacons/<var>beacon_id</var>/attachments/<var>attachment_id</var></code>. Leave this empty on creation.
         */
        attachmentName?: string;
        /**
         * The UTC time when this attachment was created, in milliseconds since the UNIX epoch.
         */
        creationTimeMs?: string;
        /**
         * An opaque data container for client-provided data. Must be [base64](http://tools.ietf.org/html/rfc4648#section-4) encoded in HTTP requests, and will be so encoded (with padding) in responses. Required.
         */
        data?: string;
        /**
         * The distance away from the beacon at which this attachment should be delivered to a mobile app.  Setting this to a value greater than zero indicates that the app should behave as if the beacon is "seen" when the mobile device is less than this distance away from the beacon.  Different attachments on the same beacon can have different max distances.  Note that even though this value is expressed with fractional meter precision, real-world behavior is likley to be much less precise than one meter, due to the nature of current Bluetooth radio technology.  Optional. When not set or zero, the attachment should be delivered at the beacon's outer limit of detection.  Negative values are invalid and return an error.
         */
        maxDistanceMeters?: number;
        /**
         * Specifies what kind of attachment this is. Tells a client how to interpret the `data` field. Format is <var>namespace/type</var>. Namespace provides type separation between clients. Type describes the type of `data`, for use by the client when parsing the `data` field. Required.
         */
        namespacedType?: string;
    }
    /**
     * A subset of beacon information served via the `beaconinfo.getforobserved` method, which you call when users of your app encounter your beacons.
     */
    interface Schema$BeaconInfo {
        /**
         * The ID advertised by the beacon.
         */
        advertisedId?: Schema$AdvertisedId;
        /**
         * Attachments matching the type(s) requested. May be empty if no attachment types were requested.
         */
        attachments?: Schema$AttachmentInfo[];
        /**
         * The name under which the beacon is registered.
         */
        beaconName?: string;
    }
    /**
     * Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent:  * A full date, with non-zero year, month and day values * A month and day value, with a zero year, e.g. an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, e.g. a credit card expiration date  Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
     */
    interface Schema$Date {
        /**
         * Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year by itself or a year and month where the day is not significant.
         */
        day?: number;
        /**
         * Month of year. Must be from 1 to 12, or 0 if specifying a year without a month and day.
         */
        month?: number;
        /**
         * Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
         */
        year?: number;
    }
    /**
     * Response for a request to delete attachments.
     */
    interface Schema$DeleteAttachmentsResponse {
        /**
         * The number of attachments that were deleted.
         */
        numDeleted?: number;
    }
    /**
     * Diagnostics for a single beacon.
     */
    interface Schema$Diagnostics {
        /**
         * An unordered list of Alerts that the beacon has.
         */
        alerts?: string[];
        /**
         * Resource name of the beacon. For Eddystone-EID beacons, this may be the beacon's current EID, or the beacon's "stable" Eddystone-UID.
         */
        beaconName?: string;
        /**
         * The date when the battery is expected to be low. If the value is missing then there is no estimate for when the battery will be low. This value is only an estimate, not an exact date.
         */
        estimatedLowBatteryDate?: Schema$Date;
    }
    /**
     * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:      service Foo {       rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);     }  The JSON representation for `Empty` is empty JSON object `{}`.
     */
    interface Schema$Empty {
    }
    /**
     * Write-only registration parameters for beacons using Eddystone-EID format. Two ways of securely registering an Eddystone-EID beacon with the service are supported:  1. Perform an ECDH key exchange via this API, including a previous call    to `GET /v1beta1/eidparams`. In this case the fields    `beacon_ecdh_public_key` and `service_ecdh_public_key` should be    populated and `beacon_identity_key` should not be populated. This    method ensures that only the two parties in the ECDH key exchange can    compute the identity key, which becomes a secret between them. 2. Derive or obtain the beacon's identity key via other secure means    (perhaps an ECDH key exchange between the beacon and a mobile device    or any other secure method), and then submit the resulting identity key    to the service. In this case `beacon_identity_key` field should be    populated, and neither of `beacon_ecdh_public_key` nor    `service_ecdh_public_key` fields should be. The security of this method    depends on how securely the parties involved (in particular the    bluetooth client) handle the identity key, and obviously on how    securely the identity key was generated.  See [the Eddystone specification](https://github.com/google/eddystone/tree/master/eddystone-eid) at GitHub.
     */
    interface Schema$EphemeralIdRegistration {
        /**
         * The beacon's public key used for the Elliptic curve Diffie-Hellman key exchange. When this field is populated, `service_ecdh_public_key` must also be populated, and `beacon_identity_key` must not be.
         */
        beaconEcdhPublicKey?: string;
        /**
         * The private key of the beacon. If this field is populated, `beacon_ecdh_public_key` and `service_ecdh_public_key` must not be populated.
         */
        beaconIdentityKey?: string;
        /**
         * The initial clock value of the beacon. The beacon's clock must have begun counting at this value immediately prior to transmitting this value to the resolving service. Significant delay in transmitting this value to the service risks registration or resolution failures. If a value is not provided, the default is zero.
         */
        initialClockValue?: string;
        /**
         * An initial ephemeral ID calculated using the clock value submitted as `initial_clock_value`, and the secret key generated by the Diffie-Hellman key exchange using `service_ecdh_public_key` and `service_ecdh_public_key`. This initial EID value will be used by the service to confirm that the key exchange process was successful.
         */
        initialEid?: string;
        /**
         * Indicates the nominal period between each rotation of the beacon's ephemeral ID. "Nominal" because the beacon should randomize the actual interval. See [the spec at github](https://github.com/google/eddystone/tree/master/eddystone-eid) for details. This value corresponds to a power-of-two scaler on the beacon's clock: when the scaler value is K, the beacon will begin broadcasting a new ephemeral ID on average every 2^K seconds.
         */
        rotationPeriodExponent?: number;
        /**
         * The service's public key used for the Elliptic curve Diffie-Hellman key exchange. When this field is populated, `beacon_ecdh_public_key` must also be populated, and `beacon_identity_key` must not be.
         */
        serviceEcdhPublicKey?: string;
    }
    /**
     * Information a client needs to provision and register beacons that broadcast Eddystone-EID format beacon IDs, using Elliptic curve Diffie-Hellman key exchange. See [the Eddystone specification](https://github.com/google/eddystone/tree/master/eddystone-eid) at GitHub.
     */
    interface Schema$EphemeralIdRegistrationParams {
        /**
         * Indicates the maximum rotation period supported by the service. See EddystoneEidRegistration.rotation_period_exponent
         */
        maxRotationPeriodExponent?: number;
        /**
         * Indicates the minimum rotation period supported by the service. See EddystoneEidRegistration.rotation_period_exponent
         */
        minRotationPeriodExponent?: number;
        /**
         * The beacon service's public key for use by a beacon to derive its Identity Key using Elliptic Curve Diffie-Hellman key exchange.
         */
        serviceEcdhPublicKey?: string;
    }
    /**
     * Request for beacon and attachment information about beacons that a mobile client has encountered "in the wild".
     */
    interface Schema$GetInfoForObservedBeaconsRequest {
        /**
         * Specifies what kind of attachments to include in the response. When given, the response will include only attachments of the given types. When empty, no attachments will be returned. Must be in the format <var>namespace/type</var>. Accepts `*` to specify all types in all namespaces owned by the client. Optional.
         */
        namespacedTypes?: string[];
        /**
         * The beacons that the client has encountered. At least one must be given.
         */
        observations?: Schema$Observation[];
    }
    /**
     * Information about the requested beacons, optionally including attachment data.
     */
    interface Schema$GetInfoForObservedBeaconsResponse {
        /**
         * Public information about beacons. May be empty if the request matched no beacons.
         */
        beacons?: Schema$BeaconInfo[];
    }
    /**
     * Indoor level, a human-readable string as returned by Google Maps APIs, useful to indicate which floor of a building a beacon is located on.
     */
    interface Schema$IndoorLevel {
        /**
         * The name of this level.
         */
        name?: string;
    }
    /**
     * An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 standard</a>. Values must be within normalized ranges.
     */
    interface Schema$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;
    }
    /**
     * Response to `ListBeaconAttachments` that contains the requested attachments.
     */
    interface Schema$ListBeaconAttachmentsResponse {
        /**
         * The attachments that corresponded to the request params.
         */
        attachments?: Schema$BeaconAttachment[];
    }
    /**
     * Response that contains list beacon results and pagination help.
     */
    interface Schema$ListBeaconsResponse {
        /**
         * The beacons that matched the search criteria.
         */
        beacons?: Schema$Beacon[];
        /**
         * An opaque pagination token that the client may provide in their next request to retrieve the next page of results.
         */
        nextPageToken?: string;
        /**
         * Estimate of the total number of beacons matched by the query. Higher values may be less accurate.
         */
        totalCount?: string;
    }
    /**
     * Response that contains the requested diagnostics.
     */
    interface Schema$ListDiagnosticsResponse {
        /**
         * The diagnostics matching the given request.
         */
        diagnostics?: Schema$Diagnostics[];
        /**
         * Token that can be used for pagination. Returned only if the request matches more beacons than can be returned in this response.
         */
        nextPageToken?: string;
    }
    /**
     * Response to ListNamespacesRequest that contains all the project's namespaces.
     */
    interface Schema$ListNamespacesResponse {
        /**
         * The attachments that corresponded to the request params.
         */
        namespaces?: Schema$Namespace[];
    }
    /**
     * An attachment namespace defines read and write access for all the attachments created under it. Each namespace is globally unique, and owned by one project which is the only project that can create attachments under it.
     */
    interface Schema$Namespace {
        /**
         * Resource name of this namespace. Namespaces names have the format: <code>namespaces/<var>namespace</var></code>.
         */
        namespaceName?: string;
        /**
         * Specifies what clients may receive attachments under this namespace via `beaconinfo.getforobserved`.
         */
        servingVisibility?: string;
    }
    /**
     * Represents one beacon observed once.
     */
    interface Schema$Observation {
        /**
         * The ID advertised by the beacon the client has encountered.  If the submitted `advertised_id` type is Eddystone-EID, then the client must be authorized to resolve the given beacon. Otherwise no data will be returned for that beacon. Required.
         */
        advertisedId?: Schema$AdvertisedId;
        /**
         * The array of telemetry bytes received from the beacon. The server is responsible for parsing it. This field may frequently be empty, as with a beacon that transmits telemetry only occasionally.
         */
        telemetry?: string;
        /**
         * Time when the beacon was observed.
         */
        timestampMs?: string;
    }
    class Resource$Beaconinfo {
        context: APIRequestContext;
        constructor(context: APIRequestContext);
        /**
         * proximitybeacon.beaconinfo.getforobserved
         * @desc Given one or more beacon observations, returns any beacon information and attachments accessible to your application. Authorize by using the [API key](https://developers.google.com/beacons/proximity/get-started#request_a_browser_api_key) for the application.
         * @alias proximitybeacon.beaconinfo.getforobserved
         * @memberOf! ()
         *
         * @param {object} params Parameters for request
         * @param {().GetInfoForObservedBeaconsRequest} params.resource Request body data
         * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
         * @param {callback} callback The callback that handles the response.
         * @return {object} Request object
         */
        getforobserved(params?: Params$Resource$Beaconinfo$Getforobserved, options?: MethodOptions): GaxiosPromise<Schema$GetInfoForObservedBeaconsResponse>;
        getforobserved(params: Params$Resource$Beaconinfo$Getforobserved, options: MethodOptions | BodyResponseCallback<Schema$GetInfoForObservedBeaconsResponse>, callback: BodyResponseCallback<Schema$GetInfoForObservedBeaconsResponse>): void;
        getforobserved(params: Params$Resource$Beaconinfo$Getforobserved, callback: BodyResponseCallback<Schema$GetInfoForObservedBeaconsResponse>): void;
        getforobserved(callback: BodyResponseCallback<Schema$GetInfoForObservedBeaconsResponse>): void;
    }
    interface Params$Resource$Beaconinfo$Getforobserved extends StandardParameters {
        /**
         * Auth client or API Key for the request
         */
        auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
        /**
         * Request body metadata
         */
        requestBody?: Schema$GetInfoForObservedBeaconsRequest;
    }
    class Resource$Beacons {
        context: APIRequestContext;
        attachments: Resource$Beacons$Attachments;
        diagnostics: Resource$Beacons$Diagnostics;
        constructor(context: APIRequestContext);
        /**
         * proximitybeacon.beacons.activate
         * @desc Activates a beacon. A beacon that is active will return information and attachment data when queried via `beaconinfo.getforobserved`. Calling this method on an already active beacon will do nothing (but will return a successful response code).  Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **Is owner** or **Can edit** permissions in the Google Developers Console project.
         * @alias proximitybeacon.beacons.activate
         * @memberOf! ()
         *
         * @param {object} params Parameters for request
         * @param {string} params.beaconName Beacon that should be activated. A beacon name has the format "beacons/N!beaconId" where the beaconId is the base16 ID broadcast by the beacon and N is a code for the beacon's type. Possible values are `3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5` for AltBeacon. For Eddystone-EID beacons, you may use either the current EID or the beacon's "stable" UID. Required.
         * @param {string=} params.projectId The project id of the beacon to activate. If the project id is not specified then the project making the request is used. The project id must match the project that owns the beacon. Optional.
         * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
         * @param {callback} callback The callback that handles the response.
         * @return {object} Request object
         */
        activate(params?: Params$Resource$Beacons$Activate, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
        activate(params: Params$Resource$Beacons$Activate, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
        activate(params: Params$Resource$Beacons$Activate, callback: BodyResponseCallback<Schema$Empty>): void;
        activate(callback: BodyResponseCallback<Schema$Empty>): void;
        /**
         * proximitybeacon.beacons.deactivate
         * @desc Deactivates a beacon. Once deactivated, the API will not return information nor attachment data for the beacon when queried via `beaconinfo.getforobserved`. Calling this method on an already inactive beacon will do nothing (but will return a successful response code).  Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **Is owner** or **Can edit** permissions in the Google Developers Console project.
         * @alias proximitybeacon.beacons.deactivate
         * @memberOf! ()
         *
         * @param {object} params Parameters for request
         * @param {string} params.beaconName Beacon that should be deactivated. A beacon name has the format "beacons/N!beaconId" where the beaconId is the base16 ID broadcast by the beacon and N is a code for the beacon's type. Possible values are `3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5` for AltBeacon. For Eddystone-EID beacons, you may use either the current EID or the beacon's "stable" UID. Required.
         * @param {string=} params.projectId The project id of the beacon to deactivate. If the project id is not specified then the project making the request is used. The project id must match the project that owns the beacon. Optional.
         * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
         * @param {callback} callback The callback that handles the response.
         * @return {object} Request object
         */
        deactivate(params?: Params$Resource$Beacons$Deactivate, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
        deactivate(params: Params$Resource$Beacons$Deactivate, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
        deactivate(params: Params$Resource$Beacons$Deactivate, callback: BodyResponseCallback<Schema$Empty>): void;
        deactivate(callback: BodyResponseCallback<Schema$Empty>): void;
        /**
         * proximitybeacon.beacons.decommission
         * @desc Decommissions the specified beacon in the service. This beacon will no longer be returned from `beaconinfo.getforobserved`. This operation is permanent -- you will not be able to re-register a beacon with this ID again.  Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **Is owner** or **Can edit** permissions in the Google Developers Console project.
         * @alias proximitybeacon.beacons.decommission
         * @memberOf! ()
         *
         * @param {object} params Parameters for request
         * @param {string} params.beaconName Beacon that should be decommissioned. A beacon name has the format "beacons/N!beaconId" where the beaconId is the base16 ID broadcast by the beacon and N is a code for the beacon's type. Possible values are `3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5` for AltBeacon. For Eddystone-EID beacons, you may use either the current EID of the beacon's "stable" UID. Required.
         * @param {string=} params.projectId The project id of the beacon to decommission. If the project id is not specified then the project making the request is used. The project id must match the project that owns the beacon. Optional.
         * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
         * @param {callback} callback The callback that handles the response.
         * @return {object} Request object
         */
        decommission(params?: Params$Resource$Beacons$Decommission, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
        decommission(params: Params$Resource$Beacons$Decommission, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
        decommission(params: Params$Resource$Beacons$Decommission, callback: BodyResponseCallback<Schema$Empty>): void;
        decommission(callback: BodyResponseCallback<Schema$Empty>): void;
        /**
         * proximitybeacon.beacons.delete
         * @desc Deletes the specified beacon including all diagnostics data for the beacon as well as any attachments on the beacon (including those belonging to other projects). This operation cannot be undone.  Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **Is owner** or **Can edit** permissions in the Google Developers Console project.
         * @alias proximitybeacon.beacons.delete
         * @memberOf! ()
         *
         * @param {object} params Parameters for request
         * @param {string} params.beaconName Beacon that should be deleted. A beacon name has the format "beacons/N!beaconId" where the beaconId is the base16 ID broadcast by the beacon and N is a code for the beacon's type. Possible values are `3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5` for AltBeacon. For Eddystone-EID beacons, you may use either the current EID or the beacon's "stable" UID. Required.
         * @param {string=} params.projectId The project id of the beacon to delete. If not provided, the project that is making the request is used. Optional.
         * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
         * @param {callback} callback The callback that handles the response.
         * @return {object} Request object
         */
        delete(params?: Params$Resource$Beacons$Delete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
        delete(params: Params$Resource$Beacons$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
        delete(params: Params$Resource$Beacons$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
        delete(callback: BodyResponseCallback<Schema$Empty>): void;
        /**
         * proximitybeacon.beacons.get
         * @desc Returns detailed information about the specified beacon.  Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **viewer**, **Is owner** or **Can edit** permissions in the Google Developers Console project.  Requests may supply an Eddystone-EID beacon name in the form: `beacons/4!beaconId` where the `beaconId` is the base16 ephemeral ID broadcast by the beacon. The returned `Beacon` object will contain the beacon's stable Eddystone-UID. Clients not authorized to resolve the beacon's ephemeral Eddystone-EID broadcast will receive an error.
         * @alias proximitybeacon.beacons.get
         * @memberOf! ()
         *
         * @param {object} params Parameters for request
         * @param {string} params.beaconName Resource name of this beacon. A beacon name has the format "beacons/N!beaconId" where the beaconId is the base16 ID broadcast by the beacon and N is a code for the beacon's type. Possible values are `3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5` for AltBeacon. For Eddystone-EID beacons, you may use either the current EID or the beacon's "stable" UID. Required.
         * @param {string=} params.projectId The project id of the beacon to request. If the project id is not specified then the project making the request is used. The project id must match the project that owns the beacon. Optional.
         * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
         * @param {callback} callback The callback that handles the response.
         * @return {object} Request object
         */
        get(params?: Params$Resource$Beacons$Get, options?: MethodOptions): GaxiosPromise<Schema$Beacon>;
        get(params: Params$Resource$Beacons$Get, options: MethodOptions | BodyResponseCallback<Schema$Beacon>, callback: BodyResponseCallback<Schema$Beacon>): void;
        get(params: Params$Resource$Beacons$Get, callback: BodyResponseCallback<Schema$Beacon>): void;
        get(callback: BodyResponseCallback<Schema$Beacon>): void;
        /**
         * proximitybeacon.beacons.list
         * @desc Searches the beacon registry for beacons that match the given search criteria. Only those beacons that the client has permission to list will be returned.  Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **viewer**, **Is owner** or **Can edit** permissions in the Google Developers Console project.
         * @alias proximitybeacon.beacons.list
         * @memberOf! ()
         *
         * @param {object} params Parameters for request
         * @param {integer=} params.pageSize The maximum number of records to return for this request, up to a server-defined upper limit.
         * @param {string=} params.pageToken A pagination token obtained from a previous request to list beacons.
         * @param {string=} params.projectId The project id to list beacons under. If not present then the project credential that made the request is used as the project. Optional.
         * @param {string=} params.q Filter query string that supports the following field filters:  * **description:`"<string>"`**   For example: **description:"Room 3"**   Returns beacons whose description matches tokens in the string "Room 3"   (not necessarily that exact string).   The string must be double-quoted. * **status:`<enum>`**   For example: **status:active**   Returns beacons whose status matches the given value. Values must be   one of the Beacon.Status enum values (case insensitive). Accepts   multiple filters which will be combined with OR logic. * **stability:`<enum>`**   For example: **stability:mobile**   Returns beacons whose expected stability matches the given value.   Values must be one of the Beacon.Stability enum values (case   insensitive). Accepts multiple filters which will be combined with   OR logic. * **place\_id:`"<string>"`**   For example: **place\_id:"ChIJVSZzVR8FdkgRXGmmm6SslKw="**   Returns beacons explicitly registered at the given place, expressed as   a Place ID obtained from [Google Places API](/places/place-id). Does not   match places inside the given place. Does not consider the beacon's   actual location (which may be different from its registered place).   Accepts multiple filters that will be combined with OR logic. The place   ID must be double-quoted. * **registration\_time`[<|>|<=|>=]<integer>`**   For example: **registration\_time>=1433116800**   Returns beacons whose registration time matches the given filter.   Supports the operators: <, >, <=, and >=. Timestamp must be expressed as   an integer number of seconds since midnight January 1, 1970 UTC. Accepts   at most two filters that will be combined with AND logic, to support   "between" semantics. If more than two are supplied, the latter ones are   ignored. * **lat:`<double> lng:<double> radius:<integer>`**   For example: **lat:51.1232343 lng:-1.093852 radius:1000**   Returns beacons whose registered location is within the given circle.   When any of these fields are given, all are required. Latitude and   longitude must be decimal degrees between -90.0 and 90.0 and between   -180.0 and 180.0 respectively. Radius must be an integer number of   meters between 10 and 1,000,000 (1000 km). * **property:`"<string>=<string>"`**   For example: **property:"battery-type=CR2032"**   Returns beacons which have a property of the given name and value.   Supports multiple filters which will be combined with OR logic.   The entire name=value string must be double-quoted as one string. * **attachment\_type:`"<string>"`**   For example: **attachment_type:"my-namespace/my-type"**   Returns beacons having at least one attachment of the given namespaced   type. Supports "any within this namespace" via the partial wildcard   syntax: "my-namespace/x". Supports multiple filters which will be   combined with OR logic. The string must be double-quoted. * **indoor\_level:`"<string>"`**   For example: **indoor\_level:"1"**   Returns beacons which are located on the given indoor level. Accepts   multiple filters that will be combined with OR logic.  Multiple filters on the same field are combined with OR logic (except registration_time which is combined with AND logic). Multiple filters on different fields are combined with AND logic. Filters should be separated by spaces.  As with any HTTP query string parameter, the whole filter expression must be URL-encoded.  Example REST request: `GET /v1beta1/beacons?q=status:active%20lat:51.123%20lng:-1.095%20radius:1000`
         * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
         * @param {callback} callback The callback that handles the response.
         * @return {object} Request object
         */
        list(params?: Params$Resource$Beacons$List, options?: MethodOptions): GaxiosPromise<Schema$ListBeaconsResponse>;
        list(params: Params$Resource$Beacons$List, options: MethodOptions | BodyResponseCallback<Schema$ListBeaconsResponse>, callback: BodyResponseCallback<Schema$ListBeaconsResponse>): void;
        list(params: Params$Resource$Beacons$List, callback: BodyResponseCallback<Schema$ListBeaconsResponse>): void;
        list(callback: BodyResponseCallback<Schema$ListBeaconsResponse>): void;
        /**
         * proximitybeacon.beacons.register
         * @desc Registers a previously unregistered beacon given its `advertisedId`. These IDs are unique within the system. An ID can be registered only once.  Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **Is owner** or **Can edit** permissions in the Google Developers Console project.
         * @alias proximitybeacon.beacons.register
         * @memberOf! ()
         *
         * @param {object} params Parameters for request
         * @param {string=} params.projectId The project id of the project the beacon will be registered to. If the project id is not specified then the project making the request is used. Optional.
         * @param {().Beacon} params.resource Request body data
         * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
         * @param {callback} callback The callback that handles the response.
         * @return {object} Request object
         */
        register(params?: Params$Resource$Beacons$Register, options?: MethodOptions): GaxiosPromise<Schema$Beacon>;
        register(params: Params$Resource$Beacons$Register, options: MethodOptions | BodyResponseCallback<Schema$Beacon>, callback: BodyResponseCallback<Schema$Beacon>): void;
        register(params: Params$Resource$Beacons$Register, callback: BodyResponseCallback<Schema$Beacon>): void;
        register(callback: BodyResponseCallback<Schema$Beacon>): void;
        /**
         * proximitybeacon.beacons.update
         * @desc Updates the information about the specified beacon. **Any field that you do not populate in the submitted beacon will be permanently erased**, so you should follow the "read, modify, write" pattern to avoid inadvertently destroying data.  Changes to the beacon status via this method will be  silently ignored. To update beacon status, use the separate methods on this API for activation, deactivation, and decommissioning. Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **Is owner** or **Can edit** permissions in the Google Developers Console project.
         * @alias proximitybeacon.beacons.update
         * @memberOf! ()
         *
         * @param {object} params Parameters for request
         * @param {string} params.beaconName Resource name of this beacon. A beacon name has the format "beacons/N!beaconId" where the beaconId is the base16 ID broadcast by the beacon and N is a code for the beacon's type. Possible values are `3` for Eddystone, `1` for iBeacon, or `5` for AltBeacon.  This field must be left empty when registering. After reading a beacon, clients can use the name for future operations.
         * @param {string=} params.projectId The project id of the beacon to update. If the project id is not specified then the project making the request is used. The project id must match the project that owns the beacon. Optional.
         * @param {().Beacon} params.resource Request body data
         * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
         * @param {callback} callback The callback that handles the response.
         * @return {object} Request object
         */
        update(params?: Params$Resource$Beacons$Update, options?: MethodOptions): GaxiosPromise<Schema$Beacon>;
        update(params: Params$Resource$Beacons$Update, options: MethodOptions | BodyResponseCallback<Schema$Beacon>, callback: BodyResponseCallback<Schema$Beacon>): void;
        update(params: Params$Resource$Beacons$Update, callback: BodyResponseCallback<Schema$Beacon>): void;
        update(callback: BodyResponseCallback<Schema$Beacon>): void;
    }
    interface Params$Resource$Beacons$Activate extends StandardParameters {
        /**
         * Auth client or API Key for the request
         */
        auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
        /**
         * Beacon that should be activated. A beacon name has the format "beacons/N!beaconId" where the beaconId is the base16 ID broadcast by the beacon and N is a code for the beacon's type. Possible values are `3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5` for AltBeacon. For Eddystone-EID beacons, you may use either the current EID or the beacon's "stable" UID. Required.
         */
        beaconName?: string;
        /**
         * The project id of the beacon to activate. If the project id is not specified then the project making the request is used. The project id must match the project that owns the beacon. Optional.
         */
        projectId?: string;
    }
    interface Params$Resource$Beacons$Deactivate extends StandardParameters {
        /**
         * Auth client or API Key for the request
         */
        auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
        /**
         * Beacon that should be deactivated. A beacon name has the format "beacons/N!beaconId" where the beaconId is the base16 ID broadcast by the beacon and N is a code for the beacon's type. Possible values are `3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5` for AltBeacon. For Eddystone-EID beacons, you may use either the current EID or the beacon's "stable" UID. Required.
         */
        beaconName?: string;
        /**
         * The project id of the beacon to deactivate. If the project id is not specified then the project making the request is used. The project id must match the project that owns the beacon. Optional.
         */
        projectId?: string;
    }
    interface Params$Resource$Beacons$Decommission extends StandardParameters {
        /**
         * Auth client or API Key for the request
         */
        auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
        /**
         * Beacon that should be decommissioned. A beacon name has the format "beacons/N!beaconId" where the beaconId is the base16 ID broadcast by the beacon and N is a code for the beacon's type. Possible values are `3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5` for AltBeacon. For Eddystone-EID beacons, you may use either the current EID of the beacon's "stable" UID. Required.
         */
        beaconName?: string;
        /**
         * The project id of the beacon to decommission. If the project id is not specified then the project making the request is used. The project id must match the project that owns the beacon. Optional.
         */
        projectId?: string;
    }
    interface Params$Resource$Beacons$Delete extends StandardParameters {
        /**
         * Auth client or API Key for the request
         */
        auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
        /**
         * Beacon that should be deleted. A beacon name has the format "beacons/N!beaconId" where the beaconId is the base16 ID broadcast by the beacon and N is a code for the beacon's type. Possible values are `3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5` for AltBeacon. For Eddystone-EID beacons, you may use either the current EID or the beacon's "stable" UID. Required.
         */
        beaconName?: string;
        /**
         * The project id of the beacon to delete. If not provided, the project that is making the request is used. Optional.
         */
        projectId?: string;
    }
    interface Params$Resource$Beacons$Get extends StandardParameters {
        /**
         * Auth client or API Key for the request
         */
        auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
        /**
         * Resource name of this beacon. A beacon name has the format "beacons/N!beaconId" where the beaconId is the base16 ID broadcast by the beacon and N is a code for the beacon's type. Possible values are `3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5` for AltBeacon. For Eddystone-EID beacons, you may use either the current EID or the beacon's "stable" UID. Required.
         */
        beaconName?: string;
        /**
         * The project id of the beacon to request. If the project id is not specified then the project making the request is used. The project id must match the project that owns the beacon. Optional.
         */
        projectId?: string;
    }
    interface Params$Resource$Beacons$List extends StandardParameters {
        /**
         * Auth client or API Key for the request
         */
        auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
        /**
         * The maximum number of records to return for this request, up to a server-defined upper limit.
         */
        pageSize?: number;
        /**
         * A pagination token obtained from a previous request to list beacons.
         */
        pageToken?: string;
        /**
         * The project id to list beacons under. If not present then the project credential that made the request is used as the project. Optional.
         */
        projec