gogol-classroom-0.4.0: Google Classroom SDK.

Copyright(c) 2015-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.Google.Resource.Classroom.Courses.Update

Contents

Description

Updates a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID. * `FAILED_PRECONDITION` for the following request errors: * CourseNotModifiable

See: Google Classroom API Reference for classroom.courses.update.

Synopsis

REST Resource

type CoursesUpdateResource = "v1" :> ("courses" :> (Capture "id" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] Course :> Put '[JSON] Course))))))))) Source #

A resource alias for classroom.courses.update method which the CoursesUpdate request conforms to.

Creating a Request

coursesUpdate Source #

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

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

data CoursesUpdate Source #

Updates a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID. * `FAILED_PRECONDITION` for the following request errors: * CourseNotModifiable

See: coursesUpdate smart constructor.

Instances
Eq CoursesUpdate Source # 
Instance details

Defined in Network.Google.Resource.Classroom.Courses.Update

Data CoursesUpdate Source # 
Instance details

Defined in Network.Google.Resource.Classroom.Courses.Update

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CoursesUpdate -> c CoursesUpdate #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CoursesUpdate #

toConstr :: CoursesUpdate -> Constr #

dataTypeOf :: CoursesUpdate -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CoursesUpdate) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CoursesUpdate) #

gmapT :: (forall b. Data b => b -> b) -> CoursesUpdate -> CoursesUpdate #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CoursesUpdate -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CoursesUpdate -> r #

gmapQ :: (forall d. Data d => d -> u) -> CoursesUpdate -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> CoursesUpdate -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CoursesUpdate -> m CoursesUpdate #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CoursesUpdate -> m CoursesUpdate #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CoursesUpdate -> m CoursesUpdate #

Show CoursesUpdate Source # 
Instance details

Defined in Network.Google.Resource.Classroom.Courses.Update

Generic CoursesUpdate Source # 
Instance details

Defined in Network.Google.Resource.Classroom.Courses.Update

Associated Types

type Rep CoursesUpdate :: Type -> Type #

GoogleRequest CoursesUpdate Source # 
Instance details

Defined in Network.Google.Resource.Classroom.Courses.Update

Associated Types

type Rs CoursesUpdate :: Type #

type Scopes CoursesUpdate :: [Symbol] #

type Rep CoursesUpdate Source # 
Instance details

Defined in Network.Google.Resource.Classroom.Courses.Update

type Rep CoursesUpdate = D1 (MetaData "CoursesUpdate" "Network.Google.Resource.Classroom.Courses.Update" "gogol-classroom-0.4.0-8aa8kYGMMJyCKn01TYMpOR" False) (C1 (MetaCons "CoursesUpdate'" PrefixI True) ((S1 (MetaSel (Just "_cuXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :*: (S1 (MetaSel (Just "_cuUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_cuAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 (MetaSel (Just "_cuUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_cuPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Course)) :*: (S1 (MetaSel (Just "_cuId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_cuCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Scopes CoursesUpdate Source # 
Instance details

Defined in Network.Google.Resource.Classroom.Courses.Update

type Scopes CoursesUpdate = "https://www.googleapis.com/auth/classroom.courses" ': ([] :: [Symbol])
type Rs CoursesUpdate Source # 
Instance details

Defined in Network.Google.Resource.Classroom.Courses.Update

Request Lenses

cuUploadProtocol :: Lens' CoursesUpdate (Maybe Text) Source #

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

cuUploadType :: Lens' CoursesUpdate (Maybe Text) Source #

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

cuPayload :: Lens' CoursesUpdate Course Source #

Multipart request metadata.

cuId :: Lens' CoursesUpdate Text Source #

Identifier of the course to update. This identifier can be either the Classroom-assigned identifier or an alias.