{-# 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.FraudDetector.Types.Event
-- 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.FraudDetector.Types.Event where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import Amazonka.FraudDetector.Types.Entity
import qualified Amazonka.Prelude as Prelude

-- | The event details.
--
-- /See:/ 'newEvent' smart constructor.
data Event = Event'
  { -- | The label associated with the event.
    Event -> Maybe Text
currentLabel :: Prelude.Maybe Prelude.Text,
    -- | The event entities.
    Event -> Maybe [Sensitive Entity]
entities :: Prelude.Maybe [Data.Sensitive Entity],
    -- | The event ID.
    Event -> Maybe Text
eventId :: Prelude.Maybe Prelude.Text,
    -- | The timestamp that defines when the event under evaluation occurred. The
    -- timestamp must be specified using ISO 8601 standard in UTC.
    Event -> Maybe Text
eventTimestamp :: Prelude.Maybe Prelude.Text,
    -- | The event type.
    Event -> Maybe Text
eventTypeName :: Prelude.Maybe Prelude.Text,
    -- | Names of the event type\'s variables you defined in Amazon Fraud
    -- Detector to represent data elements and their corresponding values for
    -- the event you are sending for evaluation.
    Event -> Maybe (HashMap Text (Sensitive Text))
eventVariables :: Prelude.Maybe (Prelude.HashMap Prelude.Text (Data.Sensitive Prelude.Text)),
    -- | The timestamp associated with the label to update. The timestamp must be
    -- specified using ISO 8601 standard in UTC.
    Event -> Maybe Text
labelTimestamp :: Prelude.Maybe Prelude.Text
  }
  deriving (Event -> Event -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: Event -> Event -> Bool
$c/= :: Event -> Event -> Bool
== :: Event -> Event -> Bool
$c== :: Event -> Event -> Bool
Prelude.Eq, Int -> Event -> ShowS
[Event] -> ShowS
Event -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [Event] -> ShowS
$cshowList :: [Event] -> ShowS
show :: Event -> String
$cshow :: Event -> String
showsPrec :: Int -> Event -> ShowS
$cshowsPrec :: Int -> Event -> ShowS
Prelude.Show, forall x. Rep Event x -> Event
forall x. Event -> Rep Event x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep Event x -> Event
$cfrom :: forall x. Event -> Rep Event x
Prelude.Generic)

-- |
-- Create a value of 'Event' 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:
--
-- 'currentLabel', 'event_currentLabel' - The label associated with the event.
--
-- 'entities', 'event_entities' - The event entities.
--
-- 'eventId', 'event_eventId' - The event ID.
--
-- 'eventTimestamp', 'event_eventTimestamp' - The timestamp that defines when the event under evaluation occurred. The
-- timestamp must be specified using ISO 8601 standard in UTC.
--
-- 'eventTypeName', 'event_eventTypeName' - The event type.
--
-- 'eventVariables', 'event_eventVariables' - Names of the event type\'s variables you defined in Amazon Fraud
-- Detector to represent data elements and their corresponding values for
-- the event you are sending for evaluation.
--
-- 'labelTimestamp', 'event_labelTimestamp' - The timestamp associated with the label to update. The timestamp must be
-- specified using ISO 8601 standard in UTC.
newEvent ::
  Event
newEvent :: Event
newEvent =
  Event'
    { $sel:currentLabel:Event' :: Maybe Text
currentLabel = forall a. Maybe a
Prelude.Nothing,
      $sel:entities:Event' :: Maybe [Sensitive Entity]
entities = forall a. Maybe a
Prelude.Nothing,
      $sel:eventId:Event' :: Maybe Text
eventId = forall a. Maybe a
Prelude.Nothing,
      $sel:eventTimestamp:Event' :: Maybe Text
eventTimestamp = forall a. Maybe a
Prelude.Nothing,
      $sel:eventTypeName:Event' :: Maybe Text
eventTypeName = forall a. Maybe a
Prelude.Nothing,
      $sel:eventVariables:Event' :: Maybe (HashMap Text (Sensitive Text))
eventVariables = forall a. Maybe a
Prelude.Nothing,
      $sel:labelTimestamp:Event' :: Maybe Text
labelTimestamp = forall a. Maybe a
Prelude.Nothing
    }

-- | The label associated with the event.
event_currentLabel :: Lens.Lens' Event (Prelude.Maybe Prelude.Text)
event_currentLabel :: Lens' Event (Maybe Text)
event_currentLabel = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Event' {Maybe Text
currentLabel :: Maybe Text
$sel:currentLabel:Event' :: Event -> Maybe Text
currentLabel} -> Maybe Text
currentLabel) (\s :: Event
s@Event' {} Maybe Text
a -> Event
s {$sel:currentLabel:Event' :: Maybe Text
currentLabel = Maybe Text
a} :: Event)

