Copy.hs

{-# 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.Drive.Files.Copy
-- Copyright   : (c) 2015 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay <brendan.g.hay@gmail.com>
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Creates a copy of the specified file.
--
-- /See:/ <https://developers.google.com/drive/ Drive API Reference> for @drive.files.copy@.
module Network.Google.Resource.Drive.Files.Copy
    (
    -- * REST Resource
      FilesCopyResource

    -- * Creating a Request
    , filesCopy
    , FilesCopy

    -- * Request Lenses
    , fcPinned
    , fcVisibility
    , fcTimedTextLanguage
    , fcPayload
    , fcTimedTextTrackName
    , fcOCRLanguage
    , fcConvert
    , fcFileId
    , fcOCR
    ) where

import           Network.Google.Drive.Types
import           Network.Google.Prelude

-- | A resource alias for @drive.files.copy@ method which the
-- 'FilesCopy' request conforms to.
type FilesCopyResource =
     "drive" :>
       "v2" :>
         "files" :>
           Capture "fileId" Text :>
             "copy" :>
               QueryParam "pinned" Bool :>
                 QueryParam "visibility" FilesCopyVisibility :>
                   QueryParam "timedTextLanguage" Text :>
                     QueryParam "timedTextTrackName" Text :>
                       QueryParam "ocrLanguage" Text :>
                         QueryParam "convert" Bool :>
                           QueryParam "ocr" Bool :>
                             QueryParam "alt" AltJSON :>
                               ReqBody '[JSON] File :> Post '[JSON] File

-- | Creates a copy of the specified file.
--
-- /See:/ 'filesCopy' smart constructor.
data FilesCopy = FilesCopy
    { _fcPinned             :: !Bool
    , _fcVisibility         :: !FilesCopyVisibility
    , _fcTimedTextLanguage  :: !(Maybe Text)
    , _fcPayload            :: !File
    , _fcTimedTextTrackName :: !(Maybe Text)
    , _fcOCRLanguage        :: !(Maybe Text)
    , _fcConvert            :: !Bool
    , _fcFileId             :: !Text
    , _fcOCR                :: !Bool
    } deriving (Eq,Show,Data,Typeable,Generic)

-- | Creates a value of 'FilesCopy' with the minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
-- * 'fcPinned'
--
-- * 'fcVisibility'
--
-- * 'fcTimedTextLanguage'
--
-- * 'fcPayload'
--
-- * 'fcTimedTextTrackName'
--
-- * 'fcOCRLanguage'
--
-- * 'fcConvert'
--
-- * 'fcFileId'
--
-- * 'fcOCR'
filesCopy
    :: File -- ^ 'fcPayload'
    -> Text -- ^ 'fcFileId'
    -> FilesCopy
filesCopy pFcPayload_ pFcFileId_ =
    FilesCopy
    { _fcPinned = False
    , _fcVisibility = FCVDefault
    , _fcTimedTextLanguage = Nothing
    , _fcPayload = pFcPayload_
    , _fcTimedTextTrackName = Nothing
    , _fcOCRLanguage = Nothing
    , _fcConvert = False
    , _fcFileId = pFcFileId_
    , _fcOCR = False
    }

-- | Whether to pin the head revision of the new copy. A file can have a
-- maximum of 200 pinned revisions.
fcPinned :: Lens' FilesCopy Bool
fcPinned = lens _fcPinned (\ s a -> s{_fcPinned = a})

-- | The visibility of the new file. This parameter is only relevant when the
-- source is not a native Google Doc and convert=false.
fcVisibility :: Lens' FilesCopy FilesCopyVisibility
fcVisibility
  = lens _fcVisibility (\ s a -> s{_fcVisibility = a})

-- | The language of the timed text.
fcTimedTextLanguage :: Lens' FilesCopy (Maybe Text)
fcTimedTextLanguage
  = lens _fcTimedTextLanguage
      (\ s a -> s{_fcTimedTextLanguage = a})

-- | Multipart request metadata.
fcPayload :: Lens' FilesCopy File
fcPayload
  = lens _fcPayload (\ s a -> s{_fcPayload = a})

-- | The timed text track name.
fcTimedTextTrackName :: Lens' FilesCopy (Maybe Text)
fcTimedTextTrackName
  = lens _fcTimedTextTrackName
      (\ s a -> s{_fcTimedTextTrackName = a})

-- | If ocr is true, hints at the language to use. Valid values are BCP 47
-- codes.
fcOCRLanguage :: Lens' FilesCopy (Maybe Text)
fcOCRLanguage
  = lens _fcOCRLanguage
      (\ s a -> s{_fcOCRLanguage = a})

-- | Whether to convert this file to the corresponding Google Docs format.
fcConvert :: Lens' FilesCopy Bool
fcConvert
  = lens _fcConvert (\ s a -> s{_fcConvert = a})

-- | The ID of the file to copy.
fcFileId :: Lens' FilesCopy Text
fcFileId = lens _fcFileId (\ s a -> s{_fcFileId = a})

-- | Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.
fcOCR :: Lens' FilesCopy Bool
fcOCR = lens _fcOCR (\ s a -> s{_fcOCR = a})

instance GoogleRequest FilesCopy where
        type Rs FilesCopy = File
        requestClient FilesCopy{..}
          = go _fcFileId (Just _fcPinned) (Just _fcVisibility)
              _fcTimedTextLanguage
              _fcTimedTextTrackName
              _fcOCRLanguage
              (Just _fcConvert)
              (Just _fcOCR)
              (Just AltJSON)
              _fcPayload
              driveService
          where go
                  = buildClient (Proxy :: Proxy FilesCopyResource)
                      mempty