{-# 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.IdentityStore.Types.Name
-- 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.IdentityStore.Types.Name where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import qualified Amazonka.Prelude as Prelude

-- | The full name of the user.
--
-- /See:/ 'newName' smart constructor.
data Name = Name'
  { -- | The family name of the user.
    Name -> Maybe (Sensitive Text)
familyName :: Prelude.Maybe (Data.Sensitive Prelude.Text),
    -- | A string containing a formatted version of the name for display.
    Name -> Maybe (Sensitive Text)
formatted :: Prelude.Maybe (Data.Sensitive Prelude.Text),
    -- | The given name of the user.
    Name -> Maybe (Sensitive Text)
givenName :: Prelude.Maybe (Data.Sensitive Prelude.Text),
    -- | The honorific prefix of the user. For example, \"Dr.\"
    Name -> Maybe (Sensitive Text)
honorificPrefix :: Prelude.Maybe (Data.Sensitive Prelude.Text),
    -- | The honorific suffix of the user. For example, \"M.D.\"
    Name -> Maybe (Sensitive Text)
honorificSuffix :: Prelude.Maybe (Data.Sensitive Prelude.Text),
    -- | The middle name of the user.
    Name -> Maybe (Sensitive Text)
middleName :: Prelude.Maybe (Data.Sensitive Prelude.Text)
  }
  deriving (Name -> Name -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: Name -> Name -> Bool
$c/= :: Name -> Name -> Bool
== :: Name -> Name -> Bool
$c== :: Name -> Name -> Bool
Prelude.Eq, Int -> Name -> ShowS
[Name] -> ShowS
Name -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [Name] -> ShowS
$cshowList :: [Name] -> ShowS
show :: Name -> String
$cshow :: Name -> String
showsPrec :: Int -> Name -> ShowS
$cshowsPrec :: Int -> Name -> ShowS
Prelude.Show, forall x. Rep Name x -> Name
forall x. Name -> Rep Name x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep Name x -> Name
$cfrom :: forall x. Name -> Rep Name x
Prelude.Generic)

-- |
-- Create a value of 'Name' 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:
--
-- 'familyName', 'name_familyName' - The family name of the user.
--
-- 'formatted', 'name_formatted' - A string containing a formatted version of the name for display.
--
-- 'givenName', 'name_givenName' - The given name of the user.
--
-- 'honorificPrefix', 'name_honorificPrefix' - The honorific prefix of the user. For example, \"Dr.\"
--
-- 'honorificSuffix', 'name_honorificSuffix' - The honorific suffix of the user. For example, \"M.D.\"
--
-- 'middleName', 'name_middleName' - The middle name of the user.
newName ::
  Name
newName :: Name
newName =
  Name'
    { $sel:familyName:Name' :: Maybe (Sensitive Text)
familyName = forall a. Maybe a
Prelude.Nothing,
      $sel:formatted:Name' :: Maybe (Sensitive Text)
formatted = forall a. Maybe a
Prelude.Nothing,
      $sel:givenName:Name' :: Maybe (Sensitive Text)
givenName = forall a. Maybe a
Prelude.Nothing,
      $sel:honorificPrefix:Name' :: Maybe (Sensitive Text)
honorificPrefix = forall a. Maybe a
Prelude.Nothing,
      $sel:honorificSuffix:Name' :: Maybe (Sensitive Text)
honorificSuffix = forall a. Maybe a
Prelude.Nothing,
      $sel:middleName:Name' :: Maybe (Sensitive Text)
middleName = forall a. Maybe a
Prelude.Nothing
    }

-- | The family name of the user.
name_familyName :: Lens.Lens' Name (Prelude.Maybe Prelude.Text)
name_familyName :: Lens' Name (Maybe Text)
name_familyName = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Name' {Maybe (Sensitive Text)
familyName :: Maybe (Sensitive Text)
$sel:familyName:Name' :: Name -> Maybe (Sensitive Text)
familyName} -> Maybe (Sensitive Text)
familyName) (\s :: Name
s@Name' {} Maybe (Sensitive Text)
a -> Name
s {$sel:familyName:Name' :: Maybe (Sensitive Text)
familyName = Maybe (Sensitive Text)
a} :: Name) 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 a. Iso' (Sensitive a) a
Data._Sensitive

