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.Classroom.Invitations.Delete

Contents

REST Resource
Creating a Request
Request Lenses

Description

Deletes an invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete the requested invitation or for access errors. * `NOT_FOUND` if no invitation exists with the requested ID.

See: Google Classroom API Reference for classroom.invitations.delete.

Synopsis

type InvitationsDeleteResource = "v1" :> ("invitations" :> (Capture "id" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Delete '[JSON] Empty))))))))
invitationsDelete :: Text -> InvitationsDelete
data InvitationsDelete
idXgafv :: Lens' InvitationsDelete (Maybe Xgafv)
idUploadProtocol :: Lens' InvitationsDelete (Maybe Text)
idAccessToken :: Lens' InvitationsDelete (Maybe Text)
idUploadType :: Lens' InvitationsDelete (Maybe Text)
idId :: Lens' InvitationsDelete Text
idCallback :: Lens' InvitationsDelete (Maybe Text)

REST Resource

type InvitationsDeleteResource = "v1" :> ("invitations" :> (Capture "id" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Delete '[JSON] Empty)))))))) Source #

A resource alias for classroom.invitations.delete method which the InvitationsDelete request conforms to.

Creating a Request

invitationsDelete Source #

Arguments

:: Text	`idId`
-> InvitationsDelete

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

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

data InvitationsDelete Source #

Deletes an invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete the requested invitation or for access errors. * `NOT_FOUND` if no invitation exists with the requested ID.

See: invitationsDelete smart constructor.

Instances

Eq InvitationsDelete Source #
Instance details Defined in Network.Google.Resource.Classroom.Invitations.Delete Methods (==) :: InvitationsDelete -> InvitationsDelete -> Bool # (/=) :: InvitationsDelete -> InvitationsDelete -> Bool #
Data InvitationsDelete Source #
Instance details Defined in Network.Google.Resource.Classroom.Invitations.Delete Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> InvitationsDelete -> c InvitationsDelete # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c InvitationsDelete # toConstr :: InvitationsDelete -> Constr # dataTypeOf :: InvitationsDelete -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c InvitationsDelete) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c InvitationsDelete) # gmapT :: (forall b. Data b => b -> b) -> InvitationsDelete -> InvitationsDelete # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> InvitationsDelete -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> InvitationsDelete -> r # gmapQ :: (forall d. Data d => d -> u) -> InvitationsDelete -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> InvitationsDelete -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> InvitationsDelete -> m InvitationsDelete # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> InvitationsDelete -> m InvitationsDelete # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> InvitationsDelete -> m InvitationsDelete #
Show InvitationsDelete Source #
Instance details Defined in Network.Google.Resource.Classroom.Invitations.Delete Methods showsPrec :: Int -> InvitationsDelete -> ShowS # show :: InvitationsDelete -> String # showList :: [InvitationsDelete] -> ShowS #
Generic InvitationsDelete Source #
Instance details Defined in Network.Google.Resource.Classroom.Invitations.Delete Associated Types type Rep InvitationsDelete :: Type -> Type # Methods from :: InvitationsDelete -> Rep InvitationsDelete x # to :: Rep InvitationsDelete x -> InvitationsDelete #
GoogleRequest InvitationsDelete Source #
Instance details Defined in Network.Google.Resource.Classroom.Invitations.Delete Associated Types type Rs InvitationsDelete :: Type # type Scopes InvitationsDelete :: [Symbol] # Methods requestClient :: InvitationsDelete -> GClient (Rs InvitationsDelete) #
type Rep InvitationsDelete Source #
Instance details Defined in Network.Google.Resource.Classroom.Invitations.Delete type Rep InvitationsDelete = D1 (MetaData "InvitationsDelete" "Network.Google.Resource.Classroom.Invitations.Delete" "gogol-classroom-0.4.0-8aa8kYGMMJyCKn01TYMpOR" False) (C1 (MetaCons "InvitationsDelete'" PrefixI True) ((S1 (MetaSel (Just "_idXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :: (S1 (MetaSel (Just "_idUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_idAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 (MetaSel (Just "_idUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: (S1 (MetaSel (Just "_idId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_idCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Scopes InvitationsDelete Source #
Instance details Defined in Network.Google.Resource.Classroom.Invitations.Delete type Scopes InvitationsDelete = "https://www.googleapis.com/auth/classroom.rosters" ': ([] :: [Symbol])
type Rs InvitationsDelete Source #
Instance details Defined in Network.Google.Resource.Classroom.Invitations.Delete type Rs InvitationsDelete = Empty

Request Lenses

idXgafv :: Lens' InvitationsDelete (Maybe Xgafv) Source #

V1 error format.

idUploadProtocol :: Lens' InvitationsDelete (Maybe Text) Source #

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

idAccessToken :: Lens' InvitationsDelete (Maybe Text) Source #

OAuth access token.

idUploadType :: Lens' InvitationsDelete (Maybe Text) Source #

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

idId :: Lens' InvitationsDelete Text Source #

Identifier of the invitation to delete.

idCallback :: Lens' InvitationsDelete (Maybe Text) Source #

JSONP