content: {-# 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.DFAReporting.Subaccounts.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)
  --
  -- Gets a list of subaccounts, possibly filtered. This method supports paging.
  --
  -- /See:/ <https://developers.google.com/doubleclick-advertisers/ Campaign Manager 360 API Reference> for @dfareporting.subaccounts.list@.
  module Gogol.DFAReporting.Subaccounts.List
    ( -- * Resource
      DFAReportingSubaccountsListResource,
  
      -- ** Constructing a Request
      DFAReportingSubaccountsList (..),
      newDFAReportingSubaccountsList,
    )
  where
  
  import Gogol.DFAReporting.Types
  import Gogol.Prelude qualified as Core
  
  -- | A resource alias for @dfareporting.subaccounts.list@ method which the
  -- 'DFAReportingSubaccountsList' request conforms to.
  type DFAReportingSubaccountsListResource =
    "dfareporting"
      Core.:> "v4"
      Core.:> "userprofiles"
      Core.:> Core.Capture "profileId" Core.Int64
      Core.:> "subaccounts"
      Core.:> Core.QueryParam "$.xgafv" Xgafv
      Core.:> Core.QueryParam "access_token" Core.Text
      Core.:> Core.QueryParam "callback" Core.Text
      Core.:> Core.QueryParams "ids" Core.Int64
      Core.:> Core.QueryParam "maxResults" Core.Int32
      Core.:> Core.QueryParam "pageToken" Core.Text
      Core.:> Core.QueryParam "searchString" Core.Text
      Core.:> Core.QueryParam "sortField" SubaccountsListSortField
      Core.:> Core.QueryParam "sortOrder" SubaccountsListSortOrder
      Core.:> Core.QueryParam "uploadType" Core.Text
      Core.:> Core.QueryParam "upload_protocol" Core.Text
      Core.:> Core.QueryParam "alt" Core.AltJSON
      Core.:> Core.Get '[Core.JSON] SubaccountsListResponse
  
  -- | Gets a list of subaccounts, possibly filtered. This method supports paging.
  --
  -- /See:/ 'newDFAReportingSubaccountsList' smart constructor.
  data DFAReportingSubaccountsList = DFAReportingSubaccountsList
    { -- | V1 error format.
      xgafv :: (Core.Maybe Xgafv),
      -- | OAuth access token.
      accessToken :: (Core.Maybe Core.Text),
      -- | JSONP
      callback :: (Core.Maybe Core.Text),
      -- | Select only subaccounts with these IDs.
      ids :: (Core.Maybe [Core.Int64]),
      -- | Maximum number of results to return.
      maxResults :: Core.Int32,
      -- | Value of the nextPageToken from the previous result page.
      pageToken :: (Core.Maybe Core.Text),
      -- | User profile ID associated with this request.
      profileId :: Core.Int64,
      -- | Allows searching for objects by name or ID. Wildcards (/) are allowed. For example, \"subaccount/2015\" will return objects with names like \"subaccount June 2015\", \"subaccount April 2015\", or simply \"subaccount 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"subaccount\" will match objects with name \"my subaccount\", \"subaccount 2015\", or simply \"subaccount\" .
      searchString :: (Core.Maybe Core.Text),
      -- | Field by which to sort the list.
      sortField :: SubaccountsListSortField,
      -- | Order of sorted results.
      sortOrder :: SubaccountsListSortOrder,
      -- | 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 'DFAReportingSubaccountsList' with the minimum fields required to make a request.
  newDFAReportingSubaccountsList ::
    -- |  User profile ID associated with this request. See 'profileId'.
    Core.Int64 ->
    DFAReportingSubaccountsList
  newDFAReportingSubaccountsList profileId =
    DFAReportingSubaccountsList
      { xgafv = Core.Nothing,
        accessToken = Core.Nothing,
        callback = Core.Nothing,
        ids = Core.Nothing,
        maxResults = 1000,
        pageToken = Core.Nothing,
        profileId = profileId,
        searchString = Core.Nothing,
        sortField = SubaccountsListSortField_ID,
        sortOrder = SubaccountsListSortOrder_Ascending,
        uploadType = Core.Nothing,
        uploadProtocol = Core.Nothing
      }
  
  instance Core.GoogleRequest DFAReportingSubaccountsList where
    type Rs DFAReportingSubaccountsList = SubaccountsListResponse
    type
      Scopes DFAReportingSubaccountsList =
        '[Dfatrafficking'FullControl]
    requestClient DFAReportingSubaccountsList {..} =
      go
        profileId
        xgafv
        accessToken
        callback
        (ids Core.^. Core._Default)
        (Core.Just maxResults)
        pageToken
        searchString
        (Core.Just sortField)
        (Core.Just sortOrder)
        uploadType
        uploadProtocol
        (Core.Just Core.AltJSON)
        dFAReportingService
      where
        go =
          Core.buildClient
            (Core.Proxy :: Core.Proxy DFAReportingSubaccountsListResource)
            Core.mempty
  