Safe Haskell	Safe-Inferred
Language	GHC2021

API.Galley

Synopsis

data CreateConv = CreateConv {
- qualifiedUsers :: [Value]
- name :: Maybe String
- access :: Maybe [String]
- accessRole :: Maybe [String]
- team :: Maybe String
- messageTimer :: Maybe Int
- receiptMode :: Maybe Int
- newUsersRole :: String
- protocol :: String
}
defProteus :: CreateConv
defMLS :: CreateConv
allowGuests :: CreateConv -> CreateConv
postConversation :: (HasCallStack, MakesValue user) => user -> CreateConv -> App Response
deleteTeamConversation :: (HasCallStack, MakesValue user, MakesValue conv) => String -> conv -> user -> App Response
deleteTeamMember :: (HasCallStack, MakesValue owner, MakesValue member) => String -> owner -> member -> App Response
putConversationProtocol :: (HasCallStack, MakesValue user, MakesValue protocol) => user -> ConvId -> protocol -> App Response
getConversation :: (HasCallStack, MakesValue user, MakesValue qcnv) => user -> qcnv -> App Response
getSubConversation :: (HasCallStack, MakesValue user) => user -> ConvId -> String -> App Response
deleteSubConversation :: (HasCallStack, MakesValue user, MakesValue sub) => user -> sub -> App Response
leaveSubConversation :: (HasCallStack, MakesValue user) => user -> ConvId -> App Response
getSelfConversation :: (HasCallStack, MakesValue user) => user -> App Response
data ListConversationIds = ListConversationIds {
- pagingState :: Maybe String
- size :: Maybe Int
}
listConversationIds :: MakesValue user => user -> ListConversationIds -> App Response
listConversations :: MakesValue user => user -> [Value] -> App Response
getMLSPublicKeys :: (HasCallStack, MakesValue user) => user -> App Response
getMLSPublicKeysJWK :: (HasCallStack, MakesValue user) => user -> App Response
postMLSMessage :: HasCallStack => ClientIdentity -> ByteString -> App Response
postMLSCommitBundle :: HasCallStack => ClientIdentity -> ByteString -> App Response
postProteusMessage :: (HasCallStack, MakesValue user, MakesValue conv) => user -> conv -> QualifiedNewOtrMessage -> App Response
mkProteusRecipient :: (HasCallStack, MakesValue user, MakesValue client) => user -> client -> String -> App QualifiedUserEntry
mkProteusRecipients :: (HasCallStack, MakesValue domain, MakesValue user, MakesValue client) => domain -> [(user, [client])] -> String -> App QualifiedUserEntry
getGroupInfo :: (HasCallStack, MakesValue user) => user -> ConvId -> App Response
removeConversationMember :: (HasCallStack, MakesValue user, MakesValue conv) => user -> conv -> App Response
updateConversationMember :: (HasCallStack, MakesValue user, MakesValue conv, MakesValue target) => user -> conv -> target -> String -> App Response
deleteTeamConv :: (HasCallStack, MakesValue team, MakesValue conv, MakesValue user) => team -> conv -> user -> App Response
getMLSOne2OneConversationLegacy :: (HasCallStack, MakesValue self, MakesValue other) => self -> other -> App Response
getMLSOne2OneConversation :: (HasCallStack, MakesValue self, MakesValue other) => self -> other -> App Response
getGroupClients :: (HasCallStack, MakesValue user) => user -> String -> App Response
data AddMembers = AddMembers {
- users :: [Value]
- role :: Maybe String
- version :: Maybe Int
}
addMembers :: (HasCallStack, MakesValue user, MakesValue conv) => user -> conv -> AddMembers -> App Response
removeMember :: (HasCallStack, MakesValue remover, MakesValue conv, MakesValue removed) => remover -> conv -> removed -> App Response
postConversationCode :: (HasCallStack, MakesValue user, MakesValue conv) => user -> conv -> Maybe String -> Maybe String -> App Response
getConversationCode :: (HasCallStack, MakesValue user, MakesValue conv) => user -> conv -> Maybe String -> App Response
getJoinCodeConv :: (HasCallStack, MakesValue user) => user -> String -> String -> App Response
changeConversationName :: (HasCallStack, MakesValue user, MakesValue conv, MakesValue name) => user -> conv -> name -> App Response
updateRole :: (HasCallStack, MakesValue callerUser, MakesValue targetUser, MakesValue roleUpdate, MakesValue qcnv) => callerUser -> targetUser -> roleUpdate -> qcnv -> App Response
updateReceiptMode :: (HasCallStack, MakesValue user, MakesValue conv, MakesValue mode) => user -> conv -> mode -> App Response
updateAccess :: (HasCallStack, MakesValue user, MakesValue conv) => user -> conv -> [Pair] -> App Response
updateMessageTimer :: (HasCallStack, MakesValue user, MakesValue conv) => user -> conv -> Word64 -> App Response
getTeam :: (HasCallStack, MakesValue user, MakesValue tid) => user -> tid -> App Response
getTeamMembers :: (HasCallStack, MakesValue user, MakesValue tid) => user -> tid -> App Response
data AppLockSettings = AppLockSettings {
- status :: String
- enforce :: Bool
- inactivityTimeoutSecs :: Int
}
putAppLockSettings :: (HasCallStack, MakesValue tid, MakesValue caller) => tid -> caller -> AppLockSettings -> App Response
data TeamProperties = TeamProperties {
- icon :: String
- iconKey :: String
- name :: String
- spashScreen :: String
}
putTeamProperties :: (HasCallStack, MakesValue tid, MakesValue caller) => tid -> caller -> TeamProperties -> App Response
legalholdUserStatus :: (HasCallStack, MakesValue tid, MakesValue user, MakesValue owner) => tid -> owner -> user -> App Response
disableLegalHold :: (HasCallStack, MakesValue tid, MakesValue ownerid, MakesValue uid) => tid -> ownerid -> uid -> String -> App Response
consentToLegalHold :: (HasCallStack, MakesValue tid, MakesValue zusr) => tid -> zusr -> String -> App Response
getLegalHoldStatus :: (HasCallStack, MakesValue tid, MakesValue zusr) => tid -> zusr -> App Response
getLegalHoldSettings :: (HasCallStack, MakesValue tid, MakesValue zusr) => tid -> zusr -> App Response
postLegalHoldSettings :: (HasCallStack, MakesValue ownerid, MakesValue tid, MakesValue newService) => tid -> ownerid -> newService -> App Response
requestLegalHoldDevice :: (HasCallStack, MakesValue tid, MakesValue ownerid, MakesValue uid) => tid -> ownerid -> uid -> App Response
approveLegalHoldDevice :: (HasCallStack, MakesValue tid, MakesValue uid) => tid -> uid -> String -> App Response
approveLegalHoldDevice' :: (HasCallStack, MakesValue tid, MakesValue uid, MakesValue forUid) => tid -> uid -> forUid -> String -> App Response
putLegalholdStatus :: (HasCallStack, MakesValue tid, MakesValue usr) => tid -> usr -> String -> App Response
getFeatureConfigs :: (HasCallStack, MakesValue user) => user -> App Response
getTeamFeatures :: (HasCallStack, MakesValue user, MakesValue tid) => user -> tid -> App Response
getTeamFeature :: (HasCallStack, MakesValue user, MakesValue tid) => user -> tid -> String -> App Response
setTeamFeatureConfig :: (HasCallStack, MakesValue user, MakesValue team, MakesValue featureName, MakesValue payload) => user -> team -> featureName -> payload -> App Response
setTeamFeatureConfigVersioned :: (HasCallStack, MakesValue user, MakesValue team, MakesValue featureName, MakesValue payload) => Versioned -> user -> team -> featureName -> payload -> App Response
getFeaturesForUser :: (HasCallStack, MakesValue user) => user -> App Response
getTeamNotifications :: (HasCallStack, MakesValue user) => user -> Maybe String -> App Response
getTeamMembersCsv :: (HasCallStack, MakesValue user) => user -> String -> App Response
sendTypingStatus :: (HasCallStack, MakesValue user, MakesValue conv) => user -> conv -> String -> App Response

