{-# 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.TreatmentResource
-- 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.TreatmentResource 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.CampaignState
import Amazonka.Pinpoint.Types.CustomDeliveryConfiguration
import Amazonka.Pinpoint.Types.MessageConfiguration
import Amazonka.Pinpoint.Types.Schedule
import Amazonka.Pinpoint.Types.TemplateConfiguration
import qualified Amazonka.Prelude as Prelude

-- | Specifies the settings for a campaign treatment. A /treatment/ is a
-- variation of a campaign that\'s used for A\/B testing of a campaign.
--
-- /See:/ 'newTreatmentResource' smart constructor.
data TreatmentResource = TreatmentResource'
  { -- | The delivery configuration settings for sending the treatment through a
    -- custom channel. This object is required if the MessageConfiguration
    -- object for the treatment specifies a CustomMessage object.
    TreatmentResource -> Maybe CustomDeliveryConfiguration
customDeliveryConfiguration :: Prelude.Maybe CustomDeliveryConfiguration,
    -- | The message configuration settings for the treatment.
    TreatmentResource -> Maybe MessageConfiguration
messageConfiguration :: Prelude.Maybe MessageConfiguration,
    -- | The schedule settings for the treatment.
    TreatmentResource -> Maybe Schedule
schedule :: Prelude.Maybe Schedule,
    -- | The current status of the treatment.
    TreatmentResource -> Maybe CampaignState
state :: Prelude.Maybe CampaignState,
    -- | The message template to use for the treatment.
    TreatmentResource -> Maybe TemplateConfiguration
templateConfiguration :: Prelude.Maybe TemplateConfiguration,
    -- | The custom description of the treatment.
    TreatmentResource -> Maybe Text
treatmentDescription :: Prelude.Maybe Prelude.Text,
    -- | The custom name of the treatment.
    TreatmentResource -> Maybe Text
treatmentName :: Prelude.Maybe Prelude.Text,
    -- | The unique identifier for the treatment.
    TreatmentResource -> Text
id :: Prelude.Text,
    -- | The allocated percentage of users (segment members) that the treatment
    -- is sent to.
    TreatmentResource -> Int
sizePercent :: Prelude.Int
  }
  deriving (TreatmentResource -> TreatmentResource -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: TreatmentResource -> TreatmentResource -> Bool
$c/= :: TreatmentResource -> TreatmentResource -> Bool
== :: TreatmentResource -> TreatmentResource -> Bool
$c== :: TreatmentResource -> TreatmentResource -> Bool
Prelude.Eq, ReadPrec [TreatmentResource]
ReadPrec TreatmentResource
Int -> ReadS TreatmentResource
ReadS [TreatmentResource]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [TreatmentResource]
$creadListPrec :: ReadPrec [TreatmentResource]
readPrec :: ReadPrec TreatmentResource
$creadPrec :: ReadPrec TreatmentResource
readList :: ReadS [TreatmentResource]
$creadList :: ReadS [TreatmentResource]
readsPrec :: Int -> ReadS TreatmentResource
$creadsPrec :: Int -> ReadS TreatmentResource
Prelude.Read, Int -> TreatmentResource -> ShowS
[TreatmentResource] -> ShowS
TreatmentResource -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [TreatmentResource] -> ShowS
$cshowList :: [TreatmentResource] -> ShowS
show :: TreatmentResource -> String
$cshow :: TreatmentResource -> String
showsPrec :: Int -> TreatmentResource -> ShowS
$cshowsPrec :: Int -> TreatmentResource -> ShowS
Prelude.Show, forall x. Rep TreatmentResource x -> TreatmentResource
forall x. TreatmentResource -> Rep TreatmentResource x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep TreatmentResource x -> TreatmentResource
$cfrom :: forall x. TreatmentResource -> Rep TreatmentResource x
Prelude.Generic)

-- |
-- Create a value of 'TreatmentResource' 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:
--
-- 'customDeliveryConfiguration', 'treatmentResource_customDeliveryConfiguration' - The delivery configuration settings for sending the treatment through a
-- custom channel. This object is required if the MessageConfiguration
-- object for the treatment specifies a CustomMessage object.
--
-- 'messageConfiguration', 'treatmentResource_messageConfiguration' - The message configuration settings for the treatment.
--
-- 'schedule', 'treatmentResource_schedule' - The schedule settings for the treatment.
--
-- 'state', 'treatmentResource_state' - The current status of the treatment.
--
-- 'templateConfiguration', 'treatmentResource_templateConfiguration' - The message template to use for the treatment.
--
-- 'treatmentDescription', 'treatmentResource_treatmentDescription' - The custom description of the treatment.
--
-- 'treatmentName', 'treatmentResource_treatmentName' - The custom name of the treatment.
--
-- 'id', 'treatmentResource_id' - The unique identifier for the treatment.
--
-- 'sizePercent', 'treatmentResource_sizePercent' - The allocated percentage of users (segment members) that the treatment
-- is sent to.
newTreatmentResource ::
  -- | 'id'
  Prelude.Text ->
  -- | 'sizePercent'
  Prelude.Int ->
  TreatmentResource
newTreatmentResource :: Text -> Int -> TreatmentResource
newTreatmentResource Text
pId_ Int
pSizePercent_ =
  TreatmentResource'
    { $sel:customDeliveryConfiguration:TreatmentResource' :: Maybe CustomDeliveryConfiguration
customDeliveryConfiguration =
        forall a. Maybe a
Prelude.Nothing,
      $sel:messageConfiguration:TreatmentResource' :: Maybe MessageConfiguration
messageConfiguration = forall a. Maybe a
Prelude.Nothing,
      $sel:schedule:TreatmentResource' :: Maybe Schedule
schedule = forall a. Maybe a
Prelude.Nothing,
      $sel:state:TreatmentResource' :: Maybe CampaignState
state = forall a. Maybe a
Prelude.Nothing,
      $sel:templateConfiguration:TreatmentResource' :: Maybe TemplateConfiguration
templateConfiguration = forall a. Maybe a
Prelude.Nothing,
      $sel:treatmentDescription:TreatmentResource' :: Maybe Text
treatmentDescription = forall a. Maybe a
Prelude.Nothing,
      $sel:treatmentName:TreatmentResource' :: Maybe Text
treatmentName = forall a. Maybe a
Prelude.Nothing,
      $sel:id:TreatmentResource' :: Text
id = Text
pId_,
      $sel:sizePercent:TreatmentResource' :: Int
sizePercent = Int
pSizePercent_
    }

-- | The delivery configuration settings for sending the treatment through a
-- custom channel. This object is required if the MessageConfiguration
-- object for the treatment specifies a CustomMessage object.
treatmentResource_customDeliveryConfiguration :: Lens.Lens' TreatmentResource (Prelude.Maybe CustomDeliveryConfiguration)
treatmentResource_customDeliveryConfiguration :: Lens' TreatmentResource (Maybe CustomDeliveryConfiguration)
treatmentResource_customDeliveryConfiguration = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\TreatmentResource' {Maybe CustomDeliveryConfiguration
customDeliveryConfiguration :: Maybe CustomDeliveryConfiguration
$sel:customDeliveryConfiguration:TreatmentResource' :: TreatmentResource -> Maybe CustomDeliveryConfiguration
customDeliveryConfiguration} -> Maybe CustomDeliveryConfiguration
customDeliveryConfiguration) (\s :: TreatmentResource
s@TreatmentResource' {} Maybe CustomDeliveryConfiguration
a -> TreatmentResource
s {$sel:customDeliveryConfiguration:TreatmentResource' :: Maybe CustomDeliveryConfiguration
customDeliveryConfiguration = Maybe CustomDeliveryConfiguration
a} :: TreatmentResource)

