{-# 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.CampaignEventFilter
-- 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.CampaignEventFilter where

import qualified Amazonka.Core as Core
import qualified Amazonka.Lens as Lens
import Amazonka.Pinpoint.Types.EventDimensions
import Amazonka.Pinpoint.Types.FilterType
import qualified Amazonka.Prelude as Prelude

-- | Specifies the settings for events that cause a campaign to be sent.
--
-- /See:/ 'newCampaignEventFilter' smart constructor.
data CampaignEventFilter = CampaignEventFilter'
  { -- | The type of event that causes the campaign to be sent. Valid values are:
    -- SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT,
    -- sends the campaign when an endpoint event (Events resource) occurs.
    CampaignEventFilter -> FilterType
filterType :: FilterType,
    -- | The dimension settings of the event filter for the campaign.
    CampaignEventFilter -> EventDimensions
dimensions :: EventDimensions
  }
  deriving (CampaignEventFilter -> CampaignEventFilter -> Bool
(CampaignEventFilter -> CampaignEventFilter -> Bool)
-> (CampaignEventFilter -> CampaignEventFilter -> Bool)
-> Eq CampaignEventFilter
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: CampaignEventFilter -> CampaignEventFilter -> Bool
$c/= :: CampaignEventFilter -> CampaignEventFilter -> Bool
== :: CampaignEventFilter -> CampaignEventFilter -> Bool
$c== :: CampaignEventFilter -> CampaignEventFilter -> Bool
Prelude.Eq, ReadPrec [CampaignEventFilter]
ReadPrec CampaignEventFilter
Int -> ReadS CampaignEventFilter
ReadS [CampaignEventFilter]
(Int -> ReadS CampaignEventFilter)
-> ReadS [CampaignEventFilter]
-> ReadPrec CampaignEventFilter
-> ReadPrec [CampaignEventFilter]
-> Read CampaignEventFilter
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [CampaignEventFilter]
$creadListPrec :: ReadPrec [CampaignEventFilter]
readPrec :: ReadPrec CampaignEventFilter
$creadPrec :: ReadPrec CampaignEventFilter
readList :: ReadS [CampaignEventFilter]
$creadList :: ReadS [CampaignEventFilter]
readsPrec :: Int -> ReadS CampaignEventFilter
$creadsPrec :: Int -> ReadS CampaignEventFilter
Prelude.Read, Int -> CampaignEventFilter -> ShowS
[CampaignEventFilter] -> ShowS
CampaignEventFilter -> String
(Int -> CampaignEventFilter -> ShowS)
-> (CampaignEventFilter -> String)
-> ([CampaignEventFilter] -> ShowS)
-> Show CampaignEventFilter
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [CampaignEventFilter] -> ShowS
$cshowList :: [CampaignEventFilter] -> ShowS
show :: CampaignEventFilter -> String
$cshow :: CampaignEventFilter -> String
showsPrec :: Int -> CampaignEventFilter -> ShowS
$cshowsPrec :: Int -> CampaignEventFilter -> ShowS
Prelude.Show, (forall x. CampaignEventFilter -> Rep CampaignEventFilter x)
-> (forall x. Rep CampaignEventFilter x -> CampaignEventFilter)
-> Generic CampaignEventFilter
forall x. Rep CampaignEventFilter x -> CampaignEventFilter
forall x. CampaignEventFilter -> Rep CampaignEventFilter x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep CampaignEventFilter x -> CampaignEventFilter
$cfrom :: forall x. CampaignEventFilter -> Rep CampaignEventFilter x
Prelude.Generic)

-- |
-- Create a value of 'CampaignEventFilter' 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:
--
-- 'filterType', 'campaignEventFilter_filterType' - The type of event that causes the campaign to be sent. Valid values are:
-- SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT,
-- sends the campaign when an endpoint event (Events resource) occurs.
--
-- 'dimensions', 'campaignEventFilter_dimensions' - The dimension settings of the event filter for the campaign.
newCampaignEventFilter ::
  -- | 'filterType'
  FilterType ->
  -- | 'dimensions'
  EventDimensions ->
  CampaignEventFilter
newCampaignEventFilter :: FilterType -> EventDimensions -> CampaignEventFilter
newCampaignEventFilter FilterType
pFilterType_ EventDimensions
pDimensions_ =
  CampaignEventFilter' :: FilterType -> EventDimensions -> CampaignEventFilter
CampaignEventFilter'
    { $sel:filterType:CampaignEventFilter' :: FilterType
filterType = FilterType
pFilterType_,
      $sel:dimensions:CampaignEventFilter' :: EventDimensions
dimensions = EventDimensions
pDimensions_
    }

-- | The type of event that causes the campaign to be sent. Valid values are:
-- SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT,
-- sends the campaign when an endpoint event (Events resource) occurs.
campaignEventFilter_filterType :: Lens.Lens' CampaignEventFilter FilterType
campaignEventFilter_filterType :: (FilterType -> f FilterType)
-> CampaignEventFilter -> f CampaignEventFilter
campaignEventFilter_filterType = (CampaignEventFilter -> FilterType)
-> (CampaignEventFilter -> FilterType -> CampaignEventFilter)
-> Lens
     CampaignEventFilter CampaignEventFilter FilterType FilterType
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CampaignEventFilter' {FilterType
filterType :: FilterType
$sel:filterType:CampaignEventFilter' :: CampaignEventFilter -> FilterType
filterType} -> FilterType
filterType) (\s :: CampaignEventFilter
s@CampaignEventFilter' {} FilterType
a -> CampaignEventFilter
s {$sel:filterType:CampaignEventFilter' :: FilterType
filterType = FilterType
a} :: CampaignEventFilter)

