happygapi.vault.matters — happygapi 0.4.8

Google Vault API: matters. Retention and eDiscovery for Google Workspace. To work with Vault resources, the account must have the required Vault privileges and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the View All Matters privilege. For example, to download an export, an account needs the Manage Exports privilege and the matter shared with them. See: https://developers.google.com/vaultapi/reference/rest/v1/matters

addPermissions$ clj

(addPermissions$ auth parameters body)

https://developers.google.com/vaultapi/reference/rest/v1/matters/addPermissions

Required parameters: matterId

Optional parameters: none

Body:

{:ccMe boolean, :matterPermission {:accountId string, :role string}, :sendEmails boolean}

Adds an account as a matter collaborator.

close$ clj

(close$ auth parameters body)

https://developers.google.com/vaultapi/reference/rest/v1/matters/close

Required parameters: matterId

Optional parameters: none

Body:

{}

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

count$ clj

(count$ auth parameters body)

https://developers.google.com/vaultapi/reference/rest/v1/matters/count

Required parameters: matterId

Optional parameters: none

Body:

{:view string, :query {:hangoutsChatOptions HangoutsChatOptions, :orgUnitInfo OrgUnitInfo, :timeZone string, :hangoutsChatInfo HangoutsChatInfo, :startTime string, :terms string, :searchMethod string, :method string, :voiceOptions VoiceOptions, :endTime string, :sharedDriveInfo SharedDriveInfo, :accountInfo AccountInfo, :corpus string, :teamDriveInfo TeamDriveInfo, :mailOptions MailOptions, :driveOptions DriveOptions, :dataScope string}}

Counts the accounts processed by the specified query.

create$ clj

(create$ auth parameters body)

https://developers.google.com/vaultapi/reference/rest/v1/matters/create

Required parameters: none

Optional parameters: none

Body:

{:matterId string, :name string, :description string, :state string, :matterPermissions [{:accountId string, :role string}]}

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.

delete$ clj

(delete$ auth parameters)

https://developers.google.com/vaultapi/reference/rest/v1/matters/delete

Required parameters: matterId

Optional parameters: none

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

exports-create$ clj

(exports-create$ auth parameters body)

https://developers.google.com/vaultapi/reference/rest/v1/matters/exports/create

Required parameters: matterId

Optional parameters: none

Body:

{:name string, :createTime string, :requester {:displayName string, :email string}, :status string, :id string, :matterId string, :cloudStorageSink {:files [CloudStorageFile]}, :query {:hangoutsChatOptions HangoutsChatOptions, :orgUnitInfo OrgUnitInfo, :timeZone string, :hangoutsChatInfo HangoutsChatInfo, :startTime string, :terms string, :searchMethod string, :method string, :voiceOptions VoiceOptions, :endTime string, :sharedDriveInfo SharedDriveInfo, :accountInfo AccountInfo, :corpus string, :teamDriveInfo TeamDriveInfo, :mailOptions MailOptions, :driveOptions DriveOptions, :dataScope string}, :stats {:exportedArtifactCount string, :totalArtifactCount string, :sizeInBytes string}, :exportOptions {:groupsOptions GroupsExportOptions, :region string, :voiceOptions VoiceExportOptions, :mailOptions MailExportOptions, :hangoutsChatOptions HangoutsChatExportOptions, :driveOptions DriveExportOptions}}

Creates an export.

exports-delete$ clj

(exports-delete$ auth parameters)

https://developers.google.com/vaultapi/reference/rest/v1/matters/exports/delete

Required parameters: exportId, matterId

Optional parameters: none

Deletes an export.

exports-get$ clj

(exports-get$ auth parameters)

https://developers.google.com/vaultapi/reference/rest/v1/matters/exports/get

Required parameters: exportId, matterId

Optional parameters: none

Gets an export.

exports-list$ clj

(exports-list$ auth parameters)

https://developers.google.com/vaultapi/reference/rest/v1/matters/exports/list

Required parameters: matterId

Optional parameters: pageSize, pageToken

Lists details about the exports in the specified matter.

get$ clj

(get$ auth parameters)

https://developers.google.com/vaultapi/reference/rest/v1/matters/get

Required parameters: matterId

Optional parameters: view

Gets the specified matter.

holds-accounts-create$ clj

(holds-accounts-create$ auth parameters body)

https://developers.google.com/vaultapi/reference/rest/v1/matters/holds/accounts/create

Required parameters: holdId, matterId

Optional parameters: none

Body:

{:lastName string, :accountId string, :firstName string, :holdTime string, :email string}

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.

holds-accounts-delete$ clj

(holds-accounts-delete$ auth parameters)

https://developers.google.com/vaultapi/reference/rest/v1/matters/holds/accounts/delete

Required parameters: holdId, accountId, matterId

Optional parameters: none

Removes an account from a hold.

holds-accounts-list$ clj

(holds-accounts-list$ auth parameters)

https://developers.google.com/vaultapi/reference/rest/v1/matters/holds/accounts/list

Required parameters: matterId, holdId

Optional parameters: none

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.

holds-addHeldAccounts$ clj

(holds-addHeldAccounts$ auth parameters body)

https://developers.google.com/vaultapi/reference/rest/v1/matters/holds/addHeldAccounts

