ListQualificationRequests.hs

{-# 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.ListQualificationRequests
-- 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 @ListQualificationRequests@ operation retrieves requests for
-- Qualifications of a particular Qualification type. The owner of the
-- Qualification type calls this operation to poll for pending requests,
-- and accepts them using the AcceptQualification operation.
--
-- This operation returns paginated results.
module Amazonka.MechanicalTurk.ListQualificationRequests
  ( -- * Creating a Request
    ListQualificationRequests (..),
    newListQualificationRequests,

    -- * Request Lenses
    listQualificationRequests_maxResults,
    listQualificationRequests_nextToken,
    listQualificationRequests_qualificationTypeId,

    -- * Destructuring the Response
    ListQualificationRequestsResponse (..),
    newListQualificationRequestsResponse,

    -- * Response Lenses
    listQualificationRequestsResponse_nextToken,
    listQualificationRequestsResponse_numResults,
    listQualificationRequestsResponse_qualificationRequests,
    listQualificationRequestsResponse_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:/ 'newListQualificationRequests' smart constructor.
data ListQualificationRequests = ListQualificationRequests'
  { -- | The maximum number of results to return in a single call.
    maxResults :: Prelude.Maybe Prelude.Natural,
    nextToken :: Prelude.Maybe Prelude.Text,
    -- | The ID of the QualificationType.
    qualificationTypeId :: Prelude.Maybe Prelude.Text
  }
  deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic)

-- |
-- Create a value of 'ListQualificationRequests' 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:
--
-- 'maxResults', 'listQualificationRequests_maxResults' - The maximum number of results to return in a single call.
--
-- 'nextToken', 'listQualificationRequests_nextToken' - Undocumented member.
--
-- 'qualificationTypeId', 'listQualificationRequests_qualificationTypeId' - The ID of the QualificationType.
newListQualificationRequests ::
  ListQualificationRequests
newListQualificationRequests =
  ListQualificationRequests'
    { maxResults =
        Prelude.Nothing,
      nextToken = Prelude.Nothing,
      qualificationTypeId = Prelude.Nothing
    }

-- | The maximum number of results to return in a single call.
listQualificationRequests_maxResults :: Lens.Lens' ListQualificationRequests (Prelude.Maybe Prelude.Natural)
listQualificationRequests_maxResults = Lens.lens (\ListQualificationRequests' {maxResults} -> maxResults) (\s@ListQualificationRequests' {} a -> s {maxResults = a} :: ListQualificationRequests)

-- | Undocumented member.
listQualificationRequests_nextToken :: Lens.Lens' ListQualificationRequests (Prelude.Maybe Prelude.Text)
listQualificationRequests_nextToken = Lens.lens (\ListQualificationRequests' {nextToken} -> nextToken) (\s@ListQualificationRequests' {} a -> s {nextToken = a} :: ListQualificationRequests)

-- | The ID of the QualificationType.
listQualificationRequests_qualificationTypeId :: Lens.Lens' ListQualificationRequests (Prelude.Maybe Prelude.Text)
listQualificationRequests_qualificationTypeId = Lens.lens (\ListQualificationRequests' {qualificationTypeId} -> qualificationTypeId) (\s@ListQualificationRequests' {} a -> s {qualificationTypeId = a} :: ListQualificationRequests)

instance Core.AWSPager ListQualificationRequests where
  page rq rs
    | Core.stop
        ( rs
            Lens.^? listQualificationRequestsResponse_nextToken
            Prelude.. Lens._Just
        ) =
        Prelude.Nothing
    | Core.stop
        ( rs
            Lens.^? listQualificationRequestsResponse_qualificationRequests
            Prelude.. Lens._Just
        ) =
        Prelude.Nothing
    | Prelude.otherwise =
        Prelude.Just
          Prelude.$ rq
          Prelude.& listQualificationRequests_nextToken
          Lens..~ rs
          Lens.^? listQualificationRequestsResponse_nextToken
          Prelude.. Lens._Just

instance Core.AWSRequest ListQualificationRequests where
  type
    AWSResponse ListQualificationRequests =
      ListQualificationRequestsResponse
  request overrides =
    Request.postJSON (overrides defaultService)
  response =
    Response.receiveJSON
      ( \s h x ->
          ListQualificationRequestsResponse'
            Prelude.<$> (x Data..?> "NextToken")
            Prelude.<*> (x Data..?> "NumResults")
            Prelude.<*> ( x
                            Data..?> "QualificationRequests"
                            Core..!@ Prelude.mempty
                        )
            Prelude.<*> (Prelude.pure (Prelude.fromEnum s))
      )

instance Prelude.Hashable ListQualificationRequests where
  hashWithSalt _salt ListQualificationRequests' {..} =
    _salt
      `Prelude.hashWithSalt` maxResults
      `Prelude.hashWithSalt` nextToken
      `Prelude.hashWithSalt` qualificationTypeId

instance Prelude.NFData ListQualificationRequests where
  rnf ListQualificationRequests' {..} =
    Prelude.rnf maxResults
      `Prelude.seq` Prelude.rnf nextToken
      `Prelude.seq` Prelude.rnf qualificationTypeId

instance Data.ToHeaders ListQualificationRequests where
  toHeaders =
    Prelude.const
      ( Prelude.mconcat
          [ "X-Amz-Target"
              Data.=# ( "MTurkRequesterServiceV20170117.ListQualificationRequests" ::
                          Prelude.ByteString
                      ),
            "Content-Type"
              Data.=# ( "application/x-amz-json-1.1" ::
                          Prelude.ByteString
                      )
          ]
      )

