lishogi 0.1.0

data/docs/ArenaTournamentsApi.md

@@ -0,0 +1,601 @@
+# Lishogi::ArenaTournamentsApi
+
+All URIs are relative to *https://lishogi.org*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**api_team_arena**](ArenaTournamentsApi.md#api_team_arena) | **GET** /api/team/{teamId}/arena | Get team Arena tournaments |
+| [**api_tournament**](ArenaTournamentsApi.md#api_tournament) | **GET** /api/tournament | Get current tournaments |
+| [**api_tournament_post**](ArenaTournamentsApi.md#api_tournament_post) | **POST** /api/tournament | Create a new Arena tournament |
+| [**api_user_name_tournament_created**](ArenaTournamentsApi.md#api_user_name_tournament_created) | **GET** /api/user/{username}/tournament/created | Get tournaments created by a user |
+| [**games_by_tournament**](ArenaTournamentsApi.md#games_by_tournament) | **GET** /api/tournament/{id}/games | Export games of an Arena tournament |
+| [**results_by_tournament**](ArenaTournamentsApi.md#results_by_tournament) | **GET** /api/tournament/{id}/results | Get results of an Arena tournament |
+| [**teams_by_tournament**](ArenaTournamentsApi.md#teams_by_tournament) | **GET** /api/tournament/{id}/teams | Get team standing of a team battle |
+| [**tournament**](ArenaTournamentsApi.md#tournament) | **GET** /api/tournament/{id} | Get info about an Arena tournament |
+
+
+## api_team_arena
+
+> Array<Object> api_team_arena(team_id, opts)
+
+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). 
+
+### Examples
+
+```ruby
+require 'time'
+require 'lishogi'
+
+api_instance = Lishogi::ArenaTournamentsApi.new
+team_id = 'team_id_example' # String | ID of the team
+opts = {
+  max: 56 # Integer | How many tournaments to download.
+}
+
+begin
+  # Get team Arena tournaments
+  result = api_instance.api_team_arena(team_id, opts)
+  p result
+rescue Lishogi::ApiError => e
+  puts "Error when calling ArenaTournamentsApi->api_team_arena: #{e}"
+end
+```
+
+#### Using the api_team_arena_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Array&lt;Object&gt;, Integer, Hash)> api_team_arena_with_http_info(team_id, opts)
+
+```ruby
+begin
+  # Get team Arena tournaments
+  data, status_code, headers = api_instance.api_team_arena_with_http_info(team_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Array&lt;Object&gt;
+rescue Lishogi::ApiError => e
+  puts "Error when calling ArenaTournamentsApi->api_team_arena_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **team_id** | **String** | ID of the team |  |
+| **max** | **Integer** | How many tournaments to download. | [optional][default to 100] |
+
+### Return type
+
+**Array&lt;Object&gt;**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## api_tournament
+
+> <ArenaTournaments> api_tournament
+
+Get current tournaments
+
+Get recently finished, ongoing, and upcoming tournaments.  This API is used to display the [Lishogi tournament schedule](https://lishogi.org/tournament). 
+
+### Examples
+
+```ruby
+require 'time'
+require 'lishogi'
+
+api_instance = Lishogi::ArenaTournamentsApi.new
+
+begin
+  # Get current tournaments
+  result = api_instance.api_tournament
+  p result
+rescue Lishogi::ApiError => e
+  puts "Error when calling ArenaTournamentsApi->api_tournament: #{e}"
+end
+```
+
+#### Using the api_tournament_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ArenaTournaments>, Integer, Hash)> api_tournament_with_http_info
+
+```ruby
+begin
+  # Get current tournaments
+  data, status_code, headers = api_instance.api_tournament_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ArenaTournaments>
+rescue Lishogi::ApiError => e
+  puts "Error when calling ArenaTournamentsApi->api_tournament_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ArenaTournaments**](ArenaTournaments.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## api_tournament_post
+
+> Object api_tournament_post(clock_time, clock_increment, clock_byoyomi, periods, minutes, opts)
+
+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. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'lishogi'
+# setup authorization
+Lishogi.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = Lishogi::ArenaTournamentsApi.new
+clock_time = 0 # Float | Clock initial time in minutes
+clock_increment = 0 # Integer | Clock increment in seconds
+clock_byoyomi = 0 # Integer | Clock byoyomi in seconds
+periods = 0 # Integer | Clock periods for byoyomi
+minutes = 20 # Integer | How long the tournament lasts, in minutes
+opts = {
+  name: 'name_example', # String | The tournament name. Leave empty to get a random Grandmaster name
+  wait_minutes: 1, # Integer | How long to wait before starting the tournament, from now, in minutes
+  start_date: 56, # Integer | Timestamp to start the tournament at a given date and time. Overrides the `waitMinutes` setting
+  variant: Lishogi::VariantKey::STANDARD, # VariantKey | 
+  rated: true, # Boolean | Games are rated and impact players ratings
+  position: 'position_example', # String | Custom initial position (in SFEN) for all games of the tournament. Must be a legal shogi position. Only works with standard shogi, not variants.
+  berserkable: true, # Boolean | Whether the players can use berserk
+  streakable: true, # Boolean | After 2 wins, consecutive wins grant 4 points instead of 2.
+  has_chat: true, # Boolean | Whether the players can discuss in a chat
+  description: 'description_example', # String | Anything you want to tell players about the tournament
+  password: 'password_example', # String | 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. 
+  team_battle_by_team: 'team_battle_by_team_example', # String | 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). 
+  conditions_team_member_team_id: 'conditions_team_member_team_id_example', # String | Restrict entry to members of a team.  The teamId is the last part of a team URL, e.g. `https://lishogi.org/team/shogi-is-hard` has teamId = `shogi-is-hard`.  Leave empty to let everyone join the tournament.  Do not use this to create team battles, use `teamBattleByTeam` instead. 
+  conditions_min_rating_rating: 56, # Integer | Minimum rating to join. Leave empty to let everyone join the tournament.
+  conditions_max_rating_rating: 56, # Integer | Maximum rating to join. Based on best rating reached in the last 7 days. Leave empty to let everyone join the tournament.
+  conditions_nb_rated_game_nb: 56 # Integer | Minimum number of rated games required to join.
+}
+
+begin
+  # Create a new Arena tournament
+  result = api_instance.api_tournament_post(clock_time, clock_increment, clock_byoyomi, periods, minutes, opts)
+  p result
+rescue Lishogi::ApiError => e
+  puts "Error when calling ArenaTournamentsApi->api_tournament_post: #{e}"
+end
+```
+
+#### Using the api_tournament_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> api_tournament_post_with_http_info(clock_time, clock_increment, clock_byoyomi, periods, minutes, opts)
+
+```ruby
+begin
+  # Create a new Arena tournament
+  data, status_code, headers = api_instance.api_tournament_post_with_http_info(clock_time, clock_increment, clock_byoyomi, periods, minutes, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue Lishogi::ApiError => e
+  puts "Error when calling ArenaTournamentsApi->api_tournament_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **clock_time** | **Float** | Clock initial time in minutes |  |
+| **clock_increment** | **Integer** | Clock increment in seconds |  |
+| **clock_byoyomi** | **Integer** | Clock byoyomi in seconds |  |
+| **periods** | **Integer** | Clock periods for byoyomi |  |
+| **minutes** | **Integer** | How long the tournament lasts, in minutes |  |
+| **name** | **String** | The tournament name. Leave empty to get a random Grandmaster name | [optional] |
+| **wait_minutes** | **Integer** | How long to wait before starting the tournament, from now, in minutes | [optional][default to 5] |
+| **start_date** | **Integer** | Timestamp to start the tournament at a given date and time. Overrides the &#x60;waitMinutes&#x60; setting | [optional] |
+| **variant** | [**VariantKey**](VariantKey.md) |  | [optional][default to &#39;standard&#39;] |
+| **rated** | **Boolean** | Games are rated and impact players ratings | [optional][default to true] |
+| **position** | **String** | Custom initial position (in SFEN) for all games of the tournament. Must be a legal shogi position. Only works with standard shogi, not variants. | [optional] |
+| **berserkable** | **Boolean** | Whether the players can use berserk | [optional][default to true] |
+| **streakable** | **Boolean** | After 2 wins, consecutive wins grant 4 points instead of 2. | [optional][default to true] |
+| **has_chat** | **Boolean** | Whether the players can discuss in a chat | [optional][default to true] |
+| **description** | **String** | Anything you want to tell players about the tournament | [optional] |
+| **password** | **String** | 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.  | [optional] |
+| **team_battle_by_team** | **String** | 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).  | [optional] |
+| **conditions_team_member_team_id** | **String** | 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.  | [optional] |
+| **conditions_min_rating_rating** | **Integer** | Minimum rating to join. Leave empty to let everyone join the tournament. | [optional] |
+| **conditions_max_rating_rating** | **Integer** | Maximum rating to join. Based on best rating reached in the last 7 days. Leave empty to let everyone join the tournament. | [optional] |
+| **conditions_nb_rated_game_nb** | **Integer** | Minimum number of rated games required to join. | [optional] |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: application/x-www-form-urlencoded
+- **Accept**: application/json
+
+
+## api_user_name_tournament_created
+
+> Object api_user_name_tournament_created(username, opts)
+
+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). 
+
+### Examples
+
+```ruby
+require 'time'
+require 'lishogi'
+
+api_instance = Lishogi::ArenaTournamentsApi.new
+username = 'username_example' # String | The user whose created tournaments to fetch
+opts = {
+  status: 10 # Integer | Include tournaments in the given status: \"Created\" (10), \"Started\" (20), \"Finished\" (30)  You can add this parameter more than once to include tournaments in different statuses.   Example: `?status=10&status=20` 
+}
+
+begin
+  # Get tournaments created by a user
+  result = api_instance.api_user_name_tournament_created(username, opts)
+  p result
+rescue Lishogi::ApiError => e
+  puts "Error when calling ArenaTournamentsApi->api_user_name_tournament_created: #{e}"
+end
+```
+
+#### Using the api_user_name_tournament_created_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> api_user_name_tournament_created_with_http_info(username, opts)
+
+```ruby
+begin
+  # Get tournaments created by a user
+  data, status_code, headers = api_instance.api_user_name_tournament_created_with_http_info(username, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue Lishogi::ApiError => e
+  puts "Error when calling ArenaTournamentsApi->api_user_name_tournament_created_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **username** | **String** | The user whose created tournaments to fetch |  |
+| **status** | **Integer** | 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;  | [optional] |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/x-ndjson
+
+
+## games_by_tournament
+
+> Object games_by_tournament(id, opts)
+
+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 
+
+### Examples
+
+```ruby
+require 'time'
+require 'lishogi'
+
+api_instance = Lishogi::ArenaTournamentsApi.new
+id = 'id_example' # String | The tournament ID.
+opts = {
+  player: 'player_example', # String | Only games of a particular player. Leave empty to fetch games of all players.
+  moves: true, # Boolean | Include the KIF moves.
+  pgn_in_json: true, # Boolean | Include the full KIF within the JSON response, in a `notation` field.
+  tags: true, # Boolean | Include the KIF tags.
+  clocks: true, # Boolean | Include clock comments in the KIF moves, when available.  Example: `22   同　玉(51)   (00:02/00:00:13)` 
+  evals: true # Boolean | Include analysis evaluation comments in the KIF, when available.  Example: `9   ７八銀(79)   * [%eval -1.48]` 
+}
+
+begin
+  # Export games of an Arena tournament
+  result = api_instance.games_by_tournament(id, opts)
+  p result
+rescue Lishogi::ApiError => e
+  puts "Error when calling ArenaTournamentsApi->games_by_tournament: #{e}"
+end
+```
+
+#### Using the games_by_tournament_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> games_by_tournament_with_http_info(id, opts)
+
+```ruby
+begin
+  # Export games of an Arena tournament
+  data, status_code, headers = api_instance.games_by_tournament_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue Lishogi::ApiError => e
+  puts "Error when calling ArenaTournamentsApi->games_by_tournament_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The tournament ID. |  |
+| **player** | **String** | Only games of a particular player. Leave empty to fetch games of all players. | [optional] |
+| **moves** | **Boolean** | Include the KIF moves. | [optional][default to true] |
+| **pgn_in_json** | **Boolean** | Include the full KIF within the JSON response, in a &#x60;notation&#x60; field. | [optional][default to false] |
+| **tags** | **Boolean** | Include the KIF tags. | [optional][default to true] |
+| **clocks** | **Boolean** | Include clock comments in the KIF moves, when available.  Example: &#x60;22   同　玉(51)   (00:02/00:00:13)&#x60;  | [optional][default to false] |
+| **evals** | **Boolean** | Include analysis evaluation comments in the KIF, when available.  Example: &#x60;9   ７八銀(79)   * [%eval -1.48]&#x60;  | [optional][default to false] |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: text/plain, application/x-ndjson
+
+
+## results_by_tournament
+
+> Object results_by_tournament(id, opts)
+
+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. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'lishogi'
+
+api_instance = Lishogi::ArenaTournamentsApi.new
+id = 'id_example' # String | The tournament ID.
+opts = {
+  nb: 56 # Integer | Max number of players to fetch
+}
+
+begin
+  # Get results of an Arena tournament
+  result = api_instance.results_by_tournament(id, opts)
+  p result
+rescue Lishogi::ApiError => e
+  puts "Error when calling ArenaTournamentsApi->results_by_tournament: #{e}"
+end
+```
+
+#### Using the results_by_tournament_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> results_by_tournament_with_http_info(id, opts)
+
+```ruby
+begin
+  # Get results of an Arena tournament
+  data, status_code, headers = api_instance.results_by_tournament_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue Lishogi::ApiError => e
+  puts "Error when calling ArenaTournamentsApi->results_by_tournament_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The tournament ID. |  |
+| **nb** | **Integer** | Max number of players to fetch | [optional] |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/x-ndjson
+
+
+## teams_by_tournament
+
+> Object teams_by_tournament(id)
+
+Get team standing of a team battle
+
+Teams of a team battle tournament, with top players, sorted by rank (best first). 
+
+### Examples
+
+```ruby
+require 'time'
+require 'lishogi'
+
+api_instance = Lishogi::ArenaTournamentsApi.new
+id = 'id_example' # String | The tournament ID.
+
+begin
+  # Get team standing of a team battle
+  result = api_instance.teams_by_tournament(id)
+  p result
+rescue Lishogi::ApiError => e
+  puts "Error when calling ArenaTournamentsApi->teams_by_tournament: #{e}"
+end
+```
+
+#### Using the teams_by_tournament_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> teams_by_tournament_with_http_info(id)
+
+```ruby
+begin
+  # Get team standing of a team battle
+  data, status_code, headers = api_instance.teams_by_tournament_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue Lishogi::ApiError => e
+  puts "Error when calling ArenaTournamentsApi->teams_by_tournament_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The tournament ID. |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## tournament
+
+> Object tournament(id, opts)
+
+Get info about an Arena tournament
+
+Get detailed info about recently finished, current, or upcoming tournament's duels, player standings, and other info. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'lishogi'
+
+api_instance = Lishogi::ArenaTournamentsApi.new
+id = 'id_example' # String | The tournament ID.
+opts = {
+  page: 1 # Float | Specify which page of player standings to view.
+}
+
+begin
+  # Get info about an Arena tournament
+  result = api_instance.tournament(id, opts)
+  p result
+rescue Lishogi::ApiError => e
+  puts "Error when calling ArenaTournamentsApi->tournament: #{e}"
+end
+```
+
+#### Using the tournament_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> tournament_with_http_info(id, opts)
+
+```ruby
+begin
+  # Get info about an Arena tournament
+  data, status_code, headers = api_instance.tournament_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue Lishogi::ApiError => e
+  puts "Error when calling ArenaTournamentsApi->tournament_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The tournament ID. |  |
+| **page** | **Float** | Specify which page of player standings to view. | [optional][default to 1] |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+