{-# 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.PlusDomains.People.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 all of the people in the specified collection.
--
-- /See:/ <https://developers.google.com/+/domains/ Google+ Domains API Reference> for @plusDomains.people.list@.
module Gogol.PlusDomains.People.List
  ( -- * Resource
    PlusDomainsPeopleListResource,

    -- ** Constructing a Request
    PlusDomainsPeopleList (..),
    newPlusDomainsPeopleList,
  )
where

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

-- | A resource alias for @plusDomains.people.list@ method which the
-- 'PlusDomainsPeopleList' request conforms to.
type PlusDomainsPeopleListResource =
  "plusDomains"
    Core.:> "v1"
    Core.:> "people"
    Core.:> Core.Capture "userId" Core.Text
    Core.:> "people"
    Core.:> Core.Capture "collection" PeopleListCollection
    Core.:> Core.QueryParam "maxResults" Core.Word32
    Core.:> Core.QueryParam "orderBy" PeopleListOrderBy
    Core.:> Core.QueryParam "pageToken" Core.Text
    Core.:> Core.QueryParam "alt" Core.AltJSON
    Core.:> Core.Get '[Core.JSON] PeopleFeed

-- | List all of the people in the specified collection.
--
-- /See:/ 'newPlusDomainsPeopleList' smart constructor.
data PlusDomainsPeopleList = PlusDomainsPeopleList
  { -- | The collection of people to list.
    collection :: PeopleListCollection,
    -- | The maximum number of people to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults.
    maxResults :: Core.Word32,
    -- | The order to return people in.
    orderBy :: (Core.Maybe PeopleListOrderBy),
    -- | The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of \"nextPageToken\" from the previous response.
    pageToken :: (Core.Maybe Core.Text),
    -- | Get the collection of people for the person identified. Use \"me\" to indicate the authenticated user.
    userId :: Core.Text
  }
  deriving (Core.Eq, Core.Show, Core.Generic)

-- | Creates a value of 'PlusDomainsPeopleList' with the minimum fields required to make a request.
newPlusDomainsPeopleList ::
  -- |  The collection of people to list. See 'collection'.
  PeopleListCollection ->
  -- |  Get the collection of people for the person identified. Use \"me\" to indicate the authenticated user. See 'userId'.
  Core.Text ->
  PlusDomainsPeopleList
newPlusDomainsPeopleList collection userId =
  PlusDomainsPeopleList
    { collection = collection,
      maxResults = 100,
      orderBy = Core.Nothing,
      pageToken = Core.Nothing,
      userId = userId
    }

instance Core.GoogleRequest PlusDomainsPeopleList where
  type Rs PlusDomainsPeopleList = PeopleFeed
  type
    Scopes PlusDomainsPeopleList =
      '[Plus'Circles'Read, Plus'Login, Plus'Me]
  requestClient PlusDomainsPeopleList {..} =
    go
      userId
      collection
      (Core.Just maxResults)
      orderBy
      pageToken
      (Core.Just Core.AltJSON)
      plusDomainsService
    where
      go =
        Core.buildClient
          (Core.Proxy :: Core.Proxy PlusDomainsPeopleListResource)
          Core.mempty