{-# 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.IVSChat.DeleteMessage
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Sends an event to a specific room which directs clients to delete a
-- specific message; that is, unrender it from view and delete it from the
-- client’s chat history. This event’s @EventName@ is @aws:DELETE_MESSAGE@.
-- This replicates the
-- <https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/actions-deletemessage-publish.html DeleteMessage>
-- WebSocket operation in the Amazon IVS Chat Messaging API.
module Amazonka.IVSChat.DeleteMessage
  ( -- * Creating a Request
    DeleteMessage (..),
    newDeleteMessage,

    -- * Request Lenses
    deleteMessage_reason,
    deleteMessage_id,
    deleteMessage_roomIdentifier,

    -- * Destructuring the Response
    DeleteMessageResponse (..),
    newDeleteMessageResponse,

    -- * Response Lenses
    deleteMessageResponse_id,
    deleteMessageResponse_httpStatus,
  )
where

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

-- | /See:/ 'newDeleteMessage' smart constructor.
data DeleteMessage = DeleteMessage'
  { -- | Reason for deleting the message.
    DeleteMessage -> Maybe Text
reason :: Prelude.Maybe Prelude.Text,
    -- | ID of the message to be deleted. This is the @Id@ field in the received
    -- message (see
    -- <https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/actions-message-subscribe.html Message (Subscribe)>
    -- in the Chat Messaging API).
    DeleteMessage -> Text
id :: Prelude.Text,
    -- | Identifier of the room where the message should be deleted. Currently
    -- this must be an ARN.
    DeleteMessage -> Text
roomIdentifier :: Prelude.Text
  }
  deriving (DeleteMessage -> DeleteMessage -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DeleteMessage -> DeleteMessage -> Bool
$c/= :: DeleteMessage -> DeleteMessage -> Bool
== :: DeleteMessage -> DeleteMessage -> Bool
$c== :: DeleteMessage -> DeleteMessage -> Bool
Prelude.Eq, ReadPrec [DeleteMessage]
ReadPrec DeleteMessage
Int -> ReadS DeleteMessage
ReadS [DeleteMessage]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DeleteMessage]
$creadListPrec :: ReadPrec [DeleteMessage]
readPrec :: ReadPrec DeleteMessage
$creadPrec :: ReadPrec DeleteMessage
readList :: ReadS [DeleteMessage]
$creadList :: ReadS [DeleteMessage]
readsPrec :: Int -> ReadS DeleteMessage
$creadsPrec :: Int -> ReadS DeleteMessage
Prelude.Read, Int -> DeleteMessage -> ShowS
[DeleteMessage] -> ShowS
DeleteMessage -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DeleteMessage] -> ShowS
$cshowList :: [DeleteMessage] -> ShowS
show :: DeleteMessage -> String
$cshow :: DeleteMessage -> String
showsPrec :: Int -> DeleteMessage -> ShowS
$cshowsPrec :: Int -> DeleteMessage -> ShowS
Prelude.Show, forall x. Rep DeleteMessage x -> DeleteMessage
forall x. DeleteMessage -> Rep DeleteMessage x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep DeleteMessage x -> DeleteMessage
$cfrom :: forall x. DeleteMessage -> Rep DeleteMessage x
Prelude.Generic)

-- |
-- Create a value of 'DeleteMessage' 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:
--
-- 'reason', 'deleteMessage_reason' - Reason for deleting the message.
--
-- 'id', 'deleteMessage_id' - ID of the message to be deleted. This is the @Id@ field in the received
-- message (see
-- <https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/actions-message-subscribe.html Message (Subscribe)>
-- in the Chat Messaging API).
--
-- 'roomIdentifier', 'deleteMessage_roomIdentifier' - Identifier of the room where the message should be deleted. Currently
-- this must be an ARN.
newDeleteMessage ::
  -- | 'id'
  Prelude.Text ->
  -- | 'roomIdentifier'
  Prelude.Text ->
  DeleteMessage