-- | The dimension settings of the event filter for the campaign.
campaignEventFilter_dimensions :: Lens.Lens' CampaignEventFilter EventDimensions
campaignEventFilter_dimensions :: (EventDimensions -> f EventDimensions)
-> CampaignEventFilter -> f CampaignEventFilter
campaignEventFilter_dimensions = (CampaignEventFilter -> EventDimensions)
-> (CampaignEventFilter -> EventDimensions -> CampaignEventFilter)
-> Lens
     CampaignEventFilter
     CampaignEventFilter
     EventDimensions
     EventDimensions
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CampaignEventFilter' {EventDimensions
dimensions :: EventDimensions
$sel:dimensions:CampaignEventFilter' :: CampaignEventFilter -> EventDimensions
dimensions} -> EventDimensions
dimensions) (\s :: CampaignEventFilter
s@CampaignEventFilter' {} EventDimensions
a -> CampaignEventFilter
s {$sel:dimensions:CampaignEventFilter' :: EventDimensions
dimensions = EventDimensions
a} :: CampaignEventFilter)

instance Core.FromJSON CampaignEventFilter where
  parseJSON :: Value -> Parser CampaignEventFilter
parseJSON =
    String
-> (Object -> Parser CampaignEventFilter)
-> Value
-> Parser CampaignEventFilter
forall a. String -> (Object -> Parser a) -> Value -> Parser a
Core.withObject
      String
"CampaignEventFilter"
      ( \Object
x ->
          FilterType -> EventDimensions -> CampaignEventFilter
CampaignEventFilter'
            (FilterType -> EventDimensions -> CampaignEventFilter)
-> Parser FilterType
-> Parser (EventDimensions -> CampaignEventFilter)
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x Object -> Text -> Parser FilterType
forall a. FromJSON a => Object -> Text -> Parser a
Core..: Text
"FilterType")
            Parser (EventDimensions -> CampaignEventFilter)
-> Parser EventDimensions -> Parser CampaignEventFilter
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x Object -> Text -> Parser EventDimensions
forall a. FromJSON a => Object -> Text -> Parser a
Core..: Text
"Dimensions")
      )

instance Prelude.Hashable CampaignEventFilter

instance Prelude.NFData CampaignEventFilter

instance Core.ToJSON CampaignEventFilter where
  toJSON :: CampaignEventFilter -> Value
toJSON CampaignEventFilter' {FilterType
EventDimensions
dimensions :: EventDimensions
filterType :: FilterType
$sel:dimensions:CampaignEventFilter' :: CampaignEventFilter -> EventDimensions
$sel:filterType:CampaignEventFilter' :: CampaignEventFilter -> FilterType
..} =
    [Pair] -> Value
Core.object
      ( [Maybe Pair] -> [Pair]
forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ Pair -> Maybe Pair
forall a. a -> Maybe a
Prelude.Just (Text
"FilterType" Text -> FilterType -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..= FilterType
filterType),
            Pair -> Maybe Pair
forall a. a -> Maybe a
Prelude.Just (Text
"Dimensions" Text -> EventDimensions -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..= EventDimensions
dimensions)
          ]
      )