{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}

-- Derived from AWS service descriptions, licensed under Apache 2.0.

-- |
-- Module      : Amazonka.Pinpoint.Types.ADMMessage
-- Copyright   : (c) 2013-2021 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay <brendan.g.hay+amazonka@gmail.com>
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
module Amazonka.Pinpoint.Types.ADMMessage where

import qualified Amazonka.Core as Core
import qualified Amazonka.Lens as Lens
import Amazonka.Pinpoint.Types.Action
import qualified Amazonka.Prelude as Prelude

-- | Specifies the settings for a one-time message that\'s sent directly to
-- an endpoint through the ADM (Amazon Device Messaging) channel.
--
-- /See:/ 'newADMMessage' smart constructor.
data ADMMessage = ADMMessage'
  { -- | The default message variables to use in the notification message. You
    -- can override the default variables with individual address variables.
    ADMMessage -> Maybe (HashMap Text [Text])
substitutions :: Prelude.Maybe (Prelude.HashMap Prelude.Text [Prelude.Text]),
    -- | The amount of time, in seconds, that ADM should store the message if the
    -- recipient\'s device is offline. Amazon Pinpoint specifies this value in
    -- the expiresAfter parameter when it sends the notification message to
    -- ADM.
    ADMMessage -> Maybe Text
expiresAfter :: Prelude.Maybe Prelude.Text,
    -- | The base64-encoded, MD5 checksum of the value specified by the Data
    -- property. ADM uses the MD5 value to verify the integrity of the data.
    ADMMessage -> Maybe Text
md5 :: Prelude.Maybe Prelude.Text,
    -- | Specifies whether the notification is a silent push notification, which
    -- is a push notification that doesn\'t display on a recipient\'s device.
    -- Silent push notifications can be used for cases such as updating an
    -- app\'s configuration or supporting phone home functionality.
    ADMMessage -> Maybe Bool
silentPush :: Prelude.Maybe Prelude.Bool,
    -- | The URL of the large icon image to display in the content view of the
    -- push notification.
    ADMMessage -> Maybe Text
imageIconUrl :: Prelude.Maybe Prelude.Text,
    -- | The raw, JSON-formatted string to use as the payload for the
    -- notification message. If specified, this value overrides all other
    -- content for the message.
    ADMMessage -> Maybe Text
rawContent :: Prelude.Maybe Prelude.Text,
    -- | The JSON data payload to use for the push notification, if the
    -- notification is a silent push notification. This payload is added to the
    -- data.pinpoint.jsonBody object of the notification.
    ADMMessage -> Maybe (HashMap Text Text)
data' :: Prelude.Maybe (Prelude.HashMap Prelude.Text Prelude.Text),
    -- | The URL of the small icon image to display in the status bar and the
    -- content view of the push notification.
    ADMMessage -> Maybe Text
smallImageIconUrl :: Prelude.Maybe Prelude.Text,
    -- | The body of the notification message.
    ADMMessage -> Maybe Text
body :: Prelude.Maybe Prelude.Text,
    -- | The URL to open in the recipient\'s default mobile browser, if a
    -- recipient taps the push notification and the value of the Action
    -- property is URL.
    ADMMessage -> Maybe Text
url :: Prelude.Maybe Prelude.Text,
    -- | The sound to play when the recipient receives the push notification. You
    -- can use the default stream or specify the file name of a sound resource
    -- that\'s bundled in your app. On an Android platform, the sound file must
    -- reside in \/res\/raw\/.
    ADMMessage -> Maybe Text
sound :: Prelude.Maybe Prelude.Text,
    -- | The action to occur if the recipient taps the push notification. Valid
    -- values are:
    --
    -- -   OPEN_APP - Your app opens or it becomes the foreground app if it was
    --     sent to the background. This is the default action.
    --
    -- -   DEEP_LINK - Your app opens and displays a designated user interface
    --     in the app. This action uses the deep-linking features of the
    --     Android platform.
    --
    -- -   URL - The default mobile browser on the recipient\'s device opens
    --     and loads the web page at a URL that you specify.
    ADMMessage -> Maybe Action
action :: Prelude.Maybe Action,
    -- | The URL of an image to display in the push notification.
    ADMMessage -> Maybe Text
imageUrl :: Prelude.Maybe Prelude.Text,
    -- | An arbitrary string that indicates that multiple messages are logically
    -- the same and that Amazon Device Messaging (ADM) can drop previously
    -- enqueued messages in favor of this message.
    ADMMessage -> Maybe Text
consolidationKey :: Prelude.Maybe Prelude.Text,
    -- | The title to display above the notification message on the recipient\'s
    -- device.
    ADMMessage -> Maybe Text
title :: Prelude.Maybe Prelude.Text,
    -- | The icon image name of the asset saved in your app.
    ADMMessage -> Maybe Text
iconReference :: Prelude.Maybe Prelude.Text
  }
  deriving (ADMMessage -> ADMMessage -> Bool
(ADMMessage -> ADMMessage -> Bool)
-> (ADMMessage -> ADMMessage -> Bool) -> Eq ADMMessage
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ADMMessage -> ADMMessage -> Bool
$c/= :: ADMMessage -> ADMMessage -> Bool
== :: ADMMessage -> ADMMessage -> Bool
$c== :: ADMMessage -> ADMMessage -> Bool
Prelude.Eq, ReadPrec [ADMMessage]
ReadPrec ADMMessage
Int -> ReadS ADMMessage
ReadS [ADMMessage]
(Int -> ReadS ADMMessage)
-> ReadS [ADMMessage]
-> ReadPrec ADMMessage
-> ReadPrec [ADMMessage]
-> Read ADMMessage
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ADMMessage]
$creadListPrec :: ReadPrec [ADMMessage]
readPrec :: ReadPrec ADMMessage
$creadPrec :: ReadPrec ADMMessage
readList :: ReadS [ADMMessage]
$creadList :: ReadS [ADMMessage]
readsPrec :: Int -> ReadS ADMMessage
$creadsPrec :: Int -> ReadS ADMMessage
Prelude.Read, Int -> ADMMessage -> ShowS
[ADMMessage] -> ShowS
ADMMessage -> String
(Int -> ADMMessage -> ShowS)
-> (ADMMessage -> String)
-> ([ADMMessage] -> ShowS)
-> Show ADMMessage
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ADMMessage] -> ShowS
$cshowList :: [ADMMessage] -> ShowS
show :: ADMMessage -> String
$cshow :: ADMMessage -> String
showsPrec :: Int -> ADMMessage -> ShowS
$cshowsPrec :: Int -> ADMMessage -> ShowS
Prelude.Show, (forall x. ADMMessage -> Rep ADMMessage x)
-> (forall x. Rep ADMMessage x -> ADMMessage) -> Generic ADMMessage
forall x. Rep ADMMessage x -> ADMMessage
forall x. ADMMessage -> Rep ADMMessage x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ADMMessage x -> ADMMessage
$cfrom :: forall x. ADMMessage -> Rep ADMMessage x
Prelude.Generic)

