{-# 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.Address
-- 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.Address 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 address associated with the specified user.
--
-- /See:/ 'newAddress' smart constructor.
data Address = Address'
  { -- | The country of the address.
    Address -> Maybe (Sensitive Text)
country :: Prelude.Maybe (Data.Sensitive Prelude.Text),
    -- | A string containing a formatted version of the address for display.
    Address -> Maybe (Sensitive Text)
formatted :: Prelude.Maybe (Data.Sensitive Prelude.Text),
    -- | A string of the address locality.
    Address -> Maybe (Sensitive Text)
locality :: Prelude.Maybe (Data.Sensitive Prelude.Text),
    -- | The postal code of the address.
    Address -> Maybe (Sensitive Text)
postalCode :: Prelude.Maybe (Data.Sensitive Prelude.Text),
    -- | A Boolean value representing whether this is the primary address for the
    -- associated resource.
    Address -> Maybe (Sensitive Bool)
primary :: Prelude.Maybe (Data.Sensitive Prelude.Bool),
    -- | The region of the address.
    Address -> Maybe (Sensitive Text)
region :: Prelude.Maybe (Data.Sensitive Prelude.Text),
    -- | The street of the address.
    Address -> Maybe (Sensitive Text)
streetAddress :: Prelude.Maybe (Data.Sensitive Prelude.Text),
    -- | A string representing the type of address. For example, \"Home.\"
    Address -> Maybe (Sensitive Text)
type' :: Prelude.Maybe (Data.Sensitive Prelude.Text)
  }
  deriving (Address -> Address -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: Address -> Address -> Bool
$c/= :: Address -> Address -> Bool
== :: Address -> Address -> Bool
$c== :: Address -> Address -> Bool
Prelude.Eq, Int -> Address -> ShowS
[Address] -> ShowS
Address -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [Address] -> ShowS
$cshowList :: [Address] -> ShowS
show :: Address -> String
$cshow :: Address -> String
showsPrec :: Int -> Address -> ShowS
$cshowsPrec :: Int -> Address -> ShowS
Prelude.Show, forall x. Rep Address x -> Address
forall x. Address -> Rep Address x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep Address x -> Address
$cfrom :: forall x. Address -> Rep Address x
Prelude.Generic)

-- |
-- Create a value of 'Address' 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:
--
-- 'country', 'address_country' - The country of the address.
--
-- 'formatted', 'address_formatted' - A string containing a formatted version of the address for display.
--
-- 'locality', 'address_locality' - A string of the address locality.
--
-- 'postalCode', 'address_postalCode' - The postal code of the address.
--
-- 'primary', 'address_primary' - A Boolean value representing whether this is the primary address for the
-- associated resource.
--
-- 'region', 'address_region' - The region of the address.
--
-- 'streetAddress', 'address_streetAddress' - The street of the address.
--
-- 'type'', 'address_type' - A string representing the type of address. For example, \"Home.\"
newAddress ::
  Address
newAddress :: Address
newAddress =
  Address'
    { $sel:country:Address' :: Maybe (Sensitive Text)
country = forall a. Maybe a
Prelude.Nothing,
      $sel:formatted:Address' :: Maybe (Sensitive Text)
formatted = forall a. Maybe a
Prelude.Nothing,
      $sel:locality:Address' :: Maybe (Sensitive Text)
locality = forall a. Maybe a
Prelude.Nothing,
      $sel:postalCode:Address' :: Maybe (Sensitive Text)
postalCode = forall a. Maybe a
Prelude.Nothing,
      $sel:primary:Address' :: Maybe (Sensitive Bool)
primary = forall a. Maybe a
Prelude.Nothing,
      $sel:region:Address' :: Maybe (Sensitive Text)
region = forall a. Maybe a
Prelude.Nothing,
      $sel:streetAddress:Address' :: Maybe (Sensitive Text)
streetAddress = forall a. Maybe a
Prelude.Nothing,
      $sel:type':Address' :: Maybe (Sensitive Text)
type' = forall a. Maybe a
Prelude.Nothing
    }

-- | The country of the address.
address_country :: Lens.Lens' Address (Prelude.Maybe Prelude.Text)
address_country :: Lens' Address (Maybe Text)
address_country = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Address' {Maybe (Sensitive Text)
country :: Maybe (Sensitive Text)
$sel:country:Address' :: Address -> Maybe (Sensitive Text)
country} -> Maybe (Sensitive Text)
country) (\s :: Address
s@Address' {} Maybe (Sensitive Text)
a -> Address
s {$sel:country:Address' :: Maybe (Sensitive Text)
country = Maybe (Sensitive Text)
a} :: Address) 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 address for display.
address_formatted :: Lens.Lens' Address (Prelude.Maybe Prelude.Text)
address_formatted :: Lens' Address (Maybe Text)
address_formatted = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Address' {Maybe (Sensitive Text)
formatted :: Maybe (Sensitive Text)
$sel:formatted:Address' :: Address -> Maybe (Sensitive Text)
formatted} -> Maybe (Sensitive Text)
formatted) (\s :: Address
s@Address' {} Maybe (Sensitive Text)
a -> Address
s {$sel:formatted:Address' :: Maybe (Sensitive Text)
formatted = Maybe (Sensitive Text)
a} :: Address) 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 of the address locality.
address_locality :: Lens.Lens' Address (Prelude.Maybe Prelude.Text)
address_locality :: Lens' Address (Maybe Text)
address_locality = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Address' {Maybe (Sensitive Text)
locality :: Maybe (Sensitive Text)
$sel:locality:Address' :: Address -> Maybe (Sensitive Text)
locality} -> Maybe (Sensitive Text)
locality) (\s :: Address
s@Address' {} Maybe (Sensitive Text)
a -> Address
s {$sel:locality:Address' :: Maybe (Sensitive Text)
locality = Maybe (Sensitive Text)
a} :: Address) 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 postal code of the address.
address_postalCode :: Lens.Lens' Address (Prelude.Maybe Prelude.Text)
address_postalCode :: Lens' Address (Maybe Text)
address_postalCode = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Address' {Maybe (Sensitive Text)
postalCode :: Maybe (Sensitive Text)
$sel:postalCode:Address' :: Address -> Maybe (Sensitive Text)
postalCode} -> Maybe (Sensitive Text)
postalCode) (\s :: Address
s@Address' {} Maybe (Sensitive Text)
a -> Address
s {$sel:postalCode:Address' :: Maybe (Sensitive Text)
postalCode = Maybe (Sensitive Text)
a} :: Address) 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 Boolean value representing whether this is the primary address for the
-- associated resource.
address_primary :: Lens.Lens' Address (Prelude.Maybe Prelude.Bool)
address_primary :: Lens' Address (Maybe Bool)
address_primary = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Address' {Maybe (Sensitive Bool)
primary :: Maybe (Sensitive Bool)
$sel:primary:Address' :: Address -> Maybe (Sensitive Bool)
primary} -> Maybe (Sensitive Bool)
primary) (\s :: Address
s@Address' {} Maybe (Sensitive Bool)
a -> Address
s {$sel:primary:Address' :: Maybe (Sensitive Bool)
primary = Maybe (Sensitive Bool)
a} :: Address) 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 region of the address.
address_region :: Lens.Lens' Address (Prelude.Maybe Prelude.Text)
address_region :: Lens' Address (Maybe Text)
address_region = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Address' {Maybe (Sensitive Text)
region :: Maybe (Sensitive Text)
$sel:region:Address' :: Address -> Maybe (Sensitive Text)
region} -> Maybe (Sensitive Text)
region) (\s :: Address
s@Address' {} Maybe (Sensitive Text)
a -> Address
s {$sel:region:Address' :: Maybe (Sensitive Text)
region = Maybe (Sensitive Text)
a} :: Address) 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 street of the address.
address_streetAddress :: Lens.Lens' Address (Prelude.Maybe Prelude.Text)
address_streetAddress :: Lens' Address (Maybe Text)
address_streetAddress = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Address' {Maybe (Sensitive Text)
streetAddress :: Maybe (Sensitive Text)
$sel:streetAddress:Address' :: Address -> Maybe (Sensitive Text)
streetAddress} -> Maybe (Sensitive Text)
streetAddress) (\s :: Address
s@Address' {} Maybe (Sensitive Text)
a -> Address
s {$sel:streetAddress:Address' :: Maybe (Sensitive Text)
streetAddress = Maybe (Sensitive Text)
a} :: Address) 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 representing the type of address. For example, \"Home.\"
address_type :: Lens.Lens' Address (Prelude.Maybe Prelude.Text)
address_type :: Lens' Address (Maybe Text)
address_type = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Address' {Maybe (Sensitive Text)
type' :: Maybe (Sensitive Text)
$sel:type':Address' :: Address -> Maybe (Sensitive Text)
type'} -> Maybe (Sensitive Text)
type') (\s :: Address
s@Address' {} Maybe (Sensitive Text)
a -> Address
s {$sel:type':Address' :: Maybe (Sensitive Text)
type' = Maybe (Sensitive Text)
a} :: Address) 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 Address where
  parseJSON :: Value -> Parser Address
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"Address"
      ( \Object
x ->
          Maybe (Sensitive Text)
-> Maybe (Sensitive Text)
-> Maybe (Sensitive Text)
-> Maybe (Sensitive Text)
-> Maybe (Sensitive Bool)
-> Maybe (Sensitive Text)
-> Maybe (Sensitive Text)
-> Maybe (Sensitive Text)
-> Address
Address'
            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
"Country")
            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