instance Data.ToJSON ListQualificationRequests where
  toJSON ListQualificationRequests' {..} =
    Data.object
      ( Prelude.catMaybes
          [ ("MaxResults" Data..=) Prelude.<$> maxResults,
            ("NextToken" Data..=) Prelude.<$> nextToken,
            ("QualificationTypeId" Data..=)
              Prelude.<$> qualificationTypeId
          ]
      )

instance Data.ToPath ListQualificationRequests where
  toPath = Prelude.const "/"

instance Data.ToQuery ListQualificationRequests where
  toQuery = Prelude.const Prelude.mempty

-- | /See:/ 'newListQualificationRequestsResponse' smart constructor.
data ListQualificationRequestsResponse = ListQualificationRequestsResponse'
  { nextToken :: Prelude.Maybe Prelude.Text,
    -- | The number of Qualification requests on this page in the filtered
    -- results list, equivalent to the number of Qualification requests being
    -- returned by this call.
    numResults :: Prelude.Maybe Prelude.Int,
    -- | The Qualification request. The response includes one
    -- QualificationRequest element for each Qualification request returned by
    -- the query.
    qualificationRequests :: Prelude.Maybe [QualificationRequest],
    -- | The response's http status code.
    httpStatus :: Prelude.Int
  }
  deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic)

-- |
-- Create a value of 'ListQualificationRequestsResponse' 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:
--
-- 'nextToken', 'listQualificationRequestsResponse_nextToken' - Undocumented member.
--
-- 'numResults', 'listQualificationRequestsResponse_numResults' - The number of Qualification requests on this page in the filtered
-- results list, equivalent to the number of Qualification requests being
-- returned by this call.
--
-- 'qualificationRequests', 'listQualificationRequestsResponse_qualificationRequests' - The Qualification request. The response includes one
-- QualificationRequest element for each Qualification request returned by
-- the query.
--
-- 'httpStatus', 'listQualificationRequestsResponse_httpStatus' - The response's http status code.
newListQualificationRequestsResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  ListQualificationRequestsResponse
newListQualificationRequestsResponse pHttpStatus_ =
  ListQualificationRequestsResponse'
    { nextToken =
        Prelude.Nothing,
      numResults = Prelude.Nothing,
      qualificationRequests = Prelude.Nothing,
      httpStatus = pHttpStatus_
    }

-- | Undocumented member.
listQualificationRequestsResponse_nextToken :: Lens.Lens' ListQualificationRequestsResponse (Prelude.Maybe Prelude.Text)
listQualificationRequestsResponse_nextToken = Lens.lens (\ListQualificationRequestsResponse' {nextToken} -> nextToken) (\s@ListQualificationRequestsResponse' {} a -> s {nextToken = a} :: ListQualificationRequestsResponse)

-- | The number of Qualification requests on this page in the filtered
-- results list, equivalent to the number of Qualification requests being
-- returned by this call.
listQualificationRequestsResponse_numResults :: Lens.Lens' ListQualificationRequestsResponse (Prelude.Maybe Prelude.Int)
listQualificationRequestsResponse_numResults = Lens.lens (\ListQualificationRequestsResponse' {numResults} -> numResults) (\s@ListQualificationRequestsResponse' {} a -> s {numResults = a} :: ListQualificationRequestsResponse)

-- | The Qualification request. The response includes one
-- QualificationRequest element for each Qualification request returned by
-- the query.
listQualificationRequestsResponse_qualificationRequests :: Lens.Lens' ListQualificationRequestsResponse (Prelude.Maybe [QualificationRequest])
listQualificationRequestsResponse_qualificationRequests = Lens.lens (\ListQualificationRequestsResponse' {qualificationRequests} -> qualificationRequests) (\s@ListQualificationRequestsResponse' {} a -> s {qualificationRequests = a} :: ListQualificationRequestsResponse) Prelude.. Lens.mapping Lens.coerced

-- | The response's http status code.
listQualificationRequestsResponse_httpStatus :: Lens.Lens' ListQualificationRequestsResponse Prelude.Int
listQualificationRequestsResponse_httpStatus = Lens.lens (\ListQualificationRequestsResponse' {httpStatus} -> httpStatus) (\s@ListQualificationRequestsResponse' {} a -> s {httpStatus = a} :: ListQualificationRequestsResponse)

instance
  Prelude.NFData
    ListQualificationRequestsResponse
  where
  rnf ListQualificationRequestsResponse' {..} =
    Prelude.rnf nextToken
      `Prelude.seq` Prelude.rnf numResults
      `Prelude.seq` Prelude.rnf qualificationRequests
      `Prelude.seq` Prelude.rnf httpStatus