-- |
-- Create a value of 'ADMMessage' 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:
--
-- 'substitutions', 'aDMMessage_substitutions' - The default message variables to use in the notification message. You
-- can override the default variables with individual address variables.
--
-- 'expiresAfter', 'aDMMessage_expiresAfter' - The amount of time, in seconds, that ADM should store the message if the
-- recipient\'s device is offline. Amazon Pinpoint specifies this value in
-- the expiresAfter parameter when it sends the notification message to
-- ADM.
--
-- 'md5', 'aDMMessage_md5' - The base64-encoded, MD5 checksum of the value specified by the Data
-- property. ADM uses the MD5 value to verify the integrity of the data.
--
-- 'silentPush', 'aDMMessage_silentPush' - Specifies whether the notification is a silent push notification, which
-- is a push notification that doesn\'t display on a recipient\'s device.
-- Silent push notifications can be used for cases such as updating an
-- app\'s configuration or supporting phone home functionality.
--
-- 'imageIconUrl', 'aDMMessage_imageIconUrl' - The URL of the large icon image to display in the content view of the
-- push notification.
--
-- 'rawContent', 'aDMMessage_rawContent' - The raw, JSON-formatted string to use as the payload for the
-- notification message. If specified, this value overrides all other
-- content for the message.
--
-- 'data'', 'aDMMessage_data' - The JSON data payload to use for the push notification, if the
-- notification is a silent push notification. This payload is added to the
-- data.pinpoint.jsonBody object of the notification.
--
-- 'smallImageIconUrl', 'aDMMessage_smallImageIconUrl' - The URL of the small icon image to display in the status bar and the
-- content view of the push notification.
--
-- 'body', 'aDMMessage_body' - The body of the notification message.
--
-- 'url', 'aDMMessage_url' - The URL to open in the recipient\'s default mobile browser, if a
-- recipient taps the push notification and the value of the Action
-- property is URL.
--
-- 'sound', 'aDMMessage_sound' - The sound to play when the recipient receives the push notification. You
-- can use the default stream or specify the file name of a sound resource
-- that\'s bundled in your app. On an Android platform, the sound file must
-- reside in \/res\/raw\/.
--
-- 'action', 'aDMMessage_action' - The action to occur if the recipient taps the push notification. Valid
-- values are:
--
-- -   OPEN_APP - Your app opens or it becomes the foreground app if it was
--     sent to the background. This is the default action.
--
-- -   DEEP_LINK - Your app opens and displays a designated user interface
--     in the app. This action uses the deep-linking features of the
--     Android platform.
--
-- -   URL - The default mobile browser on the recipient\'s device opens
--     and loads the web page at a URL that you specify.
--
-- 'imageUrl', 'aDMMessage_imageUrl' - The URL of an image to display in the push notification.
--
-- 'consolidationKey', 'aDMMessage_consolidationKey' - An arbitrary string that indicates that multiple messages are logically
-- the same and that Amazon Device Messaging (ADM) can drop previously
-- enqueued messages in favor of this message.
--
-- 'title', 'aDMMessage_title' - The title to display above the notification message on the recipient\'s
-- device.
--
-- 'iconReference', 'aDMMessage_iconReference' - The icon image name of the asset saved in your app.
newADMMessage ::
  ADMMessage
