Network.Google.Resource.Classroom.UserProFiles.GuardianInvitations.Create

Creates a guardian invitation, and sends an email to the guardian asking them to confirm that they are the student's guardian. Once the guardian accepts the invitation, their `state` will change to `COMPLETED` and they will start receiving guardian notifications. A `Guardian` resource will also be created to represent the active guardian. The request object must have the `student_id` and `invited_email_address` fields set. Failing to set these fields, or setting any other fields in the request, will result in an error. This method returns the following error codes: * `PERMISSION_DENIED` if the current user does not have permission to manage guardians, if the guardian in question has already rejected too many requests for that student, if guardians are not enabled for the domain in question, or for other access errors. * `RESOURCE_EXHAUSTED` if the student or guardian has exceeded the guardian link limit. * `INVALID_ARGUMENT` if the guardian email address is not valid (for example, if it is too long), or if the format of the student ID provided cannot be recognized (it is not an email address, nor a `user_id` from this API). This error will also be returned if read-only fields are set, or if the `state` field is set to to a value other than `PENDING`. * `NOT_FOUND` if the student ID provided is a valid student ID, but Classroom has no record of that student. * `ALREADY_EXISTS` if there is already a pending guardian invitation for the student and `invited_email_address` provided, or if the provided `invited_email_address` matches the Google account of an existing `Guardian` for this user.

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

REST Resource

type UserProFilesGuardianInvitationsCreateResource = "v1" :> ("userProfiles" :> (Capture "studentId" Text :> ("guardianInvitations" :> (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] GuardianInvitation :> Post '[JSON] GuardianInvitation))))))))))))

A resource alias for classroom.userProfiles.guardianInvitations.create method which the UserProFilesGuardianInvitationsCreate request conforms to.

Creating a Request

userProFilesGuardianInvitationsCreate

Arguments

:: Text

upfgicStudentId

-> GuardianInvitation

upfgicPayload

-> UserProFilesGuardianInvitationsCreate

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

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

• upfgicStudentId
• upfgicXgafv
• upfgicUploadProtocol
• upfgicPp
• upfgicAccessToken
• upfgicUploadType
• upfgicPayload
• upfgicBearerToken
• upfgicCallback

data UserProFilesGuardianInvitationsCreate

Creates a guardian invitation, and sends an email to the guardian asking them to confirm that they are the student's guardian. Once the guardian accepts the invitation, their `state` will change to `COMPLETED` and they will start receiving guardian notifications. A `Guardian` resource will also be created to represent the active guardian. The request object must have the `student_id` and `invited_email_address` fields set. Failing to set these fields, or setting any other fields in the request, will result in an error. This method returns the following error codes: * `PERMISSION_DENIED` if the current user does not have permission to manage guardians, if the guardian in question has already rejected too many requests for that student, if guardians are not enabled for the domain in question, or for other access errors. * `RESOURCE_EXHAUSTED` if the student or guardian has exceeded the guardian link limit. * `INVALID_ARGUMENT` if the guardian email address is not valid (for example, if it is too long), or if the format of the student ID provided cannot be recognized (it is not an email address, nor a `user_id` from this API). This error will also be returned if read-only fields are set, or if the `state` field is set to to a value other than `PENDING`. * `NOT_FOUND` if the student ID provided is a valid student ID, but Classroom has no record of that student. * `ALREADY_EXISTS` if there is already a pending guardian invitation for the student and `invited_email_address` provided, or if the provided `invited_email_address` matches the Google account of an existing `Guardian` for this user.

See: userProFilesGuardianInvitationsCreate smart constructor.

Instances

Eq UserProFilesGuardianInvitationsCreate

Methods

(==) :: UserProFilesGuardianInvitationsCreate -> UserProFilesGuardianInvitationsCreate -> Bool

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

Data UserProFilesGuardianInvitationsCreate

Methods

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

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

toConstr :: UserProFilesGuardianInvitationsCreate -> Constr

dataTypeOf :: UserProFilesGuardianInvitationsCreate -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c UserProFilesGuardianInvitationsCreate)

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

gmapT :: (forall b. Data b => b -> b) -> UserProFilesGuardianInvitationsCreate -> UserProFilesGuardianInvitationsCreate

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

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

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

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

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

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

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

Show UserProFilesGuardianInvitationsCreate

Methods

showsPrec :: Int -> UserProFilesGuardianInvitationsCreate -> ShowS

show :: UserProFilesGuardianInvitationsCreate -> String

showList :: [UserProFilesGuardianInvitationsCreate] -> ShowS

Generic UserProFilesGuardianInvitationsCreate

Associated Types

type Rep UserProFilesGuardianInvitationsCreate :: * -> *

Methods

from :: UserProFilesGuardianInvitationsCreate -> Rep UserProFilesGuardianInvitationsCreate x

to :: Rep UserProFilesGuardianInvitationsCreate x -> UserProFilesGuardianInvitationsCreate

GoogleRequest UserProFilesGuardianInvitationsCreate

Associated Types

type Rs UserProFilesGuardianInvitationsCreate :: *

type Scopes UserProFilesGuardianInvitationsCreate :: [Symbol]

Methods

requestClient :: UserProFilesGuardianInvitationsCreate -> Client (Rs UserProFilesGuardianInvitationsCreate)

type Rep UserProFilesGuardianInvitationsCreate

type Rep UserProFilesGuardianInvitationsCreate = D1 (MetaData "UserProFilesGuardianInvitationsCreate" "Network.Google.Resource.Classroom.UserProFiles.GuardianInvitations.Create" "gogol-classroom-0.3.0-Euho0DOVp7IFBMFcN4kr1b" False) (C1 (MetaCons "UserProFilesGuardianInvitationsCreate'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_upfgicStudentId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_upfgicXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_upfgicUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_upfgicPp") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool)))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_upfgicAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_upfgicUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_upfgicPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 GuardianInvitation)) ((:*:) (S1 (MetaSel (Just Symbol "_upfgicBearerToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_upfgicCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))))

type Scopes UserProFilesGuardianInvitationsCreate

type Scopes UserProFilesGuardianInvitationsCreate = [] Symbol

type Rs UserProFilesGuardianInvitationsCreate

type Rs UserProFilesGuardianInvitationsCreate = GuardianInvitation

Request Lenses

upfgicStudentId :: Lens' UserProFilesGuardianInvitationsCreate Text

ID of the student (in standard format)

upfgicXgafv :: Lens' UserProFilesGuardianInvitationsCreate (Maybe Text)

V1 error format.

upfgicUploadProtocol :: Lens' UserProFilesGuardianInvitationsCreate (Maybe Text)

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

upfgicPp :: Lens' UserProFilesGuardianInvitationsCreate Bool

Pretty-print response.

upfgicAccessToken :: Lens' UserProFilesGuardianInvitationsCreate (Maybe Text)

OAuth access token.

upfgicUploadType :: Lens' UserProFilesGuardianInvitationsCreate (Maybe Text)

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

upfgicPayload :: Lens' UserProFilesGuardianInvitationsCreate GuardianInvitation

Multipart request metadata.

upfgicBearerToken :: Lens' UserProFilesGuardianInvitationsCreate (Maybe Text)

OAuth bearer token.

upfgicCallback :: Lens' UserProFilesGuardianInvitationsCreate (Maybe Text)

JSONP