{-# 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.InAppMessageCampaign
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
module Amazonka.Pinpoint.Types.InAppMessageCampaign where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import Amazonka.Pinpoint.Types.InAppCampaignSchedule
import Amazonka.Pinpoint.Types.InAppMessage
import qualified Amazonka.Prelude as Prelude

-- | Targeted in-app message campaign.
--
-- /See:/ 'newInAppMessageCampaign' smart constructor.
data InAppMessageCampaign = InAppMessageCampaign'
  { -- | Campaign id of the corresponding campaign.
    InAppMessageCampaign -> Maybe Text
campaignId :: Prelude.Maybe Prelude.Text,
    -- | Daily cap which controls the number of times any in-app messages can be
    -- shown to the endpoint during a day.
    InAppMessageCampaign -> Maybe Int
dailyCap :: Prelude.Maybe Prelude.Int,
    -- | In-app message content with all fields required for rendering an in-app
    -- message.
    InAppMessageCampaign -> Maybe InAppMessage
inAppMessage :: Prelude.Maybe InAppMessage,
    -- | Priority of the in-app message.
    InAppMessageCampaign -> Maybe Int
priority :: Prelude.Maybe Prelude.Int,
    -- | Schedule of the campaign.
    InAppMessageCampaign -> Maybe InAppCampaignSchedule
schedule :: Prelude.Maybe InAppCampaignSchedule,
    -- | Session cap which controls the number of times an in-app message can be
    -- shown to the endpoint during an application session.
    InAppMessageCampaign -> Maybe Int
sessionCap :: Prelude.Maybe Prelude.Int,
    -- | Total cap which controls the number of times an in-app message can be
    -- shown to the endpoint.
    InAppMessageCampaign -> Maybe Int
totalCap :: Prelude.Maybe Prelude.Int,
    -- | Treatment id of the campaign.
    InAppMessageCampaign -> Maybe Text
treatmentId :: Prelude.Maybe Prelude.Text
  }
  deriving (InAppMessageCampaign -> InAppMessageCampaign -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: InAppMessageCampaign -> InAppMessageCampaign -> Bool
$c/= :: InAppMessageCampaign -> InAppMessageCampaign -> Bool
== :: InAppMessageCampaign -> InAppMessageCampaign -> Bool
$c== :: InAppMessageCampaign -> InAppMessageCampaign -> Bool
Prelude.Eq, ReadPrec [InAppMessageCampaign]
ReadPrec InAppMessageCampaign
Int -> ReadS InAppMessageCampaign
ReadS [InAppMessageCampaign]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [InAppMessageCampaign]
$creadListPrec :: ReadPrec [InAppMessageCampaign]
readPrec :: ReadPrec InAppMessageCampaign
$creadPrec :: ReadPrec InAppMessageCampaign
readList :: ReadS [InAppMessageCampaign]
$creadList :: ReadS [InAppMessageCampaign]
readsPrec :: Int -> ReadS InAppMessageCampaign
$creadsPrec :: Int -> ReadS InAppMessageCampaign
Prelude.Read, Int -> InAppMessageCampaign -> ShowS
[InAppMessageCampaign] -> ShowS
InAppMessageCampaign -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [InAppMessageCampaign] -> ShowS
$cshowList :: [InAppMessageCampaign] -> ShowS
show :: InAppMessageCampaign -> String
$cshow :: InAppMessageCampaign -> String
showsPrec :: Int -> InAppMessageCampaign -> ShowS
$cshowsPrec :: Int -> InAppMessageCampaign -> ShowS
Prelude.Show, forall x. Rep InAppMessageCampaign x -> InAppMessageCampaign
forall x. InAppMessageCampaign -> Rep InAppMessageCampaign x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep InAppMessageCampaign x -> InAppMessageCampaign
$cfrom :: forall x. InAppMessageCampaign -> Rep InAppMessageCampaign x
Prelude.Generic)

-- |
-- Create a value of 'InAppMessageCampaign' 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:
--
-- 'campaignId', 'inAppMessageCampaign_campaignId' - Campaign id of the corresponding campaign.
--
-- 'dailyCap', 'inAppMessageCampaign_dailyCap' - Daily cap which controls the number of times any in-app messages can be
-- shown to the endpoint during a day.
--
-- 'inAppMessage', 'inAppMessageCampaign_inAppMessage' - In-app message content with all fields required for rendering an in-app
-- message.
--
-- 'priority', 'inAppMessageCampaign_priority' - Priority of the in-app message.
--
-- 'schedule', 'inAppMessageCampaign_schedule' - Schedule of the campaign.
--
-- 'sessionCap', 'inAppMessageCampaign_sessionCap' - Session cap which controls the number of times an in-app message can be
-- shown to the endpoint during an application session.
--
-- 'totalCap', 'inAppMessageCampaign_totalCap' - Total cap which controls the number of times an in-app message can be
-- shown to the endpoint.
--
-- 'treatmentId', 'inAppMessageCampaign_treatmentId' - Treatment id of the campaign.
newInAppMessageCampaign ::
  InAppMessageCampaign
newInAppMessageCampaign :: InAppMessageCampaign
newInAppMessageCampaign =
  InAppMessageCampaign'
    { $sel:campaignId:InAppMessageCampaign' :: Maybe Text
campaignId = forall a. Maybe a
Prelude.Nothing,
      $sel:dailyCap:InAppMessageCampaign' :: Maybe Int
dailyCap = forall a. Maybe a
Prelude.Nothing,
      $sel:inAppMessage:InAppMessageCampaign' :: Maybe InAppMessage
inAppMessage = forall a. Maybe a
Prelude.Nothing,
      $sel:priority:InAppMessageCampaign' :: Maybe Int
priority = forall a. Maybe a
Prelude.Nothing,
      $sel:schedule:InAppMessageCampaign' :: Maybe InAppCampaignSchedule
schedule = forall a. Maybe a
Prelude.Nothing,
      $sel:sessionCap:InAppMessageCampaign' :: Maybe Int
sessionCap = forall a. Maybe a
Prelude.Nothing,
      $sel:totalCap:InAppMessageCampaign' :: Maybe Int
totalCap = forall a. Maybe a
Prelude.Nothing,
      $sel:treatmentId:InAppMessageCampaign' :: Maybe Text
treatmentId = forall a. Maybe a
Prelude.Nothing
    }

-- | Campaign id of the corresponding campaign.
inAppMessageCampaign_campaignId :: Lens.Lens' InAppMessageCampaign (Prelude.Maybe Prelude.Text)
inAppMessageCampaign_campaignId :: Lens' InAppMessageCampaign (Maybe Text)
inAppMessageCampaign_campaignId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\InAppMessageCampaign' {Maybe Text
campaignId :: Maybe Text
$sel:campaignId:InAppMessageCampaign' :: InAppMessageCampaign -> Maybe Text
campaignId} -> Maybe Text
campaignId) (\s :: InAppMessageCampaign
s@InAppMessageCampaign' {} Maybe Text
a -> InAppMessageCampaign
s {$sel:campaignId:InAppMessageCampaign' :: Maybe Text
campaignId = Maybe Text
a} :: InAppMessageCampaign)

