GoogleApi.Vault.V1.Api.Matters (google_api_vault v0.25.0)

View Source

API calls for all endpoints tagged Matters.

Summary

Functions

vault_matters_add_permissions(connection, matter_id, optional_params \\ [], opts \\ [])

Adds an account as a matter collaborator.

vault_matters_close(connection, matter_id, optional_params \\ [], opts \\ [])

Closes the specified matter. Returns the matter with updated state.

vault_matters_count(connection, matter_id, optional_params \\ [], opts \\ [])

Counts the accounts processed by the specified query.

vault_matters_create(connection, optional_params \\ [], opts \\ [])

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.

vault_matters_delete(connection, matter_id, optional_params \\ [], opts \\ [])

Deletes the specified matter. Returns the matter with updated state.

vault_matters_exports_create(connection, matter_id, optional_params \\ [], opts \\ [])

Creates an export.

vault_matters_exports_delete(connection, matter_id, export_id, optional_params \\ [], opts \\ [])

Deletes an export.

vault_matters_exports_get(connection, matter_id, export_id, optional_params \\ [], opts \\ [])

Gets an export.

vault_matters_exports_list(connection, matter_id, optional_params \\ [], opts \\ [])

Lists details about the exports in the specified matter.

vault_matters_get(connection, matter_id, optional_params \\ [], opts \\ [])

Gets the specified matter.

vault_matters_holds_accounts_create(connection, matter_id, hold_id, optional_params \\ [], opts \\ [])

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.

vault_matters_holds_accounts_delete(connection, matter_id, hold_id, account_id, optional_params \\ [], opts \\ [])

Removes an account from a hold.

vault_matters_holds_accounts_list(connection, matter_id, hold_id, optional_params \\ [], opts \\ [])

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. to list the members of the organizational unit on hold.

vault_matters_holds_add_held_accounts(connection, matter_id, hold_id, optional_params \\ [], opts \\ [])

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.

vault_matters_holds_create(connection, matter_id, optional_params \\ [], opts \\ [])

Creates a hold in the specified matter.

vault_matters_holds_delete(connection, matter_id, hold_id, optional_params \\ [], opts \\ [])

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.

vault_matters_holds_get(connection, matter_id, hold_id, optional_params \\ [], opts \\ [])

Gets the specified hold.

vault_matters_holds_list(connection, matter_id, optional_params \\ [], opts \\ [])

Lists the holds in a matter.

vault_matters_holds_remove_held_accounts(connection, matter_id, hold_id, optional_params \\ [], opts \\ [])

Removes the specified accounts from a hold. Returns a list of statuses in the same order as the request.

vault_matters_holds_update(connection, matter_id, hold_id, optional_params \\ [], opts \\ [])

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.

vault_matters_list(connection, optional_params \\ [], opts \\ [])

Lists matters the requestor has access to.

vault_matters_remove_permissions(connection, matter_id, optional_params \\ [], opts \\ [])

Removes an account as a matter collaborator.

vault_matters_reopen(connection, matter_id, optional_params \\ [], opts \\ [])

Reopens the specified matter. Returns the matter with updated state.

vault_matters_saved_queries_create(connection, matter_id, optional_params \\ [], opts \\ [])

Creates a saved query.

vault_matters_saved_queries_delete(connection, matter_id, saved_query_id, optional_params \\ [], opts \\ [])

Deletes the specified saved query.

vault_matters_saved_queries_get(connection, matter_id, saved_query_id, optional_params \\ [], opts \\ [])

Retrieves the specified saved query.

vault_matters_saved_queries_list(connection, matter_id, optional_params \\ [], opts \\ [])

Lists the saved queries in a matter.

vault_matters_undelete(connection, matter_id, optional_params \\ [], opts \\ [])

Undeletes the specified matter. Returns the matter with updated state.

vault_matters_update(connection, matter_id, optional_params \\ [], opts \\ [])

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.

Functions

vault_matters_add_permissions(connection, matter_id, optional_params \\ [], opts \\ [])

@spec vault_matters_add_permissions(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Vault.V1.Model.MatterPermission.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Adds an account as a matter collaborator.

Parameters

  • connection (type: GoogleApi.Vault.V1.Connection.t) - Connection to server
  • matter_id (type: String.t) - The matter ID.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Vault.V1.Model.AddMatterPermissionsRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Vault.V1.Model.MatterPermission{}} on success
  • {:error, info} on failure

vault_matters_close(connection, matter_id, optional_params \\ [], opts \\ [])

