@googleapis/vault 5.0.1 → 7.0.0

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
@@ -1,4 +1,3 @@
1
- /// <reference types="node" />
2
1
  import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosResponseWithHTTP2, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
3
2
  import { Readable } from 'stream';
4
3
  export declare namespace vault_v1 {
@@ -365,6 +364,10 @@ export declare namespace vault_v1 {
365
364
  * Set to true to include Team Drive.
366
365
  */
367
366
  includeTeamDrives?: boolean | null;
367
+ /**
368
+ * Optional. Options to include or exclude documents in shared drives. We recommend using this field over include_shared_drives. This field overrides include_shared_drives and include_team_drives when set.
369
+ */
370
+ sharedDrivesOption?: string | null;
368
371
  /**
369
372
  * Search the current version of the Drive file, but export the contents of the last version saved before 12:00 AM UTC on the specified date. Enter the date in UTC.
370
373
  */
@@ -1152,6 +1155,63 @@ export declare namespace vault_v1 {
1152
1155
  constructor(context: APIRequestContext);
1153
1156
  /**
1154
1157
  * Adds an account as a matter collaborator.
1158
+ * @example
1159
+ * ```js
1160
+ * // Before running the sample:
1161
+ * // - Enable the API at:
1162
+ * // https://console.developers.google.com/apis/api/vault.googleapis.com
1163
+ * // - Login into gcloud by running:
1164
+ * // ```sh
1165
+ * // $ gcloud auth application-default login
1166
+ * // ```
1167
+ * // - Install the npm module by running:
1168
+ * // ```sh
1169
+ * // $ npm install googleapis
1170
+ * // ```
1171
+ *
1172
+ * const {google} = require('googleapis');
1173
+ * const vault = google.vault('v1');
1174
+ *
1175
+ * async function main() {
1176
+ * const auth = new google.auth.GoogleAuth({
1177
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
1178
+ * scopes: ['https://www.googleapis.com/auth/ediscovery'],
1179
+ * });
1180
+ *
1181
+ * // Acquire an auth client, and bind it to all future calls
1182
+ * const authClient = await auth.getClient();
1183
+ * google.options({auth: authClient});
1184
+ *
1185
+ * // Do the magic
1186
+ * const res = await vault.matters.addPermissions({
1187
+ * // The matter ID.
1188
+ * matterId: 'placeholder-value',
1189
+ *
1190
+ * // Request body metadata
1191
+ * requestBody: {
1192
+ * // request body parameters
1193
+ * // {
1194
+ * // "ccMe": false,
1195
+ * // "matterPermission": {},
1196
+ * // "sendEmails": false
1197
+ * // }
1198
+ * },
1199
+ * });
1200
+ * console.log(res.data);
1201
+ *
1202
+ * // Example response
1203
+ * // {
1204
+ * // "accountId": "my_accountId",
1205
+ * // "role": "my_role"
1206
+ * // }
1207
+ * }
1208
+ *
1209
+ * main().catch(e => {
1210
+ * console.error(e);
1211
+ * throw e;
1212
+ * });
1213
+ *
1214
+ * ```
1155
1215
  *
1156
1216
  * @param params - Parameters for request
1157
1217
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1166,6 +1226,58 @@ export declare namespace vault_v1 {
1166
1226
  addPermissions(callback: BodyResponseCallback<Schema$MatterPermission>): void;
1167
1227
  /**
1168
1228
  * Closes the specified matter. Returns the matter with updated state.
1229
+ * @example
1230
+ * ```js
1231
+ * // Before running the sample:
1232
+ * // - Enable the API at:
1233
+ * // https://console.developers.google.com/apis/api/vault.googleapis.com
1234
+ * // - Login into gcloud by running:
1235
+ * // ```sh
1236
+ * // $ gcloud auth application-default login
1237
+ * // ```
1238
+ * // - Install the npm module by running:
1239
+ * // ```sh
1240
+ * // $ npm install googleapis
1241
+ * // ```
1242
+ *
1243
+ * const {google} = require('googleapis');
1244
+ * const vault = google.vault('v1');
1245
+ *
1246
+ * async function main() {
1247
+ * const auth = new google.auth.GoogleAuth({
1248
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
1249
+ * scopes: ['https://www.googleapis.com/auth/ediscovery'],
1250
+ * });
1251
+ *
1252
+ * // Acquire an auth client, and bind it to all future calls
1253
+ * const authClient = await auth.getClient();
1254
+ * google.options({auth: authClient});
1255
+ *
1256
+ * // Do the magic
1257
+ * const res = await vault.matters.close({
1258
+ * // The matter ID.
1259
+ * matterId: 'placeholder-value',
1260
+ *
1261
+ * // Request body metadata
1262
+ * requestBody: {
1263
+ * // request body parameters
1264
+ * // {}
1265
+ * },
1266
+ * });
1267
+ * console.log(res.data);
1268
+ *
1269
+ * // Example response
1270
+ * // {
1271
+ * // "matter": {}
1272
+ * // }
1273
+ * }
1274
+ *
1275
+ * main().catch(e => {
1276
+ * console.error(e);
1277
+ * throw e;
1278
+ * });
1279
+ *
1280
+ * ```
1169
1281
  *
1170
1282
  * @param params - Parameters for request
1171
1283
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1180,6 +1292,65 @@ export declare namespace vault_v1 {
1180
1292
  close(callback: BodyResponseCallback<Schema$CloseMatterResponse>): void;
1181
1293
  /**
1182
1294
  * Counts the accounts processed by the specified query.
1295
+ * @example
1296
+ * ```js
1297
+ * // Before running the sample:
1298
+ * // - Enable the API at:
1299
+ * // https://console.developers.google.com/apis/api/vault.googleapis.com
1300
+ * // - Login into gcloud by running:
1301
+ * // ```sh
1302
+ * // $ gcloud auth application-default login
1303
+ * // ```
1304
+ * // - Install the npm module by running:
1305
+ * // ```sh
1306
+ * // $ npm install googleapis
1307
+ * // ```
1308
+ *
1309
+ * const {google} = require('googleapis');
1310
+ * const vault = google.vault('v1');
1311
+ *
1312
+ * async function main() {
1313
+ * const auth = new google.auth.GoogleAuth({
1314
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
1315
+ * scopes: ['https://www.googleapis.com/auth/ediscovery'],
1316
+ * });
1317
+ *
1318
+ * // Acquire an auth client, and bind it to all future calls
1319
+ * const authClient = await auth.getClient();
1320
+ * google.options({auth: authClient});
1321
+ *
1322
+ * // Do the magic
1323
+ * const res = await vault.matters.count({
1324
+ * // The matter ID.
1325
+ * matterId: 'placeholder-value',
1326
+ *
1327
+ * // Request body metadata
1328
+ * requestBody: {
1329
+ * // request body parameters
1330
+ * // {
1331
+ * // "query": {},
1332
+ * // "view": "my_view"
1333
+ * // }
1334
+ * },
1335
+ * });
1336
+ * console.log(res.data);
1337
+ *
1338
+ * // Example response
1339
+ * // {
1340
+ * // "done": false,
1341
+ * // "error": {},
1342
+ * // "metadata": {},
1343
+ * // "name": "my_name",
1344
+ * // "response": {}
1345
+ * // }
1346
+ * }
1347
+ *
1348
+ * main().catch(e => {
1349
+ * console.error(e);
1350
+ * throw e;
1351
+ * });
1352
+ *
1353
+ * ```
1183
1354
  *
1184
1355
  * @param params - Parameters for request
1185
1356
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1194,6 +1365,67 @@ export declare namespace vault_v1 {
1194
1365
  count(callback: BodyResponseCallback<Schema$Operation>): void;
1195
1366
  /**
1196
1367
  * 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.
1368
+ * @example
1369
+ * ```js
1370
+ * // Before running the sample:
1371
+ * // - Enable the API at:
1372
+ * // https://console.developers.google.com/apis/api/vault.googleapis.com
1373
+ * // - Login into gcloud by running:
1374
+ * // ```sh
1375
+ * // $ gcloud auth application-default login
1376
+ * // ```
1377
+ * // - Install the npm module by running:
1378
+ * // ```sh
1379
+ * // $ npm install googleapis
1380
+ * // ```
1381
+ *
1382
+ * const {google} = require('googleapis');
1383
+ * const vault = google.vault('v1');
1384
+ *
1385
+ * async function main() {
1386
+ * const auth = new google.auth.GoogleAuth({
1387
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
1388
+ * scopes: ['https://www.googleapis.com/auth/ediscovery'],
1389
+ * });
1390
+ *
1391
+ * // Acquire an auth client, and bind it to all future calls
1392
+ * const authClient = await auth.getClient();
1393
+ * google.options({auth: authClient});
1394
+ *
1395
+ * // Do the magic
1396
+ * const res = await vault.matters.create({
1397
+ * // Request body metadata
1398
+ * requestBody: {
1399
+ * // request body parameters
1400
+ * // {
1401
+ * // "description": "my_description",
1402
+ * // "matterId": "my_matterId",
1403
+ * // "matterPermissions": [],
1404
+ * // "matterRegion": "my_matterRegion",
1405
+ * // "name": "my_name",
1406
+ * // "state": "my_state"
1407
+ * // }
1408
+ * },
1409
+ * });
1410
+ * console.log(res.data);
1411
+ *
1412
+ * // Example response
1413
+ * // {
1414
+ * // "description": "my_description",
1415
+ * // "matterId": "my_matterId",
1416
+ * // "matterPermissions": [],
1417
+ * // "matterRegion": "my_matterRegion",
1418
+ * // "name": "my_name",
1419
+ * // "state": "my_state"
1420
+ * // }
1421
+ * }
1422
+ *
1423
+ * main().catch(e => {
1424
+ * console.error(e);
1425
+ * throw e;
1426
+ * });
1427
+ *
1428
+ * ```
1197
1429
  *
1198
1430
  * @param params - Parameters for request
1199
1431
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1208,6 +1440,57 @@ export declare namespace vault_v1 {
1208
1440
  create(callback: BodyResponseCallback<Schema$Matter>): void;
1209
1441
  /**
1210
1442
  * Deletes the specified matter. Returns the matter with updated state.
1443
+ * @example
1444
+ * ```js
1445
+ * // Before running the sample:
1446
+ * // - Enable the API at:
1447
+ * // https://console.developers.google.com/apis/api/vault.googleapis.com
1448
+ * // - Login into gcloud by running:
1449
+ * // ```sh
1450
+ * // $ gcloud auth application-default login
1451
+ * // ```
1452
+ * // - Install the npm module by running:
1453
+ * // ```sh
1454
+ * // $ npm install googleapis
1455
+ * // ```
1456
+ *
1457
+ * const {google} = require('googleapis');
1458
+ * const vault = google.vault('v1');
1459
+ *
1460
+ * async function main() {
1461
+ * const auth = new google.auth.GoogleAuth({
1462
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
1463
+ * scopes: ['https://www.googleapis.com/auth/ediscovery'],
1464
+ * });
1465
+ *
1466
+ * // Acquire an auth client, and bind it to all future calls
1467
+ * const authClient = await auth.getClient();
1468
+ * google.options({auth: authClient});
1469
+ *
1470
+ * // Do the magic
1471
+ * const res = await vault.matters.delete({
1472
+ * // The matter ID
1473
+ * matterId: 'placeholder-value',
1474
+ * });
1475
+ * console.log(res.data);
1476
+ *
1477
+ * // Example response
1478
+ * // {
1479
+ * // "description": "my_description",
1480
+ * // "matterId": "my_matterId",
1481
+ * // "matterPermissions": [],
1482
+ * // "matterRegion": "my_matterRegion",
1483
+ * // "name": "my_name",
1484
+ * // "state": "my_state"
1485
+ * // }
1486
+ * }
1487
+ *
1488
+ * main().catch(e => {
1489
+ * console.error(e);
1490
+ * throw e;
1491
+ * });
1492
+ *
1493
+ * ```
1211
1494
  *
1212
1495
  * @param params - Parameters for request
1213
1496
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1222,6 +1505,62 @@ export declare namespace vault_v1 {
1222
1505
  delete(callback: BodyResponseCallback<Schema$Matter>): void;
1223
1506
  /**
1224
1507
  * Gets the specified matter.
1508
+ * @example
1509
+ * ```js
1510
+ * // Before running the sample:
1511
+ * // - Enable the API at:
1512
+ * // https://console.developers.google.com/apis/api/vault.googleapis.com
1513
+ * // - Login into gcloud by running:
1514
+ * // ```sh
1515
+ * // $ gcloud auth application-default login
1516
+ * // ```
1517
+ * // - Install the npm module by running:
1518
+ * // ```sh
1519
+ * // $ npm install googleapis
1520
+ * // ```
1521
+ *
1522
+ * const {google} = require('googleapis');
1523
+ * const vault = google.vault('v1');
1524
+ *
1525
+ * async function main() {
1526
+ * const auth = new google.auth.GoogleAuth({
1527
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
1528
+ * scopes: [
1529
+ * 'https://www.googleapis.com/auth/ediscovery',
1530
+ * 'https://www.googleapis.com/auth/ediscovery.readonly',
1531
+ * ],
1532
+ * });
1533
+ *
1534
+ * // Acquire an auth client, and bind it to all future calls
1535
+ * const authClient = await auth.getClient();
1536
+ * google.options({auth: authClient});
1537
+ *
1538
+ * // Do the magic
1539
+ * const res = await vault.matters.get({
1540
+ * // The matter ID.
1541
+ * matterId: 'placeholder-value',
1542
+ * // Specifies how much information about the matter to return in the response.
1543
+ * view: 'placeholder-value',
1544
+ * });
1545
+ * console.log(res.data);
1546
+ *
1547
+ * // Example response
1548
+ * // {
1549
+ * // "description": "my_description",
1550
+ * // "matterId": "my_matterId",
1551
+ * // "matterPermissions": [],
1552
+ * // "matterRegion": "my_matterRegion",
1553
+ * // "name": "my_name",
1554
+ * // "state": "my_state"
1555
+ * // }
1556
+ * }
1557
+ *
1558
+ * main().catch(e => {
1559
+ * console.error(e);
1560
+ * throw e;
1561
+ * });
1562
+ *
1563
+ * ```
1225
1564
  *
1226
1565
  * @param params - Parameters for request
1227
1566
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1236,6 +1575,62 @@ export declare namespace vault_v1 {
1236
1575
  get(callback: BodyResponseCallback<Schema$Matter>): void;
1237
1576
  /**
1238
1577
  * Lists matters the requestor has access to.
1578
+ * @example
1579
+ * ```js
1580
+ * // Before running the sample:
1581
+ * // - Enable the API at:
1582
+ * // https://console.developers.google.com/apis/api/vault.googleapis.com
1583
+ * // - Login into gcloud by running:
1584
+ * // ```sh
1585
+ * // $ gcloud auth application-default login
1586
+ * // ```
1587
+ * // - Install the npm module by running:
1588
+ * // ```sh
1589
+ * // $ npm install googleapis
1590
+ * // ```
1591
+ *
1592
+ * const {google} = require('googleapis');
1593
+ * const vault = google.vault('v1');
1594
+ *
1595
+ * async function main() {
1596
+ * const auth = new google.auth.GoogleAuth({
1597
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
1598
+ * scopes: [
1599
+ * 'https://www.googleapis.com/auth/ediscovery',
1600
+ * 'https://www.googleapis.com/auth/ediscovery.readonly',
1601
+ * ],
1602
+ * });
1603
+ *
1604
+ * // Acquire an auth client, and bind it to all future calls
1605
+ * const authClient = await auth.getClient();
1606
+ * google.options({auth: authClient});
1607
+ *
1608
+ * // Do the magic
1609
+ * const res = await vault.matters.list({
1610
+ * // The number of matters to return in the response. Default and maximum are 100.
1611
+ * pageSize: 'placeholder-value',
1612
+ * // The pagination token as returned in the response.
1613
+ * pageToken: 'placeholder-value',
1614
+ * // If set, lists only matters with the specified state. The default lists matters of all states.
1615
+ * state: 'placeholder-value',
1616
+ * // Specifies how much information about the matter to return in response.
1617
+ * view: 'placeholder-value',
1618
+ * });
1619
+ * console.log(res.data);
1620
+ *
1621
+ * // Example response
1622
+ * // {
1623
+ * // "matters": [],
1624
+ * // "nextPageToken": "my_nextPageToken"
1625
+ * // }
1626
+ * }
1627
+ *
1628
+ * main().catch(e => {
1629
+ * console.error(e);
1630
+ * throw e;
1631
+ * });
1632
+ *
1633
+ * ```
1239
1634
  *
1240
1635
  * @param params - Parameters for request
1241
1636
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1250,6 +1645,58 @@ export declare namespace vault_v1 {
1250
1645
  list(callback: BodyResponseCallback<Schema$ListMattersResponse>): void;
1251
1646
  /**
1252
1647
  * Removes an account as a matter collaborator.
1648
+ * @example
1649
+ * ```js
1650
+ * // Before running the sample:
1651
+ * // - Enable the API at:
1652
+ * // https://console.developers.google.com/apis/api/vault.googleapis.com
1653
+ * // - Login into gcloud by running:
1654
+ * // ```sh
1655
+ * // $ gcloud auth application-default login
1656
+ * // ```
1657
+ * // - Install the npm module by running:
1658
+ * // ```sh
1659
+ * // $ npm install googleapis
1660
+ * // ```
1661
+ *
1662
+ * const {google} = require('googleapis');
1663
+ * const vault = google.vault('v1');
1664
+ *
1665
+ * async function main() {
1666
+ * const auth = new google.auth.GoogleAuth({
1667
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
1668
+ * scopes: ['https://www.googleapis.com/auth/ediscovery'],
1669
+ * });
1670
+ *
1671
+ * // Acquire an auth client, and bind it to all future calls
1672
+ * const authClient = await auth.getClient();
1673
+ * google.options({auth: authClient});
1674
+ *
1675
+ * // Do the magic
1676
+ * const res = await vault.matters.removePermissions({
1677
+ * // The matter ID.
1678
+ * matterId: 'placeholder-value',
1679
+ *
1680
+ * // Request body metadata
1681
+ * requestBody: {
1682
+ * // request body parameters
1683
+ * // {
1684
+ * // "accountId": "my_accountId"
1685
+ * // }
1686
+ * },
1687
+ * });
1688
+ * console.log(res.data);
1689
+ *
1690
+ * // Example response
1691
+ * // {}
1692
+ * }
1693
+ *
1694
+ * main().catch(e => {
1695
+ * console.error(e);
1696
+ * throw e;
1697
+ * });
1698
+ *
1699
+ * ```
1253
1700
  *
1254
1701
  * @param params - Parameters for request
1255
1702
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1264,6 +1711,58 @@ export declare namespace vault_v1 {
1264
1711
  removePermissions(callback: BodyResponseCallback<Schema$Empty>): void;
1265
1712
  /**
1266
1713
  * Reopens the specified matter. Returns the matter with updated state.
1714
+ * @example
1715
+ * ```js
1716
+ * // Before running the sample:
1717
+ * // - Enable the API at:
1718
+ * // https://console.developers.google.com/apis/api/vault.googleapis.com
1719
+ * // - Login into gcloud by running:
1720
+ * // ```sh
1721
+ * // $ gcloud auth application-default login
1722
+ * // ```
1723
+ * // - Install the npm module by running:
1724
+ * // ```sh
1725
+ * // $ npm install googleapis
1726
+ * // ```
1727
+ *
1728
+ * const {google} = require('googleapis');
1729
+ * const vault = google.vault('v1');
1730
+ *
1731
+ * async function main() {
1732
+ * const auth = new google.auth.GoogleAuth({
1733
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
1734
+ * scopes: ['https://www.googleapis.com/auth/ediscovery'],
1735
+ * });
1736
+ *
1737
+ * // Acquire an auth client, and bind it to all future calls
1738
+ * const authClient = await auth.getClient();
1739
+ * google.options({auth: authClient});
1740
+ *
1741
+ * // Do the magic
1742
+ * const res = await vault.matters.reopen({
1743
+ * // The matter ID.
1744
+ * matterId: 'placeholder-value',
1745
+ *
1746
+ * // Request body metadata
1747
+ * requestBody: {
1748
+ * // request body parameters
1749
+ * // {}
1750
+ * },
1751
+ * });
1752
+ * console.log(res.data);
1753
+ *
1754
+ * // Example response
1755
+ * // {
1756
+ * // "matter": {}
1757
+ * // }
1758
+ * }
1759
+ *
1760
+ * main().catch(e => {
1761
+ * console.error(e);
1762
+ * throw e;
1763
+ * });
1764
+ *
1765
+ * ```
1267
1766
  *
1268
1767
  * @param params - Parameters for request
1269
1768
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1278,6 +1777,63 @@ export declare namespace vault_v1 {
1278
1777
  reopen(callback: BodyResponseCallback<Schema$ReopenMatterResponse>): void;
1279
1778
  /**
1280
1779
  * Undeletes the specified matter. Returns the matter with updated state.
1780
+ * @example
1781
+ * ```js
1782
+ * // Before running the sample:
1783
+ * // - Enable the API at:
1784
+ * // https://console.developers.google.com/apis/api/vault.googleapis.com
1785
+ * // - Login into gcloud by running:
1786
+ * // ```sh
1787
+ * // $ gcloud auth application-default login
1788
+ * // ```
1789
+ * // - Install the npm module by running:
1790
+ * // ```sh
1791
+ * // $ npm install googleapis
1792
+ * // ```
1793
+ *
1794
+ * const {google} = require('googleapis');
1795
+ * const vault = google.vault('v1');
1796
+ *
1797
+ * async function main() {
1798
+ * const auth = new google.auth.GoogleAuth({
1799
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
1800
+ * scopes: ['https://www.googleapis.com/auth/ediscovery'],
1801
+ * });
1802
+ *
1803
+ * // Acquire an auth client, and bind it to all future calls
1804
+ * const authClient = await auth.getClient();
1805
+ * google.options({auth: authClient});
1806
+ *
1807
+ * // Do the magic
1808
+ * const res = await vault.matters.undelete({
1809
+ * // The matter ID.
1810
+ * matterId: 'placeholder-value',
1811
+ *
1812
+ * // Request body metadata
1813
+ * requestBody: {
1814
+ * // request body parameters
1815
+ * // {}
1816
+ * },
1817
+ * });
1818
+ * console.log(res.data);
1819
+ *
1820
+ * // Example response
1821
+ * // {
1822
+ * // "description": "my_description",
1823
+ * // "matterId": "my_matterId",
1824
+ * // "matterPermissions": [],
1825
+ * // "matterRegion": "my_matterRegion",
1826
+ * // "name": "my_name",
1827
+ * // "state": "my_state"
1828
+ * // }
1829
+ * }
1830
+ *
1831
+ * main().catch(e => {
1832
+ * console.error(e);
1833
+ * throw e;
1834
+ * });
1835
+ *
1836
+ * ```
1281
1837
  *
1282
1838
  * @param params - Parameters for request
1283
1839
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1292,6 +1848,70 @@ export declare namespace vault_v1 {
1292
1848
  undelete(callback: BodyResponseCallback<Schema$Matter>): void;
1293
1849
  /**
1294
1850
  * 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.
1851
+ * @example
1852
+ * ```js
1853
+ * // Before running the sample:
1854
+ * // - Enable the API at:
1855
+ * // https://console.developers.google.com/apis/api/vault.googleapis.com
1856
+ * // - Login into gcloud by running:
1857
+ * // ```sh
1858
+ * // $ gcloud auth application-default login
1859
+ * // ```
1860
+ * // - Install the npm module by running:
1861
+ * // ```sh
1862
+ * // $ npm install googleapis
1863
+ * // ```
1864
+ *
1865
+ * const {google} = require('googleapis');
1866
+ * const vault = google.vault('v1');
1867
+ *
1868
+ * async function main() {
1869
+ * const auth = new google.auth.GoogleAuth({
1870
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
1871
+ * scopes: ['https://www.googleapis.com/auth/ediscovery'],
1872
+ * });
1873
+ *
1874
+ * // Acquire an auth client, and bind it to all future calls
1875
+ * const authClient = await auth.getClient();
1876
+ * google.options({auth: authClient});
1877
+ *
1878
+ * // Do the magic
1879
+ * const res = await vault.matters.update({
1880
+ * // The matter ID.
1881
+ * matterId: 'placeholder-value',
1882
+ *
1883
+ * // Request body metadata
1884
+ * requestBody: {
1885
+ * // request body parameters
1886
+ * // {
1887
+ * // "description": "my_description",
1888
+ * // "matterId": "my_matterId",
1889
+ * // "matterPermissions": [],
1890
+ * // "matterRegion": "my_matterRegion",
1891
+ * // "name": "my_name",
1892
+ * // "state": "my_state"
1893
+ * // }
1894
+ * },
1895
+ * });
1896
+ * console.log(res.data);
1897
+ *
1898
+ * // Example response
1899
+ * // {
1900
+ * // "description": "my_description",
1901
+ * // "matterId": "my_matterId",
1902
+ * // "matterPermissions": [],
1903
+ * // "matterRegion": "my_matterRegion",
1904
+ * // "name": "my_name",
1905
+ * // "state": "my_state"
1906
+ * // }
1907
+ * }
1908
+ *
1909
+ * main().catch(e => {
1910
+ * console.error(e);
1911
+ * throw e;
1912
+ * });
1913
+ *
1914
+ * ```
1295
1915
  *
1296
1916
  * @param params - Parameters for request
1297
1917
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1420,6 +2040,80 @@ export declare namespace vault_v1 {
1420
2040
  constructor(context: APIRequestContext);
1421
2041
  /**
1422
2042
  * Creates an export.
2043
+ * @example
2044
+ * ```js
2045
+ * // Before running the sample:
2046
+ * // - Enable the API at:
2047
+ * // https://console.developers.google.com/apis/api/vault.googleapis.com
2048
+ * // - Login into gcloud by running:
2049
+ * // ```sh
2050
+ * // $ gcloud auth application-default login
2051
+ * // ```
2052
+ * // - Install the npm module by running:
2053
+ * // ```sh
2054
+ * // $ npm install googleapis
2055
+ * // ```
2056
+ *
2057
+ * const {google} = require('googleapis');
2058
+ * const vault = google.vault('v1');
2059
+ *
2060
+ * async function main() {
2061
+ * const auth = new google.auth.GoogleAuth({
2062
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2063
+ * scopes: ['https://www.googleapis.com/auth/ediscovery'],
2064
+ * });
2065
+ *
2066
+ * // Acquire an auth client, and bind it to all future calls
2067
+ * const authClient = await auth.getClient();
2068
+ * google.options({auth: authClient});
2069
+ *
2070
+ * // Do the magic
2071
+ * const res = await vault.matters.exports.create({
2072
+ * // The matter ID.
2073
+ * matterId: 'placeholder-value',
2074
+ *
2075
+ * // Request body metadata
2076
+ * requestBody: {
2077
+ * // request body parameters
2078
+ * // {
2079
+ * // "cloudStorageSink": {},
2080
+ * // "createTime": "my_createTime",
2081
+ * // "exportOptions": {},
2082
+ * // "id": "my_id",
2083
+ * // "matterId": "my_matterId",
2084
+ * // "name": "my_name",
2085
+ * // "parentExportId": "my_parentExportId",
2086
+ * // "query": {},
2087
+ * // "requester": {},
2088
+ * // "stats": {},
2089
+ * // "status": "my_status"
2090
+ * // }
2091
+ * },
2092
+ * });
2093
+ * console.log(res.data);
2094
+ *
2095
+ * // Example response
2096
+ * // {
2097
+ * // "cloudStorageSink": {},
2098
+ * // "createTime": "my_createTime",
2099
+ * // "exportOptions": {},
2100
+ * // "id": "my_id",
2101
+ * // "matterId": "my_matterId",
2102
+ * // "name": "my_name",
2103
+ * // "parentExportId": "my_parentExportId",
2104
+ * // "query": {},
2105
+ * // "requester": {},
2106
+ * // "stats": {},
2107
+ * // "status": "my_status"
2108
+ * // }
2109
+ * }
2110
+ *
2111
+ * main().catch(e => {
2112
+ * console.error(e);
2113
+ * throw e;
2114
+ * });
2115
+ *
2116
+ * ```
1423
2117
  *
1424
2118
  * @param params - Parameters for request
1425
2119
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1434,6 +2128,52 @@ export declare namespace vault_v1 {
1434
2128
  create(callback: BodyResponseCallback<Schema$Export>): void;
1435
2129
  /**
1436
2130
  * Deletes an export.
2131
+ * @example
2132
+ * ```js
2133
+ * // Before running the sample:
2134
+ * // - Enable the API at:
2135
+ * // https://console.developers.google.com/apis/api/vault.googleapis.com
2136
+ * // - Login into gcloud by running:
2137
+ * // ```sh
2138
+ * // $ gcloud auth application-default login
2139
+ * // ```
2140
+ * // - Install the npm module by running:
2141
+ * // ```sh
2142
+ * // $ npm install googleapis
2143
+ * // ```
2144
+ *
2145
+ * const {google} = require('googleapis');
2146
+ * const vault = google.vault('v1');
2147
+ *
2148
+ * async function main() {
2149
+ * const auth = new google.auth.GoogleAuth({
2150
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2151
+ * scopes: ['https://www.googleapis.com/auth/ediscovery'],
2152
+ * });
2153
+ *
2154
+ * // Acquire an auth client, and bind it to all future calls
2155
+ * const authClient = await auth.getClient();
2156
+ * google.options({auth: authClient});
2157
+ *
2158
+ * // Do the magic
2159
+ * const res = await vault.matters.exports.delete({
2160
+ * // The export ID.
2161
+ * exportId: 'placeholder-value',
2162
+ * // The matter ID.
2163
+ * matterId: 'placeholder-value',
2164
+ * });
2165
+ * console.log(res.data);
2166
+ *
2167
+ * // Example response
2168
+ * // {}
2169
+ * }
2170
+ *
2171
+ * main().catch(e => {
2172
+ * console.error(e);
2173
+ * throw e;
2174
+ * });
2175
+ *
2176
+ * ```
1437
2177
  *
1438
2178
  * @param params - Parameters for request
1439
2179
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1448,6 +2188,67 @@ export declare namespace vault_v1 {
1448
2188
  delete(callback: BodyResponseCallback<Schema$Empty>): void;
1449
2189
  /**
1450
2190
  * Gets an export.
2191
+ * @example
2192
+ * ```js
2193
+ * // Before running the sample:
2194
+ * // - Enable the API at:
2195
+ * // https://console.developers.google.com/apis/api/vault.googleapis.com
2196
+ * // - Login into gcloud by running:
2197
+ * // ```sh
2198
+ * // $ gcloud auth application-default login
2199
+ * // ```
2200
+ * // - Install the npm module by running:
2201
+ * // ```sh
2202
+ * // $ npm install googleapis
2203
+ * // ```
2204
+ *
2205
+ * const {google} = require('googleapis');
2206
+ * const vault = google.vault('v1');
2207
+ *
2208
+ * async function main() {
2209
+ * const auth = new google.auth.GoogleAuth({
2210
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2211
+ * scopes: [
2212
+ * 'https://www.googleapis.com/auth/ediscovery',
2213
+ * 'https://www.googleapis.com/auth/ediscovery.readonly',
2214
+ * ],
2215
+ * });
2216
+ *
2217
+ * // Acquire an auth client, and bind it to all future calls
2218
+ * const authClient = await auth.getClient();
2219
+ * google.options({auth: authClient});
2220
+ *
2221
+ * // Do the magic
2222
+ * const res = await vault.matters.exports.get({
2223
+ * // The export ID.
2224
+ * exportId: 'placeholder-value',
2225
+ * // The matter ID.
2226
+ * matterId: 'placeholder-value',
2227
+ * });
2228
+ * console.log(res.data);
2229
+ *
2230
+ * // Example response
2231
+ * // {
2232
+ * // "cloudStorageSink": {},
2233
+ * // "createTime": "my_createTime",
2234
+ * // "exportOptions": {},
2235
+ * // "id": "my_id",
2236
+ * // "matterId": "my_matterId",
2237
+ * // "name": "my_name",
2238
+ * // "parentExportId": "my_parentExportId",
2239
+ * // "query": {},
2240
+ * // "requester": {},
2241
+ * // "stats": {},
2242
+ * // "status": "my_status"
2243
+ * // }
2244
+ * }
2245
+ *
2246
+ * main().catch(e => {
2247
+ * console.error(e);
2248
+ * throw e;
2249
+ * });
2250
+ *
2251
+ * ```
1451
2252
  *
1452
2253
  * @param params - Parameters for request
1453
2254
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1462,6 +2263,60 @@ export declare namespace vault_v1 {
1462
2263
  get(callback: BodyResponseCallback<Schema$Export>): void;
1463
2264
  /**
1464
2265
  * Lists details about the exports in the specified matter.
2266
+ * @example
2267
+ * ```js
2268
+ * // Before running the sample:
2269
+ * // - Enable the API at:
2270
+ * // https://console.developers.google.com/apis/api/vault.googleapis.com
2271
+ * // - Login into gcloud by running:
2272
+ * // ```sh
2273
+ * // $ gcloud auth application-default login
2274
+ * // ```
2275
+ * // - Install the npm module by running:
2276
+ * // ```sh
2277
+ * // $ npm install googleapis
2278
+ * // ```
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: [
2287
+ * 'https://www.googleapis.com/auth/ediscovery',
2288
+ * 'https://www.googleapis.com/auth/ediscovery.readonly',
2289
+ * ],
2290
+ * });
2291
+ *
2292
+ * // Acquire an auth client, and bind it to all future calls
2293
+ * const authClient = await auth.getClient();
2294
+ * google.options({auth: authClient});
2295
+ *
2296
+ * // Do the magic
2297
+ * const res = await vault.matters.exports.list({
2298
+ * // The matter ID.
2299
+ * matterId: 'placeholder-value',
2300
+ * // The number of exports to return in the response.
2301
+ * pageSize: 'placeholder-value',
2302
+ * // The pagination token as returned in the response.
2303
+ * pageToken: 'placeholder-value',
2304
+ * });
2305
+ * console.log(res.data);
2306
+ *
2307
+ * // Example response
2308
+ * // {
2309
+ * // "exports": [],
2310
+ * // "nextPageToken": "my_nextPageToken"
2311
+ * // }
2312
+ * }
2313
+ *
2314
+ * main().catch(e => {
2315
+ * console.error(e);
2316
+ * throw e;
2317
+ * });
2318
+ *
2319
+ * ```
1465
2320
  *
1466
2321
  * @param params - Parameters for request
1467
2322
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1525,6 +2380,63 @@ export declare namespace vault_v1 {
1525
2380
  constructor(context: APIRequestContext);
1526
2381
  /**
1527
2382
  * 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.
2383
+ * @example
2384
+ * ```js
2385
+ * // Before running the sample:
2386
+ * // - Enable the API at:
2387
+ * // https://console.developers.google.com/apis/api/vault.googleapis.com
2388
+ * // - Login into gcloud by running:
2389
+ * // ```sh
2390
+ * // $ gcloud auth application-default login
2391
+ * // ```
2392
+ * // - Install the npm module by running:
2393
+ * // ```sh
2394
+ * // $ npm install googleapis
2395
+ * // ```
2396
+ *
2397
+ * const {google} = require('googleapis');
2398
+ * const vault = google.vault('v1');
2399
+ *
2400
+ * async function main() {
2401
+ * const auth = new google.auth.GoogleAuth({
2402
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2403
+ * scopes: ['https://www.googleapis.com/auth/ediscovery'],
2404
+ * });
2405
+ *
2406
+ * // Acquire an auth client, and bind it to all future calls
2407
+ * const authClient = await auth.getClient();
2408
+ * google.options({auth: authClient});
2409
+ *
2410
+ * // Do the magic
2411
+ * const res = await vault.matters.holds.addHeldAccounts({
2412
+ * // The hold ID.
2413
+ * holdId: 'placeholder-value',
2414
+ * // The matter ID.
2415
+ * matterId: 'placeholder-value',
2416
+ *
2417
+ * // Request body metadata
2418
+ * requestBody: {
2419
+ * // request body parameters
2420
+ * // {
2421
+ * // "accountIds": [],
2422
+ * // "emails": []
2423
+ * // }
2424
+ * },
2425
+ * });
2426
+ * console.log(res.data);
2427
+ *
2428
+ * // Example response
2429
+ * // {
2430
+ * // "responses": []
2431
+ * // }
2432
+ * }
2433
+ *
2434
+ * main().catch(e => {
2435
+ * console.error(e);
2436
+ * throw e;
2437
+ * });
2438
+ *
2439
+ * ```
1528
2440
  *
1529
2441
  * @param params - Parameters for request
1530
2442
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1539,6 +2451,72 @@ export declare namespace vault_v1 {
1539
2451
  addHeldAccounts(callback: BodyResponseCallback<Schema$AddHeldAccountsResponse>): void;
1540
2452
  /**
1541
2453
  * Creates a hold in the specified matter.
2454
+ * @example
2455
+ * ```js
2456
+ * // Before running the sample:
2457
+ * // - Enable the API at:
2458
+ * // https://console.developers.google.com/apis/api/vault.googleapis.com
2459
+ * // - Login into gcloud by running:
2460
+ * // ```sh
2461
+ * // $ gcloud auth application-default login
2462
+ * // ```
2463
+ * // - Install the npm module by running:
2464
+ * // ```sh
2465
+ * // $ npm install googleapis
2466
+ * // ```
2467
+ *
2468
+ * const {google} = require('googleapis');
2469
+ * const vault = google.vault('v1');
2470
+ *
2471
+ * async function main() {
2472
+ * const auth = new google.auth.GoogleAuth({
2473
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2474
+ * scopes: ['https://www.googleapis.com/auth/ediscovery'],
2475
+ * });
2476
+ *
2477
+ * // Acquire an auth client, and bind it to all future calls
2478
+ * const authClient = await auth.getClient();
2479
+ * google.options({auth: authClient});
2480
+ *
2481
+ * // Do the magic
2482
+ * const res = await vault.matters.holds.create({
2483
+ * // The matter ID.
2484
+ * matterId: 'placeholder-value',
2485
+ *
2486
+ * // Request body metadata
2487
+ * requestBody: {
2488
+ * // request body parameters
2489
+ * // {
2490
+ * // "accounts": [],
2491
+ * // "corpus": "my_corpus",
2492
+ * // "holdId": "my_holdId",
2493
+ * // "name": "my_name",
2494
+ * // "orgUnit": {},
2495
+ * // "query": {},
2496
+ * // "updateTime": "my_updateTime"
2497
+ * // }
2498
+ * },
2499
+ * });
2500
+ * console.log(res.data);
2501
+ *
2502
+ * // Example response
2503
+ * // {
2504
+ * // "accounts": [],
2505
+ * // "corpus": "my_corpus",
2506
+ * // "holdId": "my_holdId",
2507
+ * // "name": "my_name",
2508
+ * // "orgUnit": {},
2509
+ * // "query": {},
2510
+ * // "updateTime": "my_updateTime"
2511
+ * // }
2512
+ * }
2513
+ *
2514
+ * main().catch(e => {
2515
+ * console.error(e);
2516
+ * throw e;
2517
+ * });
2518
+ *
2519
+ * ```
1542
2520
  *
1543
2521
  * @param params - Parameters for request
1544
2522
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1553,6 +2531,52 @@ export declare namespace vault_v1 {
1553
2531
  create(callback: BodyResponseCallback<Schema$Hold>): void;
1554
2532
  /**
1555
2533
  * 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.
2534
+ * @example
2535
+ * ```js
2536
+ * // Before running the sample:
2537
+ * // - Enable the API at:
2538
+ * // https://console.developers.google.com/apis/api/vault.googleapis.com
2539
+ * // - Login into gcloud by running:
2540
+ * // ```sh
2541
+ * // $ gcloud auth application-default login
2542
+ * // ```
2543
+ * // - Install the npm module by running:
2544
+ * // ```sh
2545
+ * // $ npm install googleapis
2546
+ * // ```
2547
+ *
2548
+ * const {google} = require('googleapis');
2549
+ * const vault = google.vault('v1');
2550
+ *
2551
+ * async function main() {
2552
+ * const auth = new google.auth.GoogleAuth({
2553
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2554
+ * scopes: ['https://www.googleapis.com/auth/ediscovery'],
2555
+ * });
2556
+ *
2557
+ * // Acquire an auth client, and bind it to all future calls
2558
+ * const authClient = await auth.getClient();
2559
+ * google.options({auth: authClient});
2560
+ *
2561
+ * // Do the magic
2562
+ * const res = await vault.matters.holds.delete({
2563
+ * // The hold ID.
2564
+ * holdId: 'placeholder-value',
2565
+ * // The matter ID.
2566
+ * matterId: 'placeholder-value',
2567
+ * });
2568
+ * console.log(res.data);
2569
+ *
2570
+ * // Example response
2571
+ * // {}
2572
+ * }
2573
+ *
2574
+ * main().catch(e => {
2575
+ * console.error(e);
2576
+ * throw e;
2577
+ * });
2578
+ *
2579
+ * ```
1556
2580
  *
1557
2581
  * @param params - Parameters for request
1558
2582
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1567,6 +2591,65 @@ export declare namespace vault_v1 {
1567
2591
  delete(callback: BodyResponseCallback<Schema$Empty>): void;
1568
2592
  /**
1569
2593
  * Gets the specified hold.
2594
+ * @example
2595
+ * ```js
2596
+ * // Before running the sample:
2597
+ * // - Enable the API at:
2598
+ * // https://console.developers.google.com/apis/api/vault.googleapis.com
2599
+ * // - Login into gcloud by running:
2600
+ * // ```sh
2601
+ * // $ gcloud auth application-default login
2602
+ * // ```
2603
+ * // - Install the npm module by running:
2604
+ * // ```sh
2605
+ * // $ npm install googleapis
2606
+ * // ```
2607
+ *
2608
+ * const {google} = require('googleapis');
2609
+ * const vault = google.vault('v1');
2610
+ *
2611
+ * async function main() {
2612
+ * const auth = new google.auth.GoogleAuth({
2613
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2614
+ * scopes: [
2615
+ * 'https://www.googleapis.com/auth/ediscovery',
2616
+ * 'https://www.googleapis.com/auth/ediscovery.readonly',
2617
+ * ],
2618
+ * });
2619
+ *
2620
+ * // Acquire an auth client, and bind it to all future calls
2621
+ * const authClient = await auth.getClient();
2622
+ * google.options({auth: authClient});
2623
+ *
2624
+ * // Do the magic
2625
+ * const res = await vault.matters.holds.get({
2626
+ * // The hold ID.
2627
+ * holdId: 'placeholder-value',
2628
+ * // The matter ID.
2629
+ * matterId: 'placeholder-value',
2630
+ * // The amount of detail to return for a hold.
2631
+ * view: 'placeholder-value',
2632
+ * });
2633
+ * console.log(res.data);
2634
+ *
2635
+ * // Example response
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
+ * main().catch(e => {
2648
+ * console.error(e);
2649
+ * throw e;
2650
+ * });
2651
+ *
2652
+ * ```
1570
2653
  *
1571
2654
  * @param params - Parameters for request
1572
2655
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1581,6 +2664,62 @@ export declare namespace vault_v1 {
1581
2664
  get(callback: BodyResponseCallback<Schema$Hold>): void;
1582
2665
  /**
1583
2666
  * Lists the holds in a matter.
2667
+ * @example
2668
+ * ```js
2669
+ * // Before running the sample:
2670
+ * // - Enable the API at:
2671
+ * // https://console.developers.google.com/apis/api/vault.googleapis.com
2672
+ * // - Login into gcloud by running:
2673
+ * // ```sh
2674
+ * // $ gcloud auth application-default login
2675
+ * // ```
2676
+ * // - Install the npm module by running:
2677
+ * // ```sh
2678
+ * // $ npm install googleapis
2679
+ * // ```
2680
+ *
2681
+ * const {google} = require('googleapis');
2682
+ * const vault = google.vault('v1');
2683
+ *
2684
+ * async function main() {
2685
+ * const auth = new google.auth.GoogleAuth({
2686
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2687
+ * scopes: [
2688
+ * 'https://www.googleapis.com/auth/ediscovery',
2689
+ * 'https://www.googleapis.com/auth/ediscovery.readonly',
2690
+ * ],
2691
+ * });
2692
+ *
2693
+ * // Acquire an auth client, and bind it to all future calls
2694
+ * const authClient = await auth.getClient();
2695
+ * google.options({auth: authClient});
2696
+ *
2697
+ * // Do the magic
2698
+ * const res = await vault.matters.holds.list({
2699
+ * // The matter ID.
2700
+ * matterId: 'placeholder-value',
2701
+ * // 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.
2702
+ * pageSize: 'placeholder-value',
2703
+ * // The pagination token as returned in the response. An empty token means start from the beginning.
2704
+ * pageToken: 'placeholder-value',
2705
+ * // The amount of detail to return for a hold.
2706
+ * view: 'placeholder-value',
2707
+ * });
2708
+ * console.log(res.data);
2709
+ *
2710
+ * // Example response
2711
+ * // {
2712
+ * // "holds": [],
2713
+ * // "nextPageToken": "my_nextPageToken"
2714
+ * // }
2715
+ * }
2716
+ *
2717
+ * main().catch(e => {
2718
+ * console.error(e);
2719
+ * throw e;
2720
+ * });
2721
+ *
2722
+ * ```
1584
2723
  *
1585
2724
  * @param params - Parameters for request
1586
2725
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1595,6 +2734,62 @@ export declare namespace vault_v1 {
1595
2734
  list(callback: BodyResponseCallback<Schema$ListHoldsResponse>): void;
1596
2735
  /**
1597
2736
  * Removes the specified accounts from a hold. Returns a list of statuses in the same order as the request.
2737
+ * @example
2738
+ * ```js
2739
+ * // Before running the sample:
2740
+ * // - Enable the API at:
2741
+ * // https://console.developers.google.com/apis/api/vault.googleapis.com
2742
+ * // - Login into gcloud by running:
2743
+ * // ```sh
2744
+ * // $ gcloud auth application-default login
2745
+ * // ```
2746
+ * // - Install the npm module by running:
2747
+ * // ```sh
2748
+ * // $ npm install googleapis
2749
+ * // ```
2750
+ *
2751
+ * const {google} = require('googleapis');
2752
+ * const vault = google.vault('v1');
2753
+ *
2754
+ * async function main() {
2755
+ * const auth = new google.auth.GoogleAuth({
2756
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2757
+ * scopes: ['https://www.googleapis.com/auth/ediscovery'],
2758
+ * });
2759
+ *
2760
+ * // Acquire an auth client, and bind it to all future calls
2761
+ * const authClient = await auth.getClient();
2762
+ * google.options({auth: authClient});
2763
+ *
2764
+ * // Do the magic
2765
+ * const res = await vault.matters.holds.removeHeldAccounts({
2766
+ * // The hold ID.
2767
+ * holdId: 'placeholder-value',
2768
+ * // The matter ID.
2769
+ * matterId: 'placeholder-value',
2770
+ *
2771
+ * // Request body metadata
2772
+ * requestBody: {
2773
+ * // request body parameters
2774
+ * // {
2775
+ * // "accountIds": []
2776
+ * // }
2777
+ * },
2778
+ * });
2779
+ * console.log(res.data);
2780
+ *
2781
+ * // Example response
2782
+ * // {
2783
+ * // "statuses": []
2784
+ * // }
2785
+ * }
2786
+ *
2787
+ * main().catch(e => {
2788
+ * console.error(e);
2789
+ * throw e;
2790
+ * });
2791
+ *
2792
+ * ```
1598
2793
  *
1599
2794
  * @param params - Parameters for request
1600
2795
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1609,6 +2804,74 @@ export declare namespace vault_v1 {
1609
2804
  removeHeldAccounts(callback: BodyResponseCallback<Schema$RemoveHeldAccountsResponse>): void;
1610
2805
  /**
1611
2806
  * 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.
2807
+ * @example
2808
+ * ```js
2809
+ * // Before running the sample:
2810
+ * // - Enable the API at:
2811
+ * // https://console.developers.google.com/apis/api/vault.googleapis.com
2812
+ * // - Login into gcloud by running:
2813
+ * // ```sh
2814
+ * // $ gcloud auth application-default login
2815
+ * // ```
2816
+ * // - Install the npm module by running:
2817
+ * // ```sh
2818
+ * // $ npm install googleapis
2819
+ * // ```
2820
+ *
2821
+ * const {google} = require('googleapis');
2822
+ * const vault = google.vault('v1');
2823
+ *
2824
+ * async function main() {
2825
+ * const auth = new google.auth.GoogleAuth({
2826
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2827
+ * scopes: ['https://www.googleapis.com/auth/ediscovery'],
2828
+ * });
2829
+ *
2830
+ * // Acquire an auth client, and bind it to all future calls
2831
+ * const authClient = await auth.getClient();
2832
+ * google.options({auth: authClient});
2833
+ *
2834
+ * // Do the magic
2835
+ * const res = await vault.matters.holds.update({
2836
+ * // The ID of the hold.
2837
+ * holdId: 'placeholder-value',
2838
+ * // The matter ID.
2839
+ * matterId: 'placeholder-value',
2840
+ *
2841
+ * // Request body metadata
2842
+ * requestBody: {
2843
+ * // request body parameters
2844
+ * // {
2845
+ * // "accounts": [],
2846
+ * // "corpus": "my_corpus",
2847
+ * // "holdId": "my_holdId",
2848
+ * // "name": "my_name",
2849
+ * // "orgUnit": {},
2850
+ * // "query": {},
2851
+ * // "updateTime": "my_updateTime"
2852
+ * // }
2853
+ * },
2854
+ * });
2855
+ * console.log(res.data);
2856
+ *
2857
+ * // Example response
2858
+ * // {
2859
+ * // "accounts": [],
2860
+ * // "corpus": "my_corpus",
2861
+ * // "holdId": "my_holdId",
2862
+ * // "name": "my_name",
2863
+ * // "orgUnit": {},
2864
+ * // "query": {},
2865
+ * // "updateTime": "my_updateTime"
2866
+ * // }
2867
+ * }
2868
+ *
2869
+ * main().catch(e => {
2870
+ * console.error(e);
2871
+ * throw e;
2872
+ * });
2873
+ *
2874
+ * ```
1612
2875
  *
1613
2876
  * @param params - Parameters for request
1614
2877
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1721,6 +2984,70 @@ export declare namespace vault_v1 {
1721
2984
  constructor(context: APIRequestContext);
1722
2985
  /**
1723
2986
  * 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.
2987
+ * @example
2988
+ * ```js
2989
+ * // Before running the sample:
2990
+ * // - Enable the API at:
2991
+ * // https://console.developers.google.com/apis/api/vault.googleapis.com
2992
+ * // - Login into gcloud by running:
2993
+ * // ```sh
2994
+ * // $ gcloud auth application-default login
2995
+ * // ```
2996
+ * // - Install the npm module by running:
2997
+ * // ```sh
2998
+ * // $ npm install googleapis
2999
+ * // ```
3000
+ *
3001
+ * const {google} = require('googleapis');
3002
+ * const vault = google.vault('v1');
3003
+ *
3004
+ * async function main() {
3005
+ * const auth = new google.auth.GoogleAuth({
3006
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3007
+ * scopes: ['https://www.googleapis.com/auth/ediscovery'],
3008
+ * });
3009
+ *
3010
+ * // Acquire an auth client, and bind it to all future calls
3011
+ * const authClient = await auth.getClient();
3012
+ * google.options({auth: authClient});
3013
+ *
3014
+ * // Do the magic
3015
+ * const res = await vault.matters.holds.accounts.create({
3016
+ * // The hold ID.
3017
+ * holdId: 'placeholder-value',
3018
+ * // The matter ID.
3019
+ * matterId: 'placeholder-value',
3020
+ *
3021
+ * // Request body metadata
3022
+ * requestBody: {
3023
+ * // request body parameters
3024
+ * // {
3025
+ * // "accountId": "my_accountId",
3026
+ * // "email": "my_email",
3027
+ * // "firstName": "my_firstName",
3028
+ * // "holdTime": "my_holdTime",
3029
+ * // "lastName": "my_lastName"
3030
+ * // }
3031
+ * },
3032
+ * });
3033
+ * console.log(res.data);
3034
+ *
3035
+ * // Example response
3036
+ * // {
3037
+ * // "accountId": "my_accountId",
3038
+ * // "email": "my_email",
3039
+ * // "firstName": "my_firstName",
3040
+ * // "holdTime": "my_holdTime",
3041
+ * // "lastName": "my_lastName"
3042
+ * // }
3043
+ * }
3044
+ *
3045
+ * main().catch(e => {
3046
+ * console.error(e);
3047
+ * throw e;
3048
+ * });
3049
+ *
3050
+ * ```
1724
3051
  *
1725
3052
  * @param params - Parameters for request
1726
3053
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1735,6 +3062,54 @@ export declare namespace vault_v1 {
1735
3062
  create(callback: BodyResponseCallback<Schema$HeldAccount>): void;
1736
3063
  /**
1737
3064
  * Removes an account from a hold.
3065
+ * @example
3066
+ * ```js
3067
+ * // Before running the sample:
3068
+ * // - Enable the API at:
3069
+ * // https://console.developers.google.com/apis/api/vault.googleapis.com
3070
+ * // - Login into gcloud by running:
3071
+ * // ```sh
3072
+ * // $ gcloud auth application-default login
3073
+ * // ```
3074
+ * // - Install the npm module by running:
3075
+ * // ```sh
3076
+ * // $ npm install googleapis
3077
+ * // ```
3078
+ *
3079
+ * const {google} = require('googleapis');
3080
+ * const vault = google.vault('v1');
3081
+ *
3082
+ * async function main() {
3083
+ * const auth = new google.auth.GoogleAuth({
3084
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3085
+ * scopes: ['https://www.googleapis.com/auth/ediscovery'],
3086
+ * });
3087
+ *
3088
+ * // Acquire an auth client, and bind it to all future calls
3089
+ * const authClient = await auth.getClient();
3090
+ * google.options({auth: authClient});
3091
+ *
3092
+ * // Do the magic
3093
+ * const res = await vault.matters.holds.accounts.delete({
3094
+ * // The ID of the account to remove from the hold.
3095
+ * accountId: 'placeholder-value',
3096
+ * // The hold ID.
3097
+ * holdId: 'placeholder-value',
3098
+ * // The matter ID.
3099
+ * matterId: 'placeholder-value',
3100
+ * });
3101
+ * console.log(res.data);
3102
+ *
3103
+ * // Example response
3104
+ * // {}
3105
+ * }
3106
+ *
3107
+ * main().catch(e => {
3108
+ * console.error(e);
3109
+ * throw e;
3110
+ * });
3111
+ *
3112
+ * ```
1738
3113
  *
1739
3114
  * @param params - Parameters for request
1740
3115
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1749,6 +3124,57 @@ export declare namespace vault_v1 {
1749
3124
  delete(callback: BodyResponseCallback<Schema$Empty>): void;
1750
3125
  /**
1751
3126
  * 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.
3127
+ * @example
3128
+ * ```js
3129
+ * // Before running the sample:
3130
+ * // - Enable the API at:
3131
+ * // https://console.developers.google.com/apis/api/vault.googleapis.com
3132
+ * // - Login into gcloud by running:
3133
+ * // ```sh
3134
+ * // $ gcloud auth application-default login
3135
+ * // ```
3136
+ * // - Install the npm module by running:
3137
+ * // ```sh
3138
+ * // $ npm install googleapis
3139
+ * // ```
3140
+ *
3141
+ * const {google} = require('googleapis');
3142
+ * const vault = google.vault('v1');
3143
+ *
3144
+ * async function main() {
3145
+ * const auth = new google.auth.GoogleAuth({
3146
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3147
+ * scopes: [
3148
+ * 'https://www.googleapis.com/auth/ediscovery',
3149
+ * 'https://www.googleapis.com/auth/ediscovery.readonly',
3150
+ * ],
3151
+ * });
3152
+ *
3153
+ * // Acquire an auth client, and bind it to all future calls
3154
+ * const authClient = await auth.getClient();
3155
+ * google.options({auth: authClient});
3156
+ *
3157
+ * // Do the magic
3158
+ * const res = await vault.matters.holds.accounts.list({
3159
+ * // The hold ID.
3160
+ * holdId: 'placeholder-value',
3161
+ * // The matter ID.
3162
+ * matterId: 'placeholder-value',
3163
+ * });
3164
+ * console.log(res.data);
3165
+ *
3166
+ * // Example response
3167
+ * // {
3168
+ * // "accounts": []
3169
+ * // }
3170
+ * }
3171
+ *
3172
+ * main().catch(e => {
3173
+ * console.error(e);
3174
+ * throw e;
3175
+ * });
3176
+ *
3177
+ * ```
1752
3178
  *
1753
3179
  * @param params - Parameters for request
1754
3180
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1805,6 +3231,68 @@ export declare namespace vault_v1 {
1805
3231
  constructor(context: APIRequestContext);
1806
3232
  /**
1807
3233
  * Creates a saved query.
3234
+ * @example
3235
+ * ```js
3236
+ * // Before running the sample:
3237
+ * // - Enable the API at:
3238
+ * // https://console.developers.google.com/apis/api/vault.googleapis.com
3239
+ * // - Login into gcloud by running:
3240
+ * // ```sh
3241
+ * // $ gcloud auth application-default login
3242
+ * // ```
3243
+ * // - Install the npm module by running:
3244
+ * // ```sh
3245
+ * // $ npm install googleapis
3246
+ * // ```
3247
+ *
3248
+ * const {google} = require('googleapis');
3249
+ * const vault = google.vault('v1');
3250
+ *
3251
+ * async function main() {
3252
+ * const auth = new google.auth.GoogleAuth({
3253
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3254
+ * scopes: ['https://www.googleapis.com/auth/ediscovery'],
3255
+ * });
3256
+ *
3257
+ * // Acquire an auth client, and bind it to all future calls
3258
+ * const authClient = await auth.getClient();
3259
+ * google.options({auth: authClient});
3260
+ *
3261
+ * // Do the magic
3262
+ * const res = await vault.matters.savedQueries.create({
3263
+ * // The ID of the matter to create the saved query in.
3264
+ * matterId: 'placeholder-value',
3265
+ *
3266
+ * // Request body metadata
3267
+ * requestBody: {
3268
+ * // request body parameters
3269
+ * // {
3270
+ * // "createTime": "my_createTime",
3271
+ * // "displayName": "my_displayName",
3272
+ * // "matterId": "my_matterId",
3273
+ * // "query": {},
3274
+ * // "savedQueryId": "my_savedQueryId"
3275
+ * // }
3276
+ * },
3277
+ * });
3278
+ * console.log(res.data);
3279
+ *
3280
+ * // Example response
3281
+ * // {
3282
+ * // "createTime": "my_createTime",
3283
+ * // "displayName": "my_displayName",
3284
+ * // "matterId": "my_matterId",
3285
+ * // "query": {},
3286
+ * // "savedQueryId": "my_savedQueryId"
3287
+ * // }
3288
+ * }
3289
+ *
3290
+ * main().catch(e => {
3291
+ * console.error(e);
3292
+ * throw e;
3293
+ * });
3294
+ *
3295
+ * ```
1808
3296
  *
1809
3297
  * @param params - Parameters for request
1810
3298
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1819,6 +3307,52 @@ export declare namespace vault_v1 {
1819
3307
  create(callback: BodyResponseCallback<Schema$SavedQuery>): void;
1820
3308
  /**
1821
3309
  * Deletes the specified saved query.
3310
+ * @example
3311
+ * ```js
3312
+ * // Before running the sample:
3313
+ * // - Enable the API at:
3314
+ * // https://console.developers.google.com/apis/api/vault.googleapis.com
3315
+ * // - Login into gcloud by running:
3316
+ * // ```sh
3317
+ * // $ gcloud auth application-default login
3318
+ * // ```
3319
+ * // - Install the npm module by running:
3320
+ * // ```sh
3321
+ * // $ npm install googleapis
3322
+ * // ```
3323
+ *
3324
+ * const {google} = require('googleapis');
3325
+ * const vault = google.vault('v1');
3326
+ *
3327
+ * async function main() {
3328
+ * const auth = new google.auth.GoogleAuth({
3329
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3330
+ * scopes: ['https://www.googleapis.com/auth/ediscovery'],
3331
+ * });
3332
+ *
3333
+ * // Acquire an auth client, and bind it to all future calls
3334
+ * const authClient = await auth.getClient();
3335
+ * google.options({auth: authClient});
3336
+ *
3337
+ * // Do the magic
3338
+ * const res = await vault.matters.savedQueries.delete({
3339
+ * // The ID of the matter to delete the saved query from.
3340
+ * matterId: 'placeholder-value',
3341
+ * // ID of the saved query to delete.
3342
+ * savedQueryId: 'placeholder-value',
3343
+ * });
3344
+ * console.log(res.data);
3345
+ *
3346
+ * // Example response
3347
+ * // {}
3348
+ * }
3349
+ *
3350
+ * main().catch(e => {
3351
+ * console.error(e);
3352
+ * throw e;
3353
+ * });
3354
+ *
3355
+ * ```
1822
3356
  *
1823
3357
  * @param params - Parameters for request
1824
3358
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1833,6 +3367,61 @@ export declare namespace vault_v1 {
1833
3367
  delete(callback: BodyResponseCallback<Schema$Empty>): void;
1834
3368
  /**
1835
3369
  * Retrieves the specified saved query.
3370
+ * @example
3371
+ * ```js
3372
+ * // Before running the sample:
3373
+ * // - Enable the API at:
3374
+ * // https://console.developers.google.com/apis/api/vault.googleapis.com
3375
+ * // - Login into gcloud by running:
3376
+ * // ```sh
3377
+ * // $ gcloud auth application-default login
3378
+ * // ```
3379
+ * // - Install the npm module by running:
3380
+ * // ```sh
3381
+ * // $ npm install googleapis
3382
+ * // ```
3383
+ *
3384
+ * const {google} = require('googleapis');
3385
+ * const vault = google.vault('v1');
3386
+ *
3387
+ * async function main() {
3388
+ * const auth = new google.auth.GoogleAuth({
3389
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3390
+ * scopes: [
3391
+ * 'https://www.googleapis.com/auth/ediscovery',
3392
+ * 'https://www.googleapis.com/auth/ediscovery.readonly',
3393
+ * ],
3394
+ * });
3395
+ *
3396
+ * // Acquire an auth client, and bind it to all future calls
3397
+ * const authClient = await auth.getClient();
3398
+ * google.options({auth: authClient});
3399
+ *
3400
+ * // Do the magic
3401
+ * const res = await vault.matters.savedQueries.get({
3402
+ * // The ID of the matter to get the saved query from.
3403
+ * matterId: 'placeholder-value',
3404
+ * // ID of the saved query to retrieve.
3405
+ * savedQueryId: 'placeholder-value',
3406
+ * });
3407
+ * console.log(res.data);
3408
+ *
3409
+ * // Example response
3410
+ * // {
3411
+ * // "createTime": "my_createTime",
3412
+ * // "displayName": "my_displayName",
3413
+ * // "matterId": "my_matterId",
3414
+ * // "query": {},
3415
+ * // "savedQueryId": "my_savedQueryId"
3416
+ * // }
3417
+ * }
3418
+ *
3419
+ * main().catch(e => {
3420
+ * console.error(e);
3421
+ * throw e;
3422
+ * });
3423
+ *
3424
+ * ```
1836
3425
  *
1837
3426
  * @param params - Parameters for request
1838
3427
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1847,6 +3436,60 @@ export declare namespace vault_v1 {
1847
3436
  get(callback: BodyResponseCallback<Schema$SavedQuery>): void;
1848
3437
  /**
1849
3438
  * Lists the saved queries in a matter.
3439
+ * @example
3440
+ * ```js
3441
+ * // Before running the sample:
3442
+ * // - Enable the API at:
3443
+ * // https://console.developers.google.com/apis/api/vault.googleapis.com
3444
+ * // - Login into gcloud by running:
3445
+ * // ```sh
3446
+ * // $ gcloud auth application-default login
3447
+ * // ```
3448
+ * // - Install the npm module by running:
3449
+ * // ```sh
3450
+ * // $ npm install googleapis
3451
+ * // ```
3452
+ *
3453
+ * const {google} = require('googleapis');
3454
+ * const vault = google.vault('v1');
3455
+ *
3456
+ * async function main() {
3457
+ * const auth = new google.auth.GoogleAuth({
3458
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3459
+ * scopes: [
3460
+ * 'https://www.googleapis.com/auth/ediscovery',
3461
+ * 'https://www.googleapis.com/auth/ediscovery.readonly',
3462
+ * ],
3463
+ * });
3464
+ *
3465
+ * // Acquire an auth client, and bind it to all future calls
3466
+ * const authClient = await auth.getClient();
3467
+ * google.options({auth: authClient});
3468
+ *
3469
+ * // Do the magic
3470
+ * const res = await vault.matters.savedQueries.list({
3471
+ * // The ID of the matter to get the saved queries for.
3472
+ * matterId: 'placeholder-value',
3473
+ * // The maximum number of saved queries to return.
3474
+ * pageSize: 'placeholder-value',
3475
+ * // The pagination token as returned in the previous response. An empty token means start from the beginning.
3476
+ * pageToken: 'placeholder-value',
3477
+ * });
3478
+ * console.log(res.data);
3479
+ *
3480
+ * // Example response
3481
+ * // {
3482
+ * // "nextPageToken": "my_nextPageToken",
3483
+ * // "savedQueries": []
3484
+ * // }
3485
+ * }
3486
+ *
3487
+ * main().catch(e => {
3488
+ * console.error(e);
3489
+ * throw e;
3490
+ * });
3491
+ *
3492
+ * ```
1850
3493
  *
1851
3494
  * @param params - Parameters for request
1852
3495
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1909,6 +3552,56 @@ export declare namespace vault_v1 {
1909
3552
  constructor(context: APIRequestContext);
1910
3553
  /**
1911
3554
  * 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`.
3555
+ * @example
3556
+ * ```js
3557
+ * // Before running the sample:
3558
+ * // - Enable the API at:
3559
+ * // https://console.developers.google.com/apis/api/vault.googleapis.com
3560
+ * // - Login into gcloud by running:
3561
+ * // ```sh
3562
+ * // $ gcloud auth application-default login
3563
+ * // ```
3564
+ * // - Install the npm module by running:
3565
+ * // ```sh
3566
+ * // $ npm install googleapis
3567
+ * // ```
3568
+ *
3569
+ * const {google} = require('googleapis');
3570
+ * const vault = google.vault('v1');
3571
+ *
3572
+ * async function main() {
3573
+ * const auth = new google.auth.GoogleAuth({
3574
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3575
+ * scopes: ['https://www.googleapis.com/auth/ediscovery'],
3576
+ * });
3577
+ *
3578
+ * // Acquire an auth client, and bind it to all future calls
3579
+ * const authClient = await auth.getClient();
3580
+ * google.options({auth: authClient});
3581
+ *
3582
+ * // Do the magic
3583
+ * const res = await vault.operations.cancel({
3584
+ * // The name of the operation resource to be cancelled.
3585
+ * name: 'operations/.*',
3586
+ *
3587
+ * // Request body metadata
3588
+ * requestBody: {
3589
+ * // request body parameters
3590
+ * // {}
3591
+ * },
3592
+ * });
3593
+ * console.log(res.data);
3594
+ *
3595
+ * // Example response
3596
+ * // {}
3597
+ * }
3598
+ *
3599
+ * main().catch(e => {
3600
+ * console.error(e);
3601
+ * throw e;
3602
+ * });
3603
+ *
3604
+ * ```
1912
3605
  *
1913
3606
  * @param params - Parameters for request
1914
3607
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1923,6 +3616,50 @@ export declare namespace vault_v1 {
1923
3616
  cancel(callback: BodyResponseCallback<Schema$Empty>): void;
1924
3617
  /**
1925
3618
  * 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`.
3619
+ * @example
3620
+ * ```js
3621
+ * // Before running the sample:
3622
+ * // - Enable the API at:
3623
+ * // https://console.developers.google.com/apis/api/vault.googleapis.com
3624
+ * // - Login into gcloud by running:
3625
+ * // ```sh
3626
+ * // $ gcloud auth application-default login
3627
+ * // ```
3628
+ * // - Install the npm module by running:
3629
+ * // ```sh
3630
+ * // $ npm install googleapis
3631
+ * // ```
3632
+ *
3633
+ * const {google} = require('googleapis');
3634
+ * const vault = google.vault('v1');
3635
+ *
3636
+ * async function main() {
3637
+ * const auth = new google.auth.GoogleAuth({
3638
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3639
+ * scopes: ['https://www.googleapis.com/auth/ediscovery'],
3640
+ * });
3641
+ *
3642
+ * // Acquire an auth client, and bind it to all future calls
3643
+ * const authClient = await auth.getClient();
3644
+ * google.options({auth: authClient});
3645
+ *
3646
+ * // Do the magic
3647
+ * const res = await vault.operations.delete({
3648
+ * // The name of the operation resource to be deleted.
3649
+ * name: 'operations/.*',
3650
+ * });
3651
+ * console.log(res.data);
3652
+ *
3653
+ * // Example response
3654
+ * // {}
3655
+ * }
3656
+ *
3657
+ * main().catch(e => {
3658
+ * console.error(e);
3659
+ * throw e;
3660
+ * });
3661
+ *
3662
+ * ```
1926
3663
  *
1927
3664
  * @param params - Parameters for request
1928
3665
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1937,6 +3674,59 @@ export declare namespace vault_v1 {
1937
3674
  delete(callback: BodyResponseCallback<Schema$Empty>): void;
1938
3675
  /**
1939
3676
  * 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.
3677
+ * @example
3678
+ * ```js
3679
+ * // Before running the sample:
3680
+ * // - Enable the API at:
3681
+ * // https://console.developers.google.com/apis/api/vault.googleapis.com
3682
+ * // - Login into gcloud by running:
3683
+ * // ```sh
3684
+ * // $ gcloud auth application-default login
3685
+ * // ```
3686
+ * // - Install the npm module by running:
3687
+ * // ```sh
3688
+ * // $ npm install googleapis
3689
+ * // ```
3690
+ *
3691
+ * const {google} = require('googleapis');
3692
+ * const vault = google.vault('v1');
3693
+ *
3694
+ * async function main() {
3695
+ * const auth = new google.auth.GoogleAuth({
3696
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3697
+ * scopes: [
3698
+ * 'https://www.googleapis.com/auth/ediscovery',
3699
+ * 'https://www.googleapis.com/auth/ediscovery.readonly',
3700
+ * ],
3701
+ * });
3702
+ *
3703
+ * // Acquire an auth client, and bind it to all future calls
3704
+ * const authClient = await auth.getClient();
3705
+ * google.options({auth: authClient});
3706
+ *
3707
+ * // Do the magic
3708
+ * const res = await vault.operations.get({
3709
+ * // The name of the operation resource.
3710
+ * name: 'operations/.*',
3711
+ * });
3712
+ * console.log(res.data);
3713
+ *
3714
+ * // Example response
3715
+ * // {
3716
+ * // "done": false,
3717
+ * // "error": {},
3718
+ * // "metadata": {},
3719
+ * // "name": "my_name",
3720
+ * // "response": {}
3721
+ * // }
3722
+ * }
3723
+ *
3724
+ * main().catch(e => {
3725
+ * console.error(e);
3726
+ * throw e;
3727
+ * });
3728
+ *
3729
+ * ```
1940
3730
  *
1941
3731
  * @param params - Parameters for request
1942
3732
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1951,6 +3741,62 @@ export declare namespace vault_v1 {
1951
3741
  get(callback: BodyResponseCallback<Schema$Operation>): void;
1952
3742
  /**
1953
3743
  * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
3744
+ * @example
3745
+ * ```js
3746
+ * // Before running the sample:
3747
+ * // - Enable the API at:
3748
+ * // https://console.developers.google.com/apis/api/vault.googleapis.com
3749
+ * // - Login into gcloud by running:
3750
+ * // ```sh
3751
+ * // $ gcloud auth application-default login
3752
+ * // ```
3753
+ * // - Install the npm module by running:
3754
+ * // ```sh
3755
+ * // $ npm install googleapis
3756
+ * // ```
3757
+ *
3758
+ * const {google} = require('googleapis');
3759
+ * const vault = google.vault('v1');
3760
+ *
3761
+ * async function main() {
3762
+ * const auth = new google.auth.GoogleAuth({
3763
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3764
+ * scopes: [
3765
+ * 'https://www.googleapis.com/auth/ediscovery',
3766
+ * 'https://www.googleapis.com/auth/ediscovery.readonly',
3767
+ * ],
3768
+ * });
3769
+ *
3770
+ * // Acquire an auth client, and bind it to all future calls
3771
+ * const authClient = await auth.getClient();
3772
+ * google.options({auth: authClient});
3773
+ *
3774
+ * // Do the magic
3775
+ * const res = await vault.operations.list({
3776
+ * // The standard list filter.
3777
+ * filter: 'placeholder-value',
3778
+ * // The name of the operation's parent resource.
3779
+ * name: 'operations',
3780
+ * // The standard list page size.
3781
+ * pageSize: 'placeholder-value',
3782
+ * // The standard list page token.
3783
+ * pageToken: 'placeholder-value',
3784
+ * });
3785
+ * console.log(res.data);
3786
+ *
3787
+ * // Example response
3788
+ * // {
3789
+ * // "nextPageToken": "my_nextPageToken",
3790
+ * // "operations": []
3791
+ * // }
3792
+ * }
3793
+ *
3794
+ * main().catch(e => {
3795
+ * console.error(e);
3796
+ * throw e;
3797
+ * });
3798
+ *
3799
+ * ```
1954
3800
  *
1955
3801
  * @param params - Parameters for request
1956
3802
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.