newDeleteMessage :: Text -> Text -> DeleteMessage
newDeleteMessage Text
pId_ Text
pRoomIdentifier_ =
  DeleteMessage'
    { $sel:reason:DeleteMessage' :: Maybe Text
reason = forall a. Maybe a
Prelude.Nothing,
      $sel:id:DeleteMessage' :: Text
id = Text
pId_,
      $sel:roomIdentifier:DeleteMessage' :: Text
roomIdentifier = Text
pRoomIdentifier_
    }

-- | Reason for deleting the message.
deleteMessage_reason :: Lens.Lens' DeleteMessage (Prelude.Maybe Prelude.Text)
deleteMessage_reason :: Lens' DeleteMessage (Maybe Text)
deleteMessage_reason = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DeleteMessage' {Maybe Text
reason :: Maybe Text
$sel:reason:DeleteMessage' :: DeleteMessage -> Maybe Text
reason} -> Maybe Text
reason) (\s :: DeleteMessage
s@DeleteMessage' {} Maybe Text
a -> DeleteMessage
s {$sel:reason:DeleteMessage' :: Maybe Text
reason = Maybe Text
a} :: DeleteMessage)

-- | ID of the message to be deleted. This is the @Id@ field in the received
-- message (see
-- <https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/actions-message-subscribe.html Message (Subscribe)>
-- in the Chat Messaging API).
deleteMessage_id :: Lens.Lens' DeleteMessage Prelude.Text
deleteMessage_id :: Lens' DeleteMessage Text
deleteMessage_id = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DeleteMessage' {Text
id :: Text
$sel:id:DeleteMessage' :: DeleteMessage -> Text
id} -> Text
id) (\s :: DeleteMessage
s@DeleteMessage' {} Text
a -> DeleteMessage
s {$sel:id:DeleteMessage' :: Text
id = Text
a} :: DeleteMessage)

-- | Identifier of the room where the message should be deleted. Currently
-- this must be an ARN.
deleteMessage_roomIdentifier :: Lens.Lens' DeleteMessage Prelude.Text
deleteMessage_roomIdentifier :: Lens' DeleteMessage Text
deleteMessage_roomIdentifier = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DeleteMessage' {Text
roomIdentifier :: Text
$sel:roomIdentifier:DeleteMessage' :: DeleteMessage -> Text
roomIdentifier} -> Text
roomIdentifier) (\s :: DeleteMessage
s@DeleteMessage' {} Text
a -> DeleteMessage
s {$sel:roomIdentifier:DeleteMessage' :: Text
roomIdentifier = Text
a} :: DeleteMessage)

instance Core.AWSRequest DeleteMessage where
  type
    AWSResponse DeleteMessage =
      DeleteMessageResponse
  request :: (Service -> Service) -> DeleteMessage -> Request DeleteMessage
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 DeleteMessage
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse DeleteMessage)))
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 -> Int -> DeleteMessageResponse
DeleteMessageResponse'
            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
"id")
            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 DeleteMessage where
  hashWithSalt :: Int -> DeleteMessage -> Int
hashWithSalt Int
_salt DeleteMessage' {Maybe Text
Text
roomIdentifier :: Text
id :: Text
reason :: Maybe Text
$sel:roomIdentifier:DeleteMessage' :: DeleteMessage -> Text
$sel:id:DeleteMessage' :: DeleteMessage -> Text
$sel:reason:DeleteMessage' :: DeleteMessage -> Maybe Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
reason
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
id
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
roomIdentifier

instance Prelude.NFData DeleteMessage where
  rnf :: DeleteMessage -> ()
rnf DeleteMessage' {Maybe Text
Text
roomIdentifier :: Text
id :: Text
reason :: Maybe Text
$sel:roomIdentifier:DeleteMessage' :: DeleteMessage -> Text
$sel:id:DeleteMessage' :: DeleteMessage -> Text
$sel:reason:DeleteMessage' :: DeleteMessage -> Maybe Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
reason
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
id
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
roomIdentifier

instance Data.ToHeaders DeleteMessage where
  toHeaders :: DeleteMessage -> 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.ToJSON DeleteMessage where
  toJSON :: DeleteMessage -> Value
