{-# 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.Connect.DescribePhoneNumber
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Gets details and status of a phone number that’s claimed to your Amazon
-- Connect instance or traffic distribution group.
--
-- If the number is claimed to a traffic distribution group, and you are
-- calling in the Amazon Web Services Region where the traffic distribution
-- group was created, you can use either a phone number ARN or UUID value
-- for the @PhoneNumberId@ URI request parameter. However, if the number is
-- claimed to a traffic distribution group and you are calling this API in
-- the alternate Amazon Web Services Region associated with the traffic
-- distribution group, you must provide a full phone number ARN. If a UUID
-- is provided in this scenario, you will receive a
-- @ResourceNotFoundException@.
module Amazonka.Connect.DescribePhoneNumber
  ( -- * Creating a Request
    DescribePhoneNumber (..),
    newDescribePhoneNumber,

    -- * Request Lenses
    describePhoneNumber_phoneNumberId,

    -- * Destructuring the Response
    DescribePhoneNumberResponse (..),
    newDescribePhoneNumberResponse,

    -- * Response Lenses
    describePhoneNumberResponse_claimedPhoneNumberSummary,
    describePhoneNumberResponse_httpStatus,
  )
where

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

-- | /See:/ 'newDescribePhoneNumber' smart constructor.
data DescribePhoneNumber = DescribePhoneNumber'
  { -- | A unique identifier for the phone number.
    DescribePhoneNumber -> Text
phoneNumberId :: Prelude.Text
  }
  deriving (DescribePhoneNumber -> DescribePhoneNumber -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DescribePhoneNumber -> DescribePhoneNumber -> Bool
$c/= :: DescribePhoneNumber -> DescribePhoneNumber -> Bool
== :: DescribePhoneNumber -> DescribePhoneNumber -> Bool
$c== :: DescribePhoneNumber -> DescribePhoneNumber -> Bool
Prelude.Eq, ReadPrec [DescribePhoneNumber]
ReadPrec DescribePhoneNumber
Int -> ReadS DescribePhoneNumber
ReadS [DescribePhoneNumber]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DescribePhoneNumber]
$creadListPrec :: ReadPrec [DescribePhoneNumber]
readPrec :: ReadPrec DescribePhoneNumber
$creadPrec :: ReadPrec DescribePhoneNumber
readList :: ReadS [DescribePhoneNumber]
$creadList :: ReadS [DescribePhoneNumber]
readsPrec :: Int -> ReadS DescribePhoneNumber
$creadsPrec :: Int -> ReadS DescribePhoneNumber
Prelude.Read, Int -> DescribePhoneNumber -> ShowS
[DescribePhoneNumber] -> ShowS
DescribePhoneNumber -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DescribePhoneNumber] -> ShowS
$cshowList :: [DescribePhoneNumber] -> ShowS
show :: DescribePhoneNumber -> String
$cshow :: DescribePhoneNumber -> String
showsPrec :: Int -> DescribePhoneNumber -> ShowS
$cshowsPrec :: Int -> DescribePhoneNumber -> ShowS
Prelude.Show, forall x. Rep DescribePhoneNumber x -> DescribePhoneNumber
forall x. DescribePhoneNumber -> Rep DescribePhoneNumber x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep DescribePhoneNumber x -> DescribePhoneNumber
$cfrom :: forall x. DescribePhoneNumber -> Rep DescribePhoneNumber x
Prelude.Generic)

-- |
-- Create a value of 'DescribePhoneNumber' 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:
--
-- 'phoneNumberId', 'describePhoneNumber_phoneNumberId' - A unique identifier for the phone number.
newDescribePhoneNumber ::
  -- | 'phoneNumberId'
  Prelude.Text ->
  DescribePhoneNumber
newDescribePhoneNumber :: Text -> DescribePhoneNumber
newDescribePhoneNumber Text
pPhoneNumberId_ =
  DescribePhoneNumber'
    { $sel:phoneNumberId:DescribePhoneNumber' :: Text
phoneNumberId =
        Text
pPhoneNumberId_
    }