-- | A string containing a formatted version of the name for display.
name_formatted :: Lens.Lens' Name (Prelude.Maybe Prelude.Text)
name_formatted :: Lens' Name (Maybe Text)
name_formatted = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Name' {Maybe (Sensitive Text)
formatted :: Maybe (Sensitive Text)
$sel:formatted:Name' :: Name -> Maybe (Sensitive Text)
formatted} -> Maybe (Sensitive Text)
formatted) (\s :: Name
s@Name' {} Maybe (Sensitive Text)
a -> Name
s {$sel:formatted:Name' :: Maybe (Sensitive Text)
formatted = Maybe (Sensitive Text)
a} :: Name) 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 a. Iso' (Sensitive a) a
Data._Sensitive

-- | The given name of the user.
name_givenName :: Lens.Lens' Name (Prelude.Maybe Prelude.Text)
name_givenName :: Lens' Name (Maybe Text)
name_givenName = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Name' {Maybe (Sensitive Text)
givenName :: Maybe (Sensitive Text)
$sel:givenName:Name' :: Name -> Maybe (Sensitive Text)
givenName} -> Maybe (Sensitive Text)
givenName) (\s :: Name
s@Name' {} Maybe (Sensitive Text)
a -> Name
s {$sel:givenName:Name' :: Maybe (Sensitive Text)
givenName = Maybe (Sensitive Text)
a} :: Name) 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 a. Iso' (Sensitive a) a
Data._Sensitive

-- | The honorific prefix of the user. For example, \"Dr.\"
name_honorificPrefix :: Lens.Lens' Name (Prelude.Maybe Prelude.Text)
name_honorificPrefix :: Lens' Name (Maybe Text)
name_honorificPrefix = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Name' {Maybe (Sensitive Text)
honorificPrefix :: Maybe (Sensitive Text)
$sel:honorificPrefix:Name' :: Name -> Maybe (Sensitive Text)
honorificPrefix} -> Maybe (Sensitive Text)
honorificPrefix) (\s :: Name
s@Name' {} Maybe (Sensitive Text)
a -> Name
s {$sel:honorificPrefix:Name' :: Maybe (Sensitive Text)
honorificPrefix = Maybe (Sensitive Text)
a} :: Name) 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 a. Iso' (Sensitive a) a
Data._Sensitive

-- | The honorific suffix of the user. For example, \"M.D.\"
name_honorificSuffix :: Lens.Lens' Name (Prelude.Maybe Prelude.Text)
name_honorificSuffix :: Lens' Name (Maybe Text)
name_honorificSuffix = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Name' {Maybe (Sensitive Text)
honorificSuffix :: Maybe (Sensitive Text)
$sel:honorificSuffix:Name' :: Name -> Maybe (Sensitive Text)
honorificSuffix} -> Maybe (Sensitive Text)
honorificSuffix) (\s :: Name
s@Name' {} Maybe (Sensitive Text)
a -> Name
s {$sel:honorificSuffix:Name' :: Maybe (Sensitive Text)
honorificSuffix = Maybe (Sensitive Text)
a} :: Name) 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 a. Iso' (Sensitive a) a
Data._Sensitive

-- | The middle name of the user.
name_middleName :: Lens.Lens' Name (Prelude.Maybe Prelude.Text)
name_middleName :: Lens' Name (Maybe Text)
name_middleName = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Name' {Maybe (Sensitive Text)
middleName :: Maybe (Sensitive Text)
$sel:middleName:Name' :: Name -> Maybe (Sensitive Text)
middleName} -> Maybe (Sensitive Text)
middleName) (\s :: Name
s@Name' {} Maybe (Sensitive Text)
a -> Name
s {$sel:middleName:Name' :: Maybe (Sensitive Text)
middleName = Maybe (Sensitive Text)
a} :: Name) 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 a. Iso' (Sensitive a) a
Data._Sensitive

