/** * Copyright 2019 Google LLC * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ import { GaxiosPromise } from 'gaxios'; import { Compute, JWT, OAuth2Client, UserRefreshClient } from 'google-auth-library'; import { BodyResponseCallback, GlobalOptions, GoogleConfigurable, MethodOptions } from 'googleapis-common'; export declare namespace vault_v1 { interface Options extends GlobalOptions { version: 'v1'; } interface StandardParameters { /** * V1 error format. */ '$.xgafv'?: string; /** * OAuth access token. */ access_token?: string; /** * Data format for response. */ alt?: string; /** * JSONP */ callback?: string; /** * Selector specifying which fields to include in a partial response. */ fields?: string; /** * API key. Your API key identifies your project and provides you with API * access, quota, and reports. Required unless you provide an OAuth 2.0 * token. */ key?: string; /** * OAuth 2.0 token for the current user. */ oauth_token?: string; /** * Returns response with indentations and line breaks. */ prettyPrint?: boolean; /** * Available to use for quota purposes for server-side applications. Can be * any arbitrary string assigned to a user, but should not exceed 40 * characters. */ quotaUser?: string; /** * Legacy upload protocol for media (e.g. "media", "multipart"). */ uploadType?: string; /** * Upload protocol for media (e.g. "raw", "multipart"). */ upload_protocol?: string; } /** * G Suite Vault API * * Archiving and eDiscovery for G Suite. * * @example * const {google} = require('googleapis'); * const vault = google.vault('v1'); * * @namespace vault * @type {Function} * @version v1 * @variation v1 * @param {object=} options Options for Vault */ class Vault { matters: Resource$Matters; constructor(options: GlobalOptions, google?: GoogleConfigurable); } /** * Accounts to search */ interface Schema$AccountInfo { /** * A set of accounts to search. */ emails?: string[]; } /** * A status detailing the status of each account creation, and the * HeldAccount, if successful. */ interface Schema$AddHeldAccountResult { /** * If present, this account was successfully created. */ account?: Schema$HeldAccount; /** * This represents the success status. If failed, check message. */ status?: Schema$Status; } /** * Add a list of accounts to a hold. */ interface Schema$AddHeldAccountsRequest { /** * Account ids to identify which accounts to add. Only account_ids or only * emails should be specified, but not both. */ accountIds?: string[]; /** * Emails to identify which accounts to add. Only emails or only account_ids * should be specified, but not both. */ emails?: string[]; } /** * Response for batch create held accounts. */ interface Schema$AddHeldAccountsResponse { /** * The list of responses, in the same order as the batch request. */ responses?: Schema$AddHeldAccountResult[]; } /** * 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. */ interface Schema$AddMatterPermissionsRequest { /** * Only relevant if send_emails is true. True to CC requestor in the email * message. False to not CC requestor. */ ccMe?: boolean; /** * The MatterPermission to add. */ matterPermission?: Schema$MatterPermission; /** * True to send notification email to the added account. False to not send * notification email. */ sendEmails?: boolean; } /** * Close a matter by ID. */ interface Schema$CloseMatterRequest { } /** * Response to a CloseMatterRequest. */ interface Schema$CloseMatterResponse { /** * The updated matter, with state CLOSED. */ matter?: Schema$Matter; } /** * An export file on cloud storage */ interface Schema$CloudStorageFile { /** * The cloud storage bucket name of this export file. Can be used in cloud * storage JSON/XML API. */ bucketName?: string; /** * The md5 hash of the file. */ md5Hash?: string; /** * The cloud storage object name of this export file. Can be used in cloud * storage JSON/XML API. */ objectName?: string; /** * The size of the export file. */ size?: string; } /** * Export sink for cloud storage files. */ interface Schema$CloudStorageSink { /** * Output only. The exported files on cloud storage. */ files?: Schema$CloudStorageFile[]; } /** * Corpus specific queries. */ interface Schema$CorpusQuery { /** * Details pertaining to Drive holds. If set, corpus must be Drive. */ driveQuery?: Schema$HeldDriveQuery; /** * Details pertaining to Groups holds. If set, corpus must be Groups. */ groupsQuery?: Schema$HeldGroupsQuery; /** * Details pertaining to Hangouts Chat holds. If set, corpus must be * Hangouts Chat. */ hangoutsChatQuery?: Schema$HeldHangoutsChatQuery; /** * Details pertaining to mail holds. If set, corpus must be mail. */ mailQuery?: Schema$HeldMailQuery; } /** * The options for Drive export. */ interface Schema$DriveExportOptions { /** * Set to true to include access level information for users with <a * href="https://support.google.com/vault/answer/6099459#metadata">indirect * access</a> to files. */ includeAccessInfo?: boolean; } /** * Drive search advanced options */ interface Schema$DriveOptions { /** * Set to true to include Team Drive. */ includeTeamDrives?: boolean; /** * Search the versions of the Drive file as of the reference date. These * timestamps are in GMT and rounded down to the given date. */ versionDate?: string; } /** * A generic empty message that you can re-use to avoid defining duplicated * empty messages in your APIs. A typical example is to use it as the request * or the response type of an API method. For instance: service Foo { rpc * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON * representation for `Empty` is empty JSON object `{}`. */ interface Schema$Empty { } /** * An export */ interface Schema$Export { /** * Output only. Export sink for cloud storage files. */ cloudStorageSink?: Schema$CloudStorageSink; /** * Output only. The time when the export was created. */ createTime?: string; /** * Advanced options of the export. */ exportOptions?: Schema$ExportOptions; /** * Output only. The generated export ID. */ id?: string; /** * Output only. The matter ID. */ matterId?: string; /** * The export name. */ name?: string; /** * The search query being exported. */ query?: Schema$Query; /** * Output only. The requester of the export. */ requester?: Schema$UserInfo; /** * Output only. Export statistics. */ stats?: Schema$ExportStats; /** * Output only. The export status. */ status?: string; } /** * Export advanced options */ interface Schema$ExportOptions { /** * Option available for Drive export. */ driveOptions?: Schema$DriveExportOptions; /** * Option available for groups export. */ groupsOptions?: Schema$GroupsExportOptions; /** * Option available for hangouts chat export. */ hangoutsChatOptions?: Schema$HangoutsChatExportOptions; /** * Option available for mail export. */ mailOptions?: Schema$MailExportOptions; /** * The requested export location. */ region?: string; } /** * Stats of an export. */ interface Schema$ExportStats { /** * The number of documents already processed by the export. */ exportedArtifactCount?: string; /** * The size of export in bytes. */ sizeInBytes?: string; /** * The number of documents to be exported. */ totalArtifactCount?: string; } /** * The options for groups export. */ interface Schema$GroupsExportOptions { /** * The export format for groups export. */ exportFormat?: string; } /** * The options for hangouts chat export. */ interface Schema$HangoutsChatExportOptions { /** * The export format for hangouts chat export. */ exportFormat?: string; } /** * Accounts to search */ interface Schema$HangoutsChatInfo { /** * A set of rooms to search. */ roomId?: string[]; } /** * Hangouts chat search advanced options */ interface Schema$HangoutsChatOptions { /** * Set to true to include rooms. */ includeRooms?: boolean; } /** * 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. */ interface Schema$HeldAccount { /** * The account's ID as provided by the <a * href="https://developers.google.com/admin-sdk/">Admin * SDK</a>. */ accountId?: string; /** * When the account was put on hold. */ holdTime?: string; } /** * Query options for Drive holds. */ interface Schema$HeldDriveQuery { /** * If true, include files in Team Drives in the hold. */ includeTeamDriveFiles?: boolean; } /** * Query options for group holds. */ interface Schema$HeldGroupsQuery { /** * The end time range for the search query. These timestamps are in GMT and * rounded down to the start of the given date. */ endTime?: string; /** * The start time range for the search query. These timestamps are in GMT * and rounded down to the start of the given date. */ startTime?: string; /** * The search terms for the hold. */ terms?: string; } /** * Query options for hangouts chat holds. */ interface Schema$HeldHangoutsChatQuery { /** * If true, include rooms the user has participated in. */ includeRooms?: boolean; } /** * Query options for mail holds. */ interface Schema$HeldMailQuery { /** * The end time range for the search query. These timestamps are in GMT and * rounded down to the start of the given date. */ endTime?: string; /** * The start time range for the search query. These timestamps are in GMT * and rounded down to the start of the given date. */ startTime?: string; /** * The search terms for the hold. */ terms?: string; } /** * A organizational unit being held in a particular hold. This structure is * immutable. */ interface Schema$HeldOrgUnit { /** * When the org unit was put on hold. This property is immutable. */ holdTime?: string; /** * The org unit's immutable ID as provided by the Admin SDK. */ orgUnitId?: string; } /** * 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. */ interface Schema$Hold { /** * If set, the hold applies to the enumerated accounts and org_unit must be * empty. */ accounts?: Schema$HeldAccount[]; /** * The corpus to be searched. */ corpus?: string; /** * The unique immutable ID of the hold. Assigned during creation. */ holdId?: string; /** * The name of the hold. */ name?: string; /** * 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. */ orgUnit?: Schema$HeldOrgUnit; /** * The corpus-specific query. If set, the corpusQuery must match corpus * type. */ query?: Schema$CorpusQuery; /** * The last time this hold was modified. */ updateTime?: string; } /** * The holds for a matter. */ interface Schema$ListExportsResponse { /** * The list of exports. */ exports?: Schema$Export[]; /** * Page token to retrieve the next page of results in the list. */ nextPageToken?: string; } /** * Returns a list of held accounts for a hold. */ interface Schema$ListHeldAccountsResponse { /** * The held accounts on a hold. */ accounts?: Schema$HeldAccount[]; } /** * The holds for a matter. */ interface Schema$ListHoldsResponse { /** * The list of holds. */ holds?: Schema$Hold[]; /** * Page token to retrieve the next page of results in the list. If this is * empty, then there are no more holds to list. */ nextPageToken?: string; } /** * Provides the list of matters. */ interface Schema$ListMattersResponse { /** * List of matters. */ matters?: Schema$Matter[]; /** * Page token to retrieve the next page of results in the list. */ nextPageToken?: string; } /** * Definition of the response for method ListSaveQuery. */ interface Schema$ListSavedQueriesResponse { /** * Page token to retrieve the next page of results in the list. If this is * empty, then there are no more saved queries to list. */ nextPageToken?: string; /** * List of output saved queries. */ savedQueries?: Schema$SavedQuery[]; } /** * The options for mail export. */ interface Schema$MailExportOptions { /** * The export file format. */ exportFormat?: string; } /** * Mail search advanced options */ interface Schema$MailOptions { /** * Set to true to exclude drafts. */ excludeDrafts?: boolean; } /** * Represents a matter. */ interface Schema$Matter { /** * The description of the matter. */ description?: string; /** * The matter ID which is generated by the server. Should be blank when * creating a new matter. */ matterId?: string; /** * List of users and access to the matter. Currently there is no programmer * defined limit on the number of permissions a matter can have. */ matterPermissions?: Schema$MatterPermission[]; /** * The name of the matter. */ name?: string; /** * The state of the matter. */ state?: string; } /** * Currently each matter only has one owner, and all others are collaborators. * When an account is purged, its corresponding MatterPermission resources * cease to exist. */ interface Schema$MatterPermission { /** * The account id, as provided by <a * href="https://developers.google.com/admin-sdk/">Admin * SDK</a>. */ accountId?: string; /** * The user's role in this matter. */ role?: string; } /** * Org Unit to search */ interface Schema$OrgUnitInfo { /** * Org unit to search, as provided by the <a * href="https://developers.google.com/admin-sdk/directory/">Admin * SDK Directory API</a>. */ orgUnitId?: string; } /** * A query definition relevant for search & export. */ interface Schema$Query { /** * When 'ACCOUNT' is chosen as search method, account_info needs to * be specified. */ accountInfo?: Schema$AccountInfo; /** * The corpus to search. */ corpus?: string; /** * The data source to search from. */ dataScope?: string; /** * For Drive search, specify more options in this field. */ driveOptions?: Schema$DriveOptions; /** * The end time range for the search query. These timestamps are in GMT and * rounded down to the start of the given date. */ endTime?: string; /** * When 'ROOM' is chosen as search method, hangout_chats_info needs * to be specified. (read-only) */ hangoutsChatInfo?: Schema$HangoutsChatInfo; /** * For hangouts chat search, specify more options in this field. (read-only) */ hangoutsChatOptions?: Schema$HangoutsChatOptions; /** * For mail search, specify more options in this field. */ mailOptions?: Schema$MailOptions; /** * When 'ORG_UNIT' is chosen as as search method, org_unit_info * needs to be specified. */ orgUnitInfo?: Schema$OrgUnitInfo; /** * The search method to use. */ searchMethod?: string; /** * The start time range for the search query. These timestamps are in GMT * and rounded down to the start of the given date. */ startTime?: string; /** * When 'TEAM_DRIVE' is chosen as search method, team_drive_info * needs to be specified. */ teamDriveInfo?: Schema$TeamDriveInfo; /** * The corpus-specific <a * href="https://support.google.com/vault/answer/2474474">search * operators</a> used to generate search results. */ terms?: string; /** * The time zone name. It should be an IANA TZ name, such as * "America/Los_Angeles". For more information, see <a * href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones">Time * Zone</a>. */ timeZone?: string; } /** * Remove a list of accounts from a hold. */ interface Schema$RemoveHeldAccountsRequest { /** * Account ids to identify HeldAccounts to remove. */ accountIds?: string[]; } /** * Response for batch delete held accounts. */ interface Schema$RemoveHeldAccountsResponse { /** * A list of statuses for deleted accounts. Results have the same order as * the request. */ statuses?: Schema$Status[]; } /** * Remove an account as a matter collaborator. */ interface Schema$RemoveMatterPermissionsRequest { /** * The account ID. */ accountId?: string; } /** * Reopen a matter by ID. */ interface Schema$ReopenMatterRequest { } /** * Response to a ReopenMatterRequest. */ interface Schema$ReopenMatterResponse { /** * The updated matter, with state OPEN. */ matter?: Schema$Matter; } /** * Definition of the saved query. */ interface Schema$SavedQuery { /** * Output only. The server generated timestamp at which saved query was * created. */ createTime?: string; /** * Name of the saved query. */ displayName?: string; /** * 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. */ matterId?: string; /** * The underlying Query object which contains all the information of the * saved query. */ query?: Schema$Query; /** * A unique identifier for the saved query. */ savedQueryId?: string; } /** * The `Status` type defines a logical error model that is suitable for * different programming environments, including REST APIs and RPC APIs. It is * used by [gRPC](https://github.com/grpc). The error model is designed to be: * - Simple to use and understand for most users - Flexible enough to meet * unexpected needs # Overview The `Status` message contains three pieces of * data: error code, error message, and error details. The error code should * be an enum value of google.rpc.Code, but it may accept additional error * codes if needed. The error message should be a developer-facing English * message that helps developers *understand* and *resolve* the error. If a * localized user-facing error message is needed, put the localized message in * the error details or localize it in the client. The optional error details * may contain arbitrary information about the error. There is a predefined * set of error detail types in the package `google.rpc` that can be used for * common error conditions. # Language mapping The `Status` message is the * logical representation of the error model, but it is not necessarily the * actual wire format. When the `Status` message is exposed in different * client libraries and different wire protocols, it can be mapped * differently. For example, it will likely be mapped to some exceptions in * Java, but more likely mapped to some error codes in C. # Other uses The * error model and the `Status` message can be used in a variety of * environments, either with or without APIs, to provide a consistent * developer experience across different environments. Example uses of this * error model include: - Partial errors. If a service needs to return * partial errors to the client, it may embed the `Status` in the normal * response to indicate the partial errors. - Workflow errors. A typical * workflow has multiple steps. Each step may have a `Status` message for * error reporting. - Batch operations. If a client uses batch request and * batch response, the `Status` message should be used directly inside * batch response, one for each error sub-response. - Asynchronous * operations. If an API call embeds asynchronous operation results in its * response, the status of those operations should be represented directly * using the `Status` message. - Logging. If some API errors are stored in * logs, the message `Status` could be used directly after any stripping * needed for security/privacy reasons. */ interface Schema$Status { /** * The status code, which should be an enum value of google.rpc.Code. */ code?: number; /** * A list of messages that carry the error details. There is a common set * of message types for APIs to use. */ details?: Array<{ [key: string]: any; }>; /** * A developer-facing error message, which should be in English. Any * user-facing error message should be localized and sent in the * google.rpc.Status.details field, or localized by the client. */ message?: string; } /** * Team Drives to search */ interface Schema$TeamDriveInfo { /** * List of Team Drive ids, as provided by <a * href="https://developers.google.com/drive">Drive * API</a>. */ teamDriveIds?: string[]; } /** * Undelete a matter by ID. */ interface Schema$UndeleteMatterRequest { } /** * User's information. */ interface Schema$UserInfo { /** * The displayed name of the user. */ displayName?: string; /** * The email address of the user. */ email?: string; } class Resource$Matters { exports: Resource$Matters$Exports; holds: Resource$Matters$Holds; savedQueries: Resource$Matters$Savedqueries; constructor(); /** * vault.matters.addPermissions * @desc Adds an account as a matter collaborator. * @alias vault.matters.addPermissions * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.matterId The matter ID. * @param {().AddMatterPermissionsRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ addPermissions(params?: Params$Resource$Matters$Addpermissions, options?: MethodOptions): GaxiosPromise; addPermissions(params: Params$Resource$Matters$Addpermissions, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; addPermissions(params: Params$Resource$Matters$Addpermissions, callback: BodyResponseCallback): void; addPermissions(callback: BodyResponseCallback): void; /** * vault.matters.close * @desc Closes the specified matter. Returns matter with updated state. * @alias vault.matters.close * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.matterId The matter ID. * @param {().CloseMatterRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ close(params?: Params$Resource$Matters$Close, options?: MethodOptions): GaxiosPromise; close(params: Params$Resource$Matters$Close, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; close(params: Params$Resource$Matters$Close, callback: BodyResponseCallback): void; close(callback: BodyResponseCallback): void; /** * vault.matters.create * @desc 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. * @alias vault.matters.create * @memberOf! () * * @param {object} params Parameters for request * @param {().Matter} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ create(params?: Params$Resource$Matters$Create, options?: MethodOptions): GaxiosPromise; create(params: Params$Resource$Matters$Create, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; create(params: Params$Resource$Matters$Create, callback: BodyResponseCallback): void; create(callback: BodyResponseCallback): void; /** * vault.matters.delete * @desc Deletes the specified matter. Returns matter with updated state. * @alias vault.matters.delete * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.matterId The matter ID * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ delete(params?: Params$Resource$Matters$Delete, options?: MethodOptions): GaxiosPromise; delete(params: Params$Resource$Matters$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; delete(params: Params$Resource$Matters$Delete, callback: BodyResponseCallback): void; delete(callback: BodyResponseCallback): void; /** * vault.matters.get * @desc Gets the specified matter. * @alias vault.matters.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.matterId The matter ID. * @param {string=} params.view Specifies which parts of the Matter to return in the response. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: Params$Resource$Matters$Get, options?: MethodOptions): GaxiosPromise; get(params: Params$Resource$Matters$Get, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; get(params: Params$Resource$Matters$Get, callback: BodyResponseCallback): void; get(callback: BodyResponseCallback): void; /** * vault.matters.list * @desc Lists matters the user has access to. * @alias vault.matters.list * @memberOf! () * * @param {object} params Parameters for request * @param {integer=} params.pageSize The number of matters to return in the response. Default and maximum are 100. * @param {string=} params.pageToken The pagination token as returned in the response. * @param {string=} params.state If set, list only matters with that specific state. The default is listing matters of all states. * @param {string=} params.view Specifies which parts of the matter to return in response. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: Params$Resource$Matters$List, options?: MethodOptions): GaxiosPromise; list(params: Params$Resource$Matters$List, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; list(params: Params$Resource$Matters$List, callback: BodyResponseCallback): void; list(callback: BodyResponseCallback): void; /** * vault.matters.removePermissions * @desc Removes an account as a matter collaborator. * @alias vault.matters.removePermissions * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.matterId The matter ID. * @param {().RemoveMatterPermissionsRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ removePermissions(params?: Params$Resource$Matters$Removepermissions, options?: MethodOptions): GaxiosPromise; removePermissions(params: Params$Resource$Matters$Removepermissions, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; removePermissions(params: Params$Resource$Matters$Removepermissions, callback: BodyResponseCallback): void; removePermissions(callback: BodyResponseCallback): void; /** * vault.matters.reopen * @desc Reopens the specified matter. Returns matter with updated state. * @alias vault.matters.reopen * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.matterId The matter ID. * @param {().ReopenMatterRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ reopen(params?: Params$Resource$Matters$Reopen, options?: MethodOptions): GaxiosPromise; reopen(params: Params$Resource$Matters$Reopen, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; reopen(params: Params$Resource$Matters$Reopen, callback: BodyResponseCallback): void; reopen(callback: BodyResponseCallback): void; /** * vault.matters.undelete * @desc Undeletes the specified matter. Returns matter with updated state. * @alias vault.matters.undelete * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.matterId The matter ID. * @param {().UndeleteMatterRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ undelete(params?: Params$Resource$Matters$Undelete, options?: MethodOptions): GaxiosPromise; undelete(params: Params$Resource$Matters$Undelete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; undelete(params: Params$Resource$Matters$Undelete, callback: BodyResponseCallback): void; undelete(callback: BodyResponseCallback): void; /** * vault.matters.update * @desc Updates the specified matter. This updates only the name and * description of the matter, identified by matter id. Changes to any other * fields are ignored. Returns the default view of the matter. * @alias vault.matters.update * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.matterId The matter ID. * @param {().Matter} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ update(params?: Params$Resource$Matters$Update, options?: MethodOptions): GaxiosPromise; update(params: Params$Resource$Matters$Update, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; update(params: Params$Resource$Matters$Update, callback: BodyResponseCallback): void; update(callback: BodyResponseCallback): void; } interface Params$Resource$Matters$Addpermissions extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * The matter ID. */ matterId?: string; /** * Request body metadata */ requestBody?: Schema$AddMatterPermissionsRequest; } interface Params$Resource$Matters$Close extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * The matter ID. */ matterId?: string; /** * Request body metadata */ requestBody?: Schema$CloseMatterRequest; } interface Params$Resource$Matters$Create extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Request body metadata */ requestBody?: Schema$Matter; } interface Params$Resource$Matters$Delete extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * The matter ID */ matterId?: string; } interface Params$Resource$Matters$Get extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * The matter ID. */ matterId?: string; /** * Specifies which parts of the Matter to return in the response. */ view?: string; } interface Params$Resource$Matters$List extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * The number of matters to return in the response. Default and maximum are * 100. */ pageSize?: number; /** * The pagination token as returned in the response. */ pageToken?: string; /** * If set, list only matters with that specific state. The default is * listing matters of all states. */ state?: string; /** * Specifies which parts of the matter to return in response. */ view?: string; } interface Params$Resource$Matters$Removepermissions extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * The matter ID. */ matterId?: string; /** * Request body metadata */ requestBody?: Schema$RemoveMatterPermissionsRequest; } interface Params$Resource$Matters$Reopen extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * The matter ID. */ matterId?: string; /** * Request body metadata */ requestBody?: Schema$ReopenMatterRequest; } interface Params$Resource$Matters$Undelete extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * The matter ID. */ matterId?: string; /** * Request body metadata */ requestBody?: Schema$UndeleteMatterRequest; } interface Params$Resource$Matters$Update extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * The matter ID. */ matterId?: string; /** * Request body metadata */ requestBody?: Schema$Matter; } class Resource$Matters$Exports { constructor(); /** * vault.matters.exports.create * @desc Creates an Export. * @alias vault.matters.exports.create * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.matterId The matter ID. * @param {().Export} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ create(params?: Params$Resource$Matters$Exports$Create, options?: MethodOptions): GaxiosPromise; create(params: Params$Resource$Matters$Exports$Create, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; create(params: Params$Resource$Matters$Exports$Create, callback: BodyResponseCallback): void; create(callback: BodyResponseCallback): void; /** * vault.matters.exports.delete * @desc Deletes an Export. * @alias vault.matters.exports.delete * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.exportId The export ID. * @param {string} params.matterId The matter ID. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ delete(params?: Params$Resource$Matters$Exports$Delete, options?: MethodOptions): GaxiosPromise; delete(params: Params$Resource$Matters$Exports$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; delete(params: Params$Resource$Matters$Exports$Delete, callback: BodyResponseCallback): void; delete(callback: BodyResponseCallback): void; /** * vault.matters.exports.get * @desc Gets an Export. * @alias vault.matters.exports.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.exportId The export ID. * @param {string} params.matterId The matter ID. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: Params$Resource$Matters$Exports$Get, options?: MethodOptions): GaxiosPromise; get(params: Params$Resource$Matters$Exports$Get, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; get(params: Params$Resource$Matters$Exports$Get, callback: BodyResponseCallback): void; get(callback: BodyResponseCallback): void; /** * vault.matters.exports.list * @desc Lists Exports. * @alias vault.matters.exports.list * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.matterId The matter ID. * @param {integer=} params.pageSize The number of exports to return in the response. * @param {string=} params.pageToken The pagination token as returned in the response. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: Params$Resource$Matters$Exports$List, options?: MethodOptions): GaxiosPromise; list(params: Params$Resource$Matters$Exports$List, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; list(params: Params$Resource$Matters$Exports$List, callback: BodyResponseCallback): void; list(callback: BodyResponseCallback): void; } interface Params$Resource$Matters$Exports$Create extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * The matter ID. */ matterId?: string; /** * Request body metadata */ requestBody?: Schema$Export; } interface Params$Resource$Matters$Exports$Delete extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * The export ID. */ exportId?: string; /** * The matter ID. */ matterId?: string; } interface Params$Resource$Matters$Exports$Get extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * The export ID. */ exportId?: string; /** * The matter ID. */ matterId?: string; } interface Params$Resource$Matters$Exports$List extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * The matter ID. */ matterId?: string; /** * The number of exports to return in the response. */ pageSize?: number; /** * The pagination token as returned in the response. */ pageToken?: string; } class Resource$Matters$Holds { accounts: Resource$Matters$Holds$Accounts; constructor(); /** * vault.matters.holds.addHeldAccounts * @desc 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. * @alias vault.matters.holds.addHeldAccounts * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.holdId The hold ID. * @param {string} params.matterId The matter ID. * @param {().AddHeldAccountsRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ addHeldAccounts(params?: Params$Resource$Matters$Holds$Addheldaccounts, options?: MethodOptions): GaxiosPromise; addHeldAccounts(params: Params$Resource$Matters$Holds$Addheldaccounts, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; addHeldAccounts(params: Params$Resource$Matters$Holds$Addheldaccounts, callback: BodyResponseCallback): void; addHeldAccounts(callback: BodyResponseCallback): void; /** * vault.matters.holds.create * @desc Creates a hold in the given matter. * @alias vault.matters.holds.create * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.matterId The matter ID. * @param {().Hold} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ create(params?: Params$Resource$Matters$Holds$Create, options?: MethodOptions): GaxiosPromise; create(params: Params$Resource$Matters$Holds$Create, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; create(params: Params$Resource$Matters$Holds$Create, callback: BodyResponseCallback): void; create(callback: BodyResponseCallback): void; /** * vault.matters.holds.delete * @desc Removes a hold by ID. This will release any HeldAccounts on this * Hold. * @alias vault.matters.holds.delete * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.holdId The hold ID. * @param {string} params.matterId The matter ID. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ delete(params?: Params$Resource$Matters$Holds$Delete, options?: MethodOptions): GaxiosPromise; delete(params: Params$Resource$Matters$Holds$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; delete(params: Params$Resource$Matters$Holds$Delete, callback: BodyResponseCallback): void; delete(callback: BodyResponseCallback): void; /** * vault.matters.holds.get * @desc Gets a hold by ID. * @alias vault.matters.holds.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.holdId The hold ID. * @param {string} params.matterId The matter ID. * @param {string=} params.view Specifies which parts of the Hold to return. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: Params$Resource$Matters$Holds$Get, options?: MethodOptions): GaxiosPromise; get(params: Params$Resource$Matters$Holds$Get, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; get(params: Params$Resource$Matters$Holds$Get, callback: BodyResponseCallback): void; get(callback: BodyResponseCallback): void; /** * vault.matters.holds.list * @desc Lists holds within a matter. An empty page token in * ListHoldsResponse denotes no more holds to list. * @alias vault.matters.holds.list * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.matterId The matter ID. * @param {integer=} params.pageSize 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. * @param {string=} params.pageToken The pagination token as returned in the response. An empty token means start from the beginning. * @param {string=} params.view Specifies which parts of the Hold to return. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: Params$Resource$Matters$Holds$List, options?: MethodOptions): GaxiosPromise; list(params: Params$Resource$Matters$Holds$List, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; list(params: Params$Resource$Matters$Holds$List, callback: BodyResponseCallback): void; list(callback: BodyResponseCallback): void; /** * vault.matters.holds.removeHeldAccounts * @desc 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. * @alias vault.matters.holds.removeHeldAccounts * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.holdId The hold ID. * @param {string} params.matterId The matter ID. * @param {().RemoveHeldAccountsRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ removeHeldAccounts(params?: Params$Resource$Matters$Holds$Removeheldaccounts, options?: MethodOptions): GaxiosPromise; removeHeldAccounts(params: Params$Resource$Matters$Holds$Removeheldaccounts, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; removeHeldAccounts(params: Params$Resource$Matters$Holds$Removeheldaccounts, callback: BodyResponseCallback): void; removeHeldAccounts(callback: BodyResponseCallback): void; /** * vault.matters.holds.update * @desc 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. * @alias vault.matters.holds.update * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.holdId The ID of the hold. * @param {string} params.matterId The matter ID. * @param {().Hold} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ update(params?: Params$Resource$Matters$Holds$Update, options?: MethodOptions): GaxiosPromise; update(params: Params$Resource$Matters$Holds$Update, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; update(params: Params$Resource$Matters$Holds$Update, callback: BodyResponseCallback): void; update(callback: BodyResponseCallback): void; } interface Params$Resource$Matters$Holds$Addheldaccounts extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * The hold ID. */ holdId?: string; /** * The matter ID. */ matterId?: string; /** * Request body metadata */ requestBody?: Schema$AddHeldAccountsRequest; } interface Params$Resource$Matters$Holds$Create extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * The matter ID. */ matterId?: string; /** * Request body metadata */ requestBody?: Schema$Hold; } interface Params$Resource$Matters$Holds$Delete extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * The hold ID. */ holdId?: string; /** * The matter ID. */ matterId?: string; } interface Params$Resource$Matters$Holds$Get extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * The hold ID. */ holdId?: string; /** * The matter ID. */ matterId?: string; /** * Specifies which parts of the Hold to return. */ view?: string; } interface Params$Resource$Matters$Holds$List extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * The matter ID. */ matterId?: string; /** * 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. */ pageSize?: number; /** * The pagination token as returned in the response. An empty token means * start from the beginning. */ pageToken?: string; /** * Specifies which parts of the Hold to return. */ view?: string; } interface Params$Resource$Matters$Holds$Removeheldaccounts extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * The hold ID. */ holdId?: string; /** * The matter ID. */ matterId?: string; /** * Request body metadata */ requestBody?: Schema$RemoveHeldAccountsRequest; } interface Params$Resource$Matters$Holds$Update extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * The ID of the hold. */ holdId?: string; /** * The matter ID. */ matterId?: string; /** * Request body metadata */ requestBody?: Schema$Hold; } class Resource$Matters$Holds$Accounts { constructor(); /** * vault.matters.holds.accounts.create * @desc 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. * @alias vault.matters.holds.accounts.create * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.holdId The hold ID. * @param {string} params.matterId The matter ID. * @param {().HeldAccount} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ create(params?: Params$Resource$Matters$Holds$Accounts$Create, options?: MethodOptions): GaxiosPromise; create(params: Params$Resource$Matters$Holds$Accounts$Create, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; create(params: Params$Resource$Matters$Holds$Accounts$Create, callback: BodyResponseCallback): void; create(callback: BodyResponseCallback): void; /** * vault.matters.holds.accounts.delete * @desc Removes a HeldAccount from a hold. If this request leaves the hold * with no held accounts, the hold will not apply to any accounts. * @alias vault.matters.holds.accounts.delete * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accountId The ID of the account to remove from the hold. * @param {string} params.holdId The hold ID. * @param {string} params.matterId The matter ID. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ delete(params?: Params$Resource$Matters$Holds$Accounts$Delete, options?: MethodOptions): GaxiosPromise; delete(params: Params$Resource$Matters$Holds$Accounts$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; delete(params: Params$Resource$Matters$Holds$Accounts$Delete, callback: BodyResponseCallback): void; delete(callback: BodyResponseCallback): void; /** * vault.matters.holds.accounts.list * @desc 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. * @alias vault.matters.holds.accounts.list * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.holdId The hold ID. * @param {string} params.matterId The matter ID. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: Params$Resource$Matters$Holds$Accounts$List, options?: MethodOptions): GaxiosPromise; list(params: Params$Resource$Matters$Holds$Accounts$List, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; list(params: Params$Resource$Matters$Holds$Accounts$List, callback: BodyResponseCallback): void; list(callback: BodyResponseCallback): void; } interface Params$Resource$Matters$Holds$Accounts$Create extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * The hold ID. */ holdId?: string; /** * The matter ID. */ matterId?: string; /** * Request body metadata */ requestBody?: Schema$HeldAccount; } interface Params$Resource$Matters$Holds$Accounts$Delete extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * The ID of the account to remove from the hold. */ accountId?: string; /** * The hold ID. */ holdId?: string; /** * The matter ID. */ matterId?: string; } interface Params$Resource$Matters$Holds$Accounts$List extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * The hold ID. */ holdId?: string; /** * The matter ID. */ matterId?: string; } class Resource$Matters$Savedqueries { constructor(); /** * vault.matters.savedQueries.create * @desc Creates a saved query. * @alias vault.matters.savedQueries.create * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.matterId The matter id of the parent matter for which the saved query is to be created. * @param {().SavedQuery} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ create(params?: Params$Resource$Matters$Savedqueries$Create, options?: MethodOptions): GaxiosPromise; create(params: Params$Resource$Matters$Savedqueries$Create, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; create(params: Params$Resource$Matters$Savedqueries$Create, callback: BodyResponseCallback): void; create(callback: BodyResponseCallback): void; /** * vault.matters.savedQueries.delete * @desc Deletes a saved query by Id. * @alias vault.matters.savedQueries.delete * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.matterId The matter id of the parent matter for which the saved query is to be deleted. * @param {string} params.savedQueryId Id of the saved query to be deleted. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ delete(params?: Params$Resource$Matters$Savedqueries$Delete, options?: MethodOptions): GaxiosPromise; delete(params: Params$Resource$Matters$Savedqueries$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; delete(params: Params$Resource$Matters$Savedqueries$Delete, callback: BodyResponseCallback): void; delete(callback: BodyResponseCallback): void; /** * vault.matters.savedQueries.get * @desc Retrieves a saved query by Id. * @alias vault.matters.savedQueries.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.matterId The matter id of the parent matter for which the saved query is to be retrieved. * @param {string} params.savedQueryId Id of the saved query to be retrieved. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: Params$Resource$Matters$Savedqueries$Get, options?: MethodOptions): GaxiosPromise; get(params: Params$Resource$Matters$Savedqueries$Get, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; get(params: Params$Resource$Matters$Savedqueries$Get, callback: BodyResponseCallback): void; get(callback: BodyResponseCallback): void; /** * vault.matters.savedQueries.list * @desc Lists saved queries within a matter. An empty page token in * ListSavedQueriesResponse denotes no more saved queries to list. * @alias vault.matters.savedQueries.list * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.matterId The matter id of the parent matter for which the saved queries are to be retrieved. * @param {integer=} params.pageSize The maximum number of saved queries to return. * @param {string=} params.pageToken The pagination token as returned in the previous response. An empty token means start from the beginning. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: Params$Resource$Matters$Savedqueries$List, options?: MethodOptions): GaxiosPromise; list(params: Params$Resource$Matters$Savedqueries$List, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; list(params: Params$Resource$Matters$Savedqueries$List, callback: BodyResponseCallback): void; list(callback: BodyResponseCallback): void; } interface Params$Resource$Matters$Savedqueries$Create extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * The matter id of the parent matter for which the saved query is to be * created. */ matterId?: string; /** * Request body metadata */ requestBody?: Schema$SavedQuery; } interface Params$Resource$Matters$Savedqueries$Delete extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * The matter id of the parent matter for which the saved query is to be * deleted. */ matterId?: string; /** * Id of the saved query to be deleted. */ savedQueryId?: string; } interface Params$Resource$Matters$Savedqueries$Get extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * The matter id of the parent matter for which the saved query is to be * retrieved. */ matterId?: string; /** * Id of the saved query to be retrieved. */ savedQueryId?: string; } interface Params$Resource$Matters$Savedqueries$List extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * The matter id of the parent matter for which the saved queries are to be * retrieved. */ matterId?: string; /** * The maximum number of saved queries to return. */ pageSize?: number; /** * The pagination token as returned in the previous response. An empty token * means start from the beginning. */ pageToken?: string; } }