Safe Haskell	Safe-Inferred
Language	GHC2021

API.Brig

Synopsis

data AddUser = AddUser {
- name :: Maybe String
- email :: Maybe String
- teamCode :: Maybe String
- password :: Maybe String
}
data NewProvider = NewProvider {
- newProviderName :: String
- newProviderDesc :: String
- newProviderEmail :: String
- newProviderPassword :: Maybe String
- newProviderUrl :: String
}
data NewService = NewService {
- newServiceName :: String
- newServiceSummary :: String
- newServiceDescr :: String
- newServiceUrl :: String
- newServiceKey :: ByteString
- newServiceToken :: Maybe String
- newServiceAssets :: [String]
- newServiceTags :: [String]
}
addUser :: (HasCallStack, MakesValue dom) => dom -> AddUser -> App Response
getUser :: (HasCallStack, MakesValue user, MakesValue target) => user -> target -> App Response
getClient :: (HasCallStack, MakesValue user, MakesValue client) => user -> client -> App Response
getSelfClients :: (HasCallStack, MakesValue user) => user -> App Response
deleteUser :: (HasCallStack, MakesValue user) => user -> App Response
addClient :: (HasCallStack, MakesValue user) => user -> AddClient -> App Response
data UpdateClient = UpdateClient {
- prekeys :: [Value]
- lastPrekey :: Maybe Value
- label :: Maybe String
- capabilities :: Maybe [String]
- mlsPublicKeys :: Maybe Value
}
updateClient :: HasCallStack => ClientIdentity -> UpdateClient -> App Response
deleteClient :: (HasCallStack, MakesValue user, MakesValue client) => user -> client -> App Response
getClientsQualified :: (HasCallStack, MakesValue user, MakesValue domain, MakesValue otherUser) => user -> domain -> otherUser -> App Response
listUsersClients :: (HasCallStack, MakesValue user, MakesValue qualifiedUserIds) => user -> [qualifiedUserIds] -> App Response
searchContacts :: (MakesValue user, MakesValue searchTerm, MakesValue domain) => user -> searchTerm -> domain -> App Response
searchTeam :: (HasCallStack, MakesValue user) => user -> String -> App Response
getAPIVersion :: (HasCallStack, MakesValue domain) => domain -> App Response
postConnection :: (HasCallStack, MakesValue userFrom, MakesValue userTo) => userFrom -> userTo -> App Response
getConnection :: (HasCallStack, MakesValue userFrom, MakesValue userTo) => userFrom -> userTo -> App Response
putConnection :: (HasCallStack, MakesValue userFrom, MakesValue userTo, MakesValue status) => userFrom -> userTo -> status -> App Response
getConnections :: (HasCallStack, MakesValue user) => user -> App Response
uploadKeyPackages :: ClientIdentity -> [ByteString] -> App Response
claimKeyPackagesWithParams :: (MakesValue u, MakesValue v) => Ciphersuite -> u -> v -> [(String, String)] -> App Response
claimKeyPackages :: (HasCallStack, MakesValue u, MakesValue v) => Ciphersuite -> u -> v -> App Response
countKeyPackages :: Ciphersuite -> ClientIdentity -> App Response
deleteKeyPackages :: ClientIdentity -> [String] -> App Response
replaceKeyPackages :: ClientIdentity -> Maybe [Ciphersuite] -> [ByteString] -> App Response
getSelf :: (HasCallStack, MakesValue user) => user -> App Response
getSelfWithVersion :: (HasCallStack, MakesValue user) => Versioned -> user -> App Response
getSelf' :: HasCallStack => String -> String -> App Response
data PutSelf = PutSelf {
- accent :: Maybe Int
- assets :: Maybe [Value]
- name :: Maybe String
- picture :: Maybe [String]
}
putSelf :: (HasCallStack, MakesValue caller) => caller -> PutSelf -> App Response
putSelfLocale :: (HasCallStack, MakesValue caller) => caller -> String -> App Response
putSelfEmail :: (HasCallStack, MakesValue caller) => caller -> String -> App Response
deleteSelfEmail :: (HasCallStack, MakesValue caller) => caller -> App Response
putHandle :: (HasCallStack, MakesValue user) => user -> String -> App Response
getUserSupportedProtocols :: (HasCallStack, MakesValue user, MakesValue target) => user -> target -> App Response
putUserSupportedProtocols :: (HasCallStack, MakesValue user) => user -> [String] -> App Response
data PostInvitation = PostInvitation {
- email :: Maybe String
- role :: Maybe String
}
postInvitation :: (HasCallStack, MakesValue user) => user -> PostInvitation -> App Response
getApiVersions :: HasCallStack => App Response
getSwaggerPublicTOC :: HasCallStack => App Response
getSwaggerPublicAllUI :: HasCallStack => Int -> App Response
getSwaggerPublicAllJson :: HasCallStack => Int -> App Response
getSwaggerInternalUI :: HasCallStack => String -> App Response
getSwaggerInternalJson :: HasCallStack => String -> App Response
newProvider :: (HasCallStack, MakesValue provider, MakesValue user) => user -> provider -> App Value
activateProvider :: (HasCallStack, MakesValue dom) => dom -> String -> String -> App ()
activateUserV5 :: (HasCallStack, MakesValue dom, MakesValue bdy) => dom -> bdy -> App Response
loginProvider :: (HasCallStack, MakesValue dom) => dom -> String -> String -> App ByteString
newService :: (HasCallStack, MakesValue dom) => dom -> String -> NewService -> App Value
updateService :: (HasCallStack, MakesValue dom, MakesValue serviceId) => dom -> String -> serviceId -> Maybe String -> Maybe String -> App Response
updateServiceConn :: MakesValue conn => String -> String -> conn -> App Response
getUsersPrekeysClient :: (HasCallStack, MakesValue caller, MakesValue targetUser) => caller -> targetUser -> String -> App Response
getUsersPrekeyBundle :: (HasCallStack, MakesValue caller, MakesValue targetUser) => caller -> targetUser -> App Response
getMultiUserPrekeyBundle :: (HasCallStack, MakesValue caller, ToJSON userClients) => caller -> userClients -> App Response
renewToken :: (HasCallStack, MakesValue uid) => uid -> String -> App Response
getCallsConfigV2 :: (HasCallStack, MakesValue user) => user -> App Response
addBot :: (HasCallStack, MakesValue user) => user -> String -> String -> String -> App Response
setProperty :: (MakesValue user, ToJSON val) => user -> String -> val -> App Response
getProperty :: MakesValue user => user -> String -> App Response
deleteProperty :: MakesValue user => user -> String -> App Response
getAllPropertyNames :: MakesValue user => user -> App Response
getAllPropertyValues :: MakesValue user => user -> App Response
clearProperties :: MakesValue user => user -> App Response
generateOAuthAuthorizationCode :: (HasCallStack, MakesValue user, MakesValue cid) => user -> cid -> [String] -> String -> App Response
createOAuthAccessToken :: (HasCallStack, MakesValue user, MakesValue cid) => user -> cid -> String -> String -> App Response
createOAuthAccessTokenWithRefreshToken :: (HasCallStack, MakesValue user, MakesValue cid) => user -> cid -> String -> App Response
getOAuthApplications :: (HasCallStack, MakesValue user) => user -> App Response
deleteOAuthSession :: (HasCallStack, MakesValue user, MakesValue cid) => user -> cid -> String -> String -> App Response
revokeApplicationAccessV6 :: (HasCallStack, MakesValue user, MakesValue cid) => user -> cid -> App Response
revokeApplicationAccess :: (HasCallStack, MakesValue user, MakesValue cid) => user -> cid -> String -> App Response
registerUser :: (HasCallStack, MakesValue domain) => domain -> String -> String -> App Response
activate :: (HasCallStack, MakesValue domain) => domain -> String -> String -> App Response
acceptTeamInvitation :: (HasCallStack, MakesValue user) => user -> String -> Maybe String -> App Response
listInvitations :: (HasCallStack, MakesValue user) => user -> String -> App Response
getInvitationByCode :: (HasCallStack, MakesValue user) => user -> String -> App Response
passwordReset :: (HasCallStack, MakesValue domain) => domain -> String -> App Response
completePasswordReset :: (HasCallStack, MakesValue domain) => domain -> String -> String -> String -> App Response
login :: (HasCallStack, MakesValue domain) => domain -> String -> String -> App Response
updateEmail :: (HasCallStack, MakesValue user) => user -> String -> String -> String -> App Response
upgradePersonalToTeam :: (HasCallStack, MakesValue user) => user -> String -> App Response
postServiceWhitelist :: (HasCallStack, MakesValue user, MakesValue tid, MakesValue update) => user -> tid -> update -> App Response

