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

Contents

REST Resource
Creating a Request
Request Lenses

Description

Creates an invitation. Only one invitation for a user and course may exist at a time. Delete and re-create an invitation to make changes. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create invitations for this course or for access errors. * `NOT_FOUND` if the course or the user does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled or if the user already has this role or a role with greater permissions. * `ALREADY_EXISTS` if an invitation for the specified user and course already exists.

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

Synopsis

type InvitationsCreateResource = "v1" :> ("invitations" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] Invitation :> Post '[JSON] Invitation))))))))
invitationsCreate :: Invitation -> InvitationsCreate
data InvitationsCreate
icXgafv :: Lens' InvitationsCreate (Maybe Xgafv)
icUploadProtocol :: Lens' InvitationsCreate (Maybe Text)
icAccessToken :: Lens' InvitationsCreate (Maybe Text)
icUploadType :: Lens' InvitationsCreate (Maybe Text)
icPayload :: Lens' InvitationsCreate Invitation
icCallback :: Lens' InvitationsCreate (Maybe Text)

REST Resource

type InvitationsCreateResource = "v1" :> ("invitations" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] Invitation :> Post '[JSON] Invitation)))))))) Source #

A resource alias for classroom.invitations.create method which the InvitationsCreate request conforms to.

Creating a Request

invitationsCreate Source #

Arguments

:: Invitation	`icPayload`
-> InvitationsCreate

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

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

data InvitationsCreate Source #

Creates an invitation. Only one invitation for a user and course may exist at a time. Delete and re-create an invitation to make changes. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create invitations for this course or for access errors. * `NOT_FOUND` if the course or the user does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled or if the user already has this role or a role with greater permissions. * `ALREADY_EXISTS` if an invitation for the specified user and course already exists.

See: invitationsCreate smart constructor.

Instances

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

Request Lenses

icXgafv :: Lens' InvitationsCreate (Maybe Xgafv) Source #

V1 error format.

icUploadProtocol :: Lens' InvitationsCreate (Maybe Text) Source #

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

icAccessToken :: Lens' InvitationsCreate (Maybe Text) Source #

OAuth access token.

icUploadType :: Lens' InvitationsCreate (Maybe Text) Source #

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

icPayload :: Lens' InvitationsCreate Invitation Source #

Multipart request metadata.

icCallback :: Lens' InvitationsCreate (Maybe Text) Source #

JSONP