{-# LANGUAGE DataKinds #-}
{-# LANGUAGE DeriveDataTypeable #-}
{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE FlexibleInstances #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE TypeFamilies #-}
{-# LANGUAGE TypeOperators #-}
{-# OPTIONS_GHC -fno-warn-duplicate-exports #-}
{-# OPTIONS_GHC -fno-warn-unused-binds #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
module Network.Google.Resource.Classroom.Courses.Patch
(
CoursesPatchResource
, coursesPatch
, CoursesPatch
, cpXgafv
, cpUploadProtocol
, cpUpdateMask
, cpPp
, cpAccessToken
, cpUploadType
, cpPayload
, cpBearerToken
, cpId
, cpCallback
) where
import Network.Google.Classroom.Types
import Network.Google.Prelude
type CoursesPatchResource =
"v1" :>
"courses" :>
Capture "id" Text :>
QueryParam "$.xgafv" Text :>
QueryParam "upload_protocol" Text :>
QueryParam "updateMask" Text :>
QueryParam "pp" Bool :>
QueryParam "access_token" Text :>
QueryParam "uploadType" Text :>
QueryParam "bearer_token" Text :>
QueryParam "callback" Text :>
QueryParam "alt" AltJSON :>
ReqBody '[JSON] Course :> Patch '[JSON] Course
-- | Updates one or more fields in a course. This method returns the
-- following error codes: * \`PERMISSION_DENIED\` if the requesting user is
-- not permitted to modify the requested course or for access errors. *
-- \`NOT_FOUND\` if no course exists with the requested ID. *
-- \`INVALID_ARGUMENT\` if invalid fields are specified in the update mask
-- or if no update mask is supplied. * \`FAILED_PRECONDITION\` for the
-- following request errors: * CourseNotModifiable
--
-- /See:/ 'coursesPatch' smart constructor.
data CoursesPatch = CoursesPatch'
{ _cpXgafv :: !(Maybe Text)
, _cpUploadProtocol :: !(Maybe Text)
, _cpUpdateMask :: !(Maybe Text)
, _cpPp :: !Bool
, _cpAccessToken :: !(Maybe Text)
, _cpUploadType :: !(Maybe Text)
, _cpPayload :: !Course
, _cpBearerToken :: !(Maybe Text)
, _cpId :: !Text
, _cpCallback :: !(Maybe Text)
} deriving (Eq,Show,Data,Typeable,Generic)
-- | Creates a value of 'CoursesPatch' with the minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
-- * 'cpXgafv'
--
-- * 'cpUploadProtocol'
--
-- * 'cpUpdateMask'
--
-- * 'cpPp'
--
-- * 'cpAccessToken'
--
-- * 'cpUploadType'
--
-- * 'cpPayload'
--
-- * 'cpBearerToken'
--
-- * 'cpId'
--
-- * 'cpCallback'
coursesPatch
:: Course -- ^ 'cpPayload'
-> Text -- ^ 'cpId'
-> CoursesPatch
coursesPatch pCpPayload_ pCpId_ =
CoursesPatch'
{ _cpXgafv = Nothing
, _cpUploadProtocol = Nothing
, _cpUpdateMask = Nothing
, _cpPp = True
, _cpAccessToken = Nothing
, _cpUploadType = Nothing
, _cpPayload = pCpPayload_
, _cpBearerToken = Nothing
, _cpId = pCpId_
, _cpCallback = Nothing
}
-- | V1 error format.
cpXgafv :: Lens' CoursesPatch (Maybe Text)
cpXgafv = lens _cpXgafv (\ s a -> s{_cpXgafv = a})
-- | Upload protocol for media (e.g. \"raw\", \"multipart\").
cpUploadProtocol :: Lens' CoursesPatch (Maybe Text)
cpUploadProtocol
= lens _cpUploadProtocol
(\ s a -> s{_cpUploadProtocol = a})
-- | 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: * \`name\` * \`section\` *
-- \`descriptionHeading\` * \`description\` * \`room\` * \`courseState\`
-- When set in a query parameter, this field should be specified as
-- \`updateMask=,,...\`
cpUpdateMask :: Lens' CoursesPatch (Maybe Text)
cpUpdateMask
= lens _cpUpdateMask (\ s a -> s{_cpUpdateMask = a})
-- | Pretty-print response.
cpPp :: Lens' CoursesPatch Bool
cpPp = lens _cpPp (\ s a -> s{_cpPp = a})
-- | OAuth access token.
cpAccessToken :: Lens' CoursesPatch (Maybe Text)
cpAccessToken
= lens _cpAccessToken
(\ s a -> s{_cpAccessToken = a})
-- | Legacy upload protocol for media (e.g. \"media\", \"multipart\").
cpUploadType :: Lens' CoursesPatch (Maybe Text)
cpUploadType
= lens _cpUploadType (\ s a -> s{_cpUploadType = a})
-- | Multipart request metadata.
cpPayload :: Lens' CoursesPatch Course
cpPayload
= lens _cpPayload (\ s a -> s{_cpPayload = a})
-- | OAuth bearer token.
cpBearerToken :: Lens' CoursesPatch (Maybe Text)
cpBearerToken
= lens _cpBearerToken
(\ s a -> s{_cpBearerToken = a})
-- | Identifier of the course to update. This identifier can be either the
-- Classroom-assigned identifier or an alias.
cpId :: Lens' CoursesPatch Text
cpId = lens _cpId (\ s a -> s{_cpId = a})
-- | JSONP
cpCallback :: Lens' CoursesPatch (Maybe Text)
cpCallback
= lens _cpCallback (\ s a -> s{_cpCallback = a})
instance GoogleRequest CoursesPatch where
type Rs CoursesPatch = Course
type Scopes CoursesPatch =
'["https://www.googleapis.com/auth/classroom.courses"]
requestClient CoursesPatch'{..}
= go _cpId _cpXgafv _cpUploadProtocol _cpUpdateMask
(Just _cpPp)
_cpAccessToken
_cpUploadType
_cpBearerToken
_cpCallback
(Just AltJSON)
_cpPayload
classroomService
where go
= buildClient (Proxy :: Proxy CoursesPatchResource)
mempty