lichess-api 1.0.0

A client library for the Lichess API
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127

//! Arena tournaments: Lichess's continuous-pairing tournament format, where
//! players score points per game and climb a live leaderboard for the
//! duration of the event.
//!
//! Covers listing current tournaments, creating and updating them, joining,
//! withdrawing/pausing, terminating, managing team battles, and reading back
//! standings, results, team standings, and games. Creating or modifying a
//! tournament ([`create_arena_tournament`](LichessApi::create_arena_tournament),
//! [`update_arena_tournament`](LichessApi::update_arena_tournament),
//! [`join_arena_tournament`](LichessApi::join_arena_tournament),
//! [`withdraw_from_arena_tournament`](LichessApi::withdraw_from_arena_tournament),
//! [`terminate_arena_tournament`](LichessApi::terminate_arena_tournament), and
//! [`update_arena_team_battle`](LichessApi::update_arena_team_battle)) requires
//! a bearer token with the `tournament:write` scope; reading tournament info,
//! results, team standings, and games is public and needs no token.

use futures::stream::StreamExt;

use crate::client::LichessApi;
use crate::error::Result;
use crate::model::arena_tournaments::*;
use crate::model::games::GameJson;

impl LichessApi<reqwest::Client> {
    pub async fn get_current_arena_tournaments(&self) -> Result<ArenaTournaments> {
        self.get_single_model(current::GetRequest::new()).await
    }

    pub async fn create_arena_tournament(
        &self,
        request: impl Into<create::PostRequest>,
    ) -> Result<ArenaTournamentFull> {
        self.get_single_model(request.into()).await
    }

    pub async fn get_arena_tournament(
        &self,
        id: &str,
        query: show::GetQuery,
    ) -> Result<ArenaTournamentFull> {
        self.get_single_model(show::GetRequest::new(id, query))
            .await
    }

    pub async fn update_arena_tournament(
        &self,
        id: &str,
        form: update::UpdateArenaTournamentForm,
    ) -> Result<ArenaTournamentFull> {
        self.get_single_model(update::PostRequest::new(id, form))
            .await
    }

    pub async fn export_arena_tournament_games(
        &self,
        id: &str,
        query: games::GetQuery,
    ) -> Result<impl StreamExt<Item = Result<GameJson>>> {
        self.get_streamed_models(games::GetRequest::new(id, query))
            .await
    }

    pub async fn join_arena_tournament(
        &self,
        id: &str,
        form: join::JoinArenaTournamentForm,
    ) -> Result<bool> {
        self.get_ok(join::PostRequest::new(id, form)).await
    }

    pub async fn get_arena_tournament_results(
        &self,
        id: &str,
        query: results::GetQuery,
    ) -> Result<impl StreamExt<Item = Result<ArenaResult>>> {
        self.get_streamed_models(results::GetRequest::new(id, query))
            .await
    }

    pub async fn get_arena_tournament_team_standing(
        &self,
        request: impl Into<teams::GetRequest>,
    ) -> Result<ArenaTeamStanding> {
        self.get_single_model(request.into()).await
    }

    pub async fn terminate_arena_tournament(
        &self,
        request: impl Into<terminate::PostRequest>,
    ) -> Result<bool> {
        self.get_ok(request.into()).await
    }

    pub async fn withdraw_from_arena_tournament(
        &self,
        request: impl Into<withdraw::PostRequest>,
    ) -> Result<bool> {
        self.get_ok(request.into()).await
    }

    pub async fn update_arena_team_battle(
        &self,
        id: &str,
        form: team_battle::TeamBattleForm,
    ) -> Result<ArenaTournamentFull> {
        self.get_single_model(team_battle::PostRequest::new(id, form))
            .await
    }

    pub async fn get_arena_tournaments_created_by_user(
        &self,
        username: &str,
        query: created_by_user::GetQuery,
    ) -> Result<impl StreamExt<Item = Result<crate::model::ArenaTournament>>> {
        self.get_streamed_models(created_by_user::GetRequest::new(username, query))
            .await
    }

    pub async fn get_arena_tournaments_played_by_user(
        &self,
        username: &str,
        query: played_by_user::GetQuery,
    ) -> Result<impl StreamExt<Item = Result<ArenaTournamentPlayed>>> {
        self.get_streamed_models(played_by_user::GetRequest::new(username, query))
            .await
    }
}