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.GuardianInvitations.Patch

Contents

Description

Modifies a guardian invitation. Currently, the only valid modification is to change the `state` from `PENDING` to `COMPLETE`. This has the effect of withdrawing the invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the current user does not have permission to manage guardians, if guardians are not enabled for the domain in question or for other access errors. * `FAILED_PRECONDITION` if the guardian link is not in the `PENDING` state. * `INVALID_ARGUMENT` if the format of the student ID provided cannot be recognized (it is not an email address, nor a `user_id` from this API), or if the passed `GuardianInvitation` has a `state` other than `COMPLETE`, or if it modifies fields other than `state`. * `NOT_FOUND` if the student ID provided is a valid student ID, but Classroom has no record of that student, or if the `id` field does not refer to a guardian invitation known to Classroom.

See: Google Classroom API Reference for classroom.userProfiles.guardianInvitations.patch.

Synopsis

REST Resource

type UserProFilesGuardianInvitationsPatchResource = "v1" :> ("userProfiles" :> (Capture "studentId" Text :> ("guardianInvitations" :> (Capture "invitationId" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "updateMask" GFieldMask :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] GuardianInvitation :> Patch '[JSON] GuardianInvitation)))))))))))) Source #

A resource alias for classroom.userProfiles.guardianInvitations.patch method which the UserProFilesGuardianInvitationsPatch request conforms to.

Creating a Request

data UserProFilesGuardianInvitationsPatch Source #

Modifies a guardian invitation. Currently, the only valid modification is to change the `state` from `PENDING` to `COMPLETE`. This has the effect of withdrawing the invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the current user does not have permission to manage guardians, if guardians are not enabled for the domain in question or for other access errors. * `FAILED_PRECONDITION` if the guardian link is not in the `PENDING` state. * `INVALID_ARGUMENT` if the format of the student ID provided cannot be recognized (it is not an email address, nor a `user_id` from this API), or if the passed `GuardianInvitation` has a `state` other than `COMPLETE`, or if it modifies fields other than `state`. * `NOT_FOUND` if the student ID provided is a valid student ID, but Classroom has no record of that student, or if the `id` field does not refer to a guardian invitation known to Classroom.

See: userProFilesGuardianInvitationsPatch smart constructor.

Instances
Eq UserProFilesGuardianInvitationsPatch Source # 
Instance details

Defined in Network.Google.Resource.Classroom.UserProFiles.GuardianInvitations.Patch

Data UserProFilesGuardianInvitationsPatch Source # 
Instance details

Defined in Network.Google.Resource.Classroom.UserProFiles.GuardianInvitations.Patch

Methods

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

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

toConstr :: UserProFilesGuardianInvitationsPatch -> Constr #

dataTypeOf :: UserProFilesGuardianInvitationsPatch -> DataType #

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

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

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

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

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

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

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

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

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

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

Show UserProFilesGuardianInvitationsPatch Source # 
Instance details

Defined in Network.Google.Resource.Classroom.UserProFiles.GuardianInvitations.Patch

Generic UserProFilesGuardianInvitationsPatch Source # 
Instance details

Defined in Network.Google.Resource.Classroom.UserProFiles.GuardianInvitations.Patch

GoogleRequest UserProFilesGuardianInvitationsPatch Source # 
Instance details

Defined in Network.Google.Resource.Classroom.UserProFiles.GuardianInvitations.Patch

type Rep UserProFilesGuardianInvitationsPatch Source # 
Instance details

Defined in Network.Google.Resource.Classroom.UserProFiles.GuardianInvitations.Patch

type Rep UserProFilesGuardianInvitationsPatch = D1 (MetaData "UserProFilesGuardianInvitationsPatch" "Network.Google.Resource.Classroom.UserProFiles.GuardianInvitations.Patch" "gogol-classroom-0.4.0-8aa8kYGMMJyCKn01TYMpOR" False) (C1 (MetaCons "UserProFilesGuardianInvitationsPatch'" PrefixI True) (((S1 (MetaSel (Just "_upfgipStudentId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_upfgipXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv))) :*: (S1 (MetaSel (Just "_upfgipUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_upfgipUpdateMask") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe GFieldMask)))) :*: ((S1 (MetaSel (Just "_upfgipAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_upfgipUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_upfgipPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 GuardianInvitation) :*: (S1 (MetaSel (Just "_upfgipInvitationId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_upfgipCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))))
type Scopes UserProFilesGuardianInvitationsPatch Source # 
Instance details

Defined in Network.Google.Resource.Classroom.UserProFiles.GuardianInvitations.Patch

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

Defined in Network.Google.Resource.Classroom.UserProFiles.GuardianInvitations.Patch

Request Lenses

upfgipStudentId :: Lens' UserProFilesGuardianInvitationsPatch Text Source #

The ID of the student whose guardian invitation is to be modified.

upfgipUploadProtocol :: Lens' UserProFilesGuardianInvitationsPatch (Maybe Text) Source #

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

upfgipUpdateMask :: Lens' UserProFilesGuardianInvitationsPatch (Maybe GFieldMask) Source #

Mask that identifies which fields on the course to update. This field is required to do an update. The update will fail if invalid fields are specified. The following fields are valid: * `state` When set in a query parameter, this field should be specified as `updateMask=,,...`

upfgipUploadType :: Lens' UserProFilesGuardianInvitationsPatch (Maybe Text) Source #

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

upfgipInvitationId :: Lens' UserProFilesGuardianInvitationsPatch Text Source #

The `id` field of the `GuardianInvitation` to be modified.