{-# 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.DeviceFarm.ListOfferings
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Returns a list of products or offerings that the user can manage through
-- the API. Each offering record indicates the recurring price per unit and
-- the frequency for that offering. The API returns a @NotEligible@ error
-- if the user is not permitted to invoke the operation. If you must be
-- able to invoke this operation, contact
-- <mailto:aws-devicefarm-support@amazon.com aws-devicefarm-support\@amazon.com>.
--
-- This operation returns paginated results.
module Amazonka.DeviceFarm.ListOfferings
  ( -- * Creating a Request
    ListOfferings (..),
    newListOfferings,

    -- * Request Lenses
    listOfferings_nextToken,

    -- * Destructuring the Response
    ListOfferingsResponse (..),
    newListOfferingsResponse,

    -- * Response Lenses
    listOfferingsResponse_nextToken,
    listOfferingsResponse_offerings,
    listOfferingsResponse_httpStatus,
  )
where

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

-- | Represents the request to list all offerings.
--
-- /See:/ 'newListOfferings' smart constructor.
data ListOfferings = ListOfferings'
  { -- | An identifier that was returned from the previous call to this
    -- operation, which can be used to return the next set of items in the
    -- list.
    ListOfferings -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text
  }
  deriving (ListOfferings -> ListOfferings -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ListOfferings -> ListOfferings -> Bool
$c/= :: ListOfferings -> ListOfferings -> Bool
== :: ListOfferings -> ListOfferings -> Bool
$c== :: ListOfferings -> ListOfferings -> Bool
Prelude.Eq, ReadPrec [ListOfferings]
ReadPrec ListOfferings
Int -> ReadS ListOfferings
ReadS [ListOfferings]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ListOfferings]
$creadListPrec :: ReadPrec [ListOfferings]
readPrec :: ReadPrec ListOfferings
$creadPrec :: ReadPrec ListOfferings
readList :: ReadS [ListOfferings]
$creadList :: ReadS [ListOfferings]
readsPrec :: Int -> ReadS ListOfferings
$creadsPrec :: Int -> ReadS ListOfferings
Prelude.Read, Int -> ListOfferings -> ShowS
[ListOfferings] -> ShowS
ListOfferings -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ListOfferings] -> ShowS
$cshowList :: [ListOfferings] -> ShowS
show :: ListOfferings -> String
$cshow :: ListOfferings -> String
showsPrec :: Int -> ListOfferings -> ShowS
$cshowsPrec :: Int -> ListOfferings -> ShowS
Prelude.Show, forall x. Rep ListOfferings x -> ListOfferings
forall x. ListOfferings -> Rep ListOfferings x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ListOfferings x -> ListOfferings
$cfrom :: forall x. ListOfferings -> Rep ListOfferings x
Prelude.Generic)

-- |
-- Create a value of 'ListOfferings' 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', 'listOfferings_nextToken' - An identifier that was returned from the previous call to this
-- operation, which can be used to return the next set of items in the
-- list.
newListOfferings ::
  ListOfferings
newListOfferings :: ListOfferings
newListOfferings =
  ListOfferings' {$sel:nextToken:ListOfferings' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing}

-- | An identifier that was returned from the previous call to this
-- operation, which can be used to return the next set of items in the
-- list.
listOfferings_nextToken :: Lens.Lens' ListOfferings (Prelude.Maybe Prelude.Text)
listOfferings_nextToken :: Lens' ListOfferings (Maybe Text)
listOfferings_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListOfferings' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:ListOfferings' :: ListOfferings -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: ListOfferings
s@ListOfferings' {} Maybe Text
a -> ListOfferings
s {$sel:nextToken:ListOfferings' :: Maybe Text
nextToken = Maybe Text
a} :: ListOfferings)

instance Core.AWSPager ListOfferings where
  page :: ListOfferings -> AWSResponse ListOfferings -> Maybe ListOfferings
