{-# 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.SavedQueries.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 saved queries in a matter.
--
-- /See:/ <https://developers.google.com/vault Google Vault API Reference> for @vault.matters.savedQueries.list@.
module Gogol.Vault.Matters.SavedQueries.List
  ( -- * Resource
    VaultMattersSavedQueriesListResource,

    -- ** Constructing a Request
    VaultMattersSavedQueriesList (..),
    newVaultMattersSavedQueriesList,
  )
where

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

-- | A resource alias for @vault.matters.savedQueries.list@ method which the
-- 'VaultMattersSavedQueriesList' request conforms to.
type VaultMattersSavedQueriesListResource =
  "v1"
    Core.:> "matters"
    Core.:> Core.Capture "matterId" Core.Text
    Core.:> "savedQueries"
    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 "alt" Core.AltJSON
    Core.:> Core.Get '[Core.JSON] ListSavedQueriesResponse

-- | Lists the saved queries in a matter.
--
-- /See:/ 'newVaultMattersSavedQueriesList' smart constructor.
data VaultMattersSavedQueriesList = VaultMattersSavedQueriesList
  { -- | V1 error format.
    VaultMattersSavedQueriesList -> Maybe Xgafv
xgafv :: (Core.Maybe Xgafv),
    -- | OAuth access token.
    VaultMattersSavedQueriesList -> Maybe Text
accessToken :: (Core.Maybe Core.Text),
    -- | JSONP
    VaultMattersSavedQueriesList -> Maybe Text
callback :: (Core.Maybe Core.Text),
    -- | The ID of the matter to get the saved queries for.
    VaultMattersSavedQueriesList -> Text
matterId :: Core.Text,
    -- | The maximum number of saved queries to return.
    VaultMattersSavedQueriesList -> Maybe Int32
pageSize :: (Core.Maybe Core.Int32),
    -- | The pagination token as returned in the previous response. An empty token means start from the beginning.
    VaultMattersSavedQueriesList -> Maybe Text
pageToken :: (Core.Maybe Core.Text),
    -- | Legacy upload protocol for media (e.g. \"media\", \"multipart\").
    VaultMattersSavedQueriesList -> Maybe Text
uploadType :: (Core.Maybe Core.Text),
    -- | Upload protocol for media (e.g. \"raw\", \"multipart\").
    VaultMattersSavedQueriesList -> Maybe Text
uploadProtocol :: (Core.Maybe Core.Text)
  }
  deriving (VaultMattersSavedQueriesList
-> VaultMattersSavedQueriesList -> Bool
(VaultMattersSavedQueriesList
 -> VaultMattersSavedQueriesList -> Bool)
-> (VaultMattersSavedQueriesList
    -> VaultMattersSavedQueriesList -> Bool)
-> Eq VaultMattersSavedQueriesList
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
$c== :: VaultMattersSavedQueriesList
-> VaultMattersSavedQueriesList -> Bool
== :: VaultMattersSavedQueriesList
-> VaultMattersSavedQueriesList -> Bool
$c/= :: VaultMattersSavedQueriesList
-> VaultMattersSavedQueriesList -> Bool
/= :: VaultMattersSavedQueriesList
-> VaultMattersSavedQueriesList -> Bool
Core.Eq, Int -> VaultMattersSavedQueriesList -> ShowS
[VaultMattersSavedQueriesList] -> ShowS
VaultMattersSavedQueriesList -> String
(Int -> VaultMattersSavedQueriesList -> ShowS)
-> (VaultMattersSavedQueriesList -> String)
-> ([VaultMattersSavedQueriesList] -> ShowS)
-> Show VaultMattersSavedQueriesList
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
$cshowsPrec :: Int -> VaultMattersSavedQueriesList -> ShowS
showsPrec :: Int -> VaultMattersSavedQueriesList -> ShowS
$cshow :: VaultMattersSavedQueriesList -> String
show :: VaultMattersSavedQueriesList -> String
$cshowList :: [VaultMattersSavedQueriesList] -> ShowS
showList :: [VaultMattersSavedQueriesList] -> ShowS
Core.Show, (forall x.
 VaultMattersSavedQueriesList -> Rep VaultMattersSavedQueriesList x)
-> (forall x.
    Rep VaultMattersSavedQueriesList x -> VaultMattersSavedQueriesList)
-> Generic VaultMattersSavedQueriesList
forall x.
Rep VaultMattersSavedQueriesList x -> VaultMattersSavedQueriesList
forall x.
VaultMattersSavedQueriesList -> Rep VaultMattersSavedQueriesList x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cfrom :: forall x.
VaultMattersSavedQueriesList -> Rep VaultMattersSavedQueriesList x
from :: forall x.
VaultMattersSavedQueriesList -> Rep VaultMattersSavedQueriesList x
$cto :: forall x.
Rep VaultMattersSavedQueriesList x -> VaultMattersSavedQueriesList
to :: forall x.
Rep VaultMattersSavedQueriesList x -> VaultMattersSavedQueriesList
Core.Generic)

-- | Creates a value of 'VaultMattersSavedQueriesList' with the minimum fields required to make a request.
newVaultMattersSavedQueriesList ::
  -- |  The ID of the matter to get the saved queries for. See 'matterId'.
  Core.Text ->
  VaultMattersSavedQueriesList
newVaultMattersSavedQueriesList :: Text -> VaultMattersSavedQueriesList
newVaultMattersSavedQueriesList Text
matterId =
  VaultMattersSavedQueriesList
    { 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
    }

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