@googleapis/vault 5.0.1 → 6.1.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/v1.ts CHANGED
@@ -417,6 +417,10 @@ export namespace vault_v1 {
417
417
  * Set to true to include Team Drive.
418
418
  */
419
419
  includeTeamDrives?: boolean | null;
420
+ /**
421
+ * 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.
422
+ */
423
+ sharedDrivesOption?: string | null;
420
424
  /**
421
425
  * 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.
422
426
  */
@@ -1200,6 +1204,63 @@ export namespace vault_v1 {
1200
1204
 
1201
1205
  /**
1202
1206
  * Adds an account as a matter collaborator.
1207
+ * @example
1208
+ * ```js
1209
+ * // Before running the sample:
1210
+ * // - Enable the API at:
1211
+ * // https://console.developers.google.com/apis/api/vault.googleapis.com
1212
+ * // - Login into gcloud by running:
1213
+ * // ```sh
1214
+ * // $ gcloud auth application-default login
1215
+ * // ```
1216
+ * // - Install the npm module by running:
1217
+ * // ```sh
1218
+ * // $ npm install googleapis
1219
+ * // ```
1220
+ *
1221
+ * const {google} = require('googleapis');
1222
+ * const vault = google.vault('v1');
1223
+ *
1224
+ * async function main() {
1225
+ * const auth = new google.auth.GoogleAuth({
1226
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
1227
+ * scopes: ['https://www.googleapis.com/auth/ediscovery'],
1228
+ * });
1229
+ *
1230
+ * // Acquire an auth client, and bind it to all future calls
1231
+ * const authClient = await auth.getClient();
1232
+ * google.options({auth: authClient});
1233
+ *
1234
+ * // Do the magic
1235
+ * const res = await vault.matters.addPermissions({
1236
+ * // The matter ID.
1237
+ * matterId: 'placeholder-value',
1238
+ *
1239
+ * // Request body metadata
1240
+ * requestBody: {
1241
+ * // request body parameters
1242
+ * // {
1243
+ * // "ccMe": false,
1244
+ * // "matterPermission": {},
1245
+ * // "sendEmails": false
1246
+ * // }
1247
+ * },
1248
+ * });
1249
+ * console.log(res.data);
1250
+ *
1251
+ * // Example response
1252
+ * // {
1253
+ * // "accountId": "my_accountId",
1254
+ * // "role": "my_role"
1255
+ * // }
1256
+ * }
1257
+ *
1258
+ * main().catch(e => {
1259
+ * console.error(e);
1260
+ * throw e;
1261
+ * });
1262
+ *
1263
+ * ```
1203
1264
  *
1204
1265
  * @param params - Parameters for request
1205
1266
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1293,6 +1354,58 @@ export namespace vault_v1 {
1293
1354
 
1294
1355
  /**
1295
1356
  * Closes the specified matter. Returns the matter with updated state.
1357
+ * @example
1358
+ * ```js
1359
+ * // Before running the sample:
1360
+ * // - Enable the API at:
1361
+ * // https://console.developers.google.com/apis/api/vault.googleapis.com
1362
+ * // - Login into gcloud by running:
1363
+ * // ```sh
1364
+ * // $ gcloud auth application-default login
1365
+ * // ```
1366
+ * // - Install the npm module by running:
1367
+ * // ```sh
1368
+ * // $ npm install googleapis
1369
+ * // ```
1370
+ *
1371
+ * const {google} = require('googleapis');
1372
+ * const vault = google.vault('v1');
1373
+ *
1374
+ * async function main() {
1375
+ * const auth = new google.auth.GoogleAuth({
1376
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
1377
+ * scopes: ['https://www.googleapis.com/auth/ediscovery'],
1378
+ * });
1379
+ *
1380
+ * // Acquire an auth client, and bind it to all future calls
1381
+ * const authClient = await auth.getClient();
1382
+ * google.options({auth: authClient});
1383
+ *
1384
+ * // Do the magic
1385
+ * const res = await vault.matters.close({
1386
+ * // The matter ID.
1387
+ * matterId: 'placeholder-value',
1388
+ *
1389
+ * // Request body metadata
1390
+ * requestBody: {
1391
+ * // request body parameters
1392
+ * // {}
1393
+ * },
1394
+ * });
1395
+ * console.log(res.data);
1396
+ *
1397
+ * // Example response
1398
+ * // {
1399
+ * // "matter": {}
1400
+ * // }
1401
+ * }
1402
+ *
1403
+ * main().catch(e => {
1404
+ * console.error(e);
1405
+ * throw e;
1406
+ * });
1407
+ *
1408
+ * ```
1296
1409
  *
1297
1410
  * @param params - Parameters for request
1298
1411
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1383,6 +1496,65 @@ export namespace vault_v1 {
1383
1496
 
1384
1497
  /**
1385
1498
  * Counts the accounts processed by the specified query.
1499
+ * @example
1500
+ * ```js
1501
+ * // Before running the sample:
1502
+ * // - Enable the API at:
1503
+ * // https://console.developers.google.com/apis/api/vault.googleapis.com
1504
+ * // - Login into gcloud by running:
1505
+ * // ```sh
1506
+ * // $ gcloud auth application-default login
1507
+ * // ```
1508
+ * // - Install the npm module by running:
1509
+ * // ```sh
1510
+ * // $ npm install googleapis
1511
+ * // ```
1512
+ *
1513
+ * const {google} = require('googleapis');
1514
+ * const vault = google.vault('v1');
1515
+ *
1516
+ * async function main() {
1517
+ * const auth = new google.auth.GoogleAuth({
1518
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
1519
+ * scopes: ['https://www.googleapis.com/auth/ediscovery'],
1520
+ * });
1521
+ *
1522
+ * // Acquire an auth client, and bind it to all future calls
1523
+ * const authClient = await auth.getClient();
1524
+ * google.options({auth: authClient});
1525
+ *
1526
+ * // Do the magic
1527
+ * const res = await vault.matters.count({
1528
+ * // The matter ID.
1529
+ * matterId: 'placeholder-value',
1530
+ *
1531
+ * // Request body metadata
1532
+ * requestBody: {
1533
+ * // request body parameters
1534
+ * // {
1535
+ * // "query": {},
1536
+ * // "view": "my_view"
1537
+ * // }
1538
+ * },
1539
+ * });
1540
+ * console.log(res.data);
1541
+ *
1542
+ * // Example response
1543
+ * // {
1544
+ * // "done": false,
1545
+ * // "error": {},
1546
+ * // "metadata": {},
1547
+ * // "name": "my_name",
1548
+ * // "response": {}
1549
+ * // }
1550
+ * }
1551
+ *
1552
+ * main().catch(e => {
1553
+ * console.error(e);
1554
+ * throw e;
1555
+ * });
1556
+ *
1557
+ * ```
1386
1558
  *
1387
1559
  * @param params - Parameters for request
1388
1560
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1473,6 +1645,67 @@ export namespace vault_v1 {
1473
1645
 
1474
1646
  /**
1475
1647
  * 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.
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.create({
1677
+ * // Request body metadata
1678
+ * requestBody: {
1679
+ * // request body parameters
1680
+ * // {
1681
+ * // "description": "my_description",
1682
+ * // "matterId": "my_matterId",
1683
+ * // "matterPermissions": [],
1684
+ * // "matterRegion": "my_matterRegion",
1685
+ * // "name": "my_name",
1686
+ * // "state": "my_state"
1687
+ * // }
1688
+ * },
1689
+ * });
1690
+ * console.log(res.data);
1691
+ *
1692
+ * // Example response
1693
+ * // {
1694
+ * // "description": "my_description",
1695
+ * // "matterId": "my_matterId",
1696
+ * // "matterPermissions": [],
1697
+ * // "matterRegion": "my_matterRegion",
1698
+ * // "name": "my_name",
1699
+ * // "state": "my_state"
1700
+ * // }
1701
+ * }
1702
+ *
1703
+ * main().catch(e => {
1704
+ * console.error(e);
1705
+ * throw e;
1706
+ * });
1707
+ *
1708
+ * ```
1476
1709
  *
1477
1710
  * @param params - Parameters for request
1478
1711
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1560,6 +1793,57 @@ export namespace vault_v1 {
1560
1793
 
1561
1794
  /**
1562
1795
  * Deletes the specified matter. Returns the matter with updated state.
1796
+ * @example
1797
+ * ```js
1798
+ * // Before running the sample:
1799
+ * // - Enable the API at:
1800
+ * // https://console.developers.google.com/apis/api/vault.googleapis.com
1801
+ * // - Login into gcloud by running:
1802
+ * // ```sh
1803
+ * // $ gcloud auth application-default login
1804
+ * // ```
1805
+ * // - Install the npm module by running:
1806
+ * // ```sh
1807
+ * // $ npm install googleapis
1808
+ * // ```
1809
+ *
1810
+ * const {google} = require('googleapis');
1811
+ * const vault = google.vault('v1');
1812
+ *
1813
+ * async function main() {
1814
+ * const auth = new google.auth.GoogleAuth({
1815
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
1816
+ * scopes: ['https://www.googleapis.com/auth/ediscovery'],
1817
+ * });
1818
+ *
1819
+ * // Acquire an auth client, and bind it to all future calls
1820
+ * const authClient = await auth.getClient();
1821
+ * google.options({auth: authClient});
1822
+ *
1823
+ * // Do the magic
1824
+ * const res = await vault.matters.delete({
1825
+ * // The matter ID
1826
+ * matterId: 'placeholder-value',
1827
+ * });
1828
+ * console.log(res.data);
1829
+ *
1830
+ * // Example response
1831
+ * // {
1832
+ * // "description": "my_description",
1833
+ * // "matterId": "my_matterId",
1834
+ * // "matterPermissions": [],
1835
+ * // "matterRegion": "my_matterRegion",
1836
+ * // "name": "my_name",
1837
+ * // "state": "my_state"
1838
+ * // }
1839
+ * }
1840
+ *
1841
+ * main().catch(e => {
1842
+ * console.error(e);
1843
+ * throw e;
1844
+ * });
1845
+ *
1846
+ * ```
1563
1847
  *
1564
1848
  * @param params - Parameters for request
1565
1849
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1650,6 +1934,62 @@ export namespace vault_v1 {
1650
1934
 
1651
1935
  /**
1652
1936
  * Gets the specified matter.
1937
+ * @example
1938
+ * ```js
1939
+ * // Before running the sample:
1940
+ * // - Enable the API at:
1941
+ * // https://console.developers.google.com/apis/api/vault.googleapis.com
1942
+ * // - Login into gcloud by running:
1943
+ * // ```sh
1944
+ * // $ gcloud auth application-default login
1945
+ * // ```
1946
+ * // - Install the npm module by running:
1947
+ * // ```sh
1948
+ * // $ npm install googleapis
1949
+ * // ```
1950
+ *
1951
+ * const {google} = require('googleapis');
1952
+ * const vault = google.vault('v1');
1953
+ *
1954
+ * async function main() {
1955
+ * const auth = new google.auth.GoogleAuth({
1956
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
1957
+ * scopes: [
1958
+ * 'https://www.googleapis.com/auth/ediscovery',
1959
+ * 'https://www.googleapis.com/auth/ediscovery.readonly',
1960
+ * ],
1961
+ * });
1962
+ *
1963
+ * // Acquire an auth client, and bind it to all future calls
1964
+ * const authClient = await auth.getClient();
1965
+ * google.options({auth: authClient});
1966
+ *
1967
+ * // Do the magic
1968
+ * const res = await vault.matters.get({
1969
+ * // The matter ID.
1970
+ * matterId: 'placeholder-value',
1971
+ * // Specifies how much information about the matter to return in the response.
1972
+ * view: 'placeholder-value',
1973
+ * });
1974
+ * console.log(res.data);
1975
+ *
1976
+ * // Example response
1977
+ * // {
1978
+ * // "description": "my_description",
1979
+ * // "matterId": "my_matterId",
1980
+ * // "matterPermissions": [],
1981
+ * // "matterRegion": "my_matterRegion",
1982
+ * // "name": "my_name",
1983
+ * // "state": "my_state"
1984
+ * // }
1985
+ * }
1986
+ *
1987
+ * main().catch(e => {
1988
+ * console.error(e);
1989
+ * throw e;
1990
+ * });
1991
+ *
1992
+ * ```
1653
1993
  *
1654
1994
  * @param params - Parameters for request
1655
1995
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1740,6 +2080,62 @@ export namespace vault_v1 {
1740
2080
 
1741
2081
  /**
1742
2082
  * Lists matters the requestor has access to.
2083
+ * @example
2084
+ * ```js
2085
+ * // Before running the sample:
2086
+ * // - Enable the API at:
2087
+ * // https://console.developers.google.com/apis/api/vault.googleapis.com
2088
+ * // - Login into gcloud by running:
2089
+ * // ```sh
2090
+ * // $ gcloud auth application-default login
2091
+ * // ```
2092
+ * // - Install the npm module by running:
2093
+ * // ```sh
2094
+ * // $ npm install googleapis
2095
+ * // ```
2096
+ *
2097
+ * const {google} = require('googleapis');
2098
+ * const vault = google.vault('v1');
2099
+ *
2100
+ * async function main() {
2101
+ * const auth = new google.auth.GoogleAuth({
2102
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2103
+ * scopes: [
2104
+ * 'https://www.googleapis.com/auth/ediscovery',
2105
+ * 'https://www.googleapis.com/auth/ediscovery.readonly',
2106
+ * ],
2107
+ * });
2108
+ *
2109
+ * // Acquire an auth client, and bind it to all future calls
2110
+ * const authClient = await auth.getClient();
2111
+ * google.options({auth: authClient});
2112
+ *
2113
+ * // Do the magic
2114
+ * const res = await vault.matters.list({
2115
+ * // The number of matters to return in the response. Default and maximum are 100.
2116
+ * pageSize: 'placeholder-value',
2117
+ * // The pagination token as returned in the response.
2118
+ * pageToken: 'placeholder-value',
2119
+ * // If set, lists only matters with the specified state. The default lists matters of all states.
2120
+ * state: 'placeholder-value',
2121
+ * // Specifies how much information about the matter to return in response.
2122
+ * view: 'placeholder-value',
2123
+ * });
2124
+ * console.log(res.data);
2125
+ *
2126
+ * // Example response
2127
+ * // {
2128
+ * // "matters": [],
2129
+ * // "nextPageToken": "my_nextPageToken"
2130
+ * // }
2131
+ * }
2132
+ *
2133
+ * main().catch(e => {
2134
+ * console.error(e);
2135
+ * throw e;
2136
+ * });
2137
+ *
2138
+ * ```
1743
2139
  *
1744
2140
  * @param params - Parameters for request
1745
2141
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1827,6 +2223,58 @@ export namespace vault_v1 {
1827
2223
 
1828
2224
  /**
1829
2225
  * Removes an account as a matter collaborator.
2226
+ * @example
2227
+ * ```js
2228
+ * // Before running the sample:
2229
+ * // - Enable the API at:
2230
+ * // https://console.developers.google.com/apis/api/vault.googleapis.com
2231
+ * // - Login into gcloud by running:
2232
+ * // ```sh
2233
+ * // $ gcloud auth application-default login
2234
+ * // ```
2235
+ * // - Install the npm module by running:
2236
+ * // ```sh
2237
+ * // $ npm install googleapis
2238
+ * // ```
2239
+ *
2240
+ * const {google} = require('googleapis');
2241
+ * const vault = google.vault('v1');
2242
+ *
2243
+ * async function main() {
2244
+ * const auth = new google.auth.GoogleAuth({
2245
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2246
+ * scopes: ['https://www.googleapis.com/auth/ediscovery'],
2247
+ * });
2248
+ *
2249
+ * // Acquire an auth client, and bind it to all future calls
2250
+ * const authClient = await auth.getClient();
2251
+ * google.options({auth: authClient});
2252
+ *
2253
+ * // Do the magic
2254
+ * const res = await vault.matters.removePermissions({
2255
+ * // The matter ID.
2256
+ * matterId: 'placeholder-value',
2257
+ *
2258
+ * // Request body metadata
2259
+ * requestBody: {
2260
+ * // request body parameters
2261
+ * // {
2262
+ * // "accountId": "my_accountId"
2263
+ * // }
2264
+ * },
2265
+ * });
2266
+ * console.log(res.data);
2267
+ *
2268
+ * // Example response
2269
+ * // {}
2270
+ * }
2271
+ *
2272
+ * main().catch(e => {
2273
+ * console.error(e);
2274
+ * throw e;
2275
+ * });
2276
+ *
2277
+ * ```
1830
2278
  *
1831
2279
  * @param params - Parameters for request
1832
2280
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1918,6 +2366,58 @@ export namespace vault_v1 {
1918
2366
 
1919
2367
  /**
1920
2368
  * Reopens the specified matter. Returns the matter with updated state.
2369
+ * @example
2370
+ * ```js
2371
+ * // Before running the sample:
2372
+ * // - Enable the API at:
2373
+ * // https://console.developers.google.com/apis/api/vault.googleapis.com
2374
+ * // - Login into gcloud by running:
2375
+ * // ```sh
2376
+ * // $ gcloud auth application-default login
2377
+ * // ```
2378
+ * // - Install the npm module by running:
2379
+ * // ```sh
2380
+ * // $ npm install googleapis
2381
+ * // ```
2382
+ *
2383
+ * const {google} = require('googleapis');
2384
+ * const vault = google.vault('v1');
2385
+ *
2386
+ * async function main() {
2387
+ * const auth = new google.auth.GoogleAuth({
2388
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2389
+ * scopes: ['https://www.googleapis.com/auth/ediscovery'],
2390
+ * });
2391
+ *
2392
+ * // Acquire an auth client, and bind it to all future calls
2393
+ * const authClient = await auth.getClient();
2394
+ * google.options({auth: authClient});
2395
+ *
2396
+ * // Do the magic
2397
+ * const res = await vault.matters.reopen({
2398
+ * // The matter ID.
2399
+ * matterId: 'placeholder-value',
2400
+ *
2401
+ * // Request body metadata
2402
+ * requestBody: {
2403
+ * // request body parameters
2404
+ * // {}
2405
+ * },
2406
+ * });
2407
+ * console.log(res.data);
2408
+ *
2409
+ * // Example response
2410
+ * // {
2411
+ * // "matter": {}
2412
+ * // }
2413
+ * }
2414
+ *
2415
+ * main().catch(e => {
2416
+ * console.error(e);
2417
+ * throw e;
2418
+ * });
2419
+ *
2420
+ * ```
1921
2421
  *
1922
2422
  * @param params - Parameters for request
1923
2423
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2010,6 +2510,63 @@ export namespace vault_v1 {
2010
2510
 
2011
2511
  /**
2012
2512
  * Undeletes the specified matter. Returns the matter with updated state.
2513
+ * @example
2514
+ * ```js
2515
+ * // Before running the sample:
2516
+ * // - Enable the API at:
2517
+ * // https://console.developers.google.com/apis/api/vault.googleapis.com
2518
+ * // - Login into gcloud by running:
2519
+ * // ```sh
2520
+ * // $ gcloud auth application-default login
2521
+ * // ```
2522
+ * // - Install the npm module by running:
2523
+ * // ```sh
2524
+ * // $ npm install googleapis
2525
+ * // ```
2526
+ *
2527
+ * const {google} = require('googleapis');
2528
+ * const vault = google.vault('v1');
2529
+ *
2530
+ * async function main() {
2531
+ * const auth = new google.auth.GoogleAuth({
2532
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2533
+ * scopes: ['https://www.googleapis.com/auth/ediscovery'],
2534
+ * });
2535
+ *
2536
+ * // Acquire an auth client, and bind it to all future calls
2537
+ * const authClient = await auth.getClient();
2538
+ * google.options({auth: authClient});
2539
+ *
2540
+ * // Do the magic
2541
+ * const res = await vault.matters.undelete({
2542
+ * // The matter ID.
2543
+ * matterId: 'placeholder-value',
2544
+ *
2545
+ * // Request body metadata
2546
+ * requestBody: {
2547
+ * // request body parameters
2548
+ * // {}
2549
+ * },
2550
+ * });
2551
+ * console.log(res.data);
2552
+ *
2553
+ * // Example response
2554
+ * // {
2555
+ * // "description": "my_description",
2556
+ * // "matterId": "my_matterId",
2557
+ * // "matterPermissions": [],
2558
+ * // "matterRegion": "my_matterRegion",
2559
+ * // "name": "my_name",
2560
+ * // "state": "my_state"
2561
+ * // }
2562
+ * }
2563
+ *
2564
+ * main().catch(e => {
2565
+ * console.error(e);
2566
+ * throw e;
2567
+ * });
2568
+ *
2569
+ * ```
2013
2570
  *
2014
2571
  * @param params - Parameters for request
2015
2572
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2100,6 +2657,70 @@ export namespace vault_v1 {
2100
2657
 
2101
2658
  /**
2102
2659
  * 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.
2660
+ * @example
2661
+ * ```js
2662
+ * // Before running the sample:
2663
+ * // - Enable the API at:
2664
+ * // https://console.developers.google.com/apis/api/vault.googleapis.com
2665
+ * // - Login into gcloud by running:
2666
+ * // ```sh
2667
+ * // $ gcloud auth application-default login
2668
+ * // ```
2669
+ * // - Install the npm module by running:
2670
+ * // ```sh
2671
+ * // $ npm install googleapis
2672
+ * // ```
2673
+ *
2674
+ * const {google} = require('googleapis');
2675
+ * const vault = google.vault('v1');
2676
+ *
2677
+ * async function main() {
2678
+ * const auth = new google.auth.GoogleAuth({
2679
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2680
+ * scopes: ['https://www.googleapis.com/auth/ediscovery'],
2681
+ * });
2682
+ *
2683
+ * // Acquire an auth client, and bind it to all future calls
2684
+ * const authClient = await auth.getClient();
2685
+ * google.options({auth: authClient});
2686
+ *
2687
+ * // Do the magic
2688
+ * const res = await vault.matters.update({
2689
+ * // The matter ID.
2690
+ * matterId: 'placeholder-value',
2691
+ *
2692
+ * // Request body metadata
2693
+ * requestBody: {
2694
+ * // request body parameters
2695
+ * // {
2696
+ * // "description": "my_description",
2697
+ * // "matterId": "my_matterId",
2698
+ * // "matterPermissions": [],
2699
+ * // "matterRegion": "my_matterRegion",
2700
+ * // "name": "my_name",
2701
+ * // "state": "my_state"
2702
+ * // }
2703
+ * },
2704
+ * });
2705
+ * console.log(res.data);
2706
+ *
2707
+ * // Example response
2708
+ * // {
2709
+ * // "description": "my_description",
2710
+ * // "matterId": "my_matterId",
2711
+ * // "matterPermissions": [],
2712
+ * // "matterRegion": "my_matterRegion",
2713
+ * // "name": "my_name",
2714
+ * // "state": "my_state"
2715
+ * // }
2716
+ * }
2717
+ *
2718
+ * main().catch(e => {
2719
+ * console.error(e);
2720
+ * throw e;
2721
+ * });
2722
+ *
2723
+ * ```
2103
2724
  *
2104
2725
  * @param params - Parameters for request
2105
2726
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2317,6 +2938,80 @@ export namespace vault_v1 {
2317
2938
 
2318
2939
  /**
2319
2940
  * Creates an export.
2941
+ * @example
2942
+ * ```js
2943
+ * // Before running the sample:
2944
+ * // - Enable the API at:
2945
+ * // https://console.developers.google.com/apis/api/vault.googleapis.com
2946
+ * // - Login into gcloud by running:
2947
+ * // ```sh
2948
+ * // $ gcloud auth application-default login
2949
+ * // ```
2950
+ * // - Install the npm module by running:
2951
+ * // ```sh
2952
+ * // $ npm install googleapis
2953
+ * // ```
2954
+ *
2955
+ * const {google} = require('googleapis');
2956
+ * const vault = google.vault('v1');
2957
+ *
2958
+ * async function main() {
2959
+ * const auth = new google.auth.GoogleAuth({
2960
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2961
+ * scopes: ['https://www.googleapis.com/auth/ediscovery'],
2962
+ * });
2963
+ *
2964
+ * // Acquire an auth client, and bind it to all future calls
2965
+ * const authClient = await auth.getClient();
2966
+ * google.options({auth: authClient});
2967
+ *
2968
+ * // Do the magic
2969
+ * const res = await vault.matters.exports.create({
2970
+ * // The matter ID.
2971
+ * matterId: 'placeholder-value',
2972
+ *
2973
+ * // Request body metadata
2974
+ * requestBody: {
2975
+ * // request body parameters
2976
+ * // {
2977
+ * // "cloudStorageSink": {},
2978
+ * // "createTime": "my_createTime",
2979
+ * // "exportOptions": {},
2980
+ * // "id": "my_id",
2981
+ * // "matterId": "my_matterId",
2982
+ * // "name": "my_name",
2983
+ * // "parentExportId": "my_parentExportId",
2984
+ * // "query": {},
2985
+ * // "requester": {},
2986
+ * // "stats": {},
2987
+ * // "status": "my_status"
2988
+ * // }
2989
+ * },
2990
+ * });
2991
+ * console.log(res.data);
2992
+ *
2993
+ * // Example response
2994
+ * // {
2995
+ * // "cloudStorageSink": {},
2996
+ * // "createTime": "my_createTime",
2997
+ * // "exportOptions": {},
2998
+ * // "id": "my_id",
2999
+ * // "matterId": "my_matterId",
3000
+ * // "name": "my_name",
3001
+ * // "parentExportId": "my_parentExportId",
3002
+ * // "query": {},
3003
+ * // "requester": {},
3004
+ * // "stats": {},
3005
+ * // "status": "my_status"
3006
+ * // }
3007
+ * }
3008
+ *
3009
+ * main().catch(e => {
3010
+ * console.error(e);
3011
+ * throw e;
3012
+ * });
3013
+ *
3014
+ * ```
2320
3015
  *
2321
3016
  * @param params - Parameters for request
2322
3017
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2408,6 +3103,52 @@ export namespace vault_v1 {
2408
3103
 
2409
3104
  /**
2410
3105
  * Deletes an export.
3106
+ * @example
3107
+ * ```js
3108
+ * // Before running the sample:
3109
+ * // - Enable the API at:
3110
+ * // https://console.developers.google.com/apis/api/vault.googleapis.com
3111
+ * // - Login into gcloud by running:
3112
+ * // ```sh
3113
+ * // $ gcloud auth application-default login
3114
+ * // ```
3115
+ * // - Install the npm module by running:
3116
+ * // ```sh
3117
+ * // $ npm install googleapis
3118
+ * // ```
3119
+ *
3120
+ * const {google} = require('googleapis');
3121
+ * const vault = google.vault('v1');
3122
+ *
3123
+ * async function main() {
3124
+ * const auth = new google.auth.GoogleAuth({
3125
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3126
+ * scopes: ['https://www.googleapis.com/auth/ediscovery'],
3127
+ * });
3128
+ *
3129
+ * // Acquire an auth client, and bind it to all future calls
3130
+ * const authClient = await auth.getClient();
3131
+ * google.options({auth: authClient});
3132
+ *
3133
+ * // Do the magic
3134
+ * const res = await vault.matters.exports.delete({
3135
+ * // The export ID.
3136
+ * exportId: 'placeholder-value',
3137
+ * // The matter ID.
3138
+ * matterId: 'placeholder-value',
3139
+ * });
3140
+ * console.log(res.data);
3141
+ *
3142
+ * // Example response
3143
+ * // {}
3144
+ * }
3145
+ *
3146
+ * main().catch(e => {
3147
+ * console.error(e);
3148
+ * throw e;
3149
+ * });
3150
+ *
3151
+ * ```
2411
3152
  *
2412
3153
  * @param params - Parameters for request
2413
3154
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2498,6 +3239,67 @@ export namespace vault_v1 {
2498
3239
 
2499
3240
  /**
2500
3241
  * Gets an export.
3242
+ * @example
3243
+ * ```js
3244
+ * // Before running the sample:
3245
+ * // - Enable the API at:
3246
+ * // https://console.developers.google.com/apis/api/vault.googleapis.com
3247
+ * // - Login into gcloud by running:
3248
+ * // ```sh
3249
+ * // $ gcloud auth application-default login
3250
+ * // ```
3251
+ * // - Install the npm module by running:
3252
+ * // ```sh
3253
+ * // $ npm install googleapis
3254
+ * // ```
3255
+ *
3256
+ * const {google} = require('googleapis');
3257
+ * const vault = google.vault('v1');
3258
+ *
3259
+ * async function main() {
3260
+ * const auth = new google.auth.GoogleAuth({
3261
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3262
+ * scopes: [
3263
+ * 'https://www.googleapis.com/auth/ediscovery',
3264
+ * 'https://www.googleapis.com/auth/ediscovery.readonly',
3265
+ * ],
3266
+ * });
3267
+ *
3268
+ * // Acquire an auth client, and bind it to all future calls
3269
+ * const authClient = await auth.getClient();
3270
+ * google.options({auth: authClient});
3271
+ *
3272
+ * // Do the magic
3273
+ * const res = await vault.matters.exports.get({
3274
+ * // The export ID.
3275
+ * exportId: 'placeholder-value',
3276
+ * // The matter ID.
3277
+ * matterId: 'placeholder-value',
3278
+ * });
3279
+ * console.log(res.data);
3280
+ *
3281
+ * // Example response
3282
+ * // {
3283
+ * // "cloudStorageSink": {},
3284
+ * // "createTime": "my_createTime",
3285
+ * // "exportOptions": {},
3286
+ * // "id": "my_id",
3287
+ * // "matterId": "my_matterId",
3288
+ * // "name": "my_name",
3289
+ * // "parentExportId": "my_parentExportId",
3290
+ * // "query": {},
3291
+ * // "requester": {},
3292
+ * // "stats": {},
3293
+ * // "status": "my_status"
3294
+ * // }
3295
+ * }
3296
+ *
3297
+ * main().catch(e => {
3298
+ * console.error(e);
3299
+ * throw e;
3300
+ * });
3301
+ *
3302
+ * ```
2501
3303
  *
2502
3304
  * @param params - Parameters for request
2503
3305
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2588,6 +3390,60 @@ export namespace vault_v1 {
2588
3390
 
2589
3391
  /**
2590
3392
  * Lists details about the exports in the specified matter.
3393
+ * @example
3394
+ * ```js
3395
+ * // Before running the sample:
3396
+ * // - Enable the API at:
3397
+ * // https://console.developers.google.com/apis/api/vault.googleapis.com
3398
+ * // - Login into gcloud by running:
3399
+ * // ```sh
3400
+ * // $ gcloud auth application-default login
3401
+ * // ```
3402
+ * // - Install the npm module by running:
3403
+ * // ```sh
3404
+ * // $ npm install googleapis
3405
+ * // ```
3406
+ *
3407
+ * const {google} = require('googleapis');
3408
+ * const vault = google.vault('v1');
3409
+ *
3410
+ * async function main() {
3411
+ * const auth = new google.auth.GoogleAuth({
3412
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3413
+ * scopes: [
3414
+ * 'https://www.googleapis.com/auth/ediscovery',
3415
+ * 'https://www.googleapis.com/auth/ediscovery.readonly',
3416
+ * ],
3417
+ * });
3418
+ *
3419
+ * // Acquire an auth client, and bind it to all future calls
3420
+ * const authClient = await auth.getClient();
3421
+ * google.options({auth: authClient});
3422
+ *
3423
+ * // Do the magic
3424
+ * const res = await vault.matters.exports.list({
3425
+ * // The matter ID.
3426
+ * matterId: 'placeholder-value',
3427
+ * // The number of exports to return in the response.
3428
+ * pageSize: 'placeholder-value',
3429
+ * // The pagination token as returned in the response.
3430
+ * pageToken: 'placeholder-value',
3431
+ * });
3432
+ * console.log(res.data);
3433
+ *
3434
+ * // Example response
3435
+ * // {
3436
+ * // "exports": [],
3437
+ * // "nextPageToken": "my_nextPageToken"
3438
+ * // }
3439
+ * }
3440
+ *
3441
+ * main().catch(e => {
3442
+ * console.error(e);
3443
+ * throw e;
3444
+ * });
3445
+ *
3446
+ * ```
2591
3447
  *
2592
3448
  * @param params - Parameters for request
2593
3449
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2738,6 +3594,63 @@ export namespace vault_v1 {
2738
3594
 
2739
3595
  /**
2740
3596
  * 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.
3597
+ * @example
3598
+ * ```js
3599
+ * // Before running the sample:
3600
+ * // - Enable the API at:
3601
+ * // https://console.developers.google.com/apis/api/vault.googleapis.com
3602
+ * // - Login into gcloud by running:
3603
+ * // ```sh
3604
+ * // $ gcloud auth application-default login
3605
+ * // ```
3606
+ * // - Install the npm module by running:
3607
+ * // ```sh
3608
+ * // $ npm install googleapis
3609
+ * // ```
3610
+ *
3611
+ * const {google} = require('googleapis');
3612
+ * const vault = google.vault('v1');
3613
+ *
3614
+ * async function main() {
3615
+ * const auth = new google.auth.GoogleAuth({
3616
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3617
+ * scopes: ['https://www.googleapis.com/auth/ediscovery'],
3618
+ * });
3619
+ *
3620
+ * // Acquire an auth client, and bind it to all future calls
3621
+ * const authClient = await auth.getClient();
3622
+ * google.options({auth: authClient});
3623
+ *
3624
+ * // Do the magic
3625
+ * const res = await vault.matters.holds.addHeldAccounts({
3626
+ * // The hold ID.
3627
+ * holdId: 'placeholder-value',
3628
+ * // The matter ID.
3629
+ * matterId: 'placeholder-value',
3630
+ *
3631
+ * // Request body metadata
3632
+ * requestBody: {
3633
+ * // request body parameters
3634
+ * // {
3635
+ * // "accountIds": [],
3636
+ * // "emails": []
3637
+ * // }
3638
+ * },
3639
+ * });
3640
+ * console.log(res.data);
3641
+ *
3642
+ * // Example response
3643
+ * // {
3644
+ * // "responses": []
3645
+ * // }
3646
+ * }
3647
+ *
3648
+ * main().catch(e => {
3649
+ * console.error(e);
3650
+ * throw e;
3651
+ * });
3652
+ *
3653
+ * ```
2741
3654
  *
2742
3655
  * @param params - Parameters for request
2743
3656
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2832,6 +3745,72 @@ export namespace vault_v1 {
2832
3745
 
2833
3746
  /**
2834
3747
  * Creates a hold in the specified matter.
3748
+ * @example
3749
+ * ```js
3750
+ * // Before running the sample:
3751
+ * // - Enable the API at:
3752
+ * // https://console.developers.google.com/apis/api/vault.googleapis.com
3753
+ * // - Login into gcloud by running:
3754
+ * // ```sh
3755
+ * // $ gcloud auth application-default login
3756
+ * // ```
3757
+ * // - Install the npm module by running:
3758
+ * // ```sh
3759
+ * // $ npm install googleapis
3760
+ * // ```
3761
+ *
3762
+ * const {google} = require('googleapis');
3763
+ * const vault = google.vault('v1');
3764
+ *
3765
+ * async function main() {
3766
+ * const auth = new google.auth.GoogleAuth({
3767
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3768
+ * scopes: ['https://www.googleapis.com/auth/ediscovery'],
3769
+ * });
3770
+ *
3771
+ * // Acquire an auth client, and bind it to all future calls
3772
+ * const authClient = await auth.getClient();
3773
+ * google.options({auth: authClient});
3774
+ *
3775
+ * // Do the magic
3776
+ * const res = await vault.matters.holds.create({
3777
+ * // The matter ID.
3778
+ * matterId: 'placeholder-value',
3779
+ *
3780
+ * // Request body metadata
3781
+ * requestBody: {
3782
+ * // request body parameters
3783
+ * // {
3784
+ * // "accounts": [],
3785
+ * // "corpus": "my_corpus",
3786
+ * // "holdId": "my_holdId",
3787
+ * // "name": "my_name",
3788
+ * // "orgUnit": {},
3789
+ * // "query": {},
3790
+ * // "updateTime": "my_updateTime"
3791
+ * // }
3792
+ * },
3793
+ * });
3794
+ * console.log(res.data);
3795
+ *
3796
+ * // Example response
3797
+ * // {
3798
+ * // "accounts": [],
3799
+ * // "corpus": "my_corpus",
3800
+ * // "holdId": "my_holdId",
3801
+ * // "name": "my_name",
3802
+ * // "orgUnit": {},
3803
+ * // "query": {},
3804
+ * // "updateTime": "my_updateTime"
3805
+ * // }
3806
+ * }
3807
+ *
3808
+ * main().catch(e => {
3809
+ * console.error(e);
3810
+ * throw e;
3811
+ * });
3812
+ *
3813
+ * ```
2835
3814
  *
2836
3815
  * @param params - Parameters for request
2837
3816
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2923,6 +3902,52 @@ export namespace vault_v1 {
2923
3902
 
2924
3903
  /**
2925
3904
  * 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.
3905
+ * @example
3906
+ * ```js
3907
+ * // Before running the sample:
3908
+ * // - Enable the API at:
3909
+ * // https://console.developers.google.com/apis/api/vault.googleapis.com
3910
+ * // - Login into gcloud by running:
3911
+ * // ```sh
3912
+ * // $ gcloud auth application-default login
3913
+ * // ```
3914
+ * // - Install the npm module by running:
3915
+ * // ```sh
3916
+ * // $ npm install googleapis
3917
+ * // ```
3918
+ *
3919
+ * const {google} = require('googleapis');
3920
+ * const vault = google.vault('v1');
3921
+ *
3922
+ * async function main() {
3923
+ * const auth = new google.auth.GoogleAuth({
3924
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3925
+ * scopes: ['https://www.googleapis.com/auth/ediscovery'],
3926
+ * });
3927
+ *
3928
+ * // Acquire an auth client, and bind it to all future calls
3929
+ * const authClient = await auth.getClient();
3930
+ * google.options({auth: authClient});
3931
+ *
3932
+ * // Do the magic
3933
+ * const res = await vault.matters.holds.delete({
3934
+ * // The hold ID.
3935
+ * holdId: 'placeholder-value',
3936
+ * // The matter ID.
3937
+ * matterId: 'placeholder-value',
3938
+ * });
3939
+ * console.log(res.data);
3940
+ *
3941
+ * // Example response
3942
+ * // {}
3943
+ * }
3944
+ *
3945
+ * main().catch(e => {
3946
+ * console.error(e);
3947
+ * throw e;
3948
+ * });
3949
+ *
3950
+ * ```
2926
3951
  *
2927
3952
  * @param params - Parameters for request
2928
3953
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3014,6 +4039,65 @@ export namespace vault_v1 {
3014
4039
 
3015
4040
  /**
3016
4041
  * Gets the specified hold.
4042
+ * @example
4043
+ * ```js
4044
+ * // Before running the sample:
4045
+ * // - Enable the API at:
4046
+ * // https://console.developers.google.com/apis/api/vault.googleapis.com
4047
+ * // - Login into gcloud by running:
4048
+ * // ```sh
4049
+ * // $ gcloud auth application-default login
4050
+ * // ```
4051
+ * // - Install the npm module by running:
4052
+ * // ```sh
4053
+ * // $ npm install googleapis
4054
+ * // ```
4055
+ *
4056
+ * const {google} = require('googleapis');
4057
+ * const vault = google.vault('v1');
4058
+ *
4059
+ * async function main() {
4060
+ * const auth = new google.auth.GoogleAuth({
4061
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4062
+ * scopes: [
4063
+ * 'https://www.googleapis.com/auth/ediscovery',
4064
+ * 'https://www.googleapis.com/auth/ediscovery.readonly',
4065
+ * ],
4066
+ * });
4067
+ *
4068
+ * // Acquire an auth client, and bind it to all future calls
4069
+ * const authClient = await auth.getClient();
4070
+ * google.options({auth: authClient});
4071
+ *
4072
+ * // Do the magic
4073
+ * const res = await vault.matters.holds.get({
4074
+ * // The hold ID.
4075
+ * holdId: 'placeholder-value',
4076
+ * // The matter ID.
4077
+ * matterId: 'placeholder-value',
4078
+ * // The amount of detail to return for a hold.
4079
+ * view: 'placeholder-value',
4080
+ * });
4081
+ * console.log(res.data);
4082
+ *
4083
+ * // Example response
4084
+ * // {
4085
+ * // "accounts": [],
4086
+ * // "corpus": "my_corpus",
4087
+ * // "holdId": "my_holdId",
4088
+ * // "name": "my_name",
4089
+ * // "orgUnit": {},
4090
+ * // "query": {},
4091
+ * // "updateTime": "my_updateTime"
4092
+ * // }
4093
+ * }
4094
+ *
4095
+ * main().catch(e => {
4096
+ * console.error(e);
4097
+ * throw e;
4098
+ * });
4099
+ *
4100
+ * ```
3017
4101
  *
3018
4102
  * @param params - Parameters for request
3019
4103
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3105,6 +4189,62 @@ export namespace vault_v1 {
3105
4189
 
3106
4190
  /**
3107
4191
  * Lists the holds in a matter.
4192
+ * @example
4193
+ * ```js
4194
+ * // Before running the sample:
4195
+ * // - Enable the API at:
4196
+ * // https://console.developers.google.com/apis/api/vault.googleapis.com
4197
+ * // - Login into gcloud by running:
4198
+ * // ```sh
4199
+ * // $ gcloud auth application-default login
4200
+ * // ```
4201
+ * // - Install the npm module by running:
4202
+ * // ```sh
4203
+ * // $ npm install googleapis
4204
+ * // ```
4205
+ *
4206
+ * const {google} = require('googleapis');
4207
+ * const vault = google.vault('v1');
4208
+ *
4209
+ * async function main() {
4210
+ * const auth = new google.auth.GoogleAuth({
4211
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4212
+ * scopes: [
4213
+ * 'https://www.googleapis.com/auth/ediscovery',
4214
+ * 'https://www.googleapis.com/auth/ediscovery.readonly',
4215
+ * ],
4216
+ * });
4217
+ *
4218
+ * // Acquire an auth client, and bind it to all future calls
4219
+ * const authClient = await auth.getClient();
4220
+ * google.options({auth: authClient});
4221
+ *
4222
+ * // Do the magic
4223
+ * const res = await vault.matters.holds.list({
4224
+ * // The matter ID.
4225
+ * matterId: 'placeholder-value',
4226
+ * // 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.
4227
+ * pageSize: 'placeholder-value',
4228
+ * // The pagination token as returned in the response. An empty token means start from the beginning.
4229
+ * pageToken: 'placeholder-value',
4230
+ * // The amount of detail to return for a hold.
4231
+ * view: 'placeholder-value',
4232
+ * });
4233
+ * console.log(res.data);
4234
+ *
4235
+ * // Example response
4236
+ * // {
4237
+ * // "holds": [],
4238
+ * // "nextPageToken": "my_nextPageToken"
4239
+ * // }
4240
+ * }
4241
+ *
4242
+ * main().catch(e => {
4243
+ * console.error(e);
4244
+ * throw e;
4245
+ * });
4246
+ *
4247
+ * ```
3108
4248
  *
3109
4249
  * @param params - Parameters for request
3110
4250
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3196,6 +4336,62 @@ export namespace vault_v1 {
3196
4336
 
3197
4337
  /**
3198
4338
  * Removes the specified accounts from a hold. Returns a list of statuses in the same order as the request.
4339
+ * @example
4340
+ * ```js
4341
+ * // Before running the sample:
4342
+ * // - Enable the API at:
4343
+ * // https://console.developers.google.com/apis/api/vault.googleapis.com
4344
+ * // - Login into gcloud by running:
4345
+ * // ```sh
4346
+ * // $ gcloud auth application-default login
4347
+ * // ```
4348
+ * // - Install the npm module by running:
4349
+ * // ```sh
4350
+ * // $ npm install googleapis
4351
+ * // ```
4352
+ *
4353
+ * const {google} = require('googleapis');
4354
+ * const vault = google.vault('v1');
4355
+ *
4356
+ * async function main() {
4357
+ * const auth = new google.auth.GoogleAuth({
4358
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4359
+ * scopes: ['https://www.googleapis.com/auth/ediscovery'],
4360
+ * });
4361
+ *
4362
+ * // Acquire an auth client, and bind it to all future calls
4363
+ * const authClient = await auth.getClient();
4364
+ * google.options({auth: authClient});
4365
+ *
4366
+ * // Do the magic
4367
+ * const res = await vault.matters.holds.removeHeldAccounts({
4368
+ * // The hold ID.
4369
+ * holdId: 'placeholder-value',
4370
+ * // The matter ID.
4371
+ * matterId: 'placeholder-value',
4372
+ *
4373
+ * // Request body metadata
4374
+ * requestBody: {
4375
+ * // request body parameters
4376
+ * // {
4377
+ * // "accountIds": []
4378
+ * // }
4379
+ * },
4380
+ * });
4381
+ * console.log(res.data);
4382
+ *
4383
+ * // Example response
4384
+ * // {
4385
+ * // "statuses": []
4386
+ * // }
4387
+ * }
4388
+ *
4389
+ * main().catch(e => {
4390
+ * console.error(e);
4391
+ * throw e;
4392
+ * });
4393
+ *
4394
+ * ```
3199
4395
  *
3200
4396
  * @param params - Parameters for request
3201
4397
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3291,6 +4487,74 @@ export namespace vault_v1 {
3291
4487
 
3292
4488
  /**
3293
4489
  * 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.
4490
+ * @example
4491
+ * ```js
4492
+ * // Before running the sample:
4493
+ * // - Enable the API at:
4494
+ * // https://console.developers.google.com/apis/api/vault.googleapis.com
4495
+ * // - Login into gcloud by running:
4496
+ * // ```sh
4497
+ * // $ gcloud auth application-default login
4498
+ * // ```
4499
+ * // - Install the npm module by running:
4500
+ * // ```sh
4501
+ * // $ npm install googleapis
4502
+ * // ```
4503
+ *
4504
+ * const {google} = require('googleapis');
4505
+ * const vault = google.vault('v1');
4506
+ *
4507
+ * async function main() {
4508
+ * const auth = new google.auth.GoogleAuth({
4509
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4510
+ * scopes: ['https://www.googleapis.com/auth/ediscovery'],
4511
+ * });
4512
+ *
4513
+ * // Acquire an auth client, and bind it to all future calls
4514
+ * const authClient = await auth.getClient();
4515
+ * google.options({auth: authClient});
4516
+ *
4517
+ * // Do the magic
4518
+ * const res = await vault.matters.holds.update({
4519
+ * // The ID of the hold.
4520
+ * holdId: 'placeholder-value',
4521
+ * // The matter ID.
4522
+ * matterId: 'placeholder-value',
4523
+ *
4524
+ * // Request body metadata
4525
+ * requestBody: {
4526
+ * // request body parameters
4527
+ * // {
4528
+ * // "accounts": [],
4529
+ * // "corpus": "my_corpus",
4530
+ * // "holdId": "my_holdId",
4531
+ * // "name": "my_name",
4532
+ * // "orgUnit": {},
4533
+ * // "query": {},
4534
+ * // "updateTime": "my_updateTime"
4535
+ * // }
4536
+ * },
4537
+ * });
4538
+ * console.log(res.data);
4539
+ *
4540
+ * // Example response
4541
+ * // {
4542
+ * // "accounts": [],
4543
+ * // "corpus": "my_corpus",
4544
+ * // "holdId": "my_holdId",
4545
+ * // "name": "my_name",
4546
+ * // "orgUnit": {},
4547
+ * // "query": {},
4548
+ * // "updateTime": "my_updateTime"
4549
+ * // }
4550
+ * }
4551
+ *
4552
+ * main().catch(e => {
4553
+ * console.error(e);
4554
+ * throw e;
4555
+ * });
4556
+ *
4557
+ * ```
3294
4558
  *
3295
4559
  * @param params - Parameters for request
3296
4560
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3495,6 +4759,70 @@ export namespace vault_v1 {
3495
4759
 
3496
4760
  /**
3497
4761
  * 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.
4762
+ * @example
4763
+ * ```js
4764
+ * // Before running the sample:
4765
+ * // - Enable the API at:
4766
+ * // https://console.developers.google.com/apis/api/vault.googleapis.com
4767
+ * // - Login into gcloud by running:
4768
+ * // ```sh
4769
+ * // $ gcloud auth application-default login
4770
+ * // ```
4771
+ * // - Install the npm module by running:
4772
+ * // ```sh
4773
+ * // $ npm install googleapis
4774
+ * // ```
4775
+ *
4776
+ * const {google} = require('googleapis');
4777
+ * const vault = google.vault('v1');
4778
+ *
4779
+ * async function main() {
4780
+ * const auth = new google.auth.GoogleAuth({
4781
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4782
+ * scopes: ['https://www.googleapis.com/auth/ediscovery'],
4783
+ * });
4784
+ *
4785
+ * // Acquire an auth client, and bind it to all future calls
4786
+ * const authClient = await auth.getClient();
4787
+ * google.options({auth: authClient});
4788
+ *
4789
+ * // Do the magic
4790
+ * const res = await vault.matters.holds.accounts.create({
4791
+ * // The hold ID.
4792
+ * holdId: 'placeholder-value',
4793
+ * // The matter ID.
4794
+ * matterId: 'placeholder-value',
4795
+ *
4796
+ * // Request body metadata
4797
+ * requestBody: {
4798
+ * // request body parameters
4799
+ * // {
4800
+ * // "accountId": "my_accountId",
4801
+ * // "email": "my_email",
4802
+ * // "firstName": "my_firstName",
4803
+ * // "holdTime": "my_holdTime",
4804
+ * // "lastName": "my_lastName"
4805
+ * // }
4806
+ * },
4807
+ * });
4808
+ * console.log(res.data);
4809
+ *
4810
+ * // Example response
4811
+ * // {
4812
+ * // "accountId": "my_accountId",
4813
+ * // "email": "my_email",
4814
+ * // "firstName": "my_firstName",
4815
+ * // "holdTime": "my_holdTime",
4816
+ * // "lastName": "my_lastName"
4817
+ * // }
4818
+ * }
4819
+ *
4820
+ * main().catch(e => {
4821
+ * console.error(e);
4822
+ * throw e;
4823
+ * });
4824
+ *
4825
+ * ```
3498
4826
  *
3499
4827
  * @param params - Parameters for request
3500
4828
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3585,6 +4913,54 @@ export namespace vault_v1 {
3585
4913
 
3586
4914
  /**
3587
4915
  * Removes an account from a hold.
4916
+ * @example
4917
+ * ```js
4918
+ * // Before running the sample:
4919
+ * // - Enable the API at:
4920
+ * // https://console.developers.google.com/apis/api/vault.googleapis.com
4921
+ * // - Login into gcloud by running:
4922
+ * // ```sh
4923
+ * // $ gcloud auth application-default login
4924
+ * // ```
4925
+ * // - Install the npm module by running:
4926
+ * // ```sh
4927
+ * // $ npm install googleapis
4928
+ * // ```
4929
+ *
4930
+ * const {google} = require('googleapis');
4931
+ * const vault = google.vault('v1');
4932
+ *
4933
+ * async function main() {
4934
+ * const auth = new google.auth.GoogleAuth({
4935
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4936
+ * scopes: ['https://www.googleapis.com/auth/ediscovery'],
4937
+ * });
4938
+ *
4939
+ * // Acquire an auth client, and bind it to all future calls
4940
+ * const authClient = await auth.getClient();
4941
+ * google.options({auth: authClient});
4942
+ *
4943
+ * // Do the magic
4944
+ * const res = await vault.matters.holds.accounts.delete({
4945
+ * // The ID of the account to remove from the hold.
4946
+ * accountId: 'placeholder-value',
4947
+ * // The hold ID.
4948
+ * holdId: 'placeholder-value',
4949
+ * // The matter ID.
4950
+ * matterId: 'placeholder-value',
4951
+ * });
4952
+ * console.log(res.data);
4953
+ *
4954
+ * // Example response
4955
+ * // {}
4956
+ * }
4957
+ *
4958
+ * main().catch(e => {
4959
+ * console.error(e);
4960
+ * throw e;
4961
+ * });
4962
+ *
4963
+ * ```
3588
4964
  *
3589
4965
  * @param params - Parameters for request
3590
4966
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3676,6 +5052,57 @@ export namespace vault_v1 {
3676
5052
 
3677
5053
  /**
3678
5054
  * 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.
5055
+ * @example
5056
+ * ```js
5057
+ * // Before running the sample:
5058
+ * // - Enable the API at:
5059
+ * // https://console.developers.google.com/apis/api/vault.googleapis.com
5060
+ * // - Login into gcloud by running:
5061
+ * // ```sh
5062
+ * // $ gcloud auth application-default login
5063
+ * // ```
5064
+ * // - Install the npm module by running:
5065
+ * // ```sh
5066
+ * // $ npm install googleapis
5067
+ * // ```
5068
+ *
5069
+ * const {google} = require('googleapis');
5070
+ * const vault = google.vault('v1');
5071
+ *
5072
+ * async function main() {
5073
+ * const auth = new google.auth.GoogleAuth({
5074
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5075
+ * scopes: [
5076
+ * 'https://www.googleapis.com/auth/ediscovery',
5077
+ * 'https://www.googleapis.com/auth/ediscovery.readonly',
5078
+ * ],
5079
+ * });
5080
+ *
5081
+ * // Acquire an auth client, and bind it to all future calls
5082
+ * const authClient = await auth.getClient();
5083
+ * google.options({auth: authClient});
5084
+ *
5085
+ * // Do the magic
5086
+ * const res = await vault.matters.holds.accounts.list({
5087
+ * // The hold ID.
5088
+ * holdId: 'placeholder-value',
5089
+ * // The matter ID.
5090
+ * matterId: 'placeholder-value',
5091
+ * });
5092
+ * console.log(res.data);
5093
+ *
5094
+ * // Example response
5095
+ * // {
5096
+ * // "accounts": []
5097
+ * // }
5098
+ * }
5099
+ *
5100
+ * main().catch(e => {
5101
+ * console.error(e);
5102
+ * throw e;
5103
+ * });
5104
+ *
5105
+ * ```
3679
5106
  *
3680
5107
  * @param params - Parameters for request
3681
5108
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3818,6 +5245,68 @@ export namespace vault_v1 {
3818
5245
 
3819
5246
  /**
3820
5247
  * Creates a saved query.
5248
+ * @example
5249
+ * ```js
5250
+ * // Before running the sample:
5251
+ * // - Enable the API at:
5252
+ * // https://console.developers.google.com/apis/api/vault.googleapis.com
5253
+ * // - Login into gcloud by running:
5254
+ * // ```sh
5255
+ * // $ gcloud auth application-default login
5256
+ * // ```
5257
+ * // - Install the npm module by running:
5258
+ * // ```sh
5259
+ * // $ npm install googleapis
5260
+ * // ```
5261
+ *
5262
+ * const {google} = require('googleapis');
5263
+ * const vault = google.vault('v1');
5264
+ *
5265
+ * async function main() {
5266
+ * const auth = new google.auth.GoogleAuth({
5267
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5268
+ * scopes: ['https://www.googleapis.com/auth/ediscovery'],
5269
+ * });
5270
+ *
5271
+ * // Acquire an auth client, and bind it to all future calls
5272
+ * const authClient = await auth.getClient();
5273
+ * google.options({auth: authClient});
5274
+ *
5275
+ * // Do the magic
5276
+ * const res = await vault.matters.savedQueries.create({
5277
+ * // The ID of the matter to create the saved query in.
5278
+ * matterId: 'placeholder-value',
5279
+ *
5280
+ * // Request body metadata
5281
+ * requestBody: {
5282
+ * // request body parameters
5283
+ * // {
5284
+ * // "createTime": "my_createTime",
5285
+ * // "displayName": "my_displayName",
5286
+ * // "matterId": "my_matterId",
5287
+ * // "query": {},
5288
+ * // "savedQueryId": "my_savedQueryId"
5289
+ * // }
5290
+ * },
5291
+ * });
5292
+ * console.log(res.data);
5293
+ *
5294
+ * // Example response
5295
+ * // {
5296
+ * // "createTime": "my_createTime",
5297
+ * // "displayName": "my_displayName",
5298
+ * // "matterId": "my_matterId",
5299
+ * // "query": {},
5300
+ * // "savedQueryId": "my_savedQueryId"
5301
+ * // }
5302
+ * }
5303
+ *
5304
+ * main().catch(e => {
5305
+ * console.error(e);
5306
+ * throw e;
5307
+ * });
5308
+ *
5309
+ * ```
3821
5310
  *
3822
5311
  * @param params - Parameters for request
3823
5312
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3909,6 +5398,52 @@ export namespace vault_v1 {
3909
5398
 
3910
5399
  /**
3911
5400
  * Deletes the specified saved query.
5401
+ * @example
5402
+ * ```js
5403
+ * // Before running the sample:
5404
+ * // - Enable the API at:
5405
+ * // https://console.developers.google.com/apis/api/vault.googleapis.com
5406
+ * // - Login into gcloud by running:
5407
+ * // ```sh
5408
+ * // $ gcloud auth application-default login
5409
+ * // ```
5410
+ * // - Install the npm module by running:
5411
+ * // ```sh
5412
+ * // $ npm install googleapis
5413
+ * // ```
5414
+ *
5415
+ * const {google} = require('googleapis');
5416
+ * const vault = google.vault('v1');
5417
+ *
5418
+ * async function main() {
5419
+ * const auth = new google.auth.GoogleAuth({
5420
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5421
+ * scopes: ['https://www.googleapis.com/auth/ediscovery'],
5422
+ * });
5423
+ *
5424
+ * // Acquire an auth client, and bind it to all future calls
5425
+ * const authClient = await auth.getClient();
5426
+ * google.options({auth: authClient});
5427
+ *
5428
+ * // Do the magic
5429
+ * const res = await vault.matters.savedQueries.delete({
5430
+ * // The ID of the matter to delete the saved query from.
5431
+ * matterId: 'placeholder-value',
5432
+ * // ID of the saved query to delete.
5433
+ * savedQueryId: 'placeholder-value',
5434
+ * });
5435
+ * console.log(res.data);
5436
+ *
5437
+ * // Example response
5438
+ * // {}
5439
+ * }
5440
+ *
5441
+ * main().catch(e => {
5442
+ * console.error(e);
5443
+ * throw e;
5444
+ * });
5445
+ *
5446
+ * ```
3912
5447
  *
3913
5448
  * @param params - Parameters for request
3914
5449
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3999,6 +5534,61 @@ export namespace vault_v1 {
3999
5534
 
4000
5535
  /**
4001
5536
  * Retrieves the specified saved query.
5537
+ * @example
5538
+ * ```js
5539
+ * // Before running the sample:
5540
+ * // - Enable the API at:
5541
+ * // https://console.developers.google.com/apis/api/vault.googleapis.com
5542
+ * // - Login into gcloud by running:
5543
+ * // ```sh
5544
+ * // $ gcloud auth application-default login
5545
+ * // ```
5546
+ * // - Install the npm module by running:
5547
+ * // ```sh
5548
+ * // $ npm install googleapis
5549
+ * // ```
5550
+ *
5551
+ * const {google} = require('googleapis');
5552
+ * const vault = google.vault('v1');
5553
+ *
5554
+ * async function main() {
5555
+ * const auth = new google.auth.GoogleAuth({
5556
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5557
+ * scopes: [
5558
+ * 'https://www.googleapis.com/auth/ediscovery',
5559
+ * 'https://www.googleapis.com/auth/ediscovery.readonly',
5560
+ * ],
5561
+ * });
5562
+ *
5563
+ * // Acquire an auth client, and bind it to all future calls
5564
+ * const authClient = await auth.getClient();
5565
+ * google.options({auth: authClient});
5566
+ *
5567
+ * // Do the magic
5568
+ * const res = await vault.matters.savedQueries.get({
5569
+ * // The ID of the matter to get the saved query from.
5570
+ * matterId: 'placeholder-value',
5571
+ * // ID of the saved query to retrieve.
5572
+ * savedQueryId: 'placeholder-value',
5573
+ * });
5574
+ * console.log(res.data);
5575
+ *
5576
+ * // Example response
5577
+ * // {
5578
+ * // "createTime": "my_createTime",
5579
+ * // "displayName": "my_displayName",
5580
+ * // "matterId": "my_matterId",
5581
+ * // "query": {},
5582
+ * // "savedQueryId": "my_savedQueryId"
5583
+ * // }
5584
+ * }
5585
+ *
5586
+ * main().catch(e => {
5587
+ * console.error(e);
5588
+ * throw e;
5589
+ * });
5590
+ *
5591
+ * ```
4002
5592
  *
4003
5593
  * @param params - Parameters for request
4004
5594
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -4089,6 +5679,60 @@ export namespace vault_v1 {
4089
5679
 
4090
5680
  /**
4091
5681
  * Lists the saved queries in a matter.
5682
+ * @example
5683
+ * ```js
5684
+ * // Before running the sample:
5685
+ * // - Enable the API at:
5686
+ * // https://console.developers.google.com/apis/api/vault.googleapis.com
5687
+ * // - Login into gcloud by running:
5688
+ * // ```sh
5689
+ * // $ gcloud auth application-default login
5690
+ * // ```
5691
+ * // - Install the npm module by running:
5692
+ * // ```sh
5693
+ * // $ npm install googleapis
5694
+ * // ```
5695
+ *
5696
+ * const {google} = require('googleapis');
5697
+ * const vault = google.vault('v1');
5698
+ *
5699
+ * async function main() {
5700
+ * const auth = new google.auth.GoogleAuth({
5701
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5702
+ * scopes: [
5703
+ * 'https://www.googleapis.com/auth/ediscovery',
5704
+ * 'https://www.googleapis.com/auth/ediscovery.readonly',
5705
+ * ],
5706
+ * });
5707
+ *
5708
+ * // Acquire an auth client, and bind it to all future calls
5709
+ * const authClient = await auth.getClient();
5710
+ * google.options({auth: authClient});
5711
+ *
5712
+ * // Do the magic
5713
+ * const res = await vault.matters.savedQueries.list({
5714
+ * // The ID of the matter to get the saved queries for.
5715
+ * matterId: 'placeholder-value',
5716
+ * // The maximum number of saved queries to return.
5717
+ * pageSize: 'placeholder-value',
5718
+ * // The pagination token as returned in the previous response. An empty token means start from the beginning.
5719
+ * pageToken: 'placeholder-value',
5720
+ * });
5721
+ * console.log(res.data);
5722
+ *
5723
+ * // Example response
5724
+ * // {
5725
+ * // "nextPageToken": "my_nextPageToken",
5726
+ * // "savedQueries": []
5727
+ * // }
5728
+ * }
5729
+ *
5730
+ * main().catch(e => {
5731
+ * console.error(e);
5732
+ * throw e;
5733
+ * });
5734
+ *
5735
+ * ```
4092
5736
  *
4093
5737
  * @param params - Parameters for request
4094
5738
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -4239,6 +5883,56 @@ export namespace vault_v1 {
4239
5883
 
4240
5884
  /**
4241
5885
  * 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`.
5886
+ * @example
5887
+ * ```js
5888
+ * // Before running the sample:
5889
+ * // - Enable the API at:
5890
+ * // https://console.developers.google.com/apis/api/vault.googleapis.com
5891
+ * // - Login into gcloud by running:
5892
+ * // ```sh
5893
+ * // $ gcloud auth application-default login
5894
+ * // ```
5895
+ * // - Install the npm module by running:
5896
+ * // ```sh
5897
+ * // $ npm install googleapis
5898
+ * // ```
5899
+ *
5900
+ * const {google} = require('googleapis');
5901
+ * const vault = google.vault('v1');
5902
+ *
5903
+ * async function main() {
5904
+ * const auth = new google.auth.GoogleAuth({
5905
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5906
+ * scopes: ['https://www.googleapis.com/auth/ediscovery'],
5907
+ * });
5908
+ *
5909
+ * // Acquire an auth client, and bind it to all future calls
5910
+ * const authClient = await auth.getClient();
5911
+ * google.options({auth: authClient});
5912
+ *
5913
+ * // Do the magic
5914
+ * const res = await vault.operations.cancel({
5915
+ * // The name of the operation resource to be cancelled.
5916
+ * name: 'operations/.*',
5917
+ *
5918
+ * // Request body metadata
5919
+ * requestBody: {
5920
+ * // request body parameters
5921
+ * // {}
5922
+ * },
5923
+ * });
5924
+ * console.log(res.data);
5925
+ *
5926
+ * // Example response
5927
+ * // {}
5928
+ * }
5929
+ *
5930
+ * main().catch(e => {
5931
+ * console.error(e);
5932
+ * throw e;
5933
+ * });
5934
+ *
5935
+ * ```
4242
5936
  *
4243
5937
  * @param params - Parameters for request
4244
5938
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -4327,6 +6021,50 @@ export namespace vault_v1 {
4327
6021
 
4328
6022
  /**
4329
6023
  * 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`.
6024
+ * @example
6025
+ * ```js
6026
+ * // Before running the sample:
6027
+ * // - Enable the API at:
6028
+ * // https://console.developers.google.com/apis/api/vault.googleapis.com
6029
+ * // - Login into gcloud by running:
6030
+ * // ```sh
6031
+ * // $ gcloud auth application-default login
6032
+ * // ```
6033
+ * // - Install the npm module by running:
6034
+ * // ```sh
6035
+ * // $ npm install googleapis
6036
+ * // ```
6037
+ *
6038
+ * const {google} = require('googleapis');
6039
+ * const vault = google.vault('v1');
6040
+ *
6041
+ * async function main() {
6042
+ * const auth = new google.auth.GoogleAuth({
6043
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
6044
+ * scopes: ['https://www.googleapis.com/auth/ediscovery'],
6045
+ * });
6046
+ *
6047
+ * // Acquire an auth client, and bind it to all future calls
6048
+ * const authClient = await auth.getClient();
6049
+ * google.options({auth: authClient});
6050
+ *
6051
+ * // Do the magic
6052
+ * const res = await vault.operations.delete({
6053
+ * // The name of the operation resource to be deleted.
6054
+ * name: 'operations/.*',
6055
+ * });
6056
+ * console.log(res.data);
6057
+ *
6058
+ * // Example response
6059
+ * // {}
6060
+ * }
6061
+ *
6062
+ * main().catch(e => {
6063
+ * console.error(e);
6064
+ * throw e;
6065
+ * });
6066
+ *
6067
+ * ```
4330
6068
  *
4331
6069
  * @param params - Parameters for request
4332
6070
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -4415,6 +6153,59 @@ export namespace vault_v1 {
4415
6153
 
4416
6154
  /**
4417
6155
  * 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.
6156
+ * @example
6157
+ * ```js
6158
+ * // Before running the sample:
6159
+ * // - Enable the API at:
6160
+ * // https://console.developers.google.com/apis/api/vault.googleapis.com
6161
+ * // - Login into gcloud by running:
6162
+ * // ```sh
6163
+ * // $ gcloud auth application-default login
6164
+ * // ```
6165
+ * // - Install the npm module by running:
6166
+ * // ```sh
6167
+ * // $ npm install googleapis
6168
+ * // ```
6169
+ *
6170
+ * const {google} = require('googleapis');
6171
+ * const vault = google.vault('v1');
6172
+ *
6173
+ * async function main() {
6174
+ * const auth = new google.auth.GoogleAuth({
6175
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
6176
+ * scopes: [
6177
+ * 'https://www.googleapis.com/auth/ediscovery',
6178
+ * 'https://www.googleapis.com/auth/ediscovery.readonly',
6179
+ * ],
6180
+ * });
6181
+ *
6182
+ * // Acquire an auth client, and bind it to all future calls
6183
+ * const authClient = await auth.getClient();
6184
+ * google.options({auth: authClient});
6185
+ *
6186
+ * // Do the magic
6187
+ * const res = await vault.operations.get({
6188
+ * // The name of the operation resource.
6189
+ * name: 'operations/.*',
6190
+ * });
6191
+ * console.log(res.data);
6192
+ *
6193
+ * // Example response
6194
+ * // {
6195
+ * // "done": false,
6196
+ * // "error": {},
6197
+ * // "metadata": {},
6198
+ * // "name": "my_name",
6199
+ * // "response": {}
6200
+ * // }
6201
+ * }
6202
+ *
6203
+ * main().catch(e => {
6204
+ * console.error(e);
6205
+ * throw e;
6206
+ * });
6207
+ *
6208
+ * ```
4418
6209
  *
4419
6210
  * @param params - Parameters for request
4420
6211
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -4502,6 +6293,62 @@ export namespace vault_v1 {
4502
6293
 
4503
6294
  /**
4504
6295
  * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
6296
+ * @example
6297
+ * ```js
6298
+ * // Before running the sample:
6299
+ * // - Enable the API at:
6300
+ * // https://console.developers.google.com/apis/api/vault.googleapis.com
6301
+ * // - Login into gcloud by running:
6302
+ * // ```sh
6303
+ * // $ gcloud auth application-default login
6304
+ * // ```
6305
+ * // - Install the npm module by running:
6306
+ * // ```sh
6307
+ * // $ npm install googleapis
6308
+ * // ```
6309
+ *
6310
+ * const {google} = require('googleapis');
6311
+ * const vault = google.vault('v1');
6312
+ *
6313
+ * async function main() {
6314
+ * const auth = new google.auth.GoogleAuth({
6315
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
6316
+ * scopes: [
6317
+ * 'https://www.googleapis.com/auth/ediscovery',
6318
+ * 'https://www.googleapis.com/auth/ediscovery.readonly',
6319
+ * ],
6320
+ * });
6321
+ *
6322
+ * // Acquire an auth client, and bind it to all future calls
6323
+ * const authClient = await auth.getClient();
6324
+ * google.options({auth: authClient});
6325
+ *
6326
+ * // Do the magic
6327
+ * const res = await vault.operations.list({
6328
+ * // The standard list filter.
6329
+ * filter: 'placeholder-value',
6330
+ * // The name of the operation's parent resource.
6331
+ * name: 'operations',
6332
+ * // The standard list page size.
6333
+ * pageSize: 'placeholder-value',
6334
+ * // The standard list page token.
6335
+ * pageToken: 'placeholder-value',
6336
+ * });
6337
+ * console.log(res.data);
6338
+ *
6339
+ * // Example response
6340
+ * // {
6341
+ * // "nextPageToken": "my_nextPageToken",
6342
+ * // "operations": []
6343
+ * // }
6344
+ * }
6345
+ *
6346
+ * main().catch(e => {
6347
+ * console.error(e);
6348
+ * throw e;
6349
+ * });
6350
+ *
6351
+ * ```
4505
6352
  *
4506
6353
  * @param params - Parameters for request
4507
6354
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.