@spec vault_matters_close(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Vault.V1.Model.CloseMatterResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Closes the specified matter. Returns the matter with updated state.

Parameters

  • connection (type: GoogleApi.Vault.V1.Connection.t) - Connection to server
  • matter_id (type: String.t) - The matter ID.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Vault.V1.Model.CloseMatterRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Vault.V1.Model.CloseMatterResponse{}} on success
  • {:error, info} on failure

vault_matters_count(connection, matter_id, optional_params \\ [], opts \\ [])

@spec vault_matters_count(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Vault.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Counts the accounts processed by the specified query.

Parameters

  • connection (type: GoogleApi.Vault.V1.Connection.t) - Connection to server
  • matter_id (type: String.t) - The matter ID.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Vault.V1.Model.CountArtifactsRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Vault.V1.Model.Operation{}} on success
  • {:error, info} on failure

vault_matters_create(connection, optional_params \\ [], opts \\ [])

@spec vault_matters_create(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.Vault.V1.Model.Matter.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Vault.V1.Connection.t) - Connection to server
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Vault.V1.Model.Matter.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Vault.V1.Model.Matter{}} on success
  • {:error, info} on failure

vault_matters_delete(connection, matter_id, optional_params \\ [], opts \\ [])

@spec vault_matters_delete(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Vault.V1.Model.Matter.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes the specified matter. Returns the matter with updated state.

Parameters

  • connection (type: GoogleApi.Vault.V1.Connection.t) - Connection to server
  • matter_id (type: String.t) - The matter ID
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Vault.V1.Model.Matter{}} on success
  • {:error, info} on failure

vault_matters_exports_create(connection, matter_id, optional_params \\ [], opts \\ [])

@spec vault_matters_exports_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Vault.V1.Model.Export.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates an export.

Parameters

  • connection (type: GoogleApi.Vault.V1.Connection.t) - Connection to server
  • matter_id (type: String.t) - The matter ID.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Vault.V1.Model.Export.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Vault.V1.Model.Export{}} on success
  • {:error, info} on failure

vault_matters_exports_delete(connection, matter_id, export_id, optional_params \\ [], opts \\ [])

@spec vault_matters_exports_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Vault.V1.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes an export.

Parameters

  • connection (type: GoogleApi.Vault.V1.Connection.t) - Connection to server
  • matter_id (type: String.t) - The matter ID.
  • export_id (type: String.t) - The export ID.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Vault.V1.Model.Empty{}} on success
  • {:error, info} on failure

vault_matters_exports_get(connection, matter_id, export_id, optional_params \\ [], opts \\ [])

@spec vault_matters_exports_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Vault.V1.Model.Export.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets an export.

Parameters

  • connection (type: GoogleApi.Vault.V1.Connection.t) - Connection to server
  • matter_id (type: String.t) - The matter ID.
  • export_id (type: String.t) - The export ID.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Vault.V1.Model.Export{}} on success
  • {:error, info} on failure

vault_matters_exports_list(connection, matter_id, optional_params \\ [], opts \\ [])

@spec vault_matters_exports_list(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Vault.V1.Model.ListExportsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists details about the exports in the specified matter.

Parameters

  • connection (type: GoogleApi.Vault.V1.Connection.t) - Connection to server
  • matter_id (type: String.t) - The matter ID.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: integer()) - The number of exports to return in the response.
    • :pageToken (type: String.t) - The pagination token as returned in the response.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Vault.V1.Model.ListExportsResponse{}} on success
  • {:error, info} on failure

vault_matters_get(connection, matter_id, optional_params \\ [], opts \\ [])

@spec vault_matters_get(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Vault.V1.Model.Matter.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets the specified matter.

Parameters

  • connection (type: GoogleApi.Vault.V1.Connection.t) - Connection to server
  • matter_id (type: String.t) - The matter ID.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :view (type: String.t) - Specifies how much information about the matter to return in the response.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Vault.V1.Model.Matter{}} on success
  • {:error, info} on failure

vault_matters_holds_accounts_create(connection, matter_id, hold_id, optional_params \\ [], opts \\ [])

@spec vault_matters_holds_accounts_create(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Vault.V1.Model.HeldAccount.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Vault.V1.Connection.t) - Connection to server
  • matter_id (type: String.t) - The matter ID.
  • hold_id (type: String.t) - The hold ID.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Vault.V1.Model.HeldAccount.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Vault.V1.Model.HeldAccount{}} on success
  • {:error, info} on failure

vault_matters_holds_accounts_delete(connection, matter_id, hold_id, account_id, optional_params \\ [], opts \\ [])

@spec vault_matters_holds_accounts_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Vault.V1.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Removes an account from a hold.

