gogol-classroom

Copyright	(c) 2015-2025 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <[email protected]> Toni Cebrián <[email protected]>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	GHC2021

Gogol.Classroom.Registrations.Delete

Contents

Resource
- Constructing a Request

Description

Deletes a Registration, causing Classroom to stop sending notifications for that Registration.

See: Google Classroom API Reference for classroom.registrations.delete.

Synopsis

type ClassroomRegistrationsDeleteResource = "v1" :> ("registrations" :> (Capture "registrationId" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "access_token" Text :> (QueryParam "callback" Text :> (QueryParam "uploadType" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "alt" AltJSON :> Delete '[JSON] Empty))))))))
data ClassroomRegistrationsDelete = ClassroomRegistrationsDelete {
- xgafv :: Maybe Xgafv
- accessToken :: Maybe Text
- callback :: Maybe Text
- registrationId :: Text
- uploadType :: Maybe Text
- uploadProtocol :: Maybe Text
}
newClassroomRegistrationsDelete :: Text -> ClassroomRegistrationsDelete

Resource

type ClassroomRegistrationsDeleteResource = "v1" :> ("registrations" :> (Capture "registrationId" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "access_token" Text :> (QueryParam "callback" Text :> (QueryParam "uploadType" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "alt" AltJSON :> Delete '[JSON] Empty)))))))) Source #

A resource alias for classroom.registrations.delete method which the ClassroomRegistrationsDelete request conforms to.

Constructing a Request

data ClassroomRegistrationsDelete Source #

Deletes a Registration, causing Classroom to stop sending notifications for that Registration.

See: newClassroomRegistrationsDelete smart constructor.

Constructors

ClassroomRegistrationsDelete
Fields xgafv :: Maybe Xgafv V1 error format. accessToken :: Maybe Text OAuth access token. callback :: Maybe Text JSONP registrationId :: Text The `registration_id` of the `Registration` to be deleted. uploadType :: Maybe Text Legacy upload protocol for media (e.g. "media", "multipart"). uploadProtocol :: Maybe Text Upload protocol for media (e.g. "raw", "multipart").

Instances

Instances details

Generic ClassroomRegistrationsDelete Source #

Instance details

Defined in Gogol.Classroom.Registrations.Delete

Associated Types

type Rep ClassroomRegistrationsDelete

Instance details

Defined in Gogol.Classroom.Registrations.Delete

type Rep ClassroomRegistrationsDelete = D1 ('MetaData "ClassroomRegistrationsDelete" "Gogol.Classroom.Registrations.Delete" "gogol-classroom-1.0.0-E0l1a33tlucKcuM1xSJBzt" 'False) (C1 ('MetaCons "ClassroomRegistrationsDelete" 'PrefixI 'True) ((S1 ('MetaSel ('Just "xgafv") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Xgafv)) :*: (S1 ('MetaSel ('Just "accessToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "callback") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "registrationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "uploadType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "uploadProtocol") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

Methods

from :: ClassroomRegistrationsDelete -> Rep ClassroomRegistrationsDelete x #

to :: Rep ClassroomRegistrationsDelete x -> ClassroomRegistrationsDelete #

Show ClassroomRegistrationsDelete Source #

Instance details

Defined in Gogol.Classroom.Registrations.Delete

Methods

showsPrec :: Int -> ClassroomRegistrationsDelete -> ShowS #

show :: ClassroomRegistrationsDelete -> String #

showList :: [ClassroomRegistrationsDelete] -> ShowS #

Eq ClassroomRegistrationsDelete Source #

Instance details

Defined in Gogol.Classroom.Registrations.Delete

Methods

(==) :: ClassroomRegistrationsDelete -> ClassroomRegistrationsDelete -> Bool #

(/=) :: ClassroomRegistrationsDelete -> ClassroomRegistrationsDelete -> Bool #

GoogleRequest ClassroomRegistrationsDelete Source #

Instance details

Defined in Gogol.Classroom.Registrations.Delete

Associated Types

type Rs ClassroomRegistrationsDelete
Instance details Defined in Gogol.Classroom.Registrations.Delete type Rs ClassroomRegistrationsDelete = Empty
type Scopes ClassroomRegistrationsDelete
Instance details Defined in Gogol.Classroom.Registrations.Delete type Scopes ClassroomRegistrationsDelete = '[Classroom'PushNotifications]

Methods

requestClient :: ClassroomRegistrationsDelete -> GClient (Rs ClassroomRegistrationsDelete) #

type Rep ClassroomRegistrationsDelete Source #

Instance details

Defined in Gogol.Classroom.Registrations.Delete

type Rep ClassroomRegistrationsDelete = D1 ('MetaData "ClassroomRegistrationsDelete" "Gogol.Classroom.Registrations.Delete" "gogol-classroom-1.0.0-E0l1a33tlucKcuM1xSJBzt" 'False) (C1 ('MetaCons "ClassroomRegistrationsDelete" 'PrefixI 'True) ((S1 ('MetaSel ('Just "xgafv") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Xgafv)) :*: (S1 ('MetaSel ('Just "accessToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "callback") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "registrationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "uploadType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "uploadProtocol") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

type Rs ClassroomRegistrationsDelete Source #

Instance details

Defined in Gogol.Classroom.Registrations.Delete

type Rs ClassroomRegistrationsDelete = Empty

type Scopes ClassroomRegistrationsDelete Source #

Instance details

Defined in Gogol.Classroom.Registrations.Delete

type Scopes ClassroomRegistrationsDelete = '[Classroom'PushNotifications]

newClassroomRegistrationsDelete Source #

Arguments

:: Text	The `registration_id` of the `Registration` to be deleted. See `registrationId`.
-> ClassroomRegistrationsDelete

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