-- | The message configuration settings for the treatment.
treatmentResource_messageConfiguration :: Lens.Lens' TreatmentResource (Prelude.Maybe MessageConfiguration)
treatmentResource_messageConfiguration :: Lens' TreatmentResource (Maybe MessageConfiguration)
treatmentResource_messageConfiguration = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\TreatmentResource' {Maybe MessageConfiguration
messageConfiguration :: Maybe MessageConfiguration
$sel:messageConfiguration:TreatmentResource' :: TreatmentResource -> Maybe MessageConfiguration
messageConfiguration} -> Maybe MessageConfiguration
messageConfiguration) (\s :: TreatmentResource
s@TreatmentResource' {} Maybe MessageConfiguration
a -> TreatmentResource
s {$sel:messageConfiguration:TreatmentResource' :: Maybe MessageConfiguration
messageConfiguration = Maybe MessageConfiguration
a} :: TreatmentResource)

-- | The schedule settings for the treatment.
treatmentResource_schedule :: Lens.Lens' TreatmentResource (Prelude.Maybe Schedule)
treatmentResource_schedule :: Lens' TreatmentResource (Maybe Schedule)
treatmentResource_schedule = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\TreatmentResource' {Maybe Schedule
schedule :: Maybe Schedule
$sel:schedule:TreatmentResource' :: TreatmentResource -> Maybe Schedule
schedule} -> Maybe Schedule
schedule) (\s :: TreatmentResource
s@TreatmentResource' {} Maybe Schedule
a -> TreatmentResource
s {$sel:schedule:TreatmentResource' :: Maybe Schedule
schedule = Maybe Schedule
a} :: TreatmentResource)

