{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE TypeFamilies #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-binds #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}

-- Derived from AWS service descriptions, licensed under Apache 2.0.

-- |
-- Module      : Amazonka.MechanicalTurk.ListBonusPayments
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- The @ListBonusPayments@ operation retrieves the amounts of bonuses you
-- have paid to Workers for a given HIT or assignment.
--
-- This operation returns paginated results.
module Amazonka.MechanicalTurk.ListBonusPayments
  ( -- * Creating a Request
    ListBonusPayments (..),
    newListBonusPayments,

    -- * Request Lenses
    listBonusPayments_assignmentId,
    listBonusPayments_hITId,
    listBonusPayments_maxResults,
    listBonusPayments_nextToken,

    -- * Destructuring the Response
    ListBonusPaymentsResponse (..),
    newListBonusPaymentsResponse,

    -- * Response Lenses
    listBonusPaymentsResponse_bonusPayments,
    listBonusPaymentsResponse_nextToken,
    listBonusPaymentsResponse_numResults,
    listBonusPaymentsResponse_httpStatus,
  )
where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import Amazonka.MechanicalTurk.Types
import qualified Amazonka.Prelude as Prelude
import qualified Amazonka.Request as Request
import qualified Amazonka.Response as Response

-- | /See:/ 'newListBonusPayments' smart constructor.
data ListBonusPayments = ListBonusPayments'
  { -- | The ID of the assignment associated with the bonus payments to retrieve.
    -- If specified, only bonus payments for the given assignment are returned.
    -- Either the HITId parameter or the AssignmentId parameter must be
    -- specified
    ListBonusPayments -> Maybe Text
assignmentId :: Prelude.Maybe Prelude.Text,
    -- | The ID of the HIT associated with the bonus payments to retrieve. If not
    -- specified, all bonus payments for all assignments for the given HIT are
    -- returned. Either the HITId parameter or the AssignmentId parameter must
    -- be specified
    ListBonusPayments -> Maybe Text
hITId :: Prelude.Maybe Prelude.Text,
    ListBonusPayments -> Maybe Natural
maxResults :: Prelude.Maybe Prelude.Natural,
    -- | Pagination token
    ListBonusPayments -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text
  }
  deriving (ListBonusPayments -> ListBonusPayments -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ListBonusPayments -> ListBonusPayments -> Bool
$c/= :: ListBonusPayments -> ListBonusPayments -> Bool
== :: ListBonusPayments -> ListBonusPayments -> Bool
$c== :: ListBonusPayments -> ListBonusPayments -> Bool
Prelude.Eq, ReadPrec [ListBonusPayments]
ReadPrec ListBonusPayments
Int -> ReadS ListBonusPayments
ReadS [ListBonusPayments]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ListBonusPayments]
$creadListPrec :: ReadPrec [ListBonusPayments]
readPrec :: ReadPrec ListBonusPayments
$creadPrec :: ReadPrec ListBonusPayments
readList :: ReadS [ListBonusPayments]
$creadList :: ReadS [ListBonusPayments]
readsPrec :: Int -> ReadS ListBonusPayments
$creadsPrec :: Int -> ReadS ListBonusPayments
Prelude.Read, Int -> ListBonusPayments -> ShowS
[ListBonusPayments] -> ShowS
ListBonusPayments -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ListBonusPayments] -> ShowS
$cshowList :: [ListBonusPayments] -> ShowS
show :: ListBonusPayments -> String
$cshow :: ListBonusPayments -> String
showsPrec :: Int -> ListBonusPayments -> ShowS
$cshowsPrec :: Int -> ListBonusPayments -> ShowS
Prelude.Show, forall x. Rep ListBonusPayments x -> ListBonusPayments
forall x. ListBonusPayments -> Rep ListBonusPayments x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ListBonusPayments x -> ListBonusPayments
$cfrom :: forall x. ListBonusPayments -> Rep ListBonusPayments x
Prelude.Generic)

