v1beta1.d.ts
74.5 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
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
/// <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 alertcenter_v1beta1 {
export interface Options extends GlobalOptions {
version: 'v1beta1';
}
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;
}
/**
* Google Workspace Alert Center API
*
* Manages alerts on issues affecting your domain.
*
* @example
* ```js
* const {google} = require('googleapis');
* const alertcenter = google.alertcenter('v1beta1');
* ```
*/
export class Alertcenter {
context: APIRequestContext;
alerts: Resource$Alerts;
v1beta1: Resource$V1beta1;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Alerts for user account warning events.
*/
export interface Schema$AccountWarning {
/**
* Required. The email of the user that this event belongs to.
*/
email?: string | null;
/**
* Optional. Details of the login action associated with the warning event. This is only available for: * Suspicious login * Suspicious login (less secure app) * Suspicious programmatic login * User suspended (suspicious activity)
*/
loginDetails?: Schema$LoginDetails;
}
/**
* Metadata related to the action.
*/
export interface Schema$ActionInfo {
}
/**
* Alerts from Google Workspace Security Center rules service configured by an admin.
*/
export interface Schema$ActivityRule {
/**
* List of action names associated with the rule threshold.
*/
actionNames?: string[] | null;
/**
* Rule create timestamp.
*/
createTime?: string | null;
/**
* Description of the rule.
*/
description?: string | null;
/**
* Alert display name.
*/
displayName?: string | null;
/**
* Rule name.
*/
name?: string | null;
/**
* Query that is used to get the data from the associated source.
*/
query?: string | null;
/**
* List of alert IDs superseded by this alert. It is used to indicate that this alert is essentially extension of superseded alerts and we found the relationship after creating these alerts.
*/
supersededAlerts?: string[] | null;
/**
* Alert ID superseding this alert. It is used to indicate that superseding alert is essentially extension of this alert and we found the relationship after creating both alerts.
*/
supersedingAlert?: string | null;
/**
* Alert threshold is for example “COUNT \> 5”.
*/
threshold?: string | null;
/**
* The trigger sources for this rule. * GMAIL_EVENTS * DEVICE_EVENTS * USER_EVENTS
*/
triggerSource?: string | null;
/**
* The timestamp of the last update to the rule.
*/
updateTime?: string | null;
/**
* Rule window size. Possible values are 1 hour or 24 hours.
*/
windowSize?: string | null;
}
/**
* An alert affecting a customer.
*/
export interface Schema$Alert {
/**
* Output only. The unique identifier for the alert.
*/
alertId?: string | null;
/**
* Output only. The time this alert was created.
*/
createTime?: string | null;
/**
* Output only. The unique identifier of the Google account of the customer.
*/
customerId?: string | null;
/**
* Optional. The data associated with this alert, for example google.apps.alertcenter.type.DeviceCompromised.
*/
data?: {
[key: string]: any;
} | null;
/**
* Output only. `True` if this alert is marked for deletion.
*/
deleted?: boolean | null;
/**
* Optional. The time the event that caused this alert ceased being active. If provided, the end time must not be earlier than the start time. If not provided, it indicates an ongoing alert.
*/
endTime?: string | null;
/**
* Optional. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of an alert from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform alert updates in order to avoid race conditions: An `etag` is returned in the response which contains alerts, and systems are expected to put that etag in the request to update alert to ensure that their change will be applied to the same version of the alert. If no `etag` is provided in the call to update alert, then the existing alert is overwritten blindly.
*/
etag?: string | null;
/**
* Output only. The metadata associated with this alert.
*/
metadata?: Schema$AlertMetadata;
/**
* Output only. An optional [Security Investigation Tool](https://support.google.com/a/answer/7575955) query for this alert.
*/
securityInvestigationToolLink?: string | null;
/**
* Required. A unique identifier for the system that reported the alert. This is output only after alert is created. Supported sources are any of the following: * Google Operations * Mobile device management * Gmail phishing * Domain wide takeout * State sponsored attack * Google identity
*/
source?: string | null;
/**
* Required. The time the event that caused this alert was started or detected.
*/
startTime?: string | null;
/**
* Required. The type of the alert. This is output only after alert is created. For a list of available alert types see [Google Workspace Alert types](/admin-sdk/alertcenter/reference/alert-types).
*/
type?: string | null;
/**
* Output only. The time this alert was last updated.
*/
updateTime?: string | null;
}
/**
* A customer feedback about an alert.
*/
export interface Schema$AlertFeedback {
/**
* Output only. The alert identifier.
*/
alertId?: string | null;
/**
* Output only. The time this feedback was created.
*/
createTime?: string | null;
/**
* Output only. The unique identifier of the Google account of the customer.
*/
customerId?: string | null;
/**
* Output only. The email of the user that provided the feedback.
*/
email?: string | null;
/**
* Output only. The unique identifier for the feedback.
*/
feedbackId?: string | null;
/**
* Required. The type of the feedback.
*/
type?: string | null;
}
/**
* An alert metadata.
*/
export interface Schema$AlertMetadata {
/**
* Output only. The alert identifier.
*/
alertId?: string | null;
/**
* The email address of the user assigned to the alert.
*/
assignee?: string | null;
/**
* Output only. The unique identifier of the Google account of the customer.
*/
customerId?: string | null;
/**
* Optional. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of an alert metadata from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform metatdata updates in order to avoid race conditions: An `etag` is returned in the response which contains alert metadata, and systems are expected to put that etag in the request to update alert metadata to ensure that their change will be applied to the same version of the alert metadata. If no `etag` is provided in the call to update alert metadata, then the existing alert metadata is overwritten blindly.
*/
etag?: string | null;
/**
* The severity value of the alert. Alert Center will set this field at alert creation time, default's to an empty string when it could not be determined. The supported values for update actions on this field are the following: * HIGH * MEDIUM * LOW
*/
severity?: string | null;
/**
* The current status of the alert. The supported values are the following: * NOT_STARTED * IN_PROGRESS * CLOSED
*/
status?: string | null;
/**
* Output only. The time this metadata was last updated.
*/
updateTime?: string | null;
}
/**
* Alerts from App Maker to notify admins to set up default SQL instance.
*/
export interface Schema$AppMakerSqlSetupNotification {
/**
* List of applications with requests for default SQL set up.
*/
requestInfo?: Schema$RequestInfo[];
}
/**
* Alerts from AppSettingsChanged bucket Rules configured by Admin which contain the below rules. Calendar settings changed Drive settings changed Email settings changed Mobile settings changed
*/
export interface Schema$AppSettingsChanged {
/**
* Any other associated alert details, for example, AlertConfiguration.
*/
alertDetails?: string | null;
/**
* Rule name
*/
name?: string | null;
}
/**
* Attachment with application-specific information about an alert.
*/
export interface Schema$Attachment {
/**
* A CSV file attachment.
*/
csv?: Schema$Csv;
}
/**
* Alert for setting the domain or IP that malicious email comes from as whitelisted domain or IP in Gmail advanced settings.
*/
export interface Schema$BadWhitelist {
/**
* The domain ID.
*/
domainId?: Schema$DomainId;
/**
* The entity whose actions triggered a Gmail phishing alert.
*/
maliciousEntity?: Schema$MaliciousEntity;
/**
* The list of messages contained by this alert.
*/
messages?: Schema$GmailMessageInfo[];
/**
* The source IP address of the malicious email, for example, `127.0.0.1`.
*/
sourceIp?: string | null;
}
/**
* A request to perform batch delete on alerts.
*/
export interface Schema$BatchDeleteAlertsRequest {
/**
* Required. list of alert IDs.
*/
alertId?: string[] | null;
/**
* Optional. The unique identifier of the Google Workspace organization account of the customer the alerts are associated with.
*/
customerId?: string | null;
}
/**
* Response to batch delete operation on alerts.
*/
export interface Schema$BatchDeleteAlertsResponse {
/**
* The status details for each failed alert_id.
*/
failedAlertStatus?: {
[key: string]: Schema$Status;
} | null;
/**
* The successful list of alert IDs.
*/
successAlertIds?: string[] | null;
}
/**
* A request to perform batch undelete on alerts.
*/
export interface Schema$BatchUndeleteAlertsRequest {
/**
* Required. list of alert IDs.
*/
alertId?: string[] | null;
/**
* Optional. The unique identifier of the Google Workspace organization account of the customer the alerts are associated with.
*/
customerId?: string | null;
}
/**
* Response to batch undelete operation on alerts.
*/
export interface Schema$BatchUndeleteAlertsResponse {
/**
* The status details for each failed alert_id.
*/
failedAlertStatus?: {
[key: string]: Schema$Status;
} | null;
/**
* The successful list of alert IDs.
*/
successAlertIds?: string[] | null;
}
/**
* A reference to a Cloud Pubsub topic. To register for notifications, the owner of the topic must grant `alerts-api-push-notifications@system.gserviceaccount.com` the `projects.topics.publish` permission.
*/
export interface Schema$CloudPubsubTopic {
/**
* Optional. The format of the payload that would be sent. If not specified the format will be JSON.
*/
payloadFormat?: string | null;
/**
* The `name` field of a Cloud Pubsub [Topic] (https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics#Topic).
*/
topicName?: string | null;
}
/**
* A representation of a CSV file attachment, as a list of column headers and a list of data rows.
*/
export interface Schema$Csv {
/**
* The list of data rows in a CSV file, as string arrays rather than as a single comma-separated string.
*/
dataRows?: Schema$CsvRow[];
/**
* The list of headers for data columns in a CSV file.
*/
headers?: string[] | null;
}
/**
* A representation of a single data row in a CSV file.
*/
export interface Schema$CsvRow {
/**
* The data entries in a CSV file row, as a string array rather than a single comma-separated string.
*/
entries?: string[] | null;
}
/**
* A mobile device compromised alert. Derived from audit logs.
*/
export interface Schema$DeviceCompromised {
/**
* The email of the user this alert was created for.
*/
email?: string | null;
/**
* Required. The list of security events.
*/
events?: Schema$DeviceCompromisedSecurityDetail[];
}
/**
* Detailed information of a single MDM device compromised event.
*/
export interface Schema$DeviceCompromisedSecurityDetail {
/**
* The device compromised state. Possible values are "`Compromised`" or "`Not Compromised`".
*/
deviceCompromisedState?: string | null;
/**
* Required. The device ID.
*/
deviceId?: string | null;
/**
* The model of the device.
*/
deviceModel?: string | null;
/**
* The type of the device.
*/
deviceType?: string | null;
/**
* Required for iOS, empty for others.
*/
iosVendorId?: string | null;
/**
* The device resource ID.
*/
resourceId?: string | null;
/**
* The serial number of the device.
*/
serialNumber?: string | null;
}
/**
* Alerts that get triggered on violations of Data Loss Prevention (DLP) rules.
*/
export interface Schema$DlpRuleViolation {
/**
* Details about the violated DLP rule. Admins can use the predefined detectors provided by Google Cloud DLP https://cloud.google.com/dlp/ when setting up a DLP rule. Matched Cloud DLP detectors in this violation if any will be captured in the MatchInfo.predefined_detector.
*/
ruleViolationInfo?: Schema$RuleViolationInfo;
}
/**
* Domain ID of Gmail phishing alerts.
*/
export interface Schema$DomainId {
/**
* The primary domain for the customer.
*/
customerPrimaryDomain?: string | null;
}
/**
* A takeout operation for the entire domain was initiated by an admin. Derived from audit logs.
*/
export interface Schema$DomainWideTakeoutInitiated {
/**
* The email of the admin who initiated the takeout.
*/
email?: string | null;
/**
* The takeout request ID.
*/
takeoutRequestId?: string | null;
}
/**
* 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 {
}
/**
* Details of a message in phishing spike alert.
*/
export interface Schema$GmailMessageInfo {
/**
* The `SHA256` hash of email's attachment and all MIME parts.
*/
attachmentsSha256Hash?: string[] | null;
/**
* The date the malicious email was sent.
*/
date?: string | null;
/**
* The hash of the message body text.
*/
md5HashMessageBody?: string | null;
/**
* The MD5 Hash of email's subject (only available for reported emails).
*/
md5HashSubject?: string | null;
/**
* The snippet of the message body text (only available for reported emails).
*/
messageBodySnippet?: string | null;
/**
* The message ID.
*/
messageId?: string | null;
/**
* The recipient of this email.
*/
recipient?: string | null;
/**
* The email subject text (only available for reported emails).
*/
subjectText?: string | null;
}
/**
* An incident reported by Google Operations for a Google Workspace application.
*/
export interface Schema$GoogleOperations {
/**
* The list of emails which correspond to the users directly affected by the incident.
*/
affectedUserEmails?: string[] | null;
/**
* Optional. Application-specific data for an incident, provided when the Google Workspace application which reported the incident cannot be completely restored to a valid state.
*/
attachmentData?: Schema$Attachment;
/**
* A detailed, freeform incident description.
*/
description?: string | null;
/**
* A header to display above the incident message. Typically used to attach a localized notice on the timeline for followup comms translations.
*/
header?: string | null;
/**
* A one-line incident description.
*/
title?: string | null;
}
/**
* Response message for an alert feedback listing request.
*/
export interface Schema$ListAlertFeedbackResponse {
/**
* The list of alert feedback. Feedback entries for each alert are ordered by creation time descending.
*/
feedback?: Schema$AlertFeedback[];
}
/**
* Response message for an alert listing request.
*/
export interface Schema$ListAlertsResponse {
/**
* The list of alerts.
*/
alerts?: Schema$Alert[];
/**
* The token for the next page. If not empty, indicates that there may be more alerts that match the listing request; this value can be used in a subsequent ListAlertsRequest to get alerts continuing from last result of the current list call.
*/
nextPageToken?: string | null;
}
/**
* The details of the login action.
*/
export interface Schema$LoginDetails {
/**
* Optional. The human-readable IP address (for example, `11.22.33.44`) that is associated with the warning event.
*/
ipAddress?: string | null;
/**
* Optional. The successful login time that is associated with the warning event. This isn't present for blocked login attempts.
*/
loginTime?: string | null;
}
/**
* Proto for all phishing alerts with common payload. Supported types are any of the following: * User reported phishing * User reported spam spike * Suspicious message reported * Phishing reclassification * Malware reclassification * Gmail potential employee spoofing
*/
export interface Schema$MailPhishing {
/**
* The domain ID.
*/
domainId?: Schema$DomainId;
/**
* If `true`, the email originated from within the organization.
*/
isInternal?: boolean | null;
/**
* The entity whose actions triggered a Gmail phishing alert.
*/
maliciousEntity?: Schema$MaliciousEntity;
/**
* The list of messages contained by this alert.
*/
messages?: Schema$GmailMessageInfo[];
/**
* System actions on the messages.
*/
systemActionType?: string | null;
}
/**
* Entity whose actions triggered a Gmail phishing alert.
*/
export interface Schema$MaliciousEntity {
/**
* The header from display name.
*/
displayName?: string | null;
/**
* The actor who triggered a gmail phishing alert.
*/
entity?: Schema$User;
/**
* The sender email address.
*/
fromHeader?: string | null;
}
/**
* Proto that contains match information from the condition part of the rule.
*/
export interface Schema$MatchInfo {
/**
* For matched detector predefined by Google.
*/
predefinedDetector?: Schema$PredefinedDetectorInfo;
/**
* For matched detector defined by administrators.
*/
userDefinedDetector?: Schema$UserDefinedDetectorInfo;
}
/**
* Settings for callback notifications. For more details see [Google Workspace Alert Notification](/admin-sdk/alertcenter/guides/notifications).
*/
export interface Schema$Notification {
/**
* A Google Cloud Pub/sub topic destination.
*/
cloudPubsubTopic?: Schema$CloudPubsubTopic;
}
/**
* Alert for a spike in user reported phishing. *Warning*: This type has been deprecated. Use [MailPhishing](/admin-sdk/alertcenter/reference/rest/v1beta1/MailPhishing) instead.
*/
export interface Schema$PhishingSpike {
/**
* The domain ID.
*/
domainId?: Schema$DomainId;
/**
* If `true`, the email originated from within the organization.
*/
isInternal?: boolean | null;
/**
* The entity whose actions triggered a Gmail phishing alert.
*/
maliciousEntity?: Schema$MaliciousEntity;
/**
* The list of messages contained by this alert.
*/
messages?: Schema$GmailMessageInfo[];
}
/**
* Detector provided by Google.
*/
export interface Schema$PredefinedDetectorInfo {
/**
* Name that uniquely identifies the detector.
*/
detectorName?: string | null;
}
/**
* Alerts from Reporting Rules configured by Admin.
*/
export interface Schema$ReportingRule {
/**
* Any other associated alert details, for example, AlertConfiguration.
*/
alertDetails?: string | null;
/**
* Rule name
*/
name?: string | null;
/**
* Alert Rule query Sample Query query { condition { filter { expected_application_id: 777491262838 expected_event_name: "indexable_content_change" filter_op: IN \} \} conjunction_operator: OR \}
*/
query?: string | null;
}
/**
* Requests for one application that needs default SQL setup.
*/
export interface Schema$RequestInfo {
/**
* List of app developers who triggered notifications for above application.
*/
appDeveloperEmail?: string[] | null;
/**
* Required. The application that requires the SQL setup.
*/
appKey?: string | null;
/**
* Required. Number of requests sent for this application to set up default SQL instance.
*/
numberOfRequests?: string | null;
}
/**
* Proto that contains resource information.
*/
export interface Schema$ResourceInfo {
/**
* Drive file ID.
*/
documentId?: string | null;
/**
* Title of the resource, for example email subject, or document title.
*/
resourceTitle?: string | null;
}
/**
* Proto that contains rule information.
*/
export interface Schema$RuleInfo {
/**
* User provided name of the rule.
*/
displayName?: string | null;
/**
* Resource name that uniquely identifies the rule.
*/
resourceName?: string | null;
}
/**
* Common alert information about violated rules that are configured by Google Workspace administrators.
*/
export interface Schema$RuleViolationInfo {
/**
* Source of the data.
*/
dataSource?: string | null;
/**
* List of matches that were found in the resource content.
*/
matchInfo?: Schema$MatchInfo[];
/**
* Resource recipients. For Drive, they are grantees that the Drive file was shared with at the time of rule triggering. Valid values include user emails, group emails, domains, or 'anyone' if the file was publicly accessible. If the file was private the recipients list will be empty. For Gmail, they are emails of the users or groups that the Gmail message was sent to.
*/
recipients?: string[] | null;
/**
* Details of the resource which violated the rule.
*/
resourceInfo?: Schema$ResourceInfo;
/**
* Details of the violated rule.
*/
ruleInfo?: Schema$RuleInfo;
/**
* Actions suppressed due to other actions with higher priority.
*/
suppressedActionTypes?: string[] | null;
/**
* Trigger of the rule.
*/
trigger?: string | null;
/**
* Metadata related to the triggered actions.
*/
triggeredActionInfo?: Schema$ActionInfo[];
/**
* Actions applied as a consequence of the rule being triggered.
*/
triggeredActionTypes?: string[] | null;
/**
* Email of the user who caused the violation. Value could be empty if not applicable, for example, a violation found by drive continuous scan.
*/
triggeringUserEmail?: string | null;
}
/**
* Customer-level settings.
*/
export interface Schema$Settings {
/**
* The list of notifications.
*/
notifications?: Schema$Notification[];
}
/**
* A state-sponsored attack alert. Derived from audit logs.
*/
export interface Schema$StateSponsoredAttack {
/**
* The email of the user this incident was created for.
*/
email?: string | null;
}
/**
* The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
*/
export interface Schema$Status {
/**
* The status code, which should be an enum value of google.rpc.Code.
*/
code?: number | null;
/**
* A list of messages that carry the error details. There is a common set of message types for APIs to use.
*/
details?: Array<{
[key: string]: any;
}> | null;
/**
* A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
*/
message?: string | null;
}
/**
* A mobile suspicious activity alert. Derived from audit logs.
*/
export interface Schema$SuspiciousActivity {
/**
* The email of the user this alert was created for.
*/
email?: string | null;
/**
* Required. The list of security events.
*/
events?: Schema$SuspiciousActivitySecurityDetail[];
}
/**
* Detailed information of a single MDM suspicious activity event.
*/
export interface Schema$SuspiciousActivitySecurityDetail {
/**
* Required. The device ID.
*/
deviceId?: string | null;
/**
* The model of the device.
*/
deviceModel?: string | null;
/**
* The device property which was changed.
*/
deviceProperty?: string | null;
/**
* The type of the device.
*/
deviceType?: string | null;
/**
* Required for iOS, empty for others.
*/
iosVendorId?: string | null;
/**
* The new value of the device property after the change.
*/
newValue?: string | null;
/**
* The old value of the device property before the change.
*/
oldValue?: string | null;
/**
* The device resource ID.
*/
resourceId?: string | null;
/**
* The serial number of the device.
*/
serialNumber?: string | null;
}
/**
* A request to undelete a specific alert that was marked for deletion.
*/
export interface Schema$UndeleteAlertRequest {
/**
* Optional. The unique identifier of the Google Workspace organization account of the customer the alert is associated with. Inferred from the caller identity if not provided.
*/
customerId?: string | null;
}
/**
* A user.
*/
export interface Schema$User {
/**
* Display name of the user.
*/
displayName?: string | null;
/**
* Email address of the user.
*/
emailAddress?: string | null;
}
/**
* Alerts from UserChanges bucket Rules for predefined rules which contain the below rules. Suspended user made active New user Added User suspended (by admin) User granted admin privileges User admin privileges revoked User deleted Users password changed
*/
export interface Schema$UserChanges {
/**
* Rule name
*/
name?: string | null;
}
/**
* Detector defined by administrators.
*/
export interface Schema$UserDefinedDetectorInfo {
/**
* Display name of the detector.
*/
displayName?: string | null;
/**
* Resource name that uniquely identifies the detector.
*/
resourceName?: string | null;
}
export class Resource$Alerts {
context: APIRequestContext;
feedback: Resource$Alerts$Feedback;
constructor(context: APIRequestContext);
/**
* Performs batch delete operation on alerts.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/alertcenter.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 alertcenter = google.alertcenter('v1beta1');
*
* 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: ['https://www.googleapis.com/auth/apps.alerts'],
* });
*
* // 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 alertcenter.alerts.batchDelete({
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "alertId": [],
* // "customerId": "my_customerId"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "failedAlertStatus": {},
* // "successAlertIds": []
* // }
* }
*
* 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.
*/
batchDelete(params: Params$Resource$Alerts$Batchdelete, options: StreamMethodOptions): GaxiosPromise<Readable>;
batchDelete(params?: Params$Resource$Alerts$Batchdelete, options?: MethodOptions): GaxiosPromise<Schema$BatchDeleteAlertsResponse>;
batchDelete(params: Params$Resource$Alerts$Batchdelete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
batchDelete(params: Params$Resource$Alerts$Batchdelete, options: MethodOptions | BodyResponseCallback<Schema$BatchDeleteAlertsResponse>, callback: BodyResponseCallback<Schema$BatchDeleteAlertsResponse>): void;
batchDelete(params: Params$Resource$Alerts$Batchdelete, callback: BodyResponseCallback<Schema$BatchDeleteAlertsResponse>): void;
batchDelete(callback: BodyResponseCallback<Schema$BatchDeleteAlertsResponse>): void;
/**
* Performs batch undelete operation on alerts.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/alertcenter.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 alertcenter = google.alertcenter('v1beta1');
*
* 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: ['https://www.googleapis.com/auth/apps.alerts'],
* });
*
* // 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 alertcenter.alerts.batchUndelete({
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "alertId": [],
* // "customerId": "my_customerId"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "failedAlertStatus": {},
* // "successAlertIds": []
* // }
* }
*
* 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.
*/
batchUndelete(params: Params$Resource$Alerts$Batchundelete, options: StreamMethodOptions): GaxiosPromise<Readable>;
batchUndelete(params?: Params$Resource$Alerts$Batchundelete, options?: MethodOptions): GaxiosPromise<Schema$BatchUndeleteAlertsResponse>;
batchUndelete(params: Params$Resource$Alerts$Batchundelete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
batchUndelete(params: Params$Resource$Alerts$Batchundelete, options: MethodOptions | BodyResponseCallback<Schema$BatchUndeleteAlertsResponse>, callback: BodyResponseCallback<Schema$BatchUndeleteAlertsResponse>): void;
batchUndelete(params: Params$Resource$Alerts$Batchundelete, callback: BodyResponseCallback<Schema$BatchUndeleteAlertsResponse>): void;
batchUndelete(callback: BodyResponseCallback<Schema$BatchUndeleteAlertsResponse>): void;
/**
* Marks the specified alert for deletion. An alert that has been marked for deletion is removed from Alert Center after 30 days. Marking an alert for deletion has no effect on an alert which has already been marked for deletion. Attempting to mark a nonexistent alert for deletion results in a `NOT_FOUND` error.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/alertcenter.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 alertcenter = google.alertcenter('v1beta1');
*
* 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: ['https://www.googleapis.com/auth/apps.alerts'],
* });
*
* // 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 alertcenter.alerts.delete({
* // Required. The identifier of the alert to delete.
* alertId: 'placeholder-value',
* // Optional. The unique identifier of the Google Workspace organization account of the customer the alert is associated with. Inferred from the caller identity if not provided.
* customerId: 'placeholder-value',
* });
* 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.
*/
delete(params: Params$Resource$Alerts$Delete, options: StreamMethodOptions): GaxiosPromise<Readable>;
delete(params?: Params$Resource$Alerts$Delete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
delete(params: Params$Resource$Alerts$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
delete(params: Params$Resource$Alerts$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
delete(params: Params$Resource$Alerts$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
delete(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* Gets the specified alert. Attempting to get a nonexistent alert returns `NOT_FOUND` error.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/alertcenter.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 alertcenter = google.alertcenter('v1beta1');
*
* 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: ['https://www.googleapis.com/auth/apps.alerts'],
* });
*
* // 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 alertcenter.alerts.get({
* // Required. The identifier of the alert to retrieve.
* alertId: 'placeholder-value',
* // Optional. The unique identifier of the Google Workspace organization account of the customer the alert is associated with. Inferred from the caller identity if not provided.
* customerId: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "alertId": "my_alertId",
* // "createTime": "my_createTime",
* // "customerId": "my_customerId",
* // "data": {},
* // "deleted": false,
* // "endTime": "my_endTime",
* // "etag": "my_etag",
* // "metadata": {},
* // "securityInvestigationToolLink": "my_securityInvestigationToolLink",
* // "source": "my_source",
* // "startTime": "my_startTime",
* // "type": "my_type",
* // "updateTime": "my_updateTime"
* // }
* }
*
* 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$Alerts$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
get(params?: Params$Resource$Alerts$Get, options?: MethodOptions): GaxiosPromise<Schema$Alert>;
get(params: Params$Resource$Alerts$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
get(params: Params$Resource$Alerts$Get, options: MethodOptions | BodyResponseCallback<Schema$Alert>, callback: BodyResponseCallback<Schema$Alert>): void;
get(params: Params$Resource$Alerts$Get, callback: BodyResponseCallback<Schema$Alert>): void;
get(callback: BodyResponseCallback<Schema$Alert>): void;
/**
* Returns the metadata of an alert. Attempting to get metadata for a non-existent alert returns `NOT_FOUND` error.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/alertcenter.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 alertcenter = google.alertcenter('v1beta1');
*
* 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: ['https://www.googleapis.com/auth/apps.alerts'],
* });
*
* // 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 alertcenter.alerts.getMetadata({
* // Required. The identifier of the alert this metadata belongs to.
* alertId: 'placeholder-value',
* // Optional. The unique identifier of the Google Workspace organization account of the customer the alert metadata is associated with. Inferred from the caller identity if not provided.
* customerId: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "alertId": "my_alertId",
* // "assignee": "my_assignee",
* // "customerId": "my_customerId",
* // "etag": "my_etag",
* // "severity": "my_severity",
* // "status": "my_status",
* // "updateTime": "my_updateTime"
* // }
* }
*
* 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.
*/
getMetadata(params: Params$Resource$Alerts$Getmetadata, options: StreamMethodOptions): GaxiosPromise<Readable>;
getMetadata(params?: Params$Resource$Alerts$Getmetadata, options?: MethodOptions): GaxiosPromise<Schema$AlertMetadata>;
getMetadata(params: Params$Resource$Alerts$Getmetadata, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
getMetadata(params: Params$Resource$Alerts$Getmetadata, options: MethodOptions | BodyResponseCallback<Schema$AlertMetadata>, callback: BodyResponseCallback<Schema$AlertMetadata>): void;
getMetadata(params: Params$Resource$Alerts$Getmetadata, callback: BodyResponseCallback<Schema$AlertMetadata>): void;
getMetadata(callback: BodyResponseCallback<Schema$AlertMetadata>): void;
/**
* Lists the alerts.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/alertcenter.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 alertcenter = google.alertcenter('v1beta1');
*
* 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: ['https://www.googleapis.com/auth/apps.alerts'],
* });
*
* // 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 alertcenter.alerts.list({
* // Optional. The unique identifier of the Google Workspace organization account of the customer the alerts are associated with. Inferred from the caller identity if not provided.
* customerId: 'placeholder-value',
* // Optional. A query string for filtering alert results. For more details, see [Query filters](/admin-sdk/alertcenter/guides/query-filters) and [Supported query filter fields](/admin-sdk/alertcenter/reference/filter-fields#alerts.list).
* filter: 'placeholder-value',
* // Optional. The sort order of the list results. If not specified results may be returned in arbitrary order. You can sort the results in descending order based on the creation timestamp using `order_by="create_time desc"`. Currently, supported sorting are `create_time asc`, `create_time desc`, `update_time desc`
* orderBy: 'placeholder-value',
* // Optional. The requested page size. Server may return fewer items than requested. If unspecified, server picks an appropriate default.
* pageSize: 'placeholder-value',
* // Optional. A token identifying a page of results the server should return. If empty, a new iteration is started. To continue an iteration, pass in the value from the previous ListAlertsResponse's next_page_token field.
* pageToken: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "alerts": [],
* // "nextPageToken": "my_nextPageToken"
* // }
* }
*
* 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$Alerts$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Alerts$List, options?: MethodOptions): GaxiosPromise<Schema$ListAlertsResponse>;
list(params: Params$Resource$Alerts$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Alerts$List, options: MethodOptions | BodyResponseCallback<Schema$ListAlertsResponse>, callback: BodyResponseCallback<Schema$ListAlertsResponse>): void;
list(params: Params$Resource$Alerts$List, callback: BodyResponseCallback<Schema$ListAlertsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListAlertsResponse>): void;
/**
* Restores, or "undeletes", an alert that was marked for deletion within the past 30 days. Attempting to undelete an alert which was marked for deletion over 30 days ago (which has been removed from the Alert Center database) or a nonexistent alert returns a `NOT_FOUND` error. Attempting to undelete an alert which has not been marked for deletion has no effect.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/alertcenter.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 alertcenter = google.alertcenter('v1beta1');
*
* 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: ['https://www.googleapis.com/auth/apps.alerts'],
* });
*
* // 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 alertcenter.alerts.undelete({
* // Required. The identifier of the alert to undelete.
* alertId: 'placeholder-value',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "customerId": "my_customerId"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "alertId": "my_alertId",
* // "createTime": "my_createTime",
* // "customerId": "my_customerId",
* // "data": {},
* // "deleted": false,
* // "endTime": "my_endTime",
* // "etag": "my_etag",
* // "metadata": {},
* // "securityInvestigationToolLink": "my_securityInvestigationToolLink",
* // "source": "my_source",
* // "startTime": "my_startTime",
* // "type": "my_type",
* // "updateTime": "my_updateTime"
* // }
* }
*
* 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.
*/
undelete(params: Params$Resource$Alerts$Undelete, options: StreamMethodOptions): GaxiosPromise<Readable>;
undelete(params?: Params$Resource$Alerts$Undelete, options?: MethodOptions): GaxiosPromise<Schema$Alert>;
undelete(params: Params$Resource$Alerts$Undelete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
undelete(params: Params$Resource$Alerts$Undelete, options: MethodOptions | BodyResponseCallback<Schema$Alert>, callback: BodyResponseCallback<Schema$Alert>): void;
undelete(params: Params$Resource$Alerts$Undelete, callback: BodyResponseCallback<Schema$Alert>): void;
undelete(callback: BodyResponseCallback<Schema$Alert>): void;
}
export interface Params$Resource$Alerts$Batchdelete extends StandardParameters {
/**
* Request body metadata
*/
requestBody?: Schema$BatchDeleteAlertsRequest;
}
export interface Params$Resource$Alerts$Batchundelete extends StandardParameters {
/**
* Request body metadata
*/
requestBody?: Schema$BatchUndeleteAlertsRequest;
}
export interface Params$Resource$Alerts$Delete extends StandardParameters {
/**
* Required. The identifier of the alert to delete.
*/
alertId?: string;
/**
* Optional. The unique identifier of the Google Workspace organization account of the customer the alert is associated with. Inferred from the caller identity if not provided.
*/
customerId?: string;
}
export interface Params$Resource$Alerts$Get extends StandardParameters {
/**
* Required. The identifier of the alert to retrieve.
*/
alertId?: string;
/**
* Optional. The unique identifier of the Google Workspace organization account of the customer the alert is associated with. Inferred from the caller identity if not provided.
*/
customerId?: string;
}
export interface Params$Resource$Alerts$Getmetadata extends StandardParameters {
/**
* Required. The identifier of the alert this metadata belongs to.
*/
alertId?: string;
/**
* Optional. The unique identifier of the Google Workspace organization account of the customer the alert metadata is associated with. Inferred from the caller identity if not provided.
*/
customerId?: string;
}
export interface Params$Resource$Alerts$List extends StandardParameters {
/**
* Optional. The unique identifier of the Google Workspace organization account of the customer the alerts are associated with. Inferred from the caller identity if not provided.
*/
customerId?: string;
/**
* Optional. A query string for filtering alert results. For more details, see [Query filters](/admin-sdk/alertcenter/guides/query-filters) and [Supported query filter fields](/admin-sdk/alertcenter/reference/filter-fields#alerts.list).
*/
filter?: string;
/**
* Optional. The sort order of the list results. If not specified results may be returned in arbitrary order. You can sort the results in descending order based on the creation timestamp using `order_by="create_time desc"`. Currently, supported sorting are `create_time asc`, `create_time desc`, `update_time desc`
*/
orderBy?: string;
/**
* Optional. The requested page size. Server may return fewer items than requested. If unspecified, server picks an appropriate default.
*/
pageSize?: number;
/**
* Optional. A token identifying a page of results the server should return. If empty, a new iteration is started. To continue an iteration, pass in the value from the previous ListAlertsResponse's next_page_token field.
*/
pageToken?: string;
}
export interface Params$Resource$Alerts$Undelete extends StandardParameters {
/**
* Required. The identifier of the alert to undelete.
*/
alertId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$UndeleteAlertRequest;
}
export class Resource$Alerts$Feedback {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* Creates new feedback for an alert. Attempting to create a feedback for a non-existent alert returns `NOT_FOUND` error. Attempting to create a feedback for an alert that is marked for deletion returns `FAILED_PRECONDITION' error.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/alertcenter.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 alertcenter = google.alertcenter('v1beta1');
*
* 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: ['https://www.googleapis.com/auth/apps.alerts'],
* });
*
* // 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 alertcenter.alerts.feedback.create({
* // Required. The identifier of the alert this feedback belongs to.
* alertId: 'placeholder-value',
* // Optional. The unique identifier of the Google Workspace organization account of the customer the alert is associated with. Inferred from the caller identity if not provided.
* customerId: 'placeholder-value',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "alertId": "my_alertId",
* // "createTime": "my_createTime",
* // "customerId": "my_customerId",
* // "email": "my_email",
* // "feedbackId": "my_feedbackId",
* // "type": "my_type"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "alertId": "my_alertId",
* // "createTime": "my_createTime",
* // "customerId": "my_customerId",
* // "email": "my_email",
* // "feedbackId": "my_feedbackId",
* // "type": "my_type"
* // }
* }
*
* 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$Alerts$Feedback$Create, options: StreamMethodOptions): GaxiosPromise<Readable>;
create(params?: Params$Resource$Alerts$Feedback$Create, options?: MethodOptions): GaxiosPromise<Schema$AlertFeedback>;
create(params: Params$Resource$Alerts$Feedback$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
create(params: Params$Resource$Alerts$Feedback$Create, options: MethodOptions | BodyResponseCallback<Schema$AlertFeedback>, callback: BodyResponseCallback<Schema$AlertFeedback>): void;
create(params: Params$Resource$Alerts$Feedback$Create, callback: BodyResponseCallback<Schema$AlertFeedback>): void;
create(callback: BodyResponseCallback<Schema$AlertFeedback>): void;
/**
* Lists all the feedback for an alert. Attempting to list feedbacks for a non-existent alert returns `NOT_FOUND` error.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/alertcenter.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 alertcenter = google.alertcenter('v1beta1');
*
* 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: ['https://www.googleapis.com/auth/apps.alerts'],
* });
*
* // 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 alertcenter.alerts.feedback.list({
* // Required. The alert identifier. The "-" wildcard could be used to represent all alerts.
* alertId: 'placeholder-value',
* // Optional. The unique identifier of the Google Workspace organization account of the customer the alert feedback are associated with. Inferred from the caller identity if not provided.
* customerId: 'placeholder-value',
* // Optional. A query string for filtering alert feedback results. For more details, see [Query filters](/admin-sdk/alertcenter/guides/query-filters) and [Supported query filter fields](/admin-sdk/alertcenter/reference/filter-fields#alerts.feedback.list).
* filter: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "feedback": []
* // }
* }
*
* 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$Alerts$Feedback$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Alerts$Feedback$List, options?: MethodOptions): GaxiosPromise<Schema$ListAlertFeedbackResponse>;
list(params: Params$Resource$Alerts$Feedback$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Alerts$Feedback$List, options: MethodOptions | BodyResponseCallback<Schema$ListAlertFeedbackResponse>, callback: BodyResponseCallback<Schema$ListAlertFeedbackResponse>): void;
list(params: Params$Resource$Alerts$Feedback$List, callback: BodyResponseCallback<Schema$ListAlertFeedbackResponse>): void;
list(callback: BodyResponseCallback<Schema$ListAlertFeedbackResponse>): void;
}
export interface Params$Resource$Alerts$Feedback$Create extends StandardParameters {
/**
* Required. The identifier of the alert this feedback belongs to.
*/
alertId?: string;
/**
* Optional. The unique identifier of the Google Workspace organization account of the customer the alert is associated with. Inferred from the caller identity if not provided.
*/
customerId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$AlertFeedback;
}
export interface Params$Resource$Alerts$Feedback$List extends StandardParameters {
/**
* Required. The alert identifier. The "-" wildcard could be used to represent all alerts.
*/
alertId?: string;
/**
* Optional. The unique identifier of the Google Workspace organization account of the customer the alert feedback are associated with. Inferred from the caller identity if not provided.
*/
customerId?: string;
/**
* Optional. A query string for filtering alert feedback results. For more details, see [Query filters](/admin-sdk/alertcenter/guides/query-filters) and [Supported query filter fields](/admin-sdk/alertcenter/reference/filter-fields#alerts.feedback.list).
*/
filter?: string;
}
export class Resource$V1beta1 {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* Returns customer-level settings.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/alertcenter.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 alertcenter = google.alertcenter('v1beta1');
*
* 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: ['https://www.googleapis.com/auth/apps.alerts'],
* });
*
* // 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 alertcenter.getSettings({
* // Optional. The unique identifier of the Google Workspace organization account of the customer the alert settings are associated with. Inferred from the caller identity if not provided.
* customerId: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "notifications": []
* // }
* }
*
* 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.
*/
getSettings(params: Params$Resource$V1beta1$Getsettings, options: StreamMethodOptions): GaxiosPromise<Readable>;
getSettings(params?: Params$Resource$V1beta1$Getsettings, options?: MethodOptions): GaxiosPromise<Schema$Settings>;
getSettings(params: Params$Resource$V1beta1$Getsettings, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
getSettings(params: Params$Resource$V1beta1$Getsettings, options: MethodOptions | BodyResponseCallback<Schema$Settings>, callback: BodyResponseCallback<Schema$Settings>): void;
getSettings(params: Params$Resource$V1beta1$Getsettings, callback: BodyResponseCallback<Schema$Settings>): void;
getSettings(callback: BodyResponseCallback<Schema$Settings>): void;
/**
* Updates the customer-level settings.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/alertcenter.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 alertcenter = google.alertcenter('v1beta1');
*
* 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: ['https://www.googleapis.com/auth/apps.alerts'],
* });
*
* // 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 alertcenter.updateSettings({
* // Optional. The unique identifier of the Google Workspace organization account of the customer the alert settings are associated with. Inferred from the caller identity if not provided.
* customerId: 'placeholder-value',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "notifications": []
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "notifications": []
* // }
* }
*
* 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.
*/
updateSettings(params: Params$Resource$V1beta1$Updatesettings, options: StreamMethodOptions): GaxiosPromise<Readable>;
updateSettings(params?: Params$Resource$V1beta1$Updatesettings, options?: MethodOptions): GaxiosPromise<Schema$Settings>;
updateSettings(params: Params$Resource$V1beta1$Updatesettings, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
updateSettings(params: Params$Resource$V1beta1$Updatesettings, options: MethodOptions | BodyResponseCallback<Schema$Settings>, callback: BodyResponseCallback<Schema$Settings>): void;
updateSettings(params: Params$Resource$V1beta1$Updatesettings, callback: BodyResponseCallback<Schema$Settings>): void;
updateSettings(callback: BodyResponseCallback<Schema$Settings>): void;
}
export interface Params$Resource$V1beta1$Getsettings extends StandardParameters {
/**
* Optional. The unique identifier of the Google Workspace organization account of the customer the alert settings are associated with. Inferred from the caller identity if not provided.
*/
customerId?: string;
}
export interface Params$Resource$V1beta1$Updatesettings extends StandardParameters {
/**
* Optional. The unique identifier of the Google Workspace organization account of the customer the alert settings are associated with. Inferred from the caller identity if not provided.
*/
customerId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Settings;
}
export {};
}