v1beta1.d.ts
77.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
/**
* 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 {
export 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
*/
export 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.
*/
export 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 | null;
/**
* Specifies the identifier type. Required.
*/
type?: string | null;
}
/**
* A subset of attachment information served via the `beaconinfo.getforobserved` method, used when your users encounter your beacons.
*/
export interface Schema$AttachmentInfo {
/**
* An opaque data container for client-provided data.
*/
data?: string | null;
/**
* 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 | null;
/**
* 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 | null;
}
/**
* Details of a beacon device.
*/
export 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 | null;
/**
* Free text used to identify and describe the beacon. Maximum length 140 characters. Optional.
*/
description?: string | null;
/**
* 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 | null;
/**
* 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 | null;
/**
* Properties of the beacon device, for example battery type or firmware version. Optional.
*/
properties?: {
[key: string]: string;
} | null;
/**
* 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 | null;
/**
* Current status of the beacon. Required.
*/
status?: string | null;
}
/**
* Project-specific data associated with a beacon.
*/
export 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 | null;
/**
* The UTC time when this attachment was created, in milliseconds since the UNIX epoch.
*/
creationTimeMs?: string | null;
/**
* 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 | null;
/**
* 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 | null;
/**
* 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 | null;
}
/**
* A subset of beacon information served via the `beaconinfo.getforobserved` method, which you call when users of your app encounter your beacons.
*/
export 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 | null;
}
/**
* 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`.
*/
export 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 | null;
/**
* Month of year. Must be from 1 to 12, or 0 if specifying a year without a month and day.
*/
month?: number | null;
/**
* Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
*/
year?: number | null;
}
/**
* Response for a request to delete attachments.
*/
export interface Schema$DeleteAttachmentsResponse {
/**
* The number of attachments that were deleted.
*/
numDeleted?: number | null;
}
/**
* Diagnostics for a single beacon.
*/
export interface Schema$Diagnostics {
/**
* An unordered list of Alerts that the beacon has.
*/
alerts?: string[] | null;
/**
* 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 | null;
/**
* 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 `{}`.
*/
export 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.
*/
export 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 | null;
/**
* 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 | null;
/**
* 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 | null;
/**
* 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 | null;
/**
* 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 | null;
/**
* 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 | null;
}
/**
* 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.
*/
export interface Schema$EphemeralIdRegistrationParams {
/**
* Indicates the maximum rotation period supported by the service. See EddystoneEidRegistration.rotation_period_exponent
*/
maxRotationPeriodExponent?: number | null;
/**
* Indicates the minimum rotation period supported by the service. See EddystoneEidRegistration.rotation_period_exponent
*/
minRotationPeriodExponent?: number | null;
/**
* 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 | null;
}
/**
* Request for beacon and attachment information about beacons that a mobile client has encountered "in the wild".
*/
export 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[] | null;
/**
* 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.
*/
export 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.
*/
export interface Schema$IndoorLevel {
/**
* The name of this level.
*/
name?: string | null;
}
/**
* 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.
*/
export interface Schema$LatLng {
/**
* The latitude in degrees. It must be in the range [-90.0, +90.0].
*/
latitude?: number | null;
/**
* The longitude in degrees. It must be in the range [-180.0, +180.0].
*/
longitude?: number | null;
}
/**
* Response to `ListBeaconAttachments` that contains the requested attachments.
*/
export interface Schema$ListBeaconAttachmentsResponse {
/**
* The attachments that corresponded to the request params.
*/
attachments?: Schema$BeaconAttachment[];
}
/**
* Response that contains list beacon results and pagination help.
*/
export 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 | null;
/**
* Estimate of the total number of beacons matched by the query. Higher values may be less accurate.
*/
totalCount?: string | null;
}
/**
* Response that contains the requested diagnostics.
*/
export 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 | null;
}
/**
* Response to ListNamespacesRequest that contains all the project's namespaces.
*/
export 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.
*/
export interface Schema$Namespace {
/**
* Resource name of this namespace. Namespaces names have the format: <code>namespaces/<var>namespace</var></code>.
*/
namespaceName?: string | null;
/**
* Specifies what clients may receive attachments under this namespace via `beaconinfo.getforobserved`.
*/
servingVisibility?: string | null;
}
/**
* Represents one beacon observed once.
*/
export 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 | null;
/**
* Time when the beacon was observed.
*/
timestampMs?: string | null;
}
export 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;
}
export 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;
}
export 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;
}
export 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;
}
export 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;
}
export 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;
}
export 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;
}
export 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;
}
export 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.
*/
projectId?: string;
/**
* 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`
*/
q?: string;
}
export interface Params$Resource$Beacons$Register extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* 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.
*/
projectId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Beacon;
}
export interface Params$Resource$Beacons$Update 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, `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;
/**
* 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.
*/
projectId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Beacon;
}
export class Resource$Beacons$Attachments {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* proximitybeacon.beacons.attachments.batchDelete
* @desc Deletes multiple attachments on a given beacon. This operation is permanent and cannot be undone. You can optionally specify `namespacedType` to choose which attachments should be deleted. If you do not specify `namespacedType`, all your attachments on the given beacon will be deleted. You also may explicitly specify `x/x` to delete all. 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.attachments.batchDelete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.beaconName The beacon whose attachments 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.namespacedType Specifies the namespace and type of attachments to delete in `namespace/type` format. Accepts `x/x` to specify "all types in all namespaces". Optional.
* @param {string=} params.projectId The project id to delete beacon attachments under. This field can be used when "*" is specified to mean all attachment namespaces. Projects may have multiple attachments with multiple namespaces. If "*" is specified and the projectId string is empty, then the project 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
*/
batchDelete(params?: Params$Resource$Beacons$Attachments$Batchdelete, options?: MethodOptions): GaxiosPromise<Schema$DeleteAttachmentsResponse>;
batchDelete(params: Params$Resource$Beacons$Attachments$Batchdelete, options: MethodOptions | BodyResponseCallback<Schema$DeleteAttachmentsResponse>, callback: BodyResponseCallback<Schema$DeleteAttachmentsResponse>): void;
batchDelete(params: Params$Resource$Beacons$Attachments$Batchdelete, callback: BodyResponseCallback<Schema$DeleteAttachmentsResponse>): void;
batchDelete(callback: BodyResponseCallback<Schema$DeleteAttachmentsResponse>): void;
/**
* proximitybeacon.beacons.attachments.create
* @desc Associates the given data with the specified beacon. Attachment data must contain two parts: <ul> <li>A namespaced type.</li> <li>The actual attachment data itself.</li> </ul> The namespaced type consists of two parts, the namespace and the type. The namespace must be one of the values returned by the `namespaces` endpoint, while the type can be a string of any characters except for the forward slash (`/`) up to 100 characters in length. Attachment data can be up to 1024 bytes long. 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.attachments.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.beaconName Beacon on which the attachment should be created. 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 project the attachment will belong to. If the project id is not specified then the project making the request is used. Optional.
* @param {().BeaconAttachment} 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
*/
create(params?: Params$Resource$Beacons$Attachments$Create, options?: MethodOptions): GaxiosPromise<Schema$BeaconAttachment>;
create(params: Params$Resource$Beacons$Attachments$Create, options: MethodOptions | BodyResponseCallback<Schema$BeaconAttachment>, callback: BodyResponseCallback<Schema$BeaconAttachment>): void;
create(params: Params$Resource$Beacons$Attachments$Create, callback: BodyResponseCallback<Schema$BeaconAttachment>): void;
create(callback: BodyResponseCallback<Schema$BeaconAttachment>): void;
/**
* proximitybeacon.beacons.attachments.delete
* @desc Deletes the specified attachment for the given beacon. Each attachment has a unique attachment name (`attachmentName`) which is returned when you fetch the attachment data via this API. You specify this with the delete request to control which attachment is removed. 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.attachments.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.attachmentName The attachment name (`attachmentName`) of the attachment to remove. For example: `beacons/3!893737abc9/attachments/c5e937-af0-494-959-ec49d12738`. For Eddystone-EID beacons, the beacon ID portion (`3!893737abc9`) may be the beacon's current EID, or its "stable" Eddystone-UID. Required.
* @param {string=} params.projectId The project id of the attachment 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$Attachments$Delete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
delete(params: Params$Resource$Beacons$Attachments$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
delete(params: Params$Resource$Beacons$Attachments$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
delete(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* proximitybeacon.beacons.attachments.list
* @desc Returns the attachments for the specified beacon that match the specified namespaced-type pattern. To control which namespaced types are returned, you add the `namespacedType` query parameter to the request. You must either use `x/x`, to return all attachments, or the namespace must be one of the ones returned from the `namespaces` endpoint. 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.attachments.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.beaconName Beacon whose attachments should be fetched. 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.namespacedType Specifies the namespace and type of attachment to include in response in <var>namespace/type</var> format. Accepts `x/x` to specify "all types in all namespaces".
* @param {string=} params.projectId The project id to list beacon attachments under. This field can be used when "*" is specified to mean all attachment namespaces. Projects may have multiple attachments with multiple namespaces. If "*" is specified and the projectId string is empty, then the project 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
*/
list(params?: Params$Resource$Beacons$Attachments$List, options?: MethodOptions): GaxiosPromise<Schema$ListBeaconAttachmentsResponse>;
list(params: Params$Resource$Beacons$Attachments$List, options: MethodOptions | BodyResponseCallback<Schema$ListBeaconAttachmentsResponse>, callback: BodyResponseCallback<Schema$ListBeaconAttachmentsResponse>): void;
list(params: Params$Resource$Beacons$Attachments$List, callback: BodyResponseCallback<Schema$ListBeaconAttachmentsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListBeaconAttachmentsResponse>): void;
}
export interface Params$Resource$Beacons$Attachments$Batchdelete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The beacon whose attachments 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;
/**
* Specifies the namespace and type of attachments to delete in `namespace/type` format. Accepts `x/x` to specify "all types in all namespaces". Optional.
*/
namespacedType?: string;
/**
* The project id to delete beacon attachments under. This field can be used when "*" is specified to mean all attachment namespaces. Projects may have multiple attachments with multiple namespaces. If "*" is specified and the projectId string is empty, then the project making the request is used. Optional.
*/
projectId?: string;
}
export interface Params$Resource$Beacons$Attachments$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Beacon on which the attachment should be created. 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 project the attachment will belong to. If the project id is not specified then the project making the request is used. Optional.
*/
projectId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$BeaconAttachment;
}
export interface Params$Resource$Beacons$Attachments$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The attachment name (`attachmentName`) of the attachment to remove. For example: `beacons/3!893737abc9/attachments/c5e937-af0-494-959-ec49d12738`. For Eddystone-EID beacons, the beacon ID portion (`3!893737abc9`) may be the beacon's current EID, or its "stable" Eddystone-UID. Required.
*/
attachmentName?: string;
/**
* The project id of the attachment to delete. If not provided, the project that is making the request is used. Optional.
*/
projectId?: string;
}
export interface Params$Resource$Beacons$Attachments$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Beacon whose attachments should be fetched. 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;
/**
* Specifies the namespace and type of attachment to include in response in <var>namespace/type</var> format. Accepts `x/x` to specify "all types in all namespaces".
*/
namespacedType?: string;
/**
* The project id to list beacon attachments under. This field can be used when "*" is specified to mean all attachment namespaces. Projects may have multiple attachments with multiple namespaces. If "*" is specified and the projectId string is empty, then the project making the request is used. Optional.
*/
projectId?: string;
}
export class Resource$Beacons$Diagnostics {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* proximitybeacon.beacons.diagnostics.list
* @desc List the diagnostics for a single beacon. You can also list diagnostics for all the beacons owned by your Google Developers Console project by using the beacon name `beacons/-`. 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.diagnostics.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.alertFilter Requests only beacons that have the given alert. For example, to find beacons that have low batteries use `alert_filter=LOW_BATTERY`.
* @param {string} params.beaconName Beacon that the diagnostics are for.
* @param {integer=} params.pageSize Specifies the maximum number of results to return. Defaults to 10. Maximum 1000. Optional.
* @param {string=} params.pageToken Requests results that occur after the `page_token`, obtained from the response to a previous request. Optional.
* @param {string=} params.projectId Requests only diagnostic records for the given project id. If not set, then the project making the request will be used for looking up diagnostic records. 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
*/
list(params?: Params$Resource$Beacons$Diagnostics$List, options?: MethodOptions): GaxiosPromise<Schema$ListDiagnosticsResponse>;
list(params: Params$Resource$Beacons$Diagnostics$List, options: MethodOptions | BodyResponseCallback<Schema$ListDiagnosticsResponse>, callback: BodyResponseCallback<Schema$ListDiagnosticsResponse>): void;
list(params: Params$Resource$Beacons$Diagnostics$List, callback: BodyResponseCallback<Schema$ListDiagnosticsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListDiagnosticsResponse>): void;
}
export interface Params$Resource$Beacons$Diagnostics$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Requests only beacons that have the given alert. For example, to find beacons that have low batteries use `alert_filter=LOW_BATTERY`.
*/
alertFilter?: string;
/**
* Beacon that the diagnostics are for.
*/
beaconName?: string;
/**
* Specifies the maximum number of results to return. Defaults to 10. Maximum 1000. Optional.
*/
pageSize?: number;
/**
* Requests results that occur after the `page_token`, obtained from the response to a previous request. Optional.
*/
pageToken?: string;
/**
* Requests only diagnostic records for the given project id. If not set, then the project making the request will be used for looking up diagnostic records. Optional.
*/
projectId?: string;
}
export class Resource$Namespaces {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* proximitybeacon.namespaces.list
* @desc Lists all attachment namespaces owned by your Google Developers Console project. Attachment data associated with a beacon must include a namespaced type, and the namespace must be owned by your project. 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.namespaces.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.projectId The project id to list namespaces under. 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
*/
list(params?: Params$Resource$Namespaces$List, options?: MethodOptions): GaxiosPromise<Schema$ListNamespacesResponse>;
list(params: Params$Resource$Namespaces$List, options: MethodOptions | BodyResponseCallback<Schema$ListNamespacesResponse>, callback: BodyResponseCallback<Schema$ListNamespacesResponse>): void;
list(params: Params$Resource$Namespaces$List, callback: BodyResponseCallback<Schema$ListNamespacesResponse>): void;
list(callback: BodyResponseCallback<Schema$ListNamespacesResponse>): void;
/**
* proximitybeacon.namespaces.update
* @desc Updates the information about the specified namespace. Only the namespace visibility can be updated.
* @alias proximitybeacon.namespaces.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.namespaceName Resource name of this namespace. Namespaces names have the format: <code>namespaces/<var>namespace</var></code>.
* @param {string=} params.projectId The project id of the namespace 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 {().Namespace} 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$Namespaces$Update, options?: MethodOptions): GaxiosPromise<Schema$Namespace>;
update(params: Params$Resource$Namespaces$Update, options: MethodOptions | BodyResponseCallback<Schema$Namespace>, callback: BodyResponseCallback<Schema$Namespace>): void;
update(params: Params$Resource$Namespaces$Update, callback: BodyResponseCallback<Schema$Namespace>): void;
update(callback: BodyResponseCallback<Schema$Namespace>): void;
}
export interface Params$Resource$Namespaces$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The project id to list namespaces under. Optional.
*/
projectId?: string;
}
export interface Params$Resource$Namespaces$Update extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Resource name of this namespace. Namespaces names have the format: <code>namespaces/<var>namespace</var></code>.
*/
namespaceName?: string;
/**
* The project id of the namespace 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.
*/
projectId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Namespace;
}
export class Resource$V1beta1 {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* proximitybeacon.getEidparams
* @desc Gets the Proximity Beacon API's current public key and associated parameters used to initiate the Diffie-Hellman key exchange required to register a beacon that broadcasts the Eddystone-EID format. This key changes periodically; clients may cache it and re-use the same public key to provision and register multiple beacons. However, clients should be prepared to refresh this key when they encounter an error registering an Eddystone-EID beacon.
* @alias proximitybeacon.getEidparams
* @memberOf! ()
*
* @param {object} params Parameters for request
* @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
*/
getEidparams(params?: Params$Resource$V1beta1$Geteidparams, options?: MethodOptions): GaxiosPromise<Schema$EphemeralIdRegistrationParams>;
getEidparams(params: Params$Resource$V1beta1$Geteidparams, options: MethodOptions | BodyResponseCallback<Schema$EphemeralIdRegistrationParams>, callback: BodyResponseCallback<Schema$EphemeralIdRegistrationParams>): void;
getEidparams(params: Params$Resource$V1beta1$Geteidparams, callback: BodyResponseCallback<Schema$EphemeralIdRegistrationParams>): void;
getEidparams(callback: BodyResponseCallback<Schema$EphemeralIdRegistrationParams>): void;
}
export interface Params$Resource$V1beta1$Geteidparams extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
}
export {};
}