@googleapis/vault 3.0.1 → 3.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/build/v1.d.ts CHANGED
@@ -797,7 +797,7 @@ export declare namespace vault_v1 {
797
797
  */
798
798
  name?: string | null;
799
799
  /**
800
- * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
800
+ * The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
801
801
  */
802
802
  response?: {
803
803
  [key: string]: any;
@@ -1045,59 +1045,6 @@ export declare namespace vault_v1 {
1045
1045
  constructor(context: APIRequestContext);
1046
1046
  /**
1047
1047
  * Adds an account as a matter collaborator.
1048
- * @example
1049
- * ```js
1050
- * // Before running the sample:
1051
- * // - Enable the API at:
1052
- * // https://console.developers.google.com/apis/api/vault.googleapis.com
1053
- * // - Login into gcloud by running:
1054
- * // `$ gcloud auth application-default login`
1055
- * // - Install the npm module by running:
1056
- * // `$ npm install googleapis`
1057
- *
1058
- * const {google} = require('googleapis');
1059
- * const vault = google.vault('v1');
1060
- *
1061
- * async function main() {
1062
- * const auth = new google.auth.GoogleAuth({
1063
- * // Scopes can be specified either as an array or as a single, space-delimited string.
1064
- * scopes: ['https://www.googleapis.com/auth/ediscovery'],
1065
- * });
1066
- *
1067
- * // Acquire an auth client, and bind it to all future calls
1068
- * const authClient = await auth.getClient();
1069
- * google.options({auth: authClient});
1070
- *
1071
- * // Do the magic
1072
- * const res = await vault.matters.addPermissions({
1073
- * // The matter ID.
1074
- * matterId: 'placeholder-value',
1075
- *
1076
- * // Request body metadata
1077
- * requestBody: {
1078
- * // request body parameters
1079
- * // {
1080
- * // "ccMe": false,
1081
- * // "matterPermission": {},
1082
- * // "sendEmails": false
1083
- * // }
1084
- * },
1085
- * });
1086
- * console.log(res.data);
1087
- *
1088
- * // Example response
1089
- * // {
1090
- * // "accountId": "my_accountId",
1091
- * // "role": "my_role"
1092
- * // }
1093
- * }
1094
- *
1095
- * main().catch(e => {
1096
- * console.error(e);
1097
- * throw e;
1098
- * });
1099
- *
1100
- * ```
1101
1048
  *
1102
1049
  * @param params - Parameters for request
1103
1050
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1112,54 +1059,6 @@ export declare namespace vault_v1 {
1112
1059
  addPermissions(callback: BodyResponseCallback<Schema$MatterPermission>): void;
1113
1060
  /**
1114
1061
  * Closes the specified matter. Returns the matter with updated state.
1115
- * @example
1116
- * ```js
1117
- * // Before running the sample:
1118
- * // - Enable the API at:
1119
- * // https://console.developers.google.com/apis/api/vault.googleapis.com
1120
- * // - Login into gcloud by running:
1121
- * // `$ gcloud auth application-default login`
1122
- * // - Install the npm module by running:
1123
- * // `$ npm install googleapis`
1124
- *
1125
- * const {google} = require('googleapis');
1126
- * const vault = google.vault('v1');
1127
- *
1128
- * async function main() {
1129
- * const auth = new google.auth.GoogleAuth({
1130
- * // Scopes can be specified either as an array or as a single, space-delimited string.
1131
- * scopes: ['https://www.googleapis.com/auth/ediscovery'],
1132
- * });
1133
- *
1134
- * // Acquire an auth client, and bind it to all future calls
1135
- * const authClient = await auth.getClient();
1136
- * google.options({auth: authClient});
1137
- *
1138
- * // Do the magic
1139
- * const res = await vault.matters.close({
1140
- * // The matter ID.
1141
- * matterId: 'placeholder-value',
1142
- *
1143
- * // Request body metadata
1144
- * requestBody: {
1145
- * // request body parameters
1146
- * // {}
1147
- * },
1148
- * });
1149
- * console.log(res.data);
1150
- *
1151
- * // Example response
1152
- * // {
1153
- * // "matter": {}
1154
- * // }
1155
- * }
1156
- *
1157
- * main().catch(e => {
1158
- * console.error(e);
1159
- * throw e;
1160
- * });
1161
- *
1162
- * ```
1163
1062
  *
1164
1063
  * @param params - Parameters for request
1165
1064
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1174,61 +1073,6 @@ export declare namespace vault_v1 {
1174
1073
  close(callback: BodyResponseCallback<Schema$CloseMatterResponse>): void;
1175
1074
  /**
1176
1075
  * Counts the accounts processed by the specified query.
1177
- * @example
1178
- * ```js
1179
- * // Before running the sample:
1180
- * // - Enable the API at:
1181
- * // https://console.developers.google.com/apis/api/vault.googleapis.com
1182
- * // - Login into gcloud by running:
1183
- * // `$ gcloud auth application-default login`
1184
- * // - Install the npm module by running:
1185
- * // `$ npm install googleapis`
1186
- *
1187
- * const {google} = require('googleapis');
1188
- * const vault = google.vault('v1');
1189
- *
1190
- * async function main() {
1191
- * const auth = new google.auth.GoogleAuth({
1192
- * // Scopes can be specified either as an array or as a single, space-delimited string.
1193
- * scopes: ['https://www.googleapis.com/auth/ediscovery'],
1194
- * });
1195
- *
1196
- * // Acquire an auth client, and bind it to all future calls
1197
- * const authClient = await auth.getClient();
1198
- * google.options({auth: authClient});
1199
- *
1200
- * // Do the magic
1201
- * const res = await vault.matters.count({
1202
- * // The matter ID.
1203
- * matterId: 'placeholder-value',
1204
- *
1205
- * // Request body metadata
1206
- * requestBody: {
1207
- * // request body parameters
1208
- * // {
1209
- * // "query": {},
1210
- * // "view": "my_view"
1211
- * // }
1212
- * },
1213
- * });
1214
- * console.log(res.data);
1215
- *
1216
- * // Example response
1217
- * // {
1218
- * // "done": false,
1219
- * // "error": {},
1220
- * // "metadata": {},
1221
- * // "name": "my_name",
1222
- * // "response": {}
1223
- * // }
1224
- * }
1225
- *
1226
- * main().catch(e => {
1227
- * console.error(e);
1228
- * throw e;
1229
- * });
1230
- *
1231
- * ```
1232
1076
  *
1233
1077
  * @param params - Parameters for request
1234
1078
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1243,61 +1087,6 @@ export declare namespace vault_v1 {
1243
1087
  count(callback: BodyResponseCallback<Schema$Operation>): void;
1244
1088
  /**
1245
1089
  * Creates a 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.
1246
- * @example
1247
- * ```js
1248
- * // Before running the sample:
1249
- * // - Enable the API at:
1250
- * // https://console.developers.google.com/apis/api/vault.googleapis.com
1251
- * // - Login into gcloud by running:
1252
- * // `$ gcloud auth application-default login`
1253
- * // - Install the npm module by running:
1254
- * // `$ npm install googleapis`
1255
- *
1256
- * const {google} = require('googleapis');
1257
- * const vault = google.vault('v1');
1258
- *
1259
- * async function main() {
1260
- * const auth = new google.auth.GoogleAuth({
1261
- * // Scopes can be specified either as an array or as a single, space-delimited string.
1262
- * scopes: ['https://www.googleapis.com/auth/ediscovery'],
1263
- * });
1264
- *
1265
- * // Acquire an auth client, and bind it to all future calls
1266
- * const authClient = await auth.getClient();
1267
- * google.options({auth: authClient});
1268
- *
1269
- * // Do the magic
1270
- * const res = await vault.matters.create({
1271
- * // Request body metadata
1272
- * requestBody: {
1273
- * // request body parameters
1274
- * // {
1275
- * // "description": "my_description",
1276
- * // "matterId": "my_matterId",
1277
- * // "matterPermissions": [],
1278
- * // "name": "my_name",
1279
- * // "state": "my_state"
1280
- * // }
1281
- * },
1282
- * });
1283
- * console.log(res.data);
1284
- *
1285
- * // Example response
1286
- * // {
1287
- * // "description": "my_description",
1288
- * // "matterId": "my_matterId",
1289
- * // "matterPermissions": [],
1290
- * // "name": "my_name",
1291
- * // "state": "my_state"
1292
- * // }
1293
- * }
1294
- *
1295
- * main().catch(e => {
1296
- * console.error(e);
1297
- * throw e;
1298
- * });
1299
- *
1300
- * ```
1301
1090
  *
1302
1091
  * @param params - Parameters for request
1303
1092
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1312,52 +1101,6 @@ export declare namespace vault_v1 {
1312
1101
  create(callback: BodyResponseCallback<Schema$Matter>): void;
1313
1102
  /**
1314
1103
  * Deletes the specified matter. Returns the matter with updated state.
1315
- * @example
1316
- * ```js
1317
- * // Before running the sample:
1318
- * // - Enable the API at:
1319
- * // https://console.developers.google.com/apis/api/vault.googleapis.com
1320
- * // - Login into gcloud by running:
1321
- * // `$ gcloud auth application-default login`
1322
- * // - Install the npm module by running:
1323
- * // `$ npm install googleapis`
1324
- *
1325
- * const {google} = require('googleapis');
1326
- * const vault = google.vault('v1');
1327
- *
1328
- * async function main() {
1329
- * const auth = new google.auth.GoogleAuth({
1330
- * // Scopes can be specified either as an array or as a single, space-delimited string.
1331
- * scopes: ['https://www.googleapis.com/auth/ediscovery'],
1332
- * });
1333
- *
1334
- * // Acquire an auth client, and bind it to all future calls
1335
- * const authClient = await auth.getClient();
1336
- * google.options({auth: authClient});
1337
- *
1338
- * // Do the magic
1339
- * const res = await vault.matters.delete({
1340
- * // The matter ID
1341
- * matterId: 'placeholder-value',
1342
- * });
1343
- * console.log(res.data);
1344
- *
1345
- * // Example response
1346
- * // {
1347
- * // "description": "my_description",
1348
- * // "matterId": "my_matterId",
1349
- * // "matterPermissions": [],
1350
- * // "name": "my_name",
1351
- * // "state": "my_state"
1352
- * // }
1353
- * }
1354
- *
1355
- * main().catch(e => {
1356
- * console.error(e);
1357
- * throw e;
1358
- * });
1359
- *
1360
- * ```
1361
1104
  *
1362
1105
  * @param params - Parameters for request
1363
1106
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1372,57 +1115,6 @@ export declare namespace vault_v1 {
1372
1115
  delete(callback: BodyResponseCallback<Schema$Matter>): void;
1373
1116
  /**
1374
1117
  * Gets the specified matter.
1375
- * @example
1376
- * ```js
1377
- * // Before running the sample:
1378
- * // - Enable the API at:
1379
- * // https://console.developers.google.com/apis/api/vault.googleapis.com
1380
- * // - Login into gcloud by running:
1381
- * // `$ gcloud auth application-default login`
1382
- * // - Install the npm module by running:
1383
- * // `$ npm install googleapis`
1384
- *
1385
- * const {google} = require('googleapis');
1386
- * const vault = google.vault('v1');
1387
- *
1388
- * async function main() {
1389
- * const auth = new google.auth.GoogleAuth({
1390
- * // Scopes can be specified either as an array or as a single, space-delimited string.
1391
- * scopes: [
1392
- * 'https://www.googleapis.com/auth/ediscovery',
1393
- * 'https://www.googleapis.com/auth/ediscovery.readonly',
1394
- * ],
1395
- * });
1396
- *
1397
- * // Acquire an auth client, and bind it to all future calls
1398
- * const authClient = await auth.getClient();
1399
- * google.options({auth: authClient});
1400
- *
1401
- * // Do the magic
1402
- * const res = await vault.matters.get({
1403
- * // The matter ID.
1404
- * matterId: 'placeholder-value',
1405
- * // Specifies how much information about the matter to return in the response.
1406
- * view: 'placeholder-value',
1407
- * });
1408
- * console.log(res.data);
1409
- *
1410
- * // Example response
1411
- * // {
1412
- * // "description": "my_description",
1413
- * // "matterId": "my_matterId",
1414
- * // "matterPermissions": [],
1415
- * // "name": "my_name",
1416
- * // "state": "my_state"
1417
- * // }
1418
- * }
1419
- *
1420
- * main().catch(e => {
1421
- * console.error(e);
1422
- * throw e;
1423
- * });
1424
- *
1425
- * ```
1426
1118
  *
1427
1119
  * @param params - Parameters for request
1428
1120
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1437,58 +1129,6 @@ export declare namespace vault_v1 {
1437
1129
  get(callback: BodyResponseCallback<Schema$Matter>): void;
1438
1130
  /**
1439
1131
  * Lists matters the requestor has access to.
1440
- * @example
1441
- * ```js
1442
- * // Before running the sample:
1443
- * // - Enable the API at:
1444
- * // https://console.developers.google.com/apis/api/vault.googleapis.com
1445
- * // - Login into gcloud by running:
1446
- * // `$ gcloud auth application-default login`
1447
- * // - Install the npm module by running:
1448
- * // `$ npm install googleapis`
1449
- *
1450
- * const {google} = require('googleapis');
1451
- * const vault = google.vault('v1');
1452
- *
1453
- * async function main() {
1454
- * const auth = new google.auth.GoogleAuth({
1455
- * // Scopes can be specified either as an array or as a single, space-delimited string.
1456
- * scopes: [
1457
- * 'https://www.googleapis.com/auth/ediscovery',
1458
- * 'https://www.googleapis.com/auth/ediscovery.readonly',
1459
- * ],
1460
- * });
1461
- *
1462
- * // Acquire an auth client, and bind it to all future calls
1463
- * const authClient = await auth.getClient();
1464
- * google.options({auth: authClient});
1465
- *
1466
- * // Do the magic
1467
- * const res = await vault.matters.list({
1468
- * // The number of matters to return in the response. Default and maximum are 100.
1469
- * pageSize: 'placeholder-value',
1470
- * // The pagination token as returned in the response.
1471
- * pageToken: 'placeholder-value',
1472
- * // If set, lists only matters with the specified state. The default lists matters of all states.
1473
- * state: 'placeholder-value',
1474
- * // Specifies how much information about the matter to return in response.
1475
- * view: 'placeholder-value',
1476
- * });
1477
- * console.log(res.data);
1478
- *
1479
- * // Example response
1480
- * // {
1481
- * // "matters": [],
1482
- * // "nextPageToken": "my_nextPageToken"
1483
- * // }
1484
- * }
1485
- *
1486
- * main().catch(e => {
1487
- * console.error(e);
1488
- * throw e;
1489
- * });
1490
- *
1491
- * ```
1492
1132
  *
1493
1133
  * @param params - Parameters for request
1494
1134
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1503,54 +1143,6 @@ export declare namespace vault_v1 {
1503
1143
  list(callback: BodyResponseCallback<Schema$ListMattersResponse>): void;
1504
1144
  /**
1505
1145
  * Removes an account as a matter collaborator.
1506
- * @example
1507
- * ```js
1508
- * // Before running the sample:
1509
- * // - Enable the API at:
1510
- * // https://console.developers.google.com/apis/api/vault.googleapis.com
1511
- * // - Login into gcloud by running:
1512
- * // `$ gcloud auth application-default login`
1513
- * // - Install the npm module by running:
1514
- * // `$ npm install googleapis`
1515
- *
1516
- * const {google} = require('googleapis');
1517
- * const vault = google.vault('v1');
1518
- *
1519
- * async function main() {
1520
- * const auth = new google.auth.GoogleAuth({
1521
- * // Scopes can be specified either as an array or as a single, space-delimited string.
1522
- * scopes: ['https://www.googleapis.com/auth/ediscovery'],
1523
- * });
1524
- *
1525
- * // Acquire an auth client, and bind it to all future calls
1526
- * const authClient = await auth.getClient();
1527
- * google.options({auth: authClient});
1528
- *
1529
- * // Do the magic
1530
- * const res = await vault.matters.removePermissions({
1531
- * // The matter ID.
1532
- * matterId: 'placeholder-value',
1533
- *
1534
- * // Request body metadata
1535
- * requestBody: {
1536
- * // request body parameters
1537
- * // {
1538
- * // "accountId": "my_accountId"
1539
- * // }
1540
- * },
1541
- * });
1542
- * console.log(res.data);
1543
- *
1544
- * // Example response
1545
- * // {}
1546
- * }
1547
- *
1548
- * main().catch(e => {
1549
- * console.error(e);
1550
- * throw e;
1551
- * });
1552
- *
1553
- * ```
1554
1146
  *
1555
1147
  * @param params - Parameters for request
1556
1148
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1565,54 +1157,6 @@ export declare namespace vault_v1 {
1565
1157
  removePermissions(callback: BodyResponseCallback<Schema$Empty>): void;
1566
1158
  /**
1567
1159
  * Reopens the specified matter. Returns the matter with updated state.
1568
- * @example
1569
- * ```js
1570
- * // Before running the sample:
1571
- * // - Enable the API at:
1572
- * // https://console.developers.google.com/apis/api/vault.googleapis.com
1573
- * // - Login into gcloud by running:
1574
- * // `$ gcloud auth application-default login`
1575
- * // - Install the npm module by running:
1576
- * // `$ npm install googleapis`
1577
- *
1578
- * const {google} = require('googleapis');
1579
- * const vault = google.vault('v1');
1580
- *
1581
- * async function main() {
1582
- * const auth = new google.auth.GoogleAuth({
1583
- * // Scopes can be specified either as an array or as a single, space-delimited string.
1584
- * scopes: ['https://www.googleapis.com/auth/ediscovery'],
1585
- * });
1586
- *
1587
- * // Acquire an auth client, and bind it to all future calls
1588
- * const authClient = await auth.getClient();
1589
- * google.options({auth: authClient});
1590
- *
1591
- * // Do the magic
1592
- * const res = await vault.matters.reopen({
1593
- * // The matter ID.
1594
- * matterId: 'placeholder-value',
1595
- *
1596
- * // Request body metadata
1597
- * requestBody: {
1598
- * // request body parameters
1599
- * // {}
1600
- * },
1601
- * });
1602
- * console.log(res.data);
1603
- *
1604
- * // Example response
1605
- * // {
1606
- * // "matter": {}
1607
- * // }
1608
- * }
1609
- *
1610
- * main().catch(e => {
1611
- * console.error(e);
1612
- * throw e;
1613
- * });
1614
- *
1615
- * ```
1616
1160
  *
1617
1161
  * @param params - Parameters for request
1618
1162
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1627,58 +1171,6 @@ export declare namespace vault_v1 {
1627
1171
  reopen(callback: BodyResponseCallback<Schema$ReopenMatterResponse>): void;
1628
1172
  /**
1629
1173
  * Undeletes the specified matter. Returns the matter with updated state.
1630
- * @example
1631
- * ```js
1632
- * // Before running the sample:
1633
- * // - Enable the API at:
1634
- * // https://console.developers.google.com/apis/api/vault.googleapis.com
1635
- * // - Login into gcloud by running:
1636
- * // `$ gcloud auth application-default login`
1637
- * // - Install the npm module by running:
1638
- * // `$ npm install googleapis`
1639
- *
1640
- * const {google} = require('googleapis');
1641
- * const vault = google.vault('v1');
1642
- *
1643
- * async function main() {
1644
- * const auth = new google.auth.GoogleAuth({
1645
- * // Scopes can be specified either as an array or as a single, space-delimited string.
1646
- * scopes: ['https://www.googleapis.com/auth/ediscovery'],
1647
- * });
1648
- *
1649
- * // Acquire an auth client, and bind it to all future calls
1650
- * const authClient = await auth.getClient();
1651
- * google.options({auth: authClient});
1652
- *
1653
- * // Do the magic
1654
- * const res = await vault.matters.undelete({
1655
- * // The matter ID.
1656
- * matterId: 'placeholder-value',
1657
- *
1658
- * // Request body metadata
1659
- * requestBody: {
1660
- * // request body parameters
1661
- * // {}
1662
- * },
1663
- * });
1664
- * console.log(res.data);
1665
- *
1666
- * // Example response
1667
- * // {
1668
- * // "description": "my_description",
1669
- * // "matterId": "my_matterId",
1670
- * // "matterPermissions": [],
1671
- * // "name": "my_name",
1672
- * // "state": "my_state"
1673
- * // }
1674
- * }
1675
- *
1676
- * main().catch(e => {
1677
- * console.error(e);
1678
- * throw e;
1679
- * });
1680
- *
1681
- * ```
1682
1174
  *
1683
1175
  * @param params - Parameters for request
1684
1176
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1693,64 +1185,6 @@ export declare namespace vault_v1 {
1693
1185
  undelete(callback: BodyResponseCallback<Schema$Matter>): void;
1694
1186
  /**
1695
1187
  * 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.
1696
- * @example
1697
- * ```js
1698
- * // Before running the sample:
1699
- * // - Enable the API at:
1700
- * // https://console.developers.google.com/apis/api/vault.googleapis.com
1701
- * // - Login into gcloud by running:
1702
- * // `$ gcloud auth application-default login`
1703
- * // - Install the npm module by running:
1704
- * // `$ npm install googleapis`
1705
- *
1706
- * const {google} = require('googleapis');
1707
- * const vault = google.vault('v1');
1708
- *
1709
- * async function main() {
1710
- * const auth = new google.auth.GoogleAuth({
1711
- * // Scopes can be specified either as an array or as a single, space-delimited string.
1712
- * scopes: ['https://www.googleapis.com/auth/ediscovery'],
1713
- * });
1714
- *
1715
- * // Acquire an auth client, and bind it to all future calls
1716
- * const authClient = await auth.getClient();
1717
- * google.options({auth: authClient});
1718
- *
1719
- * // Do the magic
1720
- * const res = await vault.matters.update({
1721
- * // The matter ID.
1722
- * matterId: 'placeholder-value',
1723
- *
1724
- * // Request body metadata
1725
- * requestBody: {
1726
- * // request body parameters
1727
- * // {
1728
- * // "description": "my_description",
1729
- * // "matterId": "my_matterId",
1730
- * // "matterPermissions": [],
1731
- * // "name": "my_name",
1732
- * // "state": "my_state"
1733
- * // }
1734
- * },
1735
- * });
1736
- * console.log(res.data);
1737
- *
1738
- * // Example response
1739
- * // {
1740
- * // "description": "my_description",
1741
- * // "matterId": "my_matterId",
1742
- * // "matterPermissions": [],
1743
- * // "name": "my_name",
1744
- * // "state": "my_state"
1745
- * // }
1746
- * }
1747
- *
1748
- * main().catch(e => {
1749
- * console.error(e);
1750
- * throw e;
1751
- * });
1752
- *
1753
- * ```
1754
1188
  *
1755
1189
  * @param params - Parameters for request
1756
1190
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1879,74 +1313,6 @@ export declare namespace vault_v1 {
1879
1313
  constructor(context: APIRequestContext);
1880
1314
  /**
1881
1315
  * Creates an export.
1882
- * @example
1883
- * ```js
1884
- * // Before running the sample:
1885
- * // - Enable the API at:
1886
- * // https://console.developers.google.com/apis/api/vault.googleapis.com
1887
- * // - Login into gcloud by running:
1888
- * // `$ gcloud auth application-default login`
1889
- * // - Install the npm module by running:
1890
- * // `$ npm install googleapis`
1891
- *
1892
- * const {google} = require('googleapis');
1893
- * const vault = google.vault('v1');
1894
- *
1895
- * async function main() {
1896
- * const auth = new google.auth.GoogleAuth({
1897
- * // Scopes can be specified either as an array or as a single, space-delimited string.
1898
- * scopes: ['https://www.googleapis.com/auth/ediscovery'],
1899
- * });
1900
- *
1901
- * // Acquire an auth client, and bind it to all future calls
1902
- * const authClient = await auth.getClient();
1903
- * google.options({auth: authClient});
1904
- *
1905
- * // Do the magic
1906
- * const res = await vault.matters.exports.create({
1907
- * // The matter ID.
1908
- * matterId: 'placeholder-value',
1909
- *
1910
- * // Request body metadata
1911
- * requestBody: {
1912
- * // request body parameters
1913
- * // {
1914
- * // "cloudStorageSink": {},
1915
- * // "createTime": "my_createTime",
1916
- * // "exportOptions": {},
1917
- * // "id": "my_id",
1918
- * // "matterId": "my_matterId",
1919
- * // "name": "my_name",
1920
- * // "query": {},
1921
- * // "requester": {},
1922
- * // "stats": {},
1923
- * // "status": "my_status"
1924
- * // }
1925
- * },
1926
- * });
1927
- * console.log(res.data);
1928
- *
1929
- * // Example response
1930
- * // {
1931
- * // "cloudStorageSink": {},
1932
- * // "createTime": "my_createTime",
1933
- * // "exportOptions": {},
1934
- * // "id": "my_id",
1935
- * // "matterId": "my_matterId",
1936
- * // "name": "my_name",
1937
- * // "query": {},
1938
- * // "requester": {},
1939
- * // "stats": {},
1940
- * // "status": "my_status"
1941
- * // }
1942
- * }
1943
- *
1944
- * main().catch(e => {
1945
- * console.error(e);
1946
- * throw e;
1947
- * });
1948
- *
1949
- * ```
1950
1316
  *
1951
1317
  * @param params - Parameters for request
1952
1318
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1961,48 +1327,6 @@ export declare namespace vault_v1 {
1961
1327
  create(callback: BodyResponseCallback<Schema$Export>): void;
1962
1328
  /**
1963
1329
  * Deletes an export.
1964
- * @example
1965
- * ```js
1966
- * // Before running the sample:
1967
- * // - Enable the API at:
1968
- * // https://console.developers.google.com/apis/api/vault.googleapis.com
1969
- * // - Login into gcloud by running:
1970
- * // `$ gcloud auth application-default login`
1971
- * // - Install the npm module by running:
1972
- * // `$ npm install googleapis`
1973
- *
1974
- * const {google} = require('googleapis');
1975
- * const vault = google.vault('v1');
1976
- *
1977
- * async function main() {
1978
- * const auth = new google.auth.GoogleAuth({
1979
- * // Scopes can be specified either as an array or as a single, space-delimited string.
1980
- * scopes: ['https://www.googleapis.com/auth/ediscovery'],
1981
- * });
1982
- *
1983
- * // Acquire an auth client, and bind it to all future calls
1984
- * const authClient = await auth.getClient();
1985
- * google.options({auth: authClient});
1986
- *
1987
- * // Do the magic
1988
- * const res = await vault.matters.exports.delete({
1989
- * // The export ID.
1990
- * exportId: 'placeholder-value',
1991
- * // The matter ID.
1992
- * matterId: 'placeholder-value',
1993
- * });
1994
- * console.log(res.data);
1995
- *
1996
- * // Example response
1997
- * // {}
1998
- * }
1999
- *
2000
- * main().catch(e => {
2001
- * console.error(e);
2002
- * throw e;
2003
- * });
2004
- *
2005
- * ```
2006
1330
  *
2007
1331
  * @param params - Parameters for request
2008
1332
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2017,62 +1341,6 @@ export declare namespace vault_v1 {
2017
1341
  delete(callback: BodyResponseCallback<Schema$Empty>): void;
2018
1342
  /**
2019
1343
  * Gets an export.
2020
- * @example
2021
- * ```js
2022
- * // Before running the sample:
2023
- * // - Enable the API at:
2024
- * // https://console.developers.google.com/apis/api/vault.googleapis.com
2025
- * // - Login into gcloud by running:
2026
- * // `$ gcloud auth application-default login`
2027
- * // - Install the npm module by running:
2028
- * // `$ npm install googleapis`
2029
- *
2030
- * const {google} = require('googleapis');
2031
- * const vault = google.vault('v1');
2032
- *
2033
- * async function main() {
2034
- * const auth = new google.auth.GoogleAuth({
2035
- * // Scopes can be specified either as an array or as a single, space-delimited string.
2036
- * scopes: [
2037
- * 'https://www.googleapis.com/auth/ediscovery',
2038
- * 'https://www.googleapis.com/auth/ediscovery.readonly',
2039
- * ],
2040
- * });
2041
- *
2042
- * // Acquire an auth client, and bind it to all future calls
2043
- * const authClient = await auth.getClient();
2044
- * google.options({auth: authClient});
2045
- *
2046
- * // Do the magic
2047
- * const res = await vault.matters.exports.get({
2048
- * // The export ID.
2049
- * exportId: 'placeholder-value',
2050
- * // The matter ID.
2051
- * matterId: 'placeholder-value',
2052
- * });
2053
- * console.log(res.data);
2054
- *
2055
- * // Example response
2056
- * // {
2057
- * // "cloudStorageSink": {},
2058
- * // "createTime": "my_createTime",
2059
- * // "exportOptions": {},
2060
- * // "id": "my_id",
2061
- * // "matterId": "my_matterId",
2062
- * // "name": "my_name",
2063
- * // "query": {},
2064
- * // "requester": {},
2065
- * // "stats": {},
2066
- * // "status": "my_status"
2067
- * // }
2068
- * }
2069
- *
2070
- * main().catch(e => {
2071
- * console.error(e);
2072
- * throw e;
2073
- * });
2074
- *
2075
- * ```
2076
1344
  *
2077
1345
  * @param params - Parameters for request
2078
1346
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2087,56 +1355,6 @@ export declare namespace vault_v1 {
2087
1355
  get(callback: BodyResponseCallback<Schema$Export>): void;
2088
1356
  /**
2089
1357
  * Lists details about the exports in the specified matter.
2090
- * @example
2091
- * ```js
2092
- * // Before running the sample:
2093
- * // - Enable the API at:
2094
- * // https://console.developers.google.com/apis/api/vault.googleapis.com
2095
- * // - Login into gcloud by running:
2096
- * // `$ gcloud auth application-default login`
2097
- * // - Install the npm module by running:
2098
- * // `$ npm install googleapis`
2099
- *
2100
- * const {google} = require('googleapis');
2101
- * const vault = google.vault('v1');
2102
- *
2103
- * async function main() {
2104
- * const auth = new google.auth.GoogleAuth({
2105
- * // Scopes can be specified either as an array or as a single, space-delimited string.
2106
- * scopes: [
2107
- * 'https://www.googleapis.com/auth/ediscovery',
2108
- * 'https://www.googleapis.com/auth/ediscovery.readonly',
2109
- * ],
2110
- * });
2111
- *
2112
- * // Acquire an auth client, and bind it to all future calls
2113
- * const authClient = await auth.getClient();
2114
- * google.options({auth: authClient});
2115
- *
2116
- * // Do the magic
2117
- * const res = await vault.matters.exports.list({
2118
- * // The matter ID.
2119
- * matterId: 'placeholder-value',
2120
- * // The number of exports to return in the response.
2121
- * pageSize: 'placeholder-value',
2122
- * // The pagination token as returned in the response.
2123
- * pageToken: 'placeholder-value',
2124
- * });
2125
- * console.log(res.data);
2126
- *
2127
- * // Example response
2128
- * // {
2129
- * // "exports": [],
2130
- * // "nextPageToken": "my_nextPageToken"
2131
- * // }
2132
- * }
2133
- *
2134
- * main().catch(e => {
2135
- * console.error(e);
2136
- * throw e;
2137
- * });
2138
- *
2139
- * ```
2140
1358
  *
2141
1359
  * @param params - Parameters for request
2142
1360
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2200,59 +1418,6 @@ export declare namespace vault_v1 {
2200
1418
  constructor(context: APIRequestContext);
2201
1419
  /**
2202
1420
  * Adds accounts to a hold. Returns a list of accounts that have been successfully added. Accounts can be added only to an existing account-based hold.
2203
- * @example
2204
- * ```js
2205
- * // Before running the sample:
2206
- * // - Enable the API at:
2207
- * // https://console.developers.google.com/apis/api/vault.googleapis.com
2208
- * // - Login into gcloud by running:
2209
- * // `$ gcloud auth application-default login`
2210
- * // - Install the npm module by running:
2211
- * // `$ npm install googleapis`
2212
- *
2213
- * const {google} = require('googleapis');
2214
- * const vault = google.vault('v1');
2215
- *
2216
- * async function main() {
2217
- * const auth = new google.auth.GoogleAuth({
2218
- * // Scopes can be specified either as an array or as a single, space-delimited string.
2219
- * scopes: ['https://www.googleapis.com/auth/ediscovery'],
2220
- * });
2221
- *
2222
- * // Acquire an auth client, and bind it to all future calls
2223
- * const authClient = await auth.getClient();
2224
- * google.options({auth: authClient});
2225
- *
2226
- * // Do the magic
2227
- * const res = await vault.matters.holds.addHeldAccounts({
2228
- * // The hold ID.
2229
- * holdId: 'placeholder-value',
2230
- * // The matter ID.
2231
- * matterId: 'placeholder-value',
2232
- *
2233
- * // Request body metadata
2234
- * requestBody: {
2235
- * // request body parameters
2236
- * // {
2237
- * // "accountIds": [],
2238
- * // "emails": []
2239
- * // }
2240
- * },
2241
- * });
2242
- * console.log(res.data);
2243
- *
2244
- * // Example response
2245
- * // {
2246
- * // "responses": []
2247
- * // }
2248
- * }
2249
- *
2250
- * main().catch(e => {
2251
- * console.error(e);
2252
- * throw e;
2253
- * });
2254
- *
2255
- * ```
2256
1421
  *
2257
1422
  * @param params - Parameters for request
2258
1423
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2267,68 +1432,6 @@ export declare namespace vault_v1 {
2267
1432
  addHeldAccounts(callback: BodyResponseCallback<Schema$AddHeldAccountsResponse>): void;
2268
1433
  /**
2269
1434
  * Creates a hold in the specified matter.
2270
- * @example
2271
- * ```js
2272
- * // Before running the sample:
2273
- * // - Enable the API at:
2274
- * // https://console.developers.google.com/apis/api/vault.googleapis.com
2275
- * // - Login into gcloud by running:
2276
- * // `$ gcloud auth application-default login`
2277
- * // - Install the npm module by running:
2278
- * // `$ npm install googleapis`
2279
- *
2280
- * const {google} = require('googleapis');
2281
- * const vault = google.vault('v1');
2282
- *
2283
- * async function main() {
2284
- * const auth = new google.auth.GoogleAuth({
2285
- * // Scopes can be specified either as an array or as a single, space-delimited string.
2286
- * scopes: ['https://www.googleapis.com/auth/ediscovery'],
2287
- * });
2288
- *
2289
- * // Acquire an auth client, and bind it to all future calls
2290
- * const authClient = await auth.getClient();
2291
- * google.options({auth: authClient});
2292
- *
2293
- * // Do the magic
2294
- * const res = await vault.matters.holds.create({
2295
- * // The matter ID.
2296
- * matterId: 'placeholder-value',
2297
- *
2298
- * // Request body metadata
2299
- * requestBody: {
2300
- * // request body parameters
2301
- * // {
2302
- * // "accounts": [],
2303
- * // "corpus": "my_corpus",
2304
- * // "holdId": "my_holdId",
2305
- * // "name": "my_name",
2306
- * // "orgUnit": {},
2307
- * // "query": {},
2308
- * // "updateTime": "my_updateTime"
2309
- * // }
2310
- * },
2311
- * });
2312
- * console.log(res.data);
2313
- *
2314
- * // Example response
2315
- * // {
2316
- * // "accounts": [],
2317
- * // "corpus": "my_corpus",
2318
- * // "holdId": "my_holdId",
2319
- * // "name": "my_name",
2320
- * // "orgUnit": {},
2321
- * // "query": {},
2322
- * // "updateTime": "my_updateTime"
2323
- * // }
2324
- * }
2325
- *
2326
- * main().catch(e => {
2327
- * console.error(e);
2328
- * throw e;
2329
- * });
2330
- *
2331
- * ```
2332
1435
  *
2333
1436
  * @param params - Parameters for request
2334
1437
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2343,48 +1446,6 @@ export declare namespace vault_v1 {
2343
1446
  create(callback: BodyResponseCallback<Schema$Hold>): void;
2344
1447
  /**
2345
1448
  * Removes the specified hold and releases the accounts or organizational unit covered by the hold. If the data is not preserved by another hold or retention rule, it might be purged.
2346
- * @example
2347
- * ```js
2348
- * // Before running the sample:
2349
- * // - Enable the API at:
2350
- * // https://console.developers.google.com/apis/api/vault.googleapis.com
2351
- * // - Login into gcloud by running:
2352
- * // `$ gcloud auth application-default login`
2353
- * // - Install the npm module by running:
2354
- * // `$ npm install googleapis`
2355
- *
2356
- * const {google} = require('googleapis');
2357
- * const vault = google.vault('v1');
2358
- *
2359
- * async function main() {
2360
- * const auth = new google.auth.GoogleAuth({
2361
- * // Scopes can be specified either as an array or as a single, space-delimited string.
2362
- * scopes: ['https://www.googleapis.com/auth/ediscovery'],
2363
- * });
2364
- *
2365
- * // Acquire an auth client, and bind it to all future calls
2366
- * const authClient = await auth.getClient();
2367
- * google.options({auth: authClient});
2368
- *
2369
- * // Do the magic
2370
- * const res = await vault.matters.holds.delete({
2371
- * // The hold ID.
2372
- * holdId: 'placeholder-value',
2373
- * // The matter ID.
2374
- * matterId: 'placeholder-value',
2375
- * });
2376
- * console.log(res.data);
2377
- *
2378
- * // Example response
2379
- * // {}
2380
- * }
2381
- *
2382
- * main().catch(e => {
2383
- * console.error(e);
2384
- * throw e;
2385
- * });
2386
- *
2387
- * ```
2388
1449
  *
2389
1450
  * @param params - Parameters for request
2390
1451
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2399,61 +1460,6 @@ export declare namespace vault_v1 {
2399
1460
  delete(callback: BodyResponseCallback<Schema$Empty>): void;
2400
1461
  /**
2401
1462
  * Gets the specified hold.
2402
- * @example
2403
- * ```js
2404
- * // Before running the sample:
2405
- * // - Enable the API at:
2406
- * // https://console.developers.google.com/apis/api/vault.googleapis.com
2407
- * // - Login into gcloud by running:
2408
- * // `$ gcloud auth application-default login`
2409
- * // - Install the npm module by running:
2410
- * // `$ npm install googleapis`
2411
- *
2412
- * const {google} = require('googleapis');
2413
- * const vault = google.vault('v1');
2414
- *
2415
- * async function main() {
2416
- * const auth = new google.auth.GoogleAuth({
2417
- * // Scopes can be specified either as an array or as a single, space-delimited string.
2418
- * scopes: [
2419
- * 'https://www.googleapis.com/auth/ediscovery',
2420
- * 'https://www.googleapis.com/auth/ediscovery.readonly',
2421
- * ],
2422
- * });
2423
- *
2424
- * // Acquire an auth client, and bind it to all future calls
2425
- * const authClient = await auth.getClient();
2426
- * google.options({auth: authClient});
2427
- *
2428
- * // Do the magic
2429
- * const res = await vault.matters.holds.get({
2430
- * // The hold ID.
2431
- * holdId: 'placeholder-value',
2432
- * // The matter ID.
2433
- * matterId: 'placeholder-value',
2434
- * // The amount of detail to return for a hold.
2435
- * view: 'placeholder-value',
2436
- * });
2437
- * console.log(res.data);
2438
- *
2439
- * // Example response
2440
- * // {
2441
- * // "accounts": [],
2442
- * // "corpus": "my_corpus",
2443
- * // "holdId": "my_holdId",
2444
- * // "name": "my_name",
2445
- * // "orgUnit": {},
2446
- * // "query": {},
2447
- * // "updateTime": "my_updateTime"
2448
- * // }
2449
- * }
2450
- *
2451
- * main().catch(e => {
2452
- * console.error(e);
2453
- * throw e;
2454
- * });
2455
- *
2456
- * ```
2457
1463
  *
2458
1464
  * @param params - Parameters for request
2459
1465
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2468,58 +1474,6 @@ export declare namespace vault_v1 {
2468
1474
  get(callback: BodyResponseCallback<Schema$Hold>): void;
2469
1475
  /**
2470
1476
  * Lists the holds in a matter.
2471
- * @example
2472
- * ```js
2473
- * // Before running the sample:
2474
- * // - Enable the API at:
2475
- * // https://console.developers.google.com/apis/api/vault.googleapis.com
2476
- * // - Login into gcloud by running:
2477
- * // `$ gcloud auth application-default login`
2478
- * // - Install the npm module by running:
2479
- * // `$ npm install googleapis`
2480
- *
2481
- * const {google} = require('googleapis');
2482
- * const vault = google.vault('v1');
2483
- *
2484
- * async function main() {
2485
- * const auth = new google.auth.GoogleAuth({
2486
- * // Scopes can be specified either as an array or as a single, space-delimited string.
2487
- * scopes: [
2488
- * 'https://www.googleapis.com/auth/ediscovery',
2489
- * 'https://www.googleapis.com/auth/ediscovery.readonly',
2490
- * ],
2491
- * });
2492
- *
2493
- * // Acquire an auth client, and bind it to all future calls
2494
- * const authClient = await auth.getClient();
2495
- * google.options({auth: authClient});
2496
- *
2497
- * // Do the magic
2498
- * const res = await vault.matters.holds.list({
2499
- * // The matter ID.
2500
- * matterId: 'placeholder-value',
2501
- * // 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.
2502
- * pageSize: 'placeholder-value',
2503
- * // The pagination token as returned in the response. An empty token means start from the beginning.
2504
- * pageToken: 'placeholder-value',
2505
- * // The amount of detail to return for a hold.
2506
- * view: 'placeholder-value',
2507
- * });
2508
- * console.log(res.data);
2509
- *
2510
- * // Example response
2511
- * // {
2512
- * // "holds": [],
2513
- * // "nextPageToken": "my_nextPageToken"
2514
- * // }
2515
- * }
2516
- *
2517
- * main().catch(e => {
2518
- * console.error(e);
2519
- * throw e;
2520
- * });
2521
- *
2522
- * ```
2523
1477
  *
2524
1478
  * @param params - Parameters for request
2525
1479
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2534,58 +1488,6 @@ export declare namespace vault_v1 {
2534
1488
  list(callback: BodyResponseCallback<Schema$ListHoldsResponse>): void;
2535
1489
  /**
2536
1490
  * Removes the specified accounts from a hold. Returns a list of statuses in the same order as the request.
2537
- * @example
2538
- * ```js
2539
- * // Before running the sample:
2540
- * // - Enable the API at:
2541
- * // https://console.developers.google.com/apis/api/vault.googleapis.com
2542
- * // - Login into gcloud by running:
2543
- * // `$ gcloud auth application-default login`
2544
- * // - Install the npm module by running:
2545
- * // `$ npm install googleapis`
2546
- *
2547
- * const {google} = require('googleapis');
2548
- * const vault = google.vault('v1');
2549
- *
2550
- * async function main() {
2551
- * const auth = new google.auth.GoogleAuth({
2552
- * // Scopes can be specified either as an array or as a single, space-delimited string.
2553
- * scopes: ['https://www.googleapis.com/auth/ediscovery'],
2554
- * });
2555
- *
2556
- * // Acquire an auth client, and bind it to all future calls
2557
- * const authClient = await auth.getClient();
2558
- * google.options({auth: authClient});
2559
- *
2560
- * // Do the magic
2561
- * const res = await vault.matters.holds.removeHeldAccounts({
2562
- * // The hold ID.
2563
- * holdId: 'placeholder-value',
2564
- * // The matter ID.
2565
- * matterId: 'placeholder-value',
2566
- *
2567
- * // Request body metadata
2568
- * requestBody: {
2569
- * // request body parameters
2570
- * // {
2571
- * // "accountIds": []
2572
- * // }
2573
- * },
2574
- * });
2575
- * console.log(res.data);
2576
- *
2577
- * // Example response
2578
- * // {
2579
- * // "statuses": []
2580
- * // }
2581
- * }
2582
- *
2583
- * main().catch(e => {
2584
- * console.error(e);
2585
- * throw e;
2586
- * });
2587
- *
2588
- * ```
2589
1491
  *
2590
1492
  * @param params - Parameters for request
2591
1493
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2600,70 +1502,6 @@ export declare namespace vault_v1 {
2600
1502
  removeHeldAccounts(callback: BodyResponseCallback<Schema$RemoveHeldAccountsResponse>): void;
2601
1503
  /**
2602
1504
  * Updates the scope (organizational unit or accounts) and query parameters of a hold. You cannot add accounts to a hold that covers an organizational unit, nor can you add organizational units to a hold that covers individual accounts. If you try, the unsupported values are ignored.
2603
- * @example
2604
- * ```js
2605
- * // Before running the sample:
2606
- * // - Enable the API at:
2607
- * // https://console.developers.google.com/apis/api/vault.googleapis.com
2608
- * // - Login into gcloud by running:
2609
- * // `$ gcloud auth application-default login`
2610
- * // - Install the npm module by running:
2611
- * // `$ npm install googleapis`
2612
- *
2613
- * const {google} = require('googleapis');
2614
- * const vault = google.vault('v1');
2615
- *
2616
- * async function main() {
2617
- * const auth = new google.auth.GoogleAuth({
2618
- * // Scopes can be specified either as an array or as a single, space-delimited string.
2619
- * scopes: ['https://www.googleapis.com/auth/ediscovery'],
2620
- * });
2621
- *
2622
- * // Acquire an auth client, and bind it to all future calls
2623
- * const authClient = await auth.getClient();
2624
- * google.options({auth: authClient});
2625
- *
2626
- * // Do the magic
2627
- * const res = await vault.matters.holds.update({
2628
- * // The ID of the hold.
2629
- * holdId: 'placeholder-value',
2630
- * // The matter ID.
2631
- * matterId: 'placeholder-value',
2632
- *
2633
- * // Request body metadata
2634
- * requestBody: {
2635
- * // request body parameters
2636
- * // {
2637
- * // "accounts": [],
2638
- * // "corpus": "my_corpus",
2639
- * // "holdId": "my_holdId",
2640
- * // "name": "my_name",
2641
- * // "orgUnit": {},
2642
- * // "query": {},
2643
- * // "updateTime": "my_updateTime"
2644
- * // }
2645
- * },
2646
- * });
2647
- * console.log(res.data);
2648
- *
2649
- * // Example response
2650
- * // {
2651
- * // "accounts": [],
2652
- * // "corpus": "my_corpus",
2653
- * // "holdId": "my_holdId",
2654
- * // "name": "my_name",
2655
- * // "orgUnit": {},
2656
- * // "query": {},
2657
- * // "updateTime": "my_updateTime"
2658
- * // }
2659
- * }
2660
- *
2661
- * main().catch(e => {
2662
- * console.error(e);
2663
- * throw e;
2664
- * });
2665
- *
2666
- * ```
2667
1505
  *
2668
1506
  * @param params - Parameters for request
2669
1507
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2776,66 +1614,6 @@ export declare namespace vault_v1 {
2776
1614
  constructor(context: APIRequestContext);
2777
1615
  /**
2778
1616
  * Adds an account to a hold. Accounts can be added only to a hold that does not have an organizational unit set. If you try to add an account to an organizational unit-based hold, an error is returned.
2779
- * @example
2780
- * ```js
2781
- * // Before running the sample:
2782
- * // - Enable the API at:
2783
- * // https://console.developers.google.com/apis/api/vault.googleapis.com
2784
- * // - Login into gcloud by running:
2785
- * // `$ gcloud auth application-default login`
2786
- * // - Install the npm module by running:
2787
- * // `$ npm install googleapis`
2788
- *
2789
- * const {google} = require('googleapis');
2790
- * const vault = google.vault('v1');
2791
- *
2792
- * async function main() {
2793
- * const auth = new google.auth.GoogleAuth({
2794
- * // Scopes can be specified either as an array or as a single, space-delimited string.
2795
- * scopes: ['https://www.googleapis.com/auth/ediscovery'],
2796
- * });
2797
- *
2798
- * // Acquire an auth client, and bind it to all future calls
2799
- * const authClient = await auth.getClient();
2800
- * google.options({auth: authClient});
2801
- *
2802
- * // Do the magic
2803
- * const res = await vault.matters.holds.accounts.create({
2804
- * // The hold ID.
2805
- * holdId: 'placeholder-value',
2806
- * // The matter ID.
2807
- * matterId: 'placeholder-value',
2808
- *
2809
- * // Request body metadata
2810
- * requestBody: {
2811
- * // request body parameters
2812
- * // {
2813
- * // "accountId": "my_accountId",
2814
- * // "email": "my_email",
2815
- * // "firstName": "my_firstName",
2816
- * // "holdTime": "my_holdTime",
2817
- * // "lastName": "my_lastName"
2818
- * // }
2819
- * },
2820
- * });
2821
- * console.log(res.data);
2822
- *
2823
- * // Example response
2824
- * // {
2825
- * // "accountId": "my_accountId",
2826
- * // "email": "my_email",
2827
- * // "firstName": "my_firstName",
2828
- * // "holdTime": "my_holdTime",
2829
- * // "lastName": "my_lastName"
2830
- * // }
2831
- * }
2832
- *
2833
- * main().catch(e => {
2834
- * console.error(e);
2835
- * throw e;
2836
- * });
2837
- *
2838
- * ```
2839
1617
  *
2840
1618
  * @param params - Parameters for request
2841
1619
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2850,50 +1628,6 @@ export declare namespace vault_v1 {
2850
1628
  create(callback: BodyResponseCallback<Schema$HeldAccount>): void;
2851
1629
  /**
2852
1630
  * Removes an account from a hold.
2853
- * @example
2854
- * ```js
2855
- * // Before running the sample:
2856
- * // - Enable the API at:
2857
- * // https://console.developers.google.com/apis/api/vault.googleapis.com
2858
- * // - Login into gcloud by running:
2859
- * // `$ gcloud auth application-default login`
2860
- * // - Install the npm module by running:
2861
- * // `$ npm install googleapis`
2862
- *
2863
- * const {google} = require('googleapis');
2864
- * const vault = google.vault('v1');
2865
- *
2866
- * async function main() {
2867
- * const auth = new google.auth.GoogleAuth({
2868
- * // Scopes can be specified either as an array or as a single, space-delimited string.
2869
- * scopes: ['https://www.googleapis.com/auth/ediscovery'],
2870
- * });
2871
- *
2872
- * // Acquire an auth client, and bind it to all future calls
2873
- * const authClient = await auth.getClient();
2874
- * google.options({auth: authClient});
2875
- *
2876
- * // Do the magic
2877
- * const res = await vault.matters.holds.accounts.delete({
2878
- * // The ID of the account to remove from the hold.
2879
- * accountId: 'placeholder-value',
2880
- * // The hold ID.
2881
- * holdId: 'placeholder-value',
2882
- * // The matter ID.
2883
- * matterId: 'placeholder-value',
2884
- * });
2885
- * console.log(res.data);
2886
- *
2887
- * // Example response
2888
- * // {}
2889
- * }
2890
- *
2891
- * main().catch(e => {
2892
- * console.error(e);
2893
- * throw e;
2894
- * });
2895
- *
2896
- * ```
2897
1631
  *
2898
1632
  * @param params - Parameters for request
2899
1633
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2908,53 +1642,6 @@ export declare namespace vault_v1 {
2908
1642
  delete(callback: BodyResponseCallback<Schema$Empty>): void;
2909
1643
  /**
2910
1644
  * Lists the accounts covered by a hold. This can list only individually-specified accounts covered by the hold. If the hold covers an organizational unit, use the [Admin SDK](https://developers.google.com/admin-sdk/). to list the members of the organizational unit on hold.
2911
- * @example
2912
- * ```js
2913
- * // Before running the sample:
2914
- * // - Enable the API at:
2915
- * // https://console.developers.google.com/apis/api/vault.googleapis.com
2916
- * // - Login into gcloud by running:
2917
- * // `$ gcloud auth application-default login`
2918
- * // - Install the npm module by running:
2919
- * // `$ npm install googleapis`
2920
- *
2921
- * const {google} = require('googleapis');
2922
- * const vault = google.vault('v1');
2923
- *
2924
- * async function main() {
2925
- * const auth = new google.auth.GoogleAuth({
2926
- * // Scopes can be specified either as an array or as a single, space-delimited string.
2927
- * scopes: [
2928
- * 'https://www.googleapis.com/auth/ediscovery',
2929
- * 'https://www.googleapis.com/auth/ediscovery.readonly',
2930
- * ],
2931
- * });
2932
- *
2933
- * // Acquire an auth client, and bind it to all future calls
2934
- * const authClient = await auth.getClient();
2935
- * google.options({auth: authClient});
2936
- *
2937
- * // Do the magic
2938
- * const res = await vault.matters.holds.accounts.list({
2939
- * // The hold ID.
2940
- * holdId: 'placeholder-value',
2941
- * // The matter ID.
2942
- * matterId: 'placeholder-value',
2943
- * });
2944
- * console.log(res.data);
2945
- *
2946
- * // Example response
2947
- * // {
2948
- * // "accounts": []
2949
- * // }
2950
- * }
2951
- *
2952
- * main().catch(e => {
2953
- * console.error(e);
2954
- * throw e;
2955
- * });
2956
- *
2957
- * ```
2958
1645
  *
2959
1646
  * @param params - Parameters for request
2960
1647
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3011,64 +1698,6 @@ export declare namespace vault_v1 {
3011
1698
  constructor(context: APIRequestContext);
3012
1699
  /**
3013
1700
  * Creates a saved query.
3014
- * @example
3015
- * ```js
3016
- * // Before running the sample:
3017
- * // - Enable the API at:
3018
- * // https://console.developers.google.com/apis/api/vault.googleapis.com
3019
- * // - Login into gcloud by running:
3020
- * // `$ gcloud auth application-default login`
3021
- * // - Install the npm module by running:
3022
- * // `$ npm install googleapis`
3023
- *
3024
- * const {google} = require('googleapis');
3025
- * const vault = google.vault('v1');
3026
- *
3027
- * async function main() {
3028
- * const auth = new google.auth.GoogleAuth({
3029
- * // Scopes can be specified either as an array or as a single, space-delimited string.
3030
- * scopes: ['https://www.googleapis.com/auth/ediscovery'],
3031
- * });
3032
- *
3033
- * // Acquire an auth client, and bind it to all future calls
3034
- * const authClient = await auth.getClient();
3035
- * google.options({auth: authClient});
3036
- *
3037
- * // Do the magic
3038
- * const res = await vault.matters.savedQueries.create({
3039
- * // The ID of the matter to create the saved query in.
3040
- * matterId: 'placeholder-value',
3041
- *
3042
- * // Request body metadata
3043
- * requestBody: {
3044
- * // request body parameters
3045
- * // {
3046
- * // "createTime": "my_createTime",
3047
- * // "displayName": "my_displayName",
3048
- * // "matterId": "my_matterId",
3049
- * // "query": {},
3050
- * // "savedQueryId": "my_savedQueryId"
3051
- * // }
3052
- * },
3053
- * });
3054
- * console.log(res.data);
3055
- *
3056
- * // Example response
3057
- * // {
3058
- * // "createTime": "my_createTime",
3059
- * // "displayName": "my_displayName",
3060
- * // "matterId": "my_matterId",
3061
- * // "query": {},
3062
- * // "savedQueryId": "my_savedQueryId"
3063
- * // }
3064
- * }
3065
- *
3066
- * main().catch(e => {
3067
- * console.error(e);
3068
- * throw e;
3069
- * });
3070
- *
3071
- * ```
3072
1701
  *
3073
1702
  * @param params - Parameters for request
3074
1703
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3083,48 +1712,6 @@ export declare namespace vault_v1 {
3083
1712
  create(callback: BodyResponseCallback<Schema$SavedQuery>): void;
3084
1713
  /**
3085
1714
  * Deletes the specified saved query.
3086
- * @example
3087
- * ```js
3088
- * // Before running the sample:
3089
- * // - Enable the API at:
3090
- * // https://console.developers.google.com/apis/api/vault.googleapis.com
3091
- * // - Login into gcloud by running:
3092
- * // `$ gcloud auth application-default login`
3093
- * // - Install the npm module by running:
3094
- * // `$ npm install googleapis`
3095
- *
3096
- * const {google} = require('googleapis');
3097
- * const vault = google.vault('v1');
3098
- *
3099
- * async function main() {
3100
- * const auth = new google.auth.GoogleAuth({
3101
- * // Scopes can be specified either as an array or as a single, space-delimited string.
3102
- * scopes: ['https://www.googleapis.com/auth/ediscovery'],
3103
- * });
3104
- *
3105
- * // Acquire an auth client, and bind it to all future calls
3106
- * const authClient = await auth.getClient();
3107
- * google.options({auth: authClient});
3108
- *
3109
- * // Do the magic
3110
- * const res = await vault.matters.savedQueries.delete({
3111
- * // The ID of the matter to delete the saved query from.
3112
- * matterId: 'placeholder-value',
3113
- * // ID of the saved query to delete.
3114
- * savedQueryId: 'placeholder-value',
3115
- * });
3116
- * console.log(res.data);
3117
- *
3118
- * // Example response
3119
- * // {}
3120
- * }
3121
- *
3122
- * main().catch(e => {
3123
- * console.error(e);
3124
- * throw e;
3125
- * });
3126
- *
3127
- * ```
3128
1715
  *
3129
1716
  * @param params - Parameters for request
3130
1717
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3139,57 +1726,6 @@ export declare namespace vault_v1 {
3139
1726
  delete(callback: BodyResponseCallback<Schema$Empty>): void;
3140
1727
  /**
3141
1728
  * Retrieves the specified saved query.
3142
- * @example
3143
- * ```js
3144
- * // Before running the sample:
3145
- * // - Enable the API at:
3146
- * // https://console.developers.google.com/apis/api/vault.googleapis.com
3147
- * // - Login into gcloud by running:
3148
- * // `$ gcloud auth application-default login`
3149
- * // - Install the npm module by running:
3150
- * // `$ npm install googleapis`
3151
- *
3152
- * const {google} = require('googleapis');
3153
- * const vault = google.vault('v1');
3154
- *
3155
- * async function main() {
3156
- * const auth = new google.auth.GoogleAuth({
3157
- * // Scopes can be specified either as an array or as a single, space-delimited string.
3158
- * scopes: [
3159
- * 'https://www.googleapis.com/auth/ediscovery',
3160
- * 'https://www.googleapis.com/auth/ediscovery.readonly',
3161
- * ],
3162
- * });
3163
- *
3164
- * // Acquire an auth client, and bind it to all future calls
3165
- * const authClient = await auth.getClient();
3166
- * google.options({auth: authClient});
3167
- *
3168
- * // Do the magic
3169
- * const res = await vault.matters.savedQueries.get({
3170
- * // The ID of the matter to get the saved query from.
3171
- * matterId: 'placeholder-value',
3172
- * // ID of the saved query to retrieve.
3173
- * savedQueryId: 'placeholder-value',
3174
- * });
3175
- * console.log(res.data);
3176
- *
3177
- * // Example response
3178
- * // {
3179
- * // "createTime": "my_createTime",
3180
- * // "displayName": "my_displayName",
3181
- * // "matterId": "my_matterId",
3182
- * // "query": {},
3183
- * // "savedQueryId": "my_savedQueryId"
3184
- * // }
3185
- * }
3186
- *
3187
- * main().catch(e => {
3188
- * console.error(e);
3189
- * throw e;
3190
- * });
3191
- *
3192
- * ```
3193
1729
  *
3194
1730
  * @param params - Parameters for request
3195
1731
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3204,56 +1740,6 @@ export declare namespace vault_v1 {
3204
1740
  get(callback: BodyResponseCallback<Schema$SavedQuery>): void;
3205
1741
  /**
3206
1742
  * Lists the saved queries in a matter.
3207
- * @example
3208
- * ```js
3209
- * // Before running the sample:
3210
- * // - Enable the API at:
3211
- * // https://console.developers.google.com/apis/api/vault.googleapis.com
3212
- * // - Login into gcloud by running:
3213
- * // `$ gcloud auth application-default login`
3214
- * // - Install the npm module by running:
3215
- * // `$ npm install googleapis`
3216
- *
3217
- * const {google} = require('googleapis');
3218
- * const vault = google.vault('v1');
3219
- *
3220
- * async function main() {
3221
- * const auth = new google.auth.GoogleAuth({
3222
- * // Scopes can be specified either as an array or as a single, space-delimited string.
3223
- * scopes: [
3224
- * 'https://www.googleapis.com/auth/ediscovery',
3225
- * 'https://www.googleapis.com/auth/ediscovery.readonly',
3226
- * ],
3227
- * });
3228
- *
3229
- * // Acquire an auth client, and bind it to all future calls
3230
- * const authClient = await auth.getClient();
3231
- * google.options({auth: authClient});
3232
- *
3233
- * // Do the magic
3234
- * const res = await vault.matters.savedQueries.list({
3235
- * // The ID of the matter to get the saved queries for.
3236
- * matterId: 'placeholder-value',
3237
- * // The maximum number of saved queries to return.
3238
- * pageSize: 'placeholder-value',
3239
- * // The pagination token as returned in the previous response. An empty token means start from the beginning.
3240
- * pageToken: 'placeholder-value',
3241
- * });
3242
- * console.log(res.data);
3243
- *
3244
- * // Example response
3245
- * // {
3246
- * // "nextPageToken": "my_nextPageToken",
3247
- * // "savedQueries": []
3248
- * // }
3249
- * }
3250
- *
3251
- * main().catch(e => {
3252
- * console.error(e);
3253
- * throw e;
3254
- * });
3255
- *
3256
- * ```
3257
1743
  *
3258
1744
  * @param params - Parameters for request
3259
1745
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3316,52 +1802,6 @@ export declare namespace vault_v1 {
3316
1802
  constructor(context: APIRequestContext);
3317
1803
  /**
3318
1804
  * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
3319
- * @example
3320
- * ```js
3321
- * // Before running the sample:
3322
- * // - Enable the API at:
3323
- * // https://console.developers.google.com/apis/api/vault.googleapis.com
3324
- * // - Login into gcloud by running:
3325
- * // `$ gcloud auth application-default login`
3326
- * // - Install the npm module by running:
3327
- * // `$ npm install googleapis`
3328
- *
3329
- * const {google} = require('googleapis');
3330
- * const vault = google.vault('v1');
3331
- *
3332
- * async function main() {
3333
- * const auth = new google.auth.GoogleAuth({
3334
- * // Scopes can be specified either as an array or as a single, space-delimited string.
3335
- * scopes: [],
3336
- * });
3337
- *
3338
- * // Acquire an auth client, and bind it to all future calls
3339
- * const authClient = await auth.getClient();
3340
- * google.options({auth: authClient});
3341
- *
3342
- * // Do the magic
3343
- * const res = await vault.operations.cancel({
3344
- * // The name of the operation resource to be cancelled.
3345
- * name: 'operations/.*',
3346
- *
3347
- * // Request body metadata
3348
- * requestBody: {
3349
- * // request body parameters
3350
- * // {}
3351
- * },
3352
- * });
3353
- * console.log(res.data);
3354
- *
3355
- * // Example response
3356
- * // {}
3357
- * }
3358
- *
3359
- * main().catch(e => {
3360
- * console.error(e);
3361
- * throw e;
3362
- * });
3363
- *
3364
- * ```
3365
1805
  *
3366
1806
  * @param params - Parameters for request
3367
1807
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3376,46 +1816,6 @@ export declare namespace vault_v1 {
3376
1816
  cancel(callback: BodyResponseCallback<Schema$Empty>): void;
3377
1817
  /**
3378
1818
  * 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`.
3379
- * @example
3380
- * ```js
3381
- * // Before running the sample:
3382
- * // - Enable the API at:
3383
- * // https://console.developers.google.com/apis/api/vault.googleapis.com
3384
- * // - Login into gcloud by running:
3385
- * // `$ gcloud auth application-default login`
3386
- * // - Install the npm module by running:
3387
- * // `$ npm install googleapis`
3388
- *
3389
- * const {google} = require('googleapis');
3390
- * const vault = google.vault('v1');
3391
- *
3392
- * async function main() {
3393
- * const auth = new google.auth.GoogleAuth({
3394
- * // Scopes can be specified either as an array or as a single, space-delimited string.
3395
- * scopes: [],
3396
- * });
3397
- *
3398
- * // Acquire an auth client, and bind it to all future calls
3399
- * const authClient = await auth.getClient();
3400
- * google.options({auth: authClient});
3401
- *
3402
- * // Do the magic
3403
- * const res = await vault.operations.delete({
3404
- * // The name of the operation resource to be deleted.
3405
- * name: 'operations/.*',
3406
- * });
3407
- * console.log(res.data);
3408
- *
3409
- * // Example response
3410
- * // {}
3411
- * }
3412
- *
3413
- * main().catch(e => {
3414
- * console.error(e);
3415
- * throw e;
3416
- * });
3417
- *
3418
- * ```
3419
1819
  *
3420
1820
  * @param params - Parameters for request
3421
1821
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3430,55 +1830,6 @@ export declare namespace vault_v1 {
3430
1830
  delete(callback: BodyResponseCallback<Schema$Empty>): void;
3431
1831
  /**
3432
1832
  * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
3433
- * @example
3434
- * ```js
3435
- * // Before running the sample:
3436
- * // - Enable the API at:
3437
- * // https://console.developers.google.com/apis/api/vault.googleapis.com
3438
- * // - Login into gcloud by running:
3439
- * // `$ gcloud auth application-default login`
3440
- * // - Install the npm module by running:
3441
- * // `$ npm install googleapis`
3442
- *
3443
- * const {google} = require('googleapis');
3444
- * const vault = google.vault('v1');
3445
- *
3446
- * async function main() {
3447
- * const auth = new google.auth.GoogleAuth({
3448
- * // Scopes can be specified either as an array or as a single, space-delimited string.
3449
- * scopes: [
3450
- * 'https://www.googleapis.com/auth/ediscovery',
3451
- * 'https://www.googleapis.com/auth/ediscovery.readonly',
3452
- * ],
3453
- * });
3454
- *
3455
- * // Acquire an auth client, and bind it to all future calls
3456
- * const authClient = await auth.getClient();
3457
- * google.options({auth: authClient});
3458
- *
3459
- * // Do the magic
3460
- * const res = await vault.operations.get({
3461
- * // The name of the operation resource.
3462
- * name: 'operations/.*',
3463
- * });
3464
- * console.log(res.data);
3465
- *
3466
- * // Example response
3467
- * // {
3468
- * // "done": false,
3469
- * // "error": {},
3470
- * // "metadata": {},
3471
- * // "name": "my_name",
3472
- * // "response": {}
3473
- * // }
3474
- * }
3475
- *
3476
- * main().catch(e => {
3477
- * console.error(e);
3478
- * throw e;
3479
- * });
3480
- *
3481
- * ```
3482
1833
  *
3483
1834
  * @param params - Parameters for request
3484
1835
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3493,55 +1844,6 @@ export declare namespace vault_v1 {
3493
1844
  get(callback: BodyResponseCallback<Schema$Operation>): void;
3494
1845
  /**
3495
1846
  * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
3496
- * @example
3497
- * ```js
3498
- * // Before running the sample:
3499
- * // - Enable the API at:
3500
- * // https://console.developers.google.com/apis/api/vault.googleapis.com
3501
- * // - Login into gcloud by running:
3502
- * // `$ gcloud auth application-default login`
3503
- * // - Install the npm module by running:
3504
- * // `$ npm install googleapis`
3505
- *
3506
- * const {google} = require('googleapis');
3507
- * const vault = google.vault('v1');
3508
- *
3509
- * async function main() {
3510
- * const auth = new google.auth.GoogleAuth({
3511
- * // Scopes can be specified either as an array or as a single, space-delimited string.
3512
- * scopes: [],
3513
- * });
3514
- *
3515
- * // Acquire an auth client, and bind it to all future calls
3516
- * const authClient = await auth.getClient();
3517
- * google.options({auth: authClient});
3518
- *
3519
- * // Do the magic
3520
- * const res = await vault.operations.list({
3521
- * // The standard list filter.
3522
- * filter: 'placeholder-value',
3523
- * // The name of the operation's parent resource.
3524
- * name: 'operations',
3525
- * // The standard list page size.
3526
- * pageSize: 'placeholder-value',
3527
- * // The standard list page token.
3528
- * pageToken: 'placeholder-value',
3529
- * });
3530
- * console.log(res.data);
3531
- *
3532
- * // Example response
3533
- * // {
3534
- * // "nextPageToken": "my_nextPageToken",
3535
- * // "operations": []
3536
- * // }
3537
- * }
3538
- *
3539
- * main().catch(e => {
3540
- * console.error(e);
3541
- * throw e;
3542
- * });
3543
- *
3544
- * ```
3545
1847
  *
3546
1848
  * @param params - Parameters for request
3547
1849
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.