-- |
-- Create a value of 'ListBonusPayments' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'assignmentId', 'listBonusPayments_assignmentId' - The ID of the assignment associated with the bonus payments to retrieve.
-- If specified, only bonus payments for the given assignment are returned.
-- Either the HITId parameter or the AssignmentId parameter must be
-- specified
--
-- 'hITId', 'listBonusPayments_hITId' - The ID of the HIT associated with the bonus payments to retrieve. If not
-- specified, all bonus payments for all assignments for the given HIT are
-- returned. Either the HITId parameter or the AssignmentId parameter must
-- be specified
--
-- 'maxResults', 'listBonusPayments_maxResults' - Undocumented member.
--
-- 'nextToken', 'listBonusPayments_nextToken' - Pagination token
newListBonusPayments ::
  ListBonusPayments
newListBonusPayments :: ListBonusPayments
newListBonusPayments =
  ListBonusPayments'
    { $sel:assignmentId:ListBonusPayments' :: Maybe Text
assignmentId = forall a. Maybe a
Prelude.Nothing,
      $sel:hITId:ListBonusPayments' :: Maybe Text
hITId = forall a. Maybe a
Prelude.Nothing,
      $sel:maxResults:ListBonusPayments' :: Maybe Natural
maxResults = forall a. Maybe a
Prelude.Nothing,
      $sel:nextToken:ListBonusPayments' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing
    }

-- | The ID of the assignment associated with the bonus payments to retrieve.
-- If specified, only bonus payments for the given assignment are returned.
-- Either the HITId parameter or the AssignmentId parameter must be
-- specified
listBonusPayments_assignmentId :: Lens.Lens' ListBonusPayments (Prelude.Maybe Prelude.Text)
listBonusPayments_assignmentId :: Lens' ListBonusPayments (Maybe Text)
listBonusPayments_assignmentId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListBonusPayments' {Maybe Text
assignmentId :: Maybe Text
$sel:assignmentId:ListBonusPayments' :: ListBonusPayments -> Maybe Text
assignmentId} -> Maybe Text
assignmentId) (\s :: ListBonusPayments
s@ListBonusPayments' {} Maybe Text
a -> ListBonusPayments
s {$sel:assignmentId:ListBonusPayments' :: Maybe Text
assignmentId = Maybe Text
a} :: ListBonusPayments)

-- | The ID of the HIT associated with the bonus payments to retrieve. If not
-- specified, all bonus payments for all assignments for the given HIT are
-- returned. Either the HITId parameter or the AssignmentId parameter must
-- be specified
listBonusPayments_hITId :: Lens.Lens' ListBonusPayments (Prelude.Maybe Prelude.Text)
listBonusPayments_hITId :: Lens' ListBonusPayments (Maybe Text)
listBonusPayments_hITId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListBonusPayments' {Maybe Text
hITId :: Maybe Text
$sel:hITId:ListBonusPayments' :: ListBonusPayments -> Maybe Text
hITId} -> Maybe Text
hITId) (\s :: ListBonusPayments
s@ListBonusPayments' {} Maybe Text
a -> ListBonusPayments
s {$sel:hITId:ListBonusPayments' :: Maybe Text
hITId = Maybe Text
a} :: ListBonusPayments)

-- | Undocumented member.
listBonusPayments_maxResults :: Lens.Lens' ListBonusPayments (Prelude.Maybe Prelude.Natural)
listBonusPayments_maxResults :: Lens' ListBonusPayments (Maybe Natural)
listBonusPayments_maxResults = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListBonusPayments' {Maybe Natural
maxResults :: Maybe Natural
$sel:maxResults:ListBonusPayments' :: ListBonusPayments -> Maybe Natural
maxResults} -> Maybe Natural
maxResults) (\s :: ListBonusPayments
s@ListBonusPayments' {} Maybe Natural
a -> ListBonusPayments
s {$sel:maxResults:ListBonusPayments' :: Maybe Natural
maxResults = Maybe Natural
a} :: ListBonusPayments)

