# LANGUAGE DataKinds #
# LANGUAGE DeriveGeneric #
# LANGUAGE DerivingStrategies #
# LANGUAGE DuplicateRecordFields #
# LANGUAGE FlexibleInstances #
# LANGUAGE GeneralizedNewtypeDeriving #
# LANGUAGE LambdaCase #
{-# LANGUAGE OverloadedStrings #-}
# LANGUAGE PatternSynonyms #
# LANGUAGE RecordWildCards #
{-# LANGUAGE StrictData #-}
# LANGUAGE TypeFamilies #
# LANGUAGE TypeOperators #
# 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       :  . YouTube . Captions . Insert
  Copyright    : ( c ) 2015 - 2022  
  License      : Mozilla Public License , v. 2.0 .
  Maintainer   :   < brendan.g.hay+ >
-- Stability   : auto-generated
  Portability : non - portable ( GHC extensions )
--
-- Inserts a new resource into this collection.
--
-- /See:/ </ YouTube Data API v3 Reference> for @youtube.captions.insert@.
module Gogol.YouTube.Captions.Insert
  ( -- * Resource
    YouTubeCaptionsInsertResource,

    -- ** Constructing a Request
    YouTubeCaptionsInsert (..),
    newYouTubeCaptionsInsert,
  )
where

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

-- | A resource alias for @youtube.captions.insert@ method which the
-- 'YouTubeCaptionsInsert' request conforms to.
type YouTubeCaptionsInsertResource =
  "youtube"
    Core.:> "v3"
    Core.:> "captions"
    Core.:> Core.QueryParams "part" Core.Text
    Core.:> Core.QueryParam "$.xgafv" Xgafv
    Core.:> Core.QueryParam "access_token" Core.Text
    Core.:> Core.QueryParam "callback" Core.Text
    Core.:> Core.QueryParam "onBehalfOf" Core.Text
    Core.:> Core.QueryParam "onBehalfOfContentOwner" Core.Text
    Core.:> Core.QueryParam "sync" Core.Bool
    Core.:> Core.QueryParam "uploadType" Core.Text
    Core.:> Core.QueryParam "upload_protocol" Core.Text
    Core.:> Core.QueryParam "alt" Core.AltJSON
    Core.:> Core.ReqBody '[Core.JSON] Caption
    Core.:> Core.Post '[Core.JSON] Caption
    Core.:<|> "upload"
      Core.:> "youtube"
      Core.:> "v3"
      Core.:> "captions"
      Core.:> Core.QueryParams "part" Core.Text
      Core.:> Core.QueryParam "$.xgafv" Xgafv
      Core.:> Core.QueryParam "access_token" Core.Text
      Core.:> Core.QueryParam "callback" Core.Text
      Core.:> Core.QueryParam "onBehalfOf" Core.Text
      Core.:> Core.QueryParam "onBehalfOfContentOwner" Core.Text
      Core.:> Core.QueryParam "sync" Core.Bool
      Core.:> Core.QueryParam "uploadType" Core.Text
      Core.:> Core.QueryParam "upload_protocol" Core.Text
      Core.:> Core.QueryParam "alt" Core.AltJSON
      Core.:> Core.QueryParam "uploadType" Core.Multipart
      Core.:> Core.MultipartRelated '[Core.JSON] Caption
      Core.:> Core.Post '[Core.JSON] Caption

-- | Inserts a new resource into this collection.
--
-- /See:/ 'newYouTubeCaptionsInsert' smart constructor.
data YouTubeCaptionsInsert = YouTubeCaptionsInsert
  { -- | V1 error format.
    xgafv :: (Core.Maybe Xgafv),
    -- | OAuth access token.
    accessToken :: (Core.Maybe Core.Text),
  | JSONP
    callback :: (Core.Maybe Core.Text),
    -- | ID of the Google+ Page for the channel that the request is be on behalf of
    onBehalfOf :: (Core.Maybe Core.Text),
  | /Note:/ This parameter is intended exclusively for YouTube content partners . The /onBehalfOfContentOwner/ parameter indicates that the request\ 's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value . This parameter is intended for YouTube content partners that own and manage many different YouTube channels . It allows content owners to authenticate once and get access to all their video and channel data , without having to provide authentication credentials for each individual channel . The actual CMS account that the user authenticates with must be linked to the specified YouTube content owner .
    onBehalfOfContentOwner :: (Core.Maybe Core.Text),
    -- | The /part/ parameter specifies the caption resource parts that the API response will include. Set the parameter value to snippet.
    part :: [Core.Text],
    -- | Multipart request metadata.
    payload :: Caption,
    -- | Extra parameter to allow automatically syncing the uploaded caption\/transcript with the audio.
    sync :: (Core.Maybe Core.Bool),
  | 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 'YouTubeCaptionsInsert' with the minimum fields required to make a request.
newYouTubeCaptionsInsert ::
  -- |  The /part/ parameter specifies the caption resource parts that the API response will include. Set the parameter value to snippet. See 'part'.
  [Core.Text] ->
  -- |  Multipart request metadata. See 'payload'.
  Caption ->
  YouTubeCaptionsInsert
newYouTubeCaptionsInsert part payload =
  YouTubeCaptionsInsert
    { xgafv = Core.Nothing,
      accessToken = Core.Nothing,
      callback = Core.Nothing,
      onBehalfOf = Core.Nothing,
      onBehalfOfContentOwner = Core.Nothing,
      part = part,
      payload = payload,
      sync = Core.Nothing,
      uploadType = Core.Nothing,
      uploadProtocol = Core.Nothing
    }

instance Core.GoogleRequest YouTubeCaptionsInsert where
  type Rs YouTubeCaptionsInsert = Caption
  type
    Scopes YouTubeCaptionsInsert =
      '[Youtube'ForceSsl, Youtubepartner'FullControl]
  requestClient YouTubeCaptionsInsert {..} =
    go
      part
      xgafv
      accessToken
      callback
      onBehalfOf
      onBehalfOfContentOwner
      sync
      uploadType
      uploadProtocol
      (Core.Just Core.AltJSON)
      payload
      youTubeService
    where
      go Core.:<|> _ =
        Core.buildClient
          ( Core.Proxy ::
              Core.Proxy YouTubeCaptionsInsertResource
          )
          Core.mempty

instance
  Core.GoogleRequest
    (Core.MediaUpload YouTubeCaptionsInsert)
  where
  type
    Rs (Core.MediaUpload YouTubeCaptionsInsert) =
      Caption
  type
    Scopes (Core.MediaUpload YouTubeCaptionsInsert) =
      Core.Scopes YouTubeCaptionsInsert
  requestClient
    (Core.MediaUpload YouTubeCaptionsInsert {..} body) =
      go
        part
        xgafv
        accessToken
        callback
        onBehalfOf
        onBehalfOfContentOwner
        sync
        uploadType
        uploadProtocol
        (Core.Just Core.AltJSON)
        (Core.Just Core.Multipart)
        payload
        body
        youTubeService
      where
        _ Core.:<|> go =
          Core.buildClient
            ( Core.Proxy ::
                Core.Proxy YouTubeCaptionsInsertResource
            )
            Core.mempty

# LANGUAGE OverloadedStrings #
# LANGUAGE StrictData #
 |
 Stability   : auto-generated

 Inserts a new resource into this collection.

 /See:/ </ YouTube Data API v3 Reference> for @youtube.captions.insert@.
 * Resource
 ** Constructing a Request
 | A resource alias for @youtube.captions.insert@ method which the
 'YouTubeCaptionsInsert' request conforms to.
 | Inserts a new resource into this collection.

 /See:/ 'newYouTubeCaptionsInsert' smart constructor.
 | V1 error format.
 | OAuth access token.
 | ID of the Google+ Page for the channel that the request is be on behalf of
 | The /part/ parameter specifies the caption resource parts that the API response will include. Set the parameter value to snippet.
 | Multipart request metadata.
 | Extra parameter to allow automatically syncing the uploaded caption\/transcript with the audio.
 | Upload protocol for media (e.g. \"raw\", \"multipart\").
 | Creates a value of 'YouTubeCaptionsInsert' with the minimum fields required to make a request.
 |  The /part/ parameter specifies the caption resource parts that the API response will include. Set the parameter value to snippet. See 'part'.
 |  Multipart request metadata. See 'payload'.
# LANGUAGE DataKinds #
# LANGUAGE DeriveGeneric #
# LANGUAGE DerivingStrategies #
# LANGUAGE DuplicateRecordFields #
# LANGUAGE FlexibleInstances #
# LANGUAGE GeneralizedNewtypeDeriving #
# LANGUAGE LambdaCase #
# LANGUAGE PatternSynonyms #
# LANGUAGE RecordWildCards #
# LANGUAGE TypeFamilies #
# LANGUAGE TypeOperators #
# 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       :  . YouTube . Captions . Insert
  Copyright    : ( c ) 2015 - 2022  
  License      : Mozilla Public License , v. 2.0 .
  Maintainer   :   < brendan.g.hay+ >
  Portability : non - portable ( GHC extensions )
module Gogol.YouTube.Captions.Insert
    YouTubeCaptionsInsertResource,

    YouTubeCaptionsInsert (..),
    newYouTubeCaptionsInsert,
  )
where

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

type YouTubeCaptionsInsertResource =
  "youtube"
    Core.:> "v3"
    Core.:> "captions"
    Core.:> Core.QueryParams "part" Core.Text
    Core.:> Core.QueryParam "$.xgafv" Xgafv
    Core.:> Core.QueryParam "access_token" Core.Text
    Core.:> Core.QueryParam "callback" Core.Text
    Core.:> Core.QueryParam "onBehalfOf" Core.Text
    Core.:> Core.QueryParam "onBehalfOfContentOwner" Core.Text
    Core.:> Core.QueryParam "sync" Core.Bool
    Core.:> Core.QueryParam "uploadType" Core.Text
    Core.:> Core.QueryParam "upload_protocol" Core.Text
    Core.:> Core.QueryParam "alt" Core.AltJSON
    Core.:> Core.ReqBody '[Core.JSON] Caption
    Core.:> Core.Post '[Core.JSON] Caption
    Core.:<|> "upload"
      Core.:> "youtube"
      Core.:> "v3"
      Core.:> "captions"
      Core.:> Core.QueryParams "part" Core.Text
      Core.:> Core.QueryParam "$.xgafv" Xgafv
      Core.:> Core.QueryParam "access_token" Core.Text
      Core.:> Core.QueryParam "callback" Core.Text
      Core.:> Core.QueryParam "onBehalfOf" Core.Text
      Core.:> Core.QueryParam "onBehalfOfContentOwner" Core.Text
      Core.:> Core.QueryParam "sync" Core.Bool
      Core.:> Core.QueryParam "uploadType" Core.Text
      Core.:> Core.QueryParam "upload_protocol" Core.Text
      Core.:> Core.QueryParam "alt" Core.AltJSON
      Core.:> Core.QueryParam "uploadType" Core.Multipart
      Core.:> Core.MultipartRelated '[Core.JSON] Caption
      Core.:> Core.Post '[Core.JSON] Caption

data YouTubeCaptionsInsert = YouTubeCaptionsInsert
    xgafv :: (Core.Maybe Xgafv),
    accessToken :: (Core.Maybe Core.Text),
  | JSONP
    callback :: (Core.Maybe Core.Text),
    onBehalfOf :: (Core.Maybe Core.Text),
  | /Note:/ This parameter is intended exclusively for YouTube content partners . The /onBehalfOfContentOwner/ parameter indicates that the request\ 's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value . This parameter is intended for YouTube content partners that own and manage many different YouTube channels . It allows content owners to authenticate once and get access to all their video and channel data , without having to provide authentication credentials for each individual channel . The actual CMS account that the user authenticates with must be linked to the specified YouTube content owner .
    onBehalfOfContentOwner :: (Core.Maybe Core.Text),
    part :: [Core.Text],
    payload :: Caption,
    sync :: (Core.Maybe Core.Bool),
  | Legacy upload protocol for media ( e.g. \"media\ " , \"multipart\ " ) .
    uploadType :: (Core.Maybe Core.Text),
    uploadProtocol :: (Core.Maybe Core.Text)
  }
  deriving (Core.Eq, Core.Show, Core.Generic)

newYouTubeCaptionsInsert ::
  [Core.Text] ->
  Caption ->
  YouTubeCaptionsInsert
newYouTubeCaptionsInsert part payload =
  YouTubeCaptionsInsert
    { xgafv = Core.Nothing,
      accessToken = Core.Nothing,
      callback = Core.Nothing,
      onBehalfOf = Core.Nothing,
      onBehalfOfContentOwner = Core.Nothing,
      part = part,
      payload = payload,
      sync = Core.Nothing,
      uploadType = Core.Nothing,
      uploadProtocol = Core.Nothing
    }

instance Core.GoogleRequest YouTubeCaptionsInsert where
  type Rs YouTubeCaptionsInsert = Caption
  type
    Scopes YouTubeCaptionsInsert =
      '[Youtube'ForceSsl, Youtubepartner'FullControl]
  requestClient YouTubeCaptionsInsert {..} =
    go
      part
      xgafv
      accessToken
      callback
      onBehalfOf
      onBehalfOfContentOwner
      sync
      uploadType
      uploadProtocol
      (Core.Just Core.AltJSON)
      payload
      youTubeService
    where
      go Core.:<|> _ =
        Core.buildClient
          ( Core.Proxy ::
              Core.Proxy YouTubeCaptionsInsertResource
          )
          Core.mempty

instance
  Core.GoogleRequest
    (Core.MediaUpload YouTubeCaptionsInsert)
  where
  type
    Rs (Core.MediaUpload YouTubeCaptionsInsert) =
      Caption
  type
    Scopes (Core.MediaUpload YouTubeCaptionsInsert) =
      Core.Scopes YouTubeCaptionsInsert
  requestClient
    (Core.MediaUpload YouTubeCaptionsInsert {..} body) =
      go
        part
        xgafv
        accessToken
        callback
        onBehalfOf
        onBehalfOfContentOwner
        sync
        uploadType
        uploadProtocol
        (Core.Just Core.AltJSON)
        (Core.Just Core.Multipart)
        payload
        body
        youTubeService
      where
        _ Core.:<|> go =
          Core.buildClient
            ( Core.Proxy ::
                Core.Proxy YouTubeCaptionsInsertResource
            )
            Core.mempty
