google_api_vault v0.5.0 GoogleApi.Vault.V1.Api.Matters View Source

API calls for all endpoints tagged Matters.

Link to this section Summary

Functions

Closes the specified matter. Returns matter with updated state.

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.

Deletes the specified matter. Returns matter with updated state.

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.

Removes a HeldAccount from a hold. If this request leaves the hold with no held accounts, the hold will not apply to any accounts.

Lists HeldAccounts for a hold. This will only list individually specified held accounts. If the hold is on an OU, then use <a href="https://developers.google.com/admin-sdk/">Admin SDK</a> to enumerate its members.

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.

Removes a hold by ID. This will release any HeldAccounts on this Hold.

Lists holds within a matter. An empty page token in ListHoldsResponse denotes no more holds to list.

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.

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.

Reopens the specified matter. Returns matter with updated state.

Lists saved queries within a matter. An empty page token in ListSavedQueriesResponse denotes no more saved queries to list.

Undeletes the specified matter. Returns matter with updated state.

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.

Link to this section Functions

Link to this function

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

Adds an account as a matter collaborator.

Parameters

  • connection (GoogleApi.Vault.V1.Connection): Connection to server
  • matter_id (String.t): The matter ID.
  • optional_params (KeywordList): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (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.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :body (AddMatterPermissionsRequest):

Returns

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

Link to this function

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

Closes the specified matter. Returns matter with updated state.

Parameters

  • connection (GoogleApi.Vault.V1.Connection): Connection to server
  • matter_id (String.t): The matter ID.
  • optional_params (KeywordList): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (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.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :body (CloseMatterRequest):

Returns

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

Link to this function

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

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.

Parameters

  • connection (GoogleApi.Vault.V1.Connection): Connection to server
  • optional_params (KeywordList): [optional] Optional parameters

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

Returns

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

Link to this function

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

Deletes the specified matter. Returns matter with updated state.

Parameters

  • connection (GoogleApi.Vault.V1.Connection): Connection to server
  • matter_id (String.t): The matter ID
  • optional_params (KeywordList): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (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.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").

Returns

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

Link to this function

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

Creates an Export.

Parameters

  • connection (GoogleApi.Vault.V1.Connection): Connection to server
  • matter_id (String.t): The matter ID.
  • optional_params (KeywordList): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (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.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :body (Export):

Returns

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

Link to this function

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

Deletes an Export.

Parameters

  • connection (GoogleApi.Vault.V1.Connection): Connection to server
  • matter_id (String.t): The matter ID.
  • export_id (String.t): The export ID.
  • optional_params (KeywordList): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (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.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").

Returns

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

Link to this function

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

Gets an Export.

Parameters

  • connection (GoogleApi.Vault.V1.Connection): Connection to server
  • matter_id (String.t): The matter ID.
  • export_id (String.t): The export ID.
  • optional_params (KeywordList): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (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.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").

Returns

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

Link to this function

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

Lists Exports.

Parameters

  • connection (GoogleApi.Vault.V1.Connection): Connection to server
  • matter_id (String.t): The matter ID.
  • optional_params (KeywordList): [optional] Optional parameters

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

Returns

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

Link to this function

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

Gets the specified matter.

Parameters

  • connection (GoogleApi.Vault.V1.Connection): Connection to server
  • matter_id (String.t): The matter ID.
  • optional_params (KeywordList): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (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.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :view (String.t): Specifies which parts of the Matter to return in the response.

Returns

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

Link to this function

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

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.

Parameters

  • connection (GoogleApi.Vault.V1.Connection): Connection to server
  • matter_id (String.t): The matter ID.
  • hold_id (String.t): The hold ID.
  • optional_params (KeywordList): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (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.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :body (HeldAccount):

Returns

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

Link to this function

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

Removes a HeldAccount from a hold. If this request leaves the hold with no held accounts, the hold will not apply to any accounts.

Parameters

  • connection (GoogleApi.Vault.V1.Connection): Connection to server
  • matter_id (String.t): The matter ID.
  • hold_id (String.t): The hold ID.
  • account_id (String.t): The ID of the account to remove from the hold.
  • optional_params (KeywordList): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (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.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").

Returns

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

Link to this function

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

Lists HeldAccounts for a hold. This will only list individually specified held accounts. If the hold is on an OU, then use <a href="https://developers.google.com/admin-sdk/">Admin SDK</a> to enumerate its members.

Parameters

  • connection (GoogleApi.Vault.V1.Connection): Connection to server
  • matter_id (String.t): The matter ID.
  • hold_id (String.t): The hold ID.
  • optional_params (KeywordList): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (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.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").

Returns

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

Link to this function

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

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.

Parameters

  • connection (GoogleApi.Vault.V1.Connection): Connection to server
  • matter_id (String.t): The matter ID.
  • hold_id (String.t): The hold ID.
  • optional_params (KeywordList): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (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.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :body (AddHeldAccountsRequest):

Returns

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

Link to this function

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

Creates a hold in the given matter.

Parameters

  • connection (GoogleApi.Vault.V1.Connection): Connection to server
  • matter_id (String.t): The matter ID.
  • optional_params (KeywordList): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (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.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :body (Hold):

Returns

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

Link to this function

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

Removes a hold by ID. This will release any HeldAccounts on this Hold.

Parameters

  • connection (GoogleApi.Vault.V1.Connection): Connection to server
  • matter_id (String.t): The matter ID.
  • hold_id (String.t): The hold ID.
  • optional_params (KeywordList): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (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.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").

Returns

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

Link to this function

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

Gets a hold by ID.

Parameters

  • connection (GoogleApi.Vault.V1.Connection): Connection to server
  • matter_id (String.t): The matter ID.
  • hold_id (String.t): The hold ID.
  • optional_params (KeywordList): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (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.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :view (String.t): Specifies which parts of the Hold to return.

Returns

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

Link to this function

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

Lists holds within a matter. An empty page token in ListHoldsResponse denotes no more holds to list.

Parameters

  • connection (GoogleApi.Vault.V1.Connection): Connection to server
  • matter_id (String.t): The matter ID.
  • optional_params (KeywordList): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (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.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :pageSize (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 (String.t): The pagination token as returned in the response. An empty token means start from the beginning.
    • :view (String.t): Specifies which parts of the Hold to return.

Returns

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

Link to this function

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

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.

Parameters

  • connection (GoogleApi.Vault.V1.Connection): Connection to server
  • matter_id (String.t): The matter ID.
  • hold_id (String.t): The hold ID.
  • optional_params (KeywordList): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (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.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :body (RemoveHeldAccountsRequest):

Returns

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

Link to this function

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

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.

Parameters

  • connection (GoogleApi.Vault.V1.Connection): Connection to server
  • matter_id (String.t): The matter ID.
  • hold_id (String.t): The ID of the hold.
  • optional_params (KeywordList): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (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.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :body (Hold):

Returns

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

Link to this function

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

Lists matters the user has access to.

Parameters

  • connection (GoogleApi.Vault.V1.Connection): Connection to server
  • optional_params (KeywordList): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (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.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :pageSize (integer()): The number of matters to return in the response. Default and maximum are 100.
    • :pageToken (String.t): The pagination token as returned in the response.
    • :state (String.t): If set, list only matters with that specific state. The default is listing matters of all states.
    • :view (String.t): Specifies which parts of the matter to return in response.

Returns

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

Link to this function

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

Removes an account as a matter collaborator.

Parameters

  • connection (GoogleApi.Vault.V1.Connection): Connection to server
  • matter_id (String.t): The matter ID.
  • optional_params (KeywordList): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (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.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :body (RemoveMatterPermissionsRequest):

Returns

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

Link to this function

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

Reopens the specified matter. Returns matter with updated state.

Parameters

  • connection (GoogleApi.Vault.V1.Connection): Connection to server
  • matter_id (String.t): The matter ID.
  • optional_params (KeywordList): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (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.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :body (ReopenMatterRequest):

Returns

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

Link to this function

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

Creates a saved query.

Parameters

  • connection (GoogleApi.Vault.V1.Connection): Connection to server
  • matter_id (String.t): The matter id of the parent matter for which the saved query is to be created.
  • optional_params (KeywordList): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (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.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :body (SavedQuery):

Returns

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

Link to this function

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

Deletes a saved query by Id.

Parameters

  • connection (GoogleApi.Vault.V1.Connection): Connection to server
  • matter_id (String.t): The matter id of the parent matter for which the saved query is to be deleted.
  • saved_query_id (String.t): Id of the saved query to be deleted.
  • optional_params (KeywordList): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (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.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").

Returns

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

Link to this function

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

Retrieves a saved query by Id.

Parameters

  • connection (GoogleApi.Vault.V1.Connection): Connection to server
  • matter_id (String.t): The matter id of the parent matter for which the saved query is to be retrieved.
  • saved_query_id (String.t): Id of the saved query to be retrieved.
  • optional_params (KeywordList): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (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.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").

Returns

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

Link to this function

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

Lists saved queries within a matter. An empty page token in ListSavedQueriesResponse denotes no more saved queries to list.

Parameters

  • connection (GoogleApi.Vault.V1.Connection): Connection to server
  • matter_id (String.t): The matter id of the parent matter for which the saved queries are to be retrieved.
  • optional_params (KeywordList): [optional] Optional parameters

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

Returns

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

Link to this function

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

Undeletes the specified matter. Returns matter with updated state.

Parameters

  • connection (GoogleApi.Vault.V1.Connection): Connection to server
  • matter_id (String.t): The matter ID.
  • optional_params (KeywordList): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (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.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :body (UndeleteMatterRequest):

Returns

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

Link to this function

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

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 (GoogleApi.Vault.V1.Connection): Connection to server
  • matter_id (String.t): The matter ID.
  • optional_params (KeywordList): [optional] Optional parameters

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

Returns

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