toJSON DeleteMessage' {Maybe Text
Text
roomIdentifier :: Text
id :: Text
reason :: Maybe Text
$sel:roomIdentifier:DeleteMessage' :: DeleteMessage -> Text
$sel:id:DeleteMessage' :: DeleteMessage -> Text
$sel:reason:DeleteMessage' :: DeleteMessage -> Maybe Text
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"reason" 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
reason,
            forall a. a -> Maybe a
Prelude.Just (Key
"id" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
id),
            forall a. a -> Maybe a
Prelude.Just
              (Key
"roomIdentifier" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
roomIdentifier)
          ]
      )

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

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

-- | /See:/ 'newDeleteMessageResponse' smart constructor.
data DeleteMessageResponse = DeleteMessageResponse'
  { -- | Operation identifier, generated by Amazon IVS Chat.
    DeleteMessageResponse -> Maybe Text
id :: Prelude.Maybe Prelude.Text,
    -- | The response's http status code.
    DeleteMessageResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (DeleteMessageResponse -> DeleteMessageResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DeleteMessageResponse -> DeleteMessageResponse -> Bool
$c/= :: DeleteMessageResponse -> DeleteMessageResponse -> Bool
== :: DeleteMessageResponse -> DeleteMessageResponse -> Bool
$c== :: DeleteMessageResponse -> DeleteMessageResponse -> Bool
Prelude.Eq, ReadPrec [DeleteMessageResponse]
ReadPrec DeleteMessageResponse
Int -> ReadS DeleteMessageResponse
ReadS [DeleteMessageResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DeleteMessageResponse]
$creadListPrec :: ReadPrec [DeleteMessageResponse]
readPrec :: ReadPrec DeleteMessageResponse
$creadPrec :: ReadPrec DeleteMessageResponse
readList :: ReadS [DeleteMessageResponse]
$creadList :: ReadS [DeleteMessageResponse]
readsPrec :: Int -> ReadS DeleteMessageResponse
$creadsPrec :: Int -> ReadS DeleteMessageResponse
Prelude.Read, Int -> DeleteMessageResponse -> ShowS
[DeleteMessageResponse] -> ShowS
DeleteMessageResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DeleteMessageResponse] -> ShowS
$cshowList :: [DeleteMessageResponse] -> ShowS
show :: DeleteMessageResponse -> String
$cshow :: DeleteMessageResponse -> String
showsPrec :: Int -> DeleteMessageResponse -> ShowS
$cshowsPrec :: Int -> DeleteMessageResponse -> ShowS
Prelude.Show, forall x. Rep DeleteMessageResponse x -> DeleteMessageResponse
forall x. DeleteMessageResponse -> Rep DeleteMessageResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep DeleteMessageResponse x -> DeleteMessageResponse
$cfrom :: forall x. DeleteMessageResponse -> Rep DeleteMessageResponse x
Prelude.Generic)

-- |
-- Create a value of 'DeleteMessageResponse' 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:
--
-- 'id', 'deleteMessageResponse_id' - Operation identifier, generated by Amazon IVS Chat.
--
-- 'httpStatus', 'deleteMessageResponse_httpStatus' - The response's http status code.
newDeleteMessageResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  DeleteMessageResponse
newDeleteMessageResponse :: Int -> DeleteMessageResponse
newDeleteMessageResponse Int
pHttpStatus_ =
  DeleteMessageResponse'
    { $sel:id:DeleteMessageResponse' :: Maybe Text
id = forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:DeleteMessageResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | Operation identifier, generated by Amazon IVS Chat.
deleteMessageResponse_id :: Lens.Lens' DeleteMessageResponse (Prelude.Maybe Prelude.Text)
deleteMessageResponse_id :: Lens' DeleteMessageResponse (Maybe Text)
deleteMessageResponse_id = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DeleteMessageResponse' {Maybe Text
id :: Maybe Text
$sel:id:DeleteMessageResponse' :: DeleteMessageResponse -> Maybe Text
id} -> Maybe Text
id) (\s :: DeleteMessageResponse
s@DeleteMessageResponse' {} Maybe Text
a -> DeleteMessageResponse
s {$sel:id:DeleteMessageResponse' :: Maybe Text
id = Maybe Text
a} :: DeleteMessageResponse)

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

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