-- | Pagination token
listBonusPayments_nextToken :: Lens.Lens' ListBonusPayments (Prelude.Maybe Prelude.Text)
listBonusPayments_nextToken :: Lens' ListBonusPayments (Maybe Text)
listBonusPayments_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListBonusPayments' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:ListBonusPayments' :: ListBonusPayments -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: ListBonusPayments
s@ListBonusPayments' {} Maybe Text
a -> ListBonusPayments
s {$sel:nextToken:ListBonusPayments' :: Maybe Text
nextToken = Maybe Text
a} :: ListBonusPayments)

instance Core.AWSPager ListBonusPayments where
  page :: ListBonusPayments
-> AWSResponse ListBonusPayments -> Maybe ListBonusPayments
page ListBonusPayments
rq AWSResponse ListBonusPayments
rs
    | forall a. AWSTruncated a => a -> Bool
Core.stop
        ( AWSResponse ListBonusPayments
rs
            forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' ListBonusPaymentsResponse (Maybe Text)
listBonusPaymentsResponse_nextToken
            forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall a b. Prism (Maybe a) (Maybe b) a b
Lens._Just
        ) =
        forall a. Maybe a
Prelude.Nothing
    | forall a. AWSTruncated a => a -> Bool
Core.stop
        ( AWSResponse ListBonusPayments
rs
            forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' ListBonusPaymentsResponse (Maybe [BonusPayment])
listBonusPaymentsResponse_bonusPayments
            forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall a b. Prism (Maybe a) (Maybe b) a b
Lens._Just
        ) =
        forall a. Maybe a
Prelude.Nothing
    | Bool
Prelude.otherwise =
        forall a. a -> Maybe a
Prelude.Just
          forall a b. (a -> b) -> a -> b
Prelude.$ ListBonusPayments
rq
          forall a b. a -> (a -> b) -> b
Prelude.& Lens' ListBonusPayments (Maybe Text)
listBonusPayments_nextToken
          forall s t a b. ASetter s t a b -> b -> s -> t
Lens..~ AWSResponse ListBonusPayments
rs
          forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' ListBonusPaymentsResponse (Maybe Text)
listBonusPaymentsResponse_nextToken
          forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall a b. Prism (Maybe a) (Maybe b) a b
Lens._Just

instance Core.AWSRequest ListBonusPayments where
  type
    AWSResponse ListBonusPayments =
      ListBonusPaymentsResponse
  request :: (Service -> Service)
-> ListBonusPayments -> Request ListBonusPayments
request Service -> Service
overrides =
    forall a. (ToRequest a, ToJSON a) => Service -> a -> Request a
Request.postJSON (Service -> Service
overrides Service
defaultService)
  response :: forall (m :: * -> *).
MonadResource m =>
(ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy ListBonusPayments
-> ClientResponse ClientBody
-> m (Either
        Error (ClientResponse (AWSResponse ListBonusPayments)))
response =
    forall (m :: * -> *) a.
MonadResource m =>
(Int -> ResponseHeaders -> Object -> Either String (AWSResponse a))
-> (ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy a
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse a)))
Response.receiveJSON
      ( \Int
s ResponseHeaders
h Object
x ->
          Maybe [BonusPayment]
-> Maybe Text -> Maybe Int -> Int -> ListBonusPaymentsResponse
ListBonusPaymentsResponse'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x forall a. FromJSON a => Object -> Key -> Either String (Maybe a)
Data..?> Key
"BonusPayments" forall (f :: * -> *) a. Functor f => f (Maybe a) -> a -> f a
Core..!@ forall a. Monoid a => a
Prelude.mempty)
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Either String (Maybe a)
Data..?> Key
"NextToken")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Either String (Maybe a)
Data..?> Key
"NumResults")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (forall (f :: * -> *) a. Applicative f => a -> f a
Prelude.pure (forall a. Enum a => a -> Int
Prelude.fromEnum Int
s))
      )

instance Prelude.Hashable ListBonusPayments where
  hashWithSalt :: Int -> ListBonusPayments -> Int
