Safe Haskell	Safe-Inferred
Language	GHC2021

Wire.API.User.Profile

Contents

Asset
ManagedBy
Deprecated

Synopsis

newtype Name = Name {
- fromName :: Text
}
mkName :: Text -> Either String Name
data TextStatus
mkTextStatus :: Text -> Either String TextStatus
$sel:fromTextStatus:TextStatus :: TextStatus -> Text
newtype ColourId = ColourId {
- fromColourId :: Int32
}
defaultAccentId :: ColourId
data Asset = ImageAsset {
- assetKey :: AssetKey
- assetSize :: Maybe AssetSize
}
data AssetSize
- = AssetComplete
- | AssetPreview
data ManagedBy
- = ManagedByWire
- | ManagedByScim
defaultManagedBy :: ManagedBy
newtype Pict = Pict {
- fromPict :: [Object]
}
noPict :: Pict

Documentation

newtype Name Source #

Usually called display name. Length is between 1 and 128 characters.

Constructors

Name
Fields fromName :: Text

Instances

Instances details

Arbitrary Name Source #
Instance details Defined in Wire.API.User.Profile Methods arbitrary :: Gen Name Source # shrink :: Name -> [Name] Source #
FromJSON Name Source #
Instance details Defined in Wire.API.User.Profile Methods parseJSON :: Value -> Parser Name Source # parseJSONList :: Value -> Parser [Name] Source #
ToJSON Name Source #
Instance details Defined in Wire.API.User.Profile Methods toJSON :: Name -> Value Source # toEncoding :: Name -> Encoding Source # toJSONList :: [Name] -> Value Source # toEncodingList :: [Name] -> Encoding Source #
Generic Name Source #
Instance details Defined in Wire.API.User.Profile Associated Types type Rep Name :: Type -> Type # Methods from :: Name -> Rep Name x # to :: Rep Name x -> Name #
Show Name Source #
Instance details Defined in Wire.API.User.Profile Methods showsPrec :: Int -> Name -> ShowS # show :: Name -> String # showList :: [Name] -> ShowS #
FromByteString Name Source #
Instance details Defined in Wire.API.User.Profile Methods parser :: Parser Name Source #
ToByteString Name Source #
Instance details Defined in Wire.API.User.Profile Methods builder :: Name -> Builder Source #
Cql Name Source #
Instance details Defined in Wire.API.User.Profile Methods ctype :: Tagged Name ColumnType Source # toCql :: Name -> Value Source # fromCql :: Value -> Either String Name Source #
Eq Name Source #
Instance details Defined in Wire.API.User.Profile Methods (==) :: Name -> Name -> Bool # (/=) :: Name -> Name -> Bool #
Ord Name Source #
Instance details Defined in Wire.API.User.Profile Methods compare :: Name -> Name -> Ordering # (<) :: Name -> Name -> Bool # (<=) :: Name -> Name -> Bool # (>) :: Name -> Name -> Bool # (>=) :: Name -> Name -> Bool # max :: Name -> Name -> Name # min :: Name -> Name -> Name #
ToSchema Name Source #
Instance details Defined in Wire.API.User.Profile Methods declareNamedSchema :: Proxy Name -> Declare (Definitions Schema) NamedSchema Source #
ToSchema Name Source #
Instance details Defined in Wire.API.User.Profile Methods schema :: ValueSchema NamedSwaggerDoc Name Source #
type Rep Name Source #
Instance details Defined in Wire.API.User.Profile type Rep Name = D1 ('MetaData "Name" "Wire.API.User.Profile" "wire-api-0.1.0-EbZS9CKNOfZ8BBy5DRJfXi" 'True) (C1 ('MetaCons "Name" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

mkName :: Text -> Either String Name Source #

data TextStatus Source #

Instances

Instances details

Arbitrary TextStatus Source #
Instance details Defined in Wire.API.User.Profile Methods arbitrary :: Gen TextStatus Source # shrink :: TextStatus -> [TextStatus] Source #
FromJSON TextStatus Source #
Instance details Defined in Wire.API.User.Profile Methods parseJSON :: Value -> Parser TextStatus Source # parseJSONList :: Value -> Parser [TextStatus] Source #
ToJSON TextStatus Source #
Instance details Defined in Wire.API.User.Profile Methods toJSON :: TextStatus -> Value Source # toEncoding :: TextStatus -> Encoding Source # toJSONList :: [TextStatus] -> Value Source # toEncodingList :: [TextStatus] -> Encoding Source #
Generic TextStatus Source #
Instance details Defined in Wire.API.User.Profile Associated Types type Rep TextStatus :: Type -> Type # Methods from :: TextStatus -> Rep TextStatus x # to :: Rep TextStatus x -> TextStatus #
Show TextStatus Source #
Instance details Defined in Wire.API.User.Profile Methods showsPrec :: Int -> TextStatus -> ShowS # show :: TextStatus -> String # showList :: [TextStatus] -> ShowS #
FromByteString TextStatus Source #
Instance details Defined in Wire.API.User.Profile Methods parser :: Parser TextStatus Source #
ToByteString TextStatus Source #
Instance details Defined in Wire.API.User.Profile Methods builder :: TextStatus -> Builder Source #
Cql TextStatus Source #
Instance details Defined in Wire.API.User.Profile Methods ctype :: Tagged TextStatus ColumnType Source # toCql :: TextStatus -> Value Source # fromCql :: Value -> Either String TextStatus Source #
Eq TextStatus Source #
Instance details Defined in Wire.API.User.Profile Methods (==) :: TextStatus -> TextStatus -> Bool # (/=) :: TextStatus -> TextStatus -> Bool #
Ord TextStatus Source #
Instance details Defined in Wire.API.User.Profile Methods compare :: TextStatus -> TextStatus -> Ordering # (<) :: TextStatus -> TextStatus -> Bool # (<=) :: TextStatus -> TextStatus -> Bool # (>) :: TextStatus -> TextStatus -> Bool # (>=) :: TextStatus -> TextStatus -> Bool # max :: TextStatus -> TextStatus -> TextStatus # min :: TextStatus -> TextStatus -> TextStatus #
ToSchema TextStatus Source #
Instance details Defined in Wire.API.User.Profile Methods declareNamedSchema :: Proxy TextStatus -> Declare (Definitions Schema) NamedSchema Source #
ToSchema TextStatus Source #
Instance details Defined in Wire.API.User.Profile Methods schema :: ValueSchema NamedSwaggerDoc TextStatus Source #
type Rep TextStatus Source #
Instance details Defined in Wire.API.User.Profile type Rep TextStatus = D1 ('MetaData "TextStatus" "Wire.API.User.Profile" "wire-api-0.1.0-EbZS9CKNOfZ8BBy5DRJfXi" 'True) (C1 ('MetaCons "TextStatus" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromTextStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

mkTextStatus :: Text -> Either String TextStatus Source #

$sel:fromTextStatus:TextStatus :: TextStatus -> Text Source #

newtype ColourId Source #

Constructors

ColourId
Fields fromColourId :: Int32

Instances

Instances details

Arbitrary ColourId Source #
Instance details Defined in Wire.API.User.Profile Methods arbitrary :: Gen ColourId Source # shrink :: ColourId -> [ColourId] Source #
FromJSON ColourId Source #
Instance details Defined in Wire.API.User.Profile Methods parseJSON :: Value -> Parser ColourId Source # parseJSONList :: Value -> Parser [ColourId] Source #
ToJSON ColourId Source #
Instance details Defined in Wire.API.User.Profile Methods toJSON :: ColourId -> Value Source # toEncoding :: ColourId -> Encoding Source # toJSONList :: [ColourId] -> Value Source # toEncodingList :: [ColourId] -> Encoding Source #
Generic ColourId Source #
Instance details Defined in Wire.API.User.Profile Associated Types type Rep ColourId :: Type -> Type # Methods from :: ColourId -> Rep ColourId x # to :: Rep ColourId x -> ColourId #
Num ColourId Source #
Instance details Defined in Wire.API.User.Profile Methods (+) :: ColourId -> ColourId -> ColourId # (-) :: ColourId -> ColourId -> ColourId # (*) :: ColourId -> ColourId -> ColourId # negate :: ColourId -> ColourId # abs :: ColourId -> ColourId # signum :: ColourId -> ColourId # fromInteger :: Integer -> ColourId #
Show ColourId Source #
Instance details Defined in Wire.API.User.Profile Methods showsPrec :: Int -> ColourId -> ShowS # show :: ColourId -> String # showList :: [ColourId] -> ShowS #
Cql ColourId Source #
Instance details Defined in Wire.API.User.Profile Methods ctype :: Tagged ColourId ColumnType Source # toCql :: ColourId -> Value Source # fromCql :: Value -> Either String ColourId Source #
Eq ColourId Source #
Instance details Defined in Wire.API.User.Profile Methods (==) :: ColourId -> ColourId -> Bool # (/=) :: ColourId -> ColourId -> Bool #
Ord ColourId Source #
Instance details Defined in Wire.API.User.Profile Methods compare :: ColourId -> ColourId -> Ordering # (<) :: ColourId -> ColourId -> Bool # (<=) :: ColourId -> ColourId -> Bool # (>) :: ColourId -> ColourId -> Bool # (>=) :: ColourId -> ColourId -> Bool # max :: ColourId -> ColourId -> ColourId # min :: ColourId -> ColourId -> ColourId #
ToSchema ColourId Source #
Instance details Defined in Wire.API.User.Profile Methods declareNamedSchema :: Proxy ColourId -> Declare (Definitions Schema) NamedSchema Source #
ToSchema ColourId Source #
Instance details Defined in Wire.API.User.Profile Methods schema :: ValueSchema NamedSwaggerDoc ColourId Source #
type Rep ColourId Source #
Instance details Defined in Wire.API.User.Profile type Rep ColourId = D1 ('MetaData "ColourId" "Wire.API.User.Profile" "wire-api-0.1.0-EbZS9CKNOfZ8BBy5DRJfXi" 'True) (C1 ('MetaCons "ColourId" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromColourId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int32)))

defaultAccentId :: ColourId Source #

Asset

data Asset Source #

Constructors

ImageAsset
Fields assetKey :: AssetKey assetSize :: Maybe AssetSize

Instances

Instances details

Arbitrary Asset Source #
Instance details Defined in Wire.API.User.Profile Methods arbitrary :: Gen Asset Source # shrink :: Asset -> [Asset] Source #
FromJSON Asset Source #
Instance details Defined in Wire.API.User.Profile Methods parseJSON :: Value -> Parser Asset Source # parseJSONList :: Value -> Parser [Asset] Source #
ToJSON Asset Source #
Instance details Defined in Wire.API.User.Profile Methods toJSON :: Asset -> Value Source # toEncoding :: Asset -> Encoding Source # toJSONList :: [Asset] -> Value Source # toEncodingList :: [Asset] -> Encoding Source #
Generic Asset Source #
Instance details Defined in Wire.API.User.Profile Associated Types type Rep Asset :: Type -> Type # Methods from :: Asset -> Rep Asset x # to :: Rep Asset x -> Asset #
Show Asset Source #
Instance details Defined in Wire.API.User.Profile Methods showsPrec :: Int -> Asset -> ShowS # show :: Asset -> String # showList :: [Asset] -> ShowS #
Cql Asset Source #
Instance details Defined in Wire.API.User.Profile Methods ctype :: Tagged Asset ColumnType Source # toCql :: Asset -> Value Source # fromCql :: Value -> Either String Asset Source #
Eq Asset Source #
Instance details Defined in Wire.API.User.Profile Methods (==) :: Asset -> Asset -> Bool # (/=) :: Asset -> Asset -> Bool #
Ord Asset Source #
Instance details Defined in Wire.API.User.Profile Methods compare :: Asset -> Asset -> Ordering # (<) :: Asset -> Asset -> Bool # (<=) :: Asset -> Asset -> Bool # (>) :: Asset -> Asset -> Bool # (>=) :: Asset -> Asset -> Bool # max :: Asset -> Asset -> Asset # min :: Asset -> Asset -> Asset #
ToSchema Asset Source #
Instance details Defined in Wire.API.User.Profile Methods declareNamedSchema :: Proxy Asset -> Declare (Definitions Schema) NamedSchema Source #
ToSchema Asset Source #
Instance details Defined in Wire.API.User.Profile Methods schema :: ValueSchema NamedSwaggerDoc Asset Source #
type Rep Asset Source #
Instance details Defined in Wire.API.User.Profile type Rep Asset = D1 ('MetaData "Asset" "Wire.API.User.Profile" "wire-api-0.1.0-EbZS9CKNOfZ8BBy5DRJfXi" 'False) (C1 ('MetaCons "ImageAsset" 'PrefixI 'True) (S1 ('MetaSel ('Just "assetKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AssetKey) :*: S1 ('MetaSel ('Just "assetSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AssetSize))))

data AssetSize Source #

Constructors

AssetComplete
AssetPreview

Instances

Instances details

Arbitrary AssetSize Source #
Instance details Defined in Wire.API.User.Profile Methods arbitrary :: Gen AssetSize Source # shrink :: AssetSize -> [AssetSize] Source #
FromJSON AssetSize Source #
Instance details Defined in Wire.API.User.Profile Methods parseJSON :: Value -> Parser AssetSize Source # parseJSONList :: Value -> Parser [AssetSize] Source #
ToJSON AssetSize Source #
Instance details Defined in Wire.API.User.Profile Methods toJSON :: AssetSize -> Value Source # toEncoding :: AssetSize -> Encoding Source # toJSONList :: [AssetSize] -> Value Source # toEncodingList :: [AssetSize] -> Encoding Source #
Generic AssetSize Source #
Instance details Defined in Wire.API.User.Profile Associated Types type Rep AssetSize :: Type -> Type # Methods from :: AssetSize -> Rep AssetSize x # to :: Rep AssetSize x -> AssetSize #
Show AssetSize Source #
Instance details Defined in Wire.API.User.Profile Methods showsPrec :: Int -> AssetSize -> ShowS # show :: AssetSize -> String # showList :: [AssetSize] -> ShowS #
Cql AssetSize Source #
Instance details Defined in Wire.API.User.Profile Methods ctype :: Tagged AssetSize ColumnType Source # toCql :: AssetSize -> Value Source # fromCql :: Value -> Either String AssetSize Source #
Eq AssetSize Source #
Instance details Defined in Wire.API.User.Profile Methods (==) :: AssetSize -> AssetSize -> Bool # (/=) :: AssetSize -> AssetSize -> Bool #
Ord AssetSize Source #
Instance details Defined in Wire.API.User.Profile Methods compare :: AssetSize -> AssetSize -> Ordering # (<) :: AssetSize -> AssetSize -> Bool # (<=) :: AssetSize -> AssetSize -> Bool # (>) :: AssetSize -> AssetSize -> Bool # (>=) :: AssetSize -> AssetSize -> Bool # max :: AssetSize -> AssetSize -> AssetSize # min :: AssetSize -> AssetSize -> AssetSize #
ToSchema AssetSize Source #
Instance details Defined in Wire.API.User.Profile Methods declareNamedSchema :: Proxy AssetSize -> Declare (Definitions Schema) NamedSchema Source #
ToSchema AssetSize Source #
Instance details Defined in Wire.API.User.Profile Methods schema :: ValueSchema NamedSwaggerDoc AssetSize Source #
type Rep AssetSize Source #
Instance details Defined in Wire.API.User.Profile type Rep AssetSize = D1 ('MetaData "AssetSize" "Wire.API.User.Profile" "wire-api-0.1.0-EbZS9CKNOfZ8BBy5DRJfXi" 'False) (C1 ('MetaCons "AssetComplete" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "AssetPreview" 'PrefixI 'False) (U1 :: Type -> Type))

ManagedBy

data ManagedBy Source #

Who controls changes to the user profile (where the profile is defined as "all user-editable, user-visible attributes"). See {#SparBrainDump}.

Constructors

ManagedByWire

The profile can be changed in-app; user doesn't show up via SCIM at all.

ManagedByScim

The profile can only be changed via SCIM, with several exceptions:

User properties can still be set (because they are used internally by clients and none of them can be modified via SCIM now or in the future).
Password can be changed by the user (SCIM doesn't support setting passwords yet, but currently SCIM only works with SSO-users who don't even have passwords).
The user can still be deleted normally (SCIM doesn't support deleting users yet; but it's questionable whether this should even count as a change of a user profile).

There are some other things that SCIM can't do yet, like setting accent IDs, but they are not essential, unlike e.g. passwords.

Instances

Instances details

Arbitrary ManagedBy Source #
Instance details Defined in Wire.API.User.Profile Methods arbitrary :: Gen ManagedBy Source # shrink :: ManagedBy -> [ManagedBy] Source #
FromJSON ManagedBy Source #
Instance details Defined in Wire.API.User.Profile Methods parseJSON :: Value -> Parser ManagedBy Source # parseJSONList :: Value -> Parser [ManagedBy] Source #
ToJSON ManagedBy Source #
Instance details Defined in Wire.API.User.Profile Methods toJSON :: ManagedBy -> Value Source # toEncoding :: ManagedBy -> Encoding Source # toJSONList :: [ManagedBy] -> Value Source # toEncodingList :: [ManagedBy] -> Encoding Source #
Bounded ManagedBy Source #
Instance details Defined in Wire.API.User.Profile Methods minBound :: ManagedBy # maxBound :: ManagedBy #
Enum ManagedBy Source #
Instance details Defined in Wire.API.User.Profile Methods succ :: ManagedBy -> ManagedBy # pred :: ManagedBy -> ManagedBy # toEnum :: Int -> ManagedBy # fromEnum :: ManagedBy -> Int # enumFrom :: ManagedBy -> [ManagedBy] # enumFromThen :: ManagedBy -> ManagedBy -> [ManagedBy] # enumFromTo :: ManagedBy -> ManagedBy -> [ManagedBy] # enumFromThenTo :: ManagedBy -> ManagedBy -> ManagedBy -> [ManagedBy] #
Generic ManagedBy Source #
Instance details Defined in Wire.API.User.Profile Associated Types type Rep ManagedBy :: Type -> Type # Methods from :: ManagedBy -> Rep ManagedBy x # to :: Rep ManagedBy x -> ManagedBy #
Show ManagedBy Source #
Instance details Defined in Wire.API.User.Profile Methods showsPrec :: Int -> ManagedBy -> ShowS # show :: ManagedBy -> String # showList :: [ManagedBy] -> ShowS #
FromByteString ManagedBy Source #
Instance details Defined in Wire.API.User.Profile Methods parser :: Parser ManagedBy Source #
ToByteString ManagedBy Source #
Instance details Defined in Wire.API.User.Profile Methods builder :: ManagedBy -> Builder Source #
Cql ManagedBy Source #
Instance details Defined in Wire.API.User.Profile Methods ctype :: Tagged ManagedBy ColumnType Source # toCql :: ManagedBy -> Value Source # fromCql :: Value -> Either String ManagedBy Source #
Eq ManagedBy Source #
Instance details Defined in Wire.API.User.Profile Methods (==) :: ManagedBy -> ManagedBy -> Bool # (/=) :: ManagedBy -> ManagedBy -> Bool #
Ord ManagedBy Source #
Instance details Defined in Wire.API.User.Profile Methods compare :: ManagedBy -> ManagedBy -> Ordering # (<) :: ManagedBy -> ManagedBy -> Bool # (<=) :: ManagedBy -> ManagedBy -> Bool # (>) :: ManagedBy -> ManagedBy -> Bool # (>=) :: ManagedBy -> ManagedBy -> Bool # max :: ManagedBy -> ManagedBy -> ManagedBy # min :: ManagedBy -> ManagedBy -> ManagedBy #
ToSchema ManagedBy Source #
Instance details Defined in Wire.API.User.Profile Methods declareNamedSchema :: Proxy ManagedBy -> Declare (Definitions Schema) NamedSchema Source #
ToSchema ManagedBy Source #
Instance details Defined in Wire.API.User.Profile Methods schema :: ValueSchema NamedSwaggerDoc ManagedBy Source #
type Rep ManagedBy Source #
Instance details Defined in Wire.API.User.Profile type Rep ManagedBy = D1 ('MetaData "ManagedBy" "Wire.API.User.Profile" "wire-api-0.1.0-EbZS9CKNOfZ8BBy5DRJfXi" 'False) (C1 ('MetaCons "ManagedByWire" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ManagedByScim" 'PrefixI 'False) (U1 :: Type -> Type))

defaultManagedBy :: ManagedBy Source #

Deprecated

newtype Pict Source #

DEPRECATED

Constructors

Pict
Fields fromPict :: [Object]

Instances

Instances details

Arbitrary Pict Source #
Instance details Defined in Wire.API.User.Profile Methods arbitrary :: Gen Pict Source # shrink :: Pict -> [Pict] Source #
FromJSON Pict Source #
Instance details Defined in Wire.API.User.Profile Methods parseJSON :: Value -> Parser Pict Source # parseJSONList :: Value -> Parser [Pict] Source #
ToJSON Pict Source #
Instance details Defined in Wire.API.User.Profile Methods toJSON :: Pict -> Value Source # toEncoding :: Pict -> Encoding Source # toJSONList :: [Pict] -> Value Source # toEncodingList :: [Pict] -> Encoding Source #
Generic Pict Source #
Instance details Defined in Wire.API.User.Profile Associated Types type Rep Pict :: Type -> Type # Methods from :: Pict -> Rep Pict x # to :: Rep Pict x -> Pict #
Show Pict Source #
Instance details Defined in Wire.API.User.Profile Methods showsPrec :: Int -> Pict -> ShowS # show :: Pict -> String # showList :: [Pict] -> ShowS #
Cql Pict Source #
Instance details Defined in Wire.API.User.Profile Methods ctype :: Tagged Pict ColumnType Source # toCql :: Pict -> Value Source # fromCql :: Value -> Either String Pict Source #
Eq Pict Source #
Instance details Defined in Wire.API.User.Profile Methods (==) :: Pict -> Pict -> Bool # (/=) :: Pict -> Pict -> Bool #
Ord Pict Source #
Instance details Defined in Wire.API.User.Profile Methods compare :: Pict -> Pict -> Ordering # (<) :: Pict -> Pict -> Bool # (<=) :: Pict -> Pict -> Bool # (>) :: Pict -> Pict -> Bool # (>=) :: Pict -> Pict -> Bool # max :: Pict -> Pict -> Pict # min :: Pict -> Pict -> Pict #
ToSchema Pict Source #
Instance details Defined in Wire.API.User.Profile Methods declareNamedSchema :: Proxy Pict -> Declare (Definitions Schema) NamedSchema Source #
ToSchema Pict Source #
Instance details Defined in Wire.API.User.Profile Methods schema :: ValueSchema NamedSwaggerDoc Pict Source #
type Rep Pict Source #
Instance details Defined in Wire.API.User.Profile type Rep Pict = D1 ('MetaData "Pict" "Wire.API.User.Profile" "wire-api-0.1.0-EbZS9CKNOfZ8BBy5DRJfXi" 'True) (C1 ('MetaCons "Pict" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromPict") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Object])))

noPict :: Pict Source #