@googleapis/vault 0.2.1 → 0.4.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/build/v1.d.ts CHANGED
@@ -56,9 +56,9 @@ export declare namespace vault_v1 {
56
56
  upload_protocol?: string;
57
57
  }
58
58
  /**
59
- * G Suite Vault API
59
+ * Google Vault API
60
60
  *
61
- * Archiving and eDiscovery for G Suite.
61
+ * Retention and eDiscovery for Google Workspace. To work with Vault resources, the account must have the [required Vault privileges](https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege. For example, to download an export, an account needs the **Manage Exports** privilege and the matter shared with them.
62
62
  *
63
63
  * @example
64
64
  * ```js
@@ -73,7 +73,7 @@ export declare namespace vault_v1 {
73
73
  constructor(options: GlobalOptions, google?: GoogleConfigurable);
74
74
  }
75
75
  /**
76
- * Count number for each account.
76
+ * The results count for each account.
77
77
  */
78
78
  export interface Schema$AccountCount {
79
79
  /**
@@ -81,7 +81,7 @@ export declare namespace vault_v1 {
81
81
  */
82
82
  account?: Schema$UserInfo;
83
83
  /**
84
- * The number of artifacts found for this account.
84
+ * The number of results (messages or files) found for this account.
85
85
  */
86
86
  count?: string | null;
87
87
  }
@@ -99,7 +99,7 @@ export declare namespace vault_v1 {
99
99
  errorType?: string | null;
100
100
  }
101
101
  /**
102
- * Accounts to search
102
+ * The accounts to search
103
103
  */
