@lichess-org/types 2.0.14 → 2.0.16

package/lichess-api.d.ts

@@ -1029,6 +1029,10 @@ export interface paths {
      * @description Get all tournaments created by a given user.
      *     Tournaments are sorted by reverse chronological order of start date (last starting first).
      *     Tournaments are streamed as [ndjson](#section/Introduction/Streaming-with-ND-JSON).
+     *     The stream is throttled, depending on who is making the request:
+     *       - Anonymous request: 20 tournaments per second
+     *       - [OAuth2 authenticated](#section/Introduction/Authentication) request: 30 tournaments per second
+     *       - Authenticated, downloading your own tournaments: 50 games per second
      *
      */
     get: operations["apiUserNameTournamentCreated"];
@@ -1040,6 +1044,33 @@ export interface paths {
     patch?: never;
     trace?: never;
   };
+  "/api/user/{username}/tournament/played": {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    /**
+     * Get tournaments played by a user
+     * @description Get all tournaments played by a given user.
+     *     Tournaments are sorted by reverse chronological order of start date (last played first).
+     *     Tournaments are streamed as [ndjson](#section/Introduction/Streaming-with-ND-JSON).
+     *     The stream is throttled, depending on who is making the request:
+     *       - Anonymous request: 20 tournaments per second
+     *       - [OAuth2 authenticated](#section/Introduction/Authentication) request: 30 tournaments per second
+     *       - Authenticated, downloading your own tournaments: 50 games per second
+     *
+     */
+    get: operations["apiUserNameTournamentPlayed"];
+    put?: never;
+    post?: never;
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
   "/api/swiss/new/{teamId}": {
     parameters: {
       query?: never;
@@ -5144,7 +5175,10 @@ export interface components {
           name?: string;
           /** @example rnbqkbnr/ppp2ppp/3p4/4p3/4P3/5N2/PPPP1PPP/RNBQKB1R w KQkq - */
           fen?: string;
-          /** @example https://lichess.org/opening/Philidor_Defense */
+          /**
+           * Format: uri
+           * @example https://lichess.org/opening/Philidor_Defense
+           */
           url?: string;
         }
       | {
@@ -5567,6 +5601,14 @@ export interface components {
       /** @description The cause of the error. */
       error?: string;
     };
+    ArenaTournamentPlayed: {
+      tournament?: components["schemas"]["ArenaTournament"];
+      player?: {
+        games?: number;
+        score?: number;
+        rank?: number;
+      };
+    };
     /**
      * @description Custom initial position (in FEN). Variant must be standard and the game cannot be rated.
      * @default rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq - 0 1
@@ -5720,11 +5762,13 @@ export interface components {
       };
       /** @description Used to designate featured tournaments on Lichess */
       tier?: number;
+      /** Format: uri */
       image?: string;
       /** @description Full tournament description in markdown format, or in HTML if the html=1 query parameter is set. */
       description?: string;
       leaderboard?: boolean;
       teamTable?: boolean;
+      /** Format: uri */
       url: string;
     };
     BroadcastGroupTour: {
@@ -5747,6 +5791,7 @@ export interface components {
       /** @description The start date/time is unknown and the round will start automatically when the previous round completes */
       startsAfterPrevious?: boolean;
       finished?: boolean;
+      /** Format: uri */
       url: string;
       /** Format: int64 */
       delay?: number;
@@ -5926,85 +5971,122 @@ export interface components {
       /** @description Name of the broadcast round.
        *     Example: `Round 1`
        *      */
-      name: string;
-      /** @description URL that Lichess will poll to get updates about the games. It must be publicly accessible from the Internet.
-       *
-       *     Example:
-       *     ```txt
-       *     https://myserver.org/myevent/round-10/games.pgn
-       *     ```
-       *
-       *     Choose one between `syncUrl`, `syncUrls` and `syncIds`, if it is missing, the broadcast needs to be fed by [pushing PGN to it](#operation/broadcastPush)
-       *      */
-      syncUrl?: string;
-      /** @description URLs that Lichess will poll to get updates about the games. It must be publicly accessible from the Internet.
-       *
-       *     Example:
-       *     ```txt
-       *     https://myserver.org/myevent/round-10/game-1.pgn
-       *     https://myserver.org/myevent/round-10/game-2.pgn
-       *     ```
-       *
-       *     Choose one between `syncUrl`, `syncUrls` and `syncIds`, if it is missing, the broadcast needs to be fed by [pushing PGN to it](#operation/broadcastPush)
-       *      */
-      syncUrls?: string;
-      /** @description Lichess game IDs - Up to 64 Lichess game IDs, separated by spaces.
-       *
-       *     Choose one between `syncUrl`, `syncUrls` and `syncIds`, if it is missing, the broadcast needs to be fed by [pushing PGN to it](#operation/broadcastPush)
-       *      */
-      syncIds?: string;
-      /** @description Filter games by round number
-       *
-       *     Optional, only keep games from the source that match a round number.
-       *     It uses the PGN **Round** tag. These would match round 3:
-       *     ```txt
-       *     [Round "3"]
-       *     [Round "3.1"]
-       *     ```
-       *     If you set a round number, then games without a **Round** tag are dropped.
-       *
-       *     It only works if you chose `syncUrl` or `syncUrls` as the source.
-       *      */
-      onlyRound?: number;
-      /** @description Select slices of the games
-       *
-       *     Optional. Select games based on their position in the source.
-       *     ```txt
-       *     1           only select the first board
-       *     1-4         only select the first 4 boards
-       *     1,2,3,4     same as above, first 4 boards
-       *     11-15,21-25 boards 11 to 15, and boards 21 to 25
-       *     2,3,7-9     boards 2, 3, 7, 8, and 9
-       *     ```
-       *     Slicing is done after filtering by round number.
-       *
-       *     It only works if you chose `syncUrl` or `syncUrls` as the source.
-       *      */
-      slices?: string;
-      /** @description Timestamp in milliseconds of broadcast round start. Leave empty to manually start the broadcast round.
-       *     Example: `1356998400070`
-       *      */
-      startsAt?: number;
-      /**
-       * @description The start date is unknown, and the round will start automatically when the previous round completes.
-       *
-       * @default false
-       */
-      startsAfterPrevious?: boolean;
-      /** @description Delay in seconds for movements to appear on the broadcast. Leave it empty if you don't need it.
-       *     Example: `900` (15 min)
-       *      */
-      delay?: number;
-      /**
-       * @description Mark whether the round has been completed.
-       *
-       * @default false
-       */
-      finished?: boolean;
-      /** @description (Only for Admins) Waiting time for each poll.
-       *      */
-      period?: number;
-    };
+      name?: string;
+    } & (
+      | Record<string, never>
+      | {
+          /**
+           * Format: uri
+           * @description URL that Lichess will poll to get updates about the games. It must be publicly accessible from the Internet.
+           *
+           *     Example:
+           *     ```txt
+           *     https://myserver.org/myevent/round-10/games.pgn
+           *     ```
+           *     Choose one between `syncUrl`, `syncUrls` and `syncIds`, if it is missing, the broadcast needs to be fed by [pushing PGN to it](#operation/broadcastPush)
+           *
+           */
+          syncUrl?: string;
+          /** @description Filter games by round number
+           *
+           *     Optional, only keep games from the source that match a round number.
+           *     It uses the PGN **Round** tag. These would match round 3:
+           *     ```txt
+           *     [Round "3"]
+           *     [Round "3.1"]
+           *     ```
+           *     If you set a round number, then games without a **Round** tag are dropped.
+           *
+           *     It only works if you chose `syncUrl` or `syncUrls` as the source.
+           *      */
+          onlyRound?: number;
+          /** @description Select slices of the games
+           *
+           *     Optional. Select games based on their position in the source.
+           *     ```txt
+           *     1           only select the first board
+           *     1-4         only select the first 4 boards
+           *     1,2,3,4     same as above, first 4 boards
+           *     11-15,21-25 boards 11 to 15, and boards 21 to 25
+           *     2,3,7-9     boards 2, 3, 7, 8, and 9
+           *     ```
+           *     Slicing is done after filtering by round number.
+           *
+           *     It only works if you chose `syncUrl` or `syncUrls` as the source.
+           *      */
+          slices?: string;
+        }
+      | {
+          /** @description URLs that Lichess will poll to get updates about the games, separated by newlines. They must be publicly accessible from the Internet.
+           *
+           *     Example:
+           *     ```txt
+           *     https://myserver.org/myevent/round-10/game-1.pgn
+           *     https://myserver.org/myevent/round-10/game-2.pgn
+           *     ```
+           *     Choose one between `syncUrl`, `syncUrls` and `syncIds`, if it is missing, the broadcast needs to be fed by [pushing PGN to it](#operation/broadcastPush)
+           *      */
+          syncUrls?: string;
+          /** @description Filter games by round number
+           *
+           *     Optional, only keep games from the source that match a round number.
+           *     It uses the PGN **Round** tag. These would match round 3:
+           *     ```txt
+           *     [Round "3"]
+           *     [Round "3.1"]
+           *     ```
+           *     If you set a round number, then games without a **Round** tag are dropped.
+           *
+           *     It only works if you chose `syncUrl` or `syncUrls` as the source.
+           *      */
+          onlyRound?: number;
+          /** @description Select slices of the games
+           *
+           *     Optional. Select games based on their position in the source.
+           *     ```txt
+           *     1           only select the first board
+           *     1-4         only select the first 4 boards
+           *     1,2,3,4     same as above, first 4 boards
+           *     11-15,21-25 boards 11 to 15, and boards 21 to 25
+           *     2,3,7-9     boards 2, 3, 7, 8, and 9
+           *     ```
+           *     Slicing is done after filtering by round number.
+           *
+           *     It only works if you chose `syncUrl` or `syncUrls` as the source.
+           *      */
+          slices?: string;
+        }
+      | {
+          /** @description Lichess game IDs - Up to 64 Lichess game IDs, separated by spaces.
+           *     Choose one between `syncUrl`, `syncUrls` and `syncIds`, if it is missing, the broadcast needs to be fed by [pushing PGN to it](#operation/broadcastPush)
+           *      */
+          syncIds?: string;
+        }
+    ) & {
+        /** @description Timestamp in milliseconds of broadcast round start. Leave empty to manually start the broadcast round.
+         *     Example: `1356998400070`
+         *      */
+        startsAt?: number;
+        /**
+         * @description The start date is unknown, and the round will start automatically when the previous round completes.
+         *
+         * @default false
+         */
+        startsAfterPrevious?: boolean;
+        /** @description Delay in seconds for movements to appear on the broadcast. Leave it empty if you don't need it.
+         *     Example: `900` (15 min)
+         *      */
+        delay?: number;
+        /**
+         * @description Mark whether the round has been completed.
+         *
+         * @default false
+         */
+        finished?: boolean;
+        /** @description (Only for Admins) Waiting time for each poll.
+         *      */
+        period?: number;
+      };
     BroadcastRoundStudyInfo: {
       /** @description Whether the currently authenticated user has permission to update the study */
       writeable?: boolean;
@@ -6500,6 +6582,7 @@ export interface components {
      *     } */
     ChallengeJson: {
       id: string;
+      /** Format: uri */
       url: string;
       /** @enum {string} */
       status: "created" | "offline" | "canceled" | "declined" | "accepted";
@@ -6833,6 +6916,7 @@ export interface components {
      *     } */
     ChallengeOpenJson: {
       id: string;
+      /** Format: uri */
       url: string;
       /** @enum {string} */
       status: "created" | "offline" | "canceled" | "declined" | "accepted";
@@ -9290,6 +9374,8 @@ export interface operations {
   apiUserNameTournamentCreated: {
     parameters: {
       query?: {
+        /** @description Max number of tournaments to fetch */
+        nb?: number;
         /** @description Include tournaments in the given status: "Created" (10), "Started" (20), "Finished" (30)
          *     You can add this parameter more than once to include tournaments in different statuses.
          *     Example: `?status=10&status=20`
@@ -9317,6 +9403,33 @@ export interface operations {
       };
     };
   };
+  apiUserNameTournamentPlayed: {
+    parameters: {
+      query?: {
+        /** @description Max number of tournaments to fetch */
+        nb?: number;
+      };
+      header?: never;
+      path: {
+        /** @description The user whose played tournaments to fetch */
+        username: string;
+      };
+      cookie?: never;
+    };
+    requestBody?: never;
+    responses: {
+      /** @description The list of tournaments played by the user. */
+      200: {
+        headers: {
+          "Access-Control-Allow-Origin"?: string;
+          [name: string]: unknown;
+        };
+        content: {
+          "application/x-ndjson": components["schemas"]["ArenaTournamentPlayed"];
+        };
+      };
+    };
+  };
   apiSwissNew: {
     parameters: {
       query?: never;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lichess-org/types",
-  "version": "2.0.14",
+  "version": "2.0.16",
   "description": "Lichess.org API types",
   "homepage": "https://github.com/lichess-org/api",
   "license": "AGPL-3.0-or-later",