Required parameters: holdId, matterId

Optional parameters: none

Body:

{:emails [string], :accountIds [string]}

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.

holds-create$ clj

(holds-create$ auth parameters body)

https://developers.google.com/vaultapi/reference/rest/v1/matters/holds/create

Required parameters: matterId

Optional parameters: none

Body:

{:accounts [{:lastName string, :accountId string, :firstName string, :holdTime string, :email string}], :query {:hangoutsChatQuery HeldHangoutsChatQuery, :driveQuery HeldDriveQuery, :groupsQuery HeldGroupsQuery, :voiceQuery HeldVoiceQuery, :mailQuery HeldMailQuery}, :holdId string, :orgUnit {:orgUnitId string, :holdTime string}, :corpus string, :name string, :updateTime string}

Creates a hold in the specified matter.

holds-delete$ clj

(holds-delete$ auth parameters)

https://developers.google.com/vaultapi/reference/rest/v1/matters/holds/delete

Required parameters: holdId, matterId

Optional parameters: none

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.

holds-get$ clj

(holds-get$ auth parameters)

https://developers.google.com/vaultapi/reference/rest/v1/matters/holds/get

Required parameters: matterId, holdId

Optional parameters: view

Gets the specified hold.

holds-list$ clj

(holds-list$ auth parameters)

https://developers.google.com/vaultapi/reference/rest/v1/matters/holds/list

Required parameters: matterId

Optional parameters: pageToken, view, pageSize

Lists the holds in a matter.

holds-removeHeldAccounts$ clj

(holds-removeHeldAccounts$ auth parameters body)

https://developers.google.com/vaultapi/reference/rest/v1/matters/holds/removeHeldAccounts

Required parameters: holdId, matterId

Optional parameters: none

Body:

{:accountIds [string]}

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

holds-update$ clj

(holds-update$ auth parameters body)

https://developers.google.com/vaultapi/reference/rest/v1/matters/holds/update

Required parameters: holdId, matterId

Optional parameters: none

Body:

{:accounts [{:lastName string, :accountId string, :firstName string, :holdTime string, :email string}], :query {:hangoutsChatQuery HeldHangoutsChatQuery, :driveQuery HeldDriveQuery, :groupsQuery HeldGroupsQuery, :voiceQuery HeldVoiceQuery, :mailQuery HeldMailQuery}, :holdId string, :orgUnit {:orgUnitId string, :holdTime string}, :corpus string, :name string, :updateTime string}

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.

list$ clj

(list$ auth parameters)

https://developers.google.com/vaultapi/reference/rest/v1/matters/list

Required parameters: none

Optional parameters: pageSize, pageToken, view, state

Lists matters the requestor has access to.

removePermissions$ clj

(removePermissions$ auth parameters body)

https://developers.google.com/vaultapi/reference/rest/v1/matters/removePermissions

Required parameters: matterId

Optional parameters: none

Body:

{:accountId string}

Removes an account as a matter collaborator.

reopen$ clj

(reopen$ auth parameters body)

https://developers.google.com/vaultapi/reference/rest/v1/matters/reopen

Required parameters: matterId

Optional parameters: none

Body:

{}

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

savedQueries-create$ clj

(savedQueries-create$ auth parameters body)

https://developers.google.com/vaultapi/reference/rest/v1/matters/savedQueries/create

Required parameters: matterId

Optional parameters: none

Body:

{:matterId string, :displayName string, :savedQueryId string, :createTime string, :query {:hangoutsChatOptions HangoutsChatOptions, :orgUnitInfo OrgUnitInfo, :timeZone string, :hangoutsChatInfo HangoutsChatInfo, :startTime string, :terms string, :searchMethod string, :method string, :voiceOptions VoiceOptions, :endTime string, :sharedDriveInfo SharedDriveInfo, :accountInfo AccountInfo, :corpus string, :teamDriveInfo TeamDriveInfo, :mailOptions MailOptions, :driveOptions DriveOptions, :dataScope string}}

Creates a saved query.

savedQueries-delete$ clj

(savedQueries-delete$ auth parameters)

https://developers.google.com/vaultapi/reference/rest/v1/matters/savedQueries/delete

Required parameters: savedQueryId, matterId

Optional parameters: none

Deletes the specified saved query.

savedQueries-get$ clj

(savedQueries-get$ auth parameters)

https://developers.google.com/vaultapi/reference/rest/v1/matters/savedQueries/get

Required parameters: matterId, savedQueryId

Optional parameters: none

Retrieves the specified saved query.

savedQueries-list$ clj

(savedQueries-list$ auth parameters)

https://developers.google.com/vaultapi/reference/rest/v1/matters/savedQueries/list

Required parameters: matterId

Optional parameters: pageToken, pageSize

Lists the saved queries in a matter.

undelete$ clj

(undelete$ auth parameters body)

https://developers.google.com/vaultapi/reference/rest/v1/matters/undelete

Required parameters: matterId

Optional parameters: none

Body:

{}

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

update$ clj

(update$ auth parameters body)

https://developers.google.com/vaultapi/reference/rest/v1/matters/update

Required parameters: matterId

Optional parameters: none

Body:

{:matterId string, :name string, :description string, :state string, :matterPermissions [{:accountId string, :role string}]}

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.