{-# 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.SNS.CheckIfPhoneNumberIsOptedOut
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Accepts a phone number and indicates whether the phone holder has opted
-- out of receiving SMS messages from your Amazon Web Services account. You
-- cannot send SMS messages to a number that is opted out.
--
-- To resume sending messages, you can opt in the number by using the
-- @OptInPhoneNumber@ action.
module Amazonka.SNS.CheckIfPhoneNumberIsOptedOut
  ( -- * Creating a Request
    CheckIfPhoneNumberIsOptedOut (..),
    newCheckIfPhoneNumberIsOptedOut,

    -- * Request Lenses
    checkIfPhoneNumberIsOptedOut_phoneNumber,

    -- * Destructuring the Response
    CheckIfPhoneNumberIsOptedOutResponse (..),
    newCheckIfPhoneNumberIsOptedOutResponse,

    -- * Response Lenses
    checkIfPhoneNumberIsOptedOutResponse_isOptedOut,
    checkIfPhoneNumberIsOptedOutResponse_httpStatus,
  )
where

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
import Amazonka.SNS.Types

-- | The input for the @CheckIfPhoneNumberIsOptedOut@ action.
--
-- /See:/ 'newCheckIfPhoneNumberIsOptedOut' smart constructor.
data CheckIfPhoneNumberIsOptedOut = CheckIfPhoneNumberIsOptedOut'
  { -- | The phone number for which you want to check the opt out status.
    CheckIfPhoneNumberIsOptedOut -> Text
phoneNumber :: Prelude.Text
  }
  deriving (CheckIfPhoneNumberIsOptedOut
-> CheckIfPhoneNumberIsOptedOut -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: CheckIfPhoneNumberIsOptedOut
-> CheckIfPhoneNumberIsOptedOut -> Bool
$c/= :: CheckIfPhoneNumberIsOptedOut
-> CheckIfPhoneNumberIsOptedOut -> Bool
== :: CheckIfPhoneNumberIsOptedOut
-> CheckIfPhoneNumberIsOptedOut -> Bool
$c== :: CheckIfPhoneNumberIsOptedOut
-> CheckIfPhoneNumberIsOptedOut -> Bool
Prelude.Eq, ReadPrec [CheckIfPhoneNumberIsOptedOut]
ReadPrec CheckIfPhoneNumberIsOptedOut
Int -> ReadS CheckIfPhoneNumberIsOptedOut
ReadS [CheckIfPhoneNumberIsOptedOut]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [CheckIfPhoneNumberIsOptedOut]
$creadListPrec :: ReadPrec [CheckIfPhoneNumberIsOptedOut]
readPrec :: ReadPrec CheckIfPhoneNumberIsOptedOut
$creadPrec :: ReadPrec CheckIfPhoneNumberIsOptedOut
readList :: ReadS [CheckIfPhoneNumberIsOptedOut]
$creadList :: ReadS [CheckIfPhoneNumberIsOptedOut]
readsPrec :: Int -> ReadS CheckIfPhoneNumberIsOptedOut
$creadsPrec :: Int -> ReadS CheckIfPhoneNumberIsOptedOut
Prelude.Read, Int -> CheckIfPhoneNumberIsOptedOut -> ShowS
[CheckIfPhoneNumberIsOptedOut] -> ShowS
CheckIfPhoneNumberIsOptedOut -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [CheckIfPhoneNumberIsOptedOut] -> ShowS
$cshowList :: [CheckIfPhoneNumberIsOptedOut] -> ShowS
show :: CheckIfPhoneNumberIsOptedOut -> String
$cshow :: CheckIfPhoneNumberIsOptedOut -> String
showsPrec :: Int -> CheckIfPhoneNumberIsOptedOut -> ShowS
$cshowsPrec :: Int -> CheckIfPhoneNumberIsOptedOut -> ShowS
Prelude.Show, forall x.
Rep CheckIfPhoneNumberIsOptedOut x -> CheckIfPhoneNumberIsOptedOut
forall x.
CheckIfPhoneNumberIsOptedOut -> Rep CheckIfPhoneNumberIsOptedOut x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep CheckIfPhoneNumberIsOptedOut x -> CheckIfPhoneNumberIsOptedOut
$cfrom :: forall x.
CheckIfPhoneNumberIsOptedOut -> Rep CheckIfPhoneNumberIsOptedOut x
Prelude.Generic)

-- |
-- Create a value of 'CheckIfPhoneNumberIsOptedOut' 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:
--
-- 'phoneNumber', 'checkIfPhoneNumberIsOptedOut_phoneNumber' - The phone number for which you want to check the opt out status.
newCheckIfPhoneNumberIsOptedOut ::
  -- | 'phoneNumber'
  Prelude.Text ->
  CheckIfPhoneNumberIsOptedOut
newCheckIfPhoneNumberIsOptedOut :: Text -> CheckIfPhoneNumberIsOptedOut
newCheckIfPhoneNumberIsOptedOut Text
pPhoneNumber_ =
  CheckIfPhoneNumberIsOptedOut'
    { $sel:phoneNumber:CheckIfPhoneNumberIsOptedOut' :: Text
phoneNumber =
        Text
pPhoneNumber_
    }

-- | The phone number for which you want to check the opt out status.
checkIfPhoneNumberIsOptedOut_phoneNumber :: Lens.Lens' CheckIfPhoneNumberIsOptedOut Prelude.Text
checkIfPhoneNumberIsOptedOut_phoneNumber :: Lens' CheckIfPhoneNumberIsOptedOut Text
checkIfPhoneNumberIsOptedOut_phoneNumber = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CheckIfPhoneNumberIsOptedOut' {Text
phoneNumber :: Text
$sel:phoneNumber:CheckIfPhoneNumberIsOptedOut' :: CheckIfPhoneNumberIsOptedOut -> Text
phoneNumber} -> Text
phoneNumber) (\s :: CheckIfPhoneNumberIsOptedOut
s@CheckIfPhoneNumberIsOptedOut' {} Text
a -> CheckIfPhoneNumberIsOptedOut
s {$sel:phoneNumber:CheckIfPhoneNumberIsOptedOut' :: Text
phoneNumber = Text
a} :: CheckIfPhoneNumberIsOptedOut)