-- | Daily cap which controls the number of times any in-app messages can be
-- shown to the endpoint during a day.
inAppMessageCampaign_dailyCap :: Lens.Lens' InAppMessageCampaign (Prelude.Maybe Prelude.Int)
inAppMessageCampaign_dailyCap :: Lens' InAppMessageCampaign (Maybe Int)
inAppMessageCampaign_dailyCap = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\InAppMessageCampaign' {Maybe Int
dailyCap :: Maybe Int
$sel:dailyCap:InAppMessageCampaign' :: InAppMessageCampaign -> Maybe Int
dailyCap} -> Maybe Int
dailyCap) (\s :: InAppMessageCampaign
s@InAppMessageCampaign' {} Maybe Int
a -> InAppMessageCampaign
s {$sel:dailyCap:InAppMessageCampaign' :: Maybe Int
dailyCap = Maybe Int
a} :: InAppMessageCampaign)

-- | In-app message content with all fields required for rendering an in-app
-- message.
inAppMessageCampaign_inAppMessage :: Lens.Lens' InAppMessageCampaign (Prelude.Maybe InAppMessage)
inAppMessageCampaign_inAppMessage :: Lens' InAppMessageCampaign (Maybe InAppMessage)
inAppMessageCampaign_inAppMessage = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\InAppMessageCampaign' {Maybe InAppMessage
inAppMessage :: Maybe InAppMessage
$sel:inAppMessage:InAppMessageCampaign' :: InAppMessageCampaign -> Maybe InAppMessage
inAppMessage} -> Maybe InAppMessage
inAppMessage) (\s :: InAppMessageCampaign
s@InAppMessageCampaign' {} Maybe InAppMessage
a -> InAppMessageCampaign
s {$sel:inAppMessage:InAppMessageCampaign' :: Maybe InAppMessage
inAppMessage = Maybe InAppMessage
a} :: InAppMessageCampaign)

