{-# LANGUAGE DataKinds #-} {-# LANGUAGE DerivingStrategies #-} {-# LANGUAGE DuplicateRecordFields #-} {-# LANGUAGE ImportQualifiedPost #-} {-# LANGUAGE LambdaCase #-} {-# LANGUAGE OverloadedStrings #-} {-# LANGUAGE PatternSynonyms #-} {-# LANGUAGE RecordWildCards #-} {-# LANGUAGE StrictData #-} {-# LANGUAGE TypeFamilies #-} {-# LANGUAGE NoImplicitPrelude #-} {-# OPTIONS_GHC -fno-warn-duplicate-exports #-} {-# OPTIONS_GHC -fno-warn-name-shadowing #-} {-# OPTIONS_GHC -fno-warn-unused-binds #-} {-# OPTIONS_GHC -fno-warn-unused-imports #-} {-# OPTIONS_GHC -fno-warn-unused-matches #-} -- | -- Module : Gogol.Classroom.Courses.Posts.AddOnAttachments.Create -- Copyright : (c) 2015-2025 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Toni Cebrián -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- -- Creates an add-on attachment under a post. Requires the add-on to have permission to create new attachments on the post. This method returns the following error codes: * @PERMISSION_DENIED@ for access errors. * @INVALID_ARGUMENT@ if the request is malformed. * @NOT_FOUND@ if one of the identified resources does not exist. -- -- /See:/ for @classroom.courses.posts.addOnAttachments.create@. module Gogol.Classroom.Courses.Posts.AddOnAttachments.Create ( -- * Resource ClassroomCoursesPostsAddOnAttachmentsCreateResource, -- ** Constructing a Request ClassroomCoursesPostsAddOnAttachmentsCreate (..), newClassroomCoursesPostsAddOnAttachmentsCreate, ) where import Gogol.Classroom.Types import Gogol.Prelude qualified as Core -- | A resource alias for @classroom.courses.posts.addOnAttachments.create@ method which the -- 'ClassroomCoursesPostsAddOnAttachmentsCreate' request conforms to. type ClassroomCoursesPostsAddOnAttachmentsCreateResource = "v1" Core.:> "courses" Core.:> Core.Capture "courseId" Core.Text Core.:> "posts" Core.:> Core.Capture "postId" Core.Text Core.:> "addOnAttachments" Core.:> Core.QueryParam "$.xgafv" Xgafv Core.:> Core.QueryParam "access_token" Core.Text Core.:> Core.QueryParam "addOnToken" Core.Text Core.:> Core.QueryParam "callback" Core.Text Core.:> Core.QueryParam "itemId" Core.Text Core.:> Core.QueryParam "uploadType" Core.Text Core.:> Core.QueryParam "upload_protocol" Core.Text Core.:> Core.QueryParam "alt" Core.AltJSON Core.:> Core.ReqBody '[Core.JSON] AddOnAttachment Core.:> Core.Post '[Core.JSON] AddOnAttachment -- | Creates an add-on attachment under a post. Requires the add-on to have permission to create new attachments on the post. This method returns the following error codes: * @PERMISSION_DENIED@ for access errors. * @INVALID_ARGUMENT@ if the request is malformed. * @NOT_FOUND@ if one of the identified resources does not exist. -- -- /See:/ 'newClassroomCoursesPostsAddOnAttachmentsCreate' smart constructor. data ClassroomCoursesPostsAddOnAttachmentsCreate = ClassroomCoursesPostsAddOnAttachmentsCreate { -- | V1 error format. xgafv :: (Core.Maybe Xgafv), -- | OAuth access token. accessToken :: (Core.Maybe Core.Text), -- | Optional. Token that authorizes the request. The token is passed as a query parameter when the user is redirected from Classroom to the add-on\'s URL. This authorization token is required for in-Classroom attachment creation but optional for partner-first attachment creation. Returns an error if not provided for partner-first attachment creation and the developer projects that created the attachment and its parent stream item do not match. addOnToken :: (Core.Maybe Core.Text), -- | JSONP callback :: (Core.Maybe Core.Text), -- | Required. Identifier of the course. courseId :: Core.Text, -- | Identifier of the @Announcement@, @CourseWork@, or @CourseWorkMaterial@ under which to create the attachment. This field is required, but is not marked as such while we are migrating from post_id. itemId :: (Core.Maybe Core.Text), -- | Multipart request metadata. payload :: AddOnAttachment, -- | Optional. Deprecated, use @item_id@ instead. postId :: Core.Text, -- | Legacy upload protocol for media (e.g. \"media\", \"multipart\"). uploadType :: (Core.Maybe Core.Text), -- | Upload protocol for media (e.g. \"raw\", \"multipart\"). uploadProtocol :: (Core.Maybe Core.Text) } deriving (Core.Eq, Core.Show, Core.Generic) -- | Creates a value of 'ClassroomCoursesPostsAddOnAttachmentsCreate' with the minimum fields required to make a request. newClassroomCoursesPostsAddOnAttachmentsCreate :: -- | Required. Identifier of the course. See 'courseId'. Core.Text -> -- | Multipart request metadata. See 'payload'. AddOnAttachment -> -- | Optional. Deprecated, use @item_id@ instead. See 'postId'. Core.Text -> ClassroomCoursesPostsAddOnAttachmentsCreate newClassroomCoursesPostsAddOnAttachmentsCreate courseId payload postId = ClassroomCoursesPostsAddOnAttachmentsCreate { xgafv = Core.Nothing, accessToken = Core.Nothing, addOnToken = Core.Nothing, callback = Core.Nothing, courseId = courseId, itemId = Core.Nothing, payload = payload, postId = postId, uploadType = Core.Nothing, uploadProtocol = Core.Nothing } instance Core.GoogleRequest ClassroomCoursesPostsAddOnAttachmentsCreate where type Rs ClassroomCoursesPostsAddOnAttachmentsCreate = AddOnAttachment type Scopes ClassroomCoursesPostsAddOnAttachmentsCreate = '[Classroom'Addons'Teacher] requestClient ClassroomCoursesPostsAddOnAttachmentsCreate {..} = go courseId postId xgafv accessToken addOnToken callback itemId uploadType uploadProtocol (Core.Just Core.AltJSON) payload classroomService where go = Core.buildClient ( Core.Proxy :: Core.Proxy ClassroomCoursesPostsAddOnAttachmentsCreateResource ) Core.mempty