-- | The event entities.
event_entities :: Lens.Lens' Event (Prelude.Maybe [Entity])
event_entities :: Lens' Event (Maybe [Entity])
event_entities = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Event' {Maybe [Sensitive Entity]
entities :: Maybe [Sensitive Entity]
$sel:entities:Event' :: Event -> Maybe [Sensitive Entity]
entities} -> Maybe [Sensitive Entity]
entities) (\s :: Event
s@Event' {} Maybe [Sensitive Entity]
a -> Event
s {$sel:entities:Event' :: Maybe [Sensitive Entity]
entities = Maybe [Sensitive Entity]
a} :: Event) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. 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 forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | The event ID.
event_eventId :: Lens.Lens' Event (Prelude.Maybe Prelude.Text)
event_eventId :: Lens' Event (Maybe Text)
event_eventId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Event' {Maybe Text
eventId :: Maybe Text
$sel:eventId:Event' :: Event -> Maybe Text
eventId} -> Maybe Text
eventId) (\s :: Event
s@Event' {} Maybe Text
a -> Event
s {$sel:eventId:Event' :: Maybe Text
eventId = Maybe Text
a} :: Event)

-- | The timestamp that defines when the event under evaluation occurred. The
-- timestamp must be specified using ISO 8601 standard in UTC.
event_eventTimestamp :: Lens.Lens' Event (Prelude.Maybe Prelude.Text)
event_eventTimestamp :: Lens' Event (Maybe Text)
event_eventTimestamp = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Event' {Maybe Text
eventTimestamp :: Maybe Text
$sel:eventTimestamp:Event' :: Event -> Maybe Text
eventTimestamp} -> Maybe Text
eventTimestamp) (\s :: Event
s@Event' {} Maybe Text
a -> Event
s {$sel:eventTimestamp:Event' :: Maybe Text
eventTimestamp = Maybe Text
a} :: Event)

-- | The event type.
event_eventTypeName :: Lens.Lens' Event (Prelude.Maybe Prelude.Text)
event_eventTypeName :: Lens' Event (Maybe Text)
event_eventTypeName = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Event' {Maybe Text
eventTypeName :: Maybe Text
$sel:eventTypeName:Event' :: Event -> Maybe Text
eventTypeName} -> Maybe Text
eventTypeName) (\s :: Event
s@Event' {} Maybe Text
a -> Event
s {$sel:eventTypeName:Event' :: Maybe Text
eventTypeName = Maybe Text
a} :: Event)

-- | Names of the event type\'s variables you defined in Amazon Fraud
-- Detector to represent data elements and their corresponding values for
-- the event you are sending for evaluation.
event_eventVariables :: Lens.Lens' Event (Prelude.Maybe (Prelude.HashMap Prelude.Text Prelude.Text))
event_eventVariables :: Lens' Event (Maybe (HashMap Text Text))
event_eventVariables = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Event' {Maybe (HashMap Text (Sensitive Text))
eventVariables :: Maybe (HashMap Text (Sensitive Text))
$sel:eventVariables:Event' :: Event -> Maybe (HashMap Text (Sensitive Text))
eventVariables} -> Maybe (HashMap Text (Sensitive Text))
eventVariables) (\s :: Event
s@Event' {} Maybe (HashMap Text (Sensitive Text))
a -> Event
s {$sel:eventVariables:Event' :: Maybe (HashMap Text (Sensitive Text))
eventVariables = Maybe (HashMap Text (Sensitive Text))
a} :: Event) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. 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 forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | The timestamp associated with the label to update. The timestamp must be
-- specified using ISO 8601 standard in UTC.
event_labelTimestamp :: Lens.Lens' Event (Prelude.Maybe Prelude.Text)
event_labelTimestamp :: Lens' Event (Maybe Text)
event_labelTimestamp = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Event' {Maybe Text
labelTimestamp :: Maybe Text
$sel:labelTimestamp:Event' :: Event -> Maybe Text
labelTimestamp} -> Maybe Text
labelTimestamp) (\s :: Event
s@Event' {} Maybe Text
a -> Event
s {$sel:labelTimestamp:Event' :: Maybe Text
labelTimestamp = Maybe Text
a} :: Event)