Documentation

data AddUser Source #

Constructors

AddUser
Fields name :: Maybe String email :: Maybe String teamCode :: Maybe String password :: Maybe String

Instances

Instances details

Default AddUser Source #
Instance details Defined in API.Brig Methods def :: AddUser Source #

data NewProvider Source #

Constructors

NewProvider
Fields newProviderName :: String newProviderDesc :: String newProviderEmail :: String newProviderPassword :: Maybe String newProviderUrl :: String

Instances

Instances details

ToJSON NewProvider Source #
Instance details Defined in API.Brig Methods toJSON :: NewProvider -> Value Source # toEncoding :: NewProvider -> Encoding Source # toJSONList :: [NewProvider] -> Value Source # toEncodingList :: [NewProvider] -> Encoding Source #
Default NewProvider Source #
Instance details Defined in API.Brig Methods def :: NewProvider Source #

data NewService Source #

Constructors

NewService
Fields newServiceName :: String newServiceSummary :: String newServiceDescr :: String newServiceUrl :: String newServiceKey :: ByteString newServiceToken :: Maybe String newServiceAssets :: [String] newServiceTags :: [String]

Instances

Instances details

ToJSON NewService Source #
Instance details Defined in API.Brig Methods toJSON :: NewService -> Value Source # toEncoding :: NewService -> Encoding Source # toJSONList :: [NewService] -> Value Source # toEncodingList :: [NewService] -> Encoding Source #
Default NewService Source #
Instance details Defined in API.Brig Methods def :: NewService Source #

