wire-api-0.1.0
Safe HaskellSafe-Inferred
LanguageGHC2021

Wire.API.User.Activation

Synopsis

ActivationTarget

data ActivationTarget Source #

The target of an activation request.

Constructors

ActivateKey ActivationKey

An opaque key for some email awaiting activation.

ActivateEmail EmailAddress

A known email address awaiting activation.

Instances

Instances details
Arbitrary ActivationTarget Source # 
Instance details

Defined in Wire.API.User.Activation

Methods

arbitrary :: Gen ActivationTarget Source #

shrink :: ActivationTarget -> [ActivationTarget] Source #

Generic ActivationTarget Source # 
Instance details

Defined in Wire.API.User.Activation

Associated Types

type Rep ActivationTarget :: Type -> Type #

Methods

from :: ActivationTarget -> Rep ActivationTarget x #

to :: Rep ActivationTarget x -> ActivationTarget #

Show ActivationTarget Source # 
Instance details

Defined in Wire.API.User.Activation

Methods

showsPrec :: Int -> ActivationTarget -> ShowS #

show :: ActivationTarget -> String #

showList :: [ActivationTarget] -> ShowS #

ToByteString ActivationTarget Source # 
Instance details

Defined in Wire.API.User.Activation

Methods

builder :: ActivationTarget -> Builder Source #

Eq ActivationTarget Source # 
Instance details

Defined in Wire.API.User.Activation

Methods

(==) :: ActivationTarget -> ActivationTarget -> Bool #

(/=) :: ActivationTarget -> ActivationTarget -> Bool #

type Rep ActivationTarget Source # 
Instance details

Defined in Wire.API.User.Activation

type Rep ActivationTarget = D1 ('MetaData "ActivationTarget" "Wire.API.User.Activation" "wire-api-0.1.0-EbZS9CKNOfZ8BBy5DRJfXi" 'False) (C1 ('MetaCons "ActivateKey" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ActivationKey)) :+: C1 ('MetaCons "ActivateEmail" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 EmailAddress)))

newtype ActivationKey Source #

An opaque identifier of a UserKey awaiting activation.

Constructors

ActivationKey 

Fields

Instances

Instances details
Arbitrary ActivationKey Source # 
Instance details

Defined in Wire.API.User.Activation

Methods

arbitrary :: Gen ActivationKey Source #

shrink :: ActivationKey -> [ActivationKey] Source #

FromJSON ActivationKey Source # 
Instance details

Defined in Wire.API.User.Activation

Methods

parseJSON :: Value -> Parser ActivationKey Source #

parseJSONList :: Value -> Parser [ActivationKey] Source #

ToJSON ActivationKey Source # 
Instance details

Defined in Wire.API.User.Activation

Methods

toJSON :: ActivationKey -> Value Source #

toEncoding :: ActivationKey -> Encoding Source #

toJSONList :: [ActivationKey] -> Value Source #

toEncodingList :: [ActivationKey] -> Encoding Source #

Generic ActivationKey Source # 
Instance details

Defined in Wire.API.User.Activation

Associated Types

type Rep ActivationKey :: Type -> Type #

Methods

from :: ActivationKey -> Rep ActivationKey x #

to :: Rep ActivationKey x -> ActivationKey #

Show ActivationKey Source # 
Instance details

Defined in Wire.API.User.Activation

Methods

showsPrec :: Int -> ActivationKey -> ShowS #

show :: ActivationKey -> String #

showList :: [ActivationKey] -> ShowS #

FromByteString ActivationKey Source # 
Instance details

Defined in Wire.API.User.Activation

Methods

parser :: Parser ActivationKey Source #

ToByteString ActivationKey Source # 
Instance details

Defined in Wire.API.User.Activation

Methods

builder :: ActivationKey -> Builder Source #

Cql ActivationKey Source # 
Instance details

Defined in Wire.API.User.Activation

Methods

ctype :: Tagged ActivationKey ColumnType Source #

toCql :: ActivationKey -> Value Source #

fromCql :: Value -> Either String ActivationKey Source #

Eq ActivationKey Source # 
Instance details

Defined in Wire.API.User.Activation

Methods

(==) :: ActivationKey -> ActivationKey -> Bool #

(/=) :: ActivationKey -> ActivationKey -> Bool #