instance Core.AWSRequest CheckIfPhoneNumberIsOptedOut where
  type
    AWSResponse CheckIfPhoneNumberIsOptedOut =
      CheckIfPhoneNumberIsOptedOutResponse
  request :: (Service -> Service)
-> CheckIfPhoneNumberIsOptedOut
-> Request CheckIfPhoneNumberIsOptedOut
request Service -> Service
overrides =
    forall a. ToRequest a => Service -> a -> Request a
Request.postQuery (Service -> Service
overrides Service
defaultService)
  response :: forall (m :: * -> *).
MonadResource m =>
(ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy CheckIfPhoneNumberIsOptedOut
-> ClientResponse ClientBody
-> m (Either
        Error (ClientResponse (AWSResponse CheckIfPhoneNumberIsOptedOut)))
response =
    forall (m :: * -> *) a.
MonadResource m =>
Text
-> (Int
    -> ResponseHeaders -> [Node] -> Either String (AWSResponse a))
-> (ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy a
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse a)))
Response.receiveXMLWrapper
      Text
"CheckIfPhoneNumberIsOptedOutResult"
      ( \Int
s ResponseHeaders
h [Node]
x ->
          Maybe Bool -> Int -> CheckIfPhoneNumberIsOptedOutResponse
CheckIfPhoneNumberIsOptedOutResponse'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> ([Node]
x forall a. FromXML a => [Node] -> Text -> Either String (Maybe a)
Data..@? Text
"isOptedOut")
            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
    CheckIfPhoneNumberIsOptedOut
  where
  hashWithSalt :: Int -> CheckIfPhoneNumberIsOptedOut -> Int
