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

Contents

REST Resource
Creating a Request
Request Lenses

Description

Accepts an invitation, removing it and adding the invited user to the teachers or students (as appropriate) of the specified course. Only the invited user may accept an invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to accept the requested invitation or for access errors. * `FAILED_PRECONDITION` for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * CourseTeacherLimitReached * UserGroupsMembershipLimitReached * `NOT_FOUND` if no invitation exists with the requested ID.

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

Synopsis

type InvitationsAcceptResource = "v1" :> ("invitations" :> (CaptureMode "id" "accept" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Post '[JSON] Empty))))))))
invitationsAccept :: Text -> InvitationsAccept
data InvitationsAccept
iaXgafv :: Lens' InvitationsAccept (Maybe Xgafv)
iaUploadProtocol :: Lens' InvitationsAccept (Maybe Text)
iaAccessToken :: Lens' InvitationsAccept (Maybe Text)
iaUploadType :: Lens' InvitationsAccept (Maybe Text)
iaId :: Lens' InvitationsAccept Text
iaCallback :: Lens' InvitationsAccept (Maybe Text)

REST Resource

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

A resource alias for classroom.invitations.accept method which the InvitationsAccept request conforms to.

Creating a Request

invitationsAccept Source #

Arguments

:: Text	`iaId`
-> InvitationsAccept

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

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

data InvitationsAccept Source #

Accepts an invitation, removing it and adding the invited user to the teachers or students (as appropriate) of the specified course. Only the invited user may accept an invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to accept the requested invitation or for access errors. * `FAILED_PRECONDITION` for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * CourseTeacherLimitReached * UserGroupsMembershipLimitReached * `NOT_FOUND` if no invitation exists with the requested ID.

See: invitationsAccept smart constructor.

Instances

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

Request Lenses

iaXgafv :: Lens' InvitationsAccept (Maybe Xgafv) Source #

V1 error format.

iaUploadProtocol :: Lens' InvitationsAccept (Maybe Text) Source #

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

iaAccessToken :: Lens' InvitationsAccept (Maybe Text) Source #

OAuth access token.

iaUploadType :: Lens' InvitationsAccept (Maybe Text) Source #

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

iaId :: Lens' InvitationsAccept Text Source #

Identifier of the invitation to accept.

iaCallback :: Lens' InvitationsAccept (Maybe Text) Source #

JSONP