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

Contents

REST Resource
Creating a Request
Request Lenses

Description

Creates an alias for a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create the alias or for access errors. * `NOT_FOUND` if the course does not exist. * `ALREADY_EXISTS` if the alias already exists. * `FAILED_PRECONDITION` if the alias requested does not make sense for the requesting user or course (for example, if a user not in a domain attempts to access a domain-scoped alias).

See: Google Classroom API Reference for classroom.courses.aliases.create.

Synopsis

type CoursesAliasesCreateResource = "v1" :> ("courses" :> (Capture "courseId" Text :> ("aliases" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] CourseAlias :> Post '[JSON] CourseAlias))))))))))
coursesAliasesCreate :: Text -> CourseAlias -> CoursesAliasesCreate
data CoursesAliasesCreate
cacXgafv :: Lens' CoursesAliasesCreate (Maybe Xgafv)
cacUploadProtocol :: Lens' CoursesAliasesCreate (Maybe Text)
cacCourseId :: Lens' CoursesAliasesCreate Text
cacAccessToken :: Lens' CoursesAliasesCreate (Maybe Text)
cacUploadType :: Lens' CoursesAliasesCreate (Maybe Text)
cacPayload :: Lens' CoursesAliasesCreate CourseAlias
cacCallback :: Lens' CoursesAliasesCreate (Maybe Text)

REST Resource

type CoursesAliasesCreateResource = "v1" :> ("courses" :> (Capture "courseId" Text :> ("aliases" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] CourseAlias :> Post '[JSON] CourseAlias)))))))))) Source #

A resource alias for classroom.courses.aliases.create method which the CoursesAliasesCreate request conforms to.

Creating a Request

coursesAliasesCreate Source #

Arguments

:: Text	`cacCourseId`
-> CourseAlias	`cacPayload`
-> CoursesAliasesCreate

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

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

data CoursesAliasesCreate Source #

Creates an alias for a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create the alias or for access errors. * `NOT_FOUND` if the course does not exist. * `ALREADY_EXISTS` if the alias already exists. * `FAILED_PRECONDITION` if the alias requested does not make sense for the requesting user or course (for example, if a user not in a domain attempts to access a domain-scoped alias).

See: coursesAliasesCreate smart constructor.

Instances

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

Request Lenses

cacXgafv :: Lens' CoursesAliasesCreate (Maybe Xgafv) Source #

V1 error format.

cacUploadProtocol :: Lens' CoursesAliasesCreate (Maybe Text) Source #

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

cacCourseId :: Lens' CoursesAliasesCreate Text Source #

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

cacAccessToken :: Lens' CoursesAliasesCreate (Maybe Text) Source #

OAuth access token.

cacUploadType :: Lens' CoursesAliasesCreate (Maybe Text) Source #

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

cacPayload :: Lens' CoursesAliasesCreate CourseAlias Source #

Multipart request metadata.

cacCallback :: Lens' CoursesAliasesCreate (Maybe Text) Source #

JSONP