wire-api-federation-0.1.0: The Wire server-to-server API for federation
Safe HaskellSafe-Inferred
LanguageGHC2021

Wire.API.Federation.API.Brig

Synopsis

Documentation

data SearchRequest Source #

Constructors

SearchRequest 

Fields

  • term :: Text
     
  • from :: Maybe TeamId

    The searcher's team ID, used to matched against the remote backend's team federation policy.

  • onlyInTeams :: Maybe [TeamId]

    The remote teams that the calling backend is allowed to federate with.

Instances

Instances details
Arbitrary SearchRequest Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

FromJSON SearchRequest Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

ToJSON SearchRequest Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

Generic SearchRequest Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

Associated Types

type Rep SearchRequest :: Type -> Type #

Show SearchRequest Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

Eq SearchRequest Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

ToSchema SearchRequest Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

type Rep SearchRequest Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

type Rep SearchRequest = D1 ('MetaData "SearchRequest" "Wire.API.Federation.API.Brig" "wire-api-federation-0.1.0-ARZyNQKMq4lCWdaEdWVlig" 'False) (C1 ('MetaCons "SearchRequest" 'PrefixI 'True) (S1 ('MetaSel ('Just "term") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "from") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe TeamId)) :*: S1 ('MetaSel ('Just "onlyInTeams") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [TeamId])))))

data SearchResponse Source #

Instances

Instances details
FromJSON SearchResponse Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

ToJSON SearchResponse Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

Generic SearchResponse Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

Associated Types

type Rep SearchResponse :: Type -> Type #

Show SearchResponse Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

ToSchema SearchResponse Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

type Rep SearchResponse Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

type Rep SearchResponse = D1 ('MetaData "SearchResponse" "Wire.API.Federation.API.Brig" "wire-api-federation-0.1.0-ARZyNQKMq4lCWdaEdWVlig" 'False) (C1 ('MetaCons "SearchResponse" 'PrefixI 'True) (S1 ('MetaSel ('Just "contacts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Contact]) :*: S1 ('MetaSel ('Just "searchPolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FederatedUserSearchPolicy)))

type BrigApi = FedEndpoint "api-version" () VersionInfo :<|> (FedEndpoint "get-user-by-handle" Handle (Maybe UserProfile) :<|> (FedEndpoint "get-users-by-ids" [UserId] [UserProfile] :<|> (FedEndpoint "claim-prekey" (UserId, ClientId) (Maybe ClientPrekey) :<|> (FedEndpoint "claim-prekey-bundle" UserId PrekeyBundle :<|> (FedEndpoint "claim-multi-prekey-bundle" UserClients UserClientPrekeyMap :<|> (FedEndpoint "search-users" SearchRequest SearchResponse :<|> (FedEndpoint "get-user-clients" GetUserClients (UserMap (Set PubClient)) :<|> (FedEndpointWithMods '[Until V1] (Versioned 'V0 "get-mls-clients") MLSClientsRequestV0 (Set ClientInfo) :<|> (FedEndpointWithMods '[From V1] "get-mls-clients" MLSClientsRequest (Set ClientInfo) :<|> (FedEndpoint "send-connection-action" NewConnectionRequest NewConnectionResponse :<|> (FedEndpoint "claim-key-packages" ClaimKeyPackageRequest (Maybe KeyPackageBundle) :<|> (FedEndpoint "get-not-fully-connected-backends" DomainSet NonConnectedBackends :<|> BrigNotificationAPI)))))))))))) Source #

For conventions see docsdeveloper/federation-api-conventions.md

newtype GetUserClients Source #

Constructors

GetUserClients 

Fields

Instances

Instances details
FromJSON GetUserClients Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

ToJSON GetUserClients Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

Generic GetUserClients Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

Associated Types

type Rep GetUserClients :: Type -> Type #

Show GetUserClients Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

Eq GetUserClients Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

ToSchema GetUserClients Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

type Rep GetUserClients Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

type Rep GetUserClients = D1 ('MetaData "GetUserClients" "Wire.API.Federation.API.Brig" "wire-api-federation-0.1.0-ARZyNQKMq4lCWdaEdWVlig" 'True) (C1 ('MetaCons "GetUserClients" 'PrefixI 'True) (S1 ('MetaSel ('Just "users") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [UserId])))

data MLSClientsRequestV0 Source #

Instances

Instances details
FromJSON MLSClientsRequestV0 Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

ToJSON MLSClientsRequestV0 Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

Generic MLSClientsRequestV0 Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

Associated Types

type Rep MLSClientsRequestV0 :: Type -> Type #

Show MLSClientsRequestV0 Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

Eq MLSClientsRequestV0 Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

ToSchema MLSClientsRequestV0 Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

type Rep MLSClientsRequestV0 Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

type Rep MLSClientsRequestV0 = D1 ('MetaData "MLSClientsRequestV0" "Wire.API.Federation.API.Brig" "wire-api-federation-0.1.0-ARZyNQKMq4lCWdaEdWVlig" 'False) (C1 ('MetaCons "MLSClientsRequestV0" 'PrefixI 'True) (S1 ('MetaSel ('Just "userId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UserId) :*: S1 ('MetaSel ('Just "signatureScheme") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SignatureSchemeTag)))

data MLSClientsRequest Source #

Instances

Instances details
FromJSON MLSClientsRequest Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

ToJSON MLSClientsRequest Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

Generic MLSClientsRequest Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

Associated Types

type Rep MLSClientsRequest :: Type -> Type #

Show MLSClientsRequest Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

Eq MLSClientsRequest Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

ToSchema MLSClientsRequest Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

type Rep MLSClientsRequest Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

type Rep MLSClientsRequest = D1 ('MetaData "MLSClientsRequest" "Wire.API.Federation.API.Brig" "wire-api-federation-0.1.0-ARZyNQKMq4lCWdaEdWVlig" 'False) (C1 ('MetaCons "MLSClientsRequest" 'PrefixI 'True) (S1 ('MetaSel ('Just "userId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UserId) :*: S1 ('MetaSel ('Just "cipherSuite") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CipherSuite)))

data NewConnectionRequest Source #

Constructors

NewConnectionRequest 

Fields

Instances

Instances details
Arbitrary NewConnectionRequest Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

FromJSON NewConnectionRequest Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

ToJSON NewConnectionRequest Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

Generic NewConnectionRequest Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

Associated Types

type Rep NewConnectionRequest :: Type -> Type #

Show NewConnectionRequest Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

Eq NewConnectionRequest Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

ToSchema NewConnectionRequest Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

type Rep NewConnectionRequest Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

type Rep NewConnectionRequest = D1 ('MetaData "NewConnectionRequest" "Wire.API.Federation.API.Brig" "wire-api-federation-0.1.0-ARZyNQKMq4lCWdaEdWVlig" 'False) (C1 ('MetaCons "NewConnectionRequest" 'PrefixI 'True) ((S1 ('MetaSel ('Just "from") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UserId) :*: S1 ('MetaSel ('Just "fromTeam") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe TeamId))) :*: (S1 ('MetaSel ('Just "to") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UserId) :*: S1 ('MetaSel ('Just "action") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 RemoteConnectionAction))))

data NewConnectionResponse Source #

Instances

Instances details
Arbitrary NewConnectionResponse Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

FromJSON NewConnectionResponse Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

ToJSON NewConnectionResponse Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

Generic NewConnectionResponse Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

Associated Types

type Rep NewConnectionResponse :: Type -> Type #

Show NewConnectionResponse Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

Eq NewConnectionResponse Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

ToSchema NewConnectionResponse Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

type Rep NewConnectionResponse Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

type Rep NewConnectionResponse = D1 ('MetaData "NewConnectionResponse" "Wire.API.Federation.API.Brig" "wire-api-federation-0.1.0-ARZyNQKMq4lCWdaEdWVlig" 'False) (C1 ('MetaCons "NewConnectionResponseUserNotActivated" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "NewConnectionResponseNotFederating" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "NewConnectionResponseOk" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe RemoteConnectionAction)))))

data ClaimKeyPackageRequest Source #

Constructors

ClaimKeyPackageRequest 

Fields

  • claimant :: UserId

    The user making the request, implictly qualified by the origin domain.

  • target :: UserId

    The user whose key packages are being claimed, implictly qualified by the target domain.

  • cipherSuite :: CipherSuite

    The ciphersuite of the key packages being claimed.

Instances

Instances details
Arbitrary ClaimKeyPackageRequest Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

FromJSON ClaimKeyPackageRequest Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

ToJSON ClaimKeyPackageRequest Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

Generic ClaimKeyPackageRequest Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

Associated Types

type Rep ClaimKeyPackageRequest :: Type -> Type #

Show ClaimKeyPackageRequest Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

Eq ClaimKeyPackageRequest Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

ToSchema ClaimKeyPackageRequest Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

type Rep ClaimKeyPackageRequest Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

type Rep ClaimKeyPackageRequest = D1 ('MetaData "ClaimKeyPackageRequest" "Wire.API.Federation.API.Brig" "wire-api-federation-0.1.0-ARZyNQKMq4lCWdaEdWVlig" 'False) (C1 ('MetaCons "ClaimKeyPackageRequest" 'PrefixI 'True) (S1 ('MetaSel ('Just "claimant") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UserId) :*: (S1 ('MetaSel ('Just "target") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UserId) :*: S1 ('MetaSel ('Just "cipherSuite") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CipherSuite))))

newtype DomainSet Source #

Constructors

DomainSet 

Fields

Instances

Instances details
FromJSON DomainSet Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

ToJSON DomainSet Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

Generic DomainSet Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

Associated Types

type Rep DomainSet :: Type -> Type #

Show DomainSet Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

Eq DomainSet Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

ToSchema DomainSet Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

type Rep DomainSet Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

type Rep DomainSet = D1 ('MetaData "DomainSet" "Wire.API.Federation.API.Brig" "wire-api-federation-0.1.0-ARZyNQKMq4lCWdaEdWVlig" 'True) (C1 ('MetaCons "DomainSet" 'PrefixI 'True) (S1 ('MetaSel ('Just "domains") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Set Domain))))

newtype NonConnectedBackends Source #

Instances

Instances details
FromJSON NonConnectedBackends Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

ToJSON NonConnectedBackends Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

Generic NonConnectedBackends Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

Associated Types

type Rep NonConnectedBackends :: Type -> Type #

Show NonConnectedBackends Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

Eq NonConnectedBackends Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

ToSchema NonConnectedBackends Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

type Rep NonConnectedBackends Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

type Rep NonConnectedBackends = D1 ('MetaData "NonConnectedBackends" "Wire.API.Federation.API.Brig" "wire-api-federation-0.1.0-ARZyNQKMq4lCWdaEdWVlig" 'True) (C1 ('MetaCons "NonConnectedBackends" 'PrefixI 'True) (S1 ('MetaSel ('Just "nonConnectedBackends") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Set Domain))))

data RemoteConnectionAction Source #

Instances

Instances details
Arbitrary RemoteConnectionAction Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

FromJSON RemoteConnectionAction Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

ToJSON RemoteConnectionAction Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

Generic RemoteConnectionAction Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

Associated Types

type Rep RemoteConnectionAction :: Type -> Type #

Show RemoteConnectionAction Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

Eq RemoteConnectionAction Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

ToSchema RemoteConnectionAction Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

type Rep RemoteConnectionAction Source # 
Instance details

Defined in Wire.API.Federation.API.Brig

type Rep RemoteConnectionAction = D1 ('MetaData "RemoteConnectionAction" "Wire.API.Federation.API.Brig" "wire-api-federation-0.1.0-ARZyNQKMq4lCWdaEdWVlig" 'False) (C1 ('MetaCons "RemoteConnect" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "RemoteRescind" 'PrefixI 'False) (U1 :: Type -> Type))