-- | A unique identifier for the phone number.
describePhoneNumber_phoneNumberId :: Lens.Lens' DescribePhoneNumber Prelude.Text
describePhoneNumber_phoneNumberId :: Lens' DescribePhoneNumber Text
describePhoneNumber_phoneNumberId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribePhoneNumber' {Text
phoneNumberId :: Text
$sel:phoneNumberId:DescribePhoneNumber' :: DescribePhoneNumber -> Text
phoneNumberId} -> Text
phoneNumberId) (\s :: DescribePhoneNumber
s@DescribePhoneNumber' {} Text
a -> DescribePhoneNumber
s {$sel:phoneNumberId:DescribePhoneNumber' :: Text
phoneNumberId = Text
a} :: DescribePhoneNumber)

instance Core.AWSRequest DescribePhoneNumber where
  type
    AWSResponse DescribePhoneNumber =
      DescribePhoneNumberResponse
  request :: (Service -> Service)
-> DescribePhoneNumber -> Request DescribePhoneNumber
request Service -> Service
overrides =
    forall a. ToRequest a => Service -> a -> Request a
Request.get (Service -> Service
overrides Service
defaultService)
  response :: forall (m :: * -> *).
MonadResource m =>
(ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy DescribePhoneNumber
-> ClientResponse ClientBody
-> m (Either
        Error (ClientResponse (AWSResponse DescribePhoneNumber)))
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 ClaimedPhoneNumberSummary
-> Int -> DescribePhoneNumberResponse
DescribePhoneNumberResponse'
            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
"ClaimedPhoneNumberSummary")
            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 DescribePhoneNumber where
  hashWithSalt :: Int -> DescribePhoneNumber -> Int
hashWithSalt Int
_salt DescribePhoneNumber' {Text
phoneNumberId :: Text
$sel:phoneNumberId:DescribePhoneNumber' :: DescribePhoneNumber -> Text
..} =
    Int
_salt forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
phoneNumberId

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

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

instance Data.ToPath DescribePhoneNumber where
  toPath :: DescribePhoneNumber -> ByteString
toPath DescribePhoneNumber' {Text
phoneNumberId :: Text
$sel:phoneNumberId:DescribePhoneNumber' :: DescribePhoneNumber -> Text
..} =
    forall a. Monoid a => [a] -> a
Prelude.mconcat
      [ByteString
"/phone-number/", forall a. ToByteString a => a -> ByteString
Data.toBS Text
phoneNumberId]

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

-- | /See:/ 'newDescribePhoneNumberResponse' smart constructor.
data DescribePhoneNumberResponse = DescribePhoneNumberResponse'
  { -- | Information about a phone number that\'s been claimed to your Amazon
    -- Connect instance or traffic distribution group.
    DescribePhoneNumberResponse -> Maybe ClaimedPhoneNumberSummary
claimedPhoneNumberSummary :: Prelude.Maybe ClaimedPhoneNumberSummary,
    -- | The response's http status code.
    DescribePhoneNumberResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (DescribePhoneNumberResponse -> DescribePhoneNumberResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DescribePhoneNumberResponse -> DescribePhoneNumberResponse -> Bool
$c/= :: DescribePhoneNumberResponse -> DescribePhoneNumberResponse -> Bool
== :: DescribePhoneNumberResponse -> DescribePhoneNumberResponse -> Bool
$c== :: DescribePhoneNumberResponse -> DescribePhoneNumberResponse -> Bool
Prelude.Eq, ReadPrec [DescribePhoneNumberResponse]
ReadPrec DescribePhoneNumberResponse
Int -> ReadS DescribePhoneNumberResponse
ReadS [DescribePhoneNumberResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DescribePhoneNumberResponse]
$creadListPrec :: ReadPrec [DescribePhoneNumberResponse]
readPrec :: ReadPrec DescribePhoneNumberResponse
$creadPrec :: ReadPrec DescribePhoneNumberResponse
readList :: ReadS [DescribePhoneNumberResponse]
$creadList :: ReadS [DescribePhoneNumberResponse]
readsPrec :: Int -> ReadS DescribePhoneNumberResponse
$creadsPrec :: Int -> ReadS DescribePhoneNumberResponse
Prelude.Read, Int -> DescribePhoneNumberResponse -> ShowS
[DescribePhoneNumberResponse] -> ShowS
DescribePhoneNumberResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DescribePhoneNumberResponse] -> ShowS
$cshowList :: [DescribePhoneNumberResponse] -> ShowS
show :: DescribePhoneNumberResponse -> String
$cshow :: DescribePhoneNumberResponse -> String
showsPrec :: Int -> DescribePhoneNumberResponse -> ShowS
$cshowsPrec :: Int -> DescribePhoneNumberResponse -> ShowS
Prelude.Show, forall x.
Rep DescribePhoneNumberResponse x -> DescribePhoneNumberResponse
forall x.
DescribePhoneNumberResponse -> Rep DescribePhoneNumberResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep DescribePhoneNumberResponse x -> DescribePhoneNumberResponse
$cfrom :: forall x.
DescribePhoneNumberResponse -> Rep DescribePhoneNumberResponse x
Prelude.Generic)