newADMMessage :: ADMMessage
newADMMessage =
  ADMMessage' :: Maybe (HashMap Text [Text])
-> Maybe Text
-> Maybe Text
-> Maybe Bool
-> Maybe Text
-> Maybe Text
-> Maybe (HashMap Text Text)
-> Maybe Text
-> Maybe Text
-> Maybe Text
-> Maybe Text
-> Maybe Action
-> Maybe Text
-> Maybe Text
-> Maybe Text
-> Maybe Text
-> ADMMessage
ADMMessage'
    { $sel:substitutions:ADMMessage' :: Maybe (HashMap Text [Text])
substitutions = Maybe (HashMap Text [Text])
forall a. Maybe a
Prelude.Nothing,
      $sel:expiresAfter:ADMMessage' :: Maybe Text
expiresAfter = Maybe Text
forall a. Maybe a
Prelude.Nothing,
      $sel:md5:ADMMessage' :: Maybe Text
md5 = Maybe Text
forall a. Maybe a
Prelude.Nothing,
      $sel:silentPush:ADMMessage' :: Maybe Bool
silentPush = Maybe Bool
forall a. Maybe a
Prelude.Nothing,
      $sel:imageIconUrl:ADMMessage' :: Maybe Text
imageIconUrl = Maybe Text
forall a. Maybe a
Prelude.Nothing,
      $sel:rawContent:ADMMessage' :: Maybe Text
rawContent = Maybe Text
forall a. Maybe a
Prelude.Nothing,
      $sel:data':ADMMessage' :: Maybe (HashMap Text Text)
data' = Maybe (HashMap Text Text)
forall a. Maybe a
Prelude.Nothing,
      $sel:smallImageIconUrl:ADMMessage' :: Maybe Text
smallImageIconUrl = Maybe Text
forall a. Maybe a
Prelude.Nothing,
      $sel:body:ADMMessage' :: Maybe Text
body = Maybe Text
forall a. Maybe a
Prelude.Nothing,
      $sel:url:ADMMessage' :: Maybe Text
url = Maybe Text
forall a. Maybe a
Prelude.Nothing,
      $sel:sound:ADMMessage' :: Maybe Text
sound = Maybe Text
forall a. Maybe a
Prelude.Nothing,
      $sel:action:ADMMessage' :: Maybe Action
action = Maybe Action
forall a. Maybe a
Prelude.Nothing,
      $sel:imageUrl:ADMMessage' :: Maybe Text
imageUrl = Maybe Text
forall a. Maybe a
Prelude.Nothing,
      $sel:consolidationKey:ADMMessage' :: Maybe Text
consolidationKey = Maybe Text
forall a. Maybe a
Prelude.Nothing,
      $sel:title:ADMMessage' :: Maybe Text
title = Maybe Text
forall a. Maybe a
Prelude.Nothing,
      $sel:iconReference:ADMMessage' :: Maybe Text
iconReference = Maybe Text
forall a. Maybe a
Prelude.Nothing
    }

