Safe Haskell | Safe-Inferred |
---|---|
Language | GHC2021 |
Types for the (internal) provider API.
FUTUREWORK: Deduplicate with User
?
Synopsis
- data Provider = Provider {}
- newtype ProviderProfile = ProviderProfile Provider
- data NewProvider = NewProvider {}
- data NewProviderResponse = NewProviderResponse {}
- data UpdateProvider = UpdateProvider {}
- newtype ProviderActivationResponse = ProviderActivationResponse {}
- data ProviderLogin = ProviderLogin {}
- newtype DeleteProvider = DeleteProvider {}
- newtype PasswordReset = PasswordReset {}
- data CompletePasswordReset = CompletePasswordReset {}
- data PasswordChange = PasswordChange {}
- newtype EmailUpdate = EmailUpdate {}
- newtype HttpsUrl = HttpsUrl {}
- newtype ServiceToken = ServiceToken AsciiBase64Url
- data ServiceTag
- = AudioTag
- | BooksTag
- | BusinessTag
- | DesignTag
- | EducationTag
- | EntertainmentTag
- | FinanceTag
- | FitnessTag
- | FoodDrinkTag
- | GamesTag
- | GraphicsTag
- | HealthTag
- | IntegrationTag
- | LifestyleTag
- | MediaTag
- | MedicalTag
- | MoviesTag
- | MusicTag
- | NewsTag
- | PhotographyTag
- | PollTag
- | ProductivityTag
- | QuizTag
- | RatingTag
- | ShoppingTag
- | SocialTag
- | SportsTag
- | TravelTag
- | TutorialTag
- | VideoTag
- | WeatherTag
Provider
Full provider definition as seen by a verified provider itself.
Instances
newtype ProviderProfile Source #
A provider profile as seen by regular users. Note: This is a placeholder that may evolve to contain only a subset of the full provider information.
Instances
Arbitrary ProviderProfile Source # | |
Defined in Wire.API.Provider | |
FromJSON ProviderProfile Source # | |
Defined in Wire.API.Provider parseJSON :: Value -> Parser ProviderProfile Source # parseJSONList :: Value -> Parser [ProviderProfile] Source # | |
ToJSON ProviderProfile Source # | |
Defined in Wire.API.Provider toJSON :: ProviderProfile -> Value Source # toEncoding :: ProviderProfile -> Encoding Source # toJSONList :: [ProviderProfile] -> Value Source # toEncodingList :: [ProviderProfile] -> Encoding Source # | |
Show ProviderProfile Source # | |
Defined in Wire.API.Provider showsPrec :: Int -> ProviderProfile -> ShowS # show :: ProviderProfile -> String # showList :: [ProviderProfile] -> ShowS # | |
Eq ProviderProfile Source # | |
Defined in Wire.API.Provider (==) :: ProviderProfile -> ProviderProfile -> Bool # (/=) :: ProviderProfile -> ProviderProfile -> Bool # | |
ToSchema ProviderProfile Source # | |
Defined in Wire.API.Provider |
NewProvider
data NewProvider Source #
Input data for registering a new provider.
NewProvider | |
|
Instances
data NewProviderResponse Source #
Response data upon registering a new provider.
NewProviderResponse | |
|
Instances
UpdateProvider
data UpdateProvider Source #
Input data for updating general provider information.
Instances
ProviderActivationResponse
newtype ProviderActivationResponse Source #
Successful response upon activating an email address (or possibly phone number in the future) of a provider.
Instances
Arbitrary ProviderActivationResponse Source # | |
FromJSON ProviderActivationResponse Source # | |
Defined in Wire.API.Provider | |
ToJSON ProviderActivationResponse Source # | |
Defined in Wire.API.Provider | |
Show ProviderActivationResponse Source # | |
Defined in Wire.API.Provider showsPrec :: Int -> ProviderActivationResponse -> ShowS # show :: ProviderActivationResponse -> String # showList :: [ProviderActivationResponse] -> ShowS # | |
Eq ProviderActivationResponse Source # | |
Defined in Wire.API.Provider | |
ToSchema ProviderActivationResponse Source # | |
Defined in Wire.API.Provider | |
ToSchema ProviderActivationResponse Source # | |
data ProviderLogin Source #
Input data for a provider login request.
Instances
newtype DeleteProvider Source #
Input data for a provider deletion request. | FUTUREWORK: look into a phase out of PlainTextPassword6
Instances
Password Change/Reset
newtype PasswordReset Source #
The payload for initiating a password reset.
Instances
data CompletePasswordReset Source #
The payload for completing a password reset.
Instances
data PasswordChange Source #
The payload for changing a password.
Instances
newtype EmailUpdate Source #
The payload for updating an email address
Instances
Re-exports
newtype ServiceToken Source #
A secret bearer token used to authenticate and authorise requests towards
a Service
via inclusion in the HTTP Authorization
header.
Instances
data ServiceTag Source #
A fixed enumeration of tags for services.