-- | Priority of the in-app message.
inAppMessageCampaign_priority :: Lens.Lens' InAppMessageCampaign (Prelude.Maybe Prelude.Int)
inAppMessageCampaign_priority :: Lens' InAppMessageCampaign (Maybe Int)
inAppMessageCampaign_priority = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\InAppMessageCampaign' {Maybe Int
priority :: Maybe Int
$sel:priority:InAppMessageCampaign' :: InAppMessageCampaign -> Maybe Int
priority} -> Maybe Int
priority) (\s :: InAppMessageCampaign
s@InAppMessageCampaign' {} Maybe Int
a -> InAppMessageCampaign
s {$sel:priority:InAppMessageCampaign' :: Maybe Int
priority = Maybe Int
a} :: InAppMessageCampaign)

-- | Schedule of the campaign.
inAppMessageCampaign_schedule :: Lens.Lens' InAppMessageCampaign (Prelude.Maybe InAppCampaignSchedule)
inAppMessageCampaign_schedule :: Lens' InAppMessageCampaign (Maybe InAppCampaignSchedule)
inAppMessageCampaign_schedule = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\InAppMessageCampaign' {Maybe InAppCampaignSchedule
schedule :: Maybe InAppCampaignSchedule
$sel:schedule:InAppMessageCampaign' :: InAppMessageCampaign -> Maybe InAppCampaignSchedule
schedule} -> Maybe InAppCampaignSchedule
schedule) (\s :: InAppMessageCampaign
s@InAppMessageCampaign' {} Maybe InAppCampaignSchedule
a -> InAppMessageCampaign
s {$sel:schedule:InAppMessageCampaign' :: Maybe InAppCampaignSchedule
schedule = Maybe InAppCampaignSchedule
a} :: InAppMessageCampaign)

-- | Session cap which controls the number of times an in-app message can be
-- shown to the endpoint during an application session.
inAppMessageCampaign_sessionCap :: Lens.Lens' InAppMessageCampaign (Prelude.Maybe Prelude.Int)
inAppMessageCampaign_sessionCap :: Lens' InAppMessageCampaign (Maybe Int)
inAppMessageCampaign_sessionCap = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\InAppMessageCampaign' {Maybe Int
sessionCap :: Maybe Int
$sel:sessionCap:InAppMessageCampaign' :: InAppMessageCampaign -> Maybe Int
sessionCap} -> Maybe Int
sessionCap) (\s :: InAppMessageCampaign
s@InAppMessageCampaign' {} Maybe Int
a -> InAppMessageCampaign
s {$sel:sessionCap:InAppMessageCampaign' :: Maybe Int
sessionCap = Maybe Int
a} :: InAppMessageCampaign)

-- | Total cap which controls the number of times an in-app message can be
-- shown to the endpoint.
inAppMessageCampaign_totalCap :: Lens.Lens' InAppMessageCampaign (Prelude.Maybe Prelude.Int)
inAppMessageCampaign_totalCap :: Lens' InAppMessageCampaign (Maybe Int)
inAppMessageCampaign_totalCap = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\InAppMessageCampaign' {Maybe Int
totalCap :: Maybe Int
$sel:totalCap:InAppMessageCampaign' :: InAppMessageCampaign -> Maybe Int
totalCap} -> Maybe Int
totalCap) (\s :: InAppMessageCampaign
s@InAppMessageCampaign' {} Maybe Int
a -> InAppMessageCampaign
s {$sel:totalCap:InAppMessageCampaign' :: Maybe Int
totalCap = Maybe Int
a} :: InAppMessageCampaign)

