{-# 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.List
-- 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)
--
-- Lists the holds in a matter.
--
-- /See:/ <https://developers.google.com/vault Google Vault API Reference> for @vault.matters.holds.list@.
module Gogol.Vault.Matters.Holds.List
  ( -- * Resource
    VaultMattersHoldsListResource,

    -- ** Constructing a Request
    VaultMattersHoldsList (..),
    newVaultMattersHoldsList,
  )
where

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

-- | A resource alias for @vault.matters.holds.list@ method which the
-- 'VaultMattersHoldsList' request conforms to.
type VaultMattersHoldsListResource =
  "v1"
    Core.:> "matters"
    Core.:> Core.Capture "matterId" Core.Text
    Core.:> "holds"
    Core.:> Core.QueryParam "$.xgafv" Xgafv
    Core.:> Core.QueryParam "access_token" Core.Text
    Core.:> Core.QueryParam "callback" Core.Text
    Core.:> Core.QueryParam "pageSize" Core.Int32
    Core.:> Core.QueryParam "pageToken" Core.Text
    Core.:> Core.QueryParam "uploadType" Core.Text
    Core.:> Core.QueryParam "upload_protocol" Core.Text
    Core.:> Core.QueryParam "view" MattersHoldsListView
    Core.:> Core.QueryParam "alt" Core.AltJSON
    Core.:> Core.Get '[Core.JSON] ListHoldsResponse