hashWithSalt Int
_salt ListBonusPayments' {Maybe Natural
Maybe Text
nextToken :: Maybe Text
maxResults :: Maybe Natural
hITId :: Maybe Text
assignmentId :: Maybe Text
$sel:nextToken:ListBonusPayments' :: ListBonusPayments -> Maybe Text
$sel:maxResults:ListBonusPayments' :: ListBonusPayments -> Maybe Natural
$sel:hITId:ListBonusPayments' :: ListBonusPayments -> Maybe Text
$sel:assignmentId:ListBonusPayments' :: ListBonusPayments -> Maybe Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
assignmentId
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
hITId
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Natural
maxResults
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
nextToken

instance Prelude.NFData ListBonusPayments where
  rnf :: ListBonusPayments -> ()
rnf ListBonusPayments' {Maybe Natural
Maybe Text
nextToken :: Maybe Text
maxResults :: Maybe Natural
hITId :: Maybe Text
assignmentId :: Maybe Text
$sel:nextToken:ListBonusPayments' :: ListBonusPayments -> Maybe Text
$sel:maxResults:ListBonusPayments' :: ListBonusPayments -> Maybe Natural
$sel:hITId:ListBonusPayments' :: ListBonusPayments -> Maybe Text
$sel:assignmentId:ListBonusPayments' :: ListBonusPayments -> Maybe Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
assignmentId
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
hITId
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Natural
maxResults
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
nextToken

instance Data.ToHeaders ListBonusPayments where
  toHeaders :: ListBonusPayments -> ResponseHeaders
toHeaders =
    forall a b. a -> b -> a
Prelude.const
      ( forall a. Monoid a => [a] -> a
Prelude.mconcat
          [ HeaderName
"X-Amz-Target"
              forall a. ToHeader a => HeaderName -> a -> ResponseHeaders
Data.=# ( ByteString
"MTurkRequesterServiceV20170117.ListBonusPayments" ::
                          Prelude.ByteString
                      ),
            HeaderName
"Content-Type"
              forall a. ToHeader a => HeaderName -> a -> ResponseHeaders
Data.=# ( ByteString
"application/x-amz-json-1.1" ::
                          Prelude.ByteString
                      )
          ]
      )

instance Data.ToJSON ListBonusPayments where
  toJSON :: ListBonusPayments -> Value