hashWithSalt Int
_salt CheckIfPhoneNumberIsOptedOut' {Text
phoneNumber :: Text
$sel:phoneNumber:CheckIfPhoneNumberIsOptedOut' :: CheckIfPhoneNumberIsOptedOut -> Text
..} =
    Int
_salt forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
phoneNumber

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

instance Data.ToHeaders CheckIfPhoneNumberIsOptedOut where
  toHeaders :: CheckIfPhoneNumberIsOptedOut -> ResponseHeaders
toHeaders = forall a b. a -> b -> a
Prelude.const forall a. Monoid a => a
Prelude.mempty

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

instance Data.ToQuery CheckIfPhoneNumberIsOptedOut where
  toQuery :: CheckIfPhoneNumberIsOptedOut -> QueryString
toQuery CheckIfPhoneNumberIsOptedOut' {Text
phoneNumber :: Text
$sel:phoneNumber:CheckIfPhoneNumberIsOptedOut' :: CheckIfPhoneNumberIsOptedOut -> Text
..} =
    forall a. Monoid a => [a] -> a
Prelude.mconcat
      [ ByteString
"Action"
          forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: ( ByteString
"CheckIfPhoneNumberIsOptedOut" ::
                      Prelude.ByteString
                  ),
        ByteString
"Version"
          forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: (ByteString
"2010-03-31" :: Prelude.ByteString),
        ByteString
"phoneNumber" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Text
phoneNumber
      ]

