List.hs

{-# 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.AdExchangeBuyer2.Accounts.Proposals.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)
--
-- List proposals. A filter expression (PQL query) may be specified to filter the results. To retrieve all finalized proposals, regardless if a proposal is being renegotiated, see the FinalizedProposals resource. Note that Bidder\/ChildSeat relationships differ from the usual behavior. A Bidder account can only see its child seats\' proposals by specifying the ChildSeat\'s accountId in the request path.
--
-- /See:/ <https://developers.google.com/authorized-buyers/apis/reference/rest/ Ad Exchange Buyer API II Reference> for @adexchangebuyer2.accounts.proposals.list@.
module Gogol.AdExchangeBuyer2.Accounts.Proposals.List
  ( -- * Resource
    AdExchangeBuyer2AccountsProposalsListResource,

    -- ** Constructing a Request
    AdExchangeBuyer2AccountsProposalsList (..),
    newAdExchangeBuyer2AccountsProposalsList,
  )
where

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

-- | A resource alias for @adexchangebuyer2.accounts.proposals.list@ method which the
-- 'AdExchangeBuyer2AccountsProposalsList' request conforms to.
type AdExchangeBuyer2AccountsProposalsListResource =
  "v2beta1"
    Core.:> "accounts"
    Core.:> Core.Capture "accountId" Core.Text
    Core.:> "proposals"
    Core.:> Core.QueryParam "$.xgafv" Xgafv
    Core.:> Core.QueryParam "access_token" Core.Text
    Core.:> Core.QueryParam "callback" Core.Text
    Core.:> Core.QueryParam "filter" Core.Text
    Core.:> Core.QueryParam "filterSyntax" AccountsProposalsListFilterSyntax
    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] ListProposalsResponse

-- | List proposals. A filter expression (PQL query) may be specified to filter the results. To retrieve all finalized proposals, regardless if a proposal is being renegotiated, see the FinalizedProposals resource. Note that Bidder\/ChildSeat relationships differ from the usual behavior. A Bidder account can only see its child seats\' proposals by specifying the ChildSeat\'s accountId in the request path.
--
-- /See:/ 'newAdExchangeBuyer2AccountsProposalsList' smart constructor.
data AdExchangeBuyer2AccountsProposalsList = AdExchangeBuyer2AccountsProposalsList
  { -- | V1 error format.
    xgafv :: (Core.Maybe Xgafv),
    -- | OAuth access token.
    accessToken :: (Core.Maybe Core.Text),
    -- | Account ID of the buyer.
    accountId :: Core.Text,
    -- | JSONP
    callback :: (Core.Maybe Core.Text),
    -- | An optional PQL filter query used to query for proposals. Nested repeated fields, such as proposal.deals.targetingCriterion, cannot be filtered.
    filter :: (Core.Maybe Core.Text),
    -- | Syntax the filter is written in. Current implementation defaults to PQL but in the future it will be LIST_FILTER.
    filterSyntax :: (Core.Maybe AccountsProposalsListFilterSyntax),
    -- | Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
    pageSize :: (Core.Maybe Core.Int32),
    -- | The page token as returned from ListProposalsResponse.
    pageToken :: (Core.Maybe Core.Text),
    -- | 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 'AdExchangeBuyer2AccountsProposalsList' with the minimum fields required to make a request.
newAdExchangeBuyer2AccountsProposalsList ::
  -- |  Account ID of the buyer. See 'accountId'.
  Core.Text ->
  AdExchangeBuyer2AccountsProposalsList
newAdExchangeBuyer2AccountsProposalsList accountId =
  AdExchangeBuyer2AccountsProposalsList
    { xgafv = Core.Nothing,
      accessToken = Core.Nothing,
      accountId = accountId,
      callback = Core.Nothing,
      filter = Core.Nothing,
      filterSyntax = Core.Nothing,
      pageSize = Core.Nothing,
      pageToken = Core.Nothing,
      uploadType = Core.Nothing,
      uploadProtocol = Core.Nothing
    }

instance Core.GoogleRequest AdExchangeBuyer2AccountsProposalsList where
  type
    Rs AdExchangeBuyer2AccountsProposalsList =
      ListProposalsResponse
  type
    Scopes AdExchangeBuyer2AccountsProposalsList =
      '[Adexchange'Buyer]
  requestClient AdExchangeBuyer2AccountsProposalsList {..} =
    go
      accountId
      xgafv
      accessToken
      callback
      filter
      filterSyntax
      pageSize
      pageToken
      uploadType
      uploadProtocol
      (Core.Just Core.AltJSON)
      adExchangeBuyer2Service
    where
      go =
        Core.buildClient
          ( Core.Proxy ::
              Core.Proxy AdExchangeBuyer2AccountsProposalsListResource
          )
          Core.mempty