toJSON ListBonusPayments' {Maybe Natural
Maybe Text
nextToken :: Maybe Text
maxResults :: Maybe Natural
hITId :: Maybe Text
assignmentId :: Maybe Text
$sel:nextToken:ListBonusPayments' :: ListBonusPayments -> Maybe Text
$sel:maxResults:ListBonusPayments' :: ListBonusPayments -> Maybe Natural
$sel:hITId:ListBonusPayments' :: ListBonusPayments -> Maybe Text
$sel:assignmentId:ListBonusPayments' :: ListBonusPayments -> Maybe Text
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"AssignmentId" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
assignmentId,
            (Key
"HITId" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
hITId,
            (Key
"MaxResults" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Natural
maxResults,
            (Key
"NextToken" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
nextToken
          ]
      )

instance Data.ToPath ListBonusPayments where
  toPath :: ListBonusPayments -> ByteString
toPath = forall a b. a -> b -> a
Prelude.const ByteString
"/"

instance Data.ToQuery ListBonusPayments where
  toQuery :: ListBonusPayments -> QueryString
toQuery = forall a b. a -> b -> a
Prelude.const forall a. Monoid a => a
Prelude.mempty

-- | /See:/ 'newListBonusPaymentsResponse' smart constructor.
data ListBonusPaymentsResponse = ListBonusPaymentsResponse'
  { -- | A successful request to the ListBonusPayments operation returns a list
    -- of BonusPayment objects.
    ListBonusPaymentsResponse -> Maybe [BonusPayment]
bonusPayments :: Prelude.Maybe [BonusPayment],
    ListBonusPaymentsResponse -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text,
    -- | The number of bonus payments on this page in the filtered results list,
    -- equivalent to the number of bonus payments being returned by this call.
    ListBonusPaymentsResponse -> Maybe Int
numResults :: Prelude.Maybe Prelude.Int,
    -- | The response's http status code.
    ListBonusPaymentsResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (ListBonusPaymentsResponse -> ListBonusPaymentsResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ListBonusPaymentsResponse -> ListBonusPaymentsResponse -> Bool
$c/= :: ListBonusPaymentsResponse -> ListBonusPaymentsResponse -> Bool
== :: ListBonusPaymentsResponse -> ListBonusPaymentsResponse -> Bool
$c== :: ListBonusPaymentsResponse -> ListBonusPaymentsResponse -> Bool
Prelude.Eq, ReadPrec [ListBonusPaymentsResponse]
ReadPrec ListBonusPaymentsResponse
Int -> ReadS ListBonusPaymentsResponse
ReadS [ListBonusPaymentsResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ListBonusPaymentsResponse]
$creadListPrec :: ReadPrec [ListBonusPaymentsResponse]
readPrec :: ReadPrec ListBonusPaymentsResponse
$creadPrec :: ReadPrec ListBonusPaymentsResponse
readList :: ReadS [ListBonusPaymentsResponse]
$creadList :: ReadS [ListBonusPaymentsResponse]
readsPrec :: Int -> ReadS ListBonusPaymentsResponse
$creadsPrec :: Int -> ReadS ListBonusPaymentsResponse
Prelude.Read, Int -> ListBonusPaymentsResponse -> ShowS
[ListBonusPaymentsResponse] -> ShowS
ListBonusPaymentsResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ListBonusPaymentsResponse] -> ShowS
$cshowList :: [ListBonusPaymentsResponse] -> ShowS
show :: ListBonusPaymentsResponse -> String
$cshow :: ListBonusPaymentsResponse -> String
showsPrec :: Int -> ListBonusPaymentsResponse -> ShowS
$cshowsPrec :: Int -> ListBonusPaymentsResponse -> ShowS
Prelude.Show, forall x.
Rep ListBonusPaymentsResponse x -> ListBonusPaymentsResponse
forall x.
ListBonusPaymentsResponse -> Rep ListBonusPaymentsResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep ListBonusPaymentsResponse x -> ListBonusPaymentsResponse
$cfrom :: forall x.
ListBonusPaymentsResponse -> Rep ListBonusPaymentsResponse x
Prelude.Generic)

-- |
-- Create a value of 'ListBonusPaymentsResponse' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'bonusPayments', 'listBonusPaymentsResponse_bonusPayments' - A successful request to the ListBonusPayments operation returns a list
-- of BonusPayment objects.
--
-- 'nextToken', 'listBonusPaymentsResponse_nextToken' - Undocumented member.
--
-- 'numResults', 'listBonusPaymentsResponse_numResults' - The number of bonus payments on this page in the filtered results list,
-- equivalent to the number of bonus payments being returned by this call.
--
-- 'httpStatus', 'listBonusPaymentsResponse_httpStatus' - The response's http status code.
newListBonusPaymentsResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  ListBonusPaymentsResponse
newListBonusPaymentsResponse :: Int -> ListBonusPaymentsResponse
newListBonusPaymentsResponse Int
pHttpStatus_ =
  ListBonusPaymentsResponse'
    { $sel:bonusPayments:ListBonusPaymentsResponse' :: Maybe [BonusPayment]
bonusPayments =
        forall a. Maybe a
Prelude.Nothing,
      $sel:nextToken:ListBonusPaymentsResponse' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing,
      $sel:numResults:ListBonusPaymentsResponse' :: Maybe Int
numResults = forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:ListBonusPaymentsResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | A successful request to the ListBonusPayments operation returns a list
-- of BonusPayment objects.
listBonusPaymentsResponse_bonusPayments :: Lens.Lens' ListBonusPaymentsResponse (Prelude.Maybe [BonusPayment])
listBonusPaymentsResponse_bonusPayments :: Lens' ListBonusPaymentsResponse (Maybe [BonusPayment])
listBonusPaymentsResponse_bonusPayments = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListBonusPaymentsResponse' {Maybe [BonusPayment]
bonusPayments :: Maybe [BonusPayment]
$sel:bonusPayments:ListBonusPaymentsResponse' :: ListBonusPaymentsResponse -> Maybe [BonusPayment]
bonusPayments} -> Maybe [BonusPayment]
bonusPayments) (\s :: ListBonusPaymentsResponse
s@ListBonusPaymentsResponse' {} Maybe [BonusPayment]
a -> ListBonusPaymentsResponse
s {$sel:bonusPayments:ListBonusPaymentsResponse' :: Maybe [BonusPayment]
bonusPayments = Maybe [BonusPayment]
a} :: ListBonusPaymentsResponse) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | Undocumented member.
listBonusPaymentsResponse_nextToken :: Lens.Lens' ListBonusPaymentsResponse (Prelude.Maybe Prelude.Text)
listBonusPaymentsResponse_nextToken :: Lens' ListBonusPaymentsResponse (Maybe Text)
listBonusPaymentsResponse_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListBonusPaymentsResponse' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:ListBonusPaymentsResponse' :: ListBonusPaymentsResponse -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: ListBonusPaymentsResponse
s@ListBonusPaymentsResponse' {} Maybe Text
a -> ListBonusPaymentsResponse
s {$sel:nextToken:ListBonusPaymentsResponse' :: Maybe Text
nextToken = Maybe Text
a} :: ListBonusPaymentsResponse)

