{-# 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.Script.Scripts.Run
-- Copyright   : (c) 2015-2025 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay <brendan.g.hay+gogol@gmail.com>
--               Toni Cebrián <toni@tonicebrian.com>
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
--
--
-- /See:/ <https://developers.google.com/apps-script/api/ Apps Script API Reference> for @script.scripts.run@.
module Gogol.Script.Scripts.Run
  ( -- * Resource
    ScriptScriptsRunResource,

    -- ** Constructing a Request
    ScriptScriptsRun (..),
    newScriptScriptsRun,
  )
where

import Gogol.Prelude qualified as Core
import Gogol.Script.Types

-- | A resource alias for @script.scripts.run@ method which the
-- 'ScriptScriptsRun' request conforms to.
type ScriptScriptsRunResource =
  "v1"
    Core.:> "scripts"
    Core.:> Core.CaptureMode "scriptId" "run" Core.Text
    Core.:> Core.QueryParam "$.xgafv" Xgafv
    Core.:> Core.QueryParam "access_token" Core.Text
    Core.:> Core.QueryParam "callback" 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] ExecutionRequest
    Core.:> Core.Post '[Core.JSON] Operation

--
-- /See:/ 'newScriptScriptsRun' smart constructor.
data ScriptScriptsRun = ScriptScriptsRun
  { -- | V1 error format.
    xgafv :: (Core.Maybe Xgafv),
    -- | OAuth access token.
    accessToken :: (Core.Maybe Core.Text),
    -- | JSONP
    callback :: (Core.Maybe Core.Text),
    -- | Multipart request metadata.
    payload :: ExecutionRequest,
    -- | The script ID of the script to be executed. Find the script ID on the __Project settings__ page under \"IDs.\" As multiple executable APIs can be deployed in new IDE for same script, this field should be populated with DeploymentID generated while deploying in new IDE instead of script ID.
    scriptId :: 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 'ScriptScriptsRun' with the minimum fields required to make a request.
newScriptScriptsRun ::
  -- |  Multipart request metadata. See 'payload'.
  ExecutionRequest ->
  -- |  The script ID of the script to be executed. Find the script ID on the __Project settings__ page under \"IDs.\" As multiple executable APIs can be deployed in new IDE for same script, this field should be populated with DeploymentID generated while deploying in new IDE instead of script ID. See 'scriptId'.
  Core.Text ->
  ScriptScriptsRun
newScriptScriptsRun payload scriptId =
  ScriptScriptsRun
    { xgafv = Core.Nothing,
      accessToken = Core.Nothing,
      callback = Core.Nothing,
      payload = payload,
      scriptId = scriptId,
      uploadType = Core.Nothing,
      uploadProtocol = Core.Nothing
    }

instance Core.GoogleRequest ScriptScriptsRun where
  type Rs ScriptScriptsRun = Operation
  type
    Scopes ScriptScriptsRun =
      '[ Gmail'FullControl,
         Calendar'Feeds'FullControl,
         M8'Feeds'FullControl,
         Admin'Directory'Group,
         Admin'Directory'User,
         Documents'FullControl,
         Drive'FullControl,
         Forms'FullControl,
         Forms'Currentonly,
         Groups'FullControl,
         Spreadsheets'FullControl,
         Userinfo'Email
       ]
  requestClient ScriptScriptsRun {..} =
    go
      scriptId
      xgafv
      accessToken
      callback
      uploadType
      uploadProtocol
      (Core.Just Core.AltJSON)
      payload
      scriptService
    where
      go =
        Core.buildClient
          (Core.Proxy :: Core.Proxy ScriptScriptsRunResource)
          Core.mempty