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.Accounts.Create

Contents

Resource
- Constructing a Request

Description

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.

See: Google Vault API Reference for vault.matters.holds.accounts.create.

Synopsis

type VaultMattersHoldsAccountsCreateResource = "v1" :> ("matters" :> (Capture "matterId" Text :> ("holds" :> (Capture "holdId" Text :> ("accounts" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "access_token" Text :> (QueryParam "callback" Text :> (QueryParam "uploadType" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] HeldAccount :> Post '[JSON] HeldAccount))))))))))))
data VaultMattersHoldsAccountsCreate = VaultMattersHoldsAccountsCreate {
- xgafv :: Maybe Xgafv
- accessToken :: Maybe Text
- callback :: Maybe Text
- holdId :: Text
- matterId :: Text
- payload :: HeldAccount
- uploadType :: Maybe Text
- uploadProtocol :: Maybe Text
}
newVaultMattersHoldsAccountsCreate :: Text -> Text -> HeldAccount -> VaultMattersHoldsAccountsCreate

Resource

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

A resource alias for vault.matters.holds.accounts.create method which the VaultMattersHoldsAccountsCreate request conforms to.

Constructing a Request

data VaultMattersHoldsAccountsCreate Source #

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.

See: newVaultMattersHoldsAccountsCreate smart constructor.

Constructors

VaultMattersHoldsAccountsCreate
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 :: HeldAccount 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 VaultMattersHoldsAccountsCreate Source #

Instance details

Defined in Gogol.Vault.Matters.Holds.Accounts.Create

Associated Types

type Rep VaultMattersHoldsAccountsCreate

Instance details

Defined in Gogol.Vault.Matters.Holds.Accounts.Create

Methods

from :: VaultMattersHoldsAccountsCreate -> Rep VaultMattersHoldsAccountsCreate x #

to :: Rep VaultMattersHoldsAccountsCreate x -> VaultMattersHoldsAccountsCreate #

Show VaultMattersHoldsAccountsCreate Source #

Instance details

Defined in Gogol.Vault.Matters.Holds.Accounts.Create

Methods

showsPrec :: Int -> VaultMattersHoldsAccountsCreate -> ShowS #

show :: VaultMattersHoldsAccountsCreate -> String #

showList :: [VaultMattersHoldsAccountsCreate] -> ShowS #

Eq VaultMattersHoldsAccountsCreate Source #

Instance details

Defined in Gogol.Vault.Matters.Holds.Accounts.Create

Methods

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

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

GoogleRequest VaultMattersHoldsAccountsCreate Source #

Instance details

Defined in Gogol.Vault.Matters.Holds.Accounts.Create

Associated Types

type Rs VaultMattersHoldsAccountsCreate
Instance details Defined in Gogol.Vault.Matters.Holds.Accounts.Create type Rs VaultMattersHoldsAccountsCreate = HeldAccount
type Scopes VaultMattersHoldsAccountsCreate
Instance details Defined in Gogol.Vault.Matters.Holds.Accounts.Create type Scopes VaultMattersHoldsAccountsCreate = '[Ediscovery'FullControl]

Methods

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

type Rep VaultMattersHoldsAccountsCreate Source #

Instance details

Defined in Gogol.Vault.Matters.Holds.Accounts.Create

type Rs VaultMattersHoldsAccountsCreate Source #

Instance details

Defined in Gogol.Vault.Matters.Holds.Accounts.Create

type Rs VaultMattersHoldsAccountsCreate = HeldAccount

type Scopes VaultMattersHoldsAccountsCreate Source #

Instance details

Defined in Gogol.Vault.Matters.Holds.Accounts.Create

type Scopes VaultMattersHoldsAccountsCreate = '[Ediscovery'FullControl]

newVaultMattersHoldsAccountsCreate Source #

Arguments

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

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