104
104
  export interface Schema$AccountInfo {
105
105
  /**
@@ -108,15 +108,15 @@ export declare namespace vault_v1 {
108
108
  emails?: string[] | null;
109
109
  }
110
110
  /**
111
- * A status detailing the status of each account creation, and the HeldAccount, if successful.
111
+ * The status of each account creation, and the **HeldAccount**, if successful.
112
112
  */
113
113
  export interface Schema$AddHeldAccountResult {
114
114
  /**
115
- * If present, this account was successfully created.
115
+ * Returned when the account was successfully created.
116
116
  */
117
117
  account?: Schema$HeldAccount;
118
118
  /**
119
- * This represents the success status. If failed, check message.
119
+ * Reports the request status. If it failed, returns an error message.
120
120
  */
121
121
  status?: Schema$Status;
122
122
  }
@@ -125,11 +125,11 @@ export declare namespace vault_v1 {
125
125
  */
126
126
  export interface Schema$AddHeldAccountsRequest {
127
127
  /**
128
- * Account IDs to identify which accounts to add. Only account_ids or only emails should be specified, but not both.
128
+ * A comma-separated list of the account IDs of the accounts to add to the hold. Specify either **emails** or **account_ids**, but not both.
129
129
  */
130
130
  accountIds?: string[] | null;
131
131
  /**
132
- * Emails to identify which accounts to add. Only emails or only account_ids should be specified, but not both.
132
+ * A comma-separated list of the emails of the accounts to add to the hold. Specify either **emails** or **account_ids**, but not both.
133
133
  */
134
134
  emails?: string[] | null;
135
135
  }
@@ -143,19 +143,19 @@ export declare namespace vault_v1 {
143
143
  responses?: Schema$AddHeldAccountResult[];
144
144
  }
145
145
  /**
146
- * Add an account with the permission specified. The role cannot be owner. If an account already has a role in the matter, it will be overwritten.
146
+ * Add an account with the permission specified. The role cannot be owner. If an account already has a role in the matter, the existing role is overwritten.
147
147
  */
148
148
  export interface Schema$AddMatterPermissionsRequest {
149
149
  /**
150
- * Only relevant if send_emails is true. True to CC requestor in the email message. False to not CC requestor.
150
+ * Only relevant if **sendEmails** is **true**. To CC the requestor in the email message, set to **true**. To not CC requestor, set to **false**.
151
151
  */
152
152
  ccMe?: boolean | null;
153
153
  /**
154
- * The MatterPermission to add.
154
+ * The account and its role to add.
155
155
  */
156
156
  matterPermission?: Schema$MatterPermission;
157
157
  /**
158
- * True to send notification email to the added account. False to not send notification email.
158
+ * To send a notification email to the added account, set to **true**. To not send a notification email, set to **false**.
159
159
  */
160
160
  sendEmails?: boolean | null;
161
161
  }
@@ -174,16 +174,16 @@ export declare namespace vault_v1 {
174
174
  */
175
175
  export interface Schema$CloseMatterResponse {
176
176
  /**
177
- * The updated matter, with state CLOSED.
177
+ * The updated matter, with state **CLOSED**.
178
178
  */
179
179
  matter?: Schema$Matter;
180
180
  }
181
181
  /**
182
- * An export file on cloud storage
182
+ * The export file in Cloud Storage
183
183
  */
184
184
  export interface Schema$CloudStorageFile {
185
185
  /**
186
- * The cloud storage bucket name of this export file. Can be used in cloud storage JSON/XML API, but not to list the bucket contents. Instead, you can get individual export files by object name.
186
+ * The name of the Cloud Storage bucket for the export file. You can use this value in the [Cloud Storage JSON or XML APIs](https://cloud.google.com/storage/docs/apis), but not to list the bucket contents. Instead, you can [get individual export files](https://cloud.google.com/storage/docs/json_api/v1/objects/get) by object name.
187
187
  */
188
188
  bucketName?: string | null;
189
189
  /**
@@ -191,45 +191,45 @@ export declare namespace vault_v1 {
191
191
  */
192
192
  md5Hash?: string | null;
193
193
  /**
194
- * The cloud storage object name of this export file. Can be used in cloud storage JSON/XML API.
194
+ * The name of the Cloud Storage object for the export file. You can use this value in the [Cloud Storage JSON or XML APIs](https://cloud.google.com/storage/docs/apis).
195
195
  */
196
196
  objectName?: string | null;
197
197
  /**
198
- * The size of the export file.
198
+ * The export file size.
199
199
  */
200
200
  size?: string | null;
201
201
  }
202
202
  /**
203
- * Export sink for cloud storage files.
203
+ * Export sink for Cloud Storage files.
204
204
  */
205
205
  export interface Schema$CloudStorageSink {
206
206
  /**
207
- * Output only. The exported files on cloud storage.
207
+ * Output only. The exported files in Cloud Storage.
208
208
  */
209
209
  files?: Schema$CloudStorageFile[];
210
210
  }
211
211
  /**
212
- * Corpus specific queries.
212
+ * Service-specific options for holds.
213
213
  */
214
214
  export interface Schema$CorpusQuery {
215
215
  /**
216
- * Details pertaining to Drive holds. If set, corpus must be Drive.
216
+ * Service-specific options for Drive holds. If set, **CorpusType** must be **DRIVE**.
217
217
  */
218
218
  driveQuery?: Schema$HeldDriveQuery;
219
219
  /**
220
- * Details pertaining to Groups holds. If set, corpus must be Groups.
220
+ * Service-specific options for Groups holds. If set, **CorpusType** must be **GROUPS**.
221
221
  */
222
222
  groupsQuery?: Schema$HeldGroupsQuery;
223
223
  /**
224
- * Details pertaining to Hangouts Chat holds. If set, corpus must be Hangouts Chat.
224
+ * Service-specific options for Chat holds. If set, **CorpusType** must be **HANGOUTS_CHAT**.
225
225
  */
226
226
  hangoutsChatQuery?: Schema$HeldHangoutsChatQuery;
227
227
  /**
228
- * Details pertaining to mail holds. If set, corpus must be mail.
228
+ * Service-specific options for Gmail holds. If set, **CorpusType** must be **MAIL**.
229
229
  */
230
230
  mailQuery?: Schema$HeldMailQuery;
231
231
  /**
232
- * Details pertaining to Voice holds. If set, corpus must be Voice.
232
+ * Service-specific options for Voice holds. If set, **CorpusType** must be **VOICE**.
233
233
  */
234
234
  voiceQuery?: Schema$HeldVoiceQuery;
235
235
  }
@@ -263,7 +263,7 @@ export declare namespace vault_v1 {
263
263
  */
264
264
  query?: Schema$Query;
265
265
  /**
266
- * Specifies the granularity of the count result returned in response.
266
+ * Sets the granularity of the count results.
267
267
  */
268
268
  view?: string | null;
269
269
  }
@@ -272,33 +272,33 @@ export declare namespace vault_v1 {
272
272
  */
273
273
  export interface Schema$CountArtifactsResponse {
274
274
  /**
275
- * Count metrics of Groups.
275
+ * Count metrics for Groups.
276
276
  */
277
277
  groupsCountResult?: Schema$GroupsCountResult;
278
278
  /**
279
- * Count metrics of Mail.
279
+ * Count metrics for Gmail and classic Hangouts.
280
280
  */
281
281
  mailCountResult?: Schema$MailCountResult;
282
282
  /**
283
- * Total count of artifacts. For mail and groups, artifacts refers to messages.
283
+ * Total count of messages.
284
284
  */
285
285
  totalCount?: string | null;
286
286
  }
287
287
  /**
288
- * The options for Drive export.
288
+ * Options for Drive exports.
289
289
  */
290
290
  export interface Schema$DriveExportOptions {
291
291
  /**
292
- * Set to true to include access level information for users with indirect access to files.
292
+ * To include access level information for users with [indirect access](https://support.google.com/vault/answer/6099459#metadata) to files, set to **true**.
293
293
  */
294
294
  includeAccessInfo?: boolean | null;
295
295
  }
296
296
  /**
297
- * Drive search advanced options
297
+ * Additional options for Drive search
298
298
  */
299
299
  export interface Schema$DriveOptions {
300
300
  /**
301
- * Set to true to include shared drive.
301
+ * Set to **true** to include shared drives.
302
302
  */
303
303
  includeSharedDrives?: boolean | null;
304
304
  /**
@@ -306,7 +306,7 @@ export declare namespace vault_v1 {
306
306
  */
307
307
  includeTeamDrives?: boolean | null;
308
308
  /**
309
- * Search the versions of the Drive file as of the reference date. These timestamps are in GMT and rounded down to the given date.
309
+ * 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.
310
310
  */
311
311
  versionDate?: string | null;
312
312
  }
@@ -316,11 +316,11 @@ export declare namespace vault_v1 {
316
316
  export interface Schema$Empty {
317
317
  }
318
318
  /**
319
- * An export To work with Vault resources, the account must have the [required Vault privileges] (https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege.
319
+ * An export. To work with Vault resources, the account must have the [required Vault privileges](https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege.
320
320
  */
321
321
  export interface Schema$Export {
322
322
  /**
323
- * Output only. Export sink for cloud storage files.
323
+ * Output only. The sink for export files in Cloud Storage.
324
324
  */
325
325
  cloudStorageSink?: Schema$CloudStorageSink;
326
326
  /**
@@ -328,7 +328,7 @@ export declare namespace vault_v1 {
328
328
  */
329
329
  createTime?: string | null;
330
330
  /**
331
- * Advanced options of the export.
331
+ * Additional export options.
332
332
  */
333
333
  exportOptions?: Schema$ExportOptions;
334
334
  /**
@@ -340,11 +340,11 @@ export declare namespace vault_v1 {
340
340
  */
341
341
  matterId?: string | null;
342
342
  /**
343
- * The export name.
343
+ * The export name. Don't use special characters (~!$'(),;@:/?) in the name, they can prevent you from downloading exports.
344
344
  */
345
345
  name?: string | null;
346
346
  /**
347
- * The search query being exported.
347
+ * The query parameters used to create the export.
348
348
  */
349
349
  query?: Schema$Query;
350
350
  /**
@@ -352,49 +352,49 @@ export declare namespace vault_v1 {
352
352
  */
353
353
  requester?: Schema$UserInfo;
354
354
  /**
355
- * Output only. Export statistics.
355
+ * Output only. Details about the export progress and size.
356
356
  */
357
357
  stats?: Schema$ExportStats;
358
358
  /**
359
- * Output only. The export status.
359
+ * Output only. The status of the export.
360
360
  */
361
361
  status?: string | null;
362
362
  }
363
363
  /**
364
- * Export advanced options
364
+ * Additional options for exports
365
365
  */
366
366
  export interface Schema$ExportOptions {
367
367
  /**
368
- * Option available for Drive export.
368
+ * Options for Drive exports.
369
369
  */
370
370
  driveOptions?: Schema$DriveExportOptions;
371
371
  /**
372
- * Option available for groups export.
372
+ * Options for Groups exports.
373
373
  */
374
374
  groupsOptions?: Schema$GroupsExportOptions;
375
375
  /**
376
- * Option available for hangouts chat export.
376
+ * Options for Chat exports.
377
377
  */
378
378
  hangoutsChatOptions?: Schema$HangoutsChatExportOptions;
379
379
  /**
380
- * Option available for mail export.
380
+ * Options for Gmail exports.
381
381
  */
382
382
  mailOptions?: Schema$MailExportOptions;
383
383
  /**
384
- * The requested export location.
384
+ * The requested data region for the export.
385
385
  */
386
386
  region?: string | null;
387
387
  /**
388
- * Option available for voice export.
388
+ * Options for Voice exports.
389
389
  */
390
390
  voiceOptions?: Schema$VoiceExportOptions;
391
391
  }
392
392
  /**
393
- * Stats of an export.
393
+ * Progress information for an export.
394
394
  */
395
395
  export interface Schema$ExportStats {
396
396
  /**
397
- * The number of documents already processed by the export.
397
+ * The number of messages or files already processed for export.
398
398
  */
399
399
  exportedArtifactCount?: string | null;
400
400
  /**
@@ -402,7 +402,7 @@ export declare namespace vault_v1 {
402
402
  */
403
403
  sizeInBytes?: string | null;
404
404
  /**
405
- * The number of documents to be exported.
405
+ * The number of messages or files to be exported.
406
406
  */
407
407
  totalArtifactCount?: string | null;
408
408
  }
@@ -423,7 +423,7 @@ export declare namespace vault_v1 {
423
423
  */
424
424
  matchingAccountsCount?: string | null;
425
425
  /**
426
- * When data scope is HELD_DATA in the request Query, these accounts in the request are not queried because they are not on hold. For other data scope, this field is not set.
426
+ * When **DataScope** is **HELD_DATA**, these accounts in the request are not queried because they are not on hold. For other data scope, this field is not set.
427
427
  */
428
428
  nonQueryableAccounts?: string[] | null;
429
429
  /**
@@ -432,51 +432,51 @@ export declare namespace vault_v1 {
432
432
  queriedAccountsCount?: string | null;
433
433
  }
434
434
  /**
435
- * The options for groups export.
435
+ * Options for Groups exports.
436
436
  */
437
437
  export interface Schema$GroupsExportOptions {
438
438
  /**
439
- * The export format for groups export.
439
+ * The file format for exported messages.
440
440
  */
441
441
  exportFormat?: string | null;
442
442
  }
443
443
  /**
444
- * The options for hangouts chat export.
444
+ * Options for Chat exports.
445
445
  */
446
446
  export interface Schema$HangoutsChatExportOptions {
447
447
  /**
448
- * The export format for hangouts chat export.
448
+ * The file format for exported messages.
449
449
  */
450
450
  exportFormat?: string | null;
451
451
  }
452
452
  /**
453
- * Accounts to search
453
+ * The Chat spaces to search
454
454
  */
455
455
  export interface Schema$HangoutsChatInfo {
456
456
  /**
457
- * A set of rooms to search.
457
+ * A list of Chat spaces IDs, as provided by the [Chat API](https://developers.google.com/hangouts/chat).
458
458
  */
459
459
  roomId?: string[] | null;
460
460
  }
461
461
  /**
462
- * Hangouts chat search advanced options
462
+ * Additional options for Google Chat search
463
463
  */
464
464
  export interface Schema$HangoutsChatOptions {
465
465
  /**
466
- * Set to true to include rooms.
466
+ * For searches by account or organizational unit, set to **true** to include rooms.
467
467
  */
468
468
  includeRooms?: boolean | null;
469
469
  }
470
470
  /**
471
- * An account being held in a particular hold. This structure is immutable. This can be either a single user or a google group, depending on the corpus. To work with Vault resources, the account must have the [required Vault privileges] (https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege.
471
+ * An account covered by a hold. This structure is immutable. It can be an individual account or a Google Group, depending on the service. To work with Vault resources, the account must have the [required Vault privileges] (https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege.
472
472
  */
473
473
  export interface Schema$HeldAccount {
474
474
  /**
475
- * The account's ID as provided by the Admin SDK.
475
+ * The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).
476
476
  */
477
477
  accountId?: string | null;
478
478
  /**
479
- * The primary email address of the account. If used as an input, this takes precedence over account ID.
479
+ * The primary email address of the account. If used as an input, this takes precedence over **accountId**.
480
480
  */
481
481
  email?: string | null;
482
482
  /**
@@ -493,15 +493,15 @@ export declare namespace vault_v1 {
493
493
  lastName?: string | null;
494
494
  }
495
495
  /**
496
- * Query options for Drive holds.
496
+ * Options for Drive holds.
497
497
  */
498
498
  export interface Schema$HeldDriveQuery {
499
499
  /**
500
- * If true, include files in shared drives in the hold.
500
+ * To include files in shared drives in the hold, set to **true**.
501
501
  */
502
502
  includeSharedDriveFiles?: boolean | null;
503
503
  /**
504
- * If true, include files in Team Drives in the hold.
504
+ * To include files in Team Drives in the hold, set to **true**.
505
505
  */
506
506
  includeTeamDriveFiles?: boolean | null;
507
507
  }
@@ -510,76 +510,76 @@ export declare namespace vault_v1 {
510
510
  */
511
511
  export interface Schema$HeldGroupsQuery {
512
512
  /**
513
- * The end time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
513
+ * The end time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.
514
514
  */
515
515
  endTime?: string | null;
516
516
  /**
517
- * The start time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
517
+ * The start time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.
518
518
  */
519
519
  startTime?: string | null;
520
520
  /**
521
- * The search terms for the hold.
521
+ * The [search operators](https://support.google.com/vault/answer/2474474) used to refine the messages covered by the hold.
522
522
  */
523
523
  terms?: string | null;
524
524
  }
525
525
  /**
526
- * Query options for hangouts chat holds.
526
+ * Options for Chat holds.
527
527
  */
528
528
  export interface Schema$HeldHangoutsChatQuery {
529
529
  /**
530
- * If true, include rooms the user has participated in.
530
+ * To include messages in Chat spaces the user was a member of, set to **true**.
531
531
  */
532
532
  includeRooms?: boolean | null;
533
533
  }
534
534
  /**
535
- * Query options for mail holds.
535
+ * Query options for Gmail holds.
536
536
  */
537
537
  export interface Schema$HeldMailQuery {
538
538
  /**
539
- * The end time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
539
+ * The end time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.
540
540
  */
541
541
  endTime?: string | null;
542
542
  /**
543
- * The start time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
543
+ * The start time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.
544
544
  */
545
545
  startTime?: string | null;
546
546
  /**
547
- * The search terms for the hold.
547
+ * The [search operators](https://support.google.com/vault/answer/2474474) used to refine the messages covered by the hold.
548
548
  */
549
549
  terms?: string | null;
550
550
  }
551
551
  /**
552
- * A organizational unit being held in a particular hold. This structure is immutable.
552
+ * The organizational unit covered by a hold. This structure is immutable.
553
553
  */
554
554
  export interface Schema$HeldOrgUnit {
555
555
  /**
556
- * When the org unit was put on hold. This property is immutable.
556
+ * When the organizational unit was put on hold. This property is immutable.
557
557
  */
558
558
  holdTime?: string | null;
559
559
  /**
560
- * The org unit's immutable ID as provided by the Admin SDK.
560
+ * The organizational unit's immutable ID as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).
561
561
  */
562
562
  orgUnitId?: string | null;
563
563
  }
564
564
  /**
565
- * Query options for Voice holds.
565
+ * Options for Voice holds.
566
566
  */
567
567
  export interface Schema$HeldVoiceQuery {
568
568
  /**
569
- * Data covered by this rule. Should be non-empty. Order does not matter and duplicates will be ignored.
569
+ * A list of data types covered by the hold. Should be non-empty. Order does not matter and duplicates are ignored.
570
570
  */
571
571
  coveredData?: string[] | null;
572
572
  }
573
573
  /**
574
- * Represents a hold within Vault. A hold restricts purging of artifacts based on the combination of the query and accounts restrictions. A hold can be configured to either apply to an explicitly configured set of accounts, or can be applied to all members of an organizational unit. To work with Vault resources, the account must have the [required Vault privileges] (https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege.
574
+ * A hold. A hold prevents the specified Google Workspace service from purging data for specific accounts or all members of an organizational unit. To work with Vault resources, the account must have the [required Vault privileges] (https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege.
575
575
  */
576
576
  export interface Schema$Hold {
577
577
  /**
578
- * If set, the hold applies to the enumerated accounts and org_unit must be empty.
578
+ * If set, the hold applies to the specified accounts and **orgUnit** must be empty.
579
579
  */
580
580
  accounts?: Schema$HeldAccount[];
581
581
  /**
582
- * The corpus to be searched.
582
+ * The service to be searched.
583
583
  */
584
584
  corpus?: string | null;
585
585
  /**
@@ -591,11 +591,11 @@ export declare namespace vault_v1 {
591
591
  */
592
592
  name?: string | null;
593
593
  /**
594
- * If set, the hold applies to all members of the organizational unit and accounts must be empty. This property is mutable. For groups holds, set the accounts field.
594
+ * If set, the hold applies to all members of the organizational unit and **accounts** must be empty. This property is mutable. For Groups holds, set **accounts**.
595
595
  */
596
596
  orgUnit?: Schema$HeldOrgUnit;
597
597
  /**
598
- * The corpus-specific query. If set, the corpusQuery must match corpus type.
598
+ * Service-specific options. If set, **CorpusQuery** must match **CorpusType**.
599
599
  */
600
600
  query?: Schema$CorpusQuery;
601
601
  /**
@@ -604,7 +604,7 @@ export declare namespace vault_v1 {
604
604
  updateTime?: string | null;
605
605
  }
606
606
  /**
607
- * The holds for a matter.
607
+ * The exports for a matter.
608
608
  */
609
609
  export interface Schema$ListExportsResponse {
610
610
  /**
@@ -617,7 +617,7 @@ export declare namespace vault_v1 {
617
617
  nextPageToken?: string | null;
618
618
  }
619
619
  /**
620
- * Returns a list of held accounts for a hold.
620
+ * Returns a list of the accounts covered by a hold.
621
621
  */
622
622
  export interface Schema$ListHeldAccountsResponse {
623
623
  /**
@@ -673,16 +673,16 @@ export declare namespace vault_v1 {
673
673
  */
674
674
  nextPageToken?: string | null;
675
675
  /**
676
- * List of output saved queries.
676
+ * List of saved queries.
677
677
  */
678
678
  savedQueries?: Schema$SavedQuery[];
679
679
  }
680
680
  /**
681
- * Mail specific count metrics.
681
+ * Gmail and classic Hangouts-specific count metrics.
682
682
  */
683
683
  export interface Schema$MailCountResult {
684
684
  /**
685
- * Error occurred when querying these accounts.
685
+ * Errors occurred when querying these accounts.
686
686
  */
687
687
  accountCountErrors?: Schema$AccountCountError[];
688
688
  /**
@@ -694,7 +694,7 @@ export declare namespace vault_v1 {
694
694
  */
695
695
  matchingAccountsCount?: string | null;
696
696
  /**
697
- * When data scope is HELD_DATA in the request Query, these accounts in the request are not queried because they are not on hold. For other data scope, this field is not set.
697
+ * When **DataScope** is **HELD_DATA** and when account emails are passed in explicitly, the list of accounts in the request that are not queried because they are not on hold in the matter. For other data scopes, this field is not set.
698
698
  */
699
699
  nonQueryableAccounts?: string[] | null;
700
700
  /**
@@ -703,24 +703,28 @@ export declare namespace vault_v1 {
703
703
  queriedAccountsCount?: string | null;
704
704
  }
705
705
  /**
706
- * The options for mail export.
706
+ * Options for Gmail exports.
707
707
  */
708
708
  export interface Schema$MailExportOptions {
709
709
  /**
710
- * The export file format.
710
+ * The file format for exported messages.
711
711
  */
712
712
  exportFormat?: string | null;
713
713
  /**
714
- * Set to true to export confidential mode content.
714
+ * To export confidential mode content, set to **true**.
715
715
  */
716
716
  showConfidentialModeContent?: boolean | null;
717
+ /**
718
+ * To use the new export system, set to **true**.
719
+ */
720
+ useNewExport?: boolean | null;
717
721
  }
718
722
  /**
719
- * Mail search advanced options
723
+ * Additional options for Gmail search
720
724
  */
721
725
  export interface Schema$MailOptions {
722
726
  /**
723
- * Set to true to exclude drafts.
727
+ * Set to **true** to exclude drafts.
724
728
  */
725
729
  excludeDrafts?: boolean | null;
726
730
  }
@@ -729,15 +733,15 @@ export declare namespace vault_v1 {
729
733
  */
730
734
  export interface Schema$Matter {
731
735
  /**
732
- * The description of the matter.
736
+ * An optional description for the matter.
733
737
  */
734
738
  description?: string | null;
735
739
  /**
736
- * The matter ID which is generated by the server. Should be blank when creating a new matter.
740
+ * The matter ID, which is generated by the server. Leave blank when creating a matter.
737
741
  */
738
742
  matterId?: string | null;
739
743
  /**
740
- * List of users and access to the matter. Currently there is no programmer defined limit on the number of permissions a matter can have.
744
+ * Lists the users and their permission for the matter. Currently there is no programmer defined limit on the number of permissions a matter can have.
741
745
  */
742
746
  matterPermissions?: Schema$MatterPermission[];
743
747
  /**
@@ -750,15 +754,15 @@ export declare namespace vault_v1 {
750
754
  state?: string | null;
751
755
  }
752
756
  /**
753
- * Currently each matter only has one owner, and all others are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist.
757
+ * Users can be matter owners or collaborators. Each matter has only one owner. All others users who can access the matter are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist.
754
758
  */
755
759
  export interface Schema$MatterPermission {
756
760
  /**
757
- * The account ID, as provided by Admin SDK.
761
+ * The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).
758
762
  */
759
763
  accountId?: string | null;
760
764
  /**
761
- * The user's role in this matter.
765
+ * The user's role for the matter.
762
766
  */
763
767
  role?: string | null;
764
768
  }
@@ -792,56 +796,56 @@ export declare namespace vault_v1 {
792
796
  } | null;
793
797
  }
794
798
  /**
795
- * Org Unit to search
799
+ * The organizational unit to search
796
800
  */
797
801
  export interface Schema$OrgUnitInfo {
798
802
  /**
799
- * Org unit to search, as provided by the Admin SDK Directory API.
803
+ * The name of the organizational unit to search, as provided by the [Admin SDK Directory API](https://developers.google.com/admin-sdk/directory/).
800
804
  */
801
805
  orgUnitId?: string | null;
802
806
  }
803
807
  /**
804
- * A query definition relevant for search & export.
808
+ * The query definition used for search and export.
805
809
  */
806
810
  export interface Schema$Query {
807
811
  /**
808
- * When 'ACCOUNT' is chosen as search method, account_info needs to be specified.
812
+ * Required when **SearchMethod** is **ACCOUNT**.
809
813
  */
810
814
  accountInfo?: Schema$AccountInfo;
811
815
  /**
812
- * The corpus to search.
816
+ * The Google Workspace service to search.
813
817
  */
814
818
  corpus?: string | null;
815
819
  /**
816
- * The data source to search from.
820
+ * The data source to search.
817
821
  */
818
822
  dataScope?: string | null;
819
823
  /**
820
- * For Drive search, specify more options in this field.
824
+ * Set Drive search-specific options.
821
825
  */
822
826
  driveOptions?: Schema$DriveOptions;
823
827
  /**
824
- * The end time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
828
+ * The end time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date.
825
829
  */
826
830
  endTime?: string | null;
827
831
  /**
828
- * When 'ROOM' is chosen as search method, hangout_chats_info needs to be specified. (read-only)
832
+ * Required when **SearchMethod** is **ROOM**. (read-only)
829
833
  */
830
834
  hangoutsChatInfo?: Schema$HangoutsChatInfo;
831
835
  /**
832
- * For hangouts chat search, specify more options in this field. (read-only)
836
+ * Set Chat search-specific options. (read-only)
833
837
  */
834
838
  hangoutsChatOptions?: Schema$HangoutsChatOptions;
835
839
  /**
836
- * For mail search, specify more options in this field.
840
+ * Set Gmail search-specific options.
837
841
  */
838
842
  mailOptions?: Schema$MailOptions;
839
843
  /**
840
- * The search method to use. This field is similar to the search_method field but is introduced to support shared drives. It supports all search method types. In case the search_method is TEAM_DRIVE the response of this field will be SHARED_DRIVE only.
844
+ * The entity to search. This field replaces **searchMethod** to support shared drives. When **searchMethod** is **TEAM_DRIVE**, the response of this field is **SHARED_DRIVE**.
841
845
  */
842
846
  method?: string | null;
843
847
  /**
844
- * When 'ORG_UNIT' is chosen as as search method, org_unit_info needs to be specified.
848
+ * Required when **SearchMethod** is **ORG_UNIT**.
845
849
  */
846
850
  orgUnitInfo?: Schema$OrgUnitInfo;
847
851
  /**
@@ -849,27 +853,27 @@ export declare namespace vault_v1 {
849
853
  */
850
854
  searchMethod?: string | null;
851
855
  /**
852
- * When 'SHARED_DRIVE' is chosen as search method, shared_drive_info needs to be specified.
856
+ * Required when **SearchMethod** is **SHARED_DRIVE**.
853
857
  */
854
858
  sharedDriveInfo?: Schema$SharedDriveInfo;
855
859
  /**
856
- * The start time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
860
+ * The start time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date.
857
861
  */
858
862
  startTime?: string | null;
859
863
  /**
860
- * When 'TEAM_DRIVE' is chosen as search method, team_drive_info needs to be specified.
864
+ * Required when **SearchMethod** is **TEAM_DRIVE**.
861
865
  */
862
866
  teamDriveInfo?: Schema$TeamDriveInfo;
863
867
  /**
864
- * The corpus-specific search operators used to generate search results.
868
+ * Service-specific [search operators](https://support.google.com/vault/answer/2474474) to filter search results.
865
869
  */
866
870
  terms?: string | null;
867
871
  /**
868
- * The time zone name. It should be an IANA TZ name, such as "America/Los_Angeles". For more information, see Time Zone.
872
+ * The time zone name. It should be an IANA TZ name, such as "America/Los_Angeles". For a list of time zone names, see [Time Zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For more information about how Vault uses time zones, see [the Vault help center](https://support.google.com/vault/answer/6092995#time).
869
873
  */
870
874
  timeZone?: string | null;
871
875
  /**
872
- * For voice search, specify more options in this field.
876
+ * Set Voice search-specific options.
873
877
  */
874
878
  voiceOptions?: Schema$VoiceOptions;
875
879
  }
@@ -878,7 +882,7 @@ export declare namespace vault_v1 {
878
882
  */
879
883
  export interface Schema$RemoveHeldAccountsRequest {
880
884
  /**
881
- * Account IDs to identify HeldAccounts to remove.
885
+ * The account IDs of the accounts to remove from the hold.
882
886
  */
883
887
  accountIds?: string[] | null;
884
888
  }
@@ -887,7 +891,7 @@ export declare namespace vault_v1 {
887
891
  */
888
892
  export interface Schema$RemoveHeldAccountsResponse {
889
893
  /**
890
- * A list of statuses for deleted accounts. Results have the same order as the request.
894
+ * A list of statuses for the deleted accounts. Results have the same order as the request.
891
895
  */
892
896
  statuses?: Schema$Status[];
893
897
  }
@@ -910,28 +914,28 @@ export declare namespace vault_v1 {
910
914
  */
911
915
  export interface Schema$ReopenMatterResponse {
912
916
  /**
913
- * The updated matter, with state OPEN.
917
+ * The updated matter, with state **OPEN**.
914
918
  */
915
919
  matter?: Schema$Matter;
916
920
  }
917
921
  /**
918
- * Definition of the saved query. To work with Vault resources, the account must have the [required Vault privileges] (https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege.
922
+ * The definition of a saved query. To work with Vault resources, the account must have the [required Vault privileges](https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege.
919
923
  */
920
924
  export interface Schema$SavedQuery {
921
925
  /**
922
- * Output only. The server generated timestamp at which saved query was created.
926
+ * Output only. The server-generated timestamp when the saved query was created.
923
927
  */
924
928
  createTime?: string | null;
925
929
  /**
926
- * Name of the saved query.
930
+ * The name of the saved query.
927
931
  */
928
932
  displayName?: string | null;
929
933
  /**
930
- * Output only. The matter ID of the associated matter. The server does not look at this field during create and always uses matter id in the URL.
934
+ * Output only. The matter ID of the matter the saved query is saved in. The server does not use this field during create and always uses matter ID in the URL.
931
935
  */
932
936
  matterId?: string | null;
933
937
  /**
934
- * The underlying Query object which contains all the information of the saved query.
938
+ * The search parameters of the saved query.
935
939
  */
936
940
  query?: Schema$Query;
937
941
  /**
@@ -940,11 +944,11 @@ export declare namespace vault_v1 {
940
944
  savedQueryId?: string | null;
941
945
  }
942
946
  /**
943
- * Shared drives to search
947
+ * The shared drives to search
944
948
  */
945
949
  export interface Schema$SharedDriveInfo {
946
950
  /**
947
- * List of Shared drive IDs, as provided by Drive API.
951
+ * A list of shared drive IDs, as provided by the [Drive API](https://developers.google.com/drive).
948
952
  */
949
953
  sharedDriveIds?: string[] | null;
950
954
  }
@@ -972,7 +976,7 @@ export declare namespace vault_v1 {
972
976
  */
973
977
  export interface Schema$TeamDriveInfo {
974
978
  /**
975
- * List of Team Drive IDs, as provided by Drive API.
979
+ * List of Team Drive IDs, as provided by the [Drive API](https://developers.google.com/drive).
976
980
  */
977
981
  teamDriveIds?: string[] | null;
978
982
  }
@@ -995,16 +999,16 @@ export declare namespace vault_v1 {
995
999
  email?: string | null;
996
1000
  }
997
1001
  /**
998
- * The options for voice export.
1002
+ * The options for Voice exports.
999
1003
  */
1000
1004
  export interface Schema$VoiceExportOptions {
1001
1005
  /**
1002
- * The export format for voice export.
1006
+ * The file format for exported text messages.
1003
1007
  */
1004
1008
  exportFormat?: string | null;
1005
1009
  }
1006
1010
  /**
1007
- * Voice search options
1011
+ * Additional options for Voice search
1008
1012
  */
1009
1013
  export interface Schema$VoiceOptions {
1010
1014
  /**
@@ -1086,7 +1090,7 @@ export declare namespace vault_v1 {
1086
1090
  addPermissions(params: Params$Resource$Matters$Addpermissions, callback: BodyResponseCallback<Schema$MatterPermission>): void;
1087
1091
  addPermissions(callback: BodyResponseCallback<Schema$MatterPermission>): void;
1088
1092
  /**
1089
- * Closes the specified matter. Returns matter with updated state.
1093
+ * Closes the specified matter. Returns the matter with updated state.
1090
1094
  * @example
1091
1095
  * ```js
1092
1096
  * // Before running the sample:
@@ -1148,7 +1152,7 @@ export declare namespace vault_v1 {
1148
1152
  close(params: Params$Resource$Matters$Close, callback: BodyResponseCallback<Schema$CloseMatterResponse>): void;
1149
1153
  close(callback: BodyResponseCallback<Schema$CloseMatterResponse>): void;
1150
1154
  /**
1151
- * Counts the artifacts within the context of a matter and returns a detailed breakdown of metrics.
1155
+ * Counts the accounts processed by the specified query.
1152
1156
  * @example
1153
1157
  * ```js
1154
1158
  * // Before running the sample:
@@ -1217,7 +1221,7 @@ export declare namespace vault_v1 {
1217
1221
  count(params: Params$Resource$Matters$Count, callback: BodyResponseCallback<Schema$Operation>): void;
1218
1222
  count(callback: BodyResponseCallback<Schema$Operation>): void;
1219
1223
  /**
1220
- * Creates a new matter with the given name and description. The initial state is open, and the owner is the method caller. Returns the created matter with default view.
1224
+ * 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.
1221
1225
  * @example
1222
1226
  * ```js
1223
1227
  * // Before running the sample:
@@ -1286,7 +1290,7 @@ export declare namespace vault_v1 {
1286
1290
  create(params: Params$Resource$Matters$Create, callback: BodyResponseCallback<Schema$Matter>): void;
1287
1291
  create(callback: BodyResponseCallback<Schema$Matter>): void;
1288
1292
  /**
1289
- * Deletes the specified matter. Returns matter with updated state.
1293
+ * Deletes the specified matter. Returns the matter with updated state.
1290
1294
  * @example
1291
1295
  * ```js
1292
1296
  * // Before running the sample:
@@ -1377,7 +1381,7 @@ export declare namespace vault_v1 {
1377
1381
  * const res = await vault.matters.get({
1378
1382
  * // The matter ID.
1379
1383
  * matterId: 'placeholder-value',
1380
- * // Specifies which parts of the Matter to return in the response.
1384
+ * // Specifies how much information about the matter to return in the response.
1381
1385
  * view: 'placeholder-value',
1382
1386
  * });
1383
1387
  * console.log(res.data);
@@ -1411,7 +1415,7 @@ export declare namespace vault_v1 {
1411
1415
  get(params: Params$Resource$Matters$Get, callback: BodyResponseCallback<Schema$Matter>): void;
1412
1416
  get(callback: BodyResponseCallback<Schema$Matter>): void;
1413
1417
  /**
1414
- * Lists matters the user has access to.
1418
+ * Lists matters the requestor has access to.
1415
1419
  * @example
1416
1420
  * ```js
1417
1421
  * // Before running the sample:
@@ -1444,9 +1448,9 @@ export declare namespace vault_v1 {
1444
1448
  * pageSize: 'placeholder-value',
1445
1449
  * // The pagination token as returned in the response.
1446
1450
  * pageToken: 'placeholder-value',
1447
- * // If set, list only matters with that specific state. The default is listing matters of all states.
1451
+ * // If set, lists only matters with the specified state. The default lists matters of all states.
1448
1452
  * state: 'placeholder-value',
1449
- * // Specifies which parts of the matter to return in response.
1453
+ * // Specifies how much information about the matter to return in response.
1450
1454
  * view: 'placeholder-value',
1451
1455
  * });
1452
1456
  * console.log(res.data);
@@ -1539,7 +1543,7 @@ export declare namespace vault_v1 {
1539
1543
  removePermissions(params: Params$Resource$Matters$Removepermissions, callback: BodyResponseCallback<Schema$Empty>): void;
1540
1544
  removePermissions(callback: BodyResponseCallback<Schema$Empty>): void;
1541
1545
  /**
1542
- * Reopens the specified matter. Returns matter with updated state.
1546
+ * Reopens the specified matter. Returns the matter with updated state.
1543
1547
  * @example
1544
1548
  * ```js
1545
1549
  * // Before running the sample:
@@ -1601,7 +1605,7 @@ export declare namespace vault_v1 {
1601
1605
  reopen(params: Params$Resource$Matters$Reopen, callback: BodyResponseCallback<Schema$ReopenMatterResponse>): void;
1602
1606
  reopen(callback: BodyResponseCallback<Schema$ReopenMatterResponse>): void;
1603
1607
  /**
1604
- * Undeletes the specified matter. Returns matter with updated state.
1608
+ * Undeletes the specified matter. Returns the matter with updated state.
1605
1609
  * @example
1606
1610
  * ```js
1607
1611
  * // Before running the sample:
@@ -1787,7 +1791,7 @@ export declare namespace vault_v1 {
1787
1791
  */
1788
1792
  matterId?: string;
1789
1793
  /**
1790
- * Specifies which parts of the Matter to return in the response.
1794
+ * Specifies how much information about the matter to return in the response.
1791
1795
  */
1792
1796
  view?: string;
1793
1797
  }
@@ -1801,11 +1805,11 @@ export declare namespace vault_v1 {
1801
1805
  */
1802
1806
  pageToken?: string;
1803
1807
  /**
1804
- * If set, list only matters with that specific state. The default is listing matters of all states.
1808
+ * If set, lists only matters with the specified state. The default lists matters of all states.
1805
1809
  */
1806
1810
  state?: string;
1807
1811
  /**
1808
- * Specifies which parts of the matter to return in response.
1812
+ * Specifies how much information about the matter to return in response.
1809
1813
  */
1810
1814
  view?: string;
1811
1815
  }
@@ -1853,7 +1857,7 @@ export declare namespace vault_v1 {
1853
1857
  context: APIRequestContext;
1854
1858
  constructor(context: APIRequestContext);
1855
1859
  /**
1856
- * Creates an Export.
1860
+ * Creates an export.
1857
1861
  * @example
1858
1862
  * ```js
1859
1863
  * // Before running the sample:
@@ -1935,7 +1939,7 @@ export declare namespace vault_v1 {
1935
1939
  create(params: Params$Resource$Matters$Exports$Create, callback: BodyResponseCallback<Schema$Export>): void;
1936
1940
  create(callback: BodyResponseCallback<Schema$Export>): void;
1937
1941
  /**
1938
- * Deletes an Export.
1942
+ * Deletes an export.
1939
1943
  * @example
1940
1944
  * ```js
1941
1945
  * // Before running the sample:
@@ -1991,7 +1995,7 @@ export declare namespace vault_v1 {
1991
1995
  delete(params: Params$Resource$Matters$Exports$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
1992
1996
  delete(callback: BodyResponseCallback<Schema$Empty>): void;
1993
1997
  /**
1994
- * Gets an Export.
1998
+ * Gets an export.
1995
1999
  * @example
1996
2000
  * ```js
1997
2001
  * // Before running the sample:
@@ -2061,7 +2065,7 @@ export declare namespace vault_v1 {
2061
2065
  get(params: Params$Resource$Matters$Exports$Get, callback: BodyResponseCallback<Schema$Export>): void;
2062
2066
  get(callback: BodyResponseCallback<Schema$Export>): void;
2063
2067
  /**
2064
- * Lists Exports.
2068
+ * Lists details about the exports in the specified matter.
2065
2069
  * @example
2066
2070
  * ```js
2067
2071
  * // Before running the sample:
@@ -2174,7 +2178,7 @@ export declare namespace vault_v1 {
2174
2178
  accounts: Resource$Matters$Holds$Accounts;
2175
2179
  constructor(context: APIRequestContext);
2176
2180
  /**
2177
- * Adds HeldAccounts to a hold. Returns a list of accounts that have been successfully added. Accounts can only be added to an existing account-based hold.
2181
+ * 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.
2178
2182
  * @example
2179
2183
  * ```js
2180
2184
  * // Before running the sample:
@@ -2241,7 +2245,7 @@ export declare namespace vault_v1 {
2241
2245
  addHeldAccounts(params: Params$Resource$Matters$Holds$Addheldaccounts, callback: BodyResponseCallback<Schema$AddHeldAccountsResponse>): void;
2242
2246
  addHeldAccounts(callback: BodyResponseCallback<Schema$AddHeldAccountsResponse>): void;
2243
2247
  /**
2244
- * Creates a hold in the given matter.
2248
+ * Creates a hold in the specified matter.
2245
2249
  * @example
2246
2250
  * ```js
2247
2251
  * // Before running the sample:
@@ -2317,7 +2321,7 @@ export declare namespace vault_v1 {
2317
2321
  create(params: Params$Resource$Matters$Holds$Create, callback: BodyResponseCallback<Schema$Hold>): void;
2318
2322
  create(callback: BodyResponseCallback<Schema$Hold>): void;
2319
2323
  /**
2320
- * Removes a hold by ID. This will release any HeldAccounts on this Hold.
2324
+ * 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.
2321
2325
  * @example
2322
2326
  * ```js
2323
2327
  * // Before running the sample:
@@ -2373,7 +2377,7 @@ export declare namespace vault_v1 {
2373
2377
  delete(params: Params$Resource$Matters$Holds$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
2374
2378
  delete(callback: BodyResponseCallback<Schema$Empty>): void;
2375
2379
  /**
2376
- * Gets a hold by ID.
2380
+ * Gets the specified hold.
2377
2381
  * @example
2378
2382
  * ```js
2379
2383
  * // Before running the sample:
@@ -2406,7 +2410,7 @@ export declare namespace vault_v1 {
2406
2410
  * holdId: 'placeholder-value',
2407
2411
  * // The matter ID.
2408
2412
  * matterId: 'placeholder-value',
2409
- * // Specifies which parts of the Hold to return.
2413
+ * // The amount of detail to return for a hold.
2410
2414
  * view: 'placeholder-value',
2411
2415
  * });
2412
2416
  * console.log(res.data);
@@ -2442,7 +2446,7 @@ export declare namespace vault_v1 {
2442
2446
  get(params: Params$Resource$Matters$Holds$Get, callback: BodyResponseCallback<Schema$Hold>): void;
2443
2447
  get(callback: BodyResponseCallback<Schema$Hold>): void;
2444
2448
  /**
2445
- * Lists holds within a matter. An empty page token in ListHoldsResponse denotes no more holds to list.
2449
+ * Lists the holds in a matter.
2446
2450
  * @example
2447
2451
  * ```js
2448
2452
  * // Before running the sample:
@@ -2473,11 +2477,11 @@ export declare namespace vault_v1 {
2473
2477
  * const res = await vault.matters.holds.list({
2474
2478
  * // The matter ID.
2475
2479
  * matterId: 'placeholder-value',
2476
- * // 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.
2480
+ * // 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.
2477
2481
  * pageSize: 'placeholder-value',
2478
2482
  * // The pagination token as returned in the response. An empty token means start from the beginning.
2479
2483
  * pageToken: 'placeholder-value',
2480
- * // Specifies which parts of the Hold to return.
2484
+ * // The amount of detail to return for a hold.
2481
2485
  * view: 'placeholder-value',
2482
2486
  * });
2483
2487
  * console.log(res.data);
@@ -2508,7 +2512,7 @@ export declare namespace vault_v1 {
2508
2512
  list(params: Params$Resource$Matters$Holds$List, callback: BodyResponseCallback<Schema$ListHoldsResponse>): void;
2509
2513
  list(callback: BodyResponseCallback<Schema$ListHoldsResponse>): void;
2510
2514
  /**
2511
- * Removes HeldAccounts from a hold. Returns a list of statuses in the same order as the request. If this request leaves the hold with no held accounts, the hold will not apply to any accounts.
2515
+ * Removes the specified accounts from a hold. Returns a list of statuses in the same order as the request.
2512
2516
  * @example
2513
2517
  * ```js
2514
2518
  * // Before running the sample:
@@ -2574,7 +2578,7 @@ export declare namespace vault_v1 {
2574
2578
  removeHeldAccounts(params: Params$Resource$Matters$Holds$Removeheldaccounts, callback: BodyResponseCallback<Schema$RemoveHeldAccountsResponse>): void;
2575
2579
  removeHeldAccounts(callback: BodyResponseCallback<Schema$RemoveHeldAccountsResponse>): void;
2576
2580
  /**
2577
- * Updates the OU and/or query parameters of a hold. You cannot add accounts to a hold that covers an OU, nor can you add OUs to a hold that covers individual accounts. Accounts listed in the hold will be ignored.
2581
+ * 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.
2578
2582
  * @example
2579
2583
  * ```js
2580
2584
  * // Before running the sample:
@@ -2696,7 +2700,7 @@ export declare namespace vault_v1 {
2696
2700
  */
2697
2701
  matterId?: string;
2698
2702
  /**
2699
- * Specifies which parts of the Hold to return.
2703
+ * The amount of detail to return for a hold.
2700
2704
  */
2701
2705
  view?: string;
2702
2706
  }
@@ -2706,7 +2710,7 @@ export declare namespace vault_v1 {
2706
2710
  */
2707
2711
  matterId?: string;
2708
2712
  /**
2709
- * 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.
2713
+ * 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.
2710
2714
  */
2711
2715
  pageSize?: number;
2712
2716
  /**
@@ -2714,7 +2718,7 @@ export declare namespace vault_v1 {
2714
2718
  */
2715
2719
  pageToken?: string;
2716
2720
  /**
2717
- * Specifies which parts of the Hold to return.
2721
+ * The amount of detail to return for a hold.
2718
2722
  */
2719
2723
  view?: string;
2720
2724
  }
@@ -2750,7 +2754,7 @@ export declare namespace vault_v1 {
2750
2754
  context: APIRequestContext;
2751
2755
  constructor(context: APIRequestContext);
2752
2756
  /**
2753
- * Adds a HeldAccount to a hold. Accounts can only be added to a hold that has no held_org_unit set. Attempting to add an account to an OU-based hold will result in an error.
2757
+ * 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.
2754
2758
  * @example
2755
2759
  * ```js
2756
2760
  * // Before running the sample:
@@ -2824,7 +2828,7 @@ export declare namespace vault_v1 {
2824
2828
  create(params: Params$Resource$Matters$Holds$Accounts$Create, callback: BodyResponseCallback<Schema$HeldAccount>): void;
2825
2829
  create(callback: BodyResponseCallback<Schema$HeldAccount>): void;
2826
2830
  /**
2827
- * Removes a HeldAccount from a hold. If this request leaves the hold with no held accounts, the hold will not apply to any accounts.
2831
+ * Removes an account from a hold.
2828
2832
  * @example
2829
2833
  * ```js
2830
2834
  * // Before running the sample:
@@ -2882,7 +2886,7 @@ export declare namespace vault_v1 {
2882
2886
  delete(params: Params$Resource$Matters$Holds$Accounts$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
2883
2887
  delete(callback: BodyResponseCallback<Schema$Empty>): void;
2884
2888
  /**
2885
- * Lists HeldAccounts for a hold. This will only list individually specified held accounts. If the hold is on an OU, then use Admin SDK to enumerate its members.
2889
+ * 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.
2886
2890
  * @example
2887
2891
  * ```js
2888
2892
  * // Before running the sample:
@@ -3011,7 +3015,7 @@ export declare namespace vault_v1 {
3011
3015
  *
3012
3016
  * // Do the magic
3013
3017
  * const res = await vault.matters.savedQueries.create({
3014
- * // The matter ID of the parent matter for which the saved query is to be created.
3018
+ * // The ID of the matter to create the saved query in.
3015
3019
  * matterId: 'placeholder-value',
3016
3020
  *
3017
3021
  * // Request body metadata
@@ -3057,7 +3061,7 @@ export declare namespace vault_v1 {
3057
3061
  create(params: Params$Resource$Matters$Savedqueries$Create, callback: BodyResponseCallback<Schema$SavedQuery>): void;
3058
3062
  create(callback: BodyResponseCallback<Schema$SavedQuery>): void;
3059
3063
  /**
3060
- * Deletes a saved query by Id.
3064
+ * Deletes the specified saved query.
3061
3065
  * @example
3062
3066
  * ```js
3063
3067
  * // Before running the sample:
@@ -3083,9 +3087,9 @@ export declare namespace vault_v1 {
3083
3087
  *
3084
3088
  * // Do the magic
3085
3089
  * const res = await vault.matters.savedQueries.delete({
3086
- * // The matter ID of the parent matter for which the saved query is to be deleted.
3090
+ * // The ID of the matter to delete the saved query from.
3087
3091
  * matterId: 'placeholder-value',
3088
- * // ID of the saved query to be deleted.
3092
+ * // ID of the saved query to delete.
3089
3093
  * savedQueryId: 'placeholder-value',
3090
3094
  * });
3091
3095
  * console.log(res.data);
@@ -3113,7 +3117,7 @@ export declare namespace vault_v1 {
3113
3117
  delete(params: Params$Resource$Matters$Savedqueries$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
3114
3118
  delete(callback: BodyResponseCallback<Schema$Empty>): void;
3115
3119
  /**
3116
- * Retrieves a saved query by Id.
3120
+ * Retrieves the specified saved query.
3117
3121
  * @example
3118
3122
  * ```js
3119
3123
  * // Before running the sample:
@@ -3142,9 +3146,9 @@ export declare namespace vault_v1 {
3142
3146
  *
3143
3147
  * // Do the magic
3144
3148
  * const res = await vault.matters.savedQueries.get({
3145
- * // The matter ID of the parent matter for which the saved query is to be retrieved.
3149
+ * // The ID of the matter to get the saved query from.
3146
3150
  * matterId: 'placeholder-value',
3147
- * // ID of the saved query to be retrieved.
3151
+ * // ID of the saved query to retrieve.
3148
3152
  * savedQueryId: 'placeholder-value',
3149
3153
  * });
3150
3154
  * console.log(res.data);
@@ -3178,7 +3182,7 @@ export declare namespace vault_v1 {
3178
3182
  get(params: Params$Resource$Matters$Savedqueries$Get, callback: BodyResponseCallback<Schema$SavedQuery>): void;
3179
3183
  get(callback: BodyResponseCallback<Schema$SavedQuery>): void;
3180
3184
  /**
3181
- * Lists saved queries within a matter. An empty page token in ListSavedQueriesResponse denotes no more saved queries to list.
3185
+ * Lists the saved queries in a matter.
3182
3186
  * @example
3183
3187
  * ```js
3184
3188
  * // Before running the sample:
@@ -3207,7 +3211,7 @@ export declare namespace vault_v1 {
3207
3211
  *
3208
3212
  * // Do the magic
3209
3213
  * const res = await vault.matters.savedQueries.list({
3210
- * // The matter ID of the parent matter for which the saved queries are to be retrieved.
3214
+ * // The ID of the matter to get the saved queries for.
3211
3215
  * matterId: 'placeholder-value',
3212
3216
  * // The maximum number of saved queries to return.
3213
3217
  * pageSize: 'placeholder-value',
@@ -3244,7 +3248,7 @@ export declare namespace vault_v1 {
3244
3248
  }
3245
3249
  export interface Params$Resource$Matters$Savedqueries$Create extends StandardParameters {
3246
3250
  /**
3247
- * The matter ID of the parent matter for which the saved query is to be created.
3251
+ * The ID of the matter to create the saved query in.
3248
3252
  */
3249
3253
  matterId?: string;
3250
3254
  /**
@@ -3254,27 +3258,27 @@ export declare namespace vault_v1 {
3254
3258
  }
3255
3259
  export interface Params$Resource$Matters$Savedqueries$Delete extends StandardParameters {
3256
3260
  /**
3257
- * The matter ID of the parent matter for which the saved query is to be deleted.
3261
+ * The ID of the matter to delete the saved query from.
3258
3262
  */
3259
3263
  matterId?: string;
3260
3264
  /**
3261
- * ID of the saved query to be deleted.
3265
+ * ID of the saved query to delete.
3262
3266
  */
3263
3267
  savedQueryId?: string;
3264
3268
  }
3265
3269
  export interface Params$Resource$Matters$Savedqueries$Get extends StandardParameters {
3266
3270
  /**
3267
- * The matter ID of the parent matter for which the saved query is to be retrieved.
3271
+ * The ID of the matter to get the saved query from.
3268
3272
  */
3269
3273
  matterId?: string;
3270
3274
  /**
3271
- * ID of the saved query to be retrieved.
3275
+ * ID of the saved query to retrieve.
3272
3276
  */
3273
3277
  savedQueryId?: string;
3274
3278
  }
3275
3279
  export interface Params$Resource$Matters$Savedqueries$List extends StandardParameters {
3276
3280
  /**
3277
- * The matter ID of the parent matter for which the saved queries are to be retrieved.
3281
+ * The ID of the matter to get the saved queries for.
3278
3282
  */
3279
3283
  matterId?: string;
3280
3284
  /**