Documentation

data CreateConv Source #

Constructors

CreateConv
Fields qualifiedUsers :: [Value] name :: Maybe String access :: Maybe [String] accessRole :: Maybe [String] team :: Maybe String messageTimer :: Maybe Int receiptMode :: Maybe Int newUsersRole :: String protocol :: String

Instances

Instances details

MakesValue CreateConv Source #
Instance details Defined in API.Galley Methods make :: CreateConv -> App Value Source #

defProteus :: CreateConv Source #

defMLS :: CreateConv Source #

allowGuests :: CreateConv -> CreateConv Source #

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

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

deleteTeamMember :: (HasCallStack, MakesValue owner, MakesValue member) => String -> owner -> member -> App Response Source #

putConversationProtocol :: (HasCallStack, MakesValue user, MakesValue protocol) => user -> ConvId -> protocol -> App Response Source #

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

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

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

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

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

data ListConversationIds Source #

Constructors

ListConversationIds
Fields pagingState :: Maybe String size :: Maybe Int

Instances

Instances details

Default ListConversationIds Source #
Instance details Defined in API.Galley Methods def :: ListConversationIds Source #

listConversationIds :: MakesValue user => user -> ListConversationIds -> App Response Source #

listConversations :: MakesValue user => user -> [Value] -> App Response Source #

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

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

postMLSMessage :: HasCallStack => ClientIdentity -> ByteString -> App Response Source #

postMLSCommitBundle :: HasCallStack => ClientIdentity -> ByteString -> App Response Source #

postProteusMessage :: (HasCallStack, MakesValue user, MakesValue conv) => user -> conv -> QualifiedNewOtrMessage -> App Response Source #

mkProteusRecipient :: (HasCallStack, MakesValue user, MakesValue client) => user -> client -> String -> App QualifiedUserEntry Source #