Parameters

  • connection (type: GoogleApi.Vault.V1.Connection.t) - Connection to server
  • matter_id (type: String.t) - The matter ID.
  • hold_id (type: String.t) - The hold ID.
  • account_id (type: String.t) - The ID of the account to remove from the hold.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Vault.V1.Model.Empty{}} on success
  • {:error, info} on failure

vault_matters_holds_accounts_list(connection, matter_id, hold_id, optional_params \\ [], opts \\ [])

@spec vault_matters_holds_accounts_list(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Vault.V1.Model.ListHeldAccountsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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. to list the members of the organizational unit on hold.

Parameters

  • connection (type: GoogleApi.Vault.V1.Connection.t) - Connection to server
  • matter_id (type: String.t) - The matter ID.
  • hold_id (type: String.t) - The hold ID.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Vault.V1.Model.ListHeldAccountsResponse{}} on success
  • {:error, info} on failure

vault_matters_holds_add_held_accounts(connection, matter_id, hold_id, optional_params \\ [], opts \\ [])

@spec vault_matters_holds_add_held_accounts(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Vault.V1.Model.AddHeldAccountsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Vault.V1.Connection.t) - Connection to server
  • matter_id (type: String.t) - The matter ID.
  • hold_id (type: String.t) - The hold ID.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Vault.V1.Model.AddHeldAccountsRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Vault.V1.Model.AddHeldAccountsResponse{}} on success
  • {:error, info} on failure

vault_matters_holds_create(connection, matter_id, optional_params \\ [], opts \\ [])

@spec vault_matters_holds_create(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Vault.V1.Model.Hold.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates a hold in the specified matter.

Parameters

  • connection (type: GoogleApi.Vault.V1.Connection.t) - Connection to server
  • matter_id (type: String.t) - The matter ID.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Vault.V1.Model.Hold.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Vault.V1.Model.Hold{}} on success
  • {:error, info} on failure

vault_matters_holds_delete(connection, matter_id, hold_id, optional_params \\ [], opts \\ [])

@spec vault_matters_holds_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Vault.V1.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Vault.V1.Connection.t) - Connection to server
  • matter_id (type: String.t) - The matter ID.
  • hold_id (type: String.t) - The hold ID.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Vault.V1.Model.Empty{}} on success
  • {:error, info} on failure

vault_matters_holds_get(connection, matter_id, hold_id, optional_params \\ [], opts \\ [])

@spec vault_matters_holds_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Vault.V1.Model.Hold.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets the specified hold.

Parameters

  • connection (type: GoogleApi.Vault.V1.Connection.t) - Connection to server
  • matter_id (type: String.t) - The matter ID.
  • hold_id (type: String.t) - The hold ID.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :view (type: String.t) - The amount of detail to return for a hold.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Vault.V1.Model.Hold{}} on success
  • {:error, info} on failure

vault_matters_holds_list(connection, matter_id, optional_params \\ [], opts \\ [])

@spec vault_matters_holds_list(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Vault.V1.Model.ListHoldsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists the holds in a matter.

Parameters

  • connection (type: GoogleApi.Vault.V1.Connection.t) - Connection to server
  • matter_id (type: String.t) - The matter ID.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: integer()) - 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.
    • :pageToken (type: String.t) - The pagination token as returned in the response. An empty token means start from the beginning.
    • :view (type: String.t) - The amount of detail to return for a hold.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Vault.V1.Model.ListHoldsResponse{}} on success
  • {:error, info} on failure

vault_matters_holds_remove_held_accounts(connection, matter_id, hold_id, optional_params \\ [], opts \\ [])

@spec vault_matters_holds_remove_held_accounts(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Vault.V1.Model.RemoveHeldAccountsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Removes the specified accounts from a hold. Returns a list of statuses in the same order as the request.

Parameters

  • connection (type: GoogleApi.Vault.V1.Connection.t) - Connection to server
  • matter_id (type: String.t) - The matter ID.
  • hold_id (type: String.t) - The hold ID.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Vault.V1.Model.RemoveHeldAccountsRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Vault.V1.Model.RemoveHeldAccountsResponse{}} on success
  • {:error, info} on failure

vault_matters_holds_update(connection, matter_id, hold_id, optional_params \\ [], opts \\ [])

@spec vault_matters_holds_update(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Vault.V1.Model.Hold.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Vault.V1.Connection.t) - Connection to server
  • matter_id (type: String.t) - The matter ID.
  • hold_id (type: String.t) - The ID of the hold.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Vault.V1.Model.Hold.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Vault.V1.Model.Hold{}} on success
  • {:error, info} on failure

vault_matters_list(connection, optional_params \\ [], opts \\ [])

