{-# 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.Vault.Matters.Holds.AddHeldAccounts
-- 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)
--
-- Adds accounts to a hold. Returns a list of accounts that have been successfully added. Accounts can be added only to an existing account-based hold.
--
-- /See:/ <https://developers.google.com/vault Google Vault API Reference> for @vault.matters.holds.addHeldAccounts@.
module Gogol.Vault.Matters.Holds.AddHeldAccounts
  ( -- * Resource
    VaultMattersHoldsAddHeldAccountsResource,

    -- ** Constructing a Request
    VaultMattersHoldsAddHeldAccounts (..),
    newVaultMattersHoldsAddHeldAccounts,
  )
where

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

-- | A resource alias for @vault.matters.holds.addHeldAccounts@ method which the
-- 'VaultMattersHoldsAddHeldAccounts' request conforms to.
type VaultMattersHoldsAddHeldAccountsResource =
  "v1"
    Core.:> "matters"
    Core.:> Core.Capture "matterId" Core.Text
    Core.:> "holds"
    Core.:> Core.CaptureMode "holdId" "addHeldAccounts" 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] AddHeldAccountsRequest
    Core.:> Core.Post '[Core.JSON] AddHeldAccountsResponse

-- | Adds accounts to a hold. Returns a list of accounts that have been successfully added. Accounts can be added only to an existing account-based hold.
--
-- /See:/ 'newVaultMattersHoldsAddHeldAccounts' smart constructor.
data VaultMattersHoldsAddHeldAccounts = VaultMattersHoldsAddHeldAccounts
  { -- | V1 error format.
    VaultMattersHoldsAddHeldAccounts -> Maybe Xgafv
xgafv :: (Core.Maybe Xgafv),
    -- | OAuth access token.
    VaultMattersHoldsAddHeldAccounts -> Maybe Text
accessToken :: (Core.Maybe Core.Text),
    -- | JSONP
    VaultMattersHoldsAddHeldAccounts -> Maybe Text
callback :: (Core.Maybe Core.Text),
    -- | The hold ID.
    VaultMattersHoldsAddHeldAccounts -> Text
holdId :: Core.Text,
    -- | The matter ID.
    VaultMattersHoldsAddHeldAccounts -> Text
matterId :: Core.Text,
    -- | Multipart request metadata.
    VaultMattersHoldsAddHeldAccounts -> AddHeldAccountsRequest
payload :: AddHeldAccountsRequest,
    -- | Legacy upload protocol for media (e.g. \"media\", \"multipart\").
    VaultMattersHoldsAddHeldAccounts -> Maybe Text
uploadType :: (Core.Maybe Core.Text),
    -- | Upload protocol for media (e.g. \"raw\", \"multipart\").
    VaultMattersHoldsAddHeldAccounts -> Maybe Text
uploadProtocol :: (Core.Maybe Core.Text)
  }
  deriving (VaultMattersHoldsAddHeldAccounts
-> VaultMattersHoldsAddHeldAccounts -> Bool
(VaultMattersHoldsAddHeldAccounts
 -> VaultMattersHoldsAddHeldAccounts -> Bool)
-> (VaultMattersHoldsAddHeldAccounts
    -> VaultMattersHoldsAddHeldAccounts -> Bool)
-> Eq VaultMattersHoldsAddHeldAccounts
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
$c== :: VaultMattersHoldsAddHeldAccounts
-> VaultMattersHoldsAddHeldAccounts -> Bool
== :: VaultMattersHoldsAddHeldAccounts
-> VaultMattersHoldsAddHeldAccounts -> Bool
$c/= :: VaultMattersHoldsAddHeldAccounts
-> VaultMattersHoldsAddHeldAccounts -> Bool
/= :: VaultMattersHoldsAddHeldAccounts
-> VaultMattersHoldsAddHeldAccounts -> Bool
Core.Eq, Int -> VaultMattersHoldsAddHeldAccounts -> ShowS
[VaultMattersHoldsAddHeldAccounts] -> ShowS
VaultMattersHoldsAddHeldAccounts -> String
(Int -> VaultMattersHoldsAddHeldAccounts -> ShowS)
-> (VaultMattersHoldsAddHeldAccounts -> String)
-> ([VaultMattersHoldsAddHeldAccounts] -> ShowS)
-> Show VaultMattersHoldsAddHeldAccounts
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
$cshowsPrec :: Int -> VaultMattersHoldsAddHeldAccounts -> ShowS
showsPrec :: Int -> VaultMattersHoldsAddHeldAccounts -> ShowS
$cshow :: VaultMattersHoldsAddHeldAccounts -> String
show :: VaultMattersHoldsAddHeldAccounts -> String
$cshowList :: [VaultMattersHoldsAddHeldAccounts] -> ShowS
showList :: [VaultMattersHoldsAddHeldAccounts] -> ShowS
Core.Show, (forall x.
 VaultMattersHoldsAddHeldAccounts
 -> Rep VaultMattersHoldsAddHeldAccounts x)
-> (forall x.
    Rep VaultMattersHoldsAddHeldAccounts x
    -> VaultMattersHoldsAddHeldAccounts)
-> Generic VaultMattersHoldsAddHeldAccounts
forall x.
Rep VaultMattersHoldsAddHeldAccounts x
-> VaultMattersHoldsAddHeldAccounts
forall x.
VaultMattersHoldsAddHeldAccounts
-> Rep VaultMattersHoldsAddHeldAccounts x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cfrom :: forall x.
VaultMattersHoldsAddHeldAccounts
-> Rep VaultMattersHoldsAddHeldAccounts x
from :: forall x.
VaultMattersHoldsAddHeldAccounts
-> Rep VaultMattersHoldsAddHeldAccounts x
$cto :: forall x.
Rep VaultMattersHoldsAddHeldAccounts x
-> VaultMattersHoldsAddHeldAccounts
to :: forall x.
Rep VaultMattersHoldsAddHeldAccounts x
-> VaultMattersHoldsAddHeldAccounts
Core.Generic)

-- | Creates a value of 'VaultMattersHoldsAddHeldAccounts' with the minimum fields required to make a request.
newVaultMattersHoldsAddHeldAccounts ::
  -- |  The hold ID. See 'holdId'.
  Core.Text ->
  -- |  The matter ID. See 'matterId'.
  Core.Text ->
  -- |  Multipart request metadata. See 'payload'.
  AddHeldAccountsRequest ->
  VaultMattersHoldsAddHeldAccounts
newVaultMattersHoldsAddHeldAccounts :: Text
-> Text
-> AddHeldAccountsRequest
-> VaultMattersHoldsAddHeldAccounts
newVaultMattersHoldsAddHeldAccounts Text
holdId Text
matterId AddHeldAccountsRequest
payload =
  VaultMattersHoldsAddHeldAccounts
    { xgafv :: Maybe Xgafv
xgafv = Maybe Xgafv
forall a. Maybe a
Core.Nothing,
      accessToken :: Maybe Text
accessToken = Maybe Text
forall a. Maybe a
Core.Nothing,
      callback :: Maybe Text
callback = Maybe Text
forall a. Maybe a
Core.Nothing,
      holdId :: Text
holdId = Text
holdId,
      matterId :: Text
matterId = Text
matterId,
      payload :: AddHeldAccountsRequest
payload = AddHeldAccountsRequest
payload,
      uploadType :: Maybe Text
uploadType = Maybe Text
forall a. Maybe a
Core.Nothing,
      uploadProtocol :: Maybe Text
uploadProtocol = Maybe Text
forall a. Maybe a
Core.Nothing
    }

instance Core.GoogleRequest VaultMattersHoldsAddHeldAccounts where
  type Rs VaultMattersHoldsAddHeldAccounts = AddHeldAccountsResponse
  type
    Scopes VaultMattersHoldsAddHeldAccounts =
      '[Ediscovery'FullControl]
  requestClient :: VaultMattersHoldsAddHeldAccounts
-> GClient (Rs VaultMattersHoldsAddHeldAccounts)
requestClient VaultMattersHoldsAddHeldAccounts {Maybe Text
Maybe Xgafv
Text
AddHeldAccountsRequest
xgafv :: VaultMattersHoldsAddHeldAccounts -> Maybe Xgafv
accessToken :: VaultMattersHoldsAddHeldAccounts -> Maybe Text
callback :: VaultMattersHoldsAddHeldAccounts -> Maybe Text
holdId :: VaultMattersHoldsAddHeldAccounts -> Text
matterId :: VaultMattersHoldsAddHeldAccounts -> Text
payload :: VaultMattersHoldsAddHeldAccounts -> AddHeldAccountsRequest
uploadType :: VaultMattersHoldsAddHeldAccounts -> Maybe Text
uploadProtocol :: VaultMattersHoldsAddHeldAccounts -> Maybe Text
xgafv :: Maybe Xgafv
accessToken :: Maybe Text
callback :: Maybe Text
holdId :: Text
matterId :: Text
payload :: AddHeldAccountsRequest
uploadType :: Maybe Text
uploadProtocol :: Maybe Text
..} =
    Text
-> Text
-> Maybe Xgafv
-> Maybe Text
-> Maybe Text
-> Maybe Text
-> Maybe Text
-> Maybe AltJSON
-> AddHeldAccountsRequest
-> ServiceConfig
-> GClient AddHeldAccountsResponse
go
      Text
matterId
      Text
holdId
      Maybe Xgafv
xgafv
      Maybe Text
accessToken
      Maybe Text
callback
      Maybe Text
uploadType
      Maybe Text
uploadProtocol
      (AltJSON -> Maybe AltJSON
forall a. a -> Maybe a
Core.Just AltJSON
Core.AltJSON)
      AddHeldAccountsRequest
payload
      ServiceConfig
vaultService
    where
      go :: Fn VaultMattersHoldsAddHeldAccountsResource
go =
        Proxy VaultMattersHoldsAddHeldAccountsResource
-> Request -> Fn VaultMattersHoldsAddHeldAccountsResource
forall {k} (fn :: k).
GoogleClient fn =>
Proxy fn -> Request -> Fn fn
Core.buildClient
          (Proxy VaultMattersHoldsAddHeldAccountsResource
forall {k} (t :: k). Proxy t
Core.Proxy :: Core.Proxy VaultMattersHoldsAddHeldAccountsResource)
          Request
forall a. Monoid a => a
Core.mempty