{-# 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.WriteTreatmentResource
-- 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.WriteTreatmentResource 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.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:/ 'newWriteTreatmentResource' smart constructor.
data WriteTreatmentResource = WriteTreatmentResource'
  { -- | 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.
    WriteTreatmentResource -> Maybe CustomDeliveryConfiguration
customDeliveryConfiguration :: Prelude.Maybe CustomDeliveryConfiguration,
    -- | The message configuration settings for the treatment.
    WriteTreatmentResource -> Maybe MessageConfiguration
messageConfiguration :: Prelude.Maybe MessageConfiguration,
    -- | The schedule settings for the treatment.
    WriteTreatmentResource -> Maybe Schedule
schedule :: Prelude.Maybe Schedule,
    -- | The message template to use for the treatment.
    WriteTreatmentResource -> Maybe TemplateConfiguration
templateConfiguration :: Prelude.Maybe TemplateConfiguration,
    -- | A custom description of the treatment.
    WriteTreatmentResource -> Maybe Text
treatmentDescription :: Prelude.Maybe Prelude.Text,
    -- | A custom name for the treatment.
    WriteTreatmentResource -> Maybe Text
treatmentName :: Prelude.Maybe Prelude.Text,
    -- | The allocated percentage of users (segment members) to send the
    -- treatment to.
    WriteTreatmentResource -> Int
sizePercent :: Prelude.Int
  }
  deriving (WriteTreatmentResource -> WriteTreatmentResource -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: WriteTreatmentResource -> WriteTreatmentResource -> Bool
$c/= :: WriteTreatmentResource -> WriteTreatmentResource -> Bool
== :: WriteTreatmentResource -> WriteTreatmentResource -> Bool
$c== :: WriteTreatmentResource -> WriteTreatmentResource -> Bool
Prelude.Eq, ReadPrec [WriteTreatmentResource]
ReadPrec WriteTreatmentResource
Int -> ReadS WriteTreatmentResource
ReadS [WriteTreatmentResource]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [WriteTreatmentResource]
$creadListPrec :: ReadPrec [WriteTreatmentResource]
readPrec :: ReadPrec WriteTreatmentResource
$creadPrec :: ReadPrec WriteTreatmentResource
readList :: ReadS [WriteTreatmentResource]
$creadList :: ReadS [WriteTreatmentResource]
readsPrec :: Int -> ReadS WriteTreatmentResource
$creadsPrec :: Int -> ReadS WriteTreatmentResource
Prelude.Read, Int -> WriteTreatmentResource -> ShowS
[WriteTreatmentResource] -> ShowS
WriteTreatmentResource -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [WriteTreatmentResource] -> ShowS
$cshowList :: [WriteTreatmentResource] -> ShowS
show :: WriteTreatmentResource -> String
$cshow :: WriteTreatmentResource -> String
showsPrec :: Int -> WriteTreatmentResource -> ShowS
$cshowsPrec :: Int -> WriteTreatmentResource -> ShowS
Prelude.Show, forall x. Rep WriteTreatmentResource x -> WriteTreatmentResource
forall x. WriteTreatmentResource -> Rep WriteTreatmentResource x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep WriteTreatmentResource x -> WriteTreatmentResource
$cfrom :: forall x. WriteTreatmentResource -> Rep WriteTreatmentResource x
Prelude.Generic)

-- |
-- Create a value of 'WriteTreatmentResource' 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', 'writeTreatmentResource_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', 'writeTreatmentResource_messageConfiguration' - The message configuration settings for the treatment.
--
-- 'schedule', 'writeTreatmentResource_schedule' - The schedule settings for the treatment.
--
-- 'templateConfiguration', 'writeTreatmentResource_templateConfiguration' - The message template to use for the treatment.
--
-- 'treatmentDescription', 'writeTreatmentResource_treatmentDescription' - A custom description of the treatment.
--
-- 'treatmentName', 'writeTreatmentResource_treatmentName' - A custom name for the treatment.
--
-- 'sizePercent', 'writeTreatmentResource_sizePercent' - The allocated percentage of users (segment members) to send the
-- treatment to.
newWriteTreatmentResource ::
  -- | 'sizePercent'
  Prelude.Int ->
  WriteTreatmentResource
newWriteTreatmentResource :: Int -> WriteTreatmentResource
newWriteTreatmentResource Int
pSizePercent_ =
  WriteTreatmentResource'
    { $sel:customDeliveryConfiguration:WriteTreatmentResource' :: Maybe CustomDeliveryConfiguration
customDeliveryConfiguration =
        forall a. Maybe a
Prelude.Nothing,
      $sel:messageConfiguration:WriteTreatmentResource' :: Maybe MessageConfiguration
messageConfiguration = forall a. Maybe a
Prelude.Nothing,
      $sel:schedule:WriteTreatmentResource' :: Maybe Schedule
schedule = forall a. Maybe a
Prelude.Nothing,
      $sel:templateConfiguration:WriteTreatmentResource' :: Maybe TemplateConfiguration
templateConfiguration = forall a. Maybe a
Prelude.Nothing,
      $sel:treatmentDescription:WriteTreatmentResource' :: Maybe Text
treatmentDescription = forall a. Maybe a
Prelude.Nothing,
      $sel:treatmentName:WriteTreatmentResource' :: Maybe Text
treatmentName = forall a. Maybe a
Prelude.Nothing,
      $sel:sizePercent:WriteTreatmentResource' :: 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.
writeTreatmentResource_customDeliveryConfiguration :: Lens.Lens' WriteTreatmentResource (Prelude.Maybe CustomDeliveryConfiguration)
writeTreatmentResource_customDeliveryConfiguration :: Lens' WriteTreatmentResource (Maybe CustomDeliveryConfiguration)
writeTreatmentResource_customDeliveryConfiguration = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\WriteTreatmentResource' {Maybe CustomDeliveryConfiguration
customDeliveryConfiguration :: Maybe CustomDeliveryConfiguration
$sel:customDeliveryConfiguration:WriteTreatmentResource' :: WriteTreatmentResource -> Maybe CustomDeliveryConfiguration
customDeliveryConfiguration} -> Maybe CustomDeliveryConfiguration
customDeliveryConfiguration) (\s :: WriteTreatmentResource
s@WriteTreatmentResource' {} Maybe CustomDeliveryConfiguration
a -> WriteTreatmentResource
s {$sel:customDeliveryConfiguration:WriteTreatmentResource' :: Maybe CustomDeliveryConfiguration
customDeliveryConfiguration = Maybe CustomDeliveryConfiguration
a} :: WriteTreatmentResource)

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

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

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

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

