@lichess-org/types 2.0.113 → 2.0.115
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lichess-api.d.ts +23 -15
- package/package.json +1 -1
package/lichess-api.d.ts
CHANGED
|
@@ -571,7 +571,7 @@ export interface paths {
|
|
|
571
571
|
* <https://lichess.org/@/german11> for instance has more than 500,000 games.
|
|
572
572
|
* The game stream is throttled, depending on who is making the request:
|
|
573
573
|
* - Anonymous request: 20 games per second
|
|
574
|
-
* - [OAuth2 authenticated](
|
|
574
|
+
* - [OAuth2 authenticated](#description/authentication) request: 30 games per second
|
|
575
575
|
* - Authenticated, downloading your own games: 60 games per second
|
|
576
576
|
*/
|
|
577
577
|
get: operations["apiGamesUser"];
|
|
@@ -647,7 +647,7 @@ export interface paths {
|
|
|
647
647
|
* @description Creates a stream of games from an arbitrary streamId, and a list of game IDs.
|
|
648
648
|
* The stream first outputs the games that already exists, then emits an event each time a game is started or finished.
|
|
649
649
|
* Games are streamed as [ndjson](#description/streaming-with-nd-json).
|
|
650
|
-
* Maximum number of games: 500 for anonymous requests, or 1000 for [OAuth2 authenticated](
|
|
650
|
+
* Maximum number of games: 500 for anonymous requests, or 1000 for [OAuth2 authenticated](#description/authentication) requests.
|
|
651
651
|
* While the stream is open, it is possible to [add new game IDs to watch](#tag/games/POST/api/stream/games/{streamId}/add).
|
|
652
652
|
*/
|
|
653
653
|
post: operations["gamesByIds"];
|
|
@@ -1037,7 +1037,7 @@ export interface paths {
|
|
|
1037
1037
|
* Games are sorted by reverse chronological order (most recent first).
|
|
1038
1038
|
* The game stream is throttled, depending on who is making the request:
|
|
1039
1039
|
* - Anonymous request: 20 games per second
|
|
1040
|
-
* - [OAuth2 authenticated](
|
|
1040
|
+
* - [OAuth2 authenticated](#description/authentication) request: 30 games per second
|
|
1041
1041
|
*/
|
|
1042
1042
|
get: operations["gamesByTournament"];
|
|
1043
1043
|
put?: never;
|
|
@@ -1106,7 +1106,7 @@ export interface paths {
|
|
|
1106
1106
|
* Tournaments are streamed as [ndjson](#description/streaming-with-nd-json).
|
|
1107
1107
|
* The stream is throttled, depending on who is making the request:
|
|
1108
1108
|
* - Anonymous request: 20 tournaments per second
|
|
1109
|
-
* - [OAuth2 authenticated](
|
|
1109
|
+
* - [OAuth2 authenticated](#description/authentication) request: 30 tournaments per second
|
|
1110
1110
|
* - Authenticated, downloading your own tournaments: 50 tournaments per second
|
|
1111
1111
|
*/
|
|
1112
1112
|
get: operations["apiUserNameTournamentCreated"];
|
|
@@ -1132,7 +1132,7 @@ export interface paths {
|
|
|
1132
1132
|
* Tournaments are streamed as [ndjson](#description/streaming-with-nd-json).
|
|
1133
1133
|
* The stream is throttled, depending on who is making the request:
|
|
1134
1134
|
* - Anonymous request: 20 tournaments per second
|
|
1135
|
-
* - [OAuth2 authenticated](
|
|
1135
|
+
* - [OAuth2 authenticated](#description/authentication) request: 30 tournaments per second
|
|
1136
1136
|
* - Authenticated, downloading your own tournaments: 50 tournaments per second
|
|
1137
1137
|
*/
|
|
1138
1138
|
get: operations["apiUserNameTournamentPlayed"];
|
|
@@ -1334,7 +1334,7 @@ export interface paths {
|
|
|
1334
1334
|
* Games are sorted by chronological order.
|
|
1335
1335
|
* The game stream is throttled, depending on who is making the request:
|
|
1336
1336
|
* - Anonymous request: 20 games per second
|
|
1337
|
-
* - [OAuth2 authenticated](
|
|
1337
|
+
* - [OAuth2 authenticated](#description/authentication) request: 30 games per second
|
|
1338
1338
|
*/
|
|
1339
1339
|
get: operations["gamesBySwiss"];
|
|
1340
1340
|
put?: never;
|
|
@@ -1996,7 +1996,7 @@ export interface paths {
|
|
|
1996
1996
|
* @description Get recently created, started, finished, simuls.
|
|
1997
1997
|
* Created and finished simul lists are not exhaustives, only those with
|
|
1998
1998
|
* strong enough host will be listed, the same filter is used to display simuls on https://lichess.org/simul.
|
|
1999
|
-
* When [authenticated with OAuth2](
|
|
1999
|
+
* When [authenticated with OAuth2](#description/authentication), the pending list will be populated with your created, but unstarted simuls.
|
|
2000
2000
|
*/
|
|
2001
2001
|
get: operations["apiSimul"];
|
|
2002
2002
|
put?: never;
|
|
@@ -2057,6 +2057,7 @@ export interface paths {
|
|
|
2057
2057
|
/**
|
|
2058
2058
|
* Teams of a player
|
|
2059
2059
|
* @description All the teams a player is a member of.
|
|
2060
|
+
* Teams that hide their player list are only included if you also belong to the team.
|
|
2060
2061
|
*/
|
|
2061
2062
|
get: operations["teamOfUsername"];
|
|
2062
2063
|
put?: never;
|
|
@@ -3169,7 +3170,7 @@ export interface paths {
|
|
|
3169
3170
|
* You can control which color each player gets by giving them these URLs,
|
|
3170
3171
|
* instead of the main challenge URL.
|
|
3171
3172
|
* Open challenges expire after 24h.
|
|
3172
|
-
* If the challenge creation is [authenticated with OAuth2](
|
|
3173
|
+
* If the challenge creation is [authenticated with OAuth2](#description/authentication),
|
|
3173
3174
|
* then you can use the [challenge cancel endpoint](#tag/challenges/POST/api/challenge/{challengeId}/cancel) to cancel it.
|
|
3174
3175
|
* To directly pair 2 known players, use [this endpoint](#tag/bulk-pairings/GET/api/bulk-pairing) instead.
|
|
3175
3176
|
*/
|
|
@@ -4027,12 +4028,13 @@ export interface components {
|
|
|
4027
4028
|
count?: components["schemas"]["Count"];
|
|
4028
4029
|
streaming?: boolean;
|
|
4029
4030
|
streamer?: components["schemas"]["UserStreamer"];
|
|
4030
|
-
/** @description only appears if the request is [authenticated with OAuth2](
|
|
4031
|
+
/** @description only appears if the request is [authenticated with OAuth2](#description/authentication) */
|
|
4031
4032
|
followable?: boolean;
|
|
4032
|
-
/** @description only appears if the request is [authenticated with OAuth2](
|
|
4033
|
+
/** @description only appears if the request is [authenticated with OAuth2](#description/authentication) */
|
|
4033
4034
|
following?: boolean;
|
|
4034
|
-
/** @description only appears if the request is [authenticated with OAuth2](
|
|
4035
|
+
/** @description only appears if the request is [authenticated with OAuth2](#description/authentication) */
|
|
4035
4036
|
blocking?: boolean;
|
|
4037
|
+
fideId?: number;
|
|
4036
4038
|
};
|
|
4037
4039
|
/**
|
|
4038
4040
|
* @example {
|
|
@@ -7679,6 +7681,8 @@ export interface operations {
|
|
|
7679
7681
|
profile?: boolean;
|
|
7680
7682
|
/** @description Include global lichess ranking for each perf */
|
|
7681
7683
|
rank?: boolean;
|
|
7684
|
+
/** @description Include public FIDE ID if any */
|
|
7685
|
+
fideId?: boolean;
|
|
7682
7686
|
};
|
|
7683
7687
|
header?: never;
|
|
7684
7688
|
path: {
|
|
@@ -8399,15 +8403,19 @@ export interface operations {
|
|
|
8399
8403
|
};
|
|
8400
8404
|
requestBody?: never;
|
|
8401
8405
|
responses: {
|
|
8402
|
-
/**
|
|
8406
|
+
/**
|
|
8407
|
+
* @description The ongoing (or last) game of a user.
|
|
8408
|
+
* This may be in either PGN or JSON format, depending on the `Accept` header of your request.
|
|
8409
|
+
*/
|
|
8403
8410
|
200: {
|
|
8404
8411
|
headers: {
|
|
8405
8412
|
"Access-Control-Allow-Origin"?: string;
|
|
8406
8413
|
[name: string]: unknown;
|
|
8407
8414
|
};
|
|
8408
8415
|
content: {
|
|
8409
|
-
"application/
|
|
8410
|
-
|
|
8416
|
+
"application/json":
|
|
8417
|
+
| components["schemas"]["GamePgn"]
|
|
8418
|
+
| components["schemas"]["GameJson"];
|
|
8411
8419
|
};
|
|
8412
8420
|
};
|
|
8413
8421
|
};
|
|
@@ -11720,7 +11728,7 @@ export interface operations {
|
|
|
11720
11728
|
};
|
|
11721
11729
|
requestBody?: never;
|
|
11722
11730
|
responses: {
|
|
11723
|
-
/** @description The list of teams the
|
|
11731
|
+
/** @description The list of teams the player is a member of. */
|
|
11724
11732
|
200: {
|
|
11725
11733
|
headers: {
|
|
11726
11734
|
"Access-Control-Allow-Origin"?: string;
|