happygapi.vault.matters — happygapi 0.4.7

G Suite Vault API: matters. Retention and eDiscovery for Google Workspace. To work with Vault resources, the account must have the [required Vault privileges] (https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the View All Matters privilege. For example, to download an export, an account needs the Manage Exports privilege and the matter shared with them. 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:

{:sendEmails boolean, :matterPermission {:accountId string, :role string}, :ccMe 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 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 artifacts within the context of a matter and returns a detailed breakdown of metrics.

create$ clj

(create$ auth parameters body)

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

Required parameters: none

Optional parameters: none

Body:

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

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.

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 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 {:email string, :displayName 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 {:sizeInBytes string, :totalArtifactCount string, :exportedArtifactCount string}, :exportOptions {:driveOptions DriveExportOptions, :region string, :groupsOptions GroupsExportOptions, :hangoutsChatOptions HangoutsChatExportOptions, :voiceOptions VoiceExportOptions, :mailOptions MailExportOptions}}

Creates an Export.

exports-delete$ clj

(exports-delete$ auth parameters)

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

Required parameters: matterId, exportId

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: matterId, exportId

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 Exports.

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:

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

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.

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 a HeldAccount from a hold. If this request leaves the hold with no held accounts, the hold will not apply to any accounts.

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 HeldAccounts for a hold. This will only list individually specified held accounts. If the hold is on an OU, then use Admin SDK to enumerate its members.

holds-addHeldAccounts$ clj

(holds-addHeldAccounts$ auth parameters body)

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

Required parameters: matterId, holdId

Optional parameters: none

Body:

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

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.

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:

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

Creates a hold in the given matter.

holds-delete$ clj

(holds-delete$ auth parameters)

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

Required parameters: matterId, holdId

Optional parameters: none

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

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 a hold by ID.

holds-list$ clj

(holds-list$ auth parameters)

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

Required parameters: matterId

Optional parameters: view, pageToken, pageSize

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

holds-removeHeldAccounts$ clj

(holds-removeHeldAccounts$ auth parameters body)

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

Required parameters: matterId, holdId

Optional parameters: none

Body:

{:accountIds [string]}

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.

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:

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

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.

list$ clj

(list$ auth parameters)

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

Required parameters: none

Optional parameters: state, pageToken, pageSize, view

Lists matters the user 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 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:

{:createTime string, :displayName string, :matterId string, :savedQueryId 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: matterId, savedQueryId

Optional parameters: none

Deletes a saved query by Id.

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 a saved query by Id.

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 saved queries within a matter. An empty page token in ListSavedQueriesResponse denotes no more saved queries to list.

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 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:

{:description string, :matterId string, :matterPermissions [{:accountId string, :role string}], :state string, :name 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.