-- | A custom name for the treatment.
writeTreatmentResource_treatmentName :: Lens.Lens' WriteTreatmentResource (Prelude.Maybe Prelude.Text)
writeTreatmentResource_treatmentName :: Lens' WriteTreatmentResource (Maybe Text)
writeTreatmentResource_treatmentName = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\WriteTreatmentResource' {Maybe Text
treatmentName :: Maybe Text
$sel:treatmentName:WriteTreatmentResource' :: WriteTreatmentResource -> Maybe Text
treatmentName} -> Maybe Text
treatmentName) (\s :: WriteTreatmentResource
s@WriteTreatmentResource' {} Maybe Text
a -> WriteTreatmentResource
s {$sel:treatmentName:WriteTreatmentResource' :: Maybe Text
treatmentName = Maybe Text
a} :: WriteTreatmentResource)

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

instance Prelude.Hashable WriteTreatmentResource where
  hashWithSalt :: Int -> WriteTreatmentResource -> Int
hashWithSalt Int
_salt WriteTreatmentResource' {Int
Maybe Text
Maybe CustomDeliveryConfiguration
Maybe MessageConfiguration
Maybe Schedule
Maybe TemplateConfiguration
sizePercent :: Int
treatmentName :: Maybe Text
treatmentDescription :: Maybe Text
templateConfiguration :: Maybe TemplateConfiguration
schedule :: Maybe Schedule
messageConfiguration :: Maybe MessageConfiguration
customDeliveryConfiguration :: Maybe CustomDeliveryConfiguration
$sel:sizePercent:WriteTreatmentResource' :: WriteTreatmentResource -> Int
$sel:treatmentName:WriteTreatmentResource' :: WriteTreatmentResource -> Maybe Text
$sel:treatmentDescription:WriteTreatmentResource' :: WriteTreatmentResource -> Maybe Text
$sel:templateConfiguration:WriteTreatmentResource' :: WriteTreatmentResource -> Maybe TemplateConfiguration
$sel:schedule:WriteTreatmentResource' :: WriteTreatmentResource -> Maybe Schedule
$sel:messageConfiguration:WriteTreatmentResource' :: WriteTreatmentResource -> Maybe MessageConfiguration
$sel:customDeliveryConfiguration:WriteTreatmentResource' :: WriteTreatmentResource -> 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 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` Int
sizePercent

