module OryKratos.Types.Verification
  ( VerificationFlow (..),
  )
where

import OryKratos.Types.Ui (UiContainer)
import Pre

-- | Used to verify an out-of-band communication channel such as an email address or a phone number.  For more information head over to: https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation
data VerificationFlow = VerificationFlow
  { -- | Active, if set, contains the registration method that is being used. It is initially not set.
    VerificationFlow -> Maybe Text
active :: Maybe Text,
    -- | ExpiresAt is the time (UTC) when the request expires. If the user still wishes to verify the address, a new request has to be initiated.
    VerificationFlow -> Maybe UTCTime
expires_at :: Maybe UTCTime,
    -- |
    VerificationFlow -> Text
id :: Text,
    -- | IssuedAt is the time (UTC) when the request occurred.
    VerificationFlow -> Maybe UTCTime
issued_at :: Maybe UTCTime,
    -- | RequestURL is the initial URL that was requested from Ory Kratos. It can be used to forward information contained in the URL's path or query for example.
    VerificationFlow -> Maybe Text
request_url :: Maybe Text,
    -- |
    VerificationFlow -> Text
state :: Text,
    -- | The flow type can either be `api` or `browser`.
    VerificationFlow -> Text
_type :: Text,
    -- |
    VerificationFlow -> UiContainer
ui :: UiContainer
  }
  deriving stock (Int -> VerificationFlow -> ShowS
[VerificationFlow] -> ShowS
VerificationFlow -> String
(Int -> VerificationFlow -> ShowS)
-> (VerificationFlow -> String)
-> ([VerificationFlow] -> ShowS)
-> Show VerificationFlow
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [VerificationFlow] -> ShowS
$cshowList :: [VerificationFlow] -> ShowS
show :: VerificationFlow -> String
$cshow :: VerificationFlow -> String
showsPrec :: Int -> VerificationFlow -> ShowS
$cshowsPrec :: Int -> VerificationFlow -> ShowS
Show, VerificationFlow -> VerificationFlow -> Bool
(VerificationFlow -> VerificationFlow -> Bool)
-> (VerificationFlow -> VerificationFlow -> Bool)
-> Eq VerificationFlow
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: VerificationFlow -> VerificationFlow -> Bool
$c/= :: VerificationFlow -> VerificationFlow -> Bool
== :: VerificationFlow -> VerificationFlow -> Bool
$c== :: VerificationFlow -> VerificationFlow -> Bool
Eq, (forall x. VerificationFlow -> Rep VerificationFlow x)
-> (forall x. Rep VerificationFlow x -> VerificationFlow)
-> Generic VerificationFlow
forall x. Rep VerificationFlow x -> VerificationFlow
forall x. VerificationFlow -> Rep VerificationFlow x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep VerificationFlow x -> VerificationFlow
$cfrom :: forall x. VerificationFlow -> Rep VerificationFlow x
Generic, Typeable VerificationFlow
DataType
Constr
Typeable VerificationFlow
-> (forall (c :: * -> *).
    (forall d b. Data d => c (d -> b) -> d -> c b)
    -> (forall g. g -> c g) -> VerificationFlow -> c VerificationFlow)
-> (forall (c :: * -> *).
    (forall b r. Data b => c (b -> r) -> c r)
    -> (forall r. r -> c r) -> Constr -> c VerificationFlow)
-> (VerificationFlow -> Constr)
-> (VerificationFlow -> DataType)
-> (forall (t :: * -> *) (c :: * -> *).
    Typeable t =>
    (forall d. Data d => c (t d)) -> Maybe (c VerificationFlow))
-> (forall (t :: * -> * -> *) (c :: * -> *).
    Typeable t =>
    (forall d e. (Data d, Data e) => c (t d e))
    -> Maybe (c VerificationFlow))
-> ((forall b. Data b => b -> b)
    -> VerificationFlow -> VerificationFlow)
-> (forall r r'.
    (r -> r' -> r)
    -> r -> (forall d. Data d => d -> r') -> VerificationFlow -> r)
-> (forall r r'.
    (r' -> r -> r)
    -> r -> (forall d. Data d => d -> r') -> VerificationFlow -> r)
-> (forall u.
    (forall d. Data d => d -> u) -> VerificationFlow -> [u])
-> (forall u.
    Int -> (forall d. Data d => d -> u) -> VerificationFlow -> u)
-> (forall (m :: * -> *).
    Monad m =>
    (forall d. Data d => d -> m d)
    -> VerificationFlow -> m VerificationFlow)
-> (forall (m :: * -> *).
    MonadPlus m =>
    (forall d. Data d => d -> m d)
    -> VerificationFlow -> m VerificationFlow)
-> (forall (m :: * -> *).
    MonadPlus m =>
    (forall d. Data d => d -> m d)
    -> VerificationFlow -> m VerificationFlow)
-> Data VerificationFlow
VerificationFlow -> DataType
VerificationFlow -> Constr
(forall b. Data b => b -> b)
-> VerificationFlow -> VerificationFlow
(forall d b. Data d => c (d -> b) -> d -> c b)
-> (forall g. g -> c g) -> VerificationFlow -> c VerificationFlow
(forall b r. Data b => c (b -> r) -> c r)
-> (forall r. r -> c r) -> Constr -> c VerificationFlow
forall a.
Typeable a
-> (forall (c :: * -> *).
    (forall d b. Data d => c (d -> b) -> d -> c b)
    -> (forall g. g -> c g) -> a -> c a)
-> (forall (c :: * -> *).
    (forall b r. Data b => c (b -> r) -> c r)
    -> (forall r. r -> c r) -> Constr -> c a)
-> (a -> Constr)
-> (a -> DataType)
-> (forall (t :: * -> *) (c :: * -> *).
    Typeable t =>
    (forall d. Data d => c (t d)) -> Maybe (c a))
-> (forall (t :: * -> * -> *) (c :: * -> *).
    Typeable t =>
    (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c a))
-> ((forall b. Data b => b -> b) -> a -> a)
-> (forall r r'.
    (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> a -> r)
-> (forall r r'.
    (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> a -> r)
-> (forall u. (forall d. Data d => d -> u) -> a -> [u])
-> (forall u. Int -> (forall d. Data d => d -> u) -> a -> u)
-> (forall (m :: * -> *).
    Monad m =>
    (forall d. Data d => d -> m d) -> a -> m a)
-> (forall (m :: * -> *).
    MonadPlus m =>
    (forall d. Data d => d -> m d) -> a -> m a)
-> (forall (m :: * -> *).
    MonadPlus m =>
    (forall d. Data d => d -> m d) -> a -> m a)
-> Data a
forall u.
Int -> (forall d. Data d => d -> u) -> VerificationFlow -> u
forall u. (forall d. Data d => d -> u) -> VerificationFlow -> [u]
forall r r'.
(r -> r' -> r)
-> r -> (forall d. Data d => d -> r') -> VerificationFlow -> r
forall r r'.
(r' -> r -> r)
-> r -> (forall d. Data d => d -> r') -> VerificationFlow -> r
forall (m :: * -> *).
Monad m =>
(forall d. Data d => d -> m d)
-> VerificationFlow -> m VerificationFlow
forall (m :: * -> *).
MonadPlus m =>
(forall d. Data d => d -> m d)
-> VerificationFlow -> m VerificationFlow
forall (c :: * -> *).
(forall b r. Data b => c (b -> r) -> c r)
-> (forall r. r -> c r) -> Constr -> c VerificationFlow
forall (c :: * -> *).
(forall d b. Data d => c (d -> b) -> d -> c b)
-> (forall g. g -> c g) -> VerificationFlow -> c VerificationFlow
forall (t :: * -> *) (c :: * -> *).
Typeable t =>
(forall d. Data d => c (t d)) -> Maybe (c VerificationFlow)
forall (t :: * -> * -> *) (c :: * -> *).
Typeable t =>
(forall d e. (Data d, Data e) => c (t d e))
-> Maybe (c VerificationFlow)
$cVerificationFlow :: Constr
$tVerificationFlow :: DataType
gmapMo :: (forall d. Data d => d -> m d)
-> VerificationFlow -> m VerificationFlow
$cgmapMo :: forall (m :: * -> *).
MonadPlus m =>
(forall d. Data d => d -> m d)
-> VerificationFlow -> m VerificationFlow
gmapMp :: (forall d. Data d => d -> m d)
-> VerificationFlow -> m VerificationFlow
$cgmapMp :: forall (m :: * -> *).
MonadPlus m =>
(forall d. Data d => d -> m d)
-> VerificationFlow -> m VerificationFlow
gmapM :: (forall d. Data d => d -> m d)
-> VerificationFlow -> m VerificationFlow
$cgmapM :: forall (m :: * -> *).
Monad m =>
(forall d. Data d => d -> m d)
-> VerificationFlow -> m VerificationFlow
gmapQi :: Int -> (forall d. Data d => d -> u) -> VerificationFlow -> u
$cgmapQi :: forall u.
Int -> (forall d. Data d => d -> u) -> VerificationFlow -> u
gmapQ :: (forall d. Data d => d -> u) -> VerificationFlow -> [u]
$cgmapQ :: forall u. (forall d. Data d => d -> u) -> VerificationFlow -> [u]
gmapQr :: (r' -> r -> r)
-> r -> (forall d. Data d => d -> r') -> VerificationFlow -> r
$cgmapQr :: forall r r'.
(r' -> r -> r)
-> r -> (forall d. Data d => d -> r') -> VerificationFlow -> r
gmapQl :: (r -> r' -> r)
-> r -> (forall d. Data d => d -> r') -> VerificationFlow -> r
$cgmapQl :: forall r r'.
(r -> r' -> r)
-> r -> (forall d. Data d => d -> r') -> VerificationFlow -> r
gmapT :: (forall b. Data b => b -> b)
-> VerificationFlow -> VerificationFlow
$cgmapT :: (forall b. Data b => b -> b)
-> VerificationFlow -> VerificationFlow
dataCast2 :: (forall d e. (Data d, Data e) => c (t d e))
-> Maybe (c VerificationFlow)
$cdataCast2 :: forall (t :: * -> * -> *) (c :: * -> *).
Typeable t =>
(forall d e. (Data d, Data e) => c (t d e))
-> Maybe (c VerificationFlow)
dataCast1 :: (forall d. Data d => c (t d)) -> Maybe (c VerificationFlow)
$cdataCast1 :: forall (t :: * -> *) (c :: * -> *).
Typeable t =>
(forall d. Data d => c (t d)) -> Maybe (c VerificationFlow)
dataTypeOf :: VerificationFlow -> DataType
$cdataTypeOf :: VerificationFlow -> DataType
toConstr :: VerificationFlow -> Constr
$ctoConstr :: VerificationFlow -> Constr
gunfold :: (forall b r. Data b => c (b -> r) -> c r)
-> (forall r. r -> c r) -> Constr -> c VerificationFlow
$cgunfold :: forall (c :: * -> *).
(forall b r. Data b => c (b -> r) -> c r)
-> (forall r. r -> c r) -> Constr -> c VerificationFlow
gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b)
-> (forall g. g -> c g) -> VerificationFlow -> c VerificationFlow
$cgfoldl :: forall (c :: * -> *).
(forall d b. Data d => c (d -> b) -> d -> c b)
-> (forall g. g -> c g) -> VerificationFlow -> c VerificationFlow
$cp1Data :: Typeable VerificationFlow
Data)

instance FromJSON VerificationFlow where
  parseJSON :: Value -> Parser VerificationFlow
parseJSON =
    Options -> Value -> Parser VerificationFlow
forall a.
(Generic a, GFromJSON Zero (Rep a)) =>
Options -> Value -> Parser a
genericParseJSON
      Options
defaultOptions
        { constructorTagModifier :: ShowS
constructorTagModifier = ShowS
typeFieldRename,
          fieldLabelModifier :: ShowS
fieldLabelModifier = ShowS
typeFieldRename
        }

instance ToJSON VerificationFlow where
  toEncoding :: VerificationFlow -> Encoding
toEncoding =
    Options -> VerificationFlow -> Encoding
forall a.
(Generic a, GToJSON' Encoding Zero (Rep a)) =>
Options -> a -> Encoding
genericToEncoding
      Options
defaultOptions
        { constructorTagModifier :: ShowS
constructorTagModifier = ShowS
typeFieldRename,
          fieldLabelModifier :: ShowS
fieldLabelModifier = ShowS
typeFieldRename
        }