Copyright	(c) 2015-2016 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.Google.Resource.Vault.Matters.Close

Contents

REST Resource
Creating a Request
Request Lenses

Description

Closes the specified matter. Returns matter with updated state.

See: G Suite Vault API Reference for vault.matters.close.

Synopsis

type MattersCloseResource = "v1" :> ("matters" :> (CaptureMode "matterId" "close" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] CloseMatterRequest :> Post '[JSON] CloseMatterResponse)))))))))
mattersClose :: CloseMatterRequest -> Text -> MattersClose
data MattersClose
mcXgafv :: Lens' MattersClose (Maybe Xgafv)
mcUploadProtocol :: Lens' MattersClose (Maybe Text)
mcAccessToken :: Lens' MattersClose (Maybe Text)
mcUploadType :: Lens' MattersClose (Maybe Text)
mcPayload :: Lens' MattersClose CloseMatterRequest
mcMatterId :: Lens' MattersClose Text
mcCallback :: Lens' MattersClose (Maybe Text)

REST Resource

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

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

Creating a Request

mattersClose Source #

Arguments

:: CloseMatterRequest	`mcPayload`
-> Text	`mcMatterId`
-> MattersClose

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

Use one of the following lenses to modify other fields as desired:

data MattersClose Source #

Closes the specified matter. Returns matter with updated state.

See: mattersClose smart constructor.

Instances

Eq MattersClose Source #
Instance details Defined in Network.Google.Resource.Vault.Matters.Close Methods (==) :: MattersClose -> MattersClose -> Bool # (/=) :: MattersClose -> MattersClose -> Bool #
Data MattersClose Source #
Instance details Defined in Network.Google.Resource.Vault.Matters.Close Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> MattersClose -> c MattersClose # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c MattersClose # toConstr :: MattersClose -> Constr # dataTypeOf :: MattersClose -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c MattersClose) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c MattersClose) # gmapT :: (forall b. Data b => b -> b) -> MattersClose -> MattersClose # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> MattersClose -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> MattersClose -> r # gmapQ :: (forall d. Data d => d -> u) -> MattersClose -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> MattersClose -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> MattersClose -> m MattersClose # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> MattersClose -> m MattersClose # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> MattersClose -> m MattersClose #
Show MattersClose Source #
Instance details Defined in Network.Google.Resource.Vault.Matters.Close Methods showsPrec :: Int -> MattersClose -> ShowS # show :: MattersClose -> String # showList :: [MattersClose] -> ShowS #
Generic MattersClose Source #
Instance details Defined in Network.Google.Resource.Vault.Matters.Close Associated Types type Rep MattersClose :: Type -> Type # Methods from :: MattersClose -> Rep MattersClose x # to :: Rep MattersClose x -> MattersClose #
GoogleRequest MattersClose Source #
Instance details Defined in Network.Google.Resource.Vault.Matters.Close Associated Types type Rs MattersClose :: Type # type Scopes MattersClose :: [Symbol] # Methods requestClient :: MattersClose -> GClient (Rs MattersClose) #
type Rep MattersClose Source #
Instance details Defined in Network.Google.Resource.Vault.Matters.Close type Rep MattersClose = D1 (MetaData "MattersClose" "Network.Google.Resource.Vault.Matters.Close" "gogol-vault-0.4.0-EgDnYDp2TSnGyXDp2UEGmS" False) (C1 (MetaCons "MattersClose'" PrefixI True) ((S1 (MetaSel (Just "_mcXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :: (S1 (MetaSel (Just "_mcUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_mcAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 (MetaSel (Just "_mcUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_mcPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 CloseMatterRequest)) :: (S1 (MetaSel (Just "_mcMatterId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: S1 (MetaSel (Just "_mcCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Scopes MattersClose Source #
Instance details Defined in Network.Google.Resource.Vault.Matters.Close type Scopes MattersClose = "https://www.googleapis.com/auth/ediscovery" ': ([] :: [Symbol])
type Rs MattersClose Source #
Instance details Defined in Network.Google.Resource.Vault.Matters.Close type Rs MattersClose = CloseMatterResponse

Request Lenses

mcXgafv :: Lens' MattersClose (Maybe Xgafv) Source #

V1 error format.

mcUploadProtocol :: Lens' MattersClose (Maybe Text) Source #

Upload protocol for media (e.g. "raw", "multipart").

mcAccessToken :: Lens' MattersClose (Maybe Text) Source #

OAuth access token.

mcUploadType :: Lens' MattersClose (Maybe Text) Source #

Legacy upload protocol for media (e.g. "media", "multipart").

mcPayload :: Lens' MattersClose CloseMatterRequest Source #

Multipart request metadata.

mcMatterId :: Lens' MattersClose Text Source #

The matter ID.

mcCallback :: Lens' MattersClose (Maybe Text) Source #

JSONP