mkProteusRecipients :: (HasCallStack, MakesValue domain, MakesValue user, MakesValue client) => domain -> [(user, [client])] -> String -> App QualifiedUserEntry Source #

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

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

updateConversationMember :: (HasCallStack, MakesValue user, MakesValue conv, MakesValue target) => user -> conv -> target -> String -> App Response Source #

deleteTeamConv :: (HasCallStack, MakesValue team, MakesValue conv, MakesValue user) => team -> conv -> user -> App Response Source #

getMLSOne2OneConversationLegacy :: (HasCallStack, MakesValue self, MakesValue other) => self -> other -> App Response Source #

getMLSOne2OneConversation :: (HasCallStack, MakesValue self, MakesValue other) => self -> other -> App Response Source #

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

data AddMembers Source #

Constructors

AddMembers
Fields users :: [Value] role :: Maybe String version :: Maybe Int

Instances

Instances details

Default AddMembers Source #
Instance details Defined in API.Galley Methods def :: AddMembers Source #

addMembers :: (HasCallStack, MakesValue user, MakesValue conv) => user -> conv -> AddMembers -> App Response Source #

removeMember :: (HasCallStack, MakesValue remover, MakesValue conv, MakesValue removed) => remover -> conv -> removed -> App Response Source #

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

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

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

changeConversationName :: (HasCallStack, MakesValue user, MakesValue conv, MakesValue name) => user -> conv -> name -> App Response Source #

updateRole :: (HasCallStack, MakesValue callerUser, MakesValue targetUser, MakesValue roleUpdate, MakesValue qcnv) => callerUser -> targetUser -> roleUpdate -> qcnv -> App Response Source #

updateReceiptMode :: (HasCallStack, MakesValue user, MakesValue conv, MakesValue mode) => user -> conv -> mode -> App Response Source #

updateAccess :: (HasCallStack, MakesValue user, MakesValue conv) => user -> conv -> [Pair] -> App Response Source #

updateMessageTimer :: (HasCallStack, MakesValue user, MakesValue conv) => user -> conv -> Word64 -> App Response Source #

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

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

data AppLockSettings Source #

Constructors

AppLockSettings
Fields status :: String enforce :: Bool inactivityTimeoutSecs :: Int

Instances

Instances details

Default AppLockSettings Source #
Instance details Defined in API.Galley Methods def :: AppLockSettings Source #

putAppLockSettings :: (HasCallStack, MakesValue tid, MakesValue caller) => tid -> caller -> AppLockSettings -> App Response Source #

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

data TeamProperties Source #

Constructors

TeamProperties
Fields icon :: String iconKey :: String name :: String spashScreen :: String

Instances

Instances details

Default TeamProperties Source #
Instance details Defined in API.Galley Methods def :: TeamProperties Source #

putTeamProperties :: (HasCallStack, MakesValue tid, MakesValue caller) => tid -> caller -> TeamProperties -> App Response Source #

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

legalholdUserStatus :: (HasCallStack, MakesValue tid, MakesValue user, MakesValue owner) => tid -> owner -> user -> App Response Source #

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

disableLegalHold Source #

Arguments

:: (HasCallStack, MakesValue tid, MakesValue ownerid, MakesValue uid)
=> tid
-> ownerid
-> uid
-> String	the password for user with $uid$
-> App Response

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

consentToLegalHold :: (HasCallStack, MakesValue tid, MakesValue zusr) => tid -> zusr -> String -> App Response Source #

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

getLegalHoldStatus :: (HasCallStack, MakesValue tid, MakesValue zusr) => tid -> zusr -> App Response Source #

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

getLegalHoldSettings :: (HasCallStack, MakesValue tid, MakesValue zusr) => tid -> zusr -> App Response Source #

postLegalHoldSettings :: (HasCallStack, MakesValue ownerid, MakesValue tid, MakesValue newService) => tid -> ownerid -> newService -> App Response Source #

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

requestLegalHoldDevice :: (HasCallStack, MakesValue tid, MakesValue ownerid, MakesValue uid) => tid -> ownerid -> uid -> App Response Source #

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

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

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

like approveLegalHoldDevice' but approves for the requesting party

approveLegalHoldDevice' :: (HasCallStack, MakesValue tid, MakesValue uid, MakesValue forUid) => tid -> uid -> forUid -> String -> App Response Source #

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

useful for testing unauthorized requests

putLegalholdStatus Source #

Arguments

:: (HasCallStack, MakesValue tid, MakesValue usr)
=> tid
-> usr
-> String	the status to put to
-> App Response

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

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

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

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

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

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

setTeamFeatureConfig :: (HasCallStack, MakesValue user, MakesValue team, MakesValue featureName, MakesValue payload) => user -> team -> featureName -> payload -> App Response Source #

setTeamFeatureConfigVersioned :: (HasCallStack, MakesValue user, MakesValue team, MakesValue featureName, MakesValue payload) => Versioned -> user -> team -> featureName -> payload -> App Response Source #

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

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

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

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

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

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

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

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