@lichess-org/types 2.0.24 → 2.0.26

package/lichess-api.d.ts

@@ -1685,6 +1685,8 @@ export interface paths {
      * @description Create a new broadcast round to relay external games.
      *     This endpoint accepts the same form data as the web form.
      *
+     *     Choose one between `syncUrl`, `syncUrls`, `syncIds` and `syncUsers`, if it is missing, the broadcast needs to be fed by [pushing PGN to it](#operation/broadcastPush)
+     *
      */
     post: operations["broadcastRoundCreate"];
     delete?: never;
@@ -6452,7 +6454,7 @@ export interface components {
       /** @description Name of the broadcast round.
        *     Example: `Round 1`
        *      */
-      name?: string;
+      name: string;
     } & (
       | Record<string, never>
       | {
@@ -6464,10 +6466,9 @@ export interface components {
            *     ```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;
+          syncUrl: string;
           /** @description Filter games by round number
            *
            *     Optional, only keep games from the source that match a round number.
@@ -6505,9 +6506,8 @@ export interface components {
            *     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;
+          syncUrls: string;
           /** @description Filter games by round number
            *
            *     Optional, only keep games from the source that match a round number.
@@ -6539,9 +6539,13 @@ export interface components {
         }
       | {
           /** @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;
+          syncIds: string;
+        }
+      | {
+          /** @description Up to 100 Lichess usernames, separated by spaces
+           *      */
+          syncUsers: string;
         }
     ) & {
         /** @description Timestamp in milliseconds of broadcast round start. Leave empty to manually start the broadcast round.
@@ -6559,11 +6563,12 @@ export interface components {
          *      */
         delay?: number;
         /**
-         * @description Mark whether the round has been completed.
+         * @description Lichess can usually detect the round status, but you can also set it manually if needed.
          *
-         * @default false
+         * @default new
+         * @enum {string}
          */
-        finished?: boolean;
+        status?: "new" | "started" | "finished";
         /** @description (Only for Admins) Waiting time for each poll.
          *      */
         period?: number;
@@ -8805,7 +8810,7 @@ export interface operations {
       };
       header?: never;
       path: {
-        /** @description The game ID (8 characters). */
+        /** @description The game ID */
         gameId: string;
       };
       cookie?: never;
@@ -10090,7 +10095,7 @@ export interface operations {
       query?: never;
       header?: never;
       path: {
-        /** @description The tournament ID (8 characters).. */
+        /** @description The tournament ID */
         id: string;
       };
       cookie?: never;
@@ -11090,9 +11095,9 @@ export interface operations {
       };
       header?: never;
       path: {
-        /** @description The study ID (8 characters). */
+        /** @description The study ID */
         studyId: string;
-        /** @description The chapter ID (8 characters). */
+        /** @description The chapter ID */
         chapterId: string;
       };
       cookie?: never;
@@ -11136,7 +11141,7 @@ export interface operations {
       };
       header?: never;
       path: {
-        /** @description The study ID (8 characters). */
+        /** @description The study ID */
         studyId: string;
       };
       cookie?: never;
@@ -11161,7 +11166,7 @@ export interface operations {
       query?: never;
       header?: never;
       path: {
-        /** @description The study ID (8 characters). */
+        /** @description The study ID */
         studyId: string;
       };
       cookie?: never;
@@ -11305,9 +11310,9 @@ export interface operations {
       query?: never;
       header?: never;
       path: {
-        /** @description The study ID (8 characters). */
+        /** @description The study ID */
         studyId: string;
-        /** @description The chapter ID (8 characters). */
+        /** @description The chapter ID */
         chapterId: string;
       };
       cookie?: never;
@@ -11465,7 +11470,7 @@ export interface operations {
       query?: never;
       header?: never;
       path: {
-        /** @description The broadcast tournament ID (8 characters). */
+        /** @description The broadcast tournament ID */
         broadcastTournamentId: string;
       };
       cookie?: never;
@@ -11488,7 +11493,7 @@ export interface operations {
       query?: never;
       header?: never;
       path: {
-        /** @description The broadcast tournament ID (8 characters). */
+        /** @description The broadcast tournament ID */
         broadcastTournamentId: string;
       };
       cookie?: never;
@@ -11511,7 +11516,7 @@ export interface operations {
       query?: never;
       header?: never;
       path: {
-        /** @description The broadcast ID (8 characters). */
+        /** @description The broadcast ID */
         broadcastTournamentId: string;
       };
       cookie?: never;
@@ -11532,7 +11537,7 @@ export interface operations {
           "application/json": components["schemas"]["Ok"];
         };
       };
-      /** @description The edition of the broadcast tournament failed. */
+      /** @description The broadcast tournament update failed. */
       400: {
         headers: {
           [name: string]: unknown;
@@ -11548,7 +11553,7 @@ export interface operations {
       query?: never;
       header?: never;
       path: {
-        /** @description The broadcast tournament ID (8 characters). */
+        /** @description The broadcast tournament ID */
         broadcastTournamentId: string;
       };
       cookie?: never;
@@ -11589,7 +11594,7 @@ export interface operations {
         broadcastTournamentSlug: string;
         /** @description The broadcast round slug. Only used for SEO, the slug can be safely replaced by `-`. Only the `broadcastRoundId` is actually used. */
         broadcastRoundSlug: string;
-        /** @description The broadcast Round ID (8 characters). */
+        /** @description The broadcast Round ID */
         broadcastRoundId: string;
       };
       cookie?: never;
@@ -11612,7 +11617,7 @@ export interface operations {
       query?: never;
       header?: never;
       path: {
-        /** @description The broadcast round ID (8 characters). */
+        /** @description The broadcast round ID */
         broadcastRoundId: string;
       };
       cookie?: never;
@@ -11633,7 +11638,7 @@ export interface operations {
           "application/json": components["schemas"]["Ok"];
         };
       };
-      /** @description The edition of the broadcast tournament failed. */
+      /** @description The broadcast round update failed. */
       400: {
         headers: {
           [name: string]: unknown;
@@ -11649,7 +11654,7 @@ export interface operations {
       query?: never;
       header?: never;
       path: {
-        /** @description The broadcast round ID (8 characters). */
+        /** @description The broadcast round ID */
         broadcastRoundId: string;
       };
       cookie?: never;
@@ -11673,7 +11678,7 @@ export interface operations {
       query?: never;
       header?: never;
       path: {
-        /** @description The broadcast round ID (8 characters). */
+        /** @description The broadcast round ID */
         broadcastRoundId: string;
       };
       cookie?: never;
@@ -11714,7 +11719,7 @@ export interface operations {
       query?: never;
       header?: never;
       path: {
-        /** @description The broadcast round ID (8 characters). */
+        /** @description The broadcast round ID */
         broadcastRoundId: string;
       };
       cookie?: never;
@@ -11738,7 +11743,7 @@ export interface operations {
       query?: never;
       header?: never;
       path: {
-        /** @description The round ID (8 characters). */
+        /** @description The round ID */
         broadcastRoundId: string;
       };
       cookie?: never;
@@ -11762,7 +11767,7 @@ export interface operations {
       query?: never;
       header?: never;
       path: {
-        /** @description The broadcast tournament ID (8 characters). */
+        /** @description The broadcast tournament ID */
         broadcastTournamentId: string;
       };
       cookie?: never;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lichess-org/types",
-  "version": "2.0.24",
+  "version": "2.0.26",
   "description": "Lichess.org API types",
   "homepage": "https://github.com/lichess-org/api",
   "license": "AGPL-3.0-or-later",
@@ -12,7 +12,7 @@
   },
   "devDependencies": {
     "openapi-typescript": "^7.6.1",
-    "prettier": "^3.4.2",
+    "prettier": "^3.5.1",
     "typescript": "^5.7.3"
   },
   "packageManager": "pnpm@9.14.2+sha512.6e2baf77d06b9362294152c851c4f278ede37ab1eba3a55fda317a4a17b209f4dbb973fb250a77abc463a341fcb1f17f17cfa24091c4eb319cda0d9b84278387"