instance Data.FromJSON Name where
  parseJSON :: Value -> Parser Name
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"Name"
      ( \Object
x ->
          Maybe (Sensitive Text)
-> Maybe (Sensitive Text)
-> Maybe (Sensitive Text)
-> Maybe (Sensitive Text)
-> Maybe (Sensitive Text)
-> Maybe (Sensitive Text)
-> Name
Name'
            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
"FamilyName")
            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
"Formatted")
            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
"GivenName")
            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
"HonorificPrefix")
            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
"HonorificSuffix")
            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
"MiddleName")
      )

instance Prelude.Hashable Name where
  hashWithSalt :: Int -> Name -> Int
hashWithSalt Int
_salt Name' {Maybe (Sensitive Text)
middleName :: Maybe (Sensitive Text)
honorificSuffix :: Maybe (Sensitive Text)
honorificPrefix :: Maybe (Sensitive Text)
givenName :: Maybe (Sensitive Text)
formatted :: Maybe (Sensitive Text)
familyName :: Maybe (Sensitive Text)
$sel:middleName:Name' :: Name -> Maybe (Sensitive Text)
$sel:honorificSuffix:Name' :: Name -> Maybe (Sensitive Text)
$sel:honorificPrefix:Name' :: Name -> Maybe (Sensitive Text)
$sel:givenName:Name' :: Name -> Maybe (Sensitive Text)
$sel:formatted:Name' :: Name -> Maybe (Sensitive Text)
$sel:familyName:Name' :: Name -> Maybe (Sensitive Text)
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe (Sensitive Text)
familyName
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe (Sensitive Text)
formatted
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe (Sensitive Text)
givenName
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe (Sensitive Text)
honorificPrefix
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe (Sensitive Text)
honorificSuffix
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe (Sensitive Text)
middleName

instance Prelude.NFData Name where
  rnf :: Name -> ()
rnf Name' {Maybe (Sensitive Text)
middleName :: Maybe (Sensitive Text)
honorificSuffix :: Maybe (Sensitive Text)
honorificPrefix :: Maybe (Sensitive Text)
givenName :: Maybe (Sensitive Text)
formatted :: Maybe (Sensitive Text)
familyName :: Maybe (Sensitive Text)
$sel:middleName:Name' :: Name -> Maybe (Sensitive Text)
$sel:honorificSuffix:Name' :: Name -> Maybe (Sensitive Text)
$sel:honorificPrefix:Name' :: Name -> Maybe (Sensitive Text)
$sel:givenName:Name' :: Name -> Maybe (Sensitive Text)
$sel:formatted:Name' :: Name -> Maybe (Sensitive Text)
$sel:familyName:Name' :: Name -> Maybe (Sensitive Text)
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe (Sensitive Text)
familyName
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe (Sensitive Text)
formatted
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe (Sensitive Text)
givenName
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe (Sensitive Text)
honorificPrefix
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe (Sensitive Text)
honorificSuffix
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe (Sensitive Text)
middleName

instance Data.ToJSON Name where
  toJSON :: Name -> Value
toJSON Name' {Maybe (Sensitive Text)
middleName :: Maybe (Sensitive Text)
honorificSuffix :: Maybe (Sensitive Text)
honorificPrefix :: Maybe (Sensitive Text)
givenName :: Maybe (Sensitive Text)
formatted :: Maybe (Sensitive Text)
familyName :: Maybe (Sensitive Text)
$sel:middleName:Name' :: Name -> Maybe (Sensitive Text)
$sel:honorificSuffix:Name' :: Name -> Maybe (Sensitive Text)
$sel:honorificPrefix:Name' :: Name -> Maybe (Sensitive Text)
$sel:givenName:Name' :: Name -> Maybe (Sensitive Text)
$sel:formatted:Name' :: Name -> Maybe (Sensitive Text)
$sel:familyName:Name' :: Name -> Maybe (Sensitive Text)
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"FamilyName" 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 (Sensitive Text)
familyName,
            (Key
"Formatted" 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 (Sensitive Text)
formatted,
            (Key
"GivenName" 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 (Sensitive Text)
givenName,
            (Key
"HonorificPrefix" 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 (Sensitive Text)
honorificPrefix,
            (Key
"HonorificSuffix" 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 (Sensitive Text)
honorificSuffix,
            (Key
"MiddleName" 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 (Sensitive Text)
middleName
          ]
      )