Network.Google.Resource.Classroom.Invitations.Create

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.

REST Resource

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

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

Creating a Request

invitationsCreate

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:

• icXgafv
• icUploadProtocol
• icPp
• icAccessToken
• icUploadType
• icPayload
• icBearerToken
• icCallback

data InvitationsCreate

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

Methods

(==) :: InvitationsCreate -> InvitationsCreate -> Bool

(/=) :: InvitationsCreate -> InvitationsCreate -> Bool

Data InvitationsCreate

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

Methods

showsPrec :: Int -> InvitationsCreate -> ShowS

show :: InvitationsCreate -> String

showList :: [InvitationsCreate] -> ShowS

Generic InvitationsCreate

Associated Types

type Rep InvitationsCreate :: * -> *

Methods

from :: InvitationsCreate -> Rep InvitationsCreate x

to :: Rep InvitationsCreate x -> InvitationsCreate

GoogleRequest InvitationsCreate

Associated Types

type Rs InvitationsCreate :: *

type Scopes InvitationsCreate :: [Symbol]

Methods

requestClient :: InvitationsCreate -> Client (Rs InvitationsCreate)

type Rep InvitationsCreate

type Rep InvitationsCreate = D1 (MetaData "InvitationsCreate" "Network.Google.Resource.Classroom.Invitations.Create" "gogol-classroom-0.1.0-21rh7SRXdL3B6ZyyiLDhlq" False) (C1 (MetaCons "InvitationsCreate'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_icXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_icUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_icPp") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool)) (S1 (MetaSel (Just Symbol "_icAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_icUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_icPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Invitation))) ((:*:) (S1 (MetaSel (Just Symbol "_icBearerToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_icCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))))

type Scopes InvitationsCreate

type Scopes InvitationsCreate = (:) Symbol "https://www.googleapis.com/auth/classroom.rosters" ([] Symbol)

type Rs InvitationsCreate

type Rs InvitationsCreate = Invitation

Request Lenses

icXgafv :: Lens' InvitationsCreate (Maybe Text)

V1 error format.

icUploadProtocol :: Lens' InvitationsCreate (Maybe Text)

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

icPp :: Lens' InvitationsCreate Bool

Pretty-print response.

icAccessToken :: Lens' InvitationsCreate (Maybe Text)

OAuth access token.

icUploadType :: Lens' InvitationsCreate (Maybe Text)

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

icPayload :: Lens' InvitationsCreate Invitation

Multipart request metadata.

icBearerToken :: Lens' InvitationsCreate (Maybe Text)

OAuth bearer token.

icCallback :: Lens' InvitationsCreate (Maybe Text)

JSONP