Safe Haskell	Safe-Inferred
Language	GHC2021

Wire.VerificationCode

Synopsis

data Code = Code {
- codeKey :: !Key
- codeScope :: !Scope
- codeValue :: !Value
- codeRetries :: !Retries
- codeTTL :: !Timeout
- codeFor :: !EmailAddress
- codeAccount :: !(Maybe UUID)
}
newtype Key = Key {
- asciiKey :: Range 20 20 AsciiBase64Url
}
data Scope
- = AccountDeletion
- | IdentityVerification
- | PasswordReset
- | AccountLogin
- | AccountApproval
- | CreateScimToken
- | DeleteTeam
newtype Value = Value {
- asciiValue :: Range 6 20 AsciiBase64Url
}
data KeyValuePair = KeyValuePair {
- key :: !Key
- code :: !Value
}
newtype Timeout = Timeout {
- timeoutDiffTime :: NominalDiffTime
}
newtype Retries = Retries {
- numRetries :: Word8
}
codeToKeyValuePair :: Code -> KeyValuePair
scopeFromAction :: VerificationAction -> Scope

Documentation

data Code Source #

Constructors

Code
Fields codeKey :: !Key codeScope :: !Scope codeValue :: !Value codeRetries :: !Retries This field is actually used as number of allowed "tries" rather than "retries", so if a code has a retries = 1, verification can only be tried once, and it cannot actually be "re"-tried after that. codeTTL :: !Timeout codeFor :: !EmailAddress codeAccount :: !(Maybe UUID)

Instances

Instances details

Show Code Source #
Instance details Defined in Wire.VerificationCode Methods showsPrec :: Int -> Code -> ShowS # show :: Code -> String # showList :: [Code] -> ShowS #
Eq Code Source #
Instance details Defined in Wire.VerificationCode Methods (==) :: Code -> Code -> Bool # (/=) :: Code -> Code -> Bool #

newtype Key Source #

A scoped identifier for a Value with an associated Timeout.

Constructors

Key
Fields asciiKey :: Range 20 20 AsciiBase64Url

Instances

Instances details

Arbitrary Key
Instance details Defined in Data.Code Methods arbitrary :: Gen Key Source # shrink :: Key -> [Key] Source #
FromJSON Key
Instance details Defined in Data.Code Methods parseJSON :: Value -> Parser Key Source # parseJSONList :: Value -> Parser [Key] Source #
ToJSON Key
Instance details Defined in Data.Code Methods toJSON :: Key -> Value Source # toEncoding :: Key -> Encoding Source # toJSONList :: [Key] -> Value Source # toEncodingList :: [Key] -> Encoding Source #
Show Key
Instance details Defined in Data.Code Methods showsPrec :: Int -> Key -> ShowS # show :: Key -> String # showList :: [Key] -> ShowS #
FromByteString Key
Instance details Defined in Data.Code Methods parser :: Parser Key Source #
ToByteString Key
Instance details Defined in Data.Code Methods builder :: Key -> Builder Source #
Cql Key
Instance details Defined in Data.Code Methods ctype :: Tagged Key ColumnType Source # toCql :: Key -> Value Source # fromCql :: Value -> Either String Key Source #
Eq Key
Instance details Defined in Data.Code Methods (==) :: Key -> Key -> Bool # (/=) :: Key -> Key -> Bool #
Ord Key
Instance details Defined in Data.Code Methods compare :: Key -> Key -> Ordering # (<) :: Key -> Key -> Bool # (<=) :: Key -> Key -> Bool # (>) :: Key -> Key -> Bool # (>=) :: Key -> Key -> Bool # max :: Key -> Key -> Key # min :: Key -> Key -> Key #
FromHttpApiData Key
Instance details Defined in Data.Code Methods parseUrlPiece :: Text -> Either Text Key Source # parseHeader :: ByteString -> Either Text Key Source # parseQueryParam :: Text -> Either Text Key Source #
ToHttpApiData Key
Instance details Defined in Data.Code Methods toUrlPiece :: Key -> Text Source # toEncodedUrlPiece :: Key -> Builder Source # toHeader :: Key -> ByteString Source # toQueryParam :: Key -> Text Source # toEncodedQueryParam :: Key -> Builder Source #
ToParamSchema Key
Instance details Defined in Data.Code Methods toParamSchema :: Proxy Key -> Schema Source #
ToSchema Key
Instance details Defined in Data.Code Methods declareNamedSchema :: Proxy Key -> Declare (Definitions Schema) NamedSchema Source #
ToSchema Key
Instance details Defined in Data.Code Methods schema :: ValueSchema NamedSwaggerDoc Key Source #