-- | The response from the @CheckIfPhoneNumberIsOptedOut@ action.
--
-- /See:/ 'newCheckIfPhoneNumberIsOptedOutResponse' smart constructor.
data CheckIfPhoneNumberIsOptedOutResponse = CheckIfPhoneNumberIsOptedOutResponse'
  { -- | Indicates whether the phone number is opted out:
    --
    -- -   @true@ – The phone number is opted out, meaning you cannot publish
    --     SMS messages to it.
    --
    -- -   @false@ – The phone number is opted in, meaning you can publish SMS
    --     messages to it.
    CheckIfPhoneNumberIsOptedOutResponse -> Maybe Bool
isOptedOut :: Prelude.Maybe Prelude.Bool,
    -- | The response's http status code.
    CheckIfPhoneNumberIsOptedOutResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (CheckIfPhoneNumberIsOptedOutResponse
-> CheckIfPhoneNumberIsOptedOutResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: CheckIfPhoneNumberIsOptedOutResponse
-> CheckIfPhoneNumberIsOptedOutResponse -> Bool
$c/= :: CheckIfPhoneNumberIsOptedOutResponse
-> CheckIfPhoneNumberIsOptedOutResponse -> Bool
== :: CheckIfPhoneNumberIsOptedOutResponse
-> CheckIfPhoneNumberIsOptedOutResponse -> Bool
$c== :: CheckIfPhoneNumberIsOptedOutResponse
-> CheckIfPhoneNumberIsOptedOutResponse -> Bool
Prelude.Eq, ReadPrec [CheckIfPhoneNumberIsOptedOutResponse]
ReadPrec CheckIfPhoneNumberIsOptedOutResponse
Int -> ReadS CheckIfPhoneNumberIsOptedOutResponse
ReadS [CheckIfPhoneNumberIsOptedOutResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [CheckIfPhoneNumberIsOptedOutResponse]
$creadListPrec :: ReadPrec [CheckIfPhoneNumberIsOptedOutResponse]
readPrec :: ReadPrec CheckIfPhoneNumberIsOptedOutResponse
$creadPrec :: ReadPrec CheckIfPhoneNumberIsOptedOutResponse
readList :: ReadS [CheckIfPhoneNumberIsOptedOutResponse]
$creadList :: ReadS [CheckIfPhoneNumberIsOptedOutResponse]
readsPrec :: Int -> ReadS CheckIfPhoneNumberIsOptedOutResponse
$creadsPrec :: Int -> ReadS CheckIfPhoneNumberIsOptedOutResponse
Prelude.Read, Int -> CheckIfPhoneNumberIsOptedOutResponse -> ShowS
[CheckIfPhoneNumberIsOptedOutResponse] -> ShowS
CheckIfPhoneNumberIsOptedOutResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [CheckIfPhoneNumberIsOptedOutResponse] -> ShowS
$cshowList :: [CheckIfPhoneNumberIsOptedOutResponse] -> ShowS
show :: CheckIfPhoneNumberIsOptedOutResponse -> String
$cshow :: CheckIfPhoneNumberIsOptedOutResponse -> String
showsPrec :: Int -> CheckIfPhoneNumberIsOptedOutResponse -> ShowS
$cshowsPrec :: Int -> CheckIfPhoneNumberIsOptedOutResponse -> ShowS
Prelude.Show, forall x.
Rep CheckIfPhoneNumberIsOptedOutResponse x
-> CheckIfPhoneNumberIsOptedOutResponse
forall x.
CheckIfPhoneNumberIsOptedOutResponse
-> Rep CheckIfPhoneNumberIsOptedOutResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep CheckIfPhoneNumberIsOptedOutResponse x
-> CheckIfPhoneNumberIsOptedOutResponse
$cfrom :: forall x.
CheckIfPhoneNumberIsOptedOutResponse
-> Rep CheckIfPhoneNumberIsOptedOutResponse x
Prelude.Generic)

-- |
-- Create a value of 'CheckIfPhoneNumberIsOptedOutResponse' 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:
--
-- 'isOptedOut', 'checkIfPhoneNumberIsOptedOutResponse_isOptedOut' - Indicates whether the phone number is opted out:
--
-- -   @true@ – The phone number is opted out, meaning you cannot publish
--     SMS messages to it.
--
-- -   @false@ – The phone number is opted in, meaning you can publish SMS
--     messages to it.
--
-- 'httpStatus', 'checkIfPhoneNumberIsOptedOutResponse_httpStatus' - The response's http status code.
newCheckIfPhoneNumberIsOptedOutResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  CheckIfPhoneNumberIsOptedOutResponse
newCheckIfPhoneNumberIsOptedOutResponse :: Int -> CheckIfPhoneNumberIsOptedOutResponse
newCheckIfPhoneNumberIsOptedOutResponse Int
pHttpStatus_ =
  CheckIfPhoneNumberIsOptedOutResponse'
    { $sel:isOptedOut:CheckIfPhoneNumberIsOptedOutResponse' :: Maybe Bool
isOptedOut =
        forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:CheckIfPhoneNumberIsOptedOutResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | Indicates whether the phone number is opted out:
--
-- -   @true@ – The phone number is opted out, meaning you cannot publish
--     SMS messages to it.
--
-- -   @false@ – The phone number is opted in, meaning you can publish SMS
--     messages to it.
checkIfPhoneNumberIsOptedOutResponse_isOptedOut :: Lens.Lens' CheckIfPhoneNumberIsOptedOutResponse (Prelude.Maybe Prelude.Bool)
checkIfPhoneNumberIsOptedOutResponse_isOptedOut :: Lens' CheckIfPhoneNumberIsOptedOutResponse (Maybe Bool)
checkIfPhoneNumberIsOptedOutResponse_isOptedOut = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CheckIfPhoneNumberIsOptedOutResponse' {Maybe Bool
isOptedOut :: Maybe Bool
$sel:isOptedOut:CheckIfPhoneNumberIsOptedOutResponse' :: CheckIfPhoneNumberIsOptedOutResponse -> Maybe Bool
isOptedOut} -> Maybe Bool
isOptedOut) (\s :: CheckIfPhoneNumberIsOptedOutResponse
s@CheckIfPhoneNumberIsOptedOutResponse' {} Maybe Bool
a -> CheckIfPhoneNumberIsOptedOutResponse
s {$sel:isOptedOut:CheckIfPhoneNumberIsOptedOutResponse' :: Maybe Bool
isOptedOut = Maybe Bool
a} :: CheckIfPhoneNumberIsOptedOutResponse)

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

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