"Locality")
            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
"PostalCode")
            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
"Primary")
            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
"Region")
            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
"StreetAddress")
            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
"Type")
      )

instance Prelude.Hashable Address where
  hashWithSalt :: Int -> Address -> Int
hashWithSalt Int
_salt Address' {Maybe (Sensitive Bool)
Maybe (Sensitive Text)
type' :: Maybe (Sensitive Text)
streetAddress :: Maybe (Sensitive Text)
region :: Maybe (Sensitive Text)
primary :: Maybe (Sensitive Bool)
postalCode :: Maybe (Sensitive Text)
locality :: Maybe (Sensitive Text)
formatted :: Maybe (Sensitive Text)
country :: Maybe (Sensitive Text)
$sel:type':Address' :: Address -> Maybe (Sensitive Text)
$sel:streetAddress:Address' :: Address -> Maybe (Sensitive Text)
$sel:region:Address' :: Address -> Maybe (Sensitive Text)
$sel:primary:Address' :: Address -> Maybe (Sensitive Bool)
$sel:postalCode:Address' :: Address -> Maybe (Sensitive Text)
$sel:locality:Address' :: Address -> Maybe (Sensitive Text)
$sel:formatted:Address' :: Address -> Maybe (Sensitive Text)
$sel:country:Address' :: Address -> Maybe (Sensitive Text)
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe (Sensitive Text)
country
      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)
