lishogi 0.1.0

data/lib/lishogi/api/board_api.rb

@@ -0,0 +1,685 @@
+=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 BoardApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Create a seek
+    #    Create a public seek, to start a game with a random player.    ### Real-time seek    Specify the `time`, `increment`, `byoyomi` and `periods` clock values.  The response is streamed but doesn't contain any information.    **Keep the connection open to keep the seek active**.    If the client closes the connection, the seek is canceled. This way, if the client terminates, the user won't be paired in a game they wouldn't play.   When the seek is accepted, or expires, the server closes the connection.    **Make sure to also have an [Event stream](#operation/apiStreamEvent) open**, to be notified when a game starts.   We recommend opening the [Event stream](#operation/apiStreamEvent) first, then the seek stream. This way,   you won't miss the game event if the seek is accepted immediately.    ### Correspondence seek    Specify the `days` per turn value.  The response is not streamed, it immediately completes with the seek ID. The seek remains active on the server until it is joined by someone.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :rated Whether the game is rated and impacts players ratings. (default to false)
+    # @option opts [Float] :time Clock initial time in minutes. Required for real-time seeks.
+    # @option opts [Integer] :increment Clock increment in seconds. Required for real-time seeks.
+    # @option opts [Integer] :byoyomi Clock byoyomi in seconds. Required for real-time seeks.
+    # @option opts [Integer] :periods Clock periods for byoyomi in seconds. Required for real-time seeks.
+    # @option opts [Integer] :days Days per turn. Required for correspondence seeks.
+    # @option opts [VariantKey] :variant  (default to 'standard')
+    # @option opts [String] :color The color to play. Better left empty to automatically get a random color. (default to 'random')
+    # @option opts [String] :rating_range The rating range of potential opponents. Better left empty. Example: 1500-1800 
+    # @return [nil]
+    def api_board_seek(opts = {})
+      api_board_seek_with_http_info(opts)
+      nil
+    end
+
+    # Create a seek
+    #    Create a public seek, to start a game with a random player.    ### Real-time seek    Specify the `time`, `increment`, `byoyomi` and `periods` clock values.  The response is streamed but doesn't contain any information.    **Keep the connection open to keep the seek active**.    If the client closes the connection, the seek is canceled. This way, if the client terminates, the user won't be paired in a game they wouldn't play.   When the seek is accepted, or expires, the server closes the connection.    **Make sure to also have an [Event stream](#operation/apiStreamEvent) open**, to be notified when a game starts.   We recommend opening the [Event stream](#operation/apiStreamEvent) first, then the seek stream. This way,   you won't miss the game event if the seek is accepted immediately.    ### Correspondence seek    Specify the `days` per turn value.  The response is not streamed, it immediately completes with the seek ID. The seek remains active on the server until it is joined by someone.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :rated Whether the game is rated and impacts players ratings. (default to false)
+    # @option opts [Float] :time Clock initial time in minutes. Required for real-time seeks.
+    # @option opts [Integer] :increment Clock increment in seconds. Required for real-time seeks.
+    # @option opts [Integer] :byoyomi Clock byoyomi in seconds. Required for real-time seeks.
+    # @option opts [Integer] :periods Clock periods for byoyomi in seconds. Required for real-time seeks.
+    # @option opts [Integer] :days Days per turn. Required for correspondence seeks.
+    # @option opts [VariantKey] :variant  (default to 'standard')
+    # @option opts [String] :color The color to play. Better left empty to automatically get a random color. (default to 'random')
+    # @option opts [String] :rating_range The rating range of potential opponents. Better left empty. Example: 1500-1800 
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def api_board_seek_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: BoardApi.api_board_seek ...'
+      end
+      if @api_client.config.client_side_validation && !opts[:'time'].nil? && opts[:'time'] > 180
+        fail ArgumentError, 'invalid value for "opts[:"time"]" when calling BoardApi.api_board_seek, must be smaller than or equal to 180.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'time'].nil? && opts[:'time'] < 0
+        fail ArgumentError, 'invalid value for "opts[:"time"]" when calling BoardApi.api_board_seek, must be greater than or equal to 0.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'increment'].nil? && opts[:'increment'] > 180
+        fail ArgumentError, 'invalid value for "opts[:"increment"]" when calling BoardApi.api_board_seek, must be smaller than or equal to 180.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'increment'].nil? && opts[:'increment'] < 0
+        fail ArgumentError, 'invalid value for "opts[:"increment"]" when calling BoardApi.api_board_seek, must be greater than or equal to 0.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'byoyomi'].nil? && opts[:'byoyomi'] > 180
+        fail ArgumentError, 'invalid value for "opts[:"byoyomi"]" when calling BoardApi.api_board_seek, must be smaller than or equal to 180.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'byoyomi'].nil? && opts[:'byoyomi'] < 0
+        fail ArgumentError, 'invalid value for "opts[:"byoyomi"]" when calling BoardApi.api_board_seek, must be greater than or equal to 0.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'periods'].nil? && opts[:'periods'] > 5
+        fail ArgumentError, 'invalid value for "opts[:"periods"]" when calling BoardApi.api_board_seek, must be smaller than or equal to 5.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'periods'].nil? && opts[:'periods'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"periods"]" when calling BoardApi.api_board_seek, must be greater than or equal to 1.'
+      end
+
+      allowable_values = [1, 2, 3, 5, 7, 10, 14]
+      if @api_client.config.client_side_validation && opts[:'days'] && !allowable_values.include?(opts[:'days'])
+        fail ArgumentError, "invalid value for \"days\", must be one of #{allowable_values}"
+      end
+      allowable_values = ["random", "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
+      # resource path
+      local_var_path = '/api/board/seek'
+
+      # 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(['text/plain', '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['rated'] = opts[:'rated'] if !opts[:'rated'].nil?
+      form_params['time'] = opts[:'time'] if !opts[:'time'].nil?
+      form_params['increment'] = opts[:'increment'] if !opts[:'increment'].nil?
+      form_params['byoyomi'] = opts[:'byoyomi'] if !opts[:'byoyomi'].nil?
+      form_params['periods'] = opts[:'periods'] if !opts[:'periods'].nil?
+      form_params['days'] = opts[:'days'] if !opts[:'days'].nil?
+      form_params['variant'] = opts[:'variant'] if !opts[:'variant'].nil?
+      form_params['color'] = opts[:'color'] if !opts[:'color'].nil?
+      form_params['ratingRange'] = opts[:'rating_range'] if !opts[:'rating_range'].nil?
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :operation => :"BoardApi.api_board_seek",
+        :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: BoardApi#api_board_seek\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: BoardApi.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 => :"BoardApi.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: BoardApi#api_stream_event\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 Board API. 
+    # @param game_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Ok]
+    def board_game_abort(game_id, opts = {})
+      data, _status_code, _headers = board_game_abort_with_http_info(game_id, opts)
+      data
+    end
+
+    # Abort a game
+    # Abort a game being played with the Board 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 board_game_abort_with_http_info(game_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: BoardApi.board_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 BoardApi.board_game_abort"
+      end
+      # resource path
+      local_var_path = '/api/board/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 => :"BoardApi.board_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: BoardApi#board_game_abort\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 board_game_chat_get(game_id, opts = {})
+      data, _status_code, _headers = board_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 board_game_chat_get_with_http_info(game_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: BoardApi.board_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 BoardApi.board_game_chat_get"
+      end
+      # resource path
+      local_var_path = '/api/board/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 => :"BoardApi.board_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: BoardApi#board_game_chat_get\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 Board API. 
+    # @param game_id [String] 
+    # @param room [String] 
+    # @param text [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Ok]
+    def board_game_chat_post(game_id, room, text, opts = {})
+      data, _status_code, _headers = board_game_chat_post_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 Board 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 board_game_chat_post_with_http_info(game_id, room, text, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: BoardApi.board_game_chat_post ...'
+      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 BoardApi.board_game_chat_post"
+      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 BoardApi.board_game_chat_post"
+      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 BoardApi.board_game_chat_post"
+      end
+      # resource path
+      local_var_path = '/api/board/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 => :"BoardApi.board_game_chat_post",
+        :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: BoardApi#board_game_chat_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Make a Board move
+    # Make a move in a game being played with the Board API. 
+    # @param game_id [String] 
+    # @param move [String] The move to play, in USI format
+    # @param [Hash] opts the optional parameters
+    # @return [Ok]
+    def board_game_move(game_id, move, opts = {})
+      data, _status_code, _headers = board_game_move_with_http_info(game_id, move, opts)
+      data
+    end
+
+    # Make a Board move
+    # Make a move in a game being played with the Board 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 board_game_move_with_http_info(game_id, move, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: BoardApi.board_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 BoardApi.board_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 BoardApi.board_game_move"
+      end
+      # resource path
+      local_var_path = '/api/board/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 => :"BoardApi.board_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: BoardApi#board_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 Board API. 
+    # @param game_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Ok]
+    def board_game_resign(game_id, opts = {})
+      data, _status_code, _headers = board_game_resign_with_http_info(game_id, opts)
+      data
+    end
+
+    # Resign a game
+    # Resign a game being played with the Board 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 board_game_resign_with_http_info(game_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: BoardApi.board_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 BoardApi.board_game_resign"
+      end
+      # resource path
+      local_var_path = '/api/board/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 => :"BoardApi.board_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: BoardApi#board_game_resign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Stream Board game state
+    #  Stream the state of a game being played with the Board 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. Sent when a move is played, or when the game ends.   - `chatLine` Chat message sent by a user in the `room` \"player\" or \"spectator\".    The first line is always of type `gameFull`.    The server closes the stream when the game ends, or if the game has already ended.
+    # @param game_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [BoardGameStream200Response]
+    def board_game_stream(game_id, opts = {})
+      data, _status_code, _headers = board_game_stream_with_http_info(game_id, opts)
+      data
+    end
+
+    # Stream Board game state
+    #  Stream the state of a game being played with the Board 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. Sent when a move is played, or when the game ends.   - &#x60;chatLine&#x60; Chat message sent by a user in the &#x60;room&#x60; \&quot;player\&quot; or \&quot;spectator\&quot;.    The first line is always of type &#x60;gameFull&#x60;.    The server closes the stream when the game ends, or if the game has already ended.
+    # @param game_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(BoardGameStream200Response, Integer, Hash)>] BoardGameStream200Response data, response status code and response headers
+    def board_game_stream_with_http_info(game_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: BoardApi.board_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 BoardApi.board_game_stream"
+      end
+      # resource path
+      local_var_path = '/api/board/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 => :"BoardApi.board_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: BoardApi#board_game_stream\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Handle takeback offers
+    # Create/accept/decline takebacks. - `yes`: Propose a takeback, or accept the opponent's takeback offer. - `no`: Decline a takeback offer from the opponent. 
+    # @param game_id [String] 
+    # @param accept [BoardGameTakebackAcceptParameter] 
+    # @param [Hash] opts the optional parameters
+    # @return [Ok]
+    def board_game_takeback(game_id, accept, opts = {})
+      data, _status_code, _headers = board_game_takeback_with_http_info(game_id, accept, opts)
+      data
+    end
+
+    # Handle takeback offers
+    # Create/accept/decline takebacks. - &#x60;yes&#x60;: Propose a takeback, or accept the opponent&#39;s takeback offer. - &#x60;no&#x60;: Decline a takeback offer from the opponent. 
+    # @param game_id [String] 
+    # @param accept [BoardGameTakebackAcceptParameter] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Ok, Integer, Hash)>] Ok data, response status code and response headers
+    def board_game_takeback_with_http_info(game_id, accept, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: BoardApi.board_game_takeback ...'
+      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 BoardApi.board_game_takeback"
+      end
+      # verify the required parameter 'accept' is set
+      if @api_client.config.client_side_validation && accept.nil?
+        fail ArgumentError, "Missing the required parameter 'accept' when calling BoardApi.board_game_takeback"
+      end
+      # resource path
+      local_var_path = '/api/board/game/{gameId}/takeback/{accept}'.sub('{' + 'gameId' + '}', CGI.escape(game_id.to_s)).sub('{' + 'accept' + '}', CGI.escape(accept.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 => :"BoardApi.board_game_takeback",
+        :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: BoardApi#board_game_takeback\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end