page ListOfferings
rq AWSResponse ListOfferings
rs
    | forall a. AWSTruncated a => a -> Bool
Core.stop
        ( AWSResponse ListOfferings
rs
            forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' ListOfferingsResponse (Maybe Text)
listOfferingsResponse_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 ListOfferings
rs
            forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' ListOfferingsResponse (Maybe [Offering])
listOfferingsResponse_offerings
            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.$ ListOfferings
rq
          forall a b. a -> (a -> b) -> b
Prelude.& Lens' ListOfferings (Maybe Text)
listOfferings_nextToken
          forall s t a b. ASetter s t a b -> b -> s -> t
Lens..~ AWSResponse ListOfferings
rs
          forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' ListOfferingsResponse (Maybe Text)
listOfferingsResponse_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 ListOfferings where
  type
    AWSResponse ListOfferings =
      ListOfferingsResponse
  request :: (Service -> Service) -> ListOfferings -> Request ListOfferings
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 ListOfferings
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse ListOfferings)))
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 Text -> Maybe [Offering] -> Int -> ListOfferingsResponse
ListOfferingsResponse'
            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
"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
"offerings" 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.<*> (forall (f :: * -> *) a. Applicative f => a -> f a
Prelude.pure (forall a. Enum a => a -> Int
Prelude.fromEnum Int
s))
      )

instance Prelude.Hashable ListOfferings where
  hashWithSalt :: Int -> ListOfferings -> Int
hashWithSalt Int
_salt ListOfferings' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:ListOfferings' :: ListOfferings -> Maybe Text
..} =
    Int
_salt forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
nextToken

instance Prelude.NFData ListOfferings where
  rnf :: ListOfferings -> ()
rnf ListOfferings' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:ListOfferings' :: ListOfferings -> Maybe Text
..} = forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
nextToken

instance Data.ToHeaders ListOfferings where
  toHeaders :: ListOfferings -> 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
"DeviceFarm_20150623.ListOfferings" ::
                          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 ListOfferings where
  toJSON :: ListOfferings -> Value