data Scope Source #

The same Key can exist with different Values in different Scopes at the same time.

Constructors

AccountDeletion
IdentityVerification
PasswordReset
AccountLogin
AccountApproval
CreateScimToken
DeleteTeam

Instances

Instances details

Arbitrary Scope Source #
Instance details Defined in Wire.VerificationCode Methods arbitrary :: Gen Scope Source # shrink :: Scope -> [Scope] Source #
Generic Scope Source #
Instance details Defined in Wire.VerificationCode Associated Types type Rep Scope :: Type -> Type # Methods from :: Scope -> Rep Scope x # to :: Rep Scope x -> Scope #
Show Scope Source #
Instance details Defined in Wire.VerificationCode Methods showsPrec :: Int -> Scope -> ShowS # show :: Scope -> String # showList :: [Scope] -> ShowS #
Cql Scope Source #
Instance details Defined in Wire.VerificationCode Methods ctype :: Tagged Scope ColumnType Source # toCql :: Scope -> Value Source # fromCql :: Value -> Either String Scope Source #
Eq Scope Source #
Instance details Defined in Wire.VerificationCode Methods (==) :: Scope -> Scope -> Bool # (/=) :: Scope -> Scope -> Bool #
Ord Scope Source #
Instance details Defined in Wire.VerificationCode Methods compare :: Scope -> Scope -> Ordering # (<) :: Scope -> Scope -> Bool # (<=) :: Scope -> Scope -> Bool # (>) :: Scope -> Scope -> Bool # (>=) :: Scope -> Scope -> Bool # max :: Scope -> Scope -> Scope # min :: Scope -> Scope -> Scope #
type Rep Scope Source #
Instance details Defined in Wire.VerificationCode type Rep Scope = D1 ('MetaData "Scope" "Wire.VerificationCode" "wire-subsystems-0.1.0-8kLXA8DL8T7Joz69IIRPwJ" 'False) ((C1 ('MetaCons "AccountDeletion" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "IdentityVerification" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PasswordReset" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "AccountLogin" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "AccountApproval" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "CreateScimToken" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "DeleteTeam" 'PrefixI 'False) (U1 :: Type -> Type))))

newtype Value Source #

A secret value bound to a Key and a Timeout.

Constructors

Value
Fields asciiValue :: Range 6 20 AsciiBase64Url

Instances

Instances details

Arbitrary Value
Instance details Defined in Data.Code Methods arbitrary :: Gen Value Source # shrink :: Value -> [Value] Source #
FromJSON Value
Instance details Defined in Data.Code Methods parseJSON :: Value0 -> Parser Value Source # parseJSONList :: Value0 -> Parser [Value] Source #
ToJSON Value
Instance details Defined in Data.Code Methods toJSON :: Value -> Value0 Source # toEncoding :: Value -> Encoding Source # toJSONList :: [Value] -> Value0 Source # toEncodingList :: [Value] -> Encoding Source #
Show Value
Instance details Defined in Data.Code Methods showsPrec :: Int -> Value -> ShowS # show :: Value -> String # showList :: [Value] -> ShowS #
FromByteString Value
Instance details Defined in Data.Code Methods parser :: Parser Value Source #
ToByteString Value
Instance details Defined in Data.Code Methods builder :: Value -> Builder Source #
Cql Value
Instance details Defined in Data.Code Methods ctype :: Tagged Value ColumnType Source # toCql :: Value -> Value0 Source # fromCql :: Value0 -> Either String Value Source #
Eq Value
Instance details Defined in Data.Code Methods (==) :: Value -> Value -> Bool # (/=) :: Value -> Value -> Bool #
FromHttpApiData Value
Instance details Defined in Data.Code Methods parseUrlPiece :: Text -> Either Text Value Source # parseHeader :: ByteString -> Either Text Value Source # parseQueryParam :: Text -> Either Text Value Source #
ToHttpApiData Value
Instance details Defined in Data.Code Methods toUrlPiece :: Value -> Text Source # toEncodedUrlPiece :: Value -> Builder Source # toHeader :: Value -> ByteString Source # toQueryParam :: Value -> Text Source # toEncodedQueryParam :: Value -> Builder Source #
ToParamSchema Value
Instance details Defined in Data.Code Methods toParamSchema :: Proxy Value -> Schema Source #
ToSchema Value
Instance details Defined in Data.Code Methods declareNamedSchema :: Proxy Value -> Declare (Definitions Schema) NamedSchema Source #
ToSchema Value
Instance details Defined in Data.Code Methods schema :: ValueSchema NamedSwaggerDoc Value Source #

data KeyValuePair Source #

A key/value pair. This would actually more accurately if the value would actually be a "value" but since we use "key" and "code" already in quite a few place in the API (but without a type, using plain fields). This will make it easier to re-use a key/value pair in the API, keeping "code" in the JSON for backwards compatibility

Constructors

KeyValuePair
Fields key :: !Key code :: !Value

Instances

Instances details

FromJSON KeyValuePair
Instance details Defined in Data.Code Methods parseJSON :: Value -> Parser KeyValuePair Source # parseJSONList :: Value -> Parser [KeyValuePair] Source #
ToJSON KeyValuePair
Instance details Defined in Data.Code Methods toJSON :: KeyValuePair -> Value Source # toEncoding :: KeyValuePair -> Encoding Source # toJSONList :: [KeyValuePair] -> Value Source # toEncodingList :: [KeyValuePair] -> Encoding Source #
Generic KeyValuePair
Instance details Defined in Data.Code Associated Types type Rep KeyValuePair :: Type -> Type # Methods from :: KeyValuePair -> Rep KeyValuePair x # to :: Rep KeyValuePair x -> KeyValuePair #
Show KeyValuePair
Instance details Defined in Data.Code Methods showsPrec :: Int -> KeyValuePair -> ShowS # show :: KeyValuePair -> String # showList :: [KeyValuePair] -> ShowS #
Eq KeyValuePair
Instance details Defined in Data.Code Methods (==) :: KeyValuePair -> KeyValuePair -> Bool # (/=) :: KeyValuePair -> KeyValuePair -> Bool #
ToSchema KeyValuePair
Instance details Defined in Data.Code Methods declareNamedSchema :: Proxy KeyValuePair -> Declare (Definitions Schema) NamedSchema Source #
ToSchema KeyValuePair
Instance details Defined in Data.Code Methods schema :: ValueSchema NamedSwaggerDoc KeyValuePair Source #
type Rep KeyValuePair
Instance details Defined in Data.Code type Rep KeyValuePair = D1 ('MetaData "KeyValuePair" "Data.Code" "types-common-0.16.0-LkhhqucPLeMGZ2r1ZsnNqs" 'False) (C1 ('MetaCons "KeyValuePair" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Key) :*: S1 ('MetaSel ('Just "code") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Value)))

newtype Timeout Source #

A Timeout is rendered in/parsed from JSON as an integer representing the number of seconds remaining.

Constructors

Timeout
Fields timeoutDiffTime :: NominalDiffTime

Instances

Instances details

Arbitrary Timeout
Instance details Defined in Data.Code Methods arbitrary :: Gen Timeout Source # shrink :: Timeout -> [Timeout] Source #
FromJSON Timeout
Instance details Defined in Data.Code Methods parseJSON :: Value -> Parser Timeout Source # parseJSONList :: Value -> Parser [Timeout] Source #
ToJSON Timeout
Instance details Defined in Data.Code Methods toJSON :: Timeout -> Value Source # toEncoding :: Timeout -> Encoding Source # toJSONList :: [Timeout] -> Value Source # toEncodingList :: [Timeout] -> Encoding Source #
Enum Timeout
Instance details Defined in Data.Code Methods succ :: Timeout -> Timeout # pred :: Timeout -> Timeout # toEnum :: Int -> Timeout # fromEnum :: Timeout -> Int # enumFrom :: Timeout -> [Timeout] # enumFromThen :: Timeout -> Timeout -> [Timeout] # enumFromTo :: Timeout -> Timeout -> [Timeout] # enumFromThenTo :: Timeout -> Timeout -> Timeout -> [Timeout] #
Num Timeout
Instance details Defined in Data.Code Methods (+) :: Timeout -> Timeout -> Timeout # (-) :: Timeout -> Timeout -> Timeout # (*) :: Timeout -> Timeout -> Timeout # negate :: Timeout -> Timeout # abs :: Timeout -> Timeout # signum :: Timeout -> Timeout # fromInteger :: Integer -> Timeout #
Fractional Timeout
Instance details Defined in Data.Code Methods (/) :: Timeout -> Timeout -> Timeout # recip :: Timeout -> Timeout # fromRational :: Rational -> Timeout #
Real Timeout
Instance details Defined in Data.Code Methods toRational :: Timeout -> Rational #
RealFrac Timeout
Instance details Defined in Data.Code Methods properFraction :: Integral b => Timeout -> (b, Timeout) # truncate :: Integral b => Timeout -> b # round :: Integral b => Timeout -> b # ceiling :: Integral b => Timeout -> b # floor :: Integral b => Timeout -> b #
Show Timeout
Instance details Defined in Data.Code Methods showsPrec :: Int -> Timeout -> ShowS # show :: Timeout -> String # showList :: [Timeout] -> ShowS #
ToByteString Timeout	A `Timeout` is rendered as an integer representing the number of seconds remaining.
Instance details Defined in Data.Code Methods builder :: Timeout -> Builder Source #
Eq Timeout
Instance details Defined in Data.Code Methods (==) :: Timeout -> Timeout -> Bool # (/=) :: Timeout -> Timeout -> Bool #
Ord Timeout
Instance details Defined in Data.Code Methods compare :: Timeout -> Timeout -> Ordering # (<) :: Timeout -> Timeout -> Bool # (<=) :: Timeout -> Timeout -> Bool # (>) :: Timeout -> Timeout -> Bool # (>=) :: Timeout -> Timeout -> Bool # max :: Timeout -> Timeout -> Timeout # min :: Timeout -> Timeout -> Timeout #
ToSchema Timeout
Instance details Defined in Data.Code Methods declareNamedSchema :: Proxy Timeout -> Declare (Definitions Schema) NamedSchema Source #
ToSchema Timeout
Instance details Defined in Data.Code Methods schema :: ValueSchema NamedSwaggerDoc Timeout Source #

newtype Retries Source #

Constructors

Retries
Fields numRetries :: Word8

Instances

Instances details

Arbitrary Retries Source #
Instance details Defined in Wire.VerificationCode Methods arbitrary :: Gen Retries Source # shrink :: Retries -> [Retries] Source #
Enum Retries Source #
Instance details Defined in Wire.VerificationCode Methods succ :: Retries -> Retries # pred :: Retries -> Retries # toEnum :: Int -> Retries # fromEnum :: Retries -> Int # enumFrom :: Retries -> [Retries] # enumFromThen :: Retries -> Retries -> [Retries] # enumFromTo :: Retries -> Retries -> [Retries] # enumFromThenTo :: Retries -> Retries -> Retries -> [Retries] #
Num Retries Source #
Instance details Defined in Wire.VerificationCode Methods (+) :: Retries -> Retries -> Retries # (-) :: Retries -> Retries -> Retries # (*) :: Retries -> Retries -> Retries # negate :: Retries -> Retries # abs :: Retries -> Retries # signum :: Retries -> Retries # fromInteger :: Integer -> Retries #
Integral Retries Source #
Instance details Defined in Wire.VerificationCode Methods quot :: Retries -> Retries -> Retries # rem :: Retries -> Retries -> Retries # div :: Retries -> Retries -> Retries # mod :: Retries -> Retries -> Retries # quotRem :: Retries -> Retries -> (Retries, Retries) # divMod :: Retries -> Retries -> (Retries, Retries) # toInteger :: Retries -> Integer #
Real Retries Source #
Instance details Defined in Wire.VerificationCode Methods toRational :: Retries -> Rational #
Show Retries Source #
Instance details Defined in Wire.VerificationCode Methods showsPrec :: Int -> Retries -> ShowS # show :: Retries -> String # showList :: [Retries] -> ShowS #
Cql Retries Source #
Instance details Defined in Wire.VerificationCode Methods ctype :: Tagged Retries ColumnType Source # toCql :: Retries -> Value Source # fromCql :: Value -> Either String Retries Source #
Eq Retries Source #
Instance details Defined in Wire.VerificationCode Methods (==) :: Retries -> Retries -> Bool # (/=) :: Retries -> Retries -> Bool #
Ord Retries Source #
Instance details Defined in Wire.VerificationCode Methods compare :: Retries -> Retries -> Ordering # (<) :: Retries -> Retries -> Bool # (<=) :: Retries -> Retries -> Bool # (>) :: Retries -> Retries -> Bool # (>=) :: Retries -> Retries -> Bool # max :: Retries -> Retries -> Retries # min :: Retries -> Retries -> Retries #

codeToKeyValuePair :: Code -> KeyValuePair Source #

scopeFromAction :: VerificationAction -> Scope Source #