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.UserProFiles.Guardians.Delete

Contents

Description

Deletes a guardian. The guardian will no longer receive guardian notifications and the guardian will no longer be accessible via the API. This method returns the following error codes: * `PERMISSION_DENIED` if no user that matches the provided `student_id` is visible to the requesting user, if the requesting user is not permitted to manage guardians for the student identified by the `student_id`, if guardians are not enabled for the domain in question, or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API). * `NOT_FOUND` if the requesting user is permitted to modify guardians for the requested `student_id`, but no `Guardian` record exists for that student with the provided `guardian_id`.

See: Google Classroom API Reference for classroom.userProfiles.guardians.delete.

Synopsis

REST Resource

type UserProFilesGuardiansDeleteResource = "v1" :> ("userProfiles" :> (Capture "studentId" Text :> ("guardians" :> (Capture "guardianId" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Delete '[JSON] Empty)))))))))) Source #

A resource alias for classroom.userProfiles.guardians.delete method which the UserProFilesGuardiansDelete request conforms to.

Creating a Request

userProFilesGuardiansDelete Source #

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

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

data UserProFilesGuardiansDelete Source #

Deletes a guardian. The guardian will no longer receive guardian notifications and the guardian will no longer be accessible via the API. This method returns the following error codes: * `PERMISSION_DENIED` if no user that matches the provided `student_id` is visible to the requesting user, if the requesting user is not permitted to manage guardians for the student identified by the `student_id`, if guardians are not enabled for the domain in question, or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API). * `NOT_FOUND` if the requesting user is permitted to modify guardians for the requested `student_id`, but no `Guardian` record exists for that student with the provided `guardian_id`.

See: userProFilesGuardiansDelete smart constructor.

Instances
Eq UserProFilesGuardiansDelete Source # 
Instance details

Defined in Network.Google.Resource.Classroom.UserProFiles.Guardians.Delete

Data UserProFilesGuardiansDelete Source # 
Instance details

Defined in Network.Google.Resource.Classroom.UserProFiles.Guardians.Delete

Methods

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

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

toConstr :: UserProFilesGuardiansDelete -> Constr #

dataTypeOf :: UserProFilesGuardiansDelete -> DataType #

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

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

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

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

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

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

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

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

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

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

Show UserProFilesGuardiansDelete Source # 
Instance details

Defined in Network.Google.Resource.Classroom.UserProFiles.Guardians.Delete

Generic UserProFilesGuardiansDelete Source # 
Instance details

Defined in Network.Google.Resource.Classroom.UserProFiles.Guardians.Delete

Associated Types

type Rep UserProFilesGuardiansDelete :: Type -> Type #

GoogleRequest UserProFilesGuardiansDelete Source # 
Instance details

Defined in Network.Google.Resource.Classroom.UserProFiles.Guardians.Delete

type Rep UserProFilesGuardiansDelete Source # 
Instance details

Defined in Network.Google.Resource.Classroom.UserProFiles.Guardians.Delete

type Rep UserProFilesGuardiansDelete = D1 (MetaData "UserProFilesGuardiansDelete" "Network.Google.Resource.Classroom.UserProFiles.Guardians.Delete" "gogol-classroom-0.4.0-8aa8kYGMMJyCKn01TYMpOR" False) (C1 (MetaCons "UserProFilesGuardiansDelete'" PrefixI True) ((S1 (MetaSel (Just "_upfgdStudentId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: (S1 (MetaSel (Just "_upfgdXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :*: S1 (MetaSel (Just "_upfgdUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 (MetaSel (Just "_upfgdAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_upfgdUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_upfgdGuardianId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_upfgdCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Scopes UserProFilesGuardiansDelete Source # 
Instance details

Defined in Network.Google.Resource.Classroom.UserProFiles.Guardians.Delete

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

Defined in Network.Google.Resource.Classroom.UserProFiles.Guardians.Delete

Request Lenses

upfgdStudentId :: Lens' UserProFilesGuardiansDelete Text Source #

The student whose guardian is to be deleted. One of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user

upfgdUploadProtocol :: Lens' UserProFilesGuardiansDelete (Maybe Text) Source #

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

upfgdUploadType :: Lens' UserProFilesGuardiansDelete (Maybe Text) Source #

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

upfgdGuardianId :: Lens' UserProFilesGuardiansDelete Text Source #

The `id` field from a `Guardian`.