-- | The default message variables to use in the notification message. You
-- can override the default variables with individual address variables.
aDMMessage_substitutions :: Lens.Lens' ADMMessage (Prelude.Maybe (Prelude.HashMap Prelude.Text [Prelude.Text]))
aDMMessage_substitutions :: (Maybe (HashMap Text [Text]) -> f (Maybe (HashMap Text [Text])))
-> ADMMessage -> f ADMMessage
aDMMessage_substitutions = (ADMMessage -> Maybe (HashMap Text [Text]))
-> (ADMMessage -> Maybe (HashMap Text [Text]) -> ADMMessage)
-> Lens
     ADMMessage
     ADMMessage
     (Maybe (HashMap Text [Text]))
     (Maybe (HashMap Text [Text]))
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ADMMessage' {Maybe (HashMap Text [Text])
substitutions :: Maybe (HashMap Text [Text])
$sel:substitutions:ADMMessage' :: ADMMessage -> Maybe (HashMap Text [Text])
substitutions} -> Maybe (HashMap Text [Text])
substitutions) (\s :: ADMMessage
s@ADMMessage' {} Maybe (HashMap Text [Text])
a -> ADMMessage
s {$sel:substitutions:ADMMessage' :: Maybe (HashMap Text [Text])
substitutions = Maybe (HashMap Text [Text])
a} :: ADMMessage) ((Maybe (HashMap Text [Text]) -> f (Maybe (HashMap Text [Text])))
 -> ADMMessage -> f ADMMessage)
-> ((Maybe (HashMap Text [Text])
     -> f (Maybe (HashMap Text [Text])))
    -> Maybe (HashMap Text [Text]) -> f (Maybe (HashMap Text [Text])))
-> (Maybe (HashMap Text [Text]) -> f (Maybe (HashMap Text [Text])))
-> ADMMessage
-> f ADMMessage
forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. AnIso
  (HashMap Text [Text])
  (HashMap Text [Text])
  (HashMap Text [Text])
  (HashMap Text [Text])
-> Iso
     (Maybe (HashMap Text [Text]))
     (Maybe (HashMap Text [Text]))
     (Maybe (HashMap Text [Text]))
     (Maybe (HashMap Text [Text]))
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 AnIso
  (HashMap Text [Text])
  (HashMap Text [Text])
  (HashMap Text [Text])
  (HashMap Text [Text])
forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | The amount of time, in seconds, that ADM should store the message if the
-- recipient\'s device is offline. Amazon Pinpoint specifies this value in
-- the expiresAfter parameter when it sends the notification message to
-- ADM.
aDMMessage_expiresAfter :: Lens.Lens' ADMMessage (Prelude.Maybe Prelude.Text)
aDMMessage_expiresAfter :: (Maybe Text -> f (Maybe Text)) -> ADMMessage -> f ADMMessage
aDMMessage_expiresAfter = (ADMMessage -> Maybe Text)
-> (ADMMessage -> Maybe Text -> ADMMessage)
-> Lens ADMMessage ADMMessage (Maybe Text) (Maybe Text)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ADMMessage' {Maybe Text
expiresAfter :: Maybe Text
$sel:expiresAfter:ADMMessage' :: ADMMessage -> Maybe Text
expiresAfter} -> Maybe Text
expiresAfter) (\s :: ADMMessage
s@ADMMessage' {} Maybe Text
a -> ADMMessage
s {$sel:expiresAfter:ADMMessage' :: Maybe Text
expiresAfter = Maybe Text
a} :: ADMMessage)

-- | The base64-encoded, MD5 checksum of the value specified by the Data
-- property. ADM uses the MD5 value to verify the integrity of the data.
aDMMessage_md5 :: Lens.Lens' ADMMessage (Prelude.Maybe Prelude.Text)
aDMMessage_md5 :: (Maybe Text -> f (Maybe Text)) -> ADMMessage -> f ADMMessage
aDMMessage_md5 = (ADMMessage -> Maybe Text)
-> (ADMMessage -> Maybe Text -> ADMMessage)
-> Lens ADMMessage ADMMessage (Maybe Text) (Maybe Text)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ADMMessage' {Maybe Text
md5 :: Maybe Text
$sel:md5:ADMMessage' :: ADMMessage -> Maybe Text
md5} -> Maybe Text
md5) (\s :: ADMMessage
s@ADMMessage' {} Maybe Text
a -> ADMMessage
s {$sel:md5:ADMMessage' :: Maybe Text
md5 = Maybe Text
a} :: ADMMessage)

-- | Specifies whether the notification is a silent push notification, which
-- is a push notification that doesn\'t display on a recipient\'s device.
-- Silent push notifications can be used for cases such as updating an
-- app\'s configuration or supporting phone home functionality.
aDMMessage_silentPush :: Lens.Lens' ADMMessage (Prelude.Maybe Prelude.Bool)
aDMMessage_silentPush :: (Maybe Bool -> f (Maybe Bool)) -> ADMMessage -> f ADMMessage
aDMMessage_silentPush = (ADMMessage -> Maybe Bool)
-> (ADMMessage -> Maybe Bool -> ADMMessage)
-> Lens ADMMessage ADMMessage (Maybe Bool) (Maybe Bool)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ADMMessage' {Maybe Bool
silentPush :: Maybe Bool
$sel:silentPush:ADMMessage' :: ADMMessage -> Maybe Bool
silentPush} -> Maybe Bool
silentPush) (\s :: ADMMessage
s@ADMMessage' {} Maybe Bool
a -> ADMMessage
s {$sel:silentPush:ADMMessage' :: Maybe Bool
silentPush = Maybe Bool
a} :: ADMMessage)