-- | The current status of the treatment.
treatmentResource_state :: Lens.Lens' TreatmentResource (Prelude.Maybe CampaignState)
treatmentResource_state :: Lens' TreatmentResource (Maybe CampaignState)
treatmentResource_state = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\TreatmentResource' {Maybe CampaignState
state :: Maybe CampaignState
$sel:state:TreatmentResource' :: TreatmentResource -> Maybe CampaignState
state} -> Maybe CampaignState
state) (\s :: TreatmentResource
s@TreatmentResource' {} Maybe CampaignState
a -> TreatmentResource
s {$sel:state:TreatmentResource' :: Maybe CampaignState
state = Maybe CampaignState
a} :: TreatmentResource)

-- | The message template to use for the treatment.
treatmentResource_templateConfiguration :: Lens.Lens' TreatmentResource (Prelude.Maybe TemplateConfiguration)
treatmentResource_templateConfiguration :: Lens' TreatmentResource (Maybe TemplateConfiguration)
treatmentResource_templateConfiguration = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\TreatmentResource' {Maybe TemplateConfiguration
templateConfiguration :: Maybe TemplateConfiguration
$sel:templateConfiguration:TreatmentResource' :: TreatmentResource -> Maybe TemplateConfiguration
templateConfiguration} -> Maybe TemplateConfiguration
templateConfiguration) (\s :: TreatmentResource
s@TreatmentResource' {} Maybe TemplateConfiguration
a -> TreatmentResource
s {$sel:templateConfiguration:TreatmentResource' :: Maybe TemplateConfiguration
templateConfiguration = Maybe TemplateConfiguration
a} :: TreatmentResource)

-- | The custom description of the treatment.
treatmentResource_treatmentDescription :: Lens.Lens' TreatmentResource (Prelude.Maybe Prelude.Text)
treatmentResource_treatmentDescription :: Lens' TreatmentResource (Maybe Text)
treatmentResource_treatmentDescription = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\TreatmentResource' {Maybe Text
treatmentDescription :: Maybe Text
$sel:treatmentDescription:TreatmentResource' :: TreatmentResource -> Maybe Text
treatmentDescription} -> Maybe Text
treatmentDescription) (\s :: TreatmentResource
s@TreatmentResource' {} Maybe Text
a -> TreatmentResource
s {$sel:treatmentDescription:TreatmentResource' :: Maybe Text
treatmentDescription = Maybe Text
a} :: TreatmentResource)

-- | The custom name of the treatment.
treatmentResource_treatmentName :: Lens.Lens' TreatmentResource (Prelude.Maybe Prelude.Text)
treatmentResource_treatmentName :: Lens' TreatmentResource (Maybe Text)
treatmentResource_treatmentName = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\TreatmentResource' {Maybe Text
treatmentName :: Maybe Text
$sel:treatmentName:TreatmentResource' :: TreatmentResource -> Maybe Text
treatmentName} -> Maybe Text
treatmentName) (\s :: TreatmentResource
s@TreatmentResource' {} Maybe Text
a -> TreatmentResource
s {$sel:treatmentName:TreatmentResource' :: Maybe Text
treatmentName = Maybe Text
a} :: TreatmentResource)

-- | The unique identifier for the treatment.
treatmentResource_id :: Lens.Lens' TreatmentResource Prelude.Text
treatmentResource_id :: Lens' TreatmentResource Text
treatmentResource_id = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\TreatmentResource' {Text
id :: Text
$sel:id:TreatmentResource' :: TreatmentResource -> Text
id} -> Text
id) (\s :: TreatmentResource
s@TreatmentResource' {} Text
a -> TreatmentResource
s {$sel:id:TreatmentResource' :: Text
id = Text
a} :: TreatmentResource)

-- | The allocated percentage of users (segment members) that the treatment
-- is sent to.
treatmentResource_sizePercent :: Lens.Lens' TreatmentResource Prelude.Int
treatmentResource_sizePercent :: Lens' TreatmentResource Int
treatmentResource_sizePercent = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\TreatmentResource' {Int
sizePercent :: Int
$sel:sizePercent:TreatmentResource' :: TreatmentResource -> Int
sizePercent} -> Int
sizePercent) (\s :: TreatmentResource
s@TreatmentResource' {} Int
a -> TreatmentResource
s {$sel:sizePercent:TreatmentResource' :: Int
sizePercent = Int
a} :: TreatmentResource)