-- | Lists the holds in a matter.
--
-- /See:/ 'newVaultMattersHoldsList' smart constructor.
data VaultMattersHoldsList = VaultMattersHoldsList
  { -- | V1 error format.
    VaultMattersHoldsList -> Maybe Xgafv
xgafv :: (Core.Maybe Xgafv),
    -- | OAuth access token.
    VaultMattersHoldsList -> Maybe Text
accessToken :: (Core.Maybe Core.Text),
    -- | JSONP
    VaultMattersHoldsList -> Maybe Text
callback :: (Core.Maybe Core.Text),
    -- | The matter ID.
    VaultMattersHoldsList -> Text
matterId :: Core.Text,
    -- | The number of holds to return in the response, between 0 and 100 inclusive. Leaving this empty, or as 0, is the same as **page_size** = 100.
    VaultMattersHoldsList -> Maybe Int32
pageSize :: (Core.Maybe Core.Int32),
    -- | The pagination token as returned in the response. An empty token means start from the beginning.
    VaultMattersHoldsList -> Maybe Text
pageToken :: (Core.Maybe Core.Text),
    -- | Legacy upload protocol for media (e.g. \"media\", \"multipart\").
    VaultMattersHoldsList -> Maybe Text
uploadType :: (Core.Maybe Core.Text),
    -- | Upload protocol for media (e.g. \"raw\", \"multipart\").
    VaultMattersHoldsList -> Maybe Text
uploadProtocol :: (Core.Maybe Core.Text),
    -- | The amount of detail to return for a hold.
    VaultMattersHoldsList -> Maybe MattersHoldsListView
view :: (Core.Maybe MattersHoldsListView)
  }
  deriving (VaultMattersHoldsList -> VaultMattersHoldsList -> Bool
(VaultMattersHoldsList -> VaultMattersHoldsList -> Bool)
-> (VaultMattersHoldsList -> VaultMattersHoldsList -> Bool)
-> Eq VaultMattersHoldsList
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
$c== :: VaultMattersHoldsList -> VaultMattersHoldsList -> Bool
== :: VaultMattersHoldsList -> VaultMattersHoldsList -> Bool
$c/= :: VaultMattersHoldsList -> VaultMattersHoldsList -> Bool
/= :: VaultMattersHoldsList -> VaultMattersHoldsList -> Bool
Core.Eq, Int -> VaultMattersHoldsList -> ShowS
[VaultMattersHoldsList] -> ShowS
VaultMattersHoldsList -> String
(Int -> VaultMattersHoldsList -> ShowS)
-> (VaultMattersHoldsList -> String)
-> ([VaultMattersHoldsList] -> ShowS)
-> Show VaultMattersHoldsList
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
$cshowsPrec :: Int -> VaultMattersHoldsList -> ShowS
showsPrec :: Int -> VaultMattersHoldsList -> ShowS
$cshow :: VaultMattersHoldsList -> String
show :: VaultMattersHoldsList -> String
$cshowList :: [VaultMattersHoldsList] -> ShowS
showList :: [VaultMattersHoldsList] -> ShowS
Core.Show, (forall x. VaultMattersHoldsList -> Rep VaultMattersHoldsList x)
-> (forall x. Rep VaultMattersHoldsList x -> VaultMattersHoldsList)
-> Generic VaultMattersHoldsList
forall x. Rep VaultMattersHoldsList x -> VaultMattersHoldsList
forall x. VaultMattersHoldsList -> Rep VaultMattersHoldsList x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cfrom :: forall x. VaultMattersHoldsList -> Rep VaultMattersHoldsList x
from :: forall x. VaultMattersHoldsList -> Rep VaultMattersHoldsList x
$cto :: forall x. Rep VaultMattersHoldsList x -> VaultMattersHoldsList
to :: forall x. Rep VaultMattersHoldsList x -> VaultMattersHoldsList
Core.Generic)

-- | Creates a value of 'VaultMattersHoldsList' with the minimum fields required to make a request.
newVaultMattersHoldsList ::
  -- |  The matter ID. See 'matterId'.
  Core.Text ->
  VaultMattersHoldsList
newVaultMattersHoldsList :: Text -> VaultMattersHoldsList
newVaultMattersHoldsList Text
matterId =
  VaultMattersHoldsList
    { 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,
      matterId :: Text
matterId = Text
matterId,
      pageSize :: Maybe Int32
pageSize = Maybe Int32
forall a. Maybe a
Core.Nothing,
      pageToken :: Maybe Text
pageToken = Maybe Text
forall a. Maybe a
Core.Nothing,
      uploadType :: Maybe Text
uploadType = Maybe Text
forall a. Maybe a
Core.Nothing,
      uploadProtocol :: Maybe Text
uploadProtocol = Maybe Text
forall a. Maybe a
Core.Nothing,
      view :: Maybe MattersHoldsListView
view = Maybe MattersHoldsListView
forall a. Maybe a
Core.Nothing
    }

instance Core.GoogleRequest VaultMattersHoldsList where
  type Rs VaultMattersHoldsList = ListHoldsResponse
  type
    Scopes VaultMattersHoldsList =
      '[Ediscovery'FullControl, Ediscovery'Readonly]
  requestClient :: VaultMattersHoldsList -> GClient (Rs VaultMattersHoldsList)
requestClient VaultMattersHoldsList {Maybe Int32
Maybe Text
Maybe MattersHoldsListView
Maybe Xgafv
Text
xgafv :: VaultMattersHoldsList -> Maybe Xgafv
accessToken :: VaultMattersHoldsList -> Maybe Text
callback :: VaultMattersHoldsList -> Maybe Text
matterId :: VaultMattersHoldsList -> Text
pageSize :: VaultMattersHoldsList -> Maybe Int32
pageToken :: VaultMattersHoldsList -> Maybe Text
uploadType :: VaultMattersHoldsList -> Maybe Text
uploadProtocol :: VaultMattersHoldsList -> Maybe Text
view :: VaultMattersHoldsList -> Maybe MattersHoldsListView
xgafv :: Maybe Xgafv
accessToken :: Maybe Text
callback :: Maybe Text
matterId :: Text
pageSize :: Maybe Int32
pageToken :: Maybe Text
uploadType :: Maybe Text
uploadProtocol :: Maybe Text
view :: Maybe MattersHoldsListView
..} =
    Text
-> Maybe Xgafv
-> Maybe Text
-> Maybe Text
-> Maybe Int32
-> Maybe Text
-> Maybe Text
-> Maybe Text
-> Maybe MattersHoldsListView
-> Maybe AltJSON
-> ServiceConfig
-> GClient ListHoldsResponse
go
      Text
matterId
      Maybe Xgafv
xgafv
      Maybe Text
accessToken
      Maybe Text
callback
      Maybe Int32
pageSize
      Maybe Text
pageToken
      Maybe Text
uploadType
      Maybe Text
uploadProtocol
      Maybe MattersHoldsListView
view
      (AltJSON -> Maybe AltJSON
forall a. a -> Maybe a
Core.Just AltJSON
Core.AltJSON)
      ServiceConfig
vaultService
    where
      go :: Fn VaultMattersHoldsListResource
go =
        Proxy VaultMattersHoldsListResource
-> Request -> Fn VaultMattersHoldsListResource
forall {k} (fn :: k).
GoogleClient fn =>
Proxy fn -> Request -> Fn fn
Core.buildClient
          (Proxy VaultMattersHoldsListResource
forall {k} (t :: k). Proxy t
Core.Proxy :: Core.Proxy VaultMattersHoldsListResource)
          Request
forall a. Monoid a => a
Core.mempty