-- | The URL of the large icon image to display in the content view of the
-- push notification.
aDMMessage_imageIconUrl :: Lens.Lens' ADMMessage (Prelude.Maybe Prelude.Text)
aDMMessage_imageIconUrl :: (Maybe Text -> f (Maybe Text)) -> ADMMessage -> f ADMMessage
aDMMessage_imageIconUrl = (ADMMessage -> Maybe Text)
-> (ADMMessage -> Maybe Text -> ADMMessage)
-> Lens ADMMessage ADMMessage (Maybe Text) (Maybe Text)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ADMMessage' {Maybe Text
imageIconUrl :: Maybe Text
$sel:imageIconUrl:ADMMessage' :: ADMMessage -> Maybe Text
imageIconUrl} -> Maybe Text
imageIconUrl) (\s :: ADMMessage
s@ADMMessage' {} Maybe Text
a -> ADMMessage
s {$sel:imageIconUrl:ADMMessage' :: Maybe Text
imageIconUrl = Maybe Text
a} :: ADMMessage)

-- | The raw, JSON-formatted string to use as the payload for the
-- notification message. If specified, this value overrides all other
-- content for the message.
aDMMessage_rawContent :: Lens.Lens' ADMMessage (Prelude.Maybe Prelude.Text)
aDMMessage_rawContent :: (Maybe Text -> f (Maybe Text)) -> ADMMessage -> f ADMMessage
aDMMessage_rawContent = (ADMMessage -> Maybe Text)
-> (ADMMessage -> Maybe Text -> ADMMessage)
-> Lens ADMMessage ADMMessage (Maybe Text) (Maybe Text)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ADMMessage' {Maybe Text
rawContent :: Maybe Text
$sel:rawContent:ADMMessage' :: ADMMessage -> Maybe Text
rawContent} -> Maybe Text
rawContent) (\s :: ADMMessage
s@ADMMessage' {} Maybe Text
a -> ADMMessage
s {$sel:rawContent:ADMMessage' :: Maybe Text
rawContent = Maybe Text
a} :: ADMMessage)

-- | The JSON data payload to use for the push notification, if the
-- notification is a silent push notification. This payload is added to the
-- data.pinpoint.jsonBody object of the notification.
aDMMessage_data :: Lens.Lens' ADMMessage (Prelude.Maybe (Prelude.HashMap Prelude.Text Prelude.Text))
aDMMessage_data :: (Maybe (HashMap Text Text) -> f (Maybe (HashMap Text Text)))
-> ADMMessage -> f ADMMessage
aDMMessage_data = (ADMMessage -> Maybe (HashMap Text Text))
-> (ADMMessage -> Maybe (HashMap Text Text) -> ADMMessage)
-> Lens
     ADMMessage
     ADMMessage
     (Maybe (HashMap Text Text))
     (Maybe (HashMap Text Text))
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ADMMessage' {Maybe (HashMap Text Text)
data' :: Maybe (HashMap Text Text)
$sel:data':ADMMessage' :: ADMMessage -> Maybe (HashMap Text Text)
data'} -> Maybe (HashMap Text Text)
data') (\s :: ADMMessage
s@ADMMessage' {} Maybe (HashMap Text Text)
a -> ADMMessage
s {$sel:data':ADMMessage' :: Maybe (HashMap Text Text)
data' = Maybe (HashMap Text Text)
a} :: ADMMessage) ((Maybe (HashMap Text Text) -> f (Maybe (HashMap Text Text)))
 -> ADMMessage -> f ADMMessage)
-> ((Maybe (HashMap Text Text) -> f (Maybe (HashMap Text Text)))
    -> Maybe (HashMap Text Text) -> f (Maybe (HashMap Text Text)))
-> (Maybe (HashMap Text Text) -> f (Maybe (HashMap Text Text)))
-> ADMMessage
-> f ADMMessage
forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. AnIso
  (HashMap Text Text)
  (HashMap Text Text)
  (HashMap Text Text)
  (HashMap Text Text)
-> Iso
     (Maybe (HashMap Text Text))
     (Maybe (HashMap Text Text))
     (Maybe (HashMap Text Text))
     (Maybe (HashMap Text Text))
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 AnIso
  (HashMap Text Text)
  (HashMap Text Text)
  (HashMap Text Text)
  (HashMap Text Text)
forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | The URL of the small icon image to display in the status bar and the
-- content view of the push notification.
aDMMessage_smallImageIconUrl :: Lens.Lens' ADMMessage (Prelude.Maybe Prelude.Text)
aDMMessage_smallImageIconUrl :: (Maybe Text -> f (Maybe Text)) -> ADMMessage -> f ADMMessage
aDMMessage_smallImageIconUrl = (ADMMessage -> Maybe Text)
-> (ADMMessage -> Maybe Text -> ADMMessage)
-> Lens ADMMessage ADMMessage (Maybe Text) (Maybe Text)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ADMMessage' {Maybe Text
smallImageIconUrl :: Maybe Text
$sel:smallImageIconUrl:ADMMessage' :: ADMMessage -> Maybe Text
smallImageIconUrl} -> Maybe Text
smallImageIconUrl) (\s :: ADMMessage
s@ADMMessage' {} Maybe Text
a -> ADMMessage
s {$sel:smallImageIconUrl:ADMMessage' :: Maybe Text
smallImageIconUrl = Maybe Text
a} :: ADMMessage)

-- | The body of the notification message.
aDMMessage_body :: Lens.Lens' ADMMessage (Prelude.Maybe Prelude.Text)
aDMMessage_body :: (Maybe Text -> f (Maybe Text)) -> ADMMessage -> f ADMMessage
aDMMessage_body = (ADMMessage -> Maybe Text)
-> (ADMMessage -> Maybe Text -> ADMMessage)
-> Lens ADMMessage ADMMessage (Maybe Text) (Maybe Text)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ADMMessage' {Maybe Text
body :: Maybe Text
$sel:body:ADMMessage' :: ADMMessage -> Maybe Text
body} -> Maybe Text
body) (\s :: ADMMessage
s@ADMMessage' {} Maybe Text
a -> ADMMessage
s {$sel:body:ADMMessage' :: Maybe Text
body = Maybe Text
a} :: ADMMessage)

-- | The URL to open in the recipient\'s default mobile browser, if a
-- recipient taps the push notification and the value of the Action
-- property is URL.
aDMMessage_url :: Lens.Lens' ADMMessage (Prelude.Maybe Prelude.Text)
aDMMessage_url :: (Maybe Text -> f (Maybe Text)) -> ADMMessage -> f ADMMessage
aDMMessage_url = (ADMMessage -> Maybe Text)
-> (ADMMessage -> Maybe Text -> ADMMessage)
-> Lens ADMMessage ADMMessage (Maybe Text) (Maybe Text)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ADMMessage' {Maybe Text
url :: Maybe Text
$sel:url:ADMMessage' :: ADMMessage -> Maybe Text
url} -> Maybe Text
url) (\s :: ADMMessage
s@ADMMessage' {} Maybe Text
a -> ADMMessage
s {$sel:url:ADMMessage' :: Maybe Text
url = Maybe Text
a} :: ADMMessage)

-- | The sound to play when the recipient receives the push notification. You
-- can use the default stream or specify the file name of a sound resource
-- that\'s bundled in your app. On an Android platform, the sound file must
-- reside in \/res\/raw\/.
aDMMessage_sound :: Lens.Lens' ADMMessage (Prelude.Maybe Prelude.Text)
aDMMessage_sound :: (Maybe Text -> f (Maybe Text)) -> ADMMessage -> f ADMMessage
aDMMessage_sound = (ADMMessage -> Maybe Text)
-> (ADMMessage -> Maybe Text -> ADMMessage)
-> Lens ADMMessage ADMMessage (Maybe Text) (Maybe Text)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ADMMessage' {Maybe Text
sound :: Maybe Text
$sel:sound:ADMMessage' :: ADMMessage -> Maybe Text
sound} -> Maybe Text
sound) (\s :: ADMMessage
s@ADMMessage' {} Maybe Text
a -> ADMMessage
s {$sel:sound:ADMMessage' :: Maybe Text
sound = Maybe Text
a} :: ADMMessage)

-- | The action to occur if the recipient taps the push notification. Valid
-- values are:
--
-- -   OPEN_APP - Your app opens or it becomes the foreground app if it was
--     sent to the background. This is the default action.
--
-- -   DEEP_LINK - Your app opens and displays a designated user interface
--     in the app. This action uses the deep-linking features of the
--     Android platform.
--
-- -   URL - The default mobile browser on the recipient\'s device opens
--     and loads the web page at a URL that you specify.
aDMMessage_action :: Lens.Lens' ADMMessage (Prelude.Maybe Action)
aDMMessage_action :: (Maybe Action -> f (Maybe Action)) -> ADMMessage -> f ADMMessage
aDMMessage_action = (ADMMessage -> Maybe Action)
-> (ADMMessage -> Maybe Action -> ADMMessage)
-> Lens ADMMessage ADMMessage (Maybe Action) (Maybe Action)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ADMMessage' {Maybe Action
action :: Maybe Action
$sel:action:ADMMessage' :: ADMMessage -> Maybe Action
action} -> Maybe Action
action) (\s :: ADMMessage
s@ADMMessage' {} Maybe Action
a -> ADMMessage
s {$sel:action:ADMMessage' :: Maybe Action
action = Maybe Action
a} :: ADMMessage)