addUser :: (HasCallStack, MakesValue dom) => dom -> AddUser -> App Response Source #

getUser :: (HasCallStack, MakesValue user, MakesValue target) => user -> target -> App Response Source #

https://staging-nginz-https.zinfra.io/v6/api/swagger-ui/#/default/get_users__uid_domain___uid_

getClient :: (HasCallStack, MakesValue user, MakesValue client) => user -> client -> App Response Source #

https://staging-nginz-https.zinfra.io/v5/api/swagger-ui/#/default/get_clients__client_

getSelfClients :: (HasCallStack, MakesValue user) => user -> App Response Source #

https://staging-nginz-https.zinfra.io/v6/api/swagger-ui/#/default/get_clients

deleteUser :: (HasCallStack, MakesValue user) => user -> App Response Source #

https://staging-nginz-https.zinfra.io/v5/api/swagger-ui/#/default/delete_self

addClient :: (HasCallStack, MakesValue user) => user -> AddClient -> App Response Source #

https://staging-nginz-https.zinfra.io/v5/api/swagger-ui/#/default/post_clients

data UpdateClient Source #

Constructors

UpdateClient
Fields prekeys :: [Value] lastPrekey :: Maybe Value label :: Maybe String capabilities :: Maybe [String] mlsPublicKeys :: Maybe Value

Instances

Instances details

Default UpdateClient Source #
Instance details Defined in API.Brig Methods def :: UpdateClient Source #

updateClient :: HasCallStack => ClientIdentity -> UpdateClient -> App Response Source #

deleteClient :: (HasCallStack, MakesValue user, MakesValue client) => user -> client -> App Response Source #

https://staging-nginz-https.zinfra.io/v6/api/swagger-ui/#/default/delete_clients__client_

getClientsQualified :: (HasCallStack, MakesValue user, MakesValue domain, MakesValue otherUser) => user -> domain -> otherUser -> App Response Source #

https://staging-nginz-https.zinfra.io/v5/api/swagger-ui/#/default/get_users__uid_domain___uid__clients

listUsersClients :: (HasCallStack, MakesValue user, MakesValue qualifiedUserIds) => user -> [qualifiedUserIds] -> App Response Source #

https://staging-nginz-https.zinfra.io/v5/api/swagger-ui/#/default/post_users_list_clients

searchContacts :: (MakesValue user, MakesValue searchTerm, MakesValue domain) => user -> searchTerm -> domain -> App Response Source #

searchTeam :: (HasCallStack, MakesValue user) => user -> String -> App Response Source #

https://staging-nginz-https.zinfra.io/v6/api/swagger-ui/#/default/get_teams__tid__search

getAPIVersion :: (HasCallStack, MakesValue domain) => domain -> App Response Source #

postConnection :: (HasCallStack, MakesValue userFrom, MakesValue userTo) => userFrom -> userTo -> App Response Source #

getConnection :: (HasCallStack, MakesValue userFrom, MakesValue userTo) => userFrom -> userTo -> App Response Source #

putConnection :: (HasCallStack, MakesValue userFrom, MakesValue userTo, MakesValue status) => userFrom -> userTo -> status -> App Response Source #

getConnections :: (HasCallStack, MakesValue user) => user -> App Response Source #

uploadKeyPackages :: ClientIdentity -> [ByteString] -> App Response Source #

