@lichess-org/types 2.0.151 → 2.0.153

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.
Files changed (2) hide show
  1. package/lichess-api.d.ts +55 -0
  2. package/package.json +1 -1
package/lichess-api.d.ts CHANGED
@@ -814,6 +814,29 @@ export interface paths {
814
814
  patch?: never;
815
815
  trace?: never;
816
816
  };
817
+ "/bookmark/{gameId}": {
818
+ parameters: {
819
+ query?: never;
820
+ header?: never;
821
+ path?: never;
822
+ cookie?: never;
823
+ };
824
+ get?: never;
825
+ put?: never;
826
+ /**
827
+ * Bookmark a game
828
+ * @description Add or remove a bookmark on a game, for the logged in user.
829
+ * By default, the bookmark is toggled: added if absent, removed if present.
830
+ * Use the `v` parameter to explicitly set the bookmark instead, making the request idempotent.
831
+ * Bookmarked games can be downloaded with the [export your bookmarked games](#tag/games/GET/api/games/export/bookmarks) endpoint.
832
+ */
833
+ post: operations["bookmarkToggle"];
834
+ delete?: never;
835
+ options?: never;
836
+ head?: never;
837
+ patch?: never;
838
+ trace?: never;
839
+ };
817
840
  "/api/tv/channels": {
818
841
  parameters: {
819
842
  query?: never;
@@ -2021,6 +2044,10 @@ export interface paths {
2021
2044
  * If a `study:read` [OAuth token](#tag/OAuth) is provided,
2022
2045
  * the private rounds where the user is a contributor will be available.
2023
2046
  * You may want to [download only the games of a single round](#tag/broadcasts/GET/api/broadcast/round/{broadcastRoundId}.pgn) instead.
2047
+ *
2048
+ * To get real-time updates about an ongoing tournament, please use the
2049
+ * [round PGN stream](#tag/broadcasts/GET/api/stream/broadcast/round/{broadcastRoundId}.pgn) or
2050
+ * [group PGN stream](#tag/broadcasts/GET/api/stream/broadcast/group/{broadcastGroupId}.pgn) endpoints instead.
2024
2051
  */
2025
2052
  get: operations["broadcastAllRoundsPgn"];
2026
2053
  put?: never;
@@ -9204,6 +9231,34 @@ export interface operations {
9204
9231
  };
9205
9232
  };
9206
9233
  };
9234
+ bookmarkToggle: {
9235
+ parameters: {
9236
+ query?: {
9237
+ /**
9238
+ * @description Explicitly set the bookmark instead of toggling it.
9239
+ * `true` adds the bookmark, `false` removes it.
9240
+ * @example true
9241
+ */
9242
+ v?: boolean;
9243
+ };
9244
+ header?: never;
9245
+ path: {
9246
+ gameId: string;
9247
+ };
9248
+ cookie?: never;
9249
+ };
9250
+ requestBody?: never;
9251
+ responses: {
9252
+ /** @description The bookmark was successfully added or removed. */
9253
+ 204: {
9254
+ headers: {
9255
+ "Access-Control-Allow-Origin"?: string;
9256
+ [name: string]: unknown;
9257
+ };
9258
+ content?: never;
9259
+ };
9260
+ };
9261
+ };
9207
9262
  tvChannels: {
9208
9263
  parameters: {
9209
9264
  query?: never;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@lichess-org/types",
3
- "version": "2.0.151",
3
+ "version": "2.0.153",
4
4
  "description": "Lichess.org API types",
5
5
  "homepage": "https://github.com/lichess-org/api",
6
6
  "license": "AGPL-3.0-or-later",