-- | The URL of an image to display in the push notification.
aDMMessage_imageUrl :: Lens.Lens' ADMMessage (Prelude.Maybe Prelude.Text)
aDMMessage_imageUrl :: (Maybe Text -> f (Maybe Text)) -> ADMMessage -> f ADMMessage
aDMMessage_imageUrl = (ADMMessage -> Maybe Text)
-> (ADMMessage -> Maybe Text -> ADMMessage)
-> Lens ADMMessage ADMMessage (Maybe Text) (Maybe Text)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ADMMessage' {Maybe Text
imageUrl :: Maybe Text
$sel:imageUrl:ADMMessage' :: ADMMessage -> Maybe Text
imageUrl} -> Maybe Text
imageUrl) (\s :: ADMMessage
s@ADMMessage' {} Maybe Text
a -> ADMMessage
s {$sel:imageUrl:ADMMessage' :: Maybe Text
imageUrl = Maybe Text
a} :: ADMMessage)

-- | An arbitrary string that indicates that multiple messages are logically
-- the same and that Amazon Device Messaging (ADM) can drop previously
-- enqueued messages in favor of this message.
aDMMessage_consolidationKey :: Lens.Lens' ADMMessage (Prelude.Maybe Prelude.Text)
aDMMessage_consolidationKey :: (Maybe Text -> f (Maybe Text)) -> ADMMessage -> f ADMMessage
aDMMessage_consolidationKey = (ADMMessage -> Maybe Text)
-> (ADMMessage -> Maybe Text -> ADMMessage)
-> Lens ADMMessage ADMMessage (Maybe Text) (Maybe Text)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ADMMessage' {Maybe Text
consolidationKey :: Maybe Text
$sel:consolidationKey:ADMMessage' :: ADMMessage -> Maybe Text
consolidationKey} -> Maybe Text
consolidationKey) (\s :: ADMMessage
s@ADMMessage' {} Maybe Text
a -> ADMMessage
s {$sel:consolidationKey:ADMMessage' :: Maybe Text
consolidationKey = Maybe Text
a} :: ADMMessage)

-- | The title to display above the notification message on the recipient\'s
-- device.
aDMMessage_title :: Lens.Lens' ADMMessage (Prelude.Maybe Prelude.Text)
aDMMessage_title :: (Maybe Text -> f (Maybe Text)) -> ADMMessage -> f ADMMessage
aDMMessage_title = (ADMMessage -> Maybe Text)
-> (ADMMessage -> Maybe Text -> ADMMessage)
-> Lens ADMMessage ADMMessage (Maybe Text) (Maybe Text)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ADMMessage' {Maybe Text
title :: Maybe Text
$sel:title:ADMMessage' :: ADMMessage -> Maybe Text
title} -> Maybe Text
title) (\s :: ADMMessage
s@ADMMessage' {} Maybe Text
a -> ADMMessage
s {$sel:title:ADMMessage' :: Maybe Text
title = Maybe Text
a} :: ADMMessage)

-- | The icon image name of the asset saved in your app.
aDMMessage_iconReference :: Lens.Lens' ADMMessage (Prelude.Maybe Prelude.Text)
aDMMessage_iconReference :: (Maybe Text -> f (Maybe Text)) -> ADMMessage -> f ADMMessage
aDMMessage_iconReference = (ADMMessage -> Maybe Text)
-> (ADMMessage -> Maybe Text -> ADMMessage)
-> Lens ADMMessage ADMMessage (Maybe Text) (Maybe Text)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ADMMessage' {Maybe Text
iconReference :: Maybe Text
$sel:iconReference:ADMMessage' :: ADMMessage -> Maybe Text
iconReference} -> Maybe Text
iconReference) (\s :: ADMMessage
s@ADMMessage' {} Maybe Text
a -> ADMMessage
s {$sel:iconReference:ADMMessage' :: Maybe Text
iconReference = Maybe Text
a} :: ADMMessage)

instance Prelude.Hashable ADMMessage

instance Prelude.NFData ADMMessage

instance Core.ToJSON ADMMessage where
  toJSON :: ADMMessage -> Value
