wire-api-0.1.0
Safe HaskellSafe-Inferred
LanguageGHC2021

Wire.API.Provider

Description

Types for the (internal) provider API.

FUTUREWORK: Deduplicate with User?

Synopsis

Provider

data Provider Source #

Full provider definition as seen by a verified provider itself.

Instances

Instances details
Arbitrary Provider Source # 
Instance details

Defined in Wire.API.Provider

FromJSON Provider Source # 
Instance details

Defined in Wire.API.Provider

ToJSON Provider Source # 
Instance details

Defined in Wire.API.Provider

Generic Provider Source # 
Instance details

Defined in Wire.API.Provider

Associated Types

type Rep Provider :: Type -> Type #

Methods

from :: Provider -> Rep Provider x #

to :: Rep Provider x -> Provider #

Show Provider Source # 
Instance details

Defined in Wire.API.Provider

Eq Provider Source # 
Instance details

Defined in Wire.API.Provider

ToSchema Provider Source # 
Instance details

Defined in Wire.API.Provider

ToSchema Provider Source # 
Instance details

Defined in Wire.API.Provider

type Rep Provider Source # 
Instance details

Defined in Wire.API.Provider

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.

NewProvider

data NewProvider Source #

Input data for registering a new provider.

Constructors

NewProvider 

Instances

Instances details
Arbitrary NewProvider Source # 
Instance details

Defined in Wire.API.Provider

FromJSON NewProvider Source # 
Instance details

Defined in Wire.API.Provider

ToJSON NewProvider Source # 
Instance details

Defined in Wire.API.Provider

Generic NewProvider Source # 
Instance details

Defined in Wire.API.Provider

Associated Types

type Rep NewProvider :: Type -> Type #

Show NewProvider Source # 
Instance details

Defined in Wire.API.Provider

Eq NewProvider Source # 
Instance details

Defined in Wire.API.Provider

ToSchema NewProvider Source # 
Instance details

Defined in Wire.API.Provider

ToSchema NewProvider Source # 
Instance details

Defined in Wire.API.Provider

type Rep NewProvider Source # 
Instance details

Defined in Wire.API.Provider