@spec vault_matters_list(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.Vault.V1.Model.ListMattersResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists matters the requestor has access to.

Parameters

  • connection (type: GoogleApi.Vault.V1.Connection.t) - Connection to server
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: integer()) - The number of matters to return in the response. Default and maximum are 100.
    • :pageToken (type: String.t) - The pagination token as returned in the response.
    • :state (type: String.t) - If set, lists only matters with the specified state. The default lists matters of all states.
    • :view (type: String.t) - Specifies how much information about the matter to return in response.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Vault.V1.Model.ListMattersResponse{}} on success
  • {:error, info} on failure

vault_matters_remove_permissions(connection, matter_id, optional_params \\ [], opts \\ [])

@spec vault_matters_remove_permissions(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Vault.V1.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Removes an account as a matter collaborator.

Parameters

  • connection (type: GoogleApi.Vault.V1.Connection.t) - Connection to server
  • matter_id (type: String.t) - The matter ID.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Vault.V1.Model.RemoveMatterPermissionsRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Vault.V1.Model.Empty{}} on success
  • {:error, info} on failure

vault_matters_reopen(connection, matter_id, optional_params \\ [], opts \\ [])

@spec vault_matters_reopen(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Vault.V1.Model.ReopenMatterResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Reopens the specified matter. Returns the matter with updated state.

Parameters

  • connection (type: GoogleApi.Vault.V1.Connection.t) - Connection to server
  • matter_id (type: String.t) - The matter ID.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Vault.V1.Model.ReopenMatterRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Vault.V1.Model.ReopenMatterResponse{}} on success
  • {:error, info} on failure

vault_matters_saved_queries_create(connection, matter_id, optional_params \\ [], opts \\ [])

@spec vault_matters_saved_queries_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Vault.V1.Model.SavedQuery.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates a saved query.

Parameters

  • connection (type: GoogleApi.Vault.V1.Connection.t) - Connection to server
  • matter_id (type: String.t) - The ID of the matter to create the saved query in.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Vault.V1.Model.SavedQuery.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Vault.V1.Model.SavedQuery{}} on success
  • {:error, info} on failure

vault_matters_saved_queries_delete(connection, matter_id, saved_query_id, optional_params \\ [], opts \\ [])

@spec vault_matters_saved_queries_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Vault.V1.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes the specified saved query.

Parameters

  • connection (type: GoogleApi.Vault.V1.Connection.t) - Connection to server
  • matter_id (type: String.t) - The ID of the matter to delete the saved query from.
  • saved_query_id (type: String.t) - ID of the saved query to delete.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Vault.V1.Model.Empty{}} on success
  • {:error, info} on failure

vault_matters_saved_queries_get(connection, matter_id, saved_query_id, optional_params \\ [], opts \\ [])

@spec vault_matters_saved_queries_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Vault.V1.Model.SavedQuery.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves the specified saved query.

Parameters

  • connection (type: GoogleApi.Vault.V1.Connection.t) - Connection to server
  • matter_id (type: String.t) - The ID of the matter to get the saved query from.
  • saved_query_id (type: String.t) - ID of the saved query to retrieve.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Vault.V1.Model.SavedQuery{}} on success
  • {:error, info} on failure

vault_matters_saved_queries_list(connection, matter_id, optional_params \\ [], opts \\ [])

@spec vault_matters_saved_queries_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Vault.V1.Model.ListSavedQueriesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists the saved queries in a matter.

Parameters

  • connection (type: GoogleApi.Vault.V1.Connection.t) - Connection to server
  • matter_id (type: String.t) - The ID of the matter to get the saved queries for.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: integer()) - The maximum number of saved queries to return.
    • :pageToken (type: String.t) - The pagination token as returned in the previous response. An empty token means start from the beginning.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Vault.V1.Model.ListSavedQueriesResponse{}} on success
  • {:error, info} on failure

vault_matters_undelete(connection, matter_id, optional_params \\ [], opts \\ [])

@spec vault_matters_undelete(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Vault.V1.Model.Matter.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Undeletes the specified matter. Returns the matter with updated state.

Parameters

  • connection (type: GoogleApi.Vault.V1.Connection.t) - Connection to server
  • matter_id (type: String.t) - The matter ID.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Vault.V1.Model.UndeleteMatterRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Vault.V1.Model.Matter{}} on success
  • {:error, info} on failure

vault_matters_update(connection, matter_id, optional_params \\ [], opts \\ [])

@spec vault_matters_update(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Vault.V1.Model.Matter.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Vault.V1.Connection.t) - Connection to server
  • matter_id (type: String.t) - The matter ID.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Vault.V1.Model.Matter.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Vault.V1.Model.Matter{}} on success
  • {:error, info} on failure