lishogi 0.1.0

data/lib/lishogi/api/arena_tournaments_api.rb

@@ -0,0 +1,681 @@
+=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 ArenaTournamentsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get team Arena tournaments
+    # Get all Arena tournaments relevant to a team.  Tournaments are sorted by reverse chronological order of start date (last starting first).  Tournaments are streamed as [ndjson](#section/Introduction/Streaming-with-ND-JSON). 
+    # @param team_id [String] ID of the team
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :max How many tournaments to download. (default to 100)
+    # @return [Array<Object>]
+    def api_team_arena(team_id, opts = {})
+      data, _status_code, _headers = api_team_arena_with_http_info(team_id, opts)
+      data
+    end
+
+    # Get team Arena tournaments
+    # Get all Arena tournaments relevant to a team.  Tournaments are sorted by reverse chronological order of start date (last starting first).  Tournaments are streamed as [ndjson](#section/Introduction/Streaming-with-ND-JSON). 
+    # @param team_id [String] ID of the team
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :max How many tournaments to download. (default to 100)
+    # @return [Array<(Array<Object>, Integer, Hash)>] Array<Object> data, response status code and response headers
+    def api_team_arena_with_http_info(team_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ArenaTournamentsApi.api_team_arena ...'
+      end
+      # verify the required parameter 'team_id' is set
+      if @api_client.config.client_side_validation && team_id.nil?
+        fail ArgumentError, "Missing the required parameter 'team_id' when calling ArenaTournamentsApi.api_team_arena"
+      end
+      if @api_client.config.client_side_validation && !opts[:'max'].nil? && opts[:'max'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"max"]" when calling ArenaTournamentsApi.api_team_arena, must be greater than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/api/team/{teamId}/arena'.sub('{' + 'teamId' + '}', CGI.escape(team_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'max'] = opts[:'max'] if !opts[:'max'].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] || 'Array<Object>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"ArenaTournamentsApi.api_team_arena",
+        :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: ArenaTournamentsApi#api_team_arena\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get current tournaments
+    # Get recently finished, ongoing, and upcoming tournaments.  This API is used to display the [Lishogi tournament schedule](https://lishogi.org/tournament). 
+    # @param [Hash] opts the optional parameters
+    # @return [ArenaTournaments]
+    def api_tournament(opts = {})
+      data, _status_code, _headers = api_tournament_with_http_info(opts)
+      data
+    end
+
+    # Get current tournaments
+    # Get recently finished, ongoing, and upcoming tournaments.  This API is used to display the [Lishogi tournament schedule](https://lishogi.org/tournament). 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ArenaTournaments, Integer, Hash)>] ArenaTournaments data, response status code and response headers
+    def api_tournament_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ArenaTournamentsApi.api_tournament ...'
+      end
+      # resource path
+      local_var_path = '/api/tournament'
+
+      # 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] || 'ArenaTournaments'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"ArenaTournamentsApi.api_tournament",
+        :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: ArenaTournamentsApi#api_tournament\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Create a new Arena tournament
+    # Create a public or private Arena tournament.  This endpoint mirrors the form on <https://lishogi.org/tournament/new>.  You can create up to 12 public tournaments per day, or 24 private tournaments.  A team battle can be created by specifying the `teambBattleByTeam` argument. 
+    # @param clock_time [Float] Clock initial time in minutes
+    # @param clock_increment [Integer] Clock increment in seconds
+    # @param clock_byoyomi [Integer] Clock byoyomi in seconds
+    # @param periods [Integer] Clock periods for byoyomi
+    # @param minutes [Integer] How long the tournament lasts, in minutes
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :name The tournament name. Leave empty to get a random Grandmaster name
+    # @option opts [Integer] :wait_minutes How long to wait before starting the tournament, from now, in minutes (default to 5)
+    # @option opts [Integer] :start_date Timestamp to start the tournament at a given date and time. Overrides the &#x60;waitMinutes&#x60; setting
+    # @option opts [VariantKey] :variant  (default to 'standard')
+    # @option opts [Boolean] :rated Games are rated and impact players ratings (default to true)
+    # @option opts [String] :position Custom initial position (in SFEN) for all games of the tournament. Must be a legal shogi position. Only works with standard shogi, not variants.
+    # @option opts [Boolean] :berserkable Whether the players can use berserk (default to true)
+    # @option opts [Boolean] :streakable After 2 wins, consecutive wins grant 4 points instead of 2. (default to true)
+    # @option opts [Boolean] :has_chat Whether the players can discuss in a chat (default to true)
+    # @option opts [String] :description Anything you want to tell players about the tournament
+    # @option opts [String] :password Make the tournament private, and restrict access with a password. You can also [generate user-specific entry codes](https://github.com/lishogi-org/api/tree/master/example/tournament-entry-code) based on this password. 
+    # @option opts [String] :team_battle_by_team Set the ID of a team you lead to create a team battle. The other teams can be added using the [team battle edit endpoint](#operation/apiTournamentTeamBattlePost). 
+    # @option opts [String] :conditions_team_member_team_id Restrict entry to members of a team.  The teamId is the last part of a team URL, e.g. &#x60;https://lishogi.org/team/shogi-is-hard&#x60; has teamId &#x3D; &#x60;shogi-is-hard&#x60;.  Leave empty to let everyone join the tournament.  Do not use this to create team battles, use &#x60;teamBattleByTeam&#x60; instead. 
+    # @option opts [Integer] :conditions_min_rating_rating Minimum rating to join. Leave empty to let everyone join the tournament.
+    # @option opts [Integer] :conditions_max_rating_rating Maximum rating to join. Based on best rating reached in the last 7 days. Leave empty to let everyone join the tournament.
+    # @option opts [Integer] :conditions_nb_rated_game_nb Minimum number of rated games required to join.
+    # @return [Object]
+    def api_tournament_post(clock_time, clock_increment, clock_byoyomi, periods, minutes, opts = {})
+      data, _status_code, _headers = api_tournament_post_with_http_info(clock_time, clock_increment, clock_byoyomi, periods, minutes, opts)
+      data
+    end
+
+    # Create a new Arena tournament
+    # Create a public or private Arena tournament.  This endpoint mirrors the form on &lt;https://lishogi.org/tournament/new&gt;.  You can create up to 12 public tournaments per day, or 24 private tournaments.  A team battle can be created by specifying the &#x60;teambBattleByTeam&#x60; argument. 
+    # @param clock_time [Float] Clock initial time in minutes
+    # @param clock_increment [Integer] Clock increment in seconds
+    # @param clock_byoyomi [Integer] Clock byoyomi in seconds
+    # @param periods [Integer] Clock periods for byoyomi
+    # @param minutes [Integer] How long the tournament lasts, in minutes
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :name The tournament name. Leave empty to get a random Grandmaster name
+    # @option opts [Integer] :wait_minutes How long to wait before starting the tournament, from now, in minutes (default to 5)
+    # @option opts [Integer] :start_date Timestamp to start the tournament at a given date and time. Overrides the &#x60;waitMinutes&#x60; setting
+    # @option opts [VariantKey] :variant  (default to 'standard')
+    # @option opts [Boolean] :rated Games are rated and impact players ratings (default to true)
+    # @option opts [String] :position Custom initial position (in SFEN) for all games of the tournament. Must be a legal shogi position. Only works with standard shogi, not variants.
+    # @option opts [Boolean] :berserkable Whether the players can use berserk (default to true)
+    # @option opts [Boolean] :streakable After 2 wins, consecutive wins grant 4 points instead of 2. (default to true)
+    # @option opts [Boolean] :has_chat Whether the players can discuss in a chat (default to true)
+    # @option opts [String] :description Anything you want to tell players about the tournament
+    # @option opts [String] :password Make the tournament private, and restrict access with a password. You can also [generate user-specific entry codes](https://github.com/lishogi-org/api/tree/master/example/tournament-entry-code) based on this password. 
+    # @option opts [String] :team_battle_by_team Set the ID of a team you lead to create a team battle. The other teams can be added using the [team battle edit endpoint](#operation/apiTournamentTeamBattlePost). 
+    # @option opts [String] :conditions_team_member_team_id Restrict entry to members of a team.  The teamId is the last part of a team URL, e.g. &#x60;https://lishogi.org/team/shogi-is-hard&#x60; has teamId &#x3D; &#x60;shogi-is-hard&#x60;.  Leave empty to let everyone join the tournament.  Do not use this to create team battles, use &#x60;teamBattleByTeam&#x60; instead. 
+    # @option opts [Integer] :conditions_min_rating_rating Minimum rating to join. Leave empty to let everyone join the tournament.
+    # @option opts [Integer] :conditions_max_rating_rating Maximum rating to join. Based on best rating reached in the last 7 days. Leave empty to let everyone join the tournament.
+    # @option opts [Integer] :conditions_nb_rated_game_nb Minimum number of rated games required to join.
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def api_tournament_post_with_http_info(clock_time, clock_increment, clock_byoyomi, periods, minutes, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ArenaTournamentsApi.api_tournament_post ...'
+      end
+      # verify the required parameter 'clock_time' is set
+      if @api_client.config.client_side_validation && clock_time.nil?
+        fail ArgumentError, "Missing the required parameter 'clock_time' when calling ArenaTournamentsApi.api_tournament_post"
+      end
+      # verify enum value
+      allowable_values = [0, 0.25, 0.5, 0.75, 1, 1.5, 2, 3, 4, 5, 6, 7, 10, 15, 20, 25, 30, 40, 50, 60]
+      if @api_client.config.client_side_validation && !allowable_values.include?(clock_time)
+        fail ArgumentError, "invalid value for \"clock_time\", must be one of #{allowable_values}"
+      end
+      # verify the required parameter 'clock_increment' is set
+      if @api_client.config.client_side_validation && clock_increment.nil?
+        fail ArgumentError, "Missing the required parameter 'clock_increment' when calling ArenaTournamentsApi.api_tournament_post"
+      end
+      # verify enum value
+      allowable_values = [0, 1, 2, 3, 4, 5, 6, 7, 10, 15, 20, 25, 30, 40, 50, 60]
+      if @api_client.config.client_side_validation && !allowable_values.include?(clock_increment)
+        fail ArgumentError, "invalid value for \"clock_increment\", must be one of #{allowable_values}"
+      end
+      # verify the required parameter 'clock_byoyomi' is set
+      if @api_client.config.client_side_validation && clock_byoyomi.nil?
+        fail ArgumentError, "Missing the required parameter 'clock_byoyomi' when calling ArenaTournamentsApi.api_tournament_post"
+      end
+      # verify enum value
+      allowable_values = [0, 1, 2, 3, 4, 5, 6, 7, 10, 15, 20, 25, 30, 40, 50, 60]
+      if @api_client.config.client_side_validation && !allowable_values.include?(clock_byoyomi)
+        fail ArgumentError, "invalid value for \"clock_byoyomi\", must be one of #{allowable_values}"
+      end
+      # verify the required parameter 'periods' is set
+      if @api_client.config.client_side_validation && periods.nil?
+        fail ArgumentError, "Missing the required parameter 'periods' when calling ArenaTournamentsApi.api_tournament_post"
+      end
+      # verify enum value
+      allowable_values = [0, 1, 2, 3, 4, 5]
+      if @api_client.config.client_side_validation && !allowable_values.include?(periods)
+        fail ArgumentError, "invalid value for \"periods\", must be one of #{allowable_values}"
+      end
+      # verify the required parameter 'minutes' is set
+      if @api_client.config.client_side_validation && minutes.nil?
+        fail ArgumentError, "Missing the required parameter 'minutes' when calling ArenaTournamentsApi.api_tournament_post"
+      end
+      # verify enum value
+      allowable_values = [20, 25, 30, 35, 40, 45, 50, 55, 60, 70, 80, 90, 100, 110, 120, 150, 180, 210, 240, 270, 300, 330, 360, 420, 480, 540, 600, 720]
+      if @api_client.config.client_side_validation && !allowable_values.include?(minutes)
+        fail ArgumentError, "invalid value for \"minutes\", must be one of #{allowable_values}"
+      end
+      allowable_values = [1, 2, 3, 5, 10, 15, 20, 30, 45, 60]
+      if @api_client.config.client_side_validation && opts[:'wait_minutes'] && !allowable_values.include?(opts[:'wait_minutes'])
+        fail ArgumentError, "invalid value for \"wait_minutes\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/api/tournament'
+
+      # 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['clockTime'] = clock_time
+      form_params['clockIncrement'] = clock_increment
+      form_params['clockByoyomi'] = clock_byoyomi
+      form_params['periods'] = periods
+      form_params['minutes'] = minutes
+      form_params['name'] = opts[:'name'] if !opts[:'name'].nil?
+      form_params['waitMinutes'] = opts[:'wait_minutes'] if !opts[:'wait_minutes'].nil?
+      form_params['startDate'] = opts[:'start_date'] if !opts[:'start_date'].nil?
+      form_params['variant'] = opts[:'variant'] if !opts[:'variant'].nil?
+      form_params['rated'] = opts[:'rated'] if !opts[:'rated'].nil?
+      form_params['position'] = opts[:'position'] if !opts[:'position'].nil?
+      form_params['berserkable'] = opts[:'berserkable'] if !opts[:'berserkable'].nil?
+      form_params['streakable'] = opts[:'streakable'] if !opts[:'streakable'].nil?
+      form_params['hasChat'] = opts[:'has_chat'] if !opts[:'has_chat'].nil?
+      form_params['description'] = opts[:'description'] if !opts[:'description'].nil?
+      form_params['password'] = opts[:'password'] if !opts[:'password'].nil?
+      form_params['teamBattleByTeam'] = opts[:'team_battle_by_team'] if !opts[:'team_battle_by_team'].nil?
+      form_params['conditions.teamMember.teamId'] = opts[:'conditions_team_member_team_id'] if !opts[:'conditions_team_member_team_id'].nil?
+      form_params['conditions.minRating.rating'] = opts[:'conditions_min_rating_rating'] if !opts[:'conditions_min_rating_rating'].nil?
+      form_params['conditions.maxRating.rating'] = opts[:'conditions_max_rating_rating'] if !opts[:'conditions_max_rating_rating'].nil?
+      form_params['conditions.nbRatedGame.nb'] = opts[:'conditions_nb_rated_game_nb'] if !opts[:'conditions_nb_rated_game_nb'].nil?
+
+      # 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 => :"ArenaTournamentsApi.api_tournament_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: ArenaTournamentsApi#api_tournament_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get tournaments created by a user
+    # Get all tournaments created by a given user.  Tournaments are sorted by reverse chronological order of start date (last starting first).  Tournaments are streamed as [ndjson](#section/Introduction/Streaming-with-ND-JSON). 
+    # @param username [String] The user whose created tournaments to fetch
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :status Include tournaments in the given status: \&quot;Created\&quot; (10), \&quot;Started\&quot; (20), \&quot;Finished\&quot; (30)  You can add this parameter more than once to include tournaments in different statuses.   Example: &#x60;?status&#x3D;10&amp;status&#x3D;20&#x60; 
+    # @return [Object]
+    def api_user_name_tournament_created(username, opts = {})
+      data, _status_code, _headers = api_user_name_tournament_created_with_http_info(username, opts)
+      data
+    end
+
+    # Get tournaments created by a user
+    # Get all tournaments created by a given user.  Tournaments are sorted by reverse chronological order of start date (last starting first).  Tournaments are streamed as [ndjson](#section/Introduction/Streaming-with-ND-JSON). 
+    # @param username [String] The user whose created tournaments to fetch
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :status Include tournaments in the given status: \&quot;Created\&quot; (10), \&quot;Started\&quot; (20), \&quot;Finished\&quot; (30)  You can add this parameter more than once to include tournaments in different statuses.   Example: &#x60;?status&#x3D;10&amp;status&#x3D;20&#x60; 
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def api_user_name_tournament_created_with_http_info(username, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ArenaTournamentsApi.api_user_name_tournament_created ...'
+      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 ArenaTournamentsApi.api_user_name_tournament_created"
+      end
+      allowable_values = [10, 20, 30]
+      if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
+        fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/api/user/{username}/tournament/created'.sub('{' + 'username' + '}', CGI.escape(username.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'status'] = opts[:'status'] if !opts[:'status'].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] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"ArenaTournamentsApi.api_user_name_tournament_created",
+        :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: ArenaTournamentsApi#api_user_name_tournament_created\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Export games of an Arena tournament
+    # Download games of a tournament in KIF or [ndjson](#section/Introduction/Streaming-with-ND-JSON) format.  Games are sorted by reverse chronological order (most recent first).  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 
+    # @param id [String] The tournament ID.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :player Only games of a particular player. Leave empty to fetch games of all players.
+    # @option opts [Boolean] :moves Include the KIF moves. (default to true)
+    # @option opts [Boolean] :pgn_in_json Include the full KIF within the JSON response, in a &#x60;notation&#x60; field. (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)
+    # @return [Object]
+    def games_by_tournament(id, opts = {})
+      data, _status_code, _headers = games_by_tournament_with_http_info(id, opts)
+      data
+    end
+
+    # Export games of an Arena tournament
+    # Download games of a tournament in KIF or [ndjson](#section/Introduction/Streaming-with-ND-JSON) format.  Games are sorted by reverse chronological order (most recent first).  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 
+    # @param id [String] The tournament ID.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :player Only games of a particular player. Leave empty to fetch games of all players.
+    # @option opts [Boolean] :moves Include the KIF moves. (default to true)
+    # @option opts [Boolean] :pgn_in_json Include the full KIF within the JSON response, in a &#x60;notation&#x60; field. (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)
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def games_by_tournament_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ArenaTournamentsApi.games_by_tournament ...'
+      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 ArenaTournamentsApi.games_by_tournament"
+      end
+      # resource path
+      local_var_path = '/api/tournament/{id}/games'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'player'] = opts[:'player'] if !opts[:'player'].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?
+
+      # 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] || []
+
+      new_options = opts.merge(
+        :operation => :"ArenaTournamentsApi.games_by_tournament",
+        :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: ArenaTournamentsApi#games_by_tournament\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get results of an Arena tournament
+    # Players of an Arena tournament, with their score and performance, sorted by rank (best first).  **Players are streamed as [ndjson](#section/Introduction/Streaming-with-ND-JSON)**, i.e. one JSON object per line.  If called on an ongoing tournament, results can be inconsistent due to ranking changes while the players are being streamed. Use on finished tournaments for guaranteed consistency. 
+    # @param id [String] The tournament ID.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :nb Max number of players to fetch
+    # @return [Object]
+    def results_by_tournament(id, opts = {})
+      data, _status_code, _headers = results_by_tournament_with_http_info(id, opts)
+      data
+    end
+
+    # Get results of an Arena tournament
+    # Players of an Arena tournament, with their score and performance, sorted by rank (best first).  **Players are streamed as [ndjson](#section/Introduction/Streaming-with-ND-JSON)**, i.e. one JSON object per line.  If called on an ongoing tournament, results can be inconsistent due to ranking changes while the players are being streamed. Use on finished tournaments for guaranteed consistency. 
+    # @param id [String] The tournament ID.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :nb Max number of players to fetch
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def results_by_tournament_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ArenaTournamentsApi.results_by_tournament ...'
+      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 ArenaTournamentsApi.results_by_tournament"
+      end
+      if @api_client.config.client_side_validation && !opts[:'nb'].nil? && opts[:'nb'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"nb"]" when calling ArenaTournamentsApi.results_by_tournament, must be greater than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/api/tournament/{id}/results'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # 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] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"ArenaTournamentsApi.results_by_tournament",
+        :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: ArenaTournamentsApi#results_by_tournament\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get team standing of a team battle
+    # Teams of a team battle tournament, with top players, sorted by rank (best first). 
+    # @param id [String] The tournament ID.
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def teams_by_tournament(id, opts = {})
+      data, _status_code, _headers = teams_by_tournament_with_http_info(id, opts)
+      data
+    end
+
+    # Get team standing of a team battle
+    # Teams of a team battle tournament, with top players, sorted by rank (best first). 
+    # @param id [String] The tournament ID.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def teams_by_tournament_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ArenaTournamentsApi.teams_by_tournament ...'
+      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 ArenaTournamentsApi.teams_by_tournament"
+      end
+      # resource path
+      local_var_path = '/api/tournament/{id}/teams'.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/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 => :"ArenaTournamentsApi.teams_by_tournament",
+        :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: ArenaTournamentsApi#teams_by_tournament\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get info about an Arena tournament
+    # Get detailed info about recently finished, current, or upcoming tournament's duels, player standings, and other info. 
+    # @param id [String] The tournament ID.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Float] :page Specify which page of player standings to view. (default to 1)
+    # @return [Object]
+    def tournament(id, opts = {})
+      data, _status_code, _headers = tournament_with_http_info(id, opts)
+      data
+    end
+
+    # Get info about an Arena tournament
+    # Get detailed info about recently finished, current, or upcoming tournament&#39;s duels, player standings, and other info. 
+    # @param id [String] The tournament ID.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Float] :page Specify which page of player standings to view. (default to 1)
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def tournament_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ArenaTournamentsApi.tournament ...'
+      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 ArenaTournamentsApi.tournament"
+      end
+      if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] > 200
+        fail ArgumentError, 'invalid value for "opts[:"page"]" when calling ArenaTournamentsApi.tournament, must be smaller than or equal to 200.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"page"]" when calling ArenaTournamentsApi.tournament, must be greater than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/api/tournament/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].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] || []
+
+      new_options = opts.merge(
+        :operation => :"ArenaTournamentsApi.tournament",
+        :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: ArenaTournamentsApi#tournament\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end