type Rep NewProvider = D1 ('MetaData "NewProvider" "Wire.API.Provider" "wire-api-0.1.0-EbZS9CKNOfZ8BBy5DRJfXi" 'False) (C1 ('MetaCons "NewProvider" 'PrefixI 'True) ((S1 ('MetaSel ('Just "newProviderName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Name) :*: S1 ('MetaSel ('Just "newProviderEmail") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 EmailAddress)) :*: (S1 ('MetaSel ('Just "newProviderUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 HttpsUrl) :*: (S1 ('MetaSel ('Just "newProviderDescr") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Range 1 1024 Text)) :*: S1 ('MetaSel ('Just "newProviderPassword") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PlainTextPassword6))))))

data NewProviderResponse Source #

Response data upon registering a new provider.

Constructors

NewProviderResponse 

Fields

Instances

Instances details
Arbitrary NewProviderResponse Source # 
Instance details

Defined in Wire.API.Provider

FromJSON NewProviderResponse Source # 
Instance details

Defined in Wire.API.Provider

ToJSON NewProviderResponse Source # 
Instance details

Defined in Wire.API.Provider

Generic NewProviderResponse Source # 
Instance details

Defined in Wire.API.Provider

Associated Types

type Rep NewProviderResponse :: Type -> Type #

Show NewProviderResponse Source # 
Instance details

Defined in Wire.API.Provider

Eq NewProviderResponse Source # 
Instance details

Defined in Wire.API.Provider

ToSchema NewProviderResponse Source # 
Instance details

Defined in Wire.API.Provider

ToSchema NewProviderResponse Source # 
Instance details

Defined in Wire.API.Provider

type Rep NewProviderResponse Source # 
Instance details

Defined in Wire.API.Provider

type Rep NewProviderResponse = D1 ('MetaData "NewProviderResponse" "Wire.API.Provider" "wire-api-0.1.0-EbZS9CKNOfZ8BBy5DRJfXi" 'False) (C1 ('MetaCons "NewProviderResponse" 'PrefixI 'True) (S1 ('MetaSel ('Just "rsNewProviderId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ProviderId) :*: S1 ('MetaSel ('Just "rsNewProviderPassword") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PlainTextPassword8))))

UpdateProvider

data UpdateProvider Source #

Input data for updating general provider information.

Instances

Instances details
Arbitrary UpdateProvider Source # 
Instance details

Defined in Wire.API.Provider

FromJSON UpdateProvider Source # 
Instance details

Defined in Wire.API.Provider

ToJSON UpdateProvider Source # 
Instance details

Defined in Wire.API.Provider

Generic UpdateProvider Source # 
Instance details

Defined in Wire.API.Provider

Associated Types

type Rep UpdateProvider :: Type -> Type #

Show UpdateProvider Source # 
Instance details

Defined in Wire.API.Provider

Eq UpdateProvider Source # 
Instance details

Defined in Wire.API.Provider

ToSchema UpdateProvider Source # 
Instance details

Defined in Wire.API.Provider

ToSchema UpdateProvider Source # 
Instance details

Defined in Wire.API.Provider

type Rep UpdateProvider Source # 
Instance details

Defined in Wire.API.Provider

type Rep UpdateProvider = D1 ('MetaData "UpdateProvider" "Wire.API.Provider" "wire-api-0.1.0-EbZS9CKNOfZ8BBy5DRJfXi" 'False) (C1 ('MetaCons "UpdateProvider" 'PrefixI 'True) (S1 ('MetaSel ('Just "updateProviderName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Name)) :*: (S1 ('MetaSel ('Just "updateProviderUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HttpsUrl)) :*: S1 ('MetaSel ('Just "updateProviderDescr") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

ProviderActivationResponse

newtype ProviderActivationResponse Source #

Successful response upon activating an email address (or possibly phone number in the future) of a provider.

Instances

Instances details
Arbitrary ProviderActivationResponse Source # 
Instance details

Defined in Wire.API.Provider

FromJSON ProviderActivationResponse Source # 
Instance details

Defined in Wire.API.Provider

ToJSON ProviderActivationResponse Source # 
Instance details

Defined in Wire.API.Provider

Show ProviderActivationResponse Source # 
Instance details

Defined in Wire.API.Provider

Eq ProviderActivationResponse Source # 
Instance details

Defined in Wire.API.Provider

ToSchema ProviderActivationResponse Source # 
Instance details

Defined in Wire.API.Provider

ToSchema ProviderActivationResponse Source # 
Instance details

Defined in Wire.API.Provider

data ProviderLogin Source #

Input data for a provider login request.

Instances

Instances details
Arbitrary ProviderLogin Source # 
Instance details

Defined in Wire.API.Provider

FromJSON ProviderLogin Source # 
Instance details

Defined in Wire.API.Provider

ToJSON ProviderLogin Source # 
Instance details

Defined in Wire.API.Provider

Generic ProviderLogin Source # 
Instance details

Defined in Wire.API.Provider

Associated Types

type Rep ProviderLogin :: Type -> Type #

Show ProviderLogin Source # 
Instance details

Defined in Wire.API.Provider

Eq ProviderLogin Source # 
Instance details

Defined in Wire.API.Provider

ToSchema ProviderLogin Source # 
Instance details

Defined in Wire.API.Provider

ToSchema ProviderLogin Source # 
Instance details

Defined in Wire.API.Provider

type Rep ProviderLogin Source # 
Instance details

Defined in Wire.API.Provider

type Rep ProviderLogin = D1 ('MetaData "ProviderLogin" "Wire.API.Provider" "wire-api-0.1.0-EbZS9CKNOfZ8BBy5DRJfXi" 'False) (C1 ('MetaCons "ProviderLogin" 'PrefixI 'True) (S1 ('MetaSel ('Just "providerLoginEmail") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 EmailAddress) :*: S1 ('MetaSel ('Just "providerLoginPassword") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PlainTextPassword6)))

newtype DeleteProvider Source #

Input data for a provider deletion request. | FUTUREWORK: look into a phase out of PlainTextPassword6

Password Change/Reset

data CompletePasswordReset Source #

The payload for completing a password reset.

Instances

Instances details
Arbitrary CompletePasswordReset Source # 
Instance details

Defined in Wire.API.Provider

FromJSON CompletePasswordReset Source # 
Instance details

Defined in Wire.API.Provider

ToJSON CompletePasswordReset Source # 
Instance details

Defined in Wire.API.Provider

Generic CompletePasswordReset Source # 
Instance details

Defined in Wire.API.Provider

Associated Types

type Rep CompletePasswordReset :: Type -> Type #

Show CompletePasswordReset Source # 
Instance details

Defined in Wire.API.Provider

Eq CompletePasswordReset Source # 
Instance details

Defined in Wire.API.Provider

ToSchema CompletePasswordReset Source # 
Instance details

Defined in Wire.API.Provider

ToSchema CompletePasswordReset Source # 
Instance details

Defined in Wire.API.Provider

type Rep CompletePasswordReset Source # 
Instance details

Defined in Wire.API.Provider

type Rep CompletePasswordReset = D1 ('MetaData "CompletePasswordReset" "Wire.API.Provider" "wire-api-0.1.0-EbZS9CKNOfZ8BBy5DRJfXi" 'False) (C1 ('MetaCons "CompletePasswordReset" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Key) :*: (S1 ('MetaSel ('Just "code") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Value) :*: S1 ('MetaSel ('Just "password") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PlainTextPassword6))))

data PasswordChange Source #

The payload for changing a password.

Instances

Instances details
Arbitrary PasswordChange Source # 
Instance details

Defined in Wire.API.Provider

FromJSON PasswordChange Source # 
Instance details

Defined in Wire.API.Provider

ToJSON PasswordChange Source # 
Instance details

Defined in Wire.API.Provider

Generic PasswordChange Source # 
Instance details

Defined in Wire.API.Provider

Associated Types

type Rep PasswordChange :: Type -> Type #

Show PasswordChange Source # 
Instance details

Defined in Wire.API.Provider

Eq PasswordChange Source # 
Instance details

Defined in Wire.API.Provider

ToSchema PasswordChange Source # 
Instance details

Defined in Wire.API.Provider

ToSchema PasswordChange Source # 
Instance details

Defined in Wire.API.Provider

type Rep PasswordChange Source # 
Instance details

Defined in Wire.API.Provider

type Rep PasswordChange = D1 ('MetaData "PasswordChange" "Wire.API.Provider" "wire-api-0.1.0-EbZS9CKNOfZ8BBy5DRJfXi" 'False) (C1 ('MetaCons "PasswordChange" 'PrefixI 'True) (S1 ('MetaSel ('Just "oldPassword") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PlainTextPassword6) :*: S1 ('MetaSel ('Just "newPassword") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PlainTextPassword6)))

newtype EmailUpdate Source #

The payload for updating an email address

Constructors

EmailUpdate 

Fields

Instances

Instances details
Arbitrary EmailUpdate Source # 
Instance details

Defined in Wire.API.Provider

FromJSON EmailUpdate Source # 
Instance details

Defined in Wire.API.Provider

ToJSON EmailUpdate Source # 
Instance details

Defined in Wire.API.Provider

Generic EmailUpdate Source # 
Instance details

Defined in Wire.API.Provider

Associated Types

type Rep EmailUpdate :: Type -> Type #

Show EmailUpdate Source # 
Instance details

Defined in Wire.API.Provider

Eq EmailUpdate Source # 
Instance details

Defined in Wire.API.Provider

ToSchema EmailUpdate Source # 
Instance details

Defined in Wire.API.Provider

ToSchema EmailUpdate Source # 
Instance details

Defined in Wire.API.Provider

type Rep EmailUpdate Source # 
Instance details

Defined in Wire.API.Provider

type Rep EmailUpdate = D1 ('MetaData "EmailUpdate" "Wire.API.Provider" "wire-api-0.1.0-EbZS9CKNOfZ8BBy5DRJfXi" 'True) (C1 ('MetaCons "EmailUpdate" 'PrefixI 'True) (S1 ('MetaSel ('Just "email") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 EmailAddress)))

Re-exports

newtype HttpsUrl Source #

Constructors

HttpsUrl 

Instances

Instances details
Arbitrary HttpsUrl 
Instance details

Defined in Data.Misc

FromJSON HttpsUrl 
Instance details

Defined in Data.Misc

ToJSON HttpsUrl 
Instance details

Defined in Data.Misc

Generic HttpsUrl 
Instance details

Defined in Data.Misc

Associated Types

type Rep HttpsUrl :: Type -> Type #

Methods

from :: HttpsUrl -> Rep HttpsUrl x #

to :: Rep HttpsUrl x -> HttpsUrl #

Show HttpsUrl 
Instance details

Defined in Data.Misc

FromByteString HttpsUrl 
Instance details

Defined in Data.Misc

Methods

parser :: Parser HttpsUrl Source #

ToByteString HttpsUrl 
Instance details

Defined in Data.Misc

Cql HttpsUrl 
Instance details

Defined in Data.Misc

Eq HttpsUrl 
Instance details

Defined in Data.Misc

Ord HttpsUrl 
Instance details

Defined in Data.Misc

ToSchema HttpsUrl 
Instance details

Defined in Data.Misc

ToSchema HttpsUrl 
Instance details

Defined in Data.Misc

type Rep HttpsUrl 
Instance details

Defined in Data.Misc

type Rep HttpsUrl = D1 ('MetaData "HttpsUrl" "Data.Misc" "types-common-0.16.0-LkhhqucPLeMGZ2r1ZsnNqs" 'True) (C1 ('MetaCons "HttpsUrl" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpsUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (URIRef Absolute))))

newtype ServiceToken Source #

A secret bearer token used to authenticate and authorise requests towards a Service via inclusion in the HTTP Authorization header.

Instances

Instances details
Arbitrary ServiceToken Source # 
Instance details

Defined in Wire.API.Provider.Service

FromJSON ServiceToken Source # 
Instance details

Defined in Wire.API.Provider.Service

ToJSON ServiceToken Source # 
Instance details

Defined in Wire.API.Provider.Service

Generic ServiceToken Source # 
Instance details

Defined in Wire.API.Provider.Service

Associated Types

type Rep ServiceToken :: Type -> Type #

Show ServiceToken Source # 
Instance details

Defined in Wire.API.Provider.Service

FromByteString ServiceToken Source # 
Instance details

Defined in Wire.API.Provider.Service

Methods

parser :: Parser ServiceToken Source #

ToByteString ServiceToken Source # 
Instance details

Defined in Wire.API.Provider.Service

Cql ServiceToken Source # 
Instance details

Defined in Wire.API.Provider.Service

Eq ServiceToken Source # 
Instance details

Defined in Wire.API.Provider.Service

ToSchema ServiceToken Source # 
Instance details

Defined in Wire.API.Provider.Service

ToSchema ServiceToken Source # 
Instance details

Defined in Wire.API.Provider.Service

type Rep ServiceToken Source # 
Instance details

Defined in Wire.API.Provider.Service

type Rep ServiceToken = D1 ('MetaData "ServiceToken" "Wire.API.Provider.Service" "wire-api-0.1.0-EbZS9CKNOfZ8BBy5DRJfXi" 'True) (C1 ('MetaCons "ServiceToken" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AsciiBase64Url)))

data ServiceTag Source #

A fixed enumeration of tags for services.

Instances

Instances details
Arbitrary ServiceTag Source # 
Instance details

Defined in Wire.API.Provider.Service.Tag

FromJSON ServiceTag Source # 
Instance details

Defined in Wire.API.Provider.Service.Tag

ToJSON ServiceTag Source # 
Instance details

Defined in Wire.API.Provider.Service.Tag

Bounded ServiceTag Source # 
Instance details

Defined in Wire.API.Provider.Service.Tag

Enum ServiceTag Source # 
Instance details

Defined in Wire.API.Provider.Service.Tag

Generic ServiceTag Source # 
Instance details

Defined in Wire.API.Provider.Service.Tag

Associated Types

type Rep ServiceTag :: Type -> Type #

Show ServiceTag Source # 
Instance details

Defined in Wire.API.Provider.Service.Tag

FromByteString ServiceTag Source # 
Instance details

Defined in Wire.API.Provider.Service.Tag

Methods

parser :: Parser ServiceTag Source #

ToByteString ServiceTag Source # 
Instance details

Defined in Wire.API.Provider.Service.Tag

Eq ServiceTag Source # 
Instance details

Defined in Wire.API.Provider.Service.Tag

Ord ServiceTag Source # 
Instance details

Defined in Wire.API.Provider.Service.Tag

ToParamSchema ServiceTag Source # 
Instance details

Defined in Wire.API.Provider.Service.Tag

ToSchema ServiceTag Source # 
Instance details

Defined in Wire.API.Provider.Service.Tag

ToSchema ServiceTag Source # 
Instance details

Defined in Wire.API.Provider.Service.Tag

type Rep ServiceTag Source # 
Instance details

Defined in Wire.API.Provider.Service.Tag

type Rep ServiceTag = D1 ('MetaData "ServiceTag" "Wire.API.Provider.Service.Tag" "wire-api-0.1.0-EbZS9CKNOfZ8BBy5DRJfXi" 'False) ((((C1 ('MetaCons "AudioTag" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "BooksTag" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "BusinessTag" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "DesignTag" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "EducationTag" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "EntertainmentTag" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "FinanceTag" 'PrefixI 'False) (U1 :: Type -> Type)))) :+: (((C1 ('MetaCons "FitnessTag" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "FoodDrinkTag" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "GamesTag" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "GraphicsTag" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "HealthTag" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "IntegrationTag" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "LifestyleTag" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "MediaTag" 'PrefixI 'False) (U1 :: Type -> Type))))) :+: ((((C1 ('MetaCons "MedicalTag" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "MoviesTag" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "MusicTag" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "NewsTag" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "PhotographyTag" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PollTag" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "ProductivityTag" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "QuizTag" 'PrefixI 'False) (U1 :: Type -> Type)))) :+: (((C1 ('MetaCons "RatingTag" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ShoppingTag" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "SocialTag" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "SportsTag" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "TravelTag" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "TutorialTag" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "VideoTag" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "WeatherTag" 'PrefixI 'False) (U1 :: Type -> Type))))))