-- |
-- Create a value of 'DescribePhoneNumberResponse' 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:
--
-- 'claimedPhoneNumberSummary', 'describePhoneNumberResponse_claimedPhoneNumberSummary' - Information about a phone number that\'s been claimed to your Amazon
-- Connect instance or traffic distribution group.
--
-- 'httpStatus', 'describePhoneNumberResponse_httpStatus' - The response's http status code.
newDescribePhoneNumberResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  DescribePhoneNumberResponse
newDescribePhoneNumberResponse :: Int -> DescribePhoneNumberResponse
newDescribePhoneNumberResponse Int
pHttpStatus_ =
  DescribePhoneNumberResponse'
    { $sel:claimedPhoneNumberSummary:DescribePhoneNumberResponse' :: Maybe ClaimedPhoneNumberSummary
claimedPhoneNumberSummary =
        forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:DescribePhoneNumberResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | Information about a phone number that\'s been claimed to your Amazon
-- Connect instance or traffic distribution group.
describePhoneNumberResponse_claimedPhoneNumberSummary :: Lens.Lens' DescribePhoneNumberResponse (Prelude.Maybe ClaimedPhoneNumberSummary)
describePhoneNumberResponse_claimedPhoneNumberSummary :: Lens' DescribePhoneNumberResponse (Maybe ClaimedPhoneNumberSummary)
describePhoneNumberResponse_claimedPhoneNumberSummary = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribePhoneNumberResponse' {Maybe ClaimedPhoneNumberSummary
claimedPhoneNumberSummary :: Maybe ClaimedPhoneNumberSummary
$sel:claimedPhoneNumberSummary:DescribePhoneNumberResponse' :: DescribePhoneNumberResponse -> Maybe ClaimedPhoneNumberSummary
claimedPhoneNumberSummary} -> Maybe ClaimedPhoneNumberSummary
claimedPhoneNumberSummary) (\s :: DescribePhoneNumberResponse
s@DescribePhoneNumberResponse' {} Maybe ClaimedPhoneNumberSummary
a -> DescribePhoneNumberResponse
s {$sel:claimedPhoneNumberSummary:DescribePhoneNumberResponse' :: Maybe ClaimedPhoneNumberSummary
claimedPhoneNumberSummary = Maybe ClaimedPhoneNumberSummary
a} :: DescribePhoneNumberResponse)

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

instance Prelude.NFData DescribePhoneNumberResponse where
  rnf :: DescribePhoneNumberResponse -> ()
rnf DescribePhoneNumberResponse' {Int
Maybe ClaimedPhoneNumberSummary
httpStatus :: Int
claimedPhoneNumberSummary :: Maybe ClaimedPhoneNumberSummary
$sel:httpStatus:DescribePhoneNumberResponse' :: DescribePhoneNumberResponse -> Int
$sel:claimedPhoneNumberSummary:DescribePhoneNumberResponse' :: DescribePhoneNumberResponse -> Maybe ClaimedPhoneNumberSummary
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe ClaimedPhoneNumberSummary
claimedPhoneNumberSummary
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Int
httpStatus