v1.d.ts
75.1 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
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
/**
* Copyright 2019 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { OAuth2Client, JWT, Compute, UserRefreshClient } from 'google-auth-library';
import { GoogleConfigurable, MethodOptions, GlobalOptions, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { GaxiosPromise } from 'gaxios';
export declare namespace vault_v1 {
export interface Options extends GlobalOptions {
version: 'v1';
}
interface StandardParameters {
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* G Suite Vault API
*
* Archiving and eDiscovery for G Suite.
*
* @example
* const {google} = require('googleapis');
* const vault = google.vault('v1');
*
* @namespace vault
* @type {Function}
* @version v1
* @variation v1
* @param {object=} options Options for Vault
*/
export class Vault {
context: APIRequestContext;
matters: Resource$Matters;
operations: Resource$Operations;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Accounts to search
*/
export interface Schema$AccountInfo {
/**
* A set of accounts to search.
*/
emails?: string[] | null;
}
/**
* A status detailing the status of each account creation, and the HeldAccount, if successful.
*/
export interface Schema$AddHeldAccountResult {
/**
* If present, this account was successfully created.
*/
account?: Schema$HeldAccount;
/**
* This represents the success status. If failed, check message.
*/
status?: Schema$Status;
}
/**
* Add a list of accounts to a hold.
*/
export interface Schema$AddHeldAccountsRequest {
/**
* Account ids to identify which accounts to add. Only account_ids or only emails should be specified, but not both.
*/
accountIds?: string[] | null;
/**
* Emails to identify which accounts to add. Only emails or only account_ids should be specified, but not both.
*/
emails?: string[] | null;
}
/**
* Response for batch create held accounts.
*/
export interface Schema$AddHeldAccountsResponse {
/**
* The list of responses, in the same order as the batch request.
*/
responses?: Schema$AddHeldAccountResult[];
}
/**
* Add an account with the permission specified. The role cannot be owner. If an account already has a role in the matter, it will be overwritten.
*/
export interface Schema$AddMatterPermissionsRequest {
/**
* Only relevant if send_emails is true. True to CC requestor in the email message. False to not CC requestor.
*/
ccMe?: boolean | null;
/**
* The MatterPermission to add.
*/
matterPermission?: Schema$MatterPermission;
/**
* True to send notification email to the added account. False to not send notification email.
*/
sendEmails?: boolean | null;
}
/**
* Close a matter by ID.
*/
export interface Schema$CloseMatterRequest {
}
/**
* Response to a CloseMatterRequest.
*/
export interface Schema$CloseMatterResponse {
/**
* The updated matter, with state CLOSED.
*/
matter?: Schema$Matter;
}
/**
* An export file on cloud storage
*/
export interface Schema$CloudStorageFile {
/**
* The cloud storage bucket name of this export file. Can be used in cloud storage JSON/XML API.
*/
bucketName?: string | null;
/**
* The md5 hash of the file.
*/
md5Hash?: string | null;
/**
* The cloud storage object name of this export file. Can be used in cloud storage JSON/XML API.
*/
objectName?: string | null;
/**
* The size of the export file.
*/
size?: string | null;
}
/**
* Export sink for cloud storage files.
*/
export interface Schema$CloudStorageSink {
/**
* Output only. The exported files on cloud storage.
*/
files?: Schema$CloudStorageFile[];
}
/**
* Corpus specific queries.
*/
export interface Schema$CorpusQuery {
/**
* Details pertaining to Drive holds. If set, corpus must be Drive.
*/
driveQuery?: Schema$HeldDriveQuery;
/**
* Details pertaining to Groups holds. If set, corpus must be Groups.
*/
groupsQuery?: Schema$HeldGroupsQuery;
/**
* Details pertaining to Hangouts Chat holds. If set, corpus must be Hangouts Chat.
*/
hangoutsChatQuery?: Schema$HeldHangoutsChatQuery;
/**
* Details pertaining to mail holds. If set, corpus must be mail.
*/
mailQuery?: Schema$HeldMailQuery;
}
/**
* The options for Drive export.
*/
export interface Schema$DriveExportOptions {
/**
* Set to true to include access level information for users with <a href="https://support.google.com/vault/answer/6099459#metadata">indirect access</a> to files.
*/
includeAccessInfo?: boolean | null;
}
/**
* Drive search advanced options
*/
export interface Schema$DriveOptions {
/**
* Set to true to include shared drive.
*/
includeSharedDrives?: boolean | null;
/**
* Set to true to include Team Drive.
*/
includeTeamDrives?: boolean | null;
/**
* Search the versions of the Drive file as of the reference date. These timestamps are in GMT and rounded down to the given date.
*/
versionDate?: 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 {
}
/**
* An export
*/
export interface Schema$Export {
/**
* Output only. Export sink for cloud storage files.
*/
cloudStorageSink?: Schema$CloudStorageSink;
/**
* Output only. The time when the export was created.
*/
createTime?: string | null;
/**
* Advanced options of the export.
*/
exportOptions?: Schema$ExportOptions;
/**
* Output only. The generated export ID.
*/
id?: string | null;
/**
* Output only. The matter ID.
*/
matterId?: string | null;
/**
* The export name.
*/
name?: string | null;
/**
* The search query being exported.
*/
query?: Schema$Query;
/**
* Output only. The requester of the export.
*/
requester?: Schema$UserInfo;
/**
* Output only. Export statistics.
*/
stats?: Schema$ExportStats;
/**
* Output only. The export status.
*/
status?: string | null;
}
/**
* Export advanced options
*/
export interface Schema$ExportOptions {
/**
* Option available for Drive export.
*/
driveOptions?: Schema$DriveExportOptions;
/**
* Option available for groups export.
*/
groupsOptions?: Schema$GroupsExportOptions;
/**
* Option available for hangouts chat export.
*/
hangoutsChatOptions?: Schema$HangoutsChatExportOptions;
/**
* Option available for mail export.
*/
mailOptions?: Schema$MailExportOptions;
/**
* The requested export location.
*/
region?: string | null;
}
/**
* Stats of an export.
*/
export interface Schema$ExportStats {
/**
* The number of documents already processed by the export.
*/
exportedArtifactCount?: string | null;
/**
* The size of export in bytes.
*/
sizeInBytes?: string | null;
/**
* The number of documents to be exported.
*/
totalArtifactCount?: string | null;
}
/**
* The options for groups export.
*/
export interface Schema$GroupsExportOptions {
/**
* The export format for groups export.
*/
exportFormat?: string | null;
}
/**
* The options for hangouts chat export.
*/
export interface Schema$HangoutsChatExportOptions {
/**
* The export format for hangouts chat export.
*/
exportFormat?: string | null;
}
/**
* Accounts to search
*/
export interface Schema$HangoutsChatInfo {
/**
* A set of rooms to search.
*/
roomId?: string[] | null;
}
/**
* Hangouts chat search advanced options
*/
export interface Schema$HangoutsChatOptions {
/**
* Set to true to include rooms.
*/
includeRooms?: boolean | null;
}
/**
* An account being held in a particular hold. This structure is immutable. This can be either a single user or a google group, depending on the corpus.
*/
export interface Schema$HeldAccount {
/**
* The account's ID as provided by the <a href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
*/
accountId?: string | null;
/**
* The primary email address of the account. If used as an input, this takes precedence over account ID.
*/
email?: string | null;
/**
* Output only. The first name of the account holder.
*/
firstName?: string | null;
/**
* Output only. When the account was put on hold.
*/
holdTime?: string | null;
/**
* Output only. The last name of the account holder.
*/
lastName?: string | null;
}
/**
* Query options for Drive holds.
*/
export interface Schema$HeldDriveQuery {
/**
* If true, include files in shared drives in the hold.
*/
includeSharedDriveFiles?: boolean | null;
/**
* If true, include files in Team Drives in the hold.
*/
includeTeamDriveFiles?: boolean | null;
}
/**
* Query options for group holds.
*/
export interface Schema$HeldGroupsQuery {
/**
* The end time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
*/
endTime?: string | null;
/**
* The start time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
*/
startTime?: string | null;
/**
* The search terms for the hold.
*/
terms?: string | null;
}
/**
* Query options for hangouts chat holds.
*/
export interface Schema$HeldHangoutsChatQuery {
/**
* If true, include rooms the user has participated in.
*/
includeRooms?: boolean | null;
}
/**
* Query options for mail holds.
*/
export interface Schema$HeldMailQuery {
/**
* The end time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
*/
endTime?: string | null;
/**
* The start time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
*/
startTime?: string | null;
/**
* The search terms for the hold.
*/
terms?: string | null;
}
/**
* A organizational unit being held in a particular hold. This structure is immutable.
*/
export interface Schema$HeldOrgUnit {
/**
* When the org unit was put on hold. This property is immutable.
*/
holdTime?: string | null;
/**
* The org unit's immutable ID as provided by the Admin SDK.
*/
orgUnitId?: string | null;
}
/**
* Represents a hold within Vault. A hold restricts purging of artifacts based on the combination of the query and accounts restrictions. A hold can be configured to either apply to an explicitly configured set of accounts, or can be applied to all members of an organizational unit.
*/
export interface Schema$Hold {
/**
* If set, the hold applies to the enumerated accounts and org_unit must be empty.
*/
accounts?: Schema$HeldAccount[];
/**
* The corpus to be searched.
*/
corpus?: string | null;
/**
* The unique immutable ID of the hold. Assigned during creation.
*/
holdId?: string | null;
/**
* The name of the hold.
*/
name?: string | null;
/**
* If set, the hold applies to all members of the organizational unit and accounts must be empty. This property is mutable. For groups holds, set the accounts field.
*/
orgUnit?: Schema$HeldOrgUnit;
/**
* The corpus-specific query. If set, the corpusQuery must match corpus type.
*/
query?: Schema$CorpusQuery;
/**
* The last time this hold was modified.
*/
updateTime?: string | null;
}
/**
* The holds for a matter.
*/
export interface Schema$ListExportsResponse {
/**
* The list of exports.
*/
exports?: Schema$Export[];
/**
* Page token to retrieve the next page of results in the list.
*/
nextPageToken?: string | null;
}
/**
* Returns a list of held accounts for a hold.
*/
export interface Schema$ListHeldAccountsResponse {
/**
* The held accounts on a hold.
*/
accounts?: Schema$HeldAccount[];
}
/**
* The holds for a matter.
*/
export interface Schema$ListHoldsResponse {
/**
* The list of holds.
*/
holds?: Schema$Hold[];
/**
* Page token to retrieve the next page of results in the list. If this is empty, then there are no more holds to list.
*/
nextPageToken?: string | null;
}
/**
* Provides the list of matters.
*/
export interface Schema$ListMattersResponse {
/**
* List of matters.
*/
matters?: Schema$Matter[];
/**
* Page token to retrieve the next page of results in the list.
*/
nextPageToken?: string | null;
}
/**
* Definition of the response for method ListSaveQuery.
*/
export interface Schema$ListSavedQueriesResponse {
/**
* Page token to retrieve the next page of results in the list. If this is empty, then there are no more saved queries to list.
*/
nextPageToken?: string | null;
/**
* List of output saved queries.
*/
savedQueries?: Schema$SavedQuery[];
}
/**
* The options for mail export.
*/
export interface Schema$MailExportOptions {
/**
* The export file format.
*/
exportFormat?: string | null;
/**
* Set to true to export confidential mode content.
*/
showConfidentialModeContent?: boolean | null;
}
/**
* Mail search advanced options
*/
export interface Schema$MailOptions {
/**
* Set to true to exclude drafts.
*/
excludeDrafts?: boolean | null;
}
/**
* Represents a matter.
*/
export interface Schema$Matter {
/**
* The description of the matter.
*/
description?: string | null;
/**
* The matter ID which is generated by the server. Should be blank when creating a new matter.
*/
matterId?: string | null;
/**
* List of users and access to the matter. Currently there is no programmer defined limit on the number of permissions a matter can have.
*/
matterPermissions?: Schema$MatterPermission[];
/**
* The name of the matter.
*/
name?: string | null;
/**
* The state of the matter.
*/
state?: string | null;
}
/**
* Currently each matter only has one owner, and all others are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist.
*/
export interface Schema$MatterPermission {
/**
* The account id, as provided by <a href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
*/
accountId?: string | null;
/**
* The user's role in this matter.
*/
role?: string | null;
}
/**
* Org Unit to search
*/
export interface Schema$OrgUnitInfo {
/**
* Org unit to search, as provided by the <a href="https://developers.google.com/admin-sdk/directory/">Admin SDK Directory API</a>.
*/
orgUnitId?: string | null;
}
/**
* A query definition relevant for search & export.
*/
export interface Schema$Query {
/**
* When 'ACCOUNT' is chosen as search method, account_info needs to be specified.
*/
accountInfo?: Schema$AccountInfo;
/**
* The corpus to search.
*/
corpus?: string | null;
/**
* The data source to search from.
*/
dataScope?: string | null;
/**
* For Drive search, specify more options in this field.
*/
driveOptions?: Schema$DriveOptions;
/**
* The end time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
*/
endTime?: string | null;
/**
* When 'ROOM' is chosen as search method, hangout_chats_info needs to be specified. (read-only)
*/
hangoutsChatInfo?: Schema$HangoutsChatInfo;
/**
* For hangouts chat search, specify more options in this field. (read-only)
*/
hangoutsChatOptions?: Schema$HangoutsChatOptions;
/**
* For mail search, specify more options in this field.
*/
mailOptions?: Schema$MailOptions;
/**
* The search method to use. This field is similar to the search_method field but is introduced to support shared drives. It supports all search method types. In case the search_method is TEAM_DRIVE the response of this field will be SHARED_DRIVE only.
*/
method?: string | null;
/**
* When 'ORG_UNIT' is chosen as as search method, org_unit_info needs to be specified.
*/
orgUnitInfo?: Schema$OrgUnitInfo;
/**
* The search method to use.
*/
searchMethod?: string | null;
/**
* When 'SHARED_DRIVE' is chosen as search method, shared_drive_info needs to be specified.
*/
sharedDriveInfo?: Schema$SharedDriveInfo;
/**
* The start time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
*/
startTime?: string | null;
/**
* When 'TEAM_DRIVE' is chosen as search method, team_drive_info needs to be specified.
*/
teamDriveInfo?: Schema$TeamDriveInfo;
/**
* The corpus-specific <a href="https://support.google.com/vault/answer/2474474">search operators</a> used to generate search results.
*/
terms?: string | null;
/**
* The time zone name. It should be an IANA TZ name, such as "America/Los_Angeles". For more information, see <a href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones">Time Zone</a>.
*/
timeZone?: string | null;
}
/**
* Remove a list of accounts from a hold.
*/
export interface Schema$RemoveHeldAccountsRequest {
/**
* Account ids to identify HeldAccounts to remove.
*/
accountIds?: string[] | null;
}
/**
* Response for batch delete held accounts.
*/
export interface Schema$RemoveHeldAccountsResponse {
/**
* A list of statuses for deleted accounts. Results have the same order as the request.
*/
statuses?: Schema$Status[];
}
/**
* Remove an account as a matter collaborator.
*/
export interface Schema$RemoveMatterPermissionsRequest {
/**
* The account ID.
*/
accountId?: string | null;
}
/**
* Reopen a matter by ID.
*/
export interface Schema$ReopenMatterRequest {
}
/**
* Response to a ReopenMatterRequest.
*/
export interface Schema$ReopenMatterResponse {
/**
* The updated matter, with state OPEN.
*/
matter?: Schema$Matter;
}
/**
* Definition of the saved query.
*/
export interface Schema$SavedQuery {
/**
* Output only. The server generated timestamp at which saved query was created.
*/
createTime?: string | null;
/**
* Name of the saved query.
*/
displayName?: string | null;
/**
* Output only. The matter id of the associated matter. The server does not look at this field during create and always uses matter id in the URL.
*/
matterId?: string | null;
/**
* The underlying Query object which contains all the information of the saved query.
*/
query?: Schema$Query;
/**
* A unique identifier for the saved query.
*/
savedQueryId?: string | null;
}
/**
* Shared drives to search
*/
export interface Schema$SharedDriveInfo {
/**
* List of Shared drive ids, as provided by <a href="https://developers.google.com/drive">Drive API</a>.
*/
sharedDriveIds?: 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;
}
/**
* Team Drives to search
*/
export interface Schema$TeamDriveInfo {
/**
* List of Team Drive ids, as provided by <a href="https://developers.google.com/drive">Drive API</a>.
*/
teamDriveIds?: string[] | null;
}
/**
* Undelete a matter by ID.
*/
export interface Schema$UndeleteMatterRequest {
}
/**
* User's information.
*/
export interface Schema$UserInfo {
/**
* The displayed name of the user.
*/
displayName?: string | null;
/**
* The email address of the user.
*/
email?: string | null;
}
export class Resource$Matters {
context: APIRequestContext;
exports: Resource$Matters$Exports;
holds: Resource$Matters$Holds;
savedQueries: Resource$Matters$Savedqueries;
constructor(context: APIRequestContext);
/**
* vault.matters.addPermissions
* @desc Adds an account as a matter collaborator.
* @alias vault.matters.addPermissions
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.matterId The matter ID.
* @param {().AddMatterPermissionsRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
addPermissions(params?: Params$Resource$Matters$Addpermissions, options?: MethodOptions): GaxiosPromise<Schema$MatterPermission>;
addPermissions(params: Params$Resource$Matters$Addpermissions, options: MethodOptions | BodyResponseCallback<Schema$MatterPermission>, callback: BodyResponseCallback<Schema$MatterPermission>): void;
addPermissions(params: Params$Resource$Matters$Addpermissions, callback: BodyResponseCallback<Schema$MatterPermission>): void;
addPermissions(callback: BodyResponseCallback<Schema$MatterPermission>): void;
/**
* vault.matters.close
* @desc Closes the specified matter. Returns matter with updated state.
* @alias vault.matters.close
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.matterId The matter ID.
* @param {().CloseMatterRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
close(params?: Params$Resource$Matters$Close, options?: MethodOptions): GaxiosPromise<Schema$CloseMatterResponse>;
close(params: Params$Resource$Matters$Close, options: MethodOptions | BodyResponseCallback<Schema$CloseMatterResponse>, callback: BodyResponseCallback<Schema$CloseMatterResponse>): void;
close(params: Params$Resource$Matters$Close, callback: BodyResponseCallback<Schema$CloseMatterResponse>): void;
close(callback: BodyResponseCallback<Schema$CloseMatterResponse>): void;
/**
* vault.matters.create
* @desc Creates a new matter with the given name and description. The initial state is open, and the owner is the method caller. Returns the created matter with default view.
* @alias vault.matters.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {().Matter} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
create(params?: Params$Resource$Matters$Create, options?: MethodOptions): GaxiosPromise<Schema$Matter>;
create(params: Params$Resource$Matters$Create, options: MethodOptions | BodyResponseCallback<Schema$Matter>, callback: BodyResponseCallback<Schema$Matter>): void;
create(params: Params$Resource$Matters$Create, callback: BodyResponseCallback<Schema$Matter>): void;
create(callback: BodyResponseCallback<Schema$Matter>): void;
/**
* vault.matters.delete
* @desc Deletes the specified matter. Returns matter with updated state.
* @alias vault.matters.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.matterId The matter ID
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: Params$Resource$Matters$Delete, options?: MethodOptions): GaxiosPromise<Schema$Matter>;
delete(params: Params$Resource$Matters$Delete, options: MethodOptions | BodyResponseCallback<Schema$Matter>, callback: BodyResponseCallback<Schema$Matter>): void;
delete(params: Params$Resource$Matters$Delete, callback: BodyResponseCallback<Schema$Matter>): void;
delete(callback: BodyResponseCallback<Schema$Matter>): void;
/**
* vault.matters.get
* @desc Gets the specified matter.
* @alias vault.matters.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.matterId The matter ID.
* @param {string=} params.view Specifies which parts of the Matter to return in the response.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Matters$Get, options?: MethodOptions): GaxiosPromise<Schema$Matter>;
get(params: Params$Resource$Matters$Get, options: MethodOptions | BodyResponseCallback<Schema$Matter>, callback: BodyResponseCallback<Schema$Matter>): void;
get(params: Params$Resource$Matters$Get, callback: BodyResponseCallback<Schema$Matter>): void;
get(callback: BodyResponseCallback<Schema$Matter>): void;
/**
* vault.matters.list
* @desc Lists matters the user has access to.
* @alias vault.matters.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer=} params.pageSize The number of matters to return in the response. Default and maximum are 100.
* @param {string=} params.pageToken The pagination token as returned in the response.
* @param {string=} params.state If set, list only matters with that specific state. The default is listing matters of all states.
* @param {string=} params.view Specifies which parts of the matter to return in response.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Matters$List, options?: MethodOptions): GaxiosPromise<Schema$ListMattersResponse>;
list(params: Params$Resource$Matters$List, options: MethodOptions | BodyResponseCallback<Schema$ListMattersResponse>, callback: BodyResponseCallback<Schema$ListMattersResponse>): void;
list(params: Params$Resource$Matters$List, callback: BodyResponseCallback<Schema$ListMattersResponse>): void;
list(callback: BodyResponseCallback<Schema$ListMattersResponse>): void;
/**
* vault.matters.removePermissions
* @desc Removes an account as a matter collaborator.
* @alias vault.matters.removePermissions
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.matterId The matter ID.
* @param {().RemoveMatterPermissionsRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
removePermissions(params?: Params$Resource$Matters$Removepermissions, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
removePermissions(params: Params$Resource$Matters$Removepermissions, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
removePermissions(params: Params$Resource$Matters$Removepermissions, callback: BodyResponseCallback<Schema$Empty>): void;
removePermissions(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* vault.matters.reopen
* @desc Reopens the specified matter. Returns matter with updated state.
* @alias vault.matters.reopen
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.matterId The matter ID.
* @param {().ReopenMatterRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
reopen(params?: Params$Resource$Matters$Reopen, options?: MethodOptions): GaxiosPromise<Schema$ReopenMatterResponse>;
reopen(params: Params$Resource$Matters$Reopen, options: MethodOptions | BodyResponseCallback<Schema$ReopenMatterResponse>, callback: BodyResponseCallback<Schema$ReopenMatterResponse>): void;
reopen(params: Params$Resource$Matters$Reopen, callback: BodyResponseCallback<Schema$ReopenMatterResponse>): void;
reopen(callback: BodyResponseCallback<Schema$ReopenMatterResponse>): void;
/**
* vault.matters.undelete
* @desc Undeletes the specified matter. Returns matter with updated state.
* @alias vault.matters.undelete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.matterId The matter ID.
* @param {().UndeleteMatterRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
undelete(params?: Params$Resource$Matters$Undelete, options?: MethodOptions): GaxiosPromise<Schema$Matter>;
undelete(params: Params$Resource$Matters$Undelete, options: MethodOptions | BodyResponseCallback<Schema$Matter>, callback: BodyResponseCallback<Schema$Matter>): void;
undelete(params: Params$Resource$Matters$Undelete, callback: BodyResponseCallback<Schema$Matter>): void;
undelete(callback: BodyResponseCallback<Schema$Matter>): void;
/**
* vault.matters.update
* @desc Updates the specified matter. This updates only the name and description of the matter, identified by matter id. Changes to any other fields are ignored. Returns the default view of the matter.
* @alias vault.matters.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.matterId The matter ID.
* @param {().Matter} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
update(params?: Params$Resource$Matters$Update, options?: MethodOptions): GaxiosPromise<Schema$Matter>;
update(params: Params$Resource$Matters$Update, options: MethodOptions | BodyResponseCallback<Schema$Matter>, callback: BodyResponseCallback<Schema$Matter>): void;
update(params: Params$Resource$Matters$Update, callback: BodyResponseCallback<Schema$Matter>): void;
update(callback: BodyResponseCallback<Schema$Matter>): void;
}
export interface Params$Resource$Matters$Addpermissions extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The matter ID.
*/
matterId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$AddMatterPermissionsRequest;
}
export interface Params$Resource$Matters$Close extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The matter ID.
*/
matterId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$CloseMatterRequest;
}
export interface Params$Resource$Matters$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Request body metadata
*/
requestBody?: Schema$Matter;
}
export interface Params$Resource$Matters$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The matter ID
*/
matterId?: string;
}
export interface Params$Resource$Matters$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The matter ID.
*/
matterId?: string;
/**
* Specifies which parts of the Matter to return in the response.
*/
view?: string;
}
export interface Params$Resource$Matters$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The number of matters to return in the response. Default and maximum are 100.
*/
pageSize?: number;
/**
* The pagination token as returned in the response.
*/
pageToken?: string;
/**
* If set, list only matters with that specific state. The default is listing matters of all states.
*/
state?: string;
/**
* Specifies which parts of the matter to return in response.
*/
view?: string;
}
export interface Params$Resource$Matters$Removepermissions extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The matter ID.
*/
matterId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$RemoveMatterPermissionsRequest;
}
export interface Params$Resource$Matters$Reopen extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The matter ID.
*/
matterId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$ReopenMatterRequest;
}
export interface Params$Resource$Matters$Undelete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The matter ID.
*/
matterId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$UndeleteMatterRequest;
}
export interface Params$Resource$Matters$Update extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The matter ID.
*/
matterId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Matter;
}
export class Resource$Matters$Exports {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* vault.matters.exports.create
* @desc Creates an Export.
* @alias vault.matters.exports.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.matterId The matter ID.
* @param {().Export} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
create(params?: Params$Resource$Matters$Exports$Create, options?: MethodOptions): GaxiosPromise<Schema$Export>;
create(params: Params$Resource$Matters$Exports$Create, options: MethodOptions | BodyResponseCallback<Schema$Export>, callback: BodyResponseCallback<Schema$Export>): void;
create(params: Params$Resource$Matters$Exports$Create, callback: BodyResponseCallback<Schema$Export>): void;
create(callback: BodyResponseCallback<Schema$Export>): void;
/**
* vault.matters.exports.delete
* @desc Deletes an Export.
* @alias vault.matters.exports.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.exportId The export ID.
* @param {string} params.matterId The matter ID.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: Params$Resource$Matters$Exports$Delete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
delete(params: Params$Resource$Matters$Exports$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
delete(params: Params$Resource$Matters$Exports$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
delete(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* vault.matters.exports.get
* @desc Gets an Export.
* @alias vault.matters.exports.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.exportId The export ID.
* @param {string} params.matterId The matter ID.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Matters$Exports$Get, options?: MethodOptions): GaxiosPromise<Schema$Export>;
get(params: Params$Resource$Matters$Exports$Get, options: MethodOptions | BodyResponseCallback<Schema$Export>, callback: BodyResponseCallback<Schema$Export>): void;
get(params: Params$Resource$Matters$Exports$Get, callback: BodyResponseCallback<Schema$Export>): void;
get(callback: BodyResponseCallback<Schema$Export>): void;
/**
* vault.matters.exports.list
* @desc Lists Exports.
* @alias vault.matters.exports.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.matterId The matter ID.
* @param {integer=} params.pageSize The number of exports to return in the response.
* @param {string=} params.pageToken The pagination token as returned in the response.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Matters$Exports$List, options?: MethodOptions): GaxiosPromise<Schema$ListExportsResponse>;
list(params: Params$Resource$Matters$Exports$List, options: MethodOptions | BodyResponseCallback<Schema$ListExportsResponse>, callback: BodyResponseCallback<Schema$ListExportsResponse>): void;
list(params: Params$Resource$Matters$Exports$List, callback: BodyResponseCallback<Schema$ListExportsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListExportsResponse>): void;
}
export interface Params$Resource$Matters$Exports$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The matter ID.
*/
matterId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Export;
}
export interface Params$Resource$Matters$Exports$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The export ID.
*/
exportId?: string;
/**
* The matter ID.
*/
matterId?: string;
}
export interface Params$Resource$Matters$Exports$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The export ID.
*/
exportId?: string;
/**
* The matter ID.
*/
matterId?: string;
}
export interface Params$Resource$Matters$Exports$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The matter ID.
*/
matterId?: string;
/**
* The number of exports to return in the response.
*/
pageSize?: number;
/**
* The pagination token as returned in the response.
*/
pageToken?: string;
}
export class Resource$Matters$Holds {
context: APIRequestContext;
accounts: Resource$Matters$Holds$Accounts;
constructor(context: APIRequestContext);
/**
* vault.matters.holds.addHeldAccounts
* @desc Adds HeldAccounts to a hold. Returns a list of accounts that have been successfully added. Accounts can only be added to an existing account-based hold.
* @alias vault.matters.holds.addHeldAccounts
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.holdId The hold ID.
* @param {string} params.matterId The matter ID.
* @param {().AddHeldAccountsRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
addHeldAccounts(params?: Params$Resource$Matters$Holds$Addheldaccounts, options?: MethodOptions): GaxiosPromise<Schema$AddHeldAccountsResponse>;
addHeldAccounts(params: Params$Resource$Matters$Holds$Addheldaccounts, options: MethodOptions | BodyResponseCallback<Schema$AddHeldAccountsResponse>, callback: BodyResponseCallback<Schema$AddHeldAccountsResponse>): void;
addHeldAccounts(params: Params$Resource$Matters$Holds$Addheldaccounts, callback: BodyResponseCallback<Schema$AddHeldAccountsResponse>): void;
addHeldAccounts(callback: BodyResponseCallback<Schema$AddHeldAccountsResponse>): void;
/**
* vault.matters.holds.create
* @desc Creates a hold in the given matter.
* @alias vault.matters.holds.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.matterId The matter ID.
* @param {().Hold} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
create(params?: Params$Resource$Matters$Holds$Create, options?: MethodOptions): GaxiosPromise<Schema$Hold>;
create(params: Params$Resource$Matters$Holds$Create, options: MethodOptions | BodyResponseCallback<Schema$Hold>, callback: BodyResponseCallback<Schema$Hold>): void;
create(params: Params$Resource$Matters$Holds$Create, callback: BodyResponseCallback<Schema$Hold>): void;
create(callback: BodyResponseCallback<Schema$Hold>): void;
/**
* vault.matters.holds.delete
* @desc Removes a hold by ID. This will release any HeldAccounts on this Hold.
* @alias vault.matters.holds.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.holdId The hold ID.
* @param {string} params.matterId The matter ID.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: Params$Resource$Matters$Holds$Delete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
delete(params: Params$Resource$Matters$Holds$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
delete(params: Params$Resource$Matters$Holds$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
delete(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* vault.matters.holds.get
* @desc Gets a hold by ID.
* @alias vault.matters.holds.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.holdId The hold ID.
* @param {string} params.matterId The matter ID.
* @param {string=} params.view Specifies which parts of the Hold to return.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Matters$Holds$Get, options?: MethodOptions): GaxiosPromise<Schema$Hold>;
get(params: Params$Resource$Matters$Holds$Get, options: MethodOptions | BodyResponseCallback<Schema$Hold>, callback: BodyResponseCallback<Schema$Hold>): void;
get(params: Params$Resource$Matters$Holds$Get, callback: BodyResponseCallback<Schema$Hold>): void;
get(callback: BodyResponseCallback<Schema$Hold>): void;
/**
* vault.matters.holds.list
* @desc Lists holds within a matter. An empty page token in ListHoldsResponse denotes no more holds to list.
* @alias vault.matters.holds.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.matterId The matter ID.
* @param {integer=} params.pageSize The number of holds to return in the response, between 0 and 100 inclusive. Leaving this empty, or as 0, is the same as page_size = 100.
* @param {string=} params.pageToken The pagination token as returned in the response. An empty token means start from the beginning.
* @param {string=} params.view Specifies which parts of the Hold to return.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Matters$Holds$List, options?: MethodOptions): GaxiosPromise<Schema$ListHoldsResponse>;
list(params: Params$Resource$Matters$Holds$List, options: MethodOptions | BodyResponseCallback<Schema$ListHoldsResponse>, callback: BodyResponseCallback<Schema$ListHoldsResponse>): void;
list(params: Params$Resource$Matters$Holds$List, callback: BodyResponseCallback<Schema$ListHoldsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListHoldsResponse>): void;
/**
* vault.matters.holds.removeHeldAccounts
* @desc Removes HeldAccounts from a hold. Returns a list of statuses in the same order as the request. If this request leaves the hold with no held accounts, the hold will not apply to any accounts.
* @alias vault.matters.holds.removeHeldAccounts
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.holdId The hold ID.
* @param {string} params.matterId The matter ID.
* @param {().RemoveHeldAccountsRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
removeHeldAccounts(params?: Params$Resource$Matters$Holds$Removeheldaccounts, options?: MethodOptions): GaxiosPromise<Schema$RemoveHeldAccountsResponse>;
removeHeldAccounts(params: Params$Resource$Matters$Holds$Removeheldaccounts, options: MethodOptions | BodyResponseCallback<Schema$RemoveHeldAccountsResponse>, callback: BodyResponseCallback<Schema$RemoveHeldAccountsResponse>): void;
removeHeldAccounts(params: Params$Resource$Matters$Holds$Removeheldaccounts, callback: BodyResponseCallback<Schema$RemoveHeldAccountsResponse>): void;
removeHeldAccounts(callback: BodyResponseCallback<Schema$RemoveHeldAccountsResponse>): void;
/**
* vault.matters.holds.update
* @desc Updates the OU and/or query parameters of a hold. You cannot add accounts to a hold that covers an OU, nor can you add OUs to a hold that covers individual accounts. Accounts listed in the hold will be ignored.
* @alias vault.matters.holds.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.holdId The ID of the hold.
* @param {string} params.matterId The matter ID.
* @param {().Hold} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
update(params?: Params$Resource$Matters$Holds$Update, options?: MethodOptions): GaxiosPromise<Schema$Hold>;
update(params: Params$Resource$Matters$Holds$Update, options: MethodOptions | BodyResponseCallback<Schema$Hold>, callback: BodyResponseCallback<Schema$Hold>): void;
update(params: Params$Resource$Matters$Holds$Update, callback: BodyResponseCallback<Schema$Hold>): void;
update(callback: BodyResponseCallback<Schema$Hold>): void;
}
export interface Params$Resource$Matters$Holds$Addheldaccounts extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The hold ID.
*/
holdId?: string;
/**
* The matter ID.
*/
matterId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$AddHeldAccountsRequest;
}
export interface Params$Resource$Matters$Holds$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The matter ID.
*/
matterId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Hold;
}
export interface Params$Resource$Matters$Holds$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The hold ID.
*/
holdId?: string;
/**
* The matter ID.
*/
matterId?: string;
}
export interface Params$Resource$Matters$Holds$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The hold ID.
*/
holdId?: string;
/**
* The matter ID.
*/
matterId?: string;
/**
* Specifies which parts of the Hold to return.
*/
view?: string;
}
export interface Params$Resource$Matters$Holds$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The matter ID.
*/
matterId?: string;
/**
* The number of holds to return in the response, between 0 and 100 inclusive. Leaving this empty, or as 0, is the same as page_size = 100.
*/
pageSize?: number;
/**
* The pagination token as returned in the response. An empty token means start from the beginning.
*/
pageToken?: string;
/**
* Specifies which parts of the Hold to return.
*/
view?: string;
}
export interface Params$Resource$Matters$Holds$Removeheldaccounts extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The hold ID.
*/
holdId?: string;
/**
* The matter ID.
*/
matterId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$RemoveHeldAccountsRequest;
}
export interface Params$Resource$Matters$Holds$Update extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the hold.
*/
holdId?: string;
/**
* The matter ID.
*/
matterId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Hold;
}
export class Resource$Matters$Holds$Accounts {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* vault.matters.holds.accounts.create
* @desc Adds a HeldAccount to a hold. Accounts can only be added to a hold that has no held_org_unit set. Attempting to add an account to an OU-based hold will result in an error.
* @alias vault.matters.holds.accounts.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.holdId The hold ID.
* @param {string} params.matterId The matter ID.
* @param {().HeldAccount} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
create(params?: Params$Resource$Matters$Holds$Accounts$Create, options?: MethodOptions): GaxiosPromise<Schema$HeldAccount>;
create(params: Params$Resource$Matters$Holds$Accounts$Create, options: MethodOptions | BodyResponseCallback<Schema$HeldAccount>, callback: BodyResponseCallback<Schema$HeldAccount>): void;
create(params: Params$Resource$Matters$Holds$Accounts$Create, callback: BodyResponseCallback<Schema$HeldAccount>): void;
create(callback: BodyResponseCallback<Schema$HeldAccount>): void;
/**
* vault.matters.holds.accounts.delete
* @desc Removes a HeldAccount from a hold. If this request leaves the hold with no held accounts, the hold will not apply to any accounts.
* @alias vault.matters.holds.accounts.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.accountId The ID of the account to remove from the hold.
* @param {string} params.holdId The hold ID.
* @param {string} params.matterId The matter ID.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: Params$Resource$Matters$Holds$Accounts$Delete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
delete(params: Params$Resource$Matters$Holds$Accounts$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
delete(params: Params$Resource$Matters$Holds$Accounts$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
delete(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* vault.matters.holds.accounts.list
* @desc Lists HeldAccounts for a hold. This will only list individually specified held accounts. If the hold is on an OU, then use <a href="https://developers.google.com/admin-sdk/">Admin SDK</a> to enumerate its members.
* @alias vault.matters.holds.accounts.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.holdId The hold ID.
* @param {string} params.matterId The matter ID.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Matters$Holds$Accounts$List, options?: MethodOptions): GaxiosPromise<Schema$ListHeldAccountsResponse>;
list(params: Params$Resource$Matters$Holds$Accounts$List, options: MethodOptions | BodyResponseCallback<Schema$ListHeldAccountsResponse>, callback: BodyResponseCallback<Schema$ListHeldAccountsResponse>): void;
list(params: Params$Resource$Matters$Holds$Accounts$List, callback: BodyResponseCallback<Schema$ListHeldAccountsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListHeldAccountsResponse>): void;
}
export interface Params$Resource$Matters$Holds$Accounts$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The hold ID.
*/
holdId?: string;
/**
* The matter ID.
*/
matterId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$HeldAccount;
}
export interface Params$Resource$Matters$Holds$Accounts$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the account to remove from the hold.
*/
accountId?: string;
/**
* The hold ID.
*/
holdId?: string;
/**
* The matter ID.
*/
matterId?: string;
}
export interface Params$Resource$Matters$Holds$Accounts$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The hold ID.
*/
holdId?: string;
/**
* The matter ID.
*/
matterId?: string;
}
export class Resource$Matters$Savedqueries {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* vault.matters.savedQueries.create
* @desc Creates a saved query.
* @alias vault.matters.savedQueries.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.matterId The matter id of the parent matter for which the saved query is to be created.
* @param {().SavedQuery} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
create(params?: Params$Resource$Matters$Savedqueries$Create, options?: MethodOptions): GaxiosPromise<Schema$SavedQuery>;
create(params: Params$Resource$Matters$Savedqueries$Create, options: MethodOptions | BodyResponseCallback<Schema$SavedQuery>, callback: BodyResponseCallback<Schema$SavedQuery>): void;
create(params: Params$Resource$Matters$Savedqueries$Create, callback: BodyResponseCallback<Schema$SavedQuery>): void;
create(callback: BodyResponseCallback<Schema$SavedQuery>): void;
/**
* vault.matters.savedQueries.delete
* @desc Deletes a saved query by Id.
* @alias vault.matters.savedQueries.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.matterId The matter id of the parent matter for which the saved query is to be deleted.
* @param {string} params.savedQueryId Id of the saved query to be deleted.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: Params$Resource$Matters$Savedqueries$Delete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
delete(params: Params$Resource$Matters$Savedqueries$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
delete(params: Params$Resource$Matters$Savedqueries$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
delete(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* vault.matters.savedQueries.get
* @desc Retrieves a saved query by Id.
* @alias vault.matters.savedQueries.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.matterId The matter id of the parent matter for which the saved query is to be retrieved.
* @param {string} params.savedQueryId Id of the saved query to be retrieved.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Matters$Savedqueries$Get, options?: MethodOptions): GaxiosPromise<Schema$SavedQuery>;
get(params: Params$Resource$Matters$Savedqueries$Get, options: MethodOptions | BodyResponseCallback<Schema$SavedQuery>, callback: BodyResponseCallback<Schema$SavedQuery>): void;
get(params: Params$Resource$Matters$Savedqueries$Get, callback: BodyResponseCallback<Schema$SavedQuery>): void;
get(callback: BodyResponseCallback<Schema$SavedQuery>): void;
/**
* vault.matters.savedQueries.list
* @desc Lists saved queries within a matter. An empty page token in ListSavedQueriesResponse denotes no more saved queries to list.
* @alias vault.matters.savedQueries.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.matterId The matter id of the parent matter for which the saved queries are to be retrieved.
* @param {integer=} params.pageSize The maximum number of saved queries to return.
* @param {string=} params.pageToken The pagination token as returned in the previous response. An empty token means start from the beginning.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Matters$Savedqueries$List, options?: MethodOptions): GaxiosPromise<Schema$ListSavedQueriesResponse>;
list(params: Params$Resource$Matters$Savedqueries$List, options: MethodOptions | BodyResponseCallback<Schema$ListSavedQueriesResponse>, callback: BodyResponseCallback<Schema$ListSavedQueriesResponse>): void;
list(params: Params$Resource$Matters$Savedqueries$List, callback: BodyResponseCallback<Schema$ListSavedQueriesResponse>): void;
list(callback: BodyResponseCallback<Schema$ListSavedQueriesResponse>): void;
}
export interface Params$Resource$Matters$Savedqueries$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The matter id of the parent matter for which the saved query is to be created.
*/
matterId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$SavedQuery;
}
export interface Params$Resource$Matters$Savedqueries$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The matter id of the parent matter for which the saved query is to be deleted.
*/
matterId?: string;
/**
* Id of the saved query to be deleted.
*/
savedQueryId?: string;
}
export interface Params$Resource$Matters$Savedqueries$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The matter id of the parent matter for which the saved query is to be retrieved.
*/
matterId?: string;
/**
* Id of the saved query to be retrieved.
*/
savedQueryId?: string;
}
export interface Params$Resource$Matters$Savedqueries$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The matter id of the parent matter for which the saved queries are to be retrieved.
*/
matterId?: string;
/**
* The maximum number of saved queries to return.
*/
pageSize?: number;
/**
* The pagination token as returned in the previous response. An empty token means start from the beginning.
*/
pageToken?: string;
}
export class Resource$Operations {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* vault.operations.delete
* @desc Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
* @alias vault.operations.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The name of the operation resource to be deleted.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: Params$Resource$Operations$Delete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
delete(params: Params$Resource$Operations$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
delete(params: Params$Resource$Operations$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
delete(callback: BodyResponseCallback<Schema$Empty>): void;
}
export interface Params$Resource$Operations$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of the operation resource to be deleted.
*/
name?: string;
}
export {};
}