-- | The number of bonus payments on this page in the filtered results list,
-- equivalent to the number of bonus payments being returned by this call.
listBonusPaymentsResponse_numResults :: Lens.Lens' ListBonusPaymentsResponse (Prelude.Maybe Prelude.Int)
listBonusPaymentsResponse_numResults :: Lens' ListBonusPaymentsResponse (Maybe Int)
listBonusPaymentsResponse_numResults = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListBonusPaymentsResponse' {Maybe Int
numResults :: Maybe Int
$sel:numResults:ListBonusPaymentsResponse' :: ListBonusPaymentsResponse -> Maybe Int
numResults} -> Maybe Int
numResults) (\s :: ListBonusPaymentsResponse
s@ListBonusPaymentsResponse' {} Maybe Int
a -> ListBonusPaymentsResponse
s {$sel:numResults:ListBonusPaymentsResponse' :: Maybe Int
numResults = Maybe Int
a} :: ListBonusPaymentsResponse)

-- | The response's http status code.
listBonusPaymentsResponse_httpStatus :: Lens.Lens' ListBonusPaymentsResponse Prelude.Int
listBonusPaymentsResponse_httpStatus :: Lens' ListBonusPaymentsResponse Int
listBonusPaymentsResponse_httpStatus = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListBonusPaymentsResponse' {Int
httpStatus :: Int
$sel:httpStatus:ListBonusPaymentsResponse' :: ListBonusPaymentsResponse -> Int
httpStatus} -> Int
httpStatus) (\s :: ListBonusPaymentsResponse
s@ListBonusPaymentsResponse' {} Int
a -> ListBonusPaymentsResponse
s {$sel:httpStatus:ListBonusPaymentsResponse' :: Int
httpStatus = Int
a} :: ListBonusPaymentsResponse)

instance Prelude.NFData ListBonusPaymentsResponse where
  rnf :: ListBonusPaymentsResponse -> ()
rnf ListBonusPaymentsResponse' {Int
Maybe Int
Maybe [BonusPayment]
Maybe Text
httpStatus :: Int
numResults :: Maybe Int
nextToken :: Maybe Text
bonusPayments :: Maybe [BonusPayment]
$sel:httpStatus:ListBonusPaymentsResponse' :: ListBonusPaymentsResponse -> Int
$sel:numResults:ListBonusPaymentsResponse' :: ListBonusPaymentsResponse -> Maybe Int
$sel:nextToken:ListBonusPaymentsResponse' :: ListBonusPaymentsResponse -> Maybe Text
$sel:bonusPayments:ListBonusPaymentsResponse' :: ListBonusPaymentsResponse -> Maybe [BonusPayment]
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe [BonusPayment]
bonusPayments
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
nextToken
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Int
numResults
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Int
httpStatus