lishogi 0.1.0

data/lib/lishogi/api/bot_api.rb

@@ -0,0 +1,608 @@
+=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 BotApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get online bots
+    # Stream the [online bot users](https://lishogi.org/player/bots), as [ndjson](#section/Introduction/Streaming-with-ND-JSON). Throttled to 50 bot users per second.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :nb How many bot users to fetch
+    # @return [User]
+    def api_bot_online(opts = {})
+      data, _status_code, _headers = api_bot_online_with_http_info(opts)
+      data
+    end
+
+    # Get online bots
+    # Stream the [online bot users](https://lishogi.org/player/bots), as [ndjson](#section/Introduction/Streaming-with-ND-JSON). Throttled to 50 bot users per second.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :nb How many bot users to fetch
+    # @return [Array<(User, Integer, Hash)>] User data, response status code and response headers
+    def api_bot_online_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: BotApi.api_bot_online ...'
+      end
+      if @api_client.config.client_side_validation && !opts[:'nb'].nil? && opts[:'nb'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"nb"]" when calling BotApi.api_bot_online, must be greater than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/api/bot/online'
+
+      # 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/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] || 'User'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"BotApi.api_bot_online",
+        :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: BotApi#api_bot_online\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Stream incoming events
+    #    Stream the events reaching a lishogi user in real time as [ndjson](#section/Introduction/Streaming-with-ND-JSON).    Each line is a JSON object containing a `type` field. Possible values are:   - `gameStart` Start of a game   - `gameFinish` Completion of a game   - `challenge` A player sends you a challenge or you challenge someone   - `challengeDeclined` The opponent declines your challenge     When the stream opens, all current challenges and games are sent.
+    # @param [Hash] opts the optional parameters
+    # @return [ApiStreamEvent200Response]
+    def api_stream_event(opts = {})
+      data, _status_code, _headers = api_stream_event_with_http_info(opts)
+      data
+    end
+
+    # Stream incoming events
+    #    Stream the events reaching a lishogi user in real time as [ndjson](#section/Introduction/Streaming-with-ND-JSON).    Each line is a JSON object containing a &#x60;type&#x60; field. Possible values are:   - &#x60;gameStart&#x60; Start of a game   - &#x60;gameFinish&#x60; Completion of a game   - &#x60;challenge&#x60; A player sends you a challenge or you challenge someone   - &#x60;challengeDeclined&#x60; The opponent declines your challenge     When the stream opens, all current challenges and games are sent.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ApiStreamEvent200Response, Integer, Hash)>] ApiStreamEvent200Response data, response status code and response headers
+    def api_stream_event_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: BotApi.api_stream_event ...'
+      end
+      # resource path
+      local_var_path = '/api/stream/event'
+
+      # 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] || 'ApiStreamEvent200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :operation => :"BotApi.api_stream_event",
+        :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: BotApi#api_stream_event\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Upgrade to Bot account
+    # Upgrade a lishogi player account into a Bot account. Only Bot accounts can use the Bot API.  The account **cannot have played any game** before becoming a Bot account. The upgrade is **irreversible**. The account will only be able to play as a Bot.  To upgrade an account to Bot, use the [official lishogi-bot client](https://github.com/ShailChoksi/lishogi-bot), or follow these steps: - Create an [API access token](https://lishogi.org/account/oauth/token/create?scopes[]=bot:play) with \"Play bot moves\" permission. - `curl -d '' https://lishogi.org/api/bot/account/upgrade -H \"Authorization: Bearer <yourTokenHere>\"`  To know if an account has already been upgraded, use the [Get my profile API](#operation/accountMe): the `title` field should be set to `BOT`. 
+    # @param [Hash] opts the optional parameters
+    # @return [Ok]
+    def bot_account_upgrade(opts = {})
+      data, _status_code, _headers = bot_account_upgrade_with_http_info(opts)
+      data
+    end
+
+    # Upgrade to Bot account
+    # Upgrade a lishogi player account into a Bot account. Only Bot accounts can use the Bot API.  The account **cannot have played any game** before becoming a Bot account. The upgrade is **irreversible**. The account will only be able to play as a Bot.  To upgrade an account to Bot, use the [official lishogi-bot client](https://github.com/ShailChoksi/lishogi-bot), or follow these steps: - Create an [API access token](https://lishogi.org/account/oauth/token/create?scopes[]&#x3D;bot:play) with \&quot;Play bot moves\&quot; permission. - &#x60;curl -d &#39;&#39; https://lishogi.org/api/bot/account/upgrade -H \&quot;Authorization: Bearer &lt;yourTokenHere&gt;\&quot;&#x60;  To know if an account has already been upgraded, use the [Get my profile API](#operation/accountMe): the &#x60;title&#x60; field should be set to &#x60;BOT&#x60;. 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Ok, Integer, Hash)>] Ok data, response status code and response headers
+    def bot_account_upgrade_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: BotApi.bot_account_upgrade ...'
+      end
+      # resource path
+      local_var_path = '/api/bot/account/upgrade'
+
+      # 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']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # 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 => :"BotApi.bot_account_upgrade",
+        :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: BotApi#bot_account_upgrade\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Abort a game
+    # Abort a game being played with the Bot API. 
+    # @param game_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Ok]
+    def bot_game_abort(game_id, opts = {})
+      data, _status_code, _headers = bot_game_abort_with_http_info(game_id, opts)
+      data
+    end
+
+    # Abort a game
+    # Abort a game being played with the Bot API. 
+    # @param game_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Ok, Integer, Hash)>] Ok data, response status code and response headers
+    def bot_game_abort_with_http_info(game_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: BotApi.bot_game_abort ...'
+      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 BotApi.bot_game_abort"
+      end
+      # resource path
+      local_var_path = '/api/bot/game/{gameId}/abort'.sub('{' + 'gameId' + '}', CGI.escape(game_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/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] || 'Ok'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :operation => :"BotApi.bot_game_abort",
+        :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: BotApi#bot_game_abort\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Write in the chat
+    # Post a message to the player or spectator chat, in a game being played with the Bot API. 
+    # @param game_id [String] 
+    # @param room [String] 
+    # @param text [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Ok]
+    def bot_game_chat(game_id, room, text, opts = {})
+      data, _status_code, _headers = bot_game_chat_with_http_info(game_id, room, text, opts)
+      data
+    end
+
+    # Write in the chat
+    # Post a message to the player or spectator chat, in a game being played with the Bot API. 
+    # @param game_id [String] 
+    # @param room [String] 
+    # @param text [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Ok, Integer, Hash)>] Ok data, response status code and response headers
+    def bot_game_chat_with_http_info(game_id, room, text, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: BotApi.bot_game_chat ...'
+      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 BotApi.bot_game_chat"
+      end
+      # verify the required parameter 'room' is set
+      if @api_client.config.client_side_validation && room.nil?
+        fail ArgumentError, "Missing the required parameter 'room' when calling BotApi.bot_game_chat"
+      end
+      # verify enum value
+      allowable_values = ["player", "spectator"]
+      if @api_client.config.client_side_validation && !allowable_values.include?(room)
+        fail ArgumentError, "invalid value for \"room\", must be one of #{allowable_values}"
+      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 BotApi.bot_game_chat"
+      end
+      # resource path
+      local_var_path = '/api/bot/game/{gameId}/chat'.sub('{' + 'gameId' + '}', CGI.escape(game_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/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['room'] = room
+      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 => :"BotApi.bot_game_chat",
+        :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: BotApi#bot_game_chat\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Fetch the game chat
+    # Get the messages posted in the game chat 
+    # @param game_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def bot_game_chat_get(game_id, opts = {})
+      data, _status_code, _headers = bot_game_chat_get_with_http_info(game_id, opts)
+      data
+    end
+
+    # Fetch the game chat
+    # Get the messages posted in the game chat 
+    # @param game_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def bot_game_chat_get_with_http_info(game_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: BotApi.bot_game_chat_get ...'
+      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 BotApi.bot_game_chat_get"
+      end
+      # resource path
+      local_var_path = '/api/bot/game/{gameId}/chat'.sub('{' + 'gameId' + '}', CGI.escape(game_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] || ['OAuth2']
+
+      new_options = opts.merge(
+        :operation => :"BotApi.bot_game_chat_get",
+        :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: BotApi#bot_game_chat_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Make a Bot move
+    # Make a move in a game being played with the Bot API. 
+    # @param game_id [String] 
+    # @param move [String] The move to play, in USI format
+    # @param [Hash] opts the optional parameters
+    # @return [Ok]
+    def bot_game_move(game_id, move, opts = {})
+      data, _status_code, _headers = bot_game_move_with_http_info(game_id, move, opts)
+      data
+    end
+
+    # Make a Bot move
+    # Make a move in a game being played with the Bot API. 
+    # @param game_id [String] 
+    # @param move [String] The move to play, in USI format
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Ok, Integer, Hash)>] Ok data, response status code and response headers
+    def bot_game_move_with_http_info(game_id, move, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: BotApi.bot_game_move ...'
+      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 BotApi.bot_game_move"
+      end
+      # verify the required parameter 'move' is set
+      if @api_client.config.client_side_validation && move.nil?
+        fail ArgumentError, "Missing the required parameter 'move' when calling BotApi.bot_game_move"
+      end
+      # resource path
+      local_var_path = '/api/bot/game/{gameId}/move/{move}'.sub('{' + 'gameId' + '}', CGI.escape(game_id.to_s)).sub('{' + 'move' + '}', CGI.escape(move.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']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # 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 => :"BotApi.bot_game_move",
+        :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: BotApi#bot_game_move\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Resign a game
+    # Resign a game being played with the Bot API. 
+    # @param game_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Ok]
+    def bot_game_resign(game_id, opts = {})
+      data, _status_code, _headers = bot_game_resign_with_http_info(game_id, opts)
+      data
+    end
+
+    # Resign a game
+    # Resign a game being played with the Bot API. 
+    # @param game_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Ok, Integer, Hash)>] Ok data, response status code and response headers
+    def bot_game_resign_with_http_info(game_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: BotApi.bot_game_resign ...'
+      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 BotApi.bot_game_resign"
+      end
+      # resource path
+      local_var_path = '/api/bot/game/{gameId}/resign'.sub('{' + 'gameId' + '}', CGI.escape(game_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/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] || 'Ok'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :operation => :"BotApi.bot_game_resign",
+        :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: BotApi#bot_game_resign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Stream Bot game state
+    #  Stream the state of a game being played with the Bot API, as [ndjson](#section/Introduction/Streaming-with-ND-JSON).  Use this endpoint to get updates about the game in real-time, with a single request.  Each line is a JSON object containing a `type` field. Possible values are:   - `gameFull` Full game data. All values are immutable, except for the `state` field.   - `gameState` Current state of the game. Immutable values not included.   - `chatLine` Chat message sent by a user (or the bot itself) in the `room` \"player\" or \"spectator\".    The first line is always of type `gameFull`.
+    # @param game_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [BoardGameStream200Response]
+    def bot_game_stream(game_id, opts = {})
+      data, _status_code, _headers = bot_game_stream_with_http_info(game_id, opts)
+      data
+    end
+
+    # Stream Bot game state
+    #  Stream the state of a game being played with the Bot API, as [ndjson](#section/Introduction/Streaming-with-ND-JSON).  Use this endpoint to get updates about the game in real-time, with a single request.  Each line is a JSON object containing a &#x60;type&#x60; field. Possible values are:   - &#x60;gameFull&#x60; Full game data. All values are immutable, except for the &#x60;state&#x60; field.   - &#x60;gameState&#x60; Current state of the game. Immutable values not included.   - &#x60;chatLine&#x60; Chat message sent by a user (or the bot itself) in the &#x60;room&#x60; \&quot;player\&quot; or \&quot;spectator\&quot;.    The first line is always of type &#x60;gameFull&#x60;.
+    # @param game_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(BoardGameStream200Response, Integer, Hash)>] BoardGameStream200Response data, response status code and response headers
+    def bot_game_stream_with_http_info(game_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: BotApi.bot_game_stream ...'
+      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 BotApi.bot_game_stream"
+      end
+      # resource path
+      local_var_path = '/api/bot/game/stream/{gameId}'.sub('{' + 'gameId' + '}', CGI.escape(game_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', '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] || 'BoardGameStream200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :operation => :"BotApi.bot_game_stream",
+        :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: BotApi#bot_game_stream\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end