instance Data.FromJSON Event where
  parseJSON :: Value -> Parser Event
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"Event"
      ( \Object
x ->
          Maybe Text
-> Maybe [Sensitive Entity]
-> Maybe Text
-> Maybe Text
-> Maybe Text
-> Maybe (HashMap Text (Sensitive Text))
-> Maybe Text
-> Event
Event'
            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
"currentLabel")
            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
"entities" forall a. Parser (Maybe a) -> a -> Parser a
Data..!= forall a. Monoid a => a
Prelude.mempty)
            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
"eventId")
            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
"eventTimestamp")
            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
"eventTypeName")
            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
"eventVariables" forall a. Parser (Maybe a) -> a -> Parser a
Data..!= forall a. Monoid a => a
Prelude.mempty)
            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
"labelTimestamp")
      )

instance Prelude.Hashable Event where
  hashWithSalt :: Int -> Event -> Int
hashWithSalt Int
_salt Event' {Maybe [Sensitive Entity]
Maybe Text
Maybe (HashMap Text (Sensitive Text))
labelTimestamp :: Maybe Text
eventVariables :: Maybe (HashMap Text (Sensitive Text))
eventTypeName :: Maybe Text
eventTimestamp :: Maybe Text
eventId :: Maybe Text
entities :: Maybe [Sensitive Entity]
currentLabel :: Maybe Text
$sel:labelTimestamp:Event' :: Event -> Maybe Text
$sel:eventVariables:Event' :: Event -> Maybe (HashMap Text (Sensitive Text))
$sel:eventTypeName:Event' :: Event -> Maybe Text
$sel:eventTimestamp:Event' :: Event -> Maybe Text
$sel:eventId:Event' :: Event -> Maybe Text
$sel:entities:Event' :: Event -> Maybe [Sensitive Entity]
$sel:currentLabel:Event' :: Event -> Maybe Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
currentLabel
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [Sensitive Entity]
entities
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
eventId
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
eventTimestamp
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
eventTypeName
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe (HashMap Text (Sensitive Text))
eventVariables
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
labelTimestamp

instance Prelude.NFData Event where
  rnf :: Event -> ()
rnf Event' {Maybe [Sensitive Entity]
Maybe Text
Maybe (HashMap Text (Sensitive Text))
labelTimestamp :: Maybe Text
eventVariables :: Maybe (HashMap Text (Sensitive Text))
eventTypeName :: Maybe Text
eventTimestamp :: Maybe Text
eventId :: Maybe Text
entities :: Maybe [Sensitive Entity]
currentLabel :: Maybe Text
$sel:labelTimestamp:Event' :: Event -> Maybe Text
$sel:eventVariables:Event' :: Event -> Maybe (HashMap Text (Sensitive Text))
$sel:eventTypeName:Event' :: Event -> Maybe Text
$sel:eventTimestamp:Event' :: Event -> Maybe Text
$sel:eventId:Event' :: Event -> Maybe Text
$sel:entities:Event' :: Event -> Maybe [Sensitive Entity]
$sel:currentLabel:Event' :: Event -> Maybe Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
currentLabel
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe [Sensitive Entity]
entities
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
eventId
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
eventTimestamp
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
eventTypeName
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe (HashMap Text (Sensitive Text))
eventVariables
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
labelTimestamp