v4.d.ts
44.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
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
/// <reference types="node" />
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosPromise, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace safebrowsing_v4 {
export interface Options extends GlobalOptions {
version: 'v4';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | BaseExternalAccountClient | GoogleAuth;
/**
* 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;
}
/**
* Safe Browsing API
*
* Enables client applications to check web resources (most commonly URLs) against Google-generated lists of unsafe web resources. The Safe Browsing APIs are for non-commercial use only. If you need to use APIs to detect malicious URLs for commercial purposes – meaning “for sale or revenue-generating purposes” – please refer to the Web Risk API.
*
* @example
* ```js
* const {google} = require('googleapis');
* const safebrowsing = google.safebrowsing('v4');
* ```
*/
export class Safebrowsing {
context: APIRequestContext;
encodedFullHashes: Resource$Encodedfullhashes;
encodedUpdates: Resource$Encodedupdates;
fullHashes: Resource$Fullhashes;
threatHits: Resource$Threathits;
threatLists: Resource$Threatlists;
threatListUpdates: Resource$Threatlistupdates;
threatMatches: Resource$Threatmatches;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* 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$GoogleProtobufEmpty {
}
/**
* The expected state of a client's local database.
*/
export interface Schema$GoogleSecuritySafebrowsingV4Checksum {
/**
* The SHA256 hash of the client state; that is, of the sorted list of all hashes present in the database.
*/
sha256?: string | null;
}
/**
* The client metadata associated with Safe Browsing API requests.
*/
export interface Schema$GoogleSecuritySafebrowsingV4ClientInfo {
/**
* A client ID that (hopefully) uniquely identifies the client implementation of the Safe Browsing API.
*/
clientId?: string | null;
/**
* The version of the client implementation.
*/
clientVersion?: string | null;
}
/**
* Describes a Safe Browsing API update request. Clients can request updates for multiple lists in a single request. The server may not respond to all requests, if the server has no updates for that list. NOTE: Field index 2 is unused. NEXT: 5
*/
export interface Schema$GoogleSecuritySafebrowsingV4FetchThreatListUpdatesRequest {
/**
* The client metadata.
*/
client?: Schema$GoogleSecuritySafebrowsingV4ClientInfo;
/**
* The requested threat list updates.
*/
listUpdateRequests?: Schema$GoogleSecuritySafebrowsingV4FetchThreatListUpdatesRequestListUpdateRequest[];
}
/**
* A single list update request.
*/
export interface Schema$GoogleSecuritySafebrowsingV4FetchThreatListUpdatesRequestListUpdateRequest {
/**
* The constraints associated with this request.
*/
constraints?: Schema$GoogleSecuritySafebrowsingV4FetchThreatListUpdatesRequestListUpdateRequestConstraints;
/**
* The type of platform at risk by entries present in the list.
*/
platformType?: string | null;
/**
* The current state of the client for the requested list (the encrypted client state that was received from the last successful list update).
*/
state?: string | null;
/**
* The types of entries present in the list.
*/
threatEntryType?: string | null;
/**
* The type of threat posed by entries present in the list.
*/
threatType?: string | null;
}
/**
* The constraints for this update.
*/
export interface Schema$GoogleSecuritySafebrowsingV4FetchThreatListUpdatesRequestListUpdateRequestConstraints {
/**
* A client's physical location, expressed as a ISO 31166-1 alpha-2 region code.
*/
deviceLocation?: string | null;
/**
* Requests the lists for a specific language. Expects ISO 639 alpha-2 format.
*/
language?: string | null;
/**
* Sets the maximum number of entries that the client is willing to have in the local database for the specified list. This should be a power of 2 between 2**10 and 2**20. If zero, no database size limit is set.
*/
maxDatabaseEntries?: number | null;
/**
* The maximum size in number of entries. The update will not contain more entries than this value. This should be a power of 2 between 2**10 and 2**20. If zero, no update size limit is set.
*/
maxUpdateEntries?: number | null;
/**
* Requests the list for a specific geographic location. If not set the server may pick that value based on the user's IP address. Expects ISO 3166-1 alpha-2 format.
*/
region?: string | null;
/**
* The compression types supported by the client.
*/
supportedCompressions?: string[] | null;
}
export interface Schema$GoogleSecuritySafebrowsingV4FetchThreatListUpdatesResponse {
/**
* The list updates requested by the clients. The number of responses here may be less than the number of requests sent by clients. This is the case, for example, if the server has no updates for a particular list.
*/
listUpdateResponses?: Schema$GoogleSecuritySafebrowsingV4FetchThreatListUpdatesResponseListUpdateResponse[];
/**
* The minimum duration the client must wait before issuing any update request. If this field is not set clients may update as soon as they want.
*/
minimumWaitDuration?: string | null;
}
/**
* An update to an individual list.
*/
export interface Schema$GoogleSecuritySafebrowsingV4FetchThreatListUpdatesResponseListUpdateResponse {
/**
* A set of entries to add to a local threat type's list. Repeated to allow for a combination of compressed and raw data to be sent in a single response.
*/
additions?: Schema$GoogleSecuritySafebrowsingV4ThreatEntrySet[];
/**
* The expected SHA256 hash of the client state; that is, of the sorted list of all hashes present in the database after applying the provided update. If the client state doesn't match the expected state, the client must disregard this update and retry later.
*/
checksum?: Schema$GoogleSecuritySafebrowsingV4Checksum;
/**
* The new client state, in encrypted format. Opaque to clients.
*/
newClientState?: string | null;
/**
* The platform type for which data is returned.
*/
platformType?: string | null;
/**
* A set of entries to remove from a local threat type's list. In practice, this field is empty or contains exactly one ThreatEntrySet.
*/
removals?: Schema$GoogleSecuritySafebrowsingV4ThreatEntrySet[];
/**
* The type of response. This may indicate that an action is required by the client when the response is received.
*/
responseType?: string | null;
/**
* The format of the threats.
*/
threatEntryType?: string | null;
/**
* The threat type for which data is returned.
*/
threatType?: string | null;
}
/**
* Request to return full hashes matched by the provided hash prefixes.
*/
export interface Schema$GoogleSecuritySafebrowsingV4FindFullHashesRequest {
/**
* Client metadata associated with callers of higher-level APIs built on top of the client's implementation.
*/
apiClient?: Schema$GoogleSecuritySafebrowsingV4ClientInfo;
/**
* The client metadata.
*/
client?: Schema$GoogleSecuritySafebrowsingV4ClientInfo;
/**
* The current client states for each of the client's local threat lists.
*/
clientStates?: string[] | null;
/**
* The lists and hashes to be checked.
*/
threatInfo?: Schema$GoogleSecuritySafebrowsingV4ThreatInfo;
}
export interface Schema$GoogleSecuritySafebrowsingV4FindFullHashesResponse {
/**
* The full hashes that matched the requested prefixes.
*/
matches?: Schema$GoogleSecuritySafebrowsingV4ThreatMatch[];
/**
* The minimum duration the client must wait before issuing any find hashes request. If this field is not set, clients can issue a request as soon as they want.
*/
minimumWaitDuration?: string | null;
/**
* For requested entities that did not match the threat list, how long to cache the response.
*/
negativeCacheDuration?: string | null;
}
/**
* Request to check entries against lists.
*/
export interface Schema$GoogleSecuritySafebrowsingV4FindThreatMatchesRequest {
/**
* The client metadata.
*/
client?: Schema$GoogleSecuritySafebrowsingV4ClientInfo;
/**
* The lists and entries to be checked for matches.
*/
threatInfo?: Schema$GoogleSecuritySafebrowsingV4ThreatInfo;
}
export interface Schema$GoogleSecuritySafebrowsingV4FindThreatMatchesResponse {
/**
* The threat list matches.
*/
matches?: Schema$GoogleSecuritySafebrowsingV4ThreatMatch[];
}
export interface Schema$GoogleSecuritySafebrowsingV4ListThreatListsResponse {
/**
* The lists available for download by the client.
*/
threatLists?: Schema$GoogleSecuritySafebrowsingV4ThreatListDescriptor[];
}
/**
* The uncompressed threat entries in hash format of a particular prefix length. Hashes can be anywhere from 4 to 32 bytes in size. A large majority are 4 bytes, but some hashes are lengthened if they collide with the hash of a popular URL. Used for sending ThreatEntrySet to clients that do not support compression, or when sending non-4-byte hashes to clients that do support compression.
*/
export interface Schema$GoogleSecuritySafebrowsingV4RawHashes {
/**
* The number of bytes for each prefix encoded below. This field can be anywhere from 4 (shortest prefix) to 32 (full SHA256 hash).
*/
prefixSize?: number | null;
/**
* The hashes, in binary format, concatenated into one long string. Hashes are sorted in lexicographic order. For JSON API users, hashes are base64-encoded.
*/
rawHashes?: string | null;
}
/**
* A set of raw indices to remove from a local list.
*/
export interface Schema$GoogleSecuritySafebrowsingV4RawIndices {
/**
* The indices to remove from a lexicographically-sorted local list.
*/
indices?: number[] | null;
}
/**
* The Rice-Golomb encoded data. Used for sending compressed 4-byte hashes or compressed removal indices.
*/
export interface Schema$GoogleSecuritySafebrowsingV4RiceDeltaEncoding {
/**
* The encoded deltas that are encoded using the Golomb-Rice coder.
*/
encodedData?: string | null;
/**
* The offset of the first entry in the encoded data, or, if only a single integer was encoded, that single integer's value. If the field is empty or missing, assume zero.
*/
firstValue?: string | null;
/**
* The number of entries that are delta encoded in the encoded data. If only a single integer was encoded, this will be zero and the single value will be stored in `first_value`.
*/
numEntries?: number | null;
/**
* The Golomb-Rice parameter, which is a number between 2 and 28. This field is missing (that is, zero) if `num_entries` is zero.
*/
riceParameter?: number | null;
}
/**
* An individual threat; for example, a malicious URL or its hash representation. Only one of these fields should be set.
*/
export interface Schema$GoogleSecuritySafebrowsingV4ThreatEntry {
/**
* The digest of an executable in SHA256 format. The API supports both binary and hex digests. For JSON requests, digests are base64-encoded.
*/
digest?: string | null;
/**
* A hash prefix, consisting of the most significant 4-32 bytes of a SHA256 hash. This field is in binary format. For JSON requests, hashes are base64-encoded.
*/
hash?: string | null;
/**
* A URL.
*/
url?: string | null;
}
/**
* The metadata associated with a specific threat entry. The client is expected to know the metadata key/value pairs associated with each threat type.
*/
export interface Schema$GoogleSecuritySafebrowsingV4ThreatEntryMetadata {
/**
* The metadata entries.
*/
entries?: Schema$GoogleSecuritySafebrowsingV4ThreatEntryMetadataMetadataEntry[];
}
/**
* A single metadata entry.
*/
export interface Schema$GoogleSecuritySafebrowsingV4ThreatEntryMetadataMetadataEntry {
/**
* The metadata entry key. For JSON requests, the key is base64-encoded.
*/
key?: string | null;
/**
* The metadata entry value. For JSON requests, the value is base64-encoded.
*/
value?: string | null;
}
/**
* A set of threats that should be added or removed from a client's local database.
*/
export interface Schema$GoogleSecuritySafebrowsingV4ThreatEntrySet {
/**
* The compression type for the entries in this set.
*/
compressionType?: string | null;
/**
* The raw SHA256-formatted entries.
*/
rawHashes?: Schema$GoogleSecuritySafebrowsingV4RawHashes;
/**
* The raw removal indices for a local list.
*/
rawIndices?: Schema$GoogleSecuritySafebrowsingV4RawIndices;
/**
* The encoded 4-byte prefixes of SHA256-formatted entries, using a Golomb-Rice encoding. The hashes are converted to uint32, sorted in ascending order, then delta encoded and stored as encoded_data.
*/
riceHashes?: Schema$GoogleSecuritySafebrowsingV4RiceDeltaEncoding;
/**
* The encoded local, lexicographically-sorted list indices, using a Golomb-Rice encoding. Used for sending compressed removal indices. The removal indices (uint32) are sorted in ascending order, then delta encoded and stored as encoded_data.
*/
riceIndices?: Schema$GoogleSecuritySafebrowsingV4RiceDeltaEncoding;
}
export interface Schema$GoogleSecuritySafebrowsingV4ThreatHit {
/**
* Client-reported identification.
*/
clientInfo?: Schema$GoogleSecuritySafebrowsingV4ClientInfo;
/**
* The threat entry responsible for the hit. Full hash should be reported for hash-based hits.
*/
entry?: Schema$GoogleSecuritySafebrowsingV4ThreatEntry;
/**
* The platform type reported.
*/
platformType?: string | null;
/**
* The resources related to the threat hit.
*/
resources?: Schema$GoogleSecuritySafebrowsingV4ThreatHitThreatSource[];
/**
* The threat type reported.
*/
threatType?: string | null;
/**
* Details about the user that encountered the threat.
*/
userInfo?: Schema$GoogleSecuritySafebrowsingV4ThreatHitUserInfo;
}
/**
* A single resource related to a threat hit.
*/
export interface Schema$GoogleSecuritySafebrowsingV4ThreatHitThreatSource {
/**
* Referrer of the resource. Only set if the referrer is available.
*/
referrer?: string | null;
/**
* The remote IP of the resource in ASCII format. Either IPv4 or IPv6.
*/
remoteIp?: string | null;
/**
* The type of source reported.
*/
type?: string | null;
/**
* The URL of the resource.
*/
url?: string | null;
}
/**
* Details about the user that encountered the threat.
*/
export interface Schema$GoogleSecuritySafebrowsingV4ThreatHitUserInfo {
/**
* The UN M.49 region code associated with the user's location.
*/
regionCode?: string | null;
/**
* Unique user identifier defined by the client.
*/
userId?: string | null;
}
/**
* The information regarding one or more threats that a client submits when checking for matches in threat lists.
*/
export interface Schema$GoogleSecuritySafebrowsingV4ThreatInfo {
/**
* The platform types to be checked.
*/
platformTypes?: string[] | null;
/**
* The threat entries to be checked.
*/
threatEntries?: Schema$GoogleSecuritySafebrowsingV4ThreatEntry[];
/**
* The entry types to be checked.
*/
threatEntryTypes?: string[] | null;
/**
* The threat types to be checked.
*/
threatTypes?: string[] | null;
}
/**
* Describes an individual threat list. A list is defined by three parameters: the type of threat posed, the type of platform targeted by the threat, and the type of entries in the list.
*/
export interface Schema$GoogleSecuritySafebrowsingV4ThreatListDescriptor {
/**
* The platform type targeted by the list's entries.
*/
platformType?: string | null;
/**
* The entry types contained in the list.
*/
threatEntryType?: string | null;
/**
* The threat type posed by the list's entries.
*/
threatType?: string | null;
}
/**
* A match when checking a threat entry in the Safe Browsing threat lists.
*/
export interface Schema$GoogleSecuritySafebrowsingV4ThreatMatch {
/**
* The cache lifetime for the returned match. Clients must not cache this response for more than this duration to avoid false positives.
*/
cacheDuration?: string | null;
/**
* The platform type matching this threat.
*/
platformType?: string | null;
/**
* The threat matching this threat.
*/
threat?: Schema$GoogleSecuritySafebrowsingV4ThreatEntry;
/**
* Optional metadata associated with this threat.
*/
threatEntryMetadata?: Schema$GoogleSecuritySafebrowsingV4ThreatEntryMetadata;
/**
* The threat entry type matching this threat.
*/
threatEntryType?: string | null;
/**
* The threat type matching this threat.
*/
threatType?: string | null;
}
export class Resource$Encodedfullhashes {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/safebrowsing.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const safebrowsing = google.safebrowsing('v4');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await safebrowsing.encodedFullHashes.get({
* // A client ID that (hopefully) uniquely identifies the client implementation of the Safe Browsing API.
* clientId: 'placeholder-value',
* // The version of the client implementation.
* clientVersion: 'placeholder-value',
* // A serialized FindFullHashesRequest proto.
* encodedRequest: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "matches": [],
* // "minimumWaitDuration": "my_minimumWaitDuration",
* // "negativeCacheDuration": "my_negativeCacheDuration"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(params: Params$Resource$Encodedfullhashes$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
get(params?: Params$Resource$Encodedfullhashes$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleSecuritySafebrowsingV4FindFullHashesResponse>;
get(params: Params$Resource$Encodedfullhashes$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
get(params: Params$Resource$Encodedfullhashes$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleSecuritySafebrowsingV4FindFullHashesResponse>, callback: BodyResponseCallback<Schema$GoogleSecuritySafebrowsingV4FindFullHashesResponse>): void;
get(params: Params$Resource$Encodedfullhashes$Get, callback: BodyResponseCallback<Schema$GoogleSecuritySafebrowsingV4FindFullHashesResponse>): void;
get(callback: BodyResponseCallback<Schema$GoogleSecuritySafebrowsingV4FindFullHashesResponse>): void;
}
export interface Params$Resource$Encodedfullhashes$Get extends StandardParameters {
/**
* A client ID that (hopefully) uniquely identifies the client implementation of the Safe Browsing API.
*/
clientId?: string;
/**
* The version of the client implementation.
*/
clientVersion?: string;
/**
* A serialized FindFullHashesRequest proto.
*/
encodedRequest?: string;
}
export class Resource$Encodedupdates {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/safebrowsing.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const safebrowsing = google.safebrowsing('v4');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await safebrowsing.encodedUpdates.get({
* // A client ID that uniquely identifies the client implementation of the Safe Browsing API.
* clientId: 'placeholder-value',
* // The version of the client implementation.
* clientVersion: 'placeholder-value',
* // A serialized FetchThreatListUpdatesRequest proto.
* encodedRequest: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "listUpdateResponses": [],
* // "minimumWaitDuration": "my_minimumWaitDuration"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(params: Params$Resource$Encodedupdates$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
get(params?: Params$Resource$Encodedupdates$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleSecuritySafebrowsingV4FetchThreatListUpdatesResponse>;
get(params: Params$Resource$Encodedupdates$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
get(params: Params$Resource$Encodedupdates$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleSecuritySafebrowsingV4FetchThreatListUpdatesResponse>, callback: BodyResponseCallback<Schema$GoogleSecuritySafebrowsingV4FetchThreatListUpdatesResponse>): void;
get(params: Params$Resource$Encodedupdates$Get, callback: BodyResponseCallback<Schema$GoogleSecuritySafebrowsingV4FetchThreatListUpdatesResponse>): void;
get(callback: BodyResponseCallback<Schema$GoogleSecuritySafebrowsingV4FetchThreatListUpdatesResponse>): void;
}
export interface Params$Resource$Encodedupdates$Get extends StandardParameters {
/**
* A client ID that uniquely identifies the client implementation of the Safe Browsing API.
*/
clientId?: string;
/**
* The version of the client implementation.
*/
clientVersion?: string;
/**
* A serialized FetchThreatListUpdatesRequest proto.
*/
encodedRequest?: string;
}
export class Resource$Fullhashes {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* Finds the full hashes that match the requested hash prefixes.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/safebrowsing.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const safebrowsing = google.safebrowsing('v4');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await safebrowsing.fullHashes.find({
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "apiClient": {},
* // "client": {},
* // "clientStates": [],
* // "threatInfo": {}
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "matches": [],
* // "minimumWaitDuration": "my_minimumWaitDuration",
* // "negativeCacheDuration": "my_negativeCacheDuration"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
find(params: Params$Resource$Fullhashes$Find, options: StreamMethodOptions): GaxiosPromise<Readable>;
find(params?: Params$Resource$Fullhashes$Find, options?: MethodOptions): GaxiosPromise<Schema$GoogleSecuritySafebrowsingV4FindFullHashesResponse>;
find(params: Params$Resource$Fullhashes$Find, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
find(params: Params$Resource$Fullhashes$Find, options: MethodOptions | BodyResponseCallback<Schema$GoogleSecuritySafebrowsingV4FindFullHashesResponse>, callback: BodyResponseCallback<Schema$GoogleSecuritySafebrowsingV4FindFullHashesResponse>): void;
find(params: Params$Resource$Fullhashes$Find, callback: BodyResponseCallback<Schema$GoogleSecuritySafebrowsingV4FindFullHashesResponse>): void;
find(callback: BodyResponseCallback<Schema$GoogleSecuritySafebrowsingV4FindFullHashesResponse>): void;
}
export interface Params$Resource$Fullhashes$Find extends StandardParameters {
/**
* Request body metadata
*/
requestBody?: Schema$GoogleSecuritySafebrowsingV4FindFullHashesRequest;
}
export class Resource$Threathits {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* Reports a Safe Browsing threat list hit to Google. Only projects with TRUSTED_REPORTER visibility can use this method.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/safebrowsing.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const safebrowsing = google.safebrowsing('v4');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await safebrowsing.threatHits.create({
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "clientInfo": {},
* // "entry": {},
* // "platformType": "my_platformType",
* // "resources": [],
* // "threatType": "my_threatType",
* // "userInfo": {}
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {}
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
create(params: Params$Resource$Threathits$Create, options: StreamMethodOptions): GaxiosPromise<Readable>;
create(params?: Params$Resource$Threathits$Create, options?: MethodOptions): GaxiosPromise<Schema$GoogleProtobufEmpty>;
create(params: Params$Resource$Threathits$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
create(params: Params$Resource$Threathits$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleProtobufEmpty>, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
create(params: Params$Resource$Threathits$Create, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
create(callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
}
export interface Params$Resource$Threathits$Create extends StandardParameters {
/**
* Request body metadata
*/
requestBody?: Schema$GoogleSecuritySafebrowsingV4ThreatHit;
}
export class Resource$Threatlists {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* Lists the Safe Browsing threat lists available for download.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/safebrowsing.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const safebrowsing = google.safebrowsing('v4');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await safebrowsing.threatLists.list({});
* console.log(res.data);
*
* // Example response
* // {
* // "threatLists": []
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(params: Params$Resource$Threatlists$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Threatlists$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleSecuritySafebrowsingV4ListThreatListsResponse>;
list(params: Params$Resource$Threatlists$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Threatlists$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleSecuritySafebrowsingV4ListThreatListsResponse>, callback: BodyResponseCallback<Schema$GoogleSecuritySafebrowsingV4ListThreatListsResponse>): void;
list(params: Params$Resource$Threatlists$List, callback: BodyResponseCallback<Schema$GoogleSecuritySafebrowsingV4ListThreatListsResponse>): void;
list(callback: BodyResponseCallback<Schema$GoogleSecuritySafebrowsingV4ListThreatListsResponse>): void;
}
export interface Params$Resource$Threatlists$List extends StandardParameters {
}
export class Resource$Threatlistupdates {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* Fetches the most recent threat list updates. A client can request updates for multiple lists at once.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/safebrowsing.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const safebrowsing = google.safebrowsing('v4');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await safebrowsing.threatListUpdates.fetch({
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "client": {},
* // "listUpdateRequests": []
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "listUpdateResponses": [],
* // "minimumWaitDuration": "my_minimumWaitDuration"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
fetch(params: Params$Resource$Threatlistupdates$Fetch, options: StreamMethodOptions): GaxiosPromise<Readable>;
fetch(params?: Params$Resource$Threatlistupdates$Fetch, options?: MethodOptions): GaxiosPromise<Schema$GoogleSecuritySafebrowsingV4FetchThreatListUpdatesResponse>;
fetch(params: Params$Resource$Threatlistupdates$Fetch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
fetch(params: Params$Resource$Threatlistupdates$Fetch, options: MethodOptions | BodyResponseCallback<Schema$GoogleSecuritySafebrowsingV4FetchThreatListUpdatesResponse>, callback: BodyResponseCallback<Schema$GoogleSecuritySafebrowsingV4FetchThreatListUpdatesResponse>): void;
fetch(params: Params$Resource$Threatlistupdates$Fetch, callback: BodyResponseCallback<Schema$GoogleSecuritySafebrowsingV4FetchThreatListUpdatesResponse>): void;
fetch(callback: BodyResponseCallback<Schema$GoogleSecuritySafebrowsingV4FetchThreatListUpdatesResponse>): void;
}
export interface Params$Resource$Threatlistupdates$Fetch extends StandardParameters {
/**
* Request body metadata
*/
requestBody?: Schema$GoogleSecuritySafebrowsingV4FetchThreatListUpdatesRequest;
}
export class Resource$Threatmatches {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* Finds the threat entries that match the Safe Browsing lists.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/safebrowsing.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const safebrowsing = google.safebrowsing('v4');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await safebrowsing.threatMatches.find({
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "client": {},
* // "threatInfo": {}
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "matches": []
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
find(params: Params$Resource$Threatmatches$Find, options: StreamMethodOptions): GaxiosPromise<Readable>;
find(params?: Params$Resource$Threatmatches$Find, options?: MethodOptions): GaxiosPromise<Schema$GoogleSecuritySafebrowsingV4FindThreatMatchesResponse>;
find(params: Params$Resource$Threatmatches$Find, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
find(params: Params$Resource$Threatmatches$Find, options: MethodOptions | BodyResponseCallback<Schema$GoogleSecuritySafebrowsingV4FindThreatMatchesResponse>, callback: BodyResponseCallback<Schema$GoogleSecuritySafebrowsingV4FindThreatMatchesResponse>): void;
find(params: Params$Resource$Threatmatches$Find, callback: BodyResponseCallback<Schema$GoogleSecuritySafebrowsingV4FindThreatMatchesResponse>): void;
find(callback: BodyResponseCallback<Schema$GoogleSecuritySafebrowsingV4FindThreatMatchesResponse>): void;
}
export interface Params$Resource$Threatmatches$Find extends StandardParameters {
/**
* Request body metadata
*/
requestBody?: Schema$GoogleSecuritySafebrowsingV4FindThreatMatchesRequest;
}
export {};
}