claimKeyPackagesWithParams :: (MakesValue u, MakesValue v) => Ciphersuite -> u -> v -> [(String, String)] -> App Response Source #

claimKeyPackages :: (HasCallStack, MakesValue u, MakesValue v) => Ciphersuite -> u -> v -> App Response Source #

countKeyPackages :: Ciphersuite -> ClientIdentity -> App Response Source #

deleteKeyPackages :: ClientIdentity -> [String] -> App Response Source #

replaceKeyPackages :: ClientIdentity -> Maybe [Ciphersuite] -> [ByteString] -> App Response Source #

getSelf :: (HasCallStack, MakesValue user) => user -> App Response Source #

https://staging-nginz-https.zinfra.io/v6/api/swagger-ui/#/default/get_self

getSelfWithVersion :: (HasCallStack, MakesValue user) => Versioned -> user -> App Response Source #

getSelf' :: HasCallStack => String -> String -> App Response Source #

https://staging-nginz-https.zinfra.io/v6/api/swagger-ui/#/default/get_self this is a low-level version of getSelf for testing some error conditions.

data PutSelf Source #

Constructors

PutSelf
Fields accent :: Maybe Int assets :: Maybe [Value] name :: Maybe String picture :: Maybe [String]

Instances

Instances details

Default PutSelf Source #
Instance details Defined in API.Brig Methods def :: PutSelf Source #

putSelf :: (HasCallStack, MakesValue caller) => caller -> PutSelf -> App Response Source #

https://staging-nginz-https.zinfra.io/v6/api/swagger-ui/#/default/put_self

putSelfLocale :: (HasCallStack, MakesValue caller) => caller -> String -> App Response Source #

https://staging-nginz-https.zinfra.io/v6/api/swagger-ui/#/default/put_self_locale

putSelfEmail :: (HasCallStack, MakesValue caller) => caller -> String -> App Response Source #

https://staging-nginz-https.zinfra.io/v6/api/swagger-ui/#/default/put_users__uid__email

NOTE: the full process of changing (and confirming) the email address is more complicated. see servicesbrigtestintegration for details.

deleteSelfEmail :: (HasCallStack, MakesValue caller) => caller -> App Response Source #

https://staging-nginz-https.zinfra.io/v6/api/swagger-ui/#/default/delete_self_email

putHandle :: (HasCallStack, MakesValue user) => user -> String -> App Response Source #

https://staging-nginz-https.zinfra.io/v6/api/swagger-ui/#/default/put_self_handle FUTUREWORK: rename to putSelfHandle for consistency

getUserSupportedProtocols :: (HasCallStack, MakesValue user, MakesValue target) => user -> target -> App Response Source #

putUserSupportedProtocols :: (HasCallStack, MakesValue user) => user -> [String] -> App Response Source #

data PostInvitation Source #

Constructors

PostInvitation
Fields email :: Maybe String role :: Maybe String

Instances

Instances details

Default PostInvitation Source #
Instance details Defined in API.Brig Methods def :: PostInvitation Source #

postInvitation :: (HasCallStack, MakesValue user) => user -> PostInvitation -> App Response Source #

getApiVersions :: HasCallStack => App Response Source #

getSwaggerPublicTOC :: HasCallStack => App Response Source #

getSwaggerPublicAllUI :: HasCallStack => Int -> App Response Source #

getSwaggerPublicAllJson :: HasCallStack => Int -> App Response Source #

getSwaggerInternalUI :: HasCallStack => String -> App Response Source #

getSwaggerInternalJson :: HasCallStack => String -> App Response Source #

newProvider :: (HasCallStack, MakesValue provider, MakesValue user) => user -> provider -> App Value Source #

activateProvider :: (HasCallStack, MakesValue dom) => dom -> String -> String -> App () Source #

activateUserV5 :: (HasCallStack, MakesValue dom, MakesValue bdy) => dom -> bdy -> App Response Source #

loginProvider :: (HasCallStack, MakesValue dom) => dom -> String -> String -> App ByteString Source #

Returns the value of the Set-Cookie header that is to be used to authenticate to provider endpoints.

newService :: (HasCallStack, MakesValue dom) => dom -> String -> NewService -> App Value Source #

updateService :: (HasCallStack, MakesValue dom, MakesValue serviceId) => dom -> String -> serviceId -> Maybe String -> Maybe String -> App Response Source #

updateServiceConn Source #

Arguments

:: MakesValue conn
=> String	providerId
-> String	serviceId
-> conn	connection update as a Json object, with an obligatory "password" field
-> App Response

getUsersPrekeysClient :: (HasCallStack, MakesValue caller, MakesValue targetUser) => caller -> targetUser -> String -> App Response Source #

