happygapi.vault.matters — happygapi 0.2.0

G Suite Vault API: matters. Archiving and eDiscovery for G Suite. See: https://developers.google.com/vaultapi/reference/rest/v1/matters

addPermissions$ clj

(addPermissions$ auth args body)

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

Required parameters: matterId

Optional parameters: none

Body:

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

Adds an account as a matter collaborator.

close$ clj

(close$ auth args 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.

create$ clj

(create$ auth args body)

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

Required parameters: none

Optional parameters: none

Body:

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

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 args 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, :endTime string, :sharedDriveInfo SharedDriveInfo, :accountInfo AccountInfo, :corpus string, :teamDriveInfo TeamDriveInfo, :mailOptions MailOptions, :driveOptions DriveOptions, :dataScope string}, :stats {:totalArtifactCount string, :sizeInBytes string, :exportedArtifactCount string}, :exportOptions {:groupsOptions GroupsExportOptions, :driveOptions DriveExportOptions, :mailOptions MailExportOptions, :region string, :hangoutsChatOptions HangoutsChatExportOptions}}

Creates an Export.

exports-delete$ clj

(exports-delete$ auth args)

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 args)

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 args)

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

Required parameters: matterId

Optional parameters: pageToken, pageSize Lists Exports.

get$ clj

(get$ auth args)

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 args body)

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

Required parameters: holdId, matterId

Optional parameters: none

Body:

{:firstName string, :holdTime string, :lastName string, :email string, :accountId 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 args)

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

Required parameters: matterId, holdId, accountId

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 args)

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 <a href="https://developers.google.com/admin-sdk/">Admin SDK</a> to enumerate its members.

holds-addHeldAccounts$ clj

(holds-addHeldAccounts$ auth args body)

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

Required parameters: matterId, holdId

Optional parameters: none

Body:

{:emails [string], :accountIds [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 args body)

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

Required parameters: matterId

Optional parameters: none

Body:

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

Creates a hold in the given matter.

holds-delete$ clj

(holds-delete$ auth args)

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 args)

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 args)

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 args 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 args body)

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

Required parameters: holdId, matterId

Optional parameters: none

Body:

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

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 args)

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

Required parameters: none

Optional parameters: view, state, pageToken, pageSize Lists matters the user has access to.

removePermissions$ clj

(removePermissions$ auth args 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 args 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 args body)

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

Required parameters: matterId

Optional parameters: none

Body:

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

Creates a saved query.

savedQueries-delete$ clj

(savedQueries-delete$ auth args)

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 args)

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 args)

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 args 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 args body)

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

Required parameters: matterId

Optional parameters: none

Body:

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