gogol-vault-1.0.0: Google Vault SDK.

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

Contents

Resource
- Constructing a Request

Description

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

See: Google Vault API Reference for vault.matters.close.

Synopsis

type VaultMattersCloseResource = "v1" :> ("matters" :> (CaptureMode "matterId" "close" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "access_token" Text :> (QueryParam "callback" Text :> (QueryParam "uploadType" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] CloseMatterRequest :> Post '[JSON] CloseMatterResponse)))))))))
data VaultMattersClose = VaultMattersClose {
- xgafv :: Maybe Xgafv
- accessToken :: Maybe Text
- callback :: Maybe Text
- matterId :: Text
- payload :: CloseMatterRequest
- uploadType :: Maybe Text
- uploadProtocol :: Maybe Text
}
newVaultMattersClose :: Text -> CloseMatterRequest -> VaultMattersClose

Resource

type VaultMattersCloseResource = "v1" :> ("matters" :> (CaptureMode "matterId" "close" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "access_token" Text :> (QueryParam "callback" Text :> (QueryParam "uploadType" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] CloseMatterRequest :> Post '[JSON] CloseMatterResponse))))))))) Source #

A resource alias for vault.matters.close method which the VaultMattersClose request conforms to.

Constructing a Request

data VaultMattersClose Source #

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

See: newVaultMattersClose smart constructor.

Constructors

VaultMattersClose
Fields xgafv :: Maybe Xgafv V1 error format. accessToken :: Maybe Text OAuth access token. callback :: Maybe Text JSONP matterId :: Text The matter ID. payload :: CloseMatterRequest 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 VaultMattersClose Source #

Instance details

Defined in Gogol.Vault.Matters.Close

Associated Types

type Rep VaultMattersClose

Instance details

Defined in Gogol.Vault.Matters.Close

type Rep VaultMattersClose = D1 ('MetaData "VaultMattersClose" "Gogol.Vault.Matters.Close" "gogol-vault-1.0.0-AEb3SvKZTS6BS7wLBL3Mmc" 'False) (C1 ('MetaCons "VaultMattersClose" 'PrefixI 'True) ((S1 ('MetaSel ('Just "xgafv") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Xgafv)) :*: (S1 ('MetaSel ('Just "accessToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "callback") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "matterId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "payload") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CloseMatterRequest)) :*: (S1 ('MetaSel ('Just "uploadType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "uploadProtocol") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

Methods

from :: VaultMattersClose -> Rep VaultMattersClose x #

to :: Rep VaultMattersClose x -> VaultMattersClose #

Show VaultMattersClose Source #

Instance details

Defined in Gogol.Vault.Matters.Close

Methods

showsPrec :: Int -> VaultMattersClose -> ShowS #

show :: VaultMattersClose -> String #

showList :: [VaultMattersClose] -> ShowS #

Eq VaultMattersClose Source #

Instance details

Defined in Gogol.Vault.Matters.Close

Methods

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

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

GoogleRequest VaultMattersClose Source #

Instance details

Defined in Gogol.Vault.Matters.Close

Associated Types

type Rs VaultMattersClose
Instance details Defined in Gogol.Vault.Matters.Close type Rs VaultMattersClose = CloseMatterResponse
type Scopes VaultMattersClose
Instance details Defined in Gogol.Vault.Matters.Close type Scopes VaultMattersClose = '[Ediscovery'FullControl]

Methods

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

type Rep VaultMattersClose Source #

Instance details

Defined in Gogol.Vault.Matters.Close

type Rep VaultMattersClose = D1 ('MetaData "VaultMattersClose" "Gogol.Vault.Matters.Close" "gogol-vault-1.0.0-AEb3SvKZTS6BS7wLBL3Mmc" 'False) (C1 ('MetaCons "VaultMattersClose" 'PrefixI 'True) ((S1 ('MetaSel ('Just "xgafv") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Xgafv)) :*: (S1 ('MetaSel ('Just "accessToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "callback") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "matterId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "payload") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CloseMatterRequest)) :*: (S1 ('MetaSel ('Just "uploadType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "uploadProtocol") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

type Rs VaultMattersClose Source #

Instance details

Defined in Gogol.Vault.Matters.Close

type Rs VaultMattersClose = CloseMatterResponse

type Scopes VaultMattersClose Source #

Instance details

Defined in Gogol.Vault.Matters.Close

type Scopes VaultMattersClose = '[Ediscovery'FullControl]

newVaultMattersClose Source #

Arguments

:: Text	The matter ID. See `matterId`.
-> CloseMatterRequest	Multipart request metadata. See `payload`.
-> VaultMattersClose

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