@googleapis/vault 0.2.0 → 0.4.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
@@ -101,9 +101,9 @@ export namespace vault_v1 {
101
101
  }
102
102
 
103
103
  /**
104
- * G Suite Vault API
104
+ * Google Vault API
105
105
  *
106
- * Archiving and eDiscovery for G Suite.
106
+ * 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.
107
107
  *
108
108
  * @example
109
109
  * ```js
@@ -128,7 +128,7 @@ export namespace vault_v1 {
128
128
  }
129
129
 
130
130
  /**
131
- * Count number for each account.
131
+ * The results count for each account.
132
132
  */
133
133
  export interface Schema$AccountCount {
134
134
  /**
@@ -136,7 +136,7 @@ export namespace vault_v1 {
136
136
  */
137
137
  account?: Schema$UserInfo;
138
138
  /**
139
- * The number of artifacts found for this account.
139
+ * The number of results (messages or files) found for this account.
140
140
  */
141
141
  count?: string | null;
142
142
  }
@@ -154,7 +154,7 @@ export namespace vault_v1 {
154
154
  errorType?: string | null;
155
155
  }
156
156
  /**
157
- * Accounts to search
157
+ * The accounts to search
158
158
  */
159
159
  export interface Schema$AccountInfo {
160
160
  /**
@@ -163,15 +163,15 @@ export namespace vault_v1 {
163
163
  emails?: string[] | null;
164
164
  }
165
165
  /**
166
- * A status detailing the status of each account creation, and the HeldAccount, if successful.
166
+ * The status of each account creation, and the **HeldAccount**, if successful.
167
167
  */
168
168
  export interface Schema$AddHeldAccountResult {
169
169
  /**
170
- * If present, this account was successfully created.
170
+ * Returned when the account was successfully created.
171
171
  */
172
172
  account?: Schema$HeldAccount;
173
173
  /**
174
- * This represents the success status. If failed, check message.
174
+ * Reports the request status. If it failed, returns an error message.
175
175
  */
176
176
  status?: Schema$Status;
177
177
  }
@@ -180,11 +180,11 @@ export namespace vault_v1 {
180
180
  */
181
181
  export interface Schema$AddHeldAccountsRequest {
182
182
  /**
183
- * Account IDs to identify which accounts to add. Only account_ids or only emails should be specified, but not both.
183
+ * 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.
184
184
  */
185
185
  accountIds?: string[] | null;
186
186
  /**
187
- * Emails to identify which accounts to add. Only emails or only account_ids should be specified, but not both.
187
+ * A comma-separated list of the emails of the accounts to add to the hold. Specify either **emails** or **account_ids**, but not both.
188
188
  */
189
189
  emails?: string[] | null;
190
190
  }
@@ -198,19 +198,19 @@ export namespace vault_v1 {
198
198
  responses?: Schema$AddHeldAccountResult[];
199
199
  }
200
200
  /**
201
- * 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.
201
+ * 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.
202
202
  */
203
203
  export interface Schema$AddMatterPermissionsRequest {
204
204
  /**
205
- * Only relevant if send_emails is true. True to CC requestor in the email message. False to not CC requestor.
205
+ * Only relevant if **sendEmails** is **true**. To CC the requestor in the email message, set to **true**. To not CC requestor, set to **false**.
206
206
  */
207
207
  ccMe?: boolean | null;
208
208
  /**
209
- * The MatterPermission to add.
209
+ * The account and its role to add.
210
210
  */
211
211
  matterPermission?: Schema$MatterPermission;
212
212
  /**
213
- * True to send notification email to the added account. False to not send notification email.
213
+ * To send a notification email to the added account, set to **true**. To not send a notification email, set to **false**.
214
214
  */
215
215
  sendEmails?: boolean | null;
216
216
  }
@@ -227,16 +227,16 @@ export namespace vault_v1 {
227
227
  */
228
228
  export interface Schema$CloseMatterResponse {
229
229
  /**
230
- * The updated matter, with state CLOSED.
230
+ * The updated matter, with state **CLOSED**.
231
231
  */
232
232
  matter?: Schema$Matter;
233
233
  }
234
234
  /**
235
- * An export file on cloud storage
235
+ * The export file in Cloud Storage
236
236
  */
237
237
  export interface Schema$CloudStorageFile {
238
238
  /**
239
- * 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.
239
+ * 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.
240
240
  */
241
241
  bucketName?: string | null;
242
242
  /**
@@ -244,45 +244,45 @@ export namespace vault_v1 {
244
244
  */
245
245
  md5Hash?: string | null;
246
246
  /**
247
- * The cloud storage object name of this export file. Can be used in cloud storage JSON/XML API.
247
+ * 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).
248
248
  */
249
249
  objectName?: string | null;
250
250
  /**
251
- * The size of the export file.
251
+ * The export file size.
252
252
  */
253
253
  size?: string | null;
254
254
  }
255
255
  /**
256
- * Export sink for cloud storage files.
256
+ * Export sink for Cloud Storage files.
257
257
  */
258
258
  export interface Schema$CloudStorageSink {
259
259
  /**
260
- * Output only. The exported files on cloud storage.
260
+ * Output only. The exported files in Cloud Storage.
261
261
  */
262
262
  files?: Schema$CloudStorageFile[];
263
263
  }
264
264
  /**
265
- * Corpus specific queries.
265
+ * Service-specific options for holds.
266
266
  */
267
267
  export interface Schema$CorpusQuery {
268
268
  /**
269
- * Details pertaining to Drive holds. If set, corpus must be Drive.
269
+ * Service-specific options for Drive holds. If set, **CorpusType** must be **DRIVE**.
270
270
  */
271
271
  driveQuery?: Schema$HeldDriveQuery;
272
272
  /**
273
- * Details pertaining to Groups holds. If set, corpus must be Groups.
273
+ * Service-specific options for Groups holds. If set, **CorpusType** must be **GROUPS**.
274
274
  */
275
275
  groupsQuery?: Schema$HeldGroupsQuery;
276
276
  /**
277
- * Details pertaining to Hangouts Chat holds. If set, corpus must be Hangouts Chat.
277
+ * Service-specific options for Chat holds. If set, **CorpusType** must be **HANGOUTS_CHAT**.
278
278
  */
279
279
  hangoutsChatQuery?: Schema$HeldHangoutsChatQuery;
280
280
  /**
281
- * Details pertaining to mail holds. If set, corpus must be mail.
281
+ * Service-specific options for Gmail holds. If set, **CorpusType** must be **MAIL**.
282
282
  */
283
283
  mailQuery?: Schema$HeldMailQuery;
284
284
  /**
285
- * Details pertaining to Voice holds. If set, corpus must be Voice.
285
+ * Service-specific options for Voice holds. If set, **CorpusType** must be **VOICE**.
286
286
  */
287
287
  voiceQuery?: Schema$HeldVoiceQuery;
288
288
  }
@@ -316,7 +316,7 @@ export namespace vault_v1 {
316
316
  */
317
317
  query?: Schema$Query;
318
318
  /**
319
- * Specifies the granularity of the count result returned in response.
319
+ * Sets the granularity of the count results.
320
320
  */
321
321
  view?: string | null;
322
322
  }
@@ -325,33 +325,33 @@ export namespace vault_v1 {
325
325
  */
326
326
  export interface Schema$CountArtifactsResponse {
327
327
  /**
328
- * Count metrics of Groups.
328
+ * Count metrics for Groups.
329
329
  */
330
330
  groupsCountResult?: Schema$GroupsCountResult;
331
331
  /**
332
- * Count metrics of Mail.
332
+ * Count metrics for Gmail and classic Hangouts.
333
333
  */
334
334
  mailCountResult?: Schema$MailCountResult;
335
335
  /**
336
- * Total count of artifacts. For mail and groups, artifacts refers to messages.
336
+ * Total count of messages.
337
337
  */
338
338
  totalCount?: string | null;
339
339
  }
340
340
  /**
341
- * The options for Drive export.
341
+ * Options for Drive exports.
342
342
  */
343
343
  export interface Schema$DriveExportOptions {
344
344
  /**
345
- * Set to true to include access level information for users with indirect access to files.
345
+ * To include access level information for users with [indirect access](https://support.google.com/vault/answer/6099459#metadata) to files, set to **true**.
346
346
  */
347
347
  includeAccessInfo?: boolean | null;
348
348
  }
349
349
  /**
350
- * Drive search advanced options
350
+ * Additional options for Drive search
351
351
  */
352
352
  export interface Schema$DriveOptions {
353
353
  /**
354
- * Set to true to include shared drive.
354
+ * Set to **true** to include shared drives.
355
355
  */
356
356
  includeSharedDrives?: boolean | null;
357
357
  /**
@@ -359,7 +359,7 @@ export namespace vault_v1 {
359
359
  */
360
360
  includeTeamDrives?: boolean | null;
361
361
  /**
362
- * Search the versions of the Drive file as of the reference date. These timestamps are in GMT and rounded down to the given date.
362
+ * 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.
363
363
  */
364
364
  versionDate?: string | null;
365
365
  }
@@ -368,11 +368,11 @@ export namespace vault_v1 {
368
368
  */
369
369
  export interface Schema$Empty {}
370
370
  /**
371
- * An export
371
+ * 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.
372
372
  */
373
373
  export interface Schema$Export {
374
374
  /**
375
- * Output only. Export sink for cloud storage files.
375
+ * Output only. The sink for export files in Cloud Storage.
376
376
  */
377
377
  cloudStorageSink?: Schema$CloudStorageSink;
378
378
  /**
@@ -380,7 +380,7 @@ export namespace vault_v1 {
380
380
  */
381
381
  createTime?: string | null;
382
382
  /**
383
- * Advanced options of the export.
383
+ * Additional export options.
384
384
  */
385
385
  exportOptions?: Schema$ExportOptions;
386
386
  /**
@@ -396,7 +396,7 @@ export namespace vault_v1 {
396
396
  */
397
397
  name?: string | null;
398
398
  /**
399
- * The search query being exported.
399
+ * The query parameters used to create the export.
400
400
  */
401
401
  query?: Schema$Query;
402
402
  /**
@@ -404,49 +404,49 @@ export namespace vault_v1 {
404
404
  */
405
405
  requester?: Schema$UserInfo;
406
406
  /**
407
- * Output only. Export statistics.
407
+ * Output only. Details about the export progress and size.
408
408
  */
409
409
  stats?: Schema$ExportStats;
410
410
  /**
411
- * Output only. The export status.
411
+ * Output only. The status of the export.
412
412
  */
413
413
  status?: string | null;
414
414
  }
415
415
  /**
416
- * Export advanced options
416
+ * Additional options for exports
417
417
  */
418
418
  export interface Schema$ExportOptions {
419
419
  /**
420
- * Option available for Drive export.
420
+ * Options for Drive exports.
421
421
  */
422
422
  driveOptions?: Schema$DriveExportOptions;
423
423
  /**
424
- * Option available for groups export.
424
+ * Options for Groups exports.
425
425
  */
426
426
  groupsOptions?: Schema$GroupsExportOptions;
427
427
  /**
428
- * Option available for hangouts chat export.
428
+ * Options for Chat exports.
429
429
  */
430
430
  hangoutsChatOptions?: Schema$HangoutsChatExportOptions;
431
431
  /**
432
- * Option available for mail export.
432
+ * Options for Gmail exports.
433
433
  */
434
434
  mailOptions?: Schema$MailExportOptions;
435
435
  /**
436
- * The requested export location.
436
+ * The requested data region for the export.
437
437
  */
438
438
  region?: string | null;
439
439
  /**
440
- * Option available for voice export.
440
+ * Options for Voice exports.
441
441
  */
442
442
  voiceOptions?: Schema$VoiceExportOptions;
443
443
  }
444
444
  /**
445
- * Stats of an export.
445
+ * Progress information for an export.
446
446
  */
447
447
  export interface Schema$ExportStats {
448
448
  /**
449
- * The number of documents already processed by the export.
449
+ * The number of messages or files already processed for export.
450
450
  */
451
451
  exportedArtifactCount?: string | null;
452
452
  /**
@@ -454,7 +454,7 @@ export namespace vault_v1 {
454
454
  */
455
455
  sizeInBytes?: string | null;
456
456
  /**
457
- * The number of documents to be exported.
457
+ * The number of messages or files to be exported.
458
458
  */
459
459
  totalArtifactCount?: string | null;
460
460
  }
@@ -475,7 +475,7 @@ export namespace vault_v1 {
475
475
  */
476
476
  matchingAccountsCount?: string | null;
477
477
  /**
478
- * 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.
478
+ * 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.
479
479
  */
480
480
  nonQueryableAccounts?: string[] | null;
481
481
  /**
@@ -484,51 +484,51 @@ export namespace vault_v1 {
484
484
  queriedAccountsCount?: string | null;
485
485
  }
486
486
  /**
487
- * The options for groups export.
487
+ * Options for Groups exports.
488
488
  */
489
489
  export interface Schema$GroupsExportOptions {
490
490
  /**
491
- * The export format for groups export.
491
+ * The file format for exported messages.
492
492
  */
493
493
  exportFormat?: string | null;
494
494
  }
495
495
  /**
496
- * The options for hangouts chat export.
496
+ * Options for Chat exports.
497
497
  */
498
498
  export interface Schema$HangoutsChatExportOptions {
499
499
  /**
500
- * The export format for hangouts chat export.
500
+ * The file format for exported messages.
501
501
  */
502
502
  exportFormat?: string | null;
503
503
  }
504
504
  /**
505
- * Accounts to search
505
+ * The Chat spaces to search
506
506
  */
507
507
  export interface Schema$HangoutsChatInfo {
508
508
  /**
509
- * A set of rooms to search.
509
+ * A list of Chat spaces IDs, as provided by the [Chat API](https://developers.google.com/hangouts/chat).
510
510
  */
511
511
  roomId?: string[] | null;
512
512
  }
513
513
  /**
514
- * Hangouts chat search advanced options
514
+ * Additional options for Google Chat search
515
515
  */
516
516
  export interface Schema$HangoutsChatOptions {
517
517
  /**
518
- * Set to true to include rooms.
518
+ * For searches by account or organizational unit, set to **true** to include rooms.
519
519
  */
520
520
  includeRooms?: boolean | null;
521
521
  }
522
522
  /**
523
- * 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.
523
+ * 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.
524
524
  */
525
525
  export interface Schema$HeldAccount {
526
526
  /**
527
- * The account's ID as provided by the Admin SDK.
527
+ * The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).
528
528
  */
529
529
  accountId?: string | null;
530
530
  /**
531
- * The primary email address of the account. If used as an input, this takes precedence over account ID.
531
+ * The primary email address of the account. If used as an input, this takes precedence over **accountId**.
532
532
  */
533
533
  email?: string | null;
534
534
  /**
@@ -545,15 +545,15 @@ export namespace vault_v1 {
545
545
  lastName?: string | null;
546
546
  }
547
547
  /**
548
- * Query options for Drive holds.
548
+ * Options for Drive holds.
549
549
  */
550
550
  export interface Schema$HeldDriveQuery {
551
551
  /**
552
- * If true, include files in shared drives in the hold.
552
+ * To include files in shared drives in the hold, set to **true**.
553
553
  */
554
554
  includeSharedDriveFiles?: boolean | null;
555
555
  /**
556
- * If true, include files in Team Drives in the hold.
556
+ * To include files in Team Drives in the hold, set to **true**.
557
557
  */
558
558
  includeTeamDriveFiles?: boolean | null;
559
559
  }
@@ -562,76 +562,76 @@ export namespace vault_v1 {
562
562
  */
563
563
  export interface Schema$HeldGroupsQuery {
564
564
  /**
565
- * The end time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
565
+ * The end time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.
566
566
  */
567
567
  endTime?: string | null;
568
568
  /**
569
- * The start time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
569
+ * The start time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.
570
570
  */
571
571
  startTime?: string | null;
572
572
  /**
573
- * The search terms for the hold.
573
+ * The [search operators](https://support.google.com/vault/answer/2474474) used to refine the messages covered by the hold.
574
574
  */
575
575
  terms?: string | null;
576
576
  }
577
577
  /**
578
- * Query options for hangouts chat holds.
578
+ * Options for Chat holds.
579
579
  */
580
580
  export interface Schema$HeldHangoutsChatQuery {
581
581
  /**
582
- * If true, include rooms the user has participated in.
582
+ * To include messages in Chat spaces the user was a member of, set to **true**.
583
583
  */
584
584
  includeRooms?: boolean | null;
585
585
  }
586
586
  /**
587
- * Query options for mail holds.
587
+ * Query options for Gmail holds.
588
588
  */
589
589
  export interface Schema$HeldMailQuery {
590
590
  /**
591
- * The end time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
591
+ * The end time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.
592
592
  */
593
593
  endTime?: string | null;
594
594
  /**
595
- * The start time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
595
+ * The start time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.
596
596
  */
597
597
  startTime?: string | null;
598
598
  /**
599
- * The search terms for the hold.
599
+ * The [search operators](https://support.google.com/vault/answer/2474474) used to refine the messages covered by the hold.
600
600
  */
601
601
  terms?: string | null;
602
602
  }
603
603
  /**
604
- * A organizational unit being held in a particular hold. This structure is immutable.
604
+ * The organizational unit covered by a hold. This structure is immutable.
605
605
  */
606
606
  export interface Schema$HeldOrgUnit {
607
607
  /**
608
- * When the org unit was put on hold. This property is immutable.
608
+ * When the organizational unit was put on hold. This property is immutable.
609
609
  */
610
610
  holdTime?: string | null;
611
611
  /**
612
- * The org unit's immutable ID as provided by the Admin SDK.
612
+ * The organizational unit's immutable ID as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).
613
613
  */
614
614
  orgUnitId?: string | null;
615
615
  }
616
616
  /**
617
- * Query options for Voice holds.
617
+ * Options for Voice holds.
618
618
  */
619
619
  export interface Schema$HeldVoiceQuery {
620
620
  /**
621
- * Data covered by this rule. Should be non-empty. Order does not matter and duplicates will be ignored.
621
+ * A list of data types covered by the hold. Should be non-empty. Order does not matter and duplicates are ignored.
622
622
  */
623
623
  coveredData?: string[] | null;
624
624
  }
625
625
  /**
626
- * 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.
626
+ * 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.
627
627
  */
628
628
  export interface Schema$Hold {
629
629
  /**
630
- * If set, the hold applies to the enumerated accounts and org_unit must be empty.
630
+ * If set, the hold applies to the specified accounts and **orgUnit** must be empty.
631
631
  */
632
632
  accounts?: Schema$HeldAccount[];
633
633
  /**
634
- * The corpus to be searched.
634
+ * The service to be searched.
635
635
  */
636
636
  corpus?: string | null;
637
637
  /**
@@ -643,11 +643,11 @@ export namespace vault_v1 {
643
643
  */
644
644
  name?: string | null;
645
645
  /**
646
- * 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.
646
+ * 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**.
647
647
  */
648
648
  orgUnit?: Schema$HeldOrgUnit;
649
649
  /**
650
- * The corpus-specific query. If set, the corpusQuery must match corpus type.
650
+ * Service-specific options. If set, **CorpusQuery** must match **CorpusType**.
651
651
  */
652
652
  query?: Schema$CorpusQuery;
653
653
  /**
@@ -656,7 +656,7 @@ export namespace vault_v1 {
656
656
  updateTime?: string | null;
657
657
  }
658
658
  /**
659
- * The holds for a matter.
659
+ * The exports for a matter.
660
660
  */
661
661
  export interface Schema$ListExportsResponse {
662
662
  /**
@@ -669,7 +669,7 @@ export namespace vault_v1 {
669
669
  nextPageToken?: string | null;
670
670
  }
671
671
  /**
672
- * Returns a list of held accounts for a hold.
672
+ * Returns a list of the accounts covered by a hold.
673
673
  */
674
674
  export interface Schema$ListHeldAccountsResponse {
675
675
  /**
@@ -725,16 +725,16 @@ export namespace vault_v1 {
725
725
  */
726
726
  nextPageToken?: string | null;
727
727
  /**
728
- * List of output saved queries.
728
+ * List of saved queries.
729
729
  */
730
730
  savedQueries?: Schema$SavedQuery[];
731
731
  }
732
732
  /**
733
- * Mail specific count metrics.
733
+ * Gmail and classic Hangouts-specific count metrics.
734
734
  */
735
735
  export interface Schema$MailCountResult {
736
736
  /**
737
- * Error occurred when querying these accounts.
737
+ * Errors occurred when querying these accounts.
738
738
  */
739
739
  accountCountErrors?: Schema$AccountCountError[];
740
740
  /**
@@ -746,7 +746,7 @@ export namespace vault_v1 {
746
746
  */
747
747
  matchingAccountsCount?: string | null;
748
748
  /**
749
- * 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.
749
+ * 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.
750
750
  */
751
751
  nonQueryableAccounts?: string[] | null;
752
752
  /**
@@ -755,41 +755,45 @@ export namespace vault_v1 {
755
755
  queriedAccountsCount?: string | null;
756
756
  }
757
757
  /**
758
- * The options for mail export.
758
+ * Options for Gmail exports.
759
759
  */
760
760
  export interface Schema$MailExportOptions {
761
761
  /**
762
- * The export file format.
762
+ * The file format for exported messages.
763
763
  */
764
764
  exportFormat?: string | null;
765
765
  /**
766
- * Set to true to export confidential mode content.
766
+ * To export confidential mode content, set to **true**.
767
767
  */
768
768
  showConfidentialModeContent?: boolean | null;
769
+ /**
770
+ * To use the new export system, set to **true**.
771
+ */
772
+ useNewExport?: boolean | null;
769
773
  }
770
774
  /**
771
- * Mail search advanced options
775
+ * Additional options for Gmail search
772
776
  */
773
777
  export interface Schema$MailOptions {
774
778
  /**
775
- * Set to true to exclude drafts.
779
+ * Set to **true** to exclude drafts.
776
780
  */
777
781
  excludeDrafts?: boolean | null;
778
782
  }
779
783
  /**
780
- * Represents a matter.
784
+ * Represents a matter. 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.
781
785
  */
782
786
  export interface Schema$Matter {
783
787
  /**
784
- * The description of the matter.
788
+ * An optional description for the matter.
785
789
  */
786
790
  description?: string | null;
787
791
  /**
788
- * The matter ID which is generated by the server. Should be blank when creating a new matter.
792
+ * The matter ID, which is generated by the server. Leave blank when creating a matter.
789
793
  */
790
794
  matterId?: string | null;
791
795
  /**
792
- * List of users and access to the matter. Currently there is no programmer defined limit on the number of permissions a matter can have.
796
+ * 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.
793
797
  */
794
798
  matterPermissions?: Schema$MatterPermission[];
795
799
  /**
@@ -802,15 +806,15 @@ export namespace vault_v1 {
802
806
  state?: string | null;
803
807
  }
804
808
  /**
805
- * Currently each matter only has one owner, and all others are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist.
809
+ * 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.
806
810
  */
807
811
  export interface Schema$MatterPermission {
808
812
  /**
809
- * The account ID, as provided by Admin SDK.
813
+ * The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).
810
814
  */
811
815
  accountId?: string | null;
812
816
  /**
813
- * The user's role in this matter.
817
+ * The user's role for the matter.
814
818
  */
815
819
  role?: string | null;
816
820
  }
@@ -840,56 +844,56 @@ export namespace vault_v1 {
840
844
  response?: {[key: string]: any} | null;
841
845
  }
842
846
  /**
843
- * Org Unit to search
847
+ * The organizational unit to search
844
848
  */
845
849
  export interface Schema$OrgUnitInfo {
846
850
  /**
847
- * Org unit to search, as provided by the Admin SDK Directory API.
851
+ * The name of the organizational unit to search, as provided by the [Admin SDK Directory API](https://developers.google.com/admin-sdk/directory/).
848
852
  */
849
853
  orgUnitId?: string | null;
850
854
  }
851
855
  /**
852
- * A query definition relevant for search & export.
856
+ * The query definition used for search and export.
853
857
  */
854
858
  export interface Schema$Query {
855
859
  /**
856
- * When 'ACCOUNT' is chosen as search method, account_info needs to be specified.
860
+ * Required when **SearchMethod** is **ACCOUNT**.
857
861
  */
858
862
  accountInfo?: Schema$AccountInfo;
859
863
  /**
860
- * The corpus to search.
864
+ * The Google Workspace service to search.
861
865
  */
862
866
  corpus?: string | null;
863
867
  /**
864
- * The data source to search from.
868
+ * The data source to search.
865
869
  */
866
870
  dataScope?: string | null;
867
871
  /**
868
- * For Drive search, specify more options in this field.
872
+ * Set Drive search-specific options.
869
873
  */
870
874
  driveOptions?: Schema$DriveOptions;
871
875
  /**
872
- * The end time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
876
+ * The end time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date.
873
877
  */
874
878
  endTime?: string | null;
875
879
  /**
876
- * When 'ROOM' is chosen as search method, hangout_chats_info needs to be specified. (read-only)
880
+ * Required when **SearchMethod** is **ROOM**. (read-only)
877
881
  */
878
882
  hangoutsChatInfo?: Schema$HangoutsChatInfo;
879
883
  /**
880
- * For hangouts chat search, specify more options in this field. (read-only)
884
+ * Set Chat search-specific options. (read-only)
881
885
  */
882
886
  hangoutsChatOptions?: Schema$HangoutsChatOptions;
883
887
  /**
884
- * For mail search, specify more options in this field.
888
+ * Set Gmail search-specific options.
885
889
  */
886
890
  mailOptions?: Schema$MailOptions;
887
891
  /**
888
- * 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.
892
+ * 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**.
889
893
  */
890
894
  method?: string | null;
891
895
  /**
892
- * When 'ORG_UNIT' is chosen as as search method, org_unit_info needs to be specified.
896
+ * Required when **SearchMethod** is **ORG_UNIT**.
893
897
  */
894
898
  orgUnitInfo?: Schema$OrgUnitInfo;
895
899
  /**
@@ -897,27 +901,27 @@ export namespace vault_v1 {
897
901
  */
898
902
  searchMethod?: string | null;
899
903
  /**
900
- * When 'SHARED_DRIVE' is chosen as search method, shared_drive_info needs to be specified.
904
+ * Required when **SearchMethod** is **SHARED_DRIVE**.
901
905
  */
902
906
  sharedDriveInfo?: Schema$SharedDriveInfo;
903
907
  /**
904
- * The start time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
908
+ * The start time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date.
905
909
  */
906
910
  startTime?: string | null;
907
911
  /**
908
- * When 'TEAM_DRIVE' is chosen as search method, team_drive_info needs to be specified.
912
+ * Required when **SearchMethod** is **TEAM_DRIVE**.
909
913
  */
910
914
  teamDriveInfo?: Schema$TeamDriveInfo;
911
915
  /**
912
- * The corpus-specific search operators used to generate search results.
916
+ * Service-specific [search operators](https://support.google.com/vault/answer/2474474) to filter search results.
913
917
  */
914
918
  terms?: string | null;
915
919
  /**
916
- * The time zone name. It should be an IANA TZ name, such as "America/Los_Angeles". For more information, see Time Zone.
920
+ * 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).
917
921
  */
918
922
  timeZone?: string | null;
919
923
  /**
920
- * For voice search, specify more options in this field.
924
+ * Set Voice search-specific options.
921
925
  */
922
926
  voiceOptions?: Schema$VoiceOptions;
923
927
  }
@@ -926,7 +930,7 @@ export namespace vault_v1 {
926
930
  */
927
931
  export interface Schema$RemoveHeldAccountsRequest {
928
932
  /**
929
- * Account IDs to identify HeldAccounts to remove.
933
+ * The account IDs of the accounts to remove from the hold.
930
934
  */
931
935
  accountIds?: string[] | null;
932
936
  }
@@ -935,7 +939,7 @@ export namespace vault_v1 {
935
939
  */
936
940
  export interface Schema$RemoveHeldAccountsResponse {
937
941
  /**
938
- * A list of statuses for deleted accounts. Results have the same order as the request.
942
+ * A list of statuses for the deleted accounts. Results have the same order as the request.
939
943
  */
940
944
  statuses?: Schema$Status[];
941
945
  }
@@ -957,28 +961,28 @@ export namespace vault_v1 {
957
961
  */
958
962
  export interface Schema$ReopenMatterResponse {
959
963
  /**
960
- * The updated matter, with state OPEN.
964
+ * The updated matter, with state **OPEN**.
961
965
  */
962
966
  matter?: Schema$Matter;
963
967
  }
964
968
  /**
965
- * Definition of the saved query.
969
+ * 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.
966
970
  */
967
971
  export interface Schema$SavedQuery {
968
972
  /**
969
- * Output only. The server generated timestamp at which saved query was created.
973
+ * Output only. The server-generated timestamp when the saved query was created.
970
974
  */
971
975
  createTime?: string | null;
972
976
  /**
973
- * Name of the saved query.
977
+ * The name of the saved query.
974
978
  */
975
979
  displayName?: string | null;
976
980
  /**
977
- * 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.
981
+ * 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.
978
982
  */
979
983
  matterId?: string | null;
980
984
  /**
981
- * The underlying Query object which contains all the information of the saved query.
985
+ * The search parameters of the saved query.
982
986
  */
983
987
  query?: Schema$Query;
984
988
  /**
@@ -987,11 +991,11 @@ export namespace vault_v1 {
987
991
  savedQueryId?: string | null;
988
992
  }
989
993
  /**
990
- * Shared drives to search
994
+ * The shared drives to search
991
995
  */
992
996
  export interface Schema$SharedDriveInfo {
993
997
  /**
994
- * List of Shared drive IDs, as provided by Drive API.
998
+ * A list of shared drive IDs, as provided by the [Drive API](https://developers.google.com/drive).
995
999
  */
996
1000
  sharedDriveIds?: string[] | null;
997
1001
  }
@@ -1017,7 +1021,7 @@ export namespace vault_v1 {
1017
1021
  */
1018
1022
  export interface Schema$TeamDriveInfo {
1019
1023
  /**
1020
- * List of Team Drive IDs, as provided by Drive API.
1024
+ * List of Team Drive IDs, as provided by the [Drive API](https://developers.google.com/drive).
1021
1025
  */
1022
1026
  teamDriveIds?: string[] | null;
1023
1027
  }
@@ -1039,16 +1043,16 @@ export namespace vault_v1 {
1039
1043
  email?: string | null;
1040
1044
  }
1041
1045
  /**
1042
- * The options for voice export.
1046
+ * The options for Voice exports.
1043
1047
  */
1044
1048
  export interface Schema$VoiceExportOptions {
1045
1049
  /**
1046
- * The export format for voice export.
1050
+ * The file format for exported text messages.
1047
1051
  */
1048
1052
  exportFormat?: string | null;
1049
1053
  }
1050
1054
  /**
1051
- * Voice search options
1055
+ * Additional options for Voice search
1052
1056
  */
1053
1057
  export interface Schema$VoiceOptions {
1054
1058
  /**
@@ -1212,7 +1216,7 @@ export namespace vault_v1 {
1212
1216
  }
1213
1217
 
1214
1218
  /**
1215
- * Closes the specified matter. Returns matter with updated state.
1219
+ * Closes the specified matter. Returns the matter with updated state.
1216
1220
  * @example
1217
1221
  * ```js
1218
1222
  * // Before running the sample:
@@ -1349,7 +1353,7 @@ export namespace vault_v1 {
1349
1353
  }
1350
1354
 
1351
1355
  /**
1352
- * Counts the artifacts within the context of a matter and returns a detailed breakdown of metrics.
1356
+ * Counts the accounts processed by the specified query.
1353
1357
  * @example
1354
1358
  * ```js
1355
1359
  * // Before running the sample:
@@ -1490,7 +1494,7 @@ export namespace vault_v1 {
1490
1494
  }
1491
1495
 
1492
1496
  /**
1493
- * 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.
1497
+ * 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.
1494
1498
  * @example
1495
1499
  * ```js
1496
1500
  * // Before running the sample:
@@ -1628,7 +1632,7 @@ export namespace vault_v1 {
1628
1632
  }
1629
1633
 
1630
1634
  /**
1631
- * Deletes the specified matter. Returns matter with updated state.
1635
+ * Deletes the specified matter. Returns the matter with updated state.
1632
1636
  * @example
1633
1637
  * ```js
1634
1638
  * // Before running the sample:
@@ -1791,7 +1795,7 @@ export namespace vault_v1 {
1791
1795
  * const res = await vault.matters.get({
1792
1796
  * // The matter ID.
1793
1797
  * matterId: 'placeholder-value',
1794
- * // Specifies which parts of the Matter to return in the response.
1798
+ * // Specifies how much information about the matter to return in the response.
1795
1799
  * view: 'placeholder-value',
1796
1800
  * });
1797
1801
  * console.log(res.data);
@@ -1897,7 +1901,7 @@ export namespace vault_v1 {
1897
1901
  }
1898
1902
 
1899
1903
  /**
1900
- * Lists matters the user has access to.
1904
+ * Lists matters the requestor has access to.
1901
1905
  * @example
1902
1906
  * ```js
1903
1907
  * // Before running the sample:
@@ -1930,9 +1934,9 @@ export namespace vault_v1 {
1930
1934
  * pageSize: 'placeholder-value',
1931
1935
  * // The pagination token as returned in the response.
1932
1936
  * pageToken: 'placeholder-value',
1933
- * // If set, list only matters with that specific state. The default is listing matters of all states.
1937
+ * // If set, lists only matters with the specified state. The default lists matters of all states.
1934
1938
  * state: 'placeholder-value',
1935
- * // Specifies which parts of the matter to return in response.
1939
+ * // Specifies how much information about the matter to return in response.
1936
1940
  * view: 'placeholder-value',
1937
1941
  * });
1938
1942
  * console.log(res.data);
@@ -2170,7 +2174,7 @@ export namespace vault_v1 {
2170
2174
  }
2171
2175
 
2172
2176
  /**
2173
- * Reopens the specified matter. Returns matter with updated state.
2177
+ * Reopens the specified matter. Returns the matter with updated state.
2174
2178
  * @example
2175
2179
  * ```js
2176
2180
  * // Before running the sample:
@@ -2309,7 +2313,7 @@ export namespace vault_v1 {
2309
2313
  }
2310
2314
 
2311
2315
  /**
2312
- * Undeletes the specified matter. Returns matter with updated state.
2316
+ * Undeletes the specified matter. Returns the matter with updated state.
2313
2317
  * @example
2314
2318
  * ```js
2315
2319
  * // Before running the sample:
@@ -2643,7 +2647,7 @@ export namespace vault_v1 {
2643
2647
  */
2644
2648
  matterId?: string;
2645
2649
  /**
2646
- * Specifies which parts of the Matter to return in the response.
2650
+ * Specifies how much information about the matter to return in the response.
2647
2651
  */
2648
2652
  view?: string;
2649
2653
  }
@@ -2657,11 +2661,11 @@ export namespace vault_v1 {
2657
2661
  */
2658
2662
  pageToken?: string;
2659
2663
  /**
2660
- * If set, list only matters with that specific state. The default is listing matters of all states.
2664
+ * If set, lists only matters with the specified state. The default lists matters of all states.
2661
2665
  */
2662
2666
  state?: string;
2663
2667
  /**
2664
- * Specifies which parts of the matter to return in response.
2668
+ * Specifies how much information about the matter to return in response.
2665
2669
  */
2666
2670
  view?: string;
2667
2671
  }
@@ -2718,7 +2722,7 @@ export namespace vault_v1 {
2718
2722
  }
2719
2723
 
2720
2724
  /**
2721
- * Creates an Export.
2725
+ * Creates an export.
2722
2726
  * @example
2723
2727
  * ```js
2724
2728
  * // Before running the sample:
@@ -2873,7 +2877,7 @@ export namespace vault_v1 {
2873
2877
  }
2874
2878
 
2875
2879
  /**
2876
- * Deletes an Export.
2880
+ * Deletes an export.
2877
2881
  * @example
2878
2882
  * ```js
2879
2883
  * // Before running the sample:
@@ -3001,7 +3005,7 @@ export namespace vault_v1 {
3001
3005
  }
3002
3006
 
3003
3007
  /**
3004
- * Gets an Export.
3008
+ * Gets an export.
3005
3009
  * @example
3006
3010
  * ```js
3007
3011
  * // Before running the sample:
@@ -3143,7 +3147,7 @@ export namespace vault_v1 {
3143
3147
  }
3144
3148
 
3145
3149
  /**
3146
- * Lists Exports.
3150
+ * Lists details about the exports in the specified matter.
3147
3151
  * @example
3148
3152
  * ```js
3149
3153
  * // Before running the sample:
@@ -3342,7 +3346,7 @@ export namespace vault_v1 {
3342
3346
  }
3343
3347
 
3344
3348
  /**
3345
- * 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.
3349
+ * 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.
3346
3350
  * @example
3347
3351
  * ```js
3348
3352
  * // Before running the sample:
@@ -3488,7 +3492,7 @@ export namespace vault_v1 {
3488
3492
  }
3489
3493
 
3490
3494
  /**
3491
- * Creates a hold in the given matter.
3495
+ * Creates a hold in the specified matter.
3492
3496
  * @example
3493
3497
  * ```js
3494
3498
  * // Before running the sample:
@@ -3637,7 +3641,7 @@ export namespace vault_v1 {
3637
3641
  }
3638
3642
 
3639
3643
  /**
3640
- * Removes a hold by ID. This will release any HeldAccounts on this Hold.
3644
+ * 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.
3641
3645
  * @example
3642
3646
  * ```js
3643
3647
  * // Before running the sample:
@@ -3766,7 +3770,7 @@ export namespace vault_v1 {
3766
3770
  }
3767
3771
 
3768
3772
  /**
3769
- * Gets a hold by ID.
3773
+ * Gets the specified hold.
3770
3774
  * @example
3771
3775
  * ```js
3772
3776
  * // Before running the sample:
@@ -3799,7 +3803,7 @@ export namespace vault_v1 {
3799
3803
  * holdId: 'placeholder-value',
3800
3804
  * // The matter ID.
3801
3805
  * matterId: 'placeholder-value',
3802
- * // Specifies which parts of the Hold to return.
3806
+ * // The amount of detail to return for a hold.
3803
3807
  * view: 'placeholder-value',
3804
3808
  * });
3805
3809
  * console.log(res.data);
@@ -3908,7 +3912,7 @@ export namespace vault_v1 {
3908
3912
  }
3909
3913
 
3910
3914
  /**
3911
- * Lists holds within a matter. An empty page token in ListHoldsResponse denotes no more holds to list.
3915
+ * Lists the holds in a matter.
3912
3916
  * @example
3913
3917
  * ```js
3914
3918
  * // Before running the sample:
@@ -3939,11 +3943,11 @@ export namespace vault_v1 {
3939
3943
  * const res = await vault.matters.holds.list({
3940
3944
  * // The matter ID.
3941
3945
  * matterId: 'placeholder-value',
3942
- * // 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.
3946
+ * // 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.
3943
3947
  * pageSize: 'placeholder-value',
3944
3948
  * // The pagination token as returned in the response. An empty token means start from the beginning.
3945
3949
  * pageToken: 'placeholder-value',
3946
- * // Specifies which parts of the Hold to return.
3950
+ * // The amount of detail to return for a hold.
3947
3951
  * view: 'placeholder-value',
3948
3952
  * });
3949
3953
  * console.log(res.data);
@@ -4050,7 +4054,7 @@ export namespace vault_v1 {
4050
4054
  }
4051
4055
 
4052
4056
  /**
4053
- * 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.
4057
+ * Removes the specified accounts from a hold. Returns a list of statuses in the same order as the request.
4054
4058
  * @example
4055
4059
  * ```js
4056
4060
  * // Before running the sample:
@@ -4196,7 +4200,7 @@ export namespace vault_v1 {
4196
4200
  }
4197
4201
 
4198
4202
  /**
4199
- * 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.
4203
+ * 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.
4200
4204
  * @example
4201
4205
  * ```js
4202
4206
  * // Before running the sample:
@@ -4397,7 +4401,7 @@ export namespace vault_v1 {
4397
4401
  */
4398
4402
  matterId?: string;
4399
4403
  /**
4400
- * Specifies which parts of the Hold to return.
4404
+ * The amount of detail to return for a hold.
4401
4405
  */
4402
4406
  view?: string;
4403
4407
  }
@@ -4408,7 +4412,7 @@ export namespace vault_v1 {
4408
4412
  */
4409
4413
  matterId?: string;
4410
4414
  /**
4411
- * 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.
4415
+ * 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.
4412
4416
  */
4413
4417
  pageSize?: number;
4414
4418
  /**
@@ -4416,7 +4420,7 @@ export namespace vault_v1 {
4416
4420
  */
4417
4421
  pageToken?: string;
4418
4422
  /**
4419
- * Specifies which parts of the Hold to return.
4423
+ * The amount of detail to return for a hold.
4420
4424
  */
4421
4425
  view?: string;
4422
4426
  }
@@ -4460,7 +4464,7 @@ export namespace vault_v1 {
4460
4464
  }
4461
4465
 
4462
4466
  /**
4463
- * 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.
4467
+ * 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.
4464
4468
  * @example
4465
4469
  * ```js
4466
4470
  * // Before running the sample:
@@ -4606,7 +4610,7 @@ export namespace vault_v1 {
4606
4610
  }
4607
4611
 
4608
4612
  /**
4609
- * Removes a HeldAccount from a hold. If this request leaves the hold with no held accounts, the hold will not apply to any accounts.
4613
+ * Removes an account from a hold.
4610
4614
  * @example
4611
4615
  * ```js
4612
4616
  * // Before running the sample:
@@ -4737,7 +4741,7 @@ export namespace vault_v1 {
4737
4741
  }
4738
4742
 
4739
4743
  /**
4740
- * 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.
4744
+ * 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.
4741
4745
  * @example
4742
4746
  * ```js
4743
4747
  * // Before running the sample:
@@ -4951,7 +4955,7 @@ export namespace vault_v1 {
4951
4955
  *
4952
4956
  * // Do the magic
4953
4957
  * const res = await vault.matters.savedQueries.create({
4954
- * // The matter ID of the parent matter for which the saved query is to be created.
4958
+ * // The ID of the matter to create the saved query in.
4955
4959
  * matterId: 'placeholder-value',
4956
4960
  *
4957
4961
  * // Request body metadata
@@ -5070,7 +5074,7 @@ export namespace vault_v1 {
5070
5074
  }
5071
5075
 
5072
5076
  /**
5073
- * Deletes a saved query by Id.
5077
+ * Deletes the specified saved query.
5074
5078
  * @example
5075
5079
  * ```js
5076
5080
  * // Before running the sample:
@@ -5096,9 +5100,9 @@ export namespace vault_v1 {
5096
5100
  *
5097
5101
  * // Do the magic
5098
5102
  * const res = await vault.matters.savedQueries.delete({
5099
- * // The matter ID of the parent matter for which the saved query is to be deleted.
5103
+ * // The ID of the matter to delete the saved query from.
5100
5104
  * matterId: 'placeholder-value',
5101
- * // ID of the saved query to be deleted.
5105
+ * // ID of the saved query to delete.
5102
5106
  * savedQueryId: 'placeholder-value',
5103
5107
  * });
5104
5108
  * console.log(res.data);
@@ -5198,7 +5202,7 @@ export namespace vault_v1 {
5198
5202
  }
5199
5203
 
5200
5204
  /**
5201
- * Retrieves a saved query by Id.
5205
+ * Retrieves the specified saved query.
5202
5206
  * @example
5203
5207
  * ```js
5204
5208
  * // Before running the sample:
@@ -5227,9 +5231,9 @@ export namespace vault_v1 {
5227
5231
  *
5228
5232
  * // Do the magic
5229
5233
  * const res = await vault.matters.savedQueries.get({
5230
- * // The matter ID of the parent matter for which the saved query is to be retrieved.
5234
+ * // The ID of the matter to get the saved query from.
5231
5235
  * matterId: 'placeholder-value',
5232
- * // ID of the saved query to be retrieved.
5236
+ * // ID of the saved query to retrieve.
5233
5237
  * savedQueryId: 'placeholder-value',
5234
5238
  * });
5235
5239
  * console.log(res.data);
@@ -5335,7 +5339,7 @@ export namespace vault_v1 {
5335
5339
  }
5336
5340
 
5337
5341
  /**
5338
- * Lists saved queries within a matter. An empty page token in ListSavedQueriesResponse denotes no more saved queries to list.
5342
+ * Lists the saved queries in a matter.
5339
5343
  * @example
5340
5344
  * ```js
5341
5345
  * // Before running the sample:
@@ -5364,7 +5368,7 @@ export namespace vault_v1 {
5364
5368
  *
5365
5369
  * // Do the magic
5366
5370
  * const res = await vault.matters.savedQueries.list({
5367
- * // The matter ID of the parent matter for which the saved queries are to be retrieved.
5371
+ * // The ID of the matter to get the saved queries for.
5368
5372
  * matterId: 'placeholder-value',
5369
5373
  * // The maximum number of saved queries to return.
5370
5374
  * pageSize: 'placeholder-value',
@@ -5480,7 +5484,7 @@ export namespace vault_v1 {
5480
5484
  export interface Params$Resource$Matters$Savedqueries$Create
5481
5485
  extends StandardParameters {
5482
5486
  /**
5483
- * The matter ID of the parent matter for which the saved query is to be created.
5487
+ * The ID of the matter to create the saved query in.
5484
5488
  */
5485
5489
  matterId?: string;
5486
5490
 
@@ -5492,29 +5496,29 @@ export namespace vault_v1 {
5492
5496
  export interface Params$Resource$Matters$Savedqueries$Delete
5493
5497
  extends StandardParameters {
5494
5498
  /**
5495
- * The matter ID of the parent matter for which the saved query is to be deleted.
5499
+ * The ID of the matter to delete the saved query from.
5496
5500
  */
5497
5501
  matterId?: string;
5498
5502
  /**
5499
- * ID of the saved query to be deleted.
5503
+ * ID of the saved query to delete.
5500
5504
  */
5501
5505
  savedQueryId?: string;
5502
5506
  }
5503
5507
  export interface Params$Resource$Matters$Savedqueries$Get
5504
5508
  extends StandardParameters {
5505
5509
  /**
5506
- * The matter ID of the parent matter for which the saved query is to be retrieved.
5510
+ * The ID of the matter to get the saved query from.
5507
5511
  */
5508
5512
  matterId?: string;
5509
5513
  /**
5510
- * ID of the saved query to be retrieved.
5514
+ * ID of the saved query to retrieve.
5511
5515
  */
5512
5516
  savedQueryId?: string;
5513
5517
  }
5514
5518
  export interface Params$Resource$Matters$Savedqueries$List
5515
5519
  extends StandardParameters {
5516
5520
  /**
5517
- * The matter ID of the parent matter for which the saved queries are to be retrieved.
5521
+ * The ID of the matter to get the saved queries for.
5518
5522
  */
5519
5523
  matterId?: string;
5520
5524
  /**