locality
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe (Sensitive Text)
postalCode
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe (Sensitive Bool)
primary
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe (Sensitive Text)
region
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe (Sensitive Text)
streetAddress
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe (Sensitive Text)
type'

instance Prelude.NFData Address where
  rnf :: Address -> ()
rnf Address' {Maybe (Sensitive Bool)
Maybe (Sensitive Text)
type' :: Maybe (Sensitive Text)
streetAddress :: Maybe (Sensitive Text)
region :: Maybe (Sensitive Text)
primary :: Maybe (Sensitive Bool)
postalCode :: Maybe (Sensitive Text)
locality :: Maybe (Sensitive Text)
formatted :: Maybe (Sensitive Text)
country :: Maybe (Sensitive Text)
$sel:type':Address' :: Address -> Maybe (Sensitive Text)
$sel:streetAddress:Address' :: Address -> Maybe (Sensitive Text)
$sel:region:Address' :: Address -> Maybe (Sensitive Text)
$sel:primary:Address' :: Address -> Maybe (Sensitive Bool)
$sel:postalCode:Address' :: Address -> Maybe (Sensitive Text)
$sel:locality:Address' :: Address -> Maybe (Sensitive Text)
$sel:formatted:Address' :: Address -> Maybe (Sensitive Text)
$sel:country:Address' :: Address -> Maybe (Sensitive Text)
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe (Sensitive Text)
country
      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)
locality
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe (Sensitive Text)
postalCode
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe (Sensitive Bool)
primary
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe (Sensitive Text)
region
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe (Sensitive Text)
streetAddress
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe (Sensitive Text)
type'

instance Data.ToJSON Address where
  toJSON :: Address -> Value
toJSON Address' {Maybe (Sensitive Bool)
Maybe (Sensitive Text)
type' :: Maybe (Sensitive Text)
streetAddress :: Maybe (Sensitive Text)
region :: Maybe (Sensitive Text)
primary :: Maybe (Sensitive Bool)
postalCode :: Maybe (Sensitive Text)
locality :: Maybe (Sensitive Text)
formatted :: Maybe (Sensitive Text)
country :: Maybe (Sensitive Text)
$sel:type':Address' :: Address -> Maybe (Sensitive Text)
$sel:streetAddress:Address' :: Address -> Maybe (Sensitive Text)
$sel:region:Address' :: Address -> Maybe (Sensitive Text)
$sel:primary:Address' :: Address -> Maybe (Sensitive Bool)
$sel:postalCode:Address' :: Address -> Maybe (Sensitive Text)
$sel:locality:Address' :: Address -> Maybe (Sensitive Text)
$sel:formatted:Address' :: Address -> Maybe (Sensitive Text)
$sel:country:Address' :: Address -> Maybe (Sensitive Text)
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"Country" 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)
country,
            (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
"Locality" 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)
locality,
            (Key
"PostalCode" 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)
postalCode,
            (Key
"Primary" 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 Bool)
primary,
            (Key
"Region" 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)
region,
            (Key
"StreetAddress" 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)
streetAddress,
            (Key
"Type" 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)
type'
          ]
      )