https://staging-nginz-https.zinfra.io/v5/api/swagger-ui/#/default/get_users__uid_domain___uid__prekeys__client_

getUsersPrekeyBundle :: (HasCallStack, MakesValue caller, MakesValue targetUser) => caller -> targetUser -> App Response Source #

https://staging-nginz-https.zinfra.io/v5/api/swagger-ui/#/default/get_users__uid_domain___uid__prekeys

getMultiUserPrekeyBundle :: (HasCallStack, MakesValue caller, ToJSON userClients) => caller -> userClients -> App Response Source #

https://staging-nginz-https.zinfra.io/v5/api/swagger-ui/#/default/post_users_list_prekeys

renewToken :: (HasCallStack, MakesValue uid) => uid -> String -> App Response Source #

https://staging-nginz-https.zinfra.io/v5/api/swagger-ui/#/default/post_access

getCallsConfigV2 :: (HasCallStack, MakesValue user) => user -> App Response Source #

https://staging-nginz-https.zinfra.io/v5/api/swagger-ui/#/default/get_calls_config_v2

addBot :: (HasCallStack, MakesValue user) => user -> String -> String -> String -> App Response Source #

setProperty :: (MakesValue user, ToJSON val) => user -> String -> val -> App Response Source #

getProperty :: MakesValue user => user -> String -> App Response Source #

deleteProperty :: MakesValue user => user -> String -> App Response Source #

getAllPropertyNames :: MakesValue user => user -> App Response Source #

getAllPropertyValues :: MakesValue user => user -> App Response Source #

clearProperties :: MakesValue user => user -> App Response Source #

generateOAuthAuthorizationCode :: (HasCallStack, MakesValue user, MakesValue cid) => user -> cid -> [String] -> String -> App Response Source #

https://staging-nginz-https.zinfra.io/v6/api/swagger-ui/#/default/post_oauth_authorization_codes

createOAuthAccessToken :: (HasCallStack, MakesValue user, MakesValue cid) => user -> cid -> String -> String -> App Response Source #

https://staging-nginz-https.zinfra.io/v6/api/swagger-ui/#/default/post_oauth_token

createOAuthAccessTokenWithRefreshToken :: (HasCallStack, MakesValue user, MakesValue cid) => user -> cid -> String -> App Response Source #

https://staging-nginz-https.zinfra.io/v6/api/swagger-ui/#/default/post_oauth_token

getOAuthApplications :: (HasCallStack, MakesValue user) => user -> App Response Source #

https://staging-nginz-https.zinfra.io/v6/api/swagger-ui/#/default/get_oauth_applications

deleteOAuthSession :: (HasCallStack, MakesValue user, MakesValue cid) => user -> cid -> String -> String -> App Response Source #

revokeApplicationAccessV6 :: (HasCallStack, MakesValue user, MakesValue cid) => user -> cid -> App Response Source #

https://staging-nginz-https.zinfra.io/v6/api/swagger-ui/#/default/delete_oauth_applications__OAuthClientId_

revokeApplicationAccess :: (HasCallStack, MakesValue user, MakesValue cid) => user -> cid -> String -> App Response Source #

registerUser :: (HasCallStack, MakesValue domain) => domain -> String -> String -> App Response Source #

activate :: (HasCallStack, MakesValue domain) => domain -> String -> String -> App Response Source #

acceptTeamInvitation :: (HasCallStack, MakesValue user) => user -> String -> Maybe String -> App Response Source #

listInvitations :: (HasCallStack, MakesValue user) => user -> String -> App Response Source #

https://staging-nginz-https.zinfra.io/v6/api/swagger-ui/#/default/get_teams__tid__invitations

getInvitationByCode :: (HasCallStack, MakesValue user) => user -> String -> App Response Source #

https://staging-nginz-https.zinfra.io/v7/api/swagger-ui/#/default/get-team-invitation-info

passwordReset :: (HasCallStack, MakesValue domain) => domain -> String -> App Response Source #

completePasswordReset :: (HasCallStack, MakesValue domain) => domain -> String -> String -> String -> App Response Source #

login :: (HasCallStack, MakesValue domain) => domain -> String -> String -> App Response Source #

updateEmail :: (HasCallStack, MakesValue user) => user -> String -> String -> String -> App Response Source #

upgradePersonalToTeam :: (HasCallStack, MakesValue user) => user -> String -> App Response Source #

postServiceWhitelist :: (HasCallStack, MakesValue user, MakesValue tid, MakesValue update) => user -> tid -> update -> App Response Source #