lishogi 0.1.0

data/lib/lishogi/api/games_api.rb

@@ -0,0 +1,514 @@
+=begin
+#Lishogi.org API reference
+
+## Introduction Welcome to the reference for the Lishogi API! Lishogi is free/libre, open-source shogi server forked from lichess powered by volunteers and donations.  Currently this page is a work in progress, certain information here might be wrong and incorrect! Expect it to be done during 2022. - Get help in the [Lishogi Discord channel](https://discord.gg/YFtpMGg3rR) - [Contribute to this documentation on Github](https://github.com/WandererXII/lishogi/blob/master/public/doc/lishogi-api.yaml) - Check out [Lishogi widgets to embed in your website](https://lishogi.org/developers)  ## Endpoint All requests go to `https://lishogi.org` (unless otherwise specified).  ## Rate limiting All requests are rate limited using various strategies, to ensure the API remains responsive for everyone. Only make one request at a time. If you receive an HTTP response with a [429 status](https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#429), please wait a full minute before resuming API usage.  ## Streaming with ND-JSON Some API endpoints stream their responses as [Newline Delimited JSON a.k.a. **nd-json**](http://ndjson.org/), with one JSON object per line.  Here's a [JavaScript utility function (for lichess)](https://gist.github.com/ornicar/a097406810939cf7be1df8ea30e94f3e) to help reading NDJSON streamed responses. 
+
+The version of the OpenAPI document: 2.0.0
+Contact: contact@lishogi.org
+Generated by: https://openapi-generator.tech
+Generator version: 7.10.0
+
+=end
+
+require 'cgi'
+
+module Lishogi
+  class GamesApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get my ongoing games
+    # Get the ongoing games of the current user. Real-time and correspondence games are included. The most urgent games are listed first. 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :nb Max number of games to fetch (default to 9)
+    # @return [Object]
+    def api_account_playing(opts = {})
+      data, _status_code, _headers = api_account_playing_with_http_info(opts)
+      data
+    end
+
+    # Get my ongoing games
+    # Get the ongoing games of the current user. Real-time and correspondence games are included. The most urgent games are listed first. 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :nb Max number of games to fetch (default to 9)
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def api_account_playing_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: GamesApi.api_account_playing ...'
+      end
+      if @api_client.config.client_side_validation && !opts[:'nb'].nil? && opts[:'nb'] > 50
+        fail ArgumentError, 'invalid value for "opts[:"nb"]" when calling GamesApi.api_account_playing, must be smaller than or equal to 50.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'nb'].nil? && opts[:'nb'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"nb"]" when calling GamesApi.api_account_playing, must be greater than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/api/account/playing'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'nb'] = opts[:'nb'] if !opts[:'nb'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :operation => :"GamesApi.api_account_playing",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: GamesApi#api_account_playing\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Export games of a user
+    # Download all games of any user in KIF or [ndjson](#section/Introduction/Streaming-with-ND-JSON) format.  Games are sorted by reverse chronological order (most recent first).  We recommend streaming the response, for it can be very long. <https://lishogi.org/@/YoBot_v2> for instance has more than 15,000 games.  The game stream is throttled, depending on who is making the request:   - Anonymous request: 20 games per second   - [OAuth2 authenticated](#section/Authentication) request: 30 games per second   - Authenticated, downloading your own games: 60 games per second 
+    # @param username [String] The user name.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :since Download games played since this timestamp. Defaults to account creation date.
+    # @option opts [Integer] :_until Download games played until this timestamp. Defaults to now.
+    # @option opts [Integer] :max How many games to download. Leave empty to download all games.
+    # @option opts [String] :vs [Filter] Only games played against this opponent
+    # @option opts [Boolean] :rated [Filter] Only rated (&#x60;true&#x60;) or casual (&#x60;false&#x60;) games
+    # @option opts [PerfType] :perf_type [Filter] Only games in these speeds or variants.   Multiple perf types can be specified, separated by a comma.   Example: blitz,rapid,classical
+    # @option opts [String] :color [Filter] Only games played as this color.
+    # @option opts [Boolean] :analysed [Filter] Only games with or without a computer analysis available
+    # @option opts [Boolean] :moves Include the KIF moves.
+    # @option opts [Boolean] :pgn_in_json Include the full KIF within the JSON response, in a &#x60;notation&#x60; field. The response type must be set to &#x60;application/x-ndjson&#x60; by the request &#x60;Accept&#x60; header. (default to false)
+    # @option opts [Boolean] :tags Include the KIF tags. (default to true)
+    # @option opts [Boolean] :clocks Include clock comments in the KIF moves, when available.  Example: &#x60;22   同　玉(51)   (00:02/00:00:13)&#x60;  (default to false)
+    # @option opts [Boolean] :evals Include analysis evaluation comments in the KIF, when available.  Example: &#x60;9   ７八銀(79)   * [%eval -1.48]&#x60;  (default to false)
+    # @option opts [Boolean] :ongoing Include ongoing games. The last 3 moves will be omitted. (default to false)
+    # @option opts [Boolean] :finished Include finished games. Set to &#x60;false&#x60; to only get ongoing games. (default to true)
+    # @option opts [String] :players URL of a text file containing real names and ratings, to replace Lishogi usernames and ratings in the KIF. Example: &lt;https://gist.githubusercontent.com/ornicar/6bfa91eb61a2dcae7bcd14cce1b2a4eb/raw/768b9f6cc8a8471d2555e47ba40fb0095e5fba37/gistfile1.txt&gt; 
+    # @option opts [String] :sort Sort order of the games. (default to 'dateDesc')
+    # @return [Object]
+    def api_games_user(username, opts = {})
+      data, _status_code, _headers = api_games_user_with_http_info(username, opts)
+      data
+    end
+
+    # Export games of a user
+    # Download all games of any user in KIF or [ndjson](#section/Introduction/Streaming-with-ND-JSON) format.  Games are sorted by reverse chronological order (most recent first).  We recommend streaming the response, for it can be very long. &lt;https://lishogi.org/@/YoBot_v2&gt; for instance has more than 15,000 games.  The game stream is throttled, depending on who is making the request:   - Anonymous request: 20 games per second   - [OAuth2 authenticated](#section/Authentication) request: 30 games per second   - Authenticated, downloading your own games: 60 games per second 
+    # @param username [String] The user name.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :since Download games played since this timestamp. Defaults to account creation date.
+    # @option opts [Integer] :_until Download games played until this timestamp. Defaults to now.
+    # @option opts [Integer] :max How many games to download. Leave empty to download all games.
+    # @option opts [String] :vs [Filter] Only games played against this opponent
+    # @option opts [Boolean] :rated [Filter] Only rated (&#x60;true&#x60;) or casual (&#x60;false&#x60;) games
+    # @option opts [PerfType] :perf_type [Filter] Only games in these speeds or variants.   Multiple perf types can be specified, separated by a comma.   Example: blitz,rapid,classical
+    # @option opts [String] :color [Filter] Only games played as this color.
+    # @option opts [Boolean] :analysed [Filter] Only games with or without a computer analysis available
+    # @option opts [Boolean] :moves Include the KIF moves.
+    # @option opts [Boolean] :pgn_in_json Include the full KIF within the JSON response, in a &#x60;notation&#x60; field. The response type must be set to &#x60;application/x-ndjson&#x60; by the request &#x60;Accept&#x60; header. (default to false)
+    # @option opts [Boolean] :tags Include the KIF tags. (default to true)
+    # @option opts [Boolean] :clocks Include clock comments in the KIF moves, when available.  Example: &#x60;22   同　玉(51)   (00:02/00:00:13)&#x60;  (default to false)
+    # @option opts [Boolean] :evals Include analysis evaluation comments in the KIF, when available.  Example: &#x60;9   ７八銀(79)   * [%eval -1.48]&#x60;  (default to false)
+    # @option opts [Boolean] :ongoing Include ongoing games. The last 3 moves will be omitted. (default to false)
+    # @option opts [Boolean] :finished Include finished games. Set to &#x60;false&#x60; to only get ongoing games. (default to true)
+    # @option opts [String] :players URL of a text file containing real names and ratings, to replace Lishogi usernames and ratings in the KIF. Example: &lt;https://gist.githubusercontent.com/ornicar/6bfa91eb61a2dcae7bcd14cce1b2a4eb/raw/768b9f6cc8a8471d2555e47ba40fb0095e5fba37/gistfile1.txt&gt; 
+    # @option opts [String] :sort Sort order of the games. (default to 'dateDesc')
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def api_games_user_with_http_info(username, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: GamesApi.api_games_user ...'
+      end
+      # verify the required parameter 'username' is set
+      if @api_client.config.client_side_validation && username.nil?
+        fail ArgumentError, "Missing the required parameter 'username' when calling GamesApi.api_games_user"
+      end
+      if @api_client.config.client_side_validation && !opts[:'since'].nil? && opts[:'since'] < 1356998400070
+        fail ArgumentError, 'invalid value for "opts[:"since"]" when calling GamesApi.api_games_user, must be greater than or equal to 1356998400070.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'_until'].nil? && opts[:'_until'] < 1356998400070
+        fail ArgumentError, 'invalid value for "opts[:"_until"]" when calling GamesApi.api_games_user, must be greater than or equal to 1356998400070.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'max'].nil? && opts[:'max'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"max"]" when calling GamesApi.api_games_user, must be greater than or equal to 1.'
+      end
+
+      allowable_values = ["sente", "gote"]
+      if @api_client.config.client_side_validation && opts[:'color'] && !allowable_values.include?(opts[:'color'])
+        fail ArgumentError, "invalid value for \"color\", must be one of #{allowable_values}"
+      end
+      allowable_values = ["dateAsc", "dateDesc"]
+      if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
+        fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/api/games/user/{username}'.sub('{' + 'username' + '}', CGI.escape(username.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
+      query_params[:'until'] = opts[:'_until'] if !opts[:'_until'].nil?
+      query_params[:'max'] = opts[:'max'] if !opts[:'max'].nil?
+      query_params[:'vs'] = opts[:'vs'] if !opts[:'vs'].nil?
+      query_params[:'rated'] = opts[:'rated'] if !opts[:'rated'].nil?
+      query_params[:'perfType'] = opts[:'perf_type'] if !opts[:'perf_type'].nil?
+      query_params[:'color'] = opts[:'color'] if !opts[:'color'].nil?
+      query_params[:'analysed'] = opts[:'analysed'] if !opts[:'analysed'].nil?
+      query_params[:'moves'] = opts[:'moves'] if !opts[:'moves'].nil?
+      query_params[:'pgnInJson'] = opts[:'pgn_in_json'] if !opts[:'pgn_in_json'].nil?
+      query_params[:'tags'] = opts[:'tags'] if !opts[:'tags'].nil?
+      query_params[:'clocks'] = opts[:'clocks'] if !opts[:'clocks'].nil?
+      query_params[:'evals'] = opts[:'evals'] if !opts[:'evals'].nil?
+      query_params[:'ongoing'] = opts[:'ongoing'] if !opts[:'ongoing'].nil?
+      query_params[:'finished'] = opts[:'finished'] if !opts[:'finished'].nil?
+      query_params[:'players'] = opts[:'players'] if !opts[:'players'].nil?
+      query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/x-ndjson']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :operation => :"GamesApi.api_games_user",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: GamesApi#api_games_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Export ongoing game of a user
+    # Download the ongoing game, or the last game played, of a user. Available in either KIF or JSON format. If the game is ongoing, the 3 last moves are omitted. 
+    # @param username [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :moves Include the KIF moves. (default to true)
+    # @option opts [Boolean] :tags Include the KIF tags. (default to true)
+    # @option opts [Boolean] :clocks Include clock comments in the KIF moves, when available.  Example: &#x60;22   同　玉(51)   (00:02/00:00:13)&#x60;  (default to true)
+    # @option opts [Boolean] :evals Include analysis evaluation comments in the KIF, when available.  Example: &#x60;9   ７八銀(79)   * [%eval -1.48]&#x60;  (default to true)
+    # @option opts [String] :players URL of a text file containing real names and ratings, to replace Lishogi usernames and ratings in the KIF. Example: &lt;https://gist.githubusercontent.com/ornicar/6bfa91eb61a2dcae7bcd14cce1b2a4eb/raw/768b9f6cc8a8471d2555e47ba40fb0095e5fba37/gistfile1.txt&gt; 
+    # @return [Object]
+    def api_user_current_game(username, opts = {})
+      data, _status_code, _headers = api_user_current_game_with_http_info(username, opts)
+      data
+    end
+
+    # Export ongoing game of a user
+    # Download the ongoing game, or the last game played, of a user. Available in either KIF or JSON format. If the game is ongoing, the 3 last moves are omitted. 
+    # @param username [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :moves Include the KIF moves. (default to true)
+    # @option opts [Boolean] :tags Include the KIF tags. (default to true)
+    # @option opts [Boolean] :clocks Include clock comments in the KIF moves, when available.  Example: &#x60;22   同　玉(51)   (00:02/00:00:13)&#x60;  (default to true)
+    # @option opts [Boolean] :evals Include analysis evaluation comments in the KIF, when available.  Example: &#x60;9   ７八銀(79)   * [%eval -1.48]&#x60;  (default to true)
+    # @option opts [String] :players URL of a text file containing real names and ratings, to replace Lishogi usernames and ratings in the KIF. Example: &lt;https://gist.githubusercontent.com/ornicar/6bfa91eb61a2dcae7bcd14cce1b2a4eb/raw/768b9f6cc8a8471d2555e47ba40fb0095e5fba37/gistfile1.txt&gt; 
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def api_user_current_game_with_http_info(username, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: GamesApi.api_user_current_game ...'
+      end
+      # verify the required parameter 'username' is set
+      if @api_client.config.client_side_validation && username.nil?
+        fail ArgumentError, "Missing the required parameter 'username' when calling GamesApi.api_user_current_game"
+      end
+      # resource path
+      local_var_path = '/api/user/{username}/current-game'.sub('{' + 'username' + '}', CGI.escape(username.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'moves'] = opts[:'moves'] if !opts[:'moves'].nil?
+      query_params[:'tags'] = opts[:'tags'] if !opts[:'tags'].nil?
+      query_params[:'clocks'] = opts[:'clocks'] if !opts[:'clocks'].nil?
+      query_params[:'evals'] = opts[:'evals'] if !opts[:'evals'].nil?
+      query_params[:'players'] = opts[:'players'] if !opts[:'players'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"GamesApi.api_user_current_game",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: GamesApi#api_user_current_game\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Export one game
+    # Download one game in either KIF or JSON format.  Ongoing games have their last 3 moves omitted, after move 5. 
+    # @param game_id [String] The game ID (8 characters).
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :moves Include the KIF moves. (default to true)
+    # @option opts [Boolean] :tags Include the KIF tags. (default to true)
+    # @option opts [Boolean] :clocks Include clock comments in the KIF moves, when available.  Example: &#x60;22   同　玉(51)   (00:02/00:00:13)&#x60;  (default to true)
+    # @option opts [Boolean] :evals Include analysis evaluation comments in the KIF, when available.  Example: &#x60;9   ７八銀(79)   * [%eval -1.48]&#x60;  (default to true)
+    # @option opts [String] :players URL of a text file containing real names and ratings, to replace Lishogi usernames and ratings in the KIF. Example: &lt;https://gist.githubusercontent.com/ornicar/6bfa91eb61a2dcae7bcd14cce1b2a4eb/raw/768b9f6cc8a8471d2555e47ba40fb0095e5fba37/gistfile1.txt&gt; 
+    # @return [Object]
+    def game_kif(game_id, opts = {})
+      data, _status_code, _headers = game_kif_with_http_info(game_id, opts)
+      data
+    end
+
+    # Export one game
+    # Download one game in either KIF or JSON format.  Ongoing games have their last 3 moves omitted, after move 5. 
+    # @param game_id [String] The game ID (8 characters).
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :moves Include the KIF moves. (default to true)
+    # @option opts [Boolean] :tags Include the KIF tags. (default to true)
+    # @option opts [Boolean] :clocks Include clock comments in the KIF moves, when available.  Example: &#x60;22   同　玉(51)   (00:02/00:00:13)&#x60;  (default to true)
+    # @option opts [Boolean] :evals Include analysis evaluation comments in the KIF, when available.  Example: &#x60;9   ７八銀(79)   * [%eval -1.48]&#x60;  (default to true)
+    # @option opts [String] :players URL of a text file containing real names and ratings, to replace Lishogi usernames and ratings in the KIF. Example: &lt;https://gist.githubusercontent.com/ornicar/6bfa91eb61a2dcae7bcd14cce1b2a4eb/raw/768b9f6cc8a8471d2555e47ba40fb0095e5fba37/gistfile1.txt&gt; 
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def game_kif_with_http_info(game_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: GamesApi.game_kif ...'
+      end
+      # verify the required parameter 'game_id' is set
+      if @api_client.config.client_side_validation && game_id.nil?
+        fail ArgumentError, "Missing the required parameter 'game_id' when calling GamesApi.game_kif"
+      end
+      # resource path
+      local_var_path = '/game/export/{gameId}'.sub('{' + 'gameId' + '}', CGI.escape(game_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'moves'] = opts[:'moves'] if !opts[:'moves'].nil?
+      query_params[:'tags'] = opts[:'tags'] if !opts[:'tags'].nil?
+      query_params[:'clocks'] = opts[:'clocks'] if !opts[:'clocks'].nil?
+      query_params[:'evals'] = opts[:'evals'] if !opts[:'evals'].nil?
+      query_params[:'players'] = opts[:'players'] if !opts[:'players'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"GamesApi.game_kif",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: GamesApi#game_kif\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Stream games of users
+    # Stream the games played between a list of users, in real time. Only games where **both players** are part of the list are included.  By default, games are only sent to the stream when they start. To also get all ongoing games at the beginning of the stream, use the `withCurrentGames` flag.  Maximum number of users: 300.  Games are streamed as [ndjson](#section/Introduction/Streaming-with-ND-JSON).  The method is `POST` so a longer list of IDs can be sent in the request body. 
+    # @param body [String] Up to 300 user IDs separated by commas.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :with_current_games Include the already started games at the beginning of the stream. (default to false)
+    # @return [Object]
+    def games_by_users(body, opts = {})
+      data, _status_code, _headers = games_by_users_with_http_info(body, opts)
+      data
+    end
+
+    # Stream games of users
+    # Stream the games played between a list of users, in real time. Only games where **both players** are part of the list are included.  By default, games are only sent to the stream when they start. To also get all ongoing games at the beginning of the stream, use the &#x60;withCurrentGames&#x60; flag.  Maximum number of users: 300.  Games are streamed as [ndjson](#section/Introduction/Streaming-with-ND-JSON).  The method is &#x60;POST&#x60; so a longer list of IDs can be sent in the request body. 
+    # @param body [String] Up to 300 user IDs separated by commas.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :with_current_games Include the already started games at the beginning of the stream. (default to false)
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def games_by_users_with_http_info(body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: GamesApi.games_by_users ...'
+      end
+      # verify the required parameter 'body' is set
+      if @api_client.config.client_side_validation && body.nil?
+        fail ArgumentError, "Missing the required parameter 'body' when calling GamesApi.games_by_users"
+      end
+      # resource path
+      local_var_path = '/api/stream/games-by-users'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'withCurrentGames'] = opts[:'with_current_games'] if !opts[:'with_current_games'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/x-ndjson']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['text/plain'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(body)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"GamesApi.games_by_users",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: GamesApi#games_by_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Stream moves of a game
+    # Stream positions and moves of any ongoing game, in [ndjson](#section/Introduction/Streaming-with-ND-JSON).  A description of the game is sent as a first message. Then a message is sent each time a move is played. Finally a description of the game is sent when it finishes, and the stream is closed.  After move 5, the stream intentionally remains 3 moves behind the game status, as to prevent cheat bots from using this API.  No more than 8 game streams can be opened at the same time from the same IP address. 
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def stream_game(id, opts = {})
+      data, _status_code, _headers = stream_game_with_http_info(id, opts)
+      data
+    end
+
+    # Stream moves of a game
+    # Stream positions and moves of any ongoing game, in [ndjson](#section/Introduction/Streaming-with-ND-JSON).  A description of the game is sent as a first message. Then a message is sent each time a move is played. Finally a description of the game is sent when it finishes, and the stream is closed.  After move 5, the stream intentionally remains 3 moves behind the game status, as to prevent cheat bots from using this API.  No more than 8 game streams can be opened at the same time from the same IP address. 
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def stream_game_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: GamesApi.stream_game ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling GamesApi.stream_game"
+      end
+      # resource path
+      local_var_path = '/api/stream/game/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/x-ndjson']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"GamesApi.stream_game",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: GamesApi#stream_game\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/lishogi/api/messaging_api.rb

@@ -0,0 +1,97 @@
+=begin
+#Lishogi.org API reference
+
+## Introduction Welcome to the reference for the Lishogi API! Lishogi is free/libre, open-source shogi server forked from lichess powered by volunteers and donations.  Currently this page is a work in progress, certain information here might be wrong and incorrect! Expect it to be done during 2022. - Get help in the [Lishogi Discord channel](https://discord.gg/YFtpMGg3rR) - [Contribute to this documentation on Github](https://github.com/WandererXII/lishogi/blob/master/public/doc/lishogi-api.yaml) - Check out [Lishogi widgets to embed in your website](https://lishogi.org/developers)  ## Endpoint All requests go to `https://lishogi.org` (unless otherwise specified).  ## Rate limiting All requests are rate limited using various strategies, to ensure the API remains responsive for everyone. Only make one request at a time. If you receive an HTTP response with a [429 status](https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#429), please wait a full minute before resuming API usage.  ## Streaming with ND-JSON Some API endpoints stream their responses as [Newline Delimited JSON a.k.a. **nd-json**](http://ndjson.org/), with one JSON object per line.  Here's a [JavaScript utility function (for lichess)](https://gist.github.com/ornicar/a097406810939cf7be1df8ea30e94f3e) to help reading NDJSON streamed responses. 
+
+The version of the OpenAPI document: 2.0.0
+Contact: contact@lishogi.org
+Generated by: https://openapi-generator.tech
+Generator version: 7.10.0
+
+=end
+
+require 'cgi'
+
+module Lishogi
+  class MessagingApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Send a private message
+    # Send a private message to another player. 
+    # @param username [String] 
+    # @param text [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Ok]
+    def inbox_username(username, text, opts = {})
+      data, _status_code, _headers = inbox_username_with_http_info(username, text, opts)
+      data
+    end
+
+    # Send a private message
+    # Send a private message to another player. 
+    # @param username [String] 
+    # @param text [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Ok, Integer, Hash)>] Ok data, response status code and response headers
+    def inbox_username_with_http_info(username, text, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MessagingApi.inbox_username ...'
+      end
+      # verify the required parameter 'username' is set
+      if @api_client.config.client_side_validation && username.nil?
+        fail ArgumentError, "Missing the required parameter 'username' when calling MessagingApi.inbox_username"
+      end
+      # verify the required parameter 'text' is set
+      if @api_client.config.client_side_validation && text.nil?
+        fail ArgumentError, "Missing the required parameter 'text' when calling MessagingApi.inbox_username"
+      end
+      # resource path
+      local_var_path = '/inbox/{username}'.sub('{' + 'username' + '}', CGI.escape(username.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+      form_params['text'] = text
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Ok'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :operation => :"MessagingApi.inbox_username",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: MessagingApi#inbox_username\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end