instance Data.FromJSON TreatmentResource where
  parseJSON :: Value -> Parser TreatmentResource
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"TreatmentResource"
      ( \Object
x ->
          Maybe CustomDeliveryConfiguration
-> Maybe MessageConfiguration
-> Maybe Schedule
-> Maybe CampaignState
-> Maybe TemplateConfiguration
-> Maybe Text
-> Maybe Text
-> Text
-> Int
-> TreatmentResource
TreatmentResource'
            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
"CustomDeliveryConfiguration")
            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
"MessageConfiguration")
            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
"State")
            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
"TemplateConfiguration")
            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
"TreatmentDescription")
            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
"TreatmentName")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser a
Data..: Key
"Id")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser a
Data..: Key
"SizePercent")
      )

instance Prelude.Hashable TreatmentResource where
  hashWithSalt :: Int -> TreatmentResource -> Int
hashWithSalt Int
_salt TreatmentResource' {Int
Maybe Text
Maybe CampaignState
Maybe CustomDeliveryConfiguration
Maybe MessageConfiguration
Maybe Schedule
Maybe TemplateConfiguration
Text
sizePercent :: Int
id :: Text
treatmentName :: Maybe Text
treatmentDescription :: Maybe Text
templateConfiguration :: Maybe TemplateConfiguration
state :: Maybe CampaignState
schedule :: Maybe Schedule
messageConfiguration :: Maybe MessageConfiguration
customDeliveryConfiguration :: Maybe CustomDeliveryConfiguration
$sel:sizePercent:TreatmentResource' :: TreatmentResource -> Int
$sel:id:TreatmentResource' :: TreatmentResource -> Text
$sel:treatmentName:TreatmentResource' :: TreatmentResource -> Maybe Text
$sel:treatmentDescription:TreatmentResource' :: TreatmentResource -> Maybe Text
$sel:templateConfiguration:TreatmentResource' :: TreatmentResource -> Maybe TemplateConfiguration
$sel:state:TreatmentResource' :: TreatmentResource -> Maybe CampaignState
$sel:schedule:TreatmentResource' :: TreatmentResource -> Maybe Schedule
$sel:messageConfiguration:TreatmentResource' :: TreatmentResource -> Maybe MessageConfiguration
$sel:customDeliveryConfiguration:TreatmentResource' :: TreatmentResource -> Maybe CustomDeliveryConfiguration
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe CustomDeliveryConfiguration
customDeliveryConfiguration
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe MessageConfiguration
messageConfiguration
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Schedule
schedule
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe CampaignState
state
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe TemplateConfiguration
templateConfiguration
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
treatmentDescription
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
treatmentName
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
id
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Int
sizePercent

instance Prelude.NFData TreatmentResource where
  rnf :: TreatmentResource -> ()
rnf TreatmentResource' {Int
Maybe Text
Maybe CampaignState
Maybe CustomDeliveryConfiguration
Maybe MessageConfiguration
Maybe Schedule
Maybe TemplateConfiguration
Text
sizePercent :: Int
id :: Text
treatmentName :: Maybe Text
treatmentDescription :: Maybe Text
templateConfiguration :: Maybe TemplateConfiguration
state :: Maybe CampaignState
schedule :: Maybe Schedule
messageConfiguration :: Maybe MessageConfiguration
customDeliveryConfiguration :: Maybe CustomDeliveryConfiguration
$sel:sizePercent:TreatmentResource' :: TreatmentResource -> Int
$sel:id:TreatmentResource' :: TreatmentResource -> Text
$sel:treatmentName:TreatmentResource' :: TreatmentResource -> Maybe Text
$sel:treatmentDescription:TreatmentResource' :: TreatmentResource -> Maybe Text
$sel:templateConfiguration:TreatmentResource' :: TreatmentResource -> Maybe TemplateConfiguration
$sel:state:TreatmentResource' :: TreatmentResource -> Maybe CampaignState
$sel:schedule:TreatmentResource' :: TreatmentResource -> Maybe Schedule
$sel:messageConfiguration:TreatmentResource' :: TreatmentResource -> Maybe MessageConfiguration
$sel:customDeliveryConfiguration:TreatmentResource' :: TreatmentResource -> Maybe CustomDeliveryConfiguration
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe CustomDeliveryConfiguration
customDeliveryConfiguration
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe MessageConfiguration
messageConfiguration
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Schedule
schedule
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe CampaignState
state
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe TemplateConfiguration
templateConfiguration
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
treatmentDescription
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
treatmentName
      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 Int
sizePercent