License	MIT
Safe Haskell	None
Language	Haskell2010

BattlePlace.WebApi

Description

Documentation

type WebApi = "v1a" :> (("client" :> (("auth" :> (ReqBody '[JSON] ClientAuthRequest :> Post '[JSON] ClientAuthResponse)) :<|> (("match" :> ((AuthProtect ClientToken :> (ReqBody '[JSON] MatchRequest :> Post '[JSON] MatchResponse)) :<|> (AuthProtect ClientToken :> (Capture "matchToken" (InternalToken MatchToken) :> Get '[JSON] MatchStatusResponse)))) :<|> ("session" :> (Capture "sessionToken" (InternalToken SessionToken) :> ("result" :> (AuthProtect ClientToken :> (ReqBody '[JSON] SessionResultRequest :> Post '[JSON] ())))))))) :<|> ("server" :> (("match" :> (ReqBody '[JSON] ServerMatchRequest :> Post '[JSON] ServerMatchResponse)) :<|> ("session" :> (Capture "serverSessionToken" (InternalToken ServerSessionToken) :> ("result" :> (ReqBody '[JSON] ServerSessionResultRequest :> Post '[JSON] ()))))))) Source #

data ClientAuthRequest Source #

Constructors

ClientAuthRequest
Fields clientAuthRequest_projectId :: !ProjectId clientAuthRequest_auth :: !Auth

Instances

Generic ClientAuthRequest Source #
Associated Types type Rep ClientAuthRequest :: * -> * # Methods from :: ClientAuthRequest -> Rep ClientAuthRequest x # to :: Rep ClientAuthRequest x -> ClientAuthRequest #
ToJSON ClientAuthRequest Source #
Methods toJSON :: ClientAuthRequest -> Value # toEncoding :: ClientAuthRequest -> Encoding # toJSONList :: [ClientAuthRequest] -> Value # toEncodingList :: [ClientAuthRequest] -> Encoding #
FromJSON ClientAuthRequest Source #
Methods parseJSON :: Value -> Parser ClientAuthRequest # parseJSONList :: Value -> Parser [ClientAuthRequest] #
type Rep ClientAuthRequest Source #
type Rep ClientAuthRequest = D1 * (MetaData "ClientAuthRequest" "BattlePlace.WebApi" "battleplace-0.1.0.2-AjG3htEGKCK3mKOZjtGepk" False) (C1 * (MetaCons "ClientAuthRequest" PrefixI True) ((::) (S1 * (MetaSel (Just Symbol "clientAuthRequest_projectId") SourceUnpack SourceStrict DecidedStrict) (Rec0 * ProjectId)) (S1 * (MetaSel (Just Symbol "clientAuthRequest_auth") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Auth))))

data ClientAuthResponse Source #

Constructors

ClientAuthResponse_authenticated
Fields clientAuthResponse_clientToken :: !(InternalToken ClientToken) clientAuthResponse_name :: !Text clientAuthResponse_pictureUrl :: !Text
ClientAuthResponse_notAuthenticated
Fields clientAuthResponse_error :: !Text

Instances

Generic ClientAuthResponse Source #
Associated Types type Rep ClientAuthResponse :: * -> * # Methods from :: ClientAuthResponse -> Rep ClientAuthResponse x # to :: Rep ClientAuthResponse x -> ClientAuthResponse #
ToJSON ClientAuthResponse Source #
Methods toJSON :: ClientAuthResponse -> Value # toEncoding :: ClientAuthResponse -> Encoding # toJSONList :: [ClientAuthResponse] -> Value # toEncodingList :: [ClientAuthResponse] -> Encoding #
FromJSON ClientAuthResponse Source #
Methods parseJSON :: Value -> Parser ClientAuthResponse # parseJSONList :: Value -> Parser [ClientAuthResponse] #
type Rep ClientAuthResponse Source #
type Rep ClientAuthResponse = D1 * (MetaData "ClientAuthResponse" "BattlePlace.WebApi" "battleplace-0.1.0.2-AjG3htEGKCK3mKOZjtGepk" False) ((:+:) * (C1 * (MetaCons "ClientAuthResponse_authenticated" PrefixI True) ((::) (S1 * (MetaSel (Just Symbol "clientAuthResponse_clientToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (InternalToken ClientToken))) ((::) (S1 * (MetaSel (Just Symbol "clientAuthResponse_name") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "clientAuthResponse_pictureUrl") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))))) (C1 * (MetaCons "ClientAuthResponse_notAuthenticated" PrefixI True) (S1 * (MetaSel (Just Symbol "clientAuthResponse_error") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))))

data MatchRequest Source #

Constructors

MatchRequest
Fields matchRequest_teamSizes :: !(Vector MatchTeamSize) matchRequest_maxMatchTime :: !Int matchRequest_matchTag :: !(Maybe MatchTag) matchRequest_info :: !(Maybe MatchPlayerInfo)

Instances

Generic MatchRequest Source #
Associated Types type Rep MatchRequest :: * -> * # Methods from :: MatchRequest -> Rep MatchRequest x # to :: Rep MatchRequest x -> MatchRequest #
ToJSON MatchRequest Source #
Methods toJSON :: MatchRequest -> Value # toEncoding :: MatchRequest -> Encoding # toJSONList :: [MatchRequest] -> Value # toEncodingList :: [MatchRequest] -> Encoding #
FromJSON MatchRequest Source #
Methods parseJSON :: Value -> Parser MatchRequest # parseJSONList :: Value -> Parser [MatchRequest] #
type Rep MatchRequest Source #
type Rep MatchRequest = D1 * (MetaData "MatchRequest" "BattlePlace.WebApi" "battleplace-0.1.0.2-AjG3htEGKCK3mKOZjtGepk" False) (C1 * (MetaCons "MatchRequest" PrefixI True) ((::) ((::) (S1 * (MetaSel (Just Symbol "matchRequest_teamSizes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Vector MatchTeamSize))) (S1 * (MetaSel (Just Symbol "matchRequest_maxMatchTime") SourceUnpack SourceStrict DecidedStrict) (Rec0 * Int))) ((::) (S1 * (MetaSel (Just Symbol "matchRequest_matchTag") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe MatchTag))) (S1 * (MetaSel (Just Symbol "matchRequest_info") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe MatchPlayerInfo))))))

data MatchResponse Source #

Constructors

MatchResponse
Fields matchResponse_matchToken :: !(InternalToken MatchToken)

Instances

Generic MatchResponse Source #
Associated Types type Rep MatchResponse :: * -> * # Methods from :: MatchResponse -> Rep MatchResponse x # to :: Rep MatchResponse x -> MatchResponse #
ToJSON MatchResponse Source #
Methods toJSON :: MatchResponse -> Value # toEncoding :: MatchResponse -> Encoding # toJSONList :: [MatchResponse] -> Value # toEncodingList :: [MatchResponse] -> Encoding #
FromJSON MatchResponse Source #
Methods parseJSON :: Value -> Parser MatchResponse # parseJSONList :: Value -> Parser [MatchResponse] #
type Rep MatchResponse Source #
type Rep MatchResponse = D1 * (MetaData "MatchResponse" "BattlePlace.WebApi" "battleplace-0.1.0.2-AjG3htEGKCK3mKOZjtGepk" False) (C1 * (MetaCons "MatchResponse" PrefixI True) (S1 * (MetaSel (Just Symbol "matchResponse_matchToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (InternalToken MatchToken))))

data MatchStatusResponse Source #

Constructors

MatchStatusResponse_notFound
MatchStatusResponse_inProgress
MatchStatusResponse_matched
Fields matchStatusResponse_sessionId :: !SessionId matchStatusResponse_sessionToken :: !(InternalToken SessionToken) matchStatusResponse_teams :: !(Vector MatchTeam) matchStatusResponse_teamIndex :: !Int matchStatusResponse_mateIndex :: !Int matchStatusResponse_server :: !(Maybe MatchServer)
MatchStatusResponse_failed
Fields matchStatusResponse_reason :: !MatchFailureReason
MatchStatusResponse_cleaned	Match status was cleaned. Normallly this status should not be visible to clients, it's here just in case.

Instances

Generic MatchStatusResponse Source #
Associated Types type Rep MatchStatusResponse :: * -> * # Methods from :: MatchStatusResponse -> Rep MatchStatusResponse x # to :: Rep MatchStatusResponse x -> MatchStatusResponse #
ToJSON MatchStatusResponse Source #
Methods toJSON :: MatchStatusResponse -> Value # toEncoding :: MatchStatusResponse -> Encoding # toJSONList :: [MatchStatusResponse] -> Value # toEncodingList :: [MatchStatusResponse] -> Encoding #
FromJSON MatchStatusResponse Source #
Methods parseJSON :: Value -> Parser MatchStatusResponse # parseJSONList :: Value -> Parser [MatchStatusResponse] #
type Rep MatchStatusResponse Source #
type Rep MatchStatusResponse = D1 * (MetaData "MatchStatusResponse" "BattlePlace.WebApi" "battleplace-0.1.0.2-AjG3htEGKCK3mKOZjtGepk" False) ((:+:) * ((:+:) * (C1 * (MetaCons "MatchStatusResponse_notFound" PrefixI False) (U1 )) (C1 (MetaCons "MatchStatusResponse_inProgress" PrefixI False) (U1 ))) ((:+:) (C1 * (MetaCons "MatchStatusResponse_matched" PrefixI True) ((::) ((::) (S1 * (MetaSel (Just Symbol "matchStatusResponse_sessionId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * SessionId)) ((::) (S1 * (MetaSel (Just Symbol "matchStatusResponse_sessionToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (InternalToken SessionToken))) (S1 * (MetaSel (Just Symbol "matchStatusResponse_teams") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Vector MatchTeam))))) ((::) (S1 * (MetaSel (Just Symbol "matchStatusResponse_teamIndex") SourceUnpack SourceStrict DecidedStrict) (Rec0 * Int)) ((::) (S1 * (MetaSel (Just Symbol "matchStatusResponse_mateIndex") SourceUnpack SourceStrict DecidedStrict) (Rec0 * Int)) (S1 * (MetaSel (Just Symbol "matchStatusResponse_server") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe MatchServer))))))) ((:+:) * (C1 * (MetaCons "MatchStatusResponse_failed" PrefixI True) (S1 * (MetaSel (Just Symbol "matchStatusResponse_reason") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * MatchFailureReason))) (C1 * (MetaCons "MatchStatusResponse_cleaned" PrefixI False) (U1 *)))))

newtype MatchTeam Source #

Constructors

MatchTeam (Vector MatchPlayer)

Instances

ToJSON MatchTeam Source #
Methods toJSON :: MatchTeam -> Value # toEncoding :: MatchTeam -> Encoding # toJSONList :: [MatchTeam] -> Value # toEncodingList :: [MatchTeam] -> Encoding #
FromJSON MatchTeam Source #
Methods parseJSON :: Value -> Parser MatchTeam # parseJSONList :: Value -> Parser [MatchTeam] #

data MatchPlayer Source #

Constructors

MatchPlayer
Fields matchPlayer_info :: !MatchPlayerInfo matchPlayer_ourTicket :: !(Maybe Ticket) matchPlayer_theirTicket :: !(Maybe Ticket)

Instances

Generic MatchPlayer Source #
Associated Types type Rep MatchPlayer :: * -> * # Methods from :: MatchPlayer -> Rep MatchPlayer x # to :: Rep MatchPlayer x -> MatchPlayer #
ToJSON MatchPlayer Source #
Methods toJSON :: MatchPlayer -> Value # toEncoding :: MatchPlayer -> Encoding # toJSONList :: [MatchPlayer] -> Value # toEncodingList :: [MatchPlayer] -> Encoding #
FromJSON MatchPlayer Source #
Methods parseJSON :: Value -> Parser MatchPlayer # parseJSONList :: Value -> Parser [MatchPlayer] #
type Rep MatchPlayer Source #
type Rep MatchPlayer = D1 * (MetaData "MatchPlayer" "BattlePlace.WebApi" "battleplace-0.1.0.2-AjG3htEGKCK3mKOZjtGepk" False) (C1 * (MetaCons "MatchPlayer" PrefixI True) ((::) (S1 * (MetaSel (Just Symbol "matchPlayer_info") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * MatchPlayerInfo)) ((::) (S1 * (MetaSel (Just Symbol "matchPlayer_ourTicket") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Ticket))) (S1 * (MetaSel (Just Symbol "matchPlayer_theirTicket") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Ticket))))))

data MatchServer Source #

Constructors

MatchServer
Fields matchServer_info :: !MatchServerInfo matchServer_ourTicket :: !Ticket matchServer_theirTicket :: !Ticket

Instances

Generic MatchServer Source #
Associated Types type Rep MatchServer :: * -> * # Methods from :: MatchServer -> Rep MatchServer x # to :: Rep MatchServer x -> MatchServer #
ToJSON MatchServer Source #
Methods toJSON :: MatchServer -> Value # toEncoding :: MatchServer -> Encoding # toJSONList :: [MatchServer] -> Value # toEncodingList :: [MatchServer] -> Encoding #
FromJSON MatchServer Source #
Methods parseJSON :: Value -> Parser MatchServer # parseJSONList :: Value -> Parser [MatchServer] #
type Rep MatchServer Source #
type Rep MatchServer = D1 * (MetaData "MatchServer" "BattlePlace.WebApi" "battleplace-0.1.0.2-AjG3htEGKCK3mKOZjtGepk" False) (C1 * (MetaCons "MatchServer" PrefixI True) ((::) (S1 * (MetaSel (Just Symbol "matchServer_info") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * MatchServerInfo)) ((::) (S1 * (MetaSel (Just Symbol "matchServer_ourTicket") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Ticket)) (S1 * (MetaSel (Just Symbol "matchServer_theirTicket") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Ticket)))))

newtype MatchServerInfo Source #

Constructors

MatchServerInfo Text

Instances

ToJSON MatchServerInfo Source #
Methods toJSON :: MatchServerInfo -> Value # toEncoding :: MatchServerInfo -> Encoding # toJSONList :: [MatchServerInfo] -> Value # toEncodingList :: [MatchServerInfo] -> Encoding #
FromJSON MatchServerInfo Source #
Methods parseJSON :: Value -> Parser MatchServerInfo # parseJSONList :: Value -> Parser [MatchServerInfo] #

data SessionResultRequest Source #

Constructors

SessionResultRequest_finished
Fields sessionResultRequest_ranks :: !(Vector Int)
SessionResultRequest_cancelled

Instances

Generic SessionResultRequest Source #
Associated Types type Rep SessionResultRequest :: * -> * # Methods from :: SessionResultRequest -> Rep SessionResultRequest x # to :: Rep SessionResultRequest x -> SessionResultRequest #
ToJSON SessionResultRequest Source #
Methods toJSON :: SessionResultRequest -> Value # toEncoding :: SessionResultRequest -> Encoding # toJSONList :: [SessionResultRequest] -> Value # toEncodingList :: [SessionResultRequest] -> Encoding #
FromJSON SessionResultRequest Source #
Methods parseJSON :: Value -> Parser SessionResultRequest # parseJSONList :: Value -> Parser [SessionResultRequest] #
type Rep SessionResultRequest Source #
type Rep SessionResultRequest = D1 * (MetaData "SessionResultRequest" "BattlePlace.WebApi" "battleplace-0.1.0.2-AjG3htEGKCK3mKOZjtGepk" False) ((:+:) * (C1 * (MetaCons "SessionResultRequest_finished" PrefixI True) (S1 * (MetaSel (Just Symbol "sessionResultRequest_ranks") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Vector Int)))) (C1 * (MetaCons "SessionResultRequest_cancelled" PrefixI False) (U1 *)))

data ServerMatchRequest Source #

Constructors

ServerMatchRequest
Fields serverMatchRequest_projectId :: !ProjectId serverMatchRequest_projectServerToken :: !ProjectServerToken serverMatchRequest_maxSessionsCount :: !Int serverMatchRequest_name :: !Text serverMatchRequest_info :: !MatchServerInfo serverMatchRequest_timeout :: !(Maybe Int)

Instances

Generic ServerMatchRequest Source #
Associated Types type Rep ServerMatchRequest :: * -> * # Methods from :: ServerMatchRequest -> Rep ServerMatchRequest x # to :: Rep ServerMatchRequest x -> ServerMatchRequest #
ToJSON ServerMatchRequest Source #
Methods toJSON :: ServerMatchRequest -> Value # toEncoding :: ServerMatchRequest -> Encoding # toJSONList :: [ServerMatchRequest] -> Value # toEncodingList :: [ServerMatchRequest] -> Encoding #
FromJSON ServerMatchRequest Source #
Methods parseJSON :: Value -> Parser ServerMatchRequest # parseJSONList :: Value -> Parser [ServerMatchRequest] #
type Rep ServerMatchRequest Source #
type Rep ServerMatchRequest = D1 * (MetaData "ServerMatchRequest" "BattlePlace.WebApi" "battleplace-0.1.0.2-AjG3htEGKCK3mKOZjtGepk" False) (C1 * (MetaCons "ServerMatchRequest" PrefixI True) ((::) ((::) (S1 * (MetaSel (Just Symbol "serverMatchRequest_projectId") SourceUnpack SourceStrict DecidedStrict) (Rec0 * ProjectId)) ((::) (S1 * (MetaSel (Just Symbol "serverMatchRequest_projectServerToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * ProjectServerToken)) (S1 * (MetaSel (Just Symbol "serverMatchRequest_maxSessionsCount") SourceUnpack SourceStrict DecidedStrict) (Rec0 * Int)))) ((::) (S1 * (MetaSel (Just Symbol "serverMatchRequest_name") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) ((::) (S1 * (MetaSel (Just Symbol "serverMatchRequest_info") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * MatchServerInfo)) (S1 * (MetaSel (Just Symbol "serverMatchRequest_timeout") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int)))))))

data ServerMatchResponse Source #

Constructors

ServerMatchResponse
Fields serverMatchResponse_sessions :: !(Vector ServerSession)

Instances

Generic ServerMatchResponse Source #
Associated Types type Rep ServerMatchResponse :: * -> * # Methods from :: ServerMatchResponse -> Rep ServerMatchResponse x # to :: Rep ServerMatchResponse x -> ServerMatchResponse #
ToJSON ServerMatchResponse Source #
Methods toJSON :: ServerMatchResponse -> Value # toEncoding :: ServerMatchResponse -> Encoding # toJSONList :: [ServerMatchResponse] -> Value # toEncodingList :: [ServerMatchResponse] -> Encoding #
FromJSON ServerMatchResponse Source #
Methods parseJSON :: Value -> Parser ServerMatchResponse # parseJSONList :: Value -> Parser [ServerMatchResponse] #
type Rep ServerMatchResponse Source #
type Rep ServerMatchResponse = D1 * (MetaData "ServerMatchResponse" "BattlePlace.WebApi" "battleplace-0.1.0.2-AjG3htEGKCK3mKOZjtGepk" False) (C1 * (MetaCons "ServerMatchResponse" PrefixI True) (S1 * (MetaSel (Just Symbol "serverMatchResponse_sessions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Vector ServerSession))))

data ServerSessionResultRequest Source #

Constructors

ServerSessionResultRequest_finished
Fields serverSessionResultRequest_ranks :: !(Vector Int)
ServerSessionResultRequest_cancelled

Instances

Generic ServerSessionResultRequest Source #
Associated Types type Rep ServerSessionResultRequest :: * -> * # Methods from :: ServerSessionResultRequest -> Rep ServerSessionResultRequest x # to :: Rep ServerSessionResultRequest x -> ServerSessionResultRequest #
ToJSON ServerSessionResultRequest Source #
Methods toJSON :: ServerSessionResultRequest -> Value # toEncoding :: ServerSessionResultRequest -> Encoding # toJSONList :: [ServerSessionResultRequest] -> Value # toEncodingList :: [ServerSessionResultRequest] -> Encoding #
FromJSON ServerSessionResultRequest Source #
Methods parseJSON :: Value -> Parser ServerSessionResultRequest # parseJSONList :: Value -> Parser [ServerSessionResultRequest] #
type Rep ServerSessionResultRequest Source #
type Rep ServerSessionResultRequest = D1 * (MetaData "ServerSessionResultRequest" "BattlePlace.WebApi" "battleplace-0.1.0.2-AjG3htEGKCK3mKOZjtGepk" False) ((:+:) * (C1 * (MetaCons "ServerSessionResultRequest_finished" PrefixI True) (S1 * (MetaSel (Just Symbol "serverSessionResultRequest_ranks") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Vector Int)))) (C1 * (MetaCons "ServerSessionResultRequest_cancelled" PrefixI False) (U1 *)))

data ServerSession Source #

Constructors

ServerSession
Fields serverSession_sessionId :: !SessionId serverSession_serverSessionToken :: !(InternalToken ServerSessionToken) serverSession_teams :: !(Vector MatchTeam)

Instances

Generic ServerSession Source #
Associated Types type Rep ServerSession :: * -> * # Methods from :: ServerSession -> Rep ServerSession x # to :: Rep ServerSession x -> ServerSession #
ToJSON ServerSession Source #
Methods toJSON :: ServerSession -> Value # toEncoding :: ServerSession -> Encoding # toJSONList :: [ServerSession] -> Value # toEncodingList :: [ServerSession] -> Encoding #
FromJSON ServerSession Source #
Methods parseJSON :: Value -> Parser ServerSession # parseJSONList :: Value -> Parser [ServerSession] #
type Rep ServerSession Source #
type Rep ServerSession = D1 * (MetaData "ServerSession" "BattlePlace.WebApi" "battleplace-0.1.0.2-AjG3htEGKCK3mKOZjtGepk" False) (C1 * (MetaCons "ServerSession" PrefixI True) ((::) (S1 * (MetaSel (Just Symbol "serverSession_sessionId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * SessionId)) ((::) (S1 * (MetaSel (Just Symbol "serverSession_serverSessionToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (InternalToken ServerSessionToken))) (S1 * (MetaSel (Just Symbol "serverSession_teams") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Vector MatchTeam))))))