lishogi 0.1.0

data/docs/BoardGameTakebackAcceptParameter.md

@@ -0,0 +1,15 @@
+# Lishogi::BoardGameTakebackAcceptParameter
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'lishogi'
+
+instance = Lishogi::BoardGameTakebackAcceptParameter.new()
+```
+

data/docs/BotApi.md

@@ -0,0 +1,634 @@
+# Lishogi::BotApi
+
+All URIs are relative to *https://lishogi.org*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**api_bot_online**](BotApi.md#api_bot_online) | **GET** /api/bot/online | Get online bots |
+| [**api_stream_event**](BotApi.md#api_stream_event) | **GET** /api/stream/event | Stream incoming events |
+| [**bot_account_upgrade**](BotApi.md#bot_account_upgrade) | **POST** /api/bot/account/upgrade | Upgrade to Bot account |
+| [**bot_game_abort**](BotApi.md#bot_game_abort) | **POST** /api/bot/game/{gameId}/abort | Abort a game |
+| [**bot_game_chat**](BotApi.md#bot_game_chat) | **POST** /api/bot/game/{gameId}/chat | Write in the chat |
+| [**bot_game_chat_get**](BotApi.md#bot_game_chat_get) | **GET** /api/bot/game/{gameId}/chat | Fetch the game chat |
+| [**bot_game_move**](BotApi.md#bot_game_move) | **POST** /api/bot/game/{gameId}/move/{move} | Make a Bot move |
+| [**bot_game_resign**](BotApi.md#bot_game_resign) | **POST** /api/bot/game/{gameId}/resign | Resign a game |
+| [**bot_game_stream**](BotApi.md#bot_game_stream) | **GET** /api/bot/game/stream/{gameId} | Stream Bot game state |
+
+
+## api_bot_online
+
+> <User> api_bot_online(opts)
+
+Get online bots
+
+Stream the [online bot users](https://lishogi.org/player/bots), as [ndjson](#section/Introduction/Streaming-with-ND-JSON). Throttled to 50 bot users per second.
+
+### Examples
+
+```ruby
+require 'time'
+require 'lishogi'
+
+api_instance = Lishogi::BotApi.new
+opts = {
+  nb: 20 # Integer | How many bot users to fetch
+}
+
+begin
+  # Get online bots
+  result = api_instance.api_bot_online(opts)
+  p result
+rescue Lishogi::ApiError => e
+  puts "Error when calling BotApi->api_bot_online: #{e}"
+end
+```
+
+#### Using the api_bot_online_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<User>, Integer, Hash)> api_bot_online_with_http_info(opts)
+
+```ruby
+begin
+  # Get online bots
+  data, status_code, headers = api_instance.api_bot_online_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <User>
+rescue Lishogi::ApiError => e
+  puts "Error when calling BotApi->api_bot_online_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **nb** | **Integer** | How many bot users to fetch | [optional] |
+
+### Return type
+
+[**User**](User.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/x-ndjson
+
+
+## api_stream_event
+
+> <ApiStreamEvent200Response> api_stream_event
+
+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.
+
+### 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::BotApi.new
+
+begin
+  # Stream incoming events
+  result = api_instance.api_stream_event
+  p result
+rescue Lishogi::ApiError => e
+  puts "Error when calling BotApi->api_stream_event: #{e}"
+end
+```
+
+#### Using the api_stream_event_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ApiStreamEvent200Response>, Integer, Hash)> api_stream_event_with_http_info
+
+```ruby
+begin
+  # Stream incoming events
+  data, status_code, headers = api_instance.api_stream_event_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ApiStreamEvent200Response>
+rescue Lishogi::ApiError => e
+  puts "Error when calling BotApi->api_stream_event_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ApiStreamEvent200Response**](ApiStreamEvent200Response.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/x-ndjson
+
+
+## bot_account_upgrade
+
+> <Ok> bot_account_upgrade
+
+Upgrade to Bot account
+
+Upgrade a lishogi player account into a Bot account. Only Bot accounts can use the Bot API.  The account **cannot have played any game** before becoming a Bot account. The upgrade is **irreversible**. The account will only be able to play as a Bot.  To upgrade an account to Bot, use the [official lishogi-bot client](https://github.com/ShailChoksi/lishogi-bot), or follow these steps: - Create an [API access token](https://lishogi.org/account/oauth/token/create?scopes[]=bot:play) with \"Play bot moves\" permission. - `curl -d '' https://lishogi.org/api/bot/account/upgrade -H \"Authorization: Bearer <yourTokenHere>\"`  To know if an account has already been upgraded, use the [Get my profile API](#operation/accountMe): the `title` field should be set to `BOT`. 
+
+### 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::BotApi.new
+
+begin
+  # Upgrade to Bot account
+  result = api_instance.bot_account_upgrade
+  p result
+rescue Lishogi::ApiError => e
+  puts "Error when calling BotApi->bot_account_upgrade: #{e}"
+end
+```
+
+#### Using the bot_account_upgrade_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Ok>, Integer, Hash)> bot_account_upgrade_with_http_info
+
+```ruby
+begin
+  # Upgrade to Bot account
+  data, status_code, headers = api_instance.bot_account_upgrade_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Ok>
+rescue Lishogi::ApiError => e
+  puts "Error when calling BotApi->bot_account_upgrade_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Ok**](Ok.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## bot_game_abort
+
+> <Ok> bot_game_abort(game_id)
+
+Abort a game
+
+Abort a game being played with the Bot API. 
+
+### 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::BotApi.new
+game_id = '5IrD6Gzz' # String | 
+
+begin
+  # Abort a game
+  result = api_instance.bot_game_abort(game_id)
+  p result
+rescue Lishogi::ApiError => e
+  puts "Error when calling BotApi->bot_game_abort: #{e}"
+end
+```
+
+#### Using the bot_game_abort_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Ok>, Integer, Hash)> bot_game_abort_with_http_info(game_id)
+
+```ruby
+begin
+  # Abort a game
+  data, status_code, headers = api_instance.bot_game_abort_with_http_info(game_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Ok>
+rescue Lishogi::ApiError => e
+  puts "Error when calling BotApi->bot_game_abort_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **game_id** | **String** |  |  |
+
+### Return type
+
+[**Ok**](Ok.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## bot_game_chat
+
+> <Ok> bot_game_chat(game_id, room, text)
+
+Write in the chat
+
+Post a message to the player or spectator chat, in a game being played with the Bot API. 
+
+### 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::BotApi.new
+game_id = '5IrD6Gzz' # String | 
+room = 'player' # String | 
+text = 'text_example' # String | 
+
+begin
+  # Write in the chat
+  result = api_instance.bot_game_chat(game_id, room, text)
+  p result
+rescue Lishogi::ApiError => e
+  puts "Error when calling BotApi->bot_game_chat: #{e}"
+end
+```
+
+#### Using the bot_game_chat_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Ok>, Integer, Hash)> bot_game_chat_with_http_info(game_id, room, text)
+
+```ruby
+begin
+  # Write in the chat
+  data, status_code, headers = api_instance.bot_game_chat_with_http_info(game_id, room, text)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Ok>
+rescue Lishogi::ApiError => e
+  puts "Error when calling BotApi->bot_game_chat_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **game_id** | **String** |  |  |
+| **room** | **String** |  |  |
+| **text** | **String** |  |  |
+
+### Return type
+
+[**Ok**](Ok.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: application/x-www-form-urlencoded
+- **Accept**: application/json
+
+
+## bot_game_chat_get
+
+> Object bot_game_chat_get(game_id)
+
+Fetch the game chat
+
+Get the messages posted in the game chat 
+
+### 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::BotApi.new
+game_id = '5IrD6Gzz' # String | 
+
+begin
+  # Fetch the game chat
+  result = api_instance.bot_game_chat_get(game_id)
+  p result
+rescue Lishogi::ApiError => e
+  puts "Error when calling BotApi->bot_game_chat_get: #{e}"
+end
+```
+
+#### Using the bot_game_chat_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> bot_game_chat_get_with_http_info(game_id)
+
+```ruby
+begin
+  # Fetch the game chat
+  data, status_code, headers = api_instance.bot_game_chat_get_with_http_info(game_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue Lishogi::ApiError => e
+  puts "Error when calling BotApi->bot_game_chat_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **game_id** | **String** |  |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/x-ndjson
+
+
+## bot_game_move
+
+> <Ok> bot_game_move(game_id, move)
+
+Make a Bot move
+
+Make a move in a game being played with the Bot API. 
+
+### 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::BotApi.new
+game_id = '5IrD6Gzz' # String | 
+move = 'e2e4' # String | The move to play, in USI format
+
+begin
+  # Make a Bot move
+  result = api_instance.bot_game_move(game_id, move)
+  p result
+rescue Lishogi::ApiError => e
+  puts "Error when calling BotApi->bot_game_move: #{e}"
+end
+```
+
+#### Using the bot_game_move_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Ok>, Integer, Hash)> bot_game_move_with_http_info(game_id, move)
+
+```ruby
+begin
+  # Make a Bot move
+  data, status_code, headers = api_instance.bot_game_move_with_http_info(game_id, move)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Ok>
+rescue Lishogi::ApiError => e
+  puts "Error when calling BotApi->bot_game_move_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **game_id** | **String** |  |  |
+| **move** | **String** | The move to play, in USI format |  |
+
+### Return type
+
+[**Ok**](Ok.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## bot_game_resign
+
+> <Ok> bot_game_resign(game_id)
+
+Resign a game
+
+Resign a game being played with the Bot API. 
+
+### 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::BotApi.new
+game_id = '5IrD6Gzz' # String | 
+
+begin
+  # Resign a game
+  result = api_instance.bot_game_resign(game_id)
+  p result
+rescue Lishogi::ApiError => e
+  puts "Error when calling BotApi->bot_game_resign: #{e}"
+end
+```
+
+#### Using the bot_game_resign_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Ok>, Integer, Hash)> bot_game_resign_with_http_info(game_id)
+
+```ruby
+begin
+  # Resign a game
+  data, status_code, headers = api_instance.bot_game_resign_with_http_info(game_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Ok>
+rescue Lishogi::ApiError => e
+  puts "Error when calling BotApi->bot_game_resign_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **game_id** | **String** |  |  |
+
+### Return type
+
+[**Ok**](Ok.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## bot_game_stream
+
+> <BoardGameStream200Response> bot_game_stream(game_id)
+
+Stream Bot game state
+
+ Stream the state of a game being played with the Bot API, as [ndjson](#section/Introduction/Streaming-with-ND-JSON).  Use this endpoint to get updates about the game in real-time, with a single request.  Each line is a JSON object containing a `type` field. Possible values are:   - `gameFull` Full game data. All values are immutable, except for the `state` field.   - `gameState` Current state of the game. Immutable values not included.   - `chatLine` Chat message sent by a user (or the bot itself) in the `room` \"player\" or \"spectator\".    The first line is always of type `gameFull`.
+
+### 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::BotApi.new
+game_id = '5IrD6Gzz' # String | 
+
+begin
+  # Stream Bot game state
+  result = api_instance.bot_game_stream(game_id)
+  p result
+rescue Lishogi::ApiError => e
+  puts "Error when calling BotApi->bot_game_stream: #{e}"
+end
+```
+
+#### Using the bot_game_stream_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<BoardGameStream200Response>, Integer, Hash)> bot_game_stream_with_http_info(game_id)
+
+```ruby
+begin
+  # Stream Bot game state
+  data, status_code, headers = api_instance.bot_game_stream_with_http_info(game_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <BoardGameStream200Response>
+rescue Lishogi::ApiError => e
+  puts "Error when calling BotApi->bot_game_stream_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **game_id** | **String** |  |  |
+
+### Return type
+
+[**BoardGameStream200Response**](BoardGameStream200Response.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/x-ndjson, application/json
+

data/docs/ChallengeDeclinedEvent.md

@@ -0,0 +1,20 @@
+# Lishogi::ChallengeDeclinedEvent
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** |  | [optional] |
+| **challenge** | [**ChallengeJson**](ChallengeJson.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'lishogi'
+
+instance = Lishogi::ChallengeDeclinedEvent.new(
+  type: null,
+  challenge: null
+)
+```
+

data/docs/ChallengeEvent.md

@@ -0,0 +1,20 @@
+# Lishogi::ChallengeEvent
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** |  | [optional] |
+| **challenge** | [**ChallengeJson**](ChallengeJson.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'lishogi'
+
+instance = Lishogi::ChallengeEvent.new(
+  type: null,
+  challenge: null
+)
+```
+