instance Prelude.NFData WriteTreatmentResource where
  rnf :: WriteTreatmentResource -> ()
rnf WriteTreatmentResource' {Int
Maybe Text
Maybe CustomDeliveryConfiguration
Maybe MessageConfiguration
Maybe Schedule
Maybe TemplateConfiguration
sizePercent :: Int
treatmentName :: Maybe Text
treatmentDescription :: Maybe Text
templateConfiguration :: Maybe TemplateConfiguration
schedule :: Maybe Schedule
messageConfiguration :: Maybe MessageConfiguration
customDeliveryConfiguration :: Maybe CustomDeliveryConfiguration
$sel:sizePercent:WriteTreatmentResource' :: WriteTreatmentResource -> Int
$sel:treatmentName:WriteTreatmentResource' :: WriteTreatmentResource -> Maybe Text
$sel:treatmentDescription:WriteTreatmentResource' :: WriteTreatmentResource -> Maybe Text
$sel:templateConfiguration:WriteTreatmentResource' :: WriteTreatmentResource -> Maybe TemplateConfiguration
$sel:schedule:WriteTreatmentResource' :: WriteTreatmentResource -> Maybe Schedule
$sel:messageConfiguration:WriteTreatmentResource' :: WriteTreatmentResource -> Maybe MessageConfiguration
$sel:customDeliveryConfiguration:WriteTreatmentResource' :: WriteTreatmentResource -> 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 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 Int
sizePercent

instance Data.ToJSON WriteTreatmentResource where
  toJSON :: WriteTreatmentResource -> Value
toJSON WriteTreatmentResource' {Int
Maybe Text
Maybe CustomDeliveryConfiguration
Maybe MessageConfiguration
Maybe Schedule
Maybe TemplateConfiguration
sizePercent :: Int
treatmentName :: Maybe Text
treatmentDescription :: Maybe Text
templateConfiguration :: Maybe TemplateConfiguration
schedule :: Maybe Schedule
messageConfiguration :: Maybe MessageConfiguration
customDeliveryConfiguration :: Maybe CustomDeliveryConfiguration
$sel:sizePercent:WriteTreatmentResource' :: WriteTreatmentResource -> Int
$sel:treatmentName:WriteTreatmentResource' :: WriteTreatmentResource -> Maybe Text
$sel:treatmentDescription:WriteTreatmentResource' :: WriteTreatmentResource -> Maybe Text
$sel:templateConfiguration:WriteTreatmentResource' :: WriteTreatmentResource -> Maybe TemplateConfiguration
$sel:schedule:WriteTreatmentResource' :: WriteTreatmentResource -> Maybe Schedule
$sel:messageConfiguration:WriteTreatmentResource' :: WriteTreatmentResource -> Maybe MessageConfiguration
$sel:customDeliveryConfiguration:WriteTreatmentResource' :: WriteTreatmentResource -> Maybe CustomDeliveryConfiguration
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"CustomDeliveryConfiguration" 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 CustomDeliveryConfiguration
customDeliveryConfiguration,
            (Key
"MessageConfiguration" 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 MessageConfiguration
messageConfiguration,
            (Key
"Schedule" 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 Schedule
schedule,
            (Key
"TemplateConfiguration" 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 TemplateConfiguration
templateConfiguration,
            (Key
"TreatmentDescription" 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
treatmentDescription,
            (Key
"TreatmentName" 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
treatmentName,
            forall a. a -> Maybe a
Prelude.Just (Key
"SizePercent" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Int
sizePercent)
          ]
      )