@googleapis/vault 3.0.1 → 3.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
@@ -1095,59 +1095,6 @@ export namespace vault_v1 {
1095
1095
 
1096
1096
  /**
1097
1097
  * Adds an account as a matter collaborator.
1098
- * @example
1099
- * ```js
1100
- * // Before running the sample:
1101
- * // - Enable the API at:
1102
- * // https://console.developers.google.com/apis/api/vault.googleapis.com
1103
- * // - Login into gcloud by running:
1104
- * // `$ gcloud auth application-default login`
1105
- * // - Install the npm module by running:
1106
- * // `$ npm install googleapis`
1107
- *
1108
- * const {google} = require('googleapis');
1109
- * const vault = google.vault('v1');
1110
- *
1111
- * async function main() {
1112
- * const auth = new google.auth.GoogleAuth({
1113
- * // Scopes can be specified either as an array or as a single, space-delimited string.
1114
- * scopes: ['https://www.googleapis.com/auth/ediscovery'],
1115
- * });
1116
- *
1117
- * // Acquire an auth client, and bind it to all future calls
1118
- * const authClient = await auth.getClient();
1119
- * google.options({auth: authClient});
1120
- *
1121
- * // Do the magic
1122
- * const res = await vault.matters.addPermissions({
1123
- * // The matter ID.
1124
- * matterId: 'placeholder-value',
1125
- *
1126
- * // Request body metadata
1127
- * requestBody: {
1128
- * // request body parameters
1129
- * // {
1130
- * // "ccMe": false,
1131
- * // "matterPermission": {},
1132
- * // "sendEmails": false
1133
- * // }
1134
- * },
1135
- * });
1136
- * console.log(res.data);
1137
- *
1138
- * // Example response
1139
- * // {
1140
- * // "accountId": "my_accountId",
1141
- * // "role": "my_role"
1142
- * // }
1143
- * }
1144
- *
1145
- * main().catch(e => {
1146
- * console.error(e);
1147
- * throw e;
1148
- * });
1149
- *
1150
- * ```
1151
1098
  *
1152
1099
  * @param params - Parameters for request
1153
1100
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1237,54 +1184,6 @@ export namespace vault_v1 {
1237
1184
 
1238
1185
  /**
1239
1186
  * Closes the specified matter. Returns the matter with updated state.
1240
- * @example
1241
- * ```js
1242
- * // Before running the sample:
1243
- * // - Enable the API at:
1244
- * // https://console.developers.google.com/apis/api/vault.googleapis.com
1245
- * // - Login into gcloud by running:
1246
- * // `$ gcloud auth application-default login`
1247
- * // - Install the npm module by running:
1248
- * // `$ npm install googleapis`
1249
- *
1250
- * const {google} = require('googleapis');
1251
- * const vault = google.vault('v1');
1252
- *
1253
- * async function main() {
1254
- * const auth = new google.auth.GoogleAuth({
1255
- * // Scopes can be specified either as an array or as a single, space-delimited string.
1256
- * scopes: ['https://www.googleapis.com/auth/ediscovery'],
1257
- * });
1258
- *
1259
- * // Acquire an auth client, and bind it to all future calls
1260
- * const authClient = await auth.getClient();
1261
- * google.options({auth: authClient});
1262
- *
1263
- * // Do the magic
1264
- * const res = await vault.matters.close({
1265
- * // The matter ID.
1266
- * matterId: 'placeholder-value',
1267
- *
1268
- * // Request body metadata
1269
- * requestBody: {
1270
- * // request body parameters
1271
- * // {}
1272
- * },
1273
- * });
1274
- * console.log(res.data);
1275
- *
1276
- * // Example response
1277
- * // {
1278
- * // "matter": {}
1279
- * // }
1280
- * }
1281
- *
1282
- * main().catch(e => {
1283
- * console.error(e);
1284
- * throw e;
1285
- * });
1286
- *
1287
- * ```
1288
1187
  *
1289
1188
  * @param params - Parameters for request
1290
1189
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1374,61 +1273,6 @@ export namespace vault_v1 {
1374
1273
 
1375
1274
  /**
1376
1275
  * Counts the accounts processed by the specified query.
1377
- * @example
1378
- * ```js
1379
- * // Before running the sample:
1380
- * // - Enable the API at:
1381
- * // https://console.developers.google.com/apis/api/vault.googleapis.com
1382
- * // - Login into gcloud by running:
1383
- * // `$ gcloud auth application-default login`
1384
- * // - Install the npm module by running:
1385
- * // `$ npm install googleapis`
1386
- *
1387
- * const {google} = require('googleapis');
1388
- * const vault = google.vault('v1');
1389
- *
1390
- * async function main() {
1391
- * const auth = new google.auth.GoogleAuth({
1392
- * // Scopes can be specified either as an array or as a single, space-delimited string.
1393
- * scopes: ['https://www.googleapis.com/auth/ediscovery'],
1394
- * });
1395
- *
1396
- * // Acquire an auth client, and bind it to all future calls
1397
- * const authClient = await auth.getClient();
1398
- * google.options({auth: authClient});
1399
- *
1400
- * // Do the magic
1401
- * const res = await vault.matters.count({
1402
- * // The matter ID.
1403
- * matterId: 'placeholder-value',
1404
- *
1405
- * // Request body metadata
1406
- * requestBody: {
1407
- * // request body parameters
1408
- * // {
1409
- * // "query": {},
1410
- * // "view": "my_view"
1411
- * // }
1412
- * },
1413
- * });
1414
- * console.log(res.data);
1415
- *
1416
- * // Example response
1417
- * // {
1418
- * // "done": false,
1419
- * // "error": {},
1420
- * // "metadata": {},
1421
- * // "name": "my_name",
1422
- * // "response": {}
1423
- * // }
1424
- * }
1425
- *
1426
- * main().catch(e => {
1427
- * console.error(e);
1428
- * throw e;
1429
- * });
1430
- *
1431
- * ```
1432
1276
  *
1433
1277
  * @param params - Parameters for request
1434
1278
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1515,61 +1359,6 @@ export namespace vault_v1 {
1515
1359
 
1516
1360
  /**
1517
1361
  * 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.
1518
- * @example
1519
- * ```js
1520
- * // Before running the sample:
1521
- * // - Enable the API at:
1522
- * // https://console.developers.google.com/apis/api/vault.googleapis.com
1523
- * // - Login into gcloud by running:
1524
- * // `$ gcloud auth application-default login`
1525
- * // - Install the npm module by running:
1526
- * // `$ npm install googleapis`
1527
- *
1528
- * const {google} = require('googleapis');
1529
- * const vault = google.vault('v1');
1530
- *
1531
- * async function main() {
1532
- * const auth = new google.auth.GoogleAuth({
1533
- * // Scopes can be specified either as an array or as a single, space-delimited string.
1534
- * scopes: ['https://www.googleapis.com/auth/ediscovery'],
1535
- * });
1536
- *
1537
- * // Acquire an auth client, and bind it to all future calls
1538
- * const authClient = await auth.getClient();
1539
- * google.options({auth: authClient});
1540
- *
1541
- * // Do the magic
1542
- * const res = await vault.matters.create({
1543
- * // Request body metadata
1544
- * requestBody: {
1545
- * // request body parameters
1546
- * // {
1547
- * // "description": "my_description",
1548
- * // "matterId": "my_matterId",
1549
- * // "matterPermissions": [],
1550
- * // "name": "my_name",
1551
- * // "state": "my_state"
1552
- * // }
1553
- * },
1554
- * });
1555
- * console.log(res.data);
1556
- *
1557
- * // Example response
1558
- * // {
1559
- * // "description": "my_description",
1560
- * // "matterId": "my_matterId",
1561
- * // "matterPermissions": [],
1562
- * // "name": "my_name",
1563
- * // "state": "my_state"
1564
- * // }
1565
- * }
1566
- *
1567
- * main().catch(e => {
1568
- * console.error(e);
1569
- * throw e;
1570
- * });
1571
- *
1572
- * ```
1573
1362
  *
1574
1363
  * @param params - Parameters for request
1575
1364
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1653,52 +1442,6 @@ export namespace vault_v1 {
1653
1442
 
1654
1443
  /**
1655
1444
  * Deletes the specified matter. Returns the matter with updated state.
1656
- * @example
1657
- * ```js
1658
- * // Before running the sample:
1659
- * // - Enable the API at:
1660
- * // https://console.developers.google.com/apis/api/vault.googleapis.com
1661
- * // - Login into gcloud by running:
1662
- * // `$ gcloud auth application-default login`
1663
- * // - Install the npm module by running:
1664
- * // `$ npm install googleapis`
1665
- *
1666
- * const {google} = require('googleapis');
1667
- * const vault = google.vault('v1');
1668
- *
1669
- * async function main() {
1670
- * const auth = new google.auth.GoogleAuth({
1671
- * // Scopes can be specified either as an array or as a single, space-delimited string.
1672
- * scopes: ['https://www.googleapis.com/auth/ediscovery'],
1673
- * });
1674
- *
1675
- * // Acquire an auth client, and bind it to all future calls
1676
- * const authClient = await auth.getClient();
1677
- * google.options({auth: authClient});
1678
- *
1679
- * // Do the magic
1680
- * const res = await vault.matters.delete({
1681
- * // The matter ID
1682
- * matterId: 'placeholder-value',
1683
- * });
1684
- * console.log(res.data);
1685
- *
1686
- * // Example response
1687
- * // {
1688
- * // "description": "my_description",
1689
- * // "matterId": "my_matterId",
1690
- * // "matterPermissions": [],
1691
- * // "name": "my_name",
1692
- * // "state": "my_state"
1693
- * // }
1694
- * }
1695
- *
1696
- * main().catch(e => {
1697
- * console.error(e);
1698
- * throw e;
1699
- * });
1700
- *
1701
- * ```
1702
1445
  *
1703
1446
  * @param params - Parameters for request
1704
1447
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1785,57 +1528,6 @@ export namespace vault_v1 {
1785
1528
 
1786
1529
  /**
1787
1530
  * Gets the specified matter.
1788
- * @example
1789
- * ```js
1790
- * // Before running the sample:
1791
- * // - Enable the API at:
1792
- * // https://console.developers.google.com/apis/api/vault.googleapis.com
1793
- * // - Login into gcloud by running:
1794
- * // `$ gcloud auth application-default login`
1795
- * // - Install the npm module by running:
1796
- * // `$ npm install googleapis`
1797
- *
1798
- * const {google} = require('googleapis');
1799
- * const vault = google.vault('v1');
1800
- *
1801
- * async function main() {
1802
- * const auth = new google.auth.GoogleAuth({
1803
- * // Scopes can be specified either as an array or as a single, space-delimited string.
1804
- * scopes: [
1805
- * 'https://www.googleapis.com/auth/ediscovery',
1806
- * 'https://www.googleapis.com/auth/ediscovery.readonly',
1807
- * ],
1808
- * });
1809
- *
1810
- * // Acquire an auth client, and bind it to all future calls
1811
- * const authClient = await auth.getClient();
1812
- * google.options({auth: authClient});
1813
- *
1814
- * // Do the magic
1815
- * const res = await vault.matters.get({
1816
- * // The matter ID.
1817
- * matterId: 'placeholder-value',
1818
- * // Specifies how much information about the matter to return in the response.
1819
- * view: 'placeholder-value',
1820
- * });
1821
- * console.log(res.data);
1822
- *
1823
- * // Example response
1824
- * // {
1825
- * // "description": "my_description",
1826
- * // "matterId": "my_matterId",
1827
- * // "matterPermissions": [],
1828
- * // "name": "my_name",
1829
- * // "state": "my_state"
1830
- * // }
1831
- * }
1832
- *
1833
- * main().catch(e => {
1834
- * console.error(e);
1835
- * throw e;
1836
- * });
1837
- *
1838
- * ```
1839
1531
  *
1840
1532
  * @param params - Parameters for request
1841
1533
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1922,58 +1614,6 @@ export namespace vault_v1 {
1922
1614
 
1923
1615
  /**
1924
1616
  * Lists matters the requestor has access to.
1925
- * @example
1926
- * ```js
1927
- * // Before running the sample:
1928
- * // - Enable the API at:
1929
- * // https://console.developers.google.com/apis/api/vault.googleapis.com
1930
- * // - Login into gcloud by running:
1931
- * // `$ gcloud auth application-default login`
1932
- * // - Install the npm module by running:
1933
- * // `$ npm install googleapis`
1934
- *
1935
- * const {google} = require('googleapis');
1936
- * const vault = google.vault('v1');
1937
- *
1938
- * async function main() {
1939
- * const auth = new google.auth.GoogleAuth({
1940
- * // Scopes can be specified either as an array or as a single, space-delimited string.
1941
- * scopes: [
1942
- * 'https://www.googleapis.com/auth/ediscovery',
1943
- * 'https://www.googleapis.com/auth/ediscovery.readonly',
1944
- * ],
1945
- * });
1946
- *
1947
- * // Acquire an auth client, and bind it to all future calls
1948
- * const authClient = await auth.getClient();
1949
- * google.options({auth: authClient});
1950
- *
1951
- * // Do the magic
1952
- * const res = await vault.matters.list({
1953
- * // The number of matters to return in the response. Default and maximum are 100.
1954
- * pageSize: 'placeholder-value',
1955
- * // The pagination token as returned in the response.
1956
- * pageToken: 'placeholder-value',
1957
- * // If set, lists only matters with the specified state. The default lists matters of all states.
1958
- * state: 'placeholder-value',
1959
- * // Specifies how much information about the matter to return in response.
1960
- * view: 'placeholder-value',
1961
- * });
1962
- * console.log(res.data);
1963
- *
1964
- * // Example response
1965
- * // {
1966
- * // "matters": [],
1967
- * // "nextPageToken": "my_nextPageToken"
1968
- * // }
1969
- * }
1970
- *
1971
- * main().catch(e => {
1972
- * console.error(e);
1973
- * throw e;
1974
- * });
1975
- *
1976
- * ```
1977
1617
  *
1978
1618
  * @param params - Parameters for request
1979
1619
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2060,54 +1700,6 @@ export namespace vault_v1 {
2060
1700
 
2061
1701
  /**
2062
1702
  * Removes an account as a matter collaborator.
2063
- * @example
2064
- * ```js
2065
- * // Before running the sample:
2066
- * // - Enable the API at:
2067
- * // https://console.developers.google.com/apis/api/vault.googleapis.com
2068
- * // - Login into gcloud by running:
2069
- * // `$ gcloud auth application-default login`
2070
- * // - Install the npm module by running:
2071
- * // `$ npm install googleapis`
2072
- *
2073
- * const {google} = require('googleapis');
2074
- * const vault = google.vault('v1');
2075
- *
2076
- * async function main() {
2077
- * const auth = new google.auth.GoogleAuth({
2078
- * // Scopes can be specified either as an array or as a single, space-delimited string.
2079
- * scopes: ['https://www.googleapis.com/auth/ediscovery'],
2080
- * });
2081
- *
2082
- * // Acquire an auth client, and bind it to all future calls
2083
- * const authClient = await auth.getClient();
2084
- * google.options({auth: authClient});
2085
- *
2086
- * // Do the magic
2087
- * const res = await vault.matters.removePermissions({
2088
- * // The matter ID.
2089
- * matterId: 'placeholder-value',
2090
- *
2091
- * // Request body metadata
2092
- * requestBody: {
2093
- * // request body parameters
2094
- * // {
2095
- * // "accountId": "my_accountId"
2096
- * // }
2097
- * },
2098
- * });
2099
- * console.log(res.data);
2100
- *
2101
- * // Example response
2102
- * // {}
2103
- * }
2104
- *
2105
- * main().catch(e => {
2106
- * console.error(e);
2107
- * throw e;
2108
- * });
2109
- *
2110
- * ```
2111
1703
  *
2112
1704
  * @param params - Parameters for request
2113
1705
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2195,54 +1787,6 @@ export namespace vault_v1 {
2195
1787
 
2196
1788
  /**
2197
1789
  * Reopens the specified matter. Returns the matter with updated state.
2198
- * @example
2199
- * ```js
2200
- * // Before running the sample:
2201
- * // - Enable the API at:
2202
- * // https://console.developers.google.com/apis/api/vault.googleapis.com
2203
- * // - Login into gcloud by running:
2204
- * // `$ gcloud auth application-default login`
2205
- * // - Install the npm module by running:
2206
- * // `$ npm install googleapis`
2207
- *
2208
- * const {google} = require('googleapis');
2209
- * const vault = google.vault('v1');
2210
- *
2211
- * async function main() {
2212
- * const auth = new google.auth.GoogleAuth({
2213
- * // Scopes can be specified either as an array or as a single, space-delimited string.
2214
- * scopes: ['https://www.googleapis.com/auth/ediscovery'],
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.reopen({
2223
- * // The matter ID.
2224
- * matterId: 'placeholder-value',
2225
- *
2226
- * // Request body metadata
2227
- * requestBody: {
2228
- * // request body parameters
2229
- * // {}
2230
- * },
2231
- * });
2232
- * console.log(res.data);
2233
- *
2234
- * // Example response
2235
- * // {
2236
- * // "matter": {}
2237
- * // }
2238
- * }
2239
- *
2240
- * main().catch(e => {
2241
- * console.error(e);
2242
- * throw e;
2243
- * });
2244
- *
2245
- * ```
2246
1790
  *
2247
1791
  * @param params - Parameters for request
2248
1792
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2334,58 +1878,6 @@ export namespace vault_v1 {
2334
1878
 
2335
1879
  /**
2336
1880
  * Undeletes the specified matter. Returns the matter with updated state.
2337
- * @example
2338
- * ```js
2339
- * // Before running the sample:
2340
- * // - Enable the API at:
2341
- * // https://console.developers.google.com/apis/api/vault.googleapis.com
2342
- * // - Login into gcloud by running:
2343
- * // `$ gcloud auth application-default login`
2344
- * // - Install the npm module by running:
2345
- * // `$ npm install googleapis`
2346
- *
2347
- * const {google} = require('googleapis');
2348
- * const vault = google.vault('v1');
2349
- *
2350
- * async function main() {
2351
- * const auth = new google.auth.GoogleAuth({
2352
- * // Scopes can be specified either as an array or as a single, space-delimited string.
2353
- * scopes: ['https://www.googleapis.com/auth/ediscovery'],
2354
- * });
2355
- *
2356
- * // Acquire an auth client, and bind it to all future calls
2357
- * const authClient = await auth.getClient();
2358
- * google.options({auth: authClient});
2359
- *
2360
- * // Do the magic
2361
- * const res = await vault.matters.undelete({
2362
- * // The matter ID.
2363
- * matterId: 'placeholder-value',
2364
- *
2365
- * // Request body metadata
2366
- * requestBody: {
2367
- * // request body parameters
2368
- * // {}
2369
- * },
2370
- * });
2371
- * console.log(res.data);
2372
- *
2373
- * // Example response
2374
- * // {
2375
- * // "description": "my_description",
2376
- * // "matterId": "my_matterId",
2377
- * // "matterPermissions": [],
2378
- * // "name": "my_name",
2379
- * // "state": "my_state"
2380
- * // }
2381
- * }
2382
- *
2383
- * main().catch(e => {
2384
- * console.error(e);
2385
- * throw e;
2386
- * });
2387
- *
2388
- * ```
2389
1881
  *
2390
1882
  * @param params - Parameters for request
2391
1883
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2472,64 +1964,6 @@ export namespace vault_v1 {
2472
1964
 
2473
1965
  /**
2474
1966
  * 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.
2475
- * @example
2476
- * ```js
2477
- * // Before running the sample:
2478
- * // - Enable the API at:
2479
- * // https://console.developers.google.com/apis/api/vault.googleapis.com
2480
- * // - Login into gcloud by running:
2481
- * // `$ gcloud auth application-default login`
2482
- * // - Install the npm module by running:
2483
- * // `$ npm install googleapis`
2484
- *
2485
- * const {google} = require('googleapis');
2486
- * const vault = google.vault('v1');
2487
- *
2488
- * async function main() {
2489
- * const auth = new google.auth.GoogleAuth({
2490
- * // Scopes can be specified either as an array or as a single, space-delimited string.
2491
- * scopes: ['https://www.googleapis.com/auth/ediscovery'],
2492
- * });
2493
- *
2494
- * // Acquire an auth client, and bind it to all future calls
2495
- * const authClient = await auth.getClient();
2496
- * google.options({auth: authClient});
2497
- *
2498
- * // Do the magic
2499
- * const res = await vault.matters.update({
2500
- * // The matter ID.
2501
- * matterId: 'placeholder-value',
2502
- *
2503
- * // Request body metadata
2504
- * requestBody: {
2505
- * // request body parameters
2506
- * // {
2507
- * // "description": "my_description",
2508
- * // "matterId": "my_matterId",
2509
- * // "matterPermissions": [],
2510
- * // "name": "my_name",
2511
- * // "state": "my_state"
2512
- * // }
2513
- * },
2514
- * });
2515
- * console.log(res.data);
2516
- *
2517
- * // Example response
2518
- * // {
2519
- * // "description": "my_description",
2520
- * // "matterId": "my_matterId",
2521
- * // "matterPermissions": [],
2522
- * // "name": "my_name",
2523
- * // "state": "my_state"
2524
- * // }
2525
- * }
2526
- *
2527
- * main().catch(e => {
2528
- * console.error(e);
2529
- * throw e;
2530
- * });
2531
- *
2532
- * ```
2533
1967
  *
2534
1968
  * @param params - Parameters for request
2535
1969
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2743,74 +2177,6 @@ export namespace vault_v1 {
2743
2177
 
2744
2178
  /**
2745
2179
  * Creates an export.
2746
- * @example
2747
- * ```js
2748
- * // Before running the sample:
2749
- * // - Enable the API at:
2750
- * // https://console.developers.google.com/apis/api/vault.googleapis.com
2751
- * // - Login into gcloud by running:
2752
- * // `$ gcloud auth application-default login`
2753
- * // - Install the npm module by running:
2754
- * // `$ npm install googleapis`
2755
- *
2756
- * const {google} = require('googleapis');
2757
- * const vault = google.vault('v1');
2758
- *
2759
- * async function main() {
2760
- * const auth = new google.auth.GoogleAuth({
2761
- * // Scopes can be specified either as an array or as a single, space-delimited string.
2762
- * scopes: ['https://www.googleapis.com/auth/ediscovery'],
2763
- * });
2764
- *
2765
- * // Acquire an auth client, and bind it to all future calls
2766
- * const authClient = await auth.getClient();
2767
- * google.options({auth: authClient});
2768
- *
2769
- * // Do the magic
2770
- * const res = await vault.matters.exports.create({
2771
- * // The matter ID.
2772
- * matterId: 'placeholder-value',
2773
- *
2774
- * // Request body metadata
2775
- * requestBody: {
2776
- * // request body parameters
2777
- * // {
2778
- * // "cloudStorageSink": {},
2779
- * // "createTime": "my_createTime",
2780
- * // "exportOptions": {},
2781
- * // "id": "my_id",
2782
- * // "matterId": "my_matterId",
2783
- * // "name": "my_name",
2784
- * // "query": {},
2785
- * // "requester": {},
2786
- * // "stats": {},
2787
- * // "status": "my_status"
2788
- * // }
2789
- * },
2790
- * });
2791
- * console.log(res.data);
2792
- *
2793
- * // Example response
2794
- * // {
2795
- * // "cloudStorageSink": {},
2796
- * // "createTime": "my_createTime",
2797
- * // "exportOptions": {},
2798
- * // "id": "my_id",
2799
- * // "matterId": "my_matterId",
2800
- * // "name": "my_name",
2801
- * // "query": {},
2802
- * // "requester": {},
2803
- * // "stats": {},
2804
- * // "status": "my_status"
2805
- * // }
2806
- * }
2807
- *
2808
- * main().catch(e => {
2809
- * console.error(e);
2810
- * throw e;
2811
- * });
2812
- *
2813
- * ```
2814
2180
  *
2815
2181
  * @param params - Parameters for request
2816
2182
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2898,48 +2264,6 @@ export namespace vault_v1 {
2898
2264
 
2899
2265
  /**
2900
2266
  * Deletes an export.
2901
- * @example
2902
- * ```js
2903
- * // Before running the sample:
2904
- * // - Enable the API at:
2905
- * // https://console.developers.google.com/apis/api/vault.googleapis.com
2906
- * // - Login into gcloud by running:
2907
- * // `$ gcloud auth application-default login`
2908
- * // - Install the npm module by running:
2909
- * // `$ npm install googleapis`
2910
- *
2911
- * const {google} = require('googleapis');
2912
- * const vault = google.vault('v1');
2913
- *
2914
- * async function main() {
2915
- * const auth = new google.auth.GoogleAuth({
2916
- * // Scopes can be specified either as an array or as a single, space-delimited string.
2917
- * scopes: ['https://www.googleapis.com/auth/ediscovery'],
2918
- * });
2919
- *
2920
- * // Acquire an auth client, and bind it to all future calls
2921
- * const authClient = await auth.getClient();
2922
- * google.options({auth: authClient});
2923
- *
2924
- * // Do the magic
2925
- * const res = await vault.matters.exports.delete({
2926
- * // The export ID.
2927
- * exportId: 'placeholder-value',
2928
- * // The matter ID.
2929
- * matterId: 'placeholder-value',
2930
- * });
2931
- * console.log(res.data);
2932
- *
2933
- * // Example response
2934
- * // {}
2935
- * }
2936
- *
2937
- * main().catch(e => {
2938
- * console.error(e);
2939
- * throw e;
2940
- * });
2941
- *
2942
- * ```
2943
2267
  *
2944
2268
  * @param params - Parameters for request
2945
2269
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3026,62 +2350,6 @@ export namespace vault_v1 {
3026
2350
 
3027
2351
  /**
3028
2352
  * Gets an export.
3029
- * @example
3030
- * ```js
3031
- * // Before running the sample:
3032
- * // - Enable the API at:
3033
- * // https://console.developers.google.com/apis/api/vault.googleapis.com
3034
- * // - Login into gcloud by running:
3035
- * // `$ gcloud auth application-default login`
3036
- * // - Install the npm module by running:
3037
- * // `$ npm install googleapis`
3038
- *
3039
- * const {google} = require('googleapis');
3040
- * const vault = google.vault('v1');
3041
- *
3042
- * async function main() {
3043
- * const auth = new google.auth.GoogleAuth({
3044
- * // Scopes can be specified either as an array or as a single, space-delimited string.
3045
- * scopes: [
3046
- * 'https://www.googleapis.com/auth/ediscovery',
3047
- * 'https://www.googleapis.com/auth/ediscovery.readonly',
3048
- * ],
3049
- * });
3050
- *
3051
- * // Acquire an auth client, and bind it to all future calls
3052
- * const authClient = await auth.getClient();
3053
- * google.options({auth: authClient});
3054
- *
3055
- * // Do the magic
3056
- * const res = await vault.matters.exports.get({
3057
- * // The export ID.
3058
- * exportId: 'placeholder-value',
3059
- * // The matter ID.
3060
- * matterId: 'placeholder-value',
3061
- * });
3062
- * console.log(res.data);
3063
- *
3064
- * // Example response
3065
- * // {
3066
- * // "cloudStorageSink": {},
3067
- * // "createTime": "my_createTime",
3068
- * // "exportOptions": {},
3069
- * // "id": "my_id",
3070
- * // "matterId": "my_matterId",
3071
- * // "name": "my_name",
3072
- * // "query": {},
3073
- * // "requester": {},
3074
- * // "stats": {},
3075
- * // "status": "my_status"
3076
- * // }
3077
- * }
3078
- *
3079
- * main().catch(e => {
3080
- * console.error(e);
3081
- * throw e;
3082
- * });
3083
- *
3084
- * ```
3085
2353
  *
3086
2354
  * @param params - Parameters for request
3087
2355
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3168,56 +2436,6 @@ export namespace vault_v1 {
3168
2436
 
3169
2437
  /**
3170
2438
  * Lists details about the exports in the specified matter.
3171
- * @example
3172
- * ```js
3173
- * // Before running the sample:
3174
- * // - Enable the API at:
3175
- * // https://console.developers.google.com/apis/api/vault.googleapis.com
3176
- * // - Login into gcloud by running:
3177
- * // `$ gcloud auth application-default login`
3178
- * // - Install the npm module by running:
3179
- * // `$ npm install googleapis`
3180
- *
3181
- * const {google} = require('googleapis');
3182
- * const vault = google.vault('v1');
3183
- *
3184
- * async function main() {
3185
- * const auth = new google.auth.GoogleAuth({
3186
- * // Scopes can be specified either as an array or as a single, space-delimited string.
3187
- * scopes: [
3188
- * 'https://www.googleapis.com/auth/ediscovery',
3189
- * 'https://www.googleapis.com/auth/ediscovery.readonly',
3190
- * ],
3191
- * });
3192
- *
3193
- * // Acquire an auth client, and bind it to all future calls
3194
- * const authClient = await auth.getClient();
3195
- * google.options({auth: authClient});
3196
- *
3197
- * // Do the magic
3198
- * const res = await vault.matters.exports.list({
3199
- * // The matter ID.
3200
- * matterId: 'placeholder-value',
3201
- * // The number of exports to return in the response.
3202
- * pageSize: 'placeholder-value',
3203
- * // The pagination token as returned in the response.
3204
- * pageToken: 'placeholder-value',
3205
- * });
3206
- * console.log(res.data);
3207
- *
3208
- * // Example response
3209
- * // {
3210
- * // "exports": [],
3211
- * // "nextPageToken": "my_nextPageToken"
3212
- * // }
3213
- * }
3214
- *
3215
- * main().catch(e => {
3216
- * console.error(e);
3217
- * throw e;
3218
- * });
3219
- *
3220
- * ```
3221
2439
  *
3222
2440
  * @param params - Parameters for request
3223
2441
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3367,59 +2585,6 @@ export namespace vault_v1 {
3367
2585
 
3368
2586
  /**
3369
2587
  * 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.
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
- * // `$ gcloud auth application-default login`
3377
- * // - Install the npm module by running:
3378
- * // `$ npm install googleapis`
3379
- *
3380
- * const {google} = require('googleapis');
3381
- * const vault = google.vault('v1');
3382
- *
3383
- * async function main() {
3384
- * const auth = new google.auth.GoogleAuth({
3385
- * // Scopes can be specified either as an array or as a single, space-delimited string.
3386
- * scopes: ['https://www.googleapis.com/auth/ediscovery'],
3387
- * });
3388
- *
3389
- * // Acquire an auth client, and bind it to all future calls
3390
- * const authClient = await auth.getClient();
3391
- * google.options({auth: authClient});
3392
- *
3393
- * // Do the magic
3394
- * const res = await vault.matters.holds.addHeldAccounts({
3395
- * // The hold ID.
3396
- * holdId: 'placeholder-value',
3397
- * // The matter ID.
3398
- * matterId: 'placeholder-value',
3399
- *
3400
- * // Request body metadata
3401
- * requestBody: {
3402
- * // request body parameters
3403
- * // {
3404
- * // "accountIds": [],
3405
- * // "emails": []
3406
- * // }
3407
- * },
3408
- * });
3409
- * console.log(res.data);
3410
- *
3411
- * // Example response
3412
- * // {
3413
- * // "responses": []
3414
- * // }
3415
- * }
3416
- *
3417
- * main().catch(e => {
3418
- * console.error(e);
3419
- * throw e;
3420
- * });
3421
- *
3422
- * ```
3423
2588
  *
3424
2589
  * @param params - Parameters for request
3425
2590
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3513,68 +2678,6 @@ export namespace vault_v1 {
3513
2678
 
3514
2679
  /**
3515
2680
  * Creates a hold in the specified matter.
3516
- * @example
3517
- * ```js
3518
- * // Before running the sample:
3519
- * // - Enable the API at:
3520
- * // https://console.developers.google.com/apis/api/vault.googleapis.com
3521
- * // - Login into gcloud by running:
3522
- * // `$ gcloud auth application-default login`
3523
- * // - Install the npm module by running:
3524
- * // `$ npm install googleapis`
3525
- *
3526
- * const {google} = require('googleapis');
3527
- * const vault = google.vault('v1');
3528
- *
3529
- * async function main() {
3530
- * const auth = new google.auth.GoogleAuth({
3531
- * // Scopes can be specified either as an array or as a single, space-delimited string.
3532
- * scopes: ['https://www.googleapis.com/auth/ediscovery'],
3533
- * });
3534
- *
3535
- * // Acquire an auth client, and bind it to all future calls
3536
- * const authClient = await auth.getClient();
3537
- * google.options({auth: authClient});
3538
- *
3539
- * // Do the magic
3540
- * const res = await vault.matters.holds.create({
3541
- * // The matter ID.
3542
- * matterId: 'placeholder-value',
3543
- *
3544
- * // Request body metadata
3545
- * requestBody: {
3546
- * // request body parameters
3547
- * // {
3548
- * // "accounts": [],
3549
- * // "corpus": "my_corpus",
3550
- * // "holdId": "my_holdId",
3551
- * // "name": "my_name",
3552
- * // "orgUnit": {},
3553
- * // "query": {},
3554
- * // "updateTime": "my_updateTime"
3555
- * // }
3556
- * },
3557
- * });
3558
- * console.log(res.data);
3559
- *
3560
- * // Example response
3561
- * // {
3562
- * // "accounts": [],
3563
- * // "corpus": "my_corpus",
3564
- * // "holdId": "my_holdId",
3565
- * // "name": "my_name",
3566
- * // "orgUnit": {},
3567
- * // "query": {},
3568
- * // "updateTime": "my_updateTime"
3569
- * // }
3570
- * }
3571
- *
3572
- * main().catch(e => {
3573
- * console.error(e);
3574
- * throw e;
3575
- * });
3576
- *
3577
- * ```
3578
2681
  *
3579
2682
  * @param params - Parameters for request
3580
2683
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3662,48 +2765,6 @@ export namespace vault_v1 {
3662
2765
 
3663
2766
  /**
3664
2767
  * 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.
3665
- * @example
3666
- * ```js
3667
- * // Before running the sample:
3668
- * // - Enable the API at:
3669
- * // https://console.developers.google.com/apis/api/vault.googleapis.com
3670
- * // - Login into gcloud by running:
3671
- * // `$ gcloud auth application-default login`
3672
- * // - Install the npm module by running:
3673
- * // `$ npm install googleapis`
3674
- *
3675
- * const {google} = require('googleapis');
3676
- * const vault = google.vault('v1');
3677
- *
3678
- * async function main() {
3679
- * const auth = new google.auth.GoogleAuth({
3680
- * // Scopes can be specified either as an array or as a single, space-delimited string.
3681
- * scopes: ['https://www.googleapis.com/auth/ediscovery'],
3682
- * });
3683
- *
3684
- * // Acquire an auth client, and bind it to all future calls
3685
- * const authClient = await auth.getClient();
3686
- * google.options({auth: authClient});
3687
- *
3688
- * // Do the magic
3689
- * const res = await vault.matters.holds.delete({
3690
- * // The hold ID.
3691
- * holdId: 'placeholder-value',
3692
- * // The matter ID.
3693
- * matterId: 'placeholder-value',
3694
- * });
3695
- * console.log(res.data);
3696
- *
3697
- * // Example response
3698
- * // {}
3699
- * }
3700
- *
3701
- * main().catch(e => {
3702
- * console.error(e);
3703
- * throw e;
3704
- * });
3705
- *
3706
- * ```
3707
2768
  *
3708
2769
  * @param params - Parameters for request
3709
2770
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3791,61 +2852,6 @@ export namespace vault_v1 {
3791
2852
 
3792
2853
  /**
3793
2854
  * Gets the specified hold.
3794
- * @example
3795
- * ```js
3796
- * // Before running the sample:
3797
- * // - Enable the API at:
3798
- * // https://console.developers.google.com/apis/api/vault.googleapis.com
3799
- * // - Login into gcloud by running:
3800
- * // `$ gcloud auth application-default login`
3801
- * // - Install the npm module by running:
3802
- * // `$ npm install googleapis`
3803
- *
3804
- * const {google} = require('googleapis');
3805
- * const vault = google.vault('v1');
3806
- *
3807
- * async function main() {
3808
- * const auth = new google.auth.GoogleAuth({
3809
- * // Scopes can be specified either as an array or as a single, space-delimited string.
3810
- * scopes: [
3811
- * 'https://www.googleapis.com/auth/ediscovery',
3812
- * 'https://www.googleapis.com/auth/ediscovery.readonly',
3813
- * ],
3814
- * });
3815
- *
3816
- * // Acquire an auth client, and bind it to all future calls
3817
- * const authClient = await auth.getClient();
3818
- * google.options({auth: authClient});
3819
- *
3820
- * // Do the magic
3821
- * const res = await vault.matters.holds.get({
3822
- * // The hold ID.
3823
- * holdId: 'placeholder-value',
3824
- * // The matter ID.
3825
- * matterId: 'placeholder-value',
3826
- * // The amount of detail to return for a hold.
3827
- * view: 'placeholder-value',
3828
- * });
3829
- * console.log(res.data);
3830
- *
3831
- * // Example response
3832
- * // {
3833
- * // "accounts": [],
3834
- * // "corpus": "my_corpus",
3835
- * // "holdId": "my_holdId",
3836
- * // "name": "my_name",
3837
- * // "orgUnit": {},
3838
- * // "query": {},
3839
- * // "updateTime": "my_updateTime"
3840
- * // }
3841
- * }
3842
- *
3843
- * main().catch(e => {
3844
- * console.error(e);
3845
- * throw e;
3846
- * });
3847
- *
3848
- * ```
3849
2855
  *
3850
2856
  * @param params - Parameters for request
3851
2857
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3933,58 +2939,6 @@ export namespace vault_v1 {
3933
2939
 
3934
2940
  /**
3935
2941
  * Lists the holds in a matter.
3936
- * @example
3937
- * ```js
3938
- * // Before running the sample:
3939
- * // - Enable the API at:
3940
- * // https://console.developers.google.com/apis/api/vault.googleapis.com
3941
- * // - Login into gcloud by running:
3942
- * // `$ gcloud auth application-default login`
3943
- * // - Install the npm module by running:
3944
- * // `$ npm install googleapis`
3945
- *
3946
- * const {google} = require('googleapis');
3947
- * const vault = google.vault('v1');
3948
- *
3949
- * async function main() {
3950
- * const auth = new google.auth.GoogleAuth({
3951
- * // Scopes can be specified either as an array or as a single, space-delimited string.
3952
- * scopes: [
3953
- * 'https://www.googleapis.com/auth/ediscovery',
3954
- * 'https://www.googleapis.com/auth/ediscovery.readonly',
3955
- * ],
3956
- * });
3957
- *
3958
- * // Acquire an auth client, and bind it to all future calls
3959
- * const authClient = await auth.getClient();
3960
- * google.options({auth: authClient});
3961
- *
3962
- * // Do the magic
3963
- * const res = await vault.matters.holds.list({
3964
- * // The matter ID.
3965
- * matterId: 'placeholder-value',
3966
- * // 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.
3967
- * pageSize: 'placeholder-value',
3968
- * // The pagination token as returned in the response. An empty token means start from the beginning.
3969
- * pageToken: 'placeholder-value',
3970
- * // The amount of detail to return for a hold.
3971
- * view: 'placeholder-value',
3972
- * });
3973
- * console.log(res.data);
3974
- *
3975
- * // Example response
3976
- * // {
3977
- * // "holds": [],
3978
- * // "nextPageToken": "my_nextPageToken"
3979
- * // }
3980
- * }
3981
- *
3982
- * main().catch(e => {
3983
- * console.error(e);
3984
- * throw e;
3985
- * });
3986
- *
3987
- * ```
3988
2942
  *
3989
2943
  * @param params - Parameters for request
3990
2944
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -4075,58 +3029,6 @@ export namespace vault_v1 {
4075
3029
 
4076
3030
  /**
4077
3031
  * Removes the specified accounts from a hold. Returns a list of statuses in the same order as the request.
4078
- * @example
4079
- * ```js
4080
- * // Before running the sample:
4081
- * // - Enable the API at:
4082
- * // https://console.developers.google.com/apis/api/vault.googleapis.com
4083
- * // - Login into gcloud by running:
4084
- * // `$ gcloud auth application-default login`
4085
- * // - Install the npm module by running:
4086
- * // `$ npm install googleapis`
4087
- *
4088
- * const {google} = require('googleapis');
4089
- * const vault = google.vault('v1');
4090
- *
4091
- * async function main() {
4092
- * const auth = new google.auth.GoogleAuth({
4093
- * // Scopes can be specified either as an array or as a single, space-delimited string.
4094
- * scopes: ['https://www.googleapis.com/auth/ediscovery'],
4095
- * });
4096
- *
4097
- * // Acquire an auth client, and bind it to all future calls
4098
- * const authClient = await auth.getClient();
4099
- * google.options({auth: authClient});
4100
- *
4101
- * // Do the magic
4102
- * const res = await vault.matters.holds.removeHeldAccounts({
4103
- * // The hold ID.
4104
- * holdId: 'placeholder-value',
4105
- * // The matter ID.
4106
- * matterId: 'placeholder-value',
4107
- *
4108
- * // Request body metadata
4109
- * requestBody: {
4110
- * // request body parameters
4111
- * // {
4112
- * // "accountIds": []
4113
- * // }
4114
- * },
4115
- * });
4116
- * console.log(res.data);
4117
- *
4118
- * // Example response
4119
- * // {
4120
- * // "statuses": []
4121
- * // }
4122
- * }
4123
- *
4124
- * main().catch(e => {
4125
- * console.error(e);
4126
- * throw e;
4127
- * });
4128
- *
4129
- * ```
4130
3032
  *
4131
3033
  * @param params - Parameters for request
4132
3034
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -4221,70 +3123,6 @@ export namespace vault_v1 {
4221
3123
 
4222
3124
  /**
4223
3125
  * 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.
4224
- * @example
4225
- * ```js
4226
- * // Before running the sample:
4227
- * // - Enable the API at:
4228
- * // https://console.developers.google.com/apis/api/vault.googleapis.com
4229
- * // - Login into gcloud by running:
4230
- * // `$ gcloud auth application-default login`
4231
- * // - Install the npm module by running:
4232
- * // `$ npm install googleapis`
4233
- *
4234
- * const {google} = require('googleapis');
4235
- * const vault = google.vault('v1');
4236
- *
4237
- * async function main() {
4238
- * const auth = new google.auth.GoogleAuth({
4239
- * // Scopes can be specified either as an array or as a single, space-delimited string.
4240
- * scopes: ['https://www.googleapis.com/auth/ediscovery'],
4241
- * });
4242
- *
4243
- * // Acquire an auth client, and bind it to all future calls
4244
- * const authClient = await auth.getClient();
4245
- * google.options({auth: authClient});
4246
- *
4247
- * // Do the magic
4248
- * const res = await vault.matters.holds.update({
4249
- * // The ID of the hold.
4250
- * holdId: 'placeholder-value',
4251
- * // The matter ID.
4252
- * matterId: 'placeholder-value',
4253
- *
4254
- * // Request body metadata
4255
- * requestBody: {
4256
- * // request body parameters
4257
- * // {
4258
- * // "accounts": [],
4259
- * // "corpus": "my_corpus",
4260
- * // "holdId": "my_holdId",
4261
- * // "name": "my_name",
4262
- * // "orgUnit": {},
4263
- * // "query": {},
4264
- * // "updateTime": "my_updateTime"
4265
- * // }
4266
- * },
4267
- * });
4268
- * console.log(res.data);
4269
- *
4270
- * // Example response
4271
- * // {
4272
- * // "accounts": [],
4273
- * // "corpus": "my_corpus",
4274
- * // "holdId": "my_holdId",
4275
- * // "name": "my_name",
4276
- * // "orgUnit": {},
4277
- * // "query": {},
4278
- * // "updateTime": "my_updateTime"
4279
- * // }
4280
- * }
4281
- *
4282
- * main().catch(e => {
4283
- * console.error(e);
4284
- * throw e;
4285
- * });
4286
- *
4287
- * ```
4288
3126
  *
4289
3127
  * @param params - Parameters for request
4290
3128
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -4485,66 +3323,6 @@ export namespace vault_v1 {
4485
3323
 
4486
3324
  /**
4487
3325
  * 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.
4488
- * @example
4489
- * ```js
4490
- * // Before running the sample:
4491
- * // - Enable the API at:
4492
- * // https://console.developers.google.com/apis/api/vault.googleapis.com
4493
- * // - Login into gcloud by running:
4494
- * // `$ gcloud auth application-default login`
4495
- * // - Install the npm module by running:
4496
- * // `$ npm install googleapis`
4497
- *
4498
- * const {google} = require('googleapis');
4499
- * const vault = google.vault('v1');
4500
- *
4501
- * async function main() {
4502
- * const auth = new google.auth.GoogleAuth({
4503
- * // Scopes can be specified either as an array or as a single, space-delimited string.
4504
- * scopes: ['https://www.googleapis.com/auth/ediscovery'],
4505
- * });
4506
- *
4507
- * // Acquire an auth client, and bind it to all future calls
4508
- * const authClient = await auth.getClient();
4509
- * google.options({auth: authClient});
4510
- *
4511
- * // Do the magic
4512
- * const res = await vault.matters.holds.accounts.create({
4513
- * // The hold ID.
4514
- * holdId: 'placeholder-value',
4515
- * // The matter ID.
4516
- * matterId: 'placeholder-value',
4517
- *
4518
- * // Request body metadata
4519
- * requestBody: {
4520
- * // request body parameters
4521
- * // {
4522
- * // "accountId": "my_accountId",
4523
- * // "email": "my_email",
4524
- * // "firstName": "my_firstName",
4525
- * // "holdTime": "my_holdTime",
4526
- * // "lastName": "my_lastName"
4527
- * // }
4528
- * },
4529
- * });
4530
- * console.log(res.data);
4531
- *
4532
- * // Example response
4533
- * // {
4534
- * // "accountId": "my_accountId",
4535
- * // "email": "my_email",
4536
- * // "firstName": "my_firstName",
4537
- * // "holdTime": "my_holdTime",
4538
- * // "lastName": "my_lastName"
4539
- * // }
4540
- * }
4541
- *
4542
- * main().catch(e => {
4543
- * console.error(e);
4544
- * throw e;
4545
- * });
4546
- *
4547
- * ```
4548
3326
  *
4549
3327
  * @param params - Parameters for request
4550
3328
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -4631,50 +3409,6 @@ export namespace vault_v1 {
4631
3409
 
4632
3410
  /**
4633
3411
  * Removes an account from a hold.
4634
- * @example
4635
- * ```js
4636
- * // Before running the sample:
4637
- * // - Enable the API at:
4638
- * // https://console.developers.google.com/apis/api/vault.googleapis.com
4639
- * // - Login into gcloud by running:
4640
- * // `$ gcloud auth application-default login`
4641
- * // - Install the npm module by running:
4642
- * // `$ npm install googleapis`
4643
- *
4644
- * const {google} = require('googleapis');
4645
- * const vault = google.vault('v1');
4646
- *
4647
- * async function main() {
4648
- * const auth = new google.auth.GoogleAuth({
4649
- * // Scopes can be specified either as an array or as a single, space-delimited string.
4650
- * scopes: ['https://www.googleapis.com/auth/ediscovery'],
4651
- * });
4652
- *
4653
- * // Acquire an auth client, and bind it to all future calls
4654
- * const authClient = await auth.getClient();
4655
- * google.options({auth: authClient});
4656
- *
4657
- * // Do the magic
4658
- * const res = await vault.matters.holds.accounts.delete({
4659
- * // The ID of the account to remove from the hold.
4660
- * accountId: 'placeholder-value',
4661
- * // The hold ID.
4662
- * holdId: 'placeholder-value',
4663
- * // The matter ID.
4664
- * matterId: 'placeholder-value',
4665
- * });
4666
- * console.log(res.data);
4667
- *
4668
- * // Example response
4669
- * // {}
4670
- * }
4671
- *
4672
- * main().catch(e => {
4673
- * console.error(e);
4674
- * throw e;
4675
- * });
4676
- *
4677
- * ```
4678
3412
  *
4679
3413
  * @param params - Parameters for request
4680
3414
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -4762,53 +3496,6 @@ export namespace vault_v1 {
4762
3496
 
4763
3497
  /**
4764
3498
  * 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.
4765
- * @example
4766
- * ```js
4767
- * // Before running the sample:
4768
- * // - Enable the API at:
4769
- * // https://console.developers.google.com/apis/api/vault.googleapis.com
4770
- * // - Login into gcloud by running:
4771
- * // `$ gcloud auth application-default login`
4772
- * // - Install the npm module by running:
4773
- * // `$ npm install googleapis`
4774
- *
4775
- * const {google} = require('googleapis');
4776
- * const vault = google.vault('v1');
4777
- *
4778
- * async function main() {
4779
- * const auth = new google.auth.GoogleAuth({
4780
- * // Scopes can be specified either as an array or as a single, space-delimited string.
4781
- * scopes: [
4782
- * 'https://www.googleapis.com/auth/ediscovery',
4783
- * 'https://www.googleapis.com/auth/ediscovery.readonly',
4784
- * ],
4785
- * });
4786
- *
4787
- * // Acquire an auth client, and bind it to all future calls
4788
- * const authClient = await auth.getClient();
4789
- * google.options({auth: authClient});
4790
- *
4791
- * // Do the magic
4792
- * const res = await vault.matters.holds.accounts.list({
4793
- * // The hold ID.
4794
- * holdId: 'placeholder-value',
4795
- * // The matter ID.
4796
- * matterId: 'placeholder-value',
4797
- * });
4798
- * console.log(res.data);
4799
- *
4800
- * // Example response
4801
- * // {
4802
- * // "accounts": []
4803
- * // }
4804
- * }
4805
- *
4806
- * main().catch(e => {
4807
- * console.error(e);
4808
- * throw e;
4809
- * });
4810
- *
4811
- * ```
4812
3499
  *
4813
3500
  * @param params - Parameters for request
4814
3501
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -4950,64 +3637,6 @@ export namespace vault_v1 {
4950
3637
 
4951
3638
  /**
4952
3639
  * Creates a saved query.
4953
- * @example
4954
- * ```js
4955
- * // Before running the sample:
4956
- * // - Enable the API at:
4957
- * // https://console.developers.google.com/apis/api/vault.googleapis.com
4958
- * // - Login into gcloud by running:
4959
- * // `$ gcloud auth application-default login`
4960
- * // - Install the npm module by running:
4961
- * // `$ npm install googleapis`
4962
- *
4963
- * const {google} = require('googleapis');
4964
- * const vault = google.vault('v1');
4965
- *
4966
- * async function main() {
4967
- * const auth = new google.auth.GoogleAuth({
4968
- * // Scopes can be specified either as an array or as a single, space-delimited string.
4969
- * scopes: ['https://www.googleapis.com/auth/ediscovery'],
4970
- * });
4971
- *
4972
- * // Acquire an auth client, and bind it to all future calls
4973
- * const authClient = await auth.getClient();
4974
- * google.options({auth: authClient});
4975
- *
4976
- * // Do the magic
4977
- * const res = await vault.matters.savedQueries.create({
4978
- * // The ID of the matter to create the saved query in.
4979
- * matterId: 'placeholder-value',
4980
- *
4981
- * // Request body metadata
4982
- * requestBody: {
4983
- * // request body parameters
4984
- * // {
4985
- * // "createTime": "my_createTime",
4986
- * // "displayName": "my_displayName",
4987
- * // "matterId": "my_matterId",
4988
- * // "query": {},
4989
- * // "savedQueryId": "my_savedQueryId"
4990
- * // }
4991
- * },
4992
- * });
4993
- * console.log(res.data);
4994
- *
4995
- * // Example response
4996
- * // {
4997
- * // "createTime": "my_createTime",
4998
- * // "displayName": "my_displayName",
4999
- * // "matterId": "my_matterId",
5000
- * // "query": {},
5001
- * // "savedQueryId": "my_savedQueryId"
5002
- * // }
5003
- * }
5004
- *
5005
- * main().catch(e => {
5006
- * console.error(e);
5007
- * throw e;
5008
- * });
5009
- *
5010
- * ```
5011
3640
  *
5012
3641
  * @param params - Parameters for request
5013
3642
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -5095,48 +3724,6 @@ export namespace vault_v1 {
5095
3724
 
5096
3725
  /**
5097
3726
  * Deletes the specified saved query.
5098
- * @example
5099
- * ```js
5100
- * // Before running the sample:
5101
- * // - Enable the API at:
5102
- * // https://console.developers.google.com/apis/api/vault.googleapis.com
5103
- * // - Login into gcloud by running:
5104
- * // `$ gcloud auth application-default login`
5105
- * // - Install the npm module by running:
5106
- * // `$ npm install googleapis`
5107
- *
5108
- * const {google} = require('googleapis');
5109
- * const vault = google.vault('v1');
5110
- *
5111
- * async function main() {
5112
- * const auth = new google.auth.GoogleAuth({
5113
- * // Scopes can be specified either as an array or as a single, space-delimited string.
5114
- * scopes: ['https://www.googleapis.com/auth/ediscovery'],
5115
- * });
5116
- *
5117
- * // Acquire an auth client, and bind it to all future calls
5118
- * const authClient = await auth.getClient();
5119
- * google.options({auth: authClient});
5120
- *
5121
- * // Do the magic
5122
- * const res = await vault.matters.savedQueries.delete({
5123
- * // The ID of the matter to delete the saved query from.
5124
- * matterId: 'placeholder-value',
5125
- * // ID of the saved query to delete.
5126
- * savedQueryId: 'placeholder-value',
5127
- * });
5128
- * console.log(res.data);
5129
- *
5130
- * // Example response
5131
- * // {}
5132
- * }
5133
- *
5134
- * main().catch(e => {
5135
- * console.error(e);
5136
- * throw e;
5137
- * });
5138
- *
5139
- * ```
5140
3727
  *
5141
3728
  * @param params - Parameters for request
5142
3729
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -5223,57 +3810,6 @@ export namespace vault_v1 {
5223
3810
 
5224
3811
  /**
5225
3812
  * Retrieves the specified saved query.
5226
- * @example
5227
- * ```js
5228
- * // Before running the sample:
5229
- * // - Enable the API at:
5230
- * // https://console.developers.google.com/apis/api/vault.googleapis.com
5231
- * // - Login into gcloud by running:
5232
- * // `$ gcloud auth application-default login`
5233
- * // - Install the npm module by running:
5234
- * // `$ npm install googleapis`
5235
- *
5236
- * const {google} = require('googleapis');
5237
- * const vault = google.vault('v1');
5238
- *
5239
- * async function main() {
5240
- * const auth = new google.auth.GoogleAuth({
5241
- * // Scopes can be specified either as an array or as a single, space-delimited string.
5242
- * scopes: [
5243
- * 'https://www.googleapis.com/auth/ediscovery',
5244
- * 'https://www.googleapis.com/auth/ediscovery.readonly',
5245
- * ],
5246
- * });
5247
- *
5248
- * // Acquire an auth client, and bind it to all future calls
5249
- * const authClient = await auth.getClient();
5250
- * google.options({auth: authClient});
5251
- *
5252
- * // Do the magic
5253
- * const res = await vault.matters.savedQueries.get({
5254
- * // The ID of the matter to get the saved query from.
5255
- * matterId: 'placeholder-value',
5256
- * // ID of the saved query to retrieve.
5257
- * savedQueryId: 'placeholder-value',
5258
- * });
5259
- * console.log(res.data);
5260
- *
5261
- * // Example response
5262
- * // {
5263
- * // "createTime": "my_createTime",
5264
- * // "displayName": "my_displayName",
5265
- * // "matterId": "my_matterId",
5266
- * // "query": {},
5267
- * // "savedQueryId": "my_savedQueryId"
5268
- * // }
5269
- * }
5270
- *
5271
- * main().catch(e => {
5272
- * console.error(e);
5273
- * throw e;
5274
- * });
5275
- *
5276
- * ```
5277
3813
  *
5278
3814
  * @param params - Parameters for request
5279
3815
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -5360,56 +3896,6 @@ export namespace vault_v1 {
5360
3896
 
5361
3897
  /**
5362
3898
  * Lists the saved queries in a matter.
5363
- * @example
5364
- * ```js
5365
- * // Before running the sample:
5366
- * // - Enable the API at:
5367
- * // https://console.developers.google.com/apis/api/vault.googleapis.com
5368
- * // - Login into gcloud by running:
5369
- * // `$ gcloud auth application-default login`
5370
- * // - Install the npm module by running:
5371
- * // `$ npm install googleapis`
5372
- *
5373
- * const {google} = require('googleapis');
5374
- * const vault = google.vault('v1');
5375
- *
5376
- * async function main() {
5377
- * const auth = new google.auth.GoogleAuth({
5378
- * // Scopes can be specified either as an array or as a single, space-delimited string.
5379
- * scopes: [
5380
- * 'https://www.googleapis.com/auth/ediscovery',
5381
- * 'https://www.googleapis.com/auth/ediscovery.readonly',
5382
- * ],
5383
- * });
5384
- *
5385
- * // Acquire an auth client, and bind it to all future calls
5386
- * const authClient = await auth.getClient();
5387
- * google.options({auth: authClient});
5388
- *
5389
- * // Do the magic
5390
- * const res = await vault.matters.savedQueries.list({
5391
- * // The ID of the matter to get the saved queries for.
5392
- * matterId: 'placeholder-value',
5393
- * // The maximum number of saved queries to return.
5394
- * pageSize: 'placeholder-value',
5395
- * // The pagination token as returned in the previous response. An empty token means start from the beginning.
5396
- * pageToken: 'placeholder-value',
5397
- * });
5398
- * console.log(res.data);
5399
- *
5400
- * // Example response
5401
- * // {
5402
- * // "nextPageToken": "my_nextPageToken",
5403
- * // "savedQueries": []
5404
- * // }
5405
- * }
5406
- *
5407
- * main().catch(e => {
5408
- * console.error(e);
5409
- * throw e;
5410
- * });
5411
- *
5412
- * ```
5413
3899
  *
5414
3900
  * @param params - Parameters for request
5415
3901
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -5559,52 +4045,6 @@ export namespace vault_v1 {
5559
4045
 
5560
4046
  /**
5561
4047
  * 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`.
5562
- * @example
5563
- * ```js
5564
- * // Before running the sample:
5565
- * // - Enable the API at:
5566
- * // https://console.developers.google.com/apis/api/vault.googleapis.com
5567
- * // - Login into gcloud by running:
5568
- * // `$ gcloud auth application-default login`
5569
- * // - Install the npm module by running:
5570
- * // `$ npm install googleapis`
5571
- *
5572
- * const {google} = require('googleapis');
5573
- * const vault = google.vault('v1');
5574
- *
5575
- * async function main() {
5576
- * const auth = new google.auth.GoogleAuth({
5577
- * // Scopes can be specified either as an array or as a single, space-delimited string.
5578
- * scopes: [],
5579
- * });
5580
- *
5581
- * // Acquire an auth client, and bind it to all future calls
5582
- * const authClient = await auth.getClient();
5583
- * google.options({auth: authClient});
5584
- *
5585
- * // Do the magic
5586
- * const res = await vault.operations.cancel({
5587
- * // The name of the operation resource to be cancelled.
5588
- * name: 'operations/.*',
5589
- *
5590
- * // Request body metadata
5591
- * requestBody: {
5592
- * // request body parameters
5593
- * // {}
5594
- * },
5595
- * });
5596
- * console.log(res.data);
5597
- *
5598
- * // Example response
5599
- * // {}
5600
- * }
5601
- *
5602
- * main().catch(e => {
5603
- * console.error(e);
5604
- * throw e;
5605
- * });
5606
- *
5607
- * ```
5608
4048
  *
5609
4049
  * @param params - Parameters for request
5610
4050
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -5689,46 +4129,6 @@ export namespace vault_v1 {
5689
4129
 
5690
4130
  /**
5691
4131
  * 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`.
5692
- * @example
5693
- * ```js
5694
- * // Before running the sample:
5695
- * // - Enable the API at:
5696
- * // https://console.developers.google.com/apis/api/vault.googleapis.com
5697
- * // - Login into gcloud by running:
5698
- * // `$ gcloud auth application-default login`
5699
- * // - Install the npm module by running:
5700
- * // `$ npm install googleapis`
5701
- *
5702
- * const {google} = require('googleapis');
5703
- * const vault = google.vault('v1');
5704
- *
5705
- * async function main() {
5706
- * const auth = new google.auth.GoogleAuth({
5707
- * // Scopes can be specified either as an array or as a single, space-delimited string.
5708
- * scopes: [],
5709
- * });
5710
- *
5711
- * // Acquire an auth client, and bind it to all future calls
5712
- * const authClient = await auth.getClient();
5713
- * google.options({auth: authClient});
5714
- *
5715
- * // Do the magic
5716
- * const res = await vault.operations.delete({
5717
- * // The name of the operation resource to be deleted.
5718
- * name: 'operations/.*',
5719
- * });
5720
- * console.log(res.data);
5721
- *
5722
- * // Example response
5723
- * // {}
5724
- * }
5725
- *
5726
- * main().catch(e => {
5727
- * console.error(e);
5728
- * throw e;
5729
- * });
5730
- *
5731
- * ```
5732
4132
  *
5733
4133
  * @param params - Parameters for request
5734
4134
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -5813,55 +4213,6 @@ export namespace vault_v1 {
5813
4213
 
5814
4214
  /**
5815
4215
  * 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.
5816
- * @example
5817
- * ```js
5818
- * // Before running the sample:
5819
- * // - Enable the API at:
5820
- * // https://console.developers.google.com/apis/api/vault.googleapis.com
5821
- * // - Login into gcloud by running:
5822
- * // `$ gcloud auth application-default login`
5823
- * // - Install the npm module by running:
5824
- * // `$ npm install googleapis`
5825
- *
5826
- * const {google} = require('googleapis');
5827
- * const vault = google.vault('v1');
5828
- *
5829
- * async function main() {
5830
- * const auth = new google.auth.GoogleAuth({
5831
- * // Scopes can be specified either as an array or as a single, space-delimited string.
5832
- * scopes: [
5833
- * 'https://www.googleapis.com/auth/ediscovery',
5834
- * 'https://www.googleapis.com/auth/ediscovery.readonly',
5835
- * ],
5836
- * });
5837
- *
5838
- * // Acquire an auth client, and bind it to all future calls
5839
- * const authClient = await auth.getClient();
5840
- * google.options({auth: authClient});
5841
- *
5842
- * // Do the magic
5843
- * const res = await vault.operations.get({
5844
- * // The name of the operation resource.
5845
- * name: 'operations/.*',
5846
- * });
5847
- * console.log(res.data);
5848
- *
5849
- * // Example response
5850
- * // {
5851
- * // "done": false,
5852
- * // "error": {},
5853
- * // "metadata": {},
5854
- * // "name": "my_name",
5855
- * // "response": {}
5856
- * // }
5857
- * }
5858
- *
5859
- * main().catch(e => {
5860
- * console.error(e);
5861
- * throw e;
5862
- * });
5863
- *
5864
- * ```
5865
4216
  *
5866
4217
  * @param params - Parameters for request
5867
4218
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -5945,55 +4296,6 @@ export namespace vault_v1 {
5945
4296
 
5946
4297
  /**
5947
4298
  * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
5948
- * @example
5949
- * ```js
5950
- * // Before running the sample:
5951
- * // - Enable the API at:
5952
- * // https://console.developers.google.com/apis/api/vault.googleapis.com
5953
- * // - Login into gcloud by running:
5954
- * // `$ gcloud auth application-default login`
5955
- * // - Install the npm module by running:
5956
- * // `$ npm install googleapis`
5957
- *
5958
- * const {google} = require('googleapis');
5959
- * const vault = google.vault('v1');
5960
- *
5961
- * async function main() {
5962
- * const auth = new google.auth.GoogleAuth({
5963
- * // Scopes can be specified either as an array or as a single, space-delimited string.
5964
- * scopes: [],
5965
- * });
5966
- *
5967
- * // Acquire an auth client, and bind it to all future calls
5968
- * const authClient = await auth.getClient();
5969
- * google.options({auth: authClient});
5970
- *
5971
- * // Do the magic
5972
- * const res = await vault.operations.list({
5973
- * // The standard list filter.
5974
- * filter: 'placeholder-value',
5975
- * // The name of the operation's parent resource.
5976
- * name: 'operations',
5977
- * // The standard list page size.
5978
- * pageSize: 'placeholder-value',
5979
- * // The standard list page token.
5980
- * pageToken: 'placeholder-value',
5981
- * });
5982
- * console.log(res.data);
5983
- *
5984
- * // Example response
5985
- * // {
5986
- * // "nextPageToken": "my_nextPageToken",
5987
- * // "operations": []
5988
- * // }
5989
- * }
5990
- *
5991
- * main().catch(e => {
5992
- * console.error(e);
5993
- * throw e;
5994
- * });
5995
- *
5996
- * ```
5997
4299
  *
5998
4300
  * @param params - Parameters for request
5999
4301
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.