toJSON ListOfferings' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:ListOfferings' :: ListOfferings -> Maybe Text
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [(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 ListOfferings where
  toPath :: ListOfferings -> ByteString
toPath = forall a b. a -> b -> a
Prelude.const ByteString
"/"

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

-- | Represents the return values of the list of offerings.
--
-- /See:/ 'newListOfferingsResponse' smart constructor.
data ListOfferingsResponse = ListOfferingsResponse'
  { -- | An identifier that was returned from the previous call to this
    -- operation, which can be used to return the next set of items in the
    -- list.
    ListOfferingsResponse -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text,
    -- | A value that represents the list offering results.
    ListOfferingsResponse -> Maybe [Offering]
offerings :: Prelude.Maybe [Offering],
    -- | The response's http status code.
    ListOfferingsResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (ListOfferingsResponse -> ListOfferingsResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ListOfferingsResponse -> ListOfferingsResponse -> Bool
$c/= :: ListOfferingsResponse -> ListOfferingsResponse -> Bool
== :: ListOfferingsResponse -> ListOfferingsResponse -> Bool
$c== :: ListOfferingsResponse -> ListOfferingsResponse -> Bool
Prelude.Eq, ReadPrec [ListOfferingsResponse]
ReadPrec ListOfferingsResponse
Int -> ReadS ListOfferingsResponse
ReadS [ListOfferingsResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ListOfferingsResponse]
$creadListPrec :: ReadPrec [ListOfferingsResponse]
readPrec :: ReadPrec ListOfferingsResponse
$creadPrec :: ReadPrec ListOfferingsResponse
readList :: ReadS [ListOfferingsResponse]
$creadList :: ReadS [ListOfferingsResponse]
readsPrec :: Int -> ReadS ListOfferingsResponse
$creadsPrec :: Int -> ReadS ListOfferingsResponse
Prelude.Read, Int -> ListOfferingsResponse -> ShowS
[ListOfferingsResponse] -> ShowS
ListOfferingsResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ListOfferingsResponse] -> ShowS
$cshowList :: [ListOfferingsResponse] -> ShowS
show :: ListOfferingsResponse -> String
$cshow :: ListOfferingsResponse -> String
showsPrec :: Int -> ListOfferingsResponse -> ShowS
$cshowsPrec :: Int -> ListOfferingsResponse -> ShowS
Prelude.Show, forall x. Rep ListOfferingsResponse x -> ListOfferingsResponse
forall x. ListOfferingsResponse -> Rep ListOfferingsResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ListOfferingsResponse x -> ListOfferingsResponse
$cfrom :: forall x. ListOfferingsResponse -> Rep ListOfferingsResponse x
Prelude.Generic)

-- |
-- Create a value of 'ListOfferingsResponse' 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', 'listOfferingsResponse_nextToken' - An identifier that was returned from the previous call to this
-- operation, which can be used to return the next set of items in the
-- list.
--
-- 'offerings', 'listOfferingsResponse_offerings' - A value that represents the list offering results.
--
-- 'httpStatus', 'listOfferingsResponse_httpStatus' - The response's http status code.
newListOfferingsResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  ListOfferingsResponse
newListOfferingsResponse :: Int -> ListOfferingsResponse
newListOfferingsResponse Int
pHttpStatus_ =
  ListOfferingsResponse'
    { $sel:nextToken:ListOfferingsResponse' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing,
      $sel:offerings:ListOfferingsResponse' :: Maybe [Offering]
offerings = forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:ListOfferingsResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | An identifier that was returned from the previous call to this
-- operation, which can be used to return the next set of items in the
-- list.
listOfferingsResponse_nextToken :: Lens.Lens' ListOfferingsResponse (Prelude.Maybe Prelude.Text)
listOfferingsResponse_nextToken :: Lens' ListOfferingsResponse (Maybe Text)
listOfferingsResponse_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListOfferingsResponse' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:ListOfferingsResponse' :: ListOfferingsResponse -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: ListOfferingsResponse
s@ListOfferingsResponse' {} Maybe Text
a -> ListOfferingsResponse
s {$sel:nextToken:ListOfferingsResponse' :: Maybe Text
nextToken = Maybe Text
a} :: ListOfferingsResponse)

-- | A value that represents the list offering results.
listOfferingsResponse_offerings :: Lens.Lens' ListOfferingsResponse (Prelude.Maybe [Offering])
listOfferingsResponse_offerings :: Lens' ListOfferingsResponse (Maybe [Offering])
listOfferingsResponse_offerings = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListOfferingsResponse' {Maybe [Offering]
offerings :: Maybe [Offering]
$sel:offerings:ListOfferingsResponse' :: ListOfferingsResponse -> Maybe [Offering]
offerings} -> Maybe [Offering]
offerings) (\s :: ListOfferingsResponse
s@ListOfferingsResponse' {} Maybe [Offering]
a -> ListOfferingsResponse
s {$sel:offerings:ListOfferingsResponse' :: Maybe [Offering]
offerings = Maybe [Offering]
a} :: ListOfferingsResponse) 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

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

instance Prelude.NFData ListOfferingsResponse where
  rnf :: ListOfferingsResponse -> ()
rnf ListOfferingsResponse' {Int
Maybe [Offering]
Maybe Text
httpStatus :: Int
offerings :: Maybe [Offering]
nextToken :: Maybe Text
$sel:httpStatus:ListOfferingsResponse' :: ListOfferingsResponse -> Int
$sel:offerings:ListOfferingsResponse' :: ListOfferingsResponse -> Maybe [Offering]
$sel:nextToken:ListOfferingsResponse' :: ListOfferingsResponse -> Maybe Text
..} =
    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 [Offering]
offerings
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Int
httpStatus