Copyright	(c) 2015-2025 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+gogol@gmail.com> Toni Cebrián <toni@tonicebrian.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	GHC2021

Gogol.Vault.Matters.Holds.AddHeldAccounts

Contents

Resource
- Constructing a Request

Description

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.

See: Google Vault API Reference for vault.matters.holds.addHeldAccounts.

Synopsis

type VaultMattersHoldsAddHeldAccountsResource = "v1" :> ("matters" :> (Capture "matterId" Text :> ("holds" :> (CaptureMode "holdId" "addHeldAccounts" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "access_token" Text :> (QueryParam "callback" Text :> (QueryParam "uploadType" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] AddHeldAccountsRequest :> Post '[JSON] AddHeldAccountsResponse)))))))))))
data VaultMattersHoldsAddHeldAccounts = VaultMattersHoldsAddHeldAccounts {
- xgafv :: Maybe Xgafv
- accessToken :: Maybe Text
- callback :: Maybe Text
- holdId :: Text
- matterId :: Text
- payload :: AddHeldAccountsRequest
- uploadType :: Maybe Text
- uploadProtocol :: Maybe Text
}
newVaultMattersHoldsAddHeldAccounts :: Text -> Text -> AddHeldAccountsRequest -> VaultMattersHoldsAddHeldAccounts

Resource

type VaultMattersHoldsAddHeldAccountsResource = "v1" :> ("matters" :> (Capture "matterId" Text :> ("holds" :> (CaptureMode "holdId" "addHeldAccounts" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "access_token" Text :> (QueryParam "callback" Text :> (QueryParam "uploadType" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] AddHeldAccountsRequest :> Post '[JSON] AddHeldAccountsResponse))))))))))) Source #

A resource alias for vault.matters.holds.addHeldAccounts method which the VaultMattersHoldsAddHeldAccounts request conforms to.

Constructing a Request

data VaultMattersHoldsAddHeldAccounts Source #

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.

See: newVaultMattersHoldsAddHeldAccounts smart constructor.

Constructors

VaultMattersHoldsAddHeldAccounts

Fields

xgafv :: Maybe Xgafv
V1 error format.
accessToken :: Maybe Text
OAuth access token.
callback :: Maybe Text
JSONP
holdId :: Text
The hold ID.
matterId :: Text
The matter ID.
payload :: AddHeldAccountsRequest
Multipart request metadata.
uploadType :: Maybe Text
Legacy upload protocol for media (e.g. "media", "multipart").
uploadProtocol :: Maybe Text
Upload protocol for media (e.g. "raw", "multipart").

Instances

Instances details

Generic VaultMattersHoldsAddHeldAccounts Source #

Instance details

Defined in Gogol.Vault.Matters.Holds.AddHeldAccounts

Associated Types

type Rep VaultMattersHoldsAddHeldAccounts

Instance details

Defined in Gogol.Vault.Matters.Holds.AddHeldAccounts

Methods

from :: VaultMattersHoldsAddHeldAccounts -> Rep VaultMattersHoldsAddHeldAccounts x #

to :: Rep VaultMattersHoldsAddHeldAccounts x -> VaultMattersHoldsAddHeldAccounts #

Show VaultMattersHoldsAddHeldAccounts Source #

Instance details

Defined in Gogol.Vault.Matters.Holds.AddHeldAccounts

Methods

showsPrec :: Int -> VaultMattersHoldsAddHeldAccounts -> ShowS #

show :: VaultMattersHoldsAddHeldAccounts -> String #

showList :: [VaultMattersHoldsAddHeldAccounts] -> ShowS #

Eq VaultMattersHoldsAddHeldAccounts Source #

Instance details

Defined in Gogol.Vault.Matters.Holds.AddHeldAccounts

Methods

(==) :: VaultMattersHoldsAddHeldAccounts -> VaultMattersHoldsAddHeldAccounts -> Bool #

(/=) :: VaultMattersHoldsAddHeldAccounts -> VaultMattersHoldsAddHeldAccounts -> Bool #

GoogleRequest VaultMattersHoldsAddHeldAccounts Source #

Instance details

Defined in Gogol.Vault.Matters.Holds.AddHeldAccounts

Associated Types

type Rs VaultMattersHoldsAddHeldAccounts
Instance details Defined in Gogol.Vault.Matters.Holds.AddHeldAccounts type Rs VaultMattersHoldsAddHeldAccounts = AddHeldAccountsResponse
type Scopes VaultMattersHoldsAddHeldAccounts
Instance details Defined in Gogol.Vault.Matters.Holds.AddHeldAccounts type Scopes VaultMattersHoldsAddHeldAccounts = '[Ediscovery'FullControl]

Methods

requestClient :: VaultMattersHoldsAddHeldAccounts -> GClient (Rs VaultMattersHoldsAddHeldAccounts) #

type Rep VaultMattersHoldsAddHeldAccounts Source #

Instance details

Defined in Gogol.Vault.Matters.Holds.AddHeldAccounts

type Rs VaultMattersHoldsAddHeldAccounts Source #

Instance details

Defined in Gogol.Vault.Matters.Holds.AddHeldAccounts

type Rs VaultMattersHoldsAddHeldAccounts = AddHeldAccountsResponse

type Scopes VaultMattersHoldsAddHeldAccounts Source #

Instance details

Defined in Gogol.Vault.Matters.Holds.AddHeldAccounts

type Scopes VaultMattersHoldsAddHeldAccounts = '[Ediscovery'FullControl]

newVaultMattersHoldsAddHeldAccounts Source #

Arguments

:: Text	The hold ID. See `holdId`.
-> Text	The matter ID. See `matterId`.
-> AddHeldAccountsRequest	Multipart request metadata. See `payload`.
-> VaultMattersHoldsAddHeldAccounts

Creates a value of VaultMattersHoldsAddHeldAccounts with the minimum fields required to make a request.