toJSON ADMMessage' {Maybe Bool
Maybe Text
Maybe (HashMap Text [Text])
Maybe (HashMap Text Text)
Maybe Action
iconReference :: Maybe Text
title :: Maybe Text
consolidationKey :: Maybe Text
imageUrl :: Maybe Text
action :: Maybe Action
sound :: Maybe Text
url :: Maybe Text
body :: Maybe Text
smallImageIconUrl :: Maybe Text
data' :: Maybe (HashMap Text Text)
rawContent :: Maybe Text
imageIconUrl :: Maybe Text
silentPush :: Maybe Bool
md5 :: Maybe Text
expiresAfter :: Maybe Text
substitutions :: Maybe (HashMap Text [Text])
$sel:iconReference:ADMMessage' :: ADMMessage -> Maybe Text
$sel:title:ADMMessage' :: ADMMessage -> Maybe Text
$sel:consolidationKey:ADMMessage' :: ADMMessage -> Maybe Text
$sel:imageUrl:ADMMessage' :: ADMMessage -> Maybe Text
$sel:action:ADMMessage' :: ADMMessage -> Maybe Action
$sel:sound:ADMMessage' :: ADMMessage -> Maybe Text
$sel:url:ADMMessage' :: ADMMessage -> Maybe Text
$sel:body:ADMMessage' :: ADMMessage -> Maybe Text
$sel:smallImageIconUrl:ADMMessage' :: ADMMessage -> Maybe Text
$sel:data':ADMMessage' :: ADMMessage -> Maybe (HashMap Text Text)
$sel:rawContent:ADMMessage' :: ADMMessage -> Maybe Text
$sel:imageIconUrl:ADMMessage' :: ADMMessage -> Maybe Text
$sel:silentPush:ADMMessage' :: ADMMessage -> Maybe Bool
$sel:md5:ADMMessage' :: ADMMessage -> Maybe Text
$sel:expiresAfter:ADMMessage' :: ADMMessage -> Maybe Text
$sel:substitutions:ADMMessage' :: ADMMessage -> Maybe (HashMap Text [Text])
..} =
    [Pair] -> Value
Core.object
      ( [Maybe Pair] -> [Pair]
forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Text
"Substitutions" Text -> HashMap Text [Text] -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..=) (HashMap Text [Text] -> Pair)
-> Maybe (HashMap Text [Text]) -> Maybe Pair
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe (HashMap Text [Text])
substitutions,
            (Text
"ExpiresAfter" Text -> Text -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..=) (Text -> Pair) -> Maybe Text -> Maybe Pair
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
expiresAfter,
            (Text
"MD5" Text -> Text -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..=) (Text -> Pair) -> Maybe Text -> Maybe Pair
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
md5,
            (Text
"SilentPush" Text -> Bool -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..=) (Bool -> Pair) -> Maybe Bool -> Maybe Pair
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Bool
silentPush,
            (Text
"ImageIconUrl" Text -> Text -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..=) (Text -> Pair) -> Maybe Text -> Maybe Pair
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
imageIconUrl,
            (Text
"RawContent" Text -> Text -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..=) (Text -> Pair) -> Maybe Text -> Maybe Pair
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
rawContent,
            (Text
"Data" Text -> HashMap Text Text -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..=) (HashMap Text Text -> Pair)
-> Maybe (HashMap Text Text) -> Maybe Pair
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe (HashMap Text Text)
data',
            (Text
"SmallImageIconUrl" Text -> Text -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..=)
              (Text -> Pair) -> Maybe Text -> Maybe Pair
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
smallImageIconUrl,
            (Text
"Body" Text -> Text -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..=) (Text -> Pair) -> Maybe Text -> Maybe Pair
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
body,
            (Text
"Url" Text -> Text -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..=) (Text -> Pair) -> Maybe Text -> Maybe Pair
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
url,
            (Text
"Sound" Text -> Text -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..=) (Text -> Pair) -> Maybe Text -> Maybe Pair
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
sound,
            (Text
"Action" Text -> Action -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..=) (Action -> Pair) -> Maybe Action -> Maybe Pair
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Action
action,
            (Text
"ImageUrl" Text -> Text -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..=) (Text -> Pair) -> Maybe Text -> Maybe Pair
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
imageUrl,
            (Text
"ConsolidationKey" Text -> Text -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..=)
              (Text -> Pair) -> Maybe Text -> Maybe Pair
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
consolidationKey,
            (Text
"Title" Text -> Text -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..=) (Text -> Pair) -> Maybe Text -> Maybe Pair
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
title,
            (Text
"IconReference" Text -> Text -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..=) (Text -> Pair) -> Maybe Text -> Maybe Pair
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
iconReference
          ]
      )