FromHttpApiData ActivationKey Source # 
Instance details

Defined in Wire.API.User.Activation

Methods

parseUrlPiece :: Text -> Either Text ActivationKey Source #

parseHeader :: ByteString -> Either Text ActivationKey Source #

parseQueryParam :: Text -> Either Text ActivationKey Source #

ToParamSchema ActivationKey Source # 
Instance details

Defined in Wire.API.User.Activation

Methods

toParamSchema :: Proxy ActivationKey -> Schema Source #

ToSchema ActivationKey Source # 
Instance details

Defined in Wire.API.User.Activation

Methods

schema :: ValueSchema NamedSwaggerDoc ActivationKey Source #

type Rep ActivationKey Source # 
Instance details

Defined in Wire.API.User.Activation

type Rep ActivationKey = D1 ('MetaData "ActivationKey" "Wire.API.User.Activation" "wire-api-0.1.0-EbZS9CKNOfZ8BBy5DRJfXi" 'True) (C1 ('MetaCons "ActivationKey" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromActivationKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AsciiBase64Url)))

ActivationCode

newtype ActivationCode Source #

A random code for use with an ActivationKey that is usually transmitted out-of-band, e.g. via email or sms. FUTUREWORK(leif): rename to VerificationCode

Constructors

ActivationCode 

Fields

Instances

Instances details
Arbitrary ActivationCode Source # 
Instance details

Defined in Wire.API.User.Activation

Methods

arbitrary :: Gen ActivationCode Source #

shrink :: ActivationCode -> [ActivationCode] Source #

FromJSON ActivationCode Source # 
Instance details

Defined in Wire.API.User.Activation

Methods

parseJSON :: Value -> Parser ActivationCode Source #

parseJSONList :: Value -> Parser [ActivationCode] Source #

ToJSON ActivationCode Source # 
Instance details

Defined in Wire.API.User.Activation

Methods

toJSON :: ActivationCode -> Value Source #

toEncoding :: ActivationCode -> Encoding Source #

toJSONList :: [ActivationCode] -> Value Source #

toEncodingList :: [ActivationCode] -> Encoding Source #

Generic ActivationCode Source # 
Instance details

Defined in Wire.API.User.Activation

Associated Types

type Rep ActivationCode :: Type -> Type #

Methods

from :: ActivationCode -> Rep ActivationCode x #

to :: Rep ActivationCode x -> ActivationCode #

Show ActivationCode Source # 
Instance details

Defined in Wire.API.User.Activation

Methods

showsPrec :: Int -> ActivationCode -> ShowS #

show :: ActivationCode -> String #

showList :: [ActivationCode] -> ShowS #

FromByteString ActivationCode Source # 
Instance details

Defined in Wire.API.User.Activation

Methods

parser :: Parser ActivationCode Source #

ToByteString ActivationCode Source # 
Instance details

Defined in Wire.API.User.Activation

Methods

builder :: ActivationCode -> Builder Source #

Cql ActivationCode Source # 
Instance details

Defined in Wire.API.User.Activation

Methods

ctype :: Tagged ActivationCode ColumnType Source #

toCql :: ActivationCode -> Value Source #

fromCql :: Value -> Either String ActivationCode Source #

Eq ActivationCode Source # 
Instance details

Defined in Wire.API.User.Activation

Methods

(==) :: ActivationCode -> ActivationCode -> Bool #

(/=) :: ActivationCode -> ActivationCode -> Bool #

FromHttpApiData ActivationCode Source # 
Instance details

Defined in Wire.API.User.Activation

Methods

parseUrlPiece :: Text -> Either Text ActivationCode Source #

parseHeader :: ByteString -> Either Text ActivationCode Source #

parseQueryParam :: Text -> Either Text ActivationCode Source #

ToParamSchema ActivationCode Source # 
Instance details

Defined in Wire.API.User.Activation

Methods

toParamSchema :: Proxy ActivationCode -> Schema Source #

ToSchema ActivationCode Source # 
Instance details

Defined in Wire.API.User.Activation

Methods

declareNamedSchema :: Proxy ActivationCode -> Declare (Definitions Schema) NamedSchema Source #

ToSchema ActivationCode Source # 
Instance details

Defined in Wire.API.User.Activation

Methods

schema :: ValueSchema NamedSwaggerDoc ActivationCode Source #

type Rep ActivationCode Source # 
Instance details

Defined in Wire.API.User.Activation

type Rep ActivationCode = D1 ('MetaData "ActivationCode" "Wire.API.User.Activation" "wire-api-0.1.0-EbZS9CKNOfZ8BBy5DRJfXi" 'True) (C1 ('MetaCons "ActivationCode" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromActivationCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AsciiBase64Url)))

Activate

data Activate Source #

Data for an activation request.

Constructors

Activate 

Fields

Instances

Instances details
Arbitrary Activate Source # 
Instance details

Defined in Wire.API.User.Activation

Methods

arbitrary :: Gen Activate Source #

shrink :: Activate -> [Activate] Source #

FromJSON Activate Source # 
Instance details

Defined in Wire.API.User.Activation

Methods

parseJSON :: Value -> Parser Activate Source #

parseJSONList :: Value -> Parser [Activate] Source #

ToJSON Activate Source # 
Instance details

Defined in Wire.API.User.Activation

Methods

toJSON :: Activate -> Value Source #

toEncoding :: Activate -> Encoding Source #

toJSONList :: [Activate] -> Value Source #

toEncodingList :: [Activate] -> Encoding Source #

Generic Activate Source # 
Instance details

Defined in Wire.API.User.Activation

Associated Types

type Rep Activate :: Type -> Type #

Methods

from :: Activate -> Rep Activate x #

to :: Rep Activate x -> Activate #

Show Activate Source # 
Instance details

Defined in Wire.API.User.Activation

Methods

showsPrec :: Int -> Activate -> ShowS #

show :: Activate -> String #

showList :: [Activate] -> ShowS #

Eq Activate Source # 
Instance details

Defined in Wire.API.User.Activation

Methods

(==) :: Activate -> Activate -> Bool #

(/=) :: Activate -> Activate -> Bool #

ToSchema Activate Source # 
Instance details

Defined in Wire.API.User.Activation

Methods

declareNamedSchema :: Proxy Activate -> Declare (Definitions Schema) NamedSchema Source #

ToSchema Activate Source # 
Instance details

Defined in Wire.API.User.Activation

Methods

schema :: ValueSchema NamedSwaggerDoc Activate Source #

type Rep Activate Source # 
Instance details

Defined in Wire.API.User.Activation

type Rep Activate = D1 ('MetaData "Activate" "Wire.API.User.Activation" "wire-api-0.1.0-EbZS9CKNOfZ8BBy5DRJfXi" 'False) (C1 ('MetaCons "Activate" 'PrefixI 'True) (S1 ('MetaSel ('Just "activateTarget") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ActivationTarget) :*: (S1 ('MetaSel ('Just "activateCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ActivationCode) :*: S1 ('MetaSel ('Just "activateDryrun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool))))

data ActivationResponse Source #

Information returned as part of a successful activation.

Constructors

ActivationResponse 

Fields

Instances

Instances details
Arbitrary ActivationResponse Source # 
Instance details

Defined in Wire.API.User.Activation

Methods

arbitrary :: Gen ActivationResponse Source #

shrink :: ActivationResponse -> [ActivationResponse] Source #

FromJSON ActivationResponse Source # 
Instance details

Defined in Wire.API.User.Activation

Methods

parseJSON :: Value -> Parser ActivationResponse Source #

parseJSONList :: Value -> Parser [ActivationResponse] Source #

ToJSON ActivationResponse Source # 
Instance details

Defined in Wire.API.User.Activation

Methods

toJSON :: ActivationResponse -> Value Source #

toEncoding :: ActivationResponse -> Encoding Source #

toJSONList :: [ActivationResponse] -> Value Source #

toEncodingList :: [ActivationResponse] -> Encoding Source #

Generic ActivationResponse Source # 
Instance details

Defined in Wire.API.User.Activation

Associated Types

type Rep ActivationResponse :: Type -> Type #

Methods

from :: ActivationResponse -> Rep ActivationResponse x #

to :: Rep ActivationResponse x -> ActivationResponse #

Show ActivationResponse Source # 
Instance details

Defined in Wire.API.User.Activation

Methods

showsPrec :: Int -> ActivationResponse -> ShowS #

show :: ActivationResponse -> String #

showList :: [ActivationResponse] -> ShowS #

Eq ActivationResponse Source # 
Instance details

Defined in Wire.API.User.Activation

Methods

(==) :: ActivationResponse -> ActivationResponse -> Bool #

(/=) :: ActivationResponse -> ActivationResponse -> Bool #

ToSchema ActivationResponse Source # 
Instance details

Defined in Wire.API.User.Activation

Methods

declareNamedSchema :: Proxy ActivationResponse -> Declare (Definitions Schema) NamedSchema Source #

ToSchema ActivationResponse Source # 
Instance details

Defined in Wire.API.User.Activation

Methods

schema :: ValueSchema NamedSwaggerDoc ActivationResponse Source #

AsUnion GetActivateResponse ActivationRespWithStatus Source # 
Instance details

Defined in Wire.API.Routes.Public.Brig

Methods

toUnion :: ActivationRespWithStatus -> Union (ResponseTypes GetActivateResponse) Source #

fromUnion :: Union (ResponseTypes GetActivateResponse) -> ActivationRespWithStatus Source #

type Rep ActivationResponse Source # 
Instance details

Defined in Wire.API.User.Activation

type Rep ActivationResponse = D1 ('MetaData "ActivationResponse" "Wire.API.User.Activation" "wire-api-0.1.0-EbZS9CKNOfZ8BBy5DRJfXi" 'False) (C1 ('MetaCons "ActivationResponse" 'PrefixI 'True) (S1 ('MetaSel ('Just "activatedIdentity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UserIdentity) :*: S1 ('MetaSel ('Just "activatedFirst") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)))

SendActivationCode

data SendActivationCode Source #

Payload for a request to (re-)send an activation code for an e-mail address.

Constructors

SendActivationCode 

Fields

Instances

Instances details
Arbitrary SendActivationCode Source # 
Instance details

Defined in Wire.API.User.Activation

Methods

arbitrary :: Gen SendActivationCode Source #

shrink :: SendActivationCode -> [SendActivationCode] Source #

FromJSON SendActivationCode Source # 
Instance details

Defined in Wire.API.User.Activation

Methods

parseJSON :: Value -> Parser SendActivationCode Source #

parseJSONList :: Value -> Parser [SendActivationCode] Source #

ToJSON SendActivationCode Source # 
Instance details

Defined in Wire.API.User.Activation

Methods

toJSON :: SendActivationCode -> Value Source #

toEncoding :: SendActivationCode -> Encoding Source #

toJSONList :: [SendActivationCode] -> Value Source #

toEncodingList :: [SendActivationCode] -> Encoding Source #

Generic SendActivationCode Source # 
Instance details

Defined in Wire.API.User.Activation

Associated Types

type Rep SendActivationCode :: Type -> Type #

Methods

from :: SendActivationCode -> Rep SendActivationCode x #

to :: Rep SendActivationCode x -> SendActivationCode #

Show SendActivationCode Source # 
Instance details

Defined in Wire.API.User.Activation

Methods

showsPrec :: Int -> SendActivationCode -> ShowS #

show :: SendActivationCode -> String #

showList :: [SendActivationCode] -> ShowS #

Eq SendActivationCode Source # 
Instance details

Defined in Wire.API.User.Activation

Methods

(==) :: SendActivationCode -> SendActivationCode -> Bool #

(/=) :: SendActivationCode -> SendActivationCode -> Bool #

ToSchema SendActivationCode Source # 
Instance details

Defined in Wire.API.User.Activation

Methods

declareNamedSchema :: Proxy SendActivationCode -> Declare (Definitions Schema) NamedSchema Source #

ToSchema SendActivationCode Source # 
Instance details

Defined in Wire.API.User.Activation

Methods

schema :: ValueSchema NamedSwaggerDoc SendActivationCode Source #

type Rep SendActivationCode Source # 
Instance details

Defined in Wire.API.User.Activation

type Rep SendActivationCode = D1 ('MetaData "SendActivationCode" "Wire.API.User.Activation" "wire-api-0.1.0-EbZS9CKNOfZ8BBy5DRJfXi" 'False) (C1 ('MetaCons "SendActivationCode" 'PrefixI 'True) (S1 ('MetaSel ('Just "emailKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 EmailAddress) :*: S1 ('MetaSel ('Just "locale") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Locale))))