-- | Treatment id of the campaign.
inAppMessageCampaign_treatmentId :: Lens.Lens' InAppMessageCampaign (Prelude.Maybe Prelude.Text)
inAppMessageCampaign_treatmentId :: Lens' InAppMessageCampaign (Maybe Text)
inAppMessageCampaign_treatmentId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\InAppMessageCampaign' {Maybe Text
treatmentId :: Maybe Text
$sel:treatmentId:InAppMessageCampaign' :: InAppMessageCampaign -> Maybe Text
treatmentId} -> Maybe Text
treatmentId) (\s :: InAppMessageCampaign
s@InAppMessageCampaign' {} Maybe Text
a -> InAppMessageCampaign
s {$sel:treatmentId:InAppMessageCampaign' :: Maybe Text
treatmentId = Maybe Text
a} :: InAppMessageCampaign)

instance Data.FromJSON InAppMessageCampaign where
  parseJSON :: Value -> Parser InAppMessageCampaign
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"InAppMessageCampaign"
      ( \Object
x ->
          Maybe Text
-> Maybe Int
-> Maybe InAppMessage
-> Maybe Int
-> Maybe InAppCampaignSchedule
-> Maybe Int
-> Maybe Int
-> Maybe Text
-> InAppMessageCampaign
InAppMessageCampaign'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"CampaignId")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"DailyCap")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"InAppMessage")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"Priority")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"Schedule")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"SessionCap")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"TotalCap")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"TreatmentId")
      )

instance Prelude.Hashable InAppMessageCampaign where
  hashWithSalt :: Int -> InAppMessageCampaign -> Int
hashWithSalt Int
_salt InAppMessageCampaign' {Maybe Int
Maybe Text
Maybe InAppMessage
Maybe InAppCampaignSchedule
treatmentId :: Maybe Text
totalCap :: Maybe Int
sessionCap :: Maybe Int
schedule :: Maybe InAppCampaignSchedule
priority :: Maybe Int
inAppMessage :: Maybe InAppMessage
dailyCap :: Maybe Int
campaignId :: Maybe Text
$sel:treatmentId:InAppMessageCampaign' :: InAppMessageCampaign -> Maybe Text
$sel:totalCap:InAppMessageCampaign' :: InAppMessageCampaign -> Maybe Int
$sel:sessionCap:InAppMessageCampaign' :: InAppMessageCampaign -> Maybe Int
$sel:schedule:InAppMessageCampaign' :: InAppMessageCampaign -> Maybe InAppCampaignSchedule
$sel:priority:InAppMessageCampaign' :: InAppMessageCampaign -> Maybe Int
$sel:inAppMessage:InAppMessageCampaign' :: InAppMessageCampaign -> Maybe InAppMessage
$sel:dailyCap:InAppMessageCampaign' :: InAppMessageCampaign -> Maybe Int
$sel:campaignId:InAppMessageCampaign' :: InAppMessageCampaign -> Maybe Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
campaignId
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Int
dailyCap
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe InAppMessage
inAppMessage
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Int
priority
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe InAppCampaignSchedule
schedule
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Int
sessionCap
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Int
totalCap
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
treatmentId

instance Prelude.NFData InAppMessageCampaign where
  rnf :: InAppMessageCampaign -> ()
rnf InAppMessageCampaign' {Maybe Int
Maybe Text
Maybe InAppMessage
Maybe InAppCampaignSchedule
treatmentId :: Maybe Text
totalCap :: Maybe Int
sessionCap :: Maybe Int
schedule :: Maybe InAppCampaignSchedule
priority :: Maybe Int
inAppMessage :: Maybe InAppMessage
dailyCap :: Maybe Int
campaignId :: Maybe Text
$sel:treatmentId:InAppMessageCampaign' :: InAppMessageCampaign -> Maybe Text
$sel:totalCap:InAppMessageCampaign' :: InAppMessageCampaign -> Maybe Int
$sel:sessionCap:InAppMessageCampaign' :: InAppMessageCampaign -> Maybe Int
$sel:schedule:InAppMessageCampaign' :: InAppMessageCampaign -> Maybe InAppCampaignSchedule
$sel:priority:InAppMessageCampaign' :: InAppMessageCampaign -> Maybe Int
$sel:inAppMessage:InAppMessageCampaign' :: InAppMessageCampaign -> Maybe InAppMessage
$sel:dailyCap:InAppMessageCampaign' :: InAppMessageCampaign -> Maybe Int
$sel:campaignId:InAppMessageCampaign' :: InAppMessageCampaign -> Maybe Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
campaignId
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Int
dailyCap
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe InAppMessage
inAppMessage
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Int
priority
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe InAppCampaignSchedule
schedule
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Int
sessionCap
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Int
totalCap
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
treatmentId