lishogi 0.1.0

data/docs/GamesApi.md

@@ -0,0 +1,473 @@
+# Lishogi::GamesApi
+
+All URIs are relative to *https://lishogi.org*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**api_account_playing**](GamesApi.md#api_account_playing) | **GET** /api/account/playing | Get my ongoing games |
+| [**api_games_user**](GamesApi.md#api_games_user) | **GET** /api/games/user/{username} | Export games of a user |
+| [**api_user_current_game**](GamesApi.md#api_user_current_game) | **GET** /api/user/{username}/current-game | Export ongoing game of a user |
+| [**game_kif**](GamesApi.md#game_kif) | **GET** /game/export/{gameId} | Export one game |
+| [**games_by_users**](GamesApi.md#games_by_users) | **POST** /api/stream/games-by-users | Stream games of users |
+| [**stream_game**](GamesApi.md#stream_game) | **GET** /api/stream/game/{id} | Stream moves of a game |
+
+
+## api_account_playing
+
+> Object api_account_playing(opts)
+
+Get my ongoing games
+
+Get the ongoing games of the current user. Real-time and correspondence games are included. The most urgent games are listed first. 
+
+### 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::GamesApi.new
+opts = {
+  nb: 56 # Integer | Max number of games to fetch
+}
+
+begin
+  # Get my ongoing games
+  result = api_instance.api_account_playing(opts)
+  p result
+rescue Lishogi::ApiError => e
+  puts "Error when calling GamesApi->api_account_playing: #{e}"
+end
+```
+
+#### Using the api_account_playing_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> api_account_playing_with_http_info(opts)
+
+```ruby
+begin
+  # Get my ongoing games
+  data, status_code, headers = api_instance.api_account_playing_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue Lishogi::ApiError => e
+  puts "Error when calling GamesApi->api_account_playing_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **nb** | **Integer** | Max number of games to fetch | [optional][default to 9] |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## api_games_user
+
+> Object api_games_user(username, opts)
+
+Export games of a user
+
+Download all games of any user in KIF or [ndjson](#section/Introduction/Streaming-with-ND-JSON) format.  Games are sorted by reverse chronological order (most recent first).  We recommend streaming the response, for it can be very long. <https://lishogi.org/@/YoBot_v2> for instance has more than 15,000 games.  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   - Authenticated, downloading your own games: 60 games per second 
+
+### 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::GamesApi.new
+username = 'username_example' # String | The user name.
+opts = {
+  since: 56, # Integer | Download games played since this timestamp. Defaults to account creation date.
+  _until: 56, # Integer | Download games played until this timestamp. Defaults to now.
+  max: 56, # Integer | How many games to download. Leave empty to download all games.
+  vs: 'vs_example', # String | [Filter] Only games played against this opponent
+  rated: true, # Boolean | [Filter] Only rated (`true`) or casual (`false`) games
+  perf_type: Lishogi::PerfType::ULTRA_BULLET, # PerfType | [Filter] Only games in these speeds or variants.   Multiple perf types can be specified, separated by a comma.   Example: blitz,rapid,classical
+  color: 'sente', # String | [Filter] Only games played as this color.
+  analysed: true, # Boolean | [Filter] Only games with or without a computer analysis available
+  moves: true, # Boolean | Include the KIF moves.
+  pgn_in_json: true, # Boolean | Include the full KIF within the JSON response, in a `notation` field. The response type must be set to `application/x-ndjson` by the request `Accept` header.
+  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]` 
+  ongoing: true, # Boolean | Include ongoing games. The last 3 moves will be omitted.
+  finished: true, # Boolean | Include finished games. Set to `false` to only get ongoing games.
+  players: 'players_example', # String | URL of a text file containing real names and ratings, to replace Lishogi usernames and ratings in the KIF. Example: <https://gist.githubusercontent.com/ornicar/6bfa91eb61a2dcae7bcd14cce1b2a4eb/raw/768b9f6cc8a8471d2555e47ba40fb0095e5fba37/gistfile1.txt> 
+  sort: 'dateAsc' # String | Sort order of the games.
+}
+
+begin
+  # Export games of a user
+  result = api_instance.api_games_user(username, opts)
+  p result
+rescue Lishogi::ApiError => e
+  puts "Error when calling GamesApi->api_games_user: #{e}"
+end
+```
+
+#### Using the api_games_user_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> api_games_user_with_http_info(username, opts)
+
+```ruby
+begin
+  # Export games of a user
+  data, status_code, headers = api_instance.api_games_user_with_http_info(username, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue Lishogi::ApiError => e
+  puts "Error when calling GamesApi->api_games_user_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **username** | **String** | The user name. |  |
+| **since** | **Integer** | Download games played since this timestamp. Defaults to account creation date. | [optional] |
+| **_until** | **Integer** | Download games played until this timestamp. Defaults to now. | [optional] |
+| **max** | **Integer** | How many games to download. Leave empty to download all games. | [optional] |
+| **vs** | **String** | [Filter] Only games played against this opponent | [optional] |
+| **rated** | **Boolean** | [Filter] Only rated (&#x60;true&#x60;) or casual (&#x60;false&#x60;) games | [optional] |
+| **perf_type** | [**PerfType**](.md) | [Filter] Only games in these speeds or variants.   Multiple perf types can be specified, separated by a comma.   Example: blitz,rapid,classical | [optional] |
+| **color** | **String** | [Filter] Only games played as this color. | [optional] |
+| **analysed** | **Boolean** | [Filter] Only games with or without a computer analysis available | [optional] |
+| **moves** | **Boolean** | Include the KIF moves. | [optional] |
+| **pgn_in_json** | **Boolean** | Include the full KIF within the JSON response, in a &#x60;notation&#x60; field. The response type must be set to &#x60;application/x-ndjson&#x60; by the request &#x60;Accept&#x60; header. | [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] |
+| **ongoing** | **Boolean** | Include ongoing games. The last 3 moves will be omitted. | [optional][default to false] |
+| **finished** | **Boolean** | Include finished games. Set to &#x60;false&#x60; to only get ongoing games. | [optional][default to true] |
+| **players** | **String** | URL of a text file containing real names and ratings, to replace Lishogi usernames and ratings in the KIF. Example: &lt;https://gist.githubusercontent.com/ornicar/6bfa91eb61a2dcae7bcd14cce1b2a4eb/raw/768b9f6cc8a8471d2555e47ba40fb0095e5fba37/gistfile1.txt&gt;  | [optional] |
+| **sort** | **String** | Sort order of the games. | [optional][default to &#39;dateDesc&#39;] |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: text/plain, application/x-ndjson
+
+
+## api_user_current_game
+
+> Object api_user_current_game(username, opts)
+
+Export ongoing game of a user
+
+Download the ongoing game, or the last game played, of a user. Available in either KIF or JSON format. If the game is ongoing, the 3 last moves are omitted. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'lishogi'
+
+api_instance = Lishogi::GamesApi.new
+username = 'username_example' # String | 
+opts = {
+  moves: true, # Boolean | Include the KIF moves.
+  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]` 
+  players: 'players_example' # String | URL of a text file containing real names and ratings, to replace Lishogi usernames and ratings in the KIF. Example: <https://gist.githubusercontent.com/ornicar/6bfa91eb61a2dcae7bcd14cce1b2a4eb/raw/768b9f6cc8a8471d2555e47ba40fb0095e5fba37/gistfile1.txt> 
+}
+
+begin
+  # Export ongoing game of a user
+  result = api_instance.api_user_current_game(username, opts)
+  p result
+rescue Lishogi::ApiError => e
+  puts "Error when calling GamesApi->api_user_current_game: #{e}"
+end
+```
+
+#### Using the api_user_current_game_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> api_user_current_game_with_http_info(username, opts)
+
+```ruby
+begin
+  # Export ongoing game of a user
+  data, status_code, headers = api_instance.api_user_current_game_with_http_info(username, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue Lishogi::ApiError => e
+  puts "Error when calling GamesApi->api_user_current_game_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **username** | **String** |  |  |
+| **moves** | **Boolean** | Include the KIF moves. | [optional][default to true] |
+| **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 true] |
+| **evals** | **Boolean** | Include analysis evaluation comments in the KIF, when available.  Example: &#x60;9   ７八銀(79)   * [%eval -1.48]&#x60;  | [optional][default to true] |
+| **players** | **String** | URL of a text file containing real names and ratings, to replace Lishogi usernames and ratings in the KIF. Example: &lt;https://gist.githubusercontent.com/ornicar/6bfa91eb61a2dcae7bcd14cce1b2a4eb/raw/768b9f6cc8a8471d2555e47ba40fb0095e5fba37/gistfile1.txt&gt;  | [optional] |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: text/plain, application/json
+
+
+## game_kif
+
+> Object game_kif(game_id, opts)
+
+Export one game
+
+Download one game in either KIF or JSON format.  Ongoing games have their last 3 moves omitted, after move 5. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'lishogi'
+
+api_instance = Lishogi::GamesApi.new
+game_id = 'game_id_example' # String | The game ID (8 characters).
+opts = {
+  moves: true, # Boolean | Include the KIF moves.
+  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]` 
+  players: 'players_example' # String | URL of a text file containing real names and ratings, to replace Lishogi usernames and ratings in the KIF. Example: <https://gist.githubusercontent.com/ornicar/6bfa91eb61a2dcae7bcd14cce1b2a4eb/raw/768b9f6cc8a8471d2555e47ba40fb0095e5fba37/gistfile1.txt> 
+}
+
+begin
+  # Export one game
+  result = api_instance.game_kif(game_id, opts)
+  p result
+rescue Lishogi::ApiError => e
+  puts "Error when calling GamesApi->game_kif: #{e}"
+end
+```
+
+#### Using the game_kif_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> game_kif_with_http_info(game_id, opts)
+
+```ruby
+begin
+  # Export one game
+  data, status_code, headers = api_instance.game_kif_with_http_info(game_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue Lishogi::ApiError => e
+  puts "Error when calling GamesApi->game_kif_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **game_id** | **String** | The game ID (8 characters). |  |
+| **moves** | **Boolean** | Include the KIF moves. | [optional][default to true] |
+| **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 true] |
+| **evals** | **Boolean** | Include analysis evaluation comments in the KIF, when available.  Example: &#x60;9   ７八銀(79)   * [%eval -1.48]&#x60;  | [optional][default to true] |
+| **players** | **String** | URL of a text file containing real names and ratings, to replace Lishogi usernames and ratings in the KIF. Example: &lt;https://gist.githubusercontent.com/ornicar/6bfa91eb61a2dcae7bcd14cce1b2a4eb/raw/768b9f6cc8a8471d2555e47ba40fb0095e5fba37/gistfile1.txt&gt;  | [optional] |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: text/plain, application/json
+
+
+## games_by_users
+
+> Object games_by_users(body, opts)
+
+Stream games of users
+
+Stream the games played between a list of users, in real time. Only games where **both players** are part of the list are included.  By default, games are only sent to the stream when they start. To also get all ongoing games at the beginning of the stream, use the `withCurrentGames` flag.  Maximum number of users: 300.  Games are streamed as [ndjson](#section/Introduction/Streaming-with-ND-JSON).  The method is `POST` so a longer list of IDs can be sent in the request body. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'lishogi'
+
+api_instance = Lishogi::GamesApi.new
+body = 'yokoyamatomoki,shogi_harbour,yohaansethnathan' # String | Up to 300 user IDs separated by commas.
+opts = {
+  with_current_games: true # Boolean | Include the already started games at the beginning of the stream.
+}
+
+begin
+  # Stream games of users
+  result = api_instance.games_by_users(body, opts)
+  p result
+rescue Lishogi::ApiError => e
+  puts "Error when calling GamesApi->games_by_users: #{e}"
+end
+```
+
+#### Using the games_by_users_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> games_by_users_with_http_info(body, opts)
+
+```ruby
+begin
+  # Stream games of users
+  data, status_code, headers = api_instance.games_by_users_with_http_info(body, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue Lishogi::ApiError => e
+  puts "Error when calling GamesApi->games_by_users_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **body** | **String** | Up to 300 user IDs separated by commas. |  |
+| **with_current_games** | **Boolean** | Include the already started games at the beginning of the stream. | [optional][default to false] |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: text/plain
+- **Accept**: application/x-ndjson
+
+
+## stream_game
+
+> Object stream_game(id)
+
+Stream moves of a game
+
+Stream positions and moves of any ongoing game, in [ndjson](#section/Introduction/Streaming-with-ND-JSON).  A description of the game is sent as a first message. Then a message is sent each time a move is played. Finally a description of the game is sent when it finishes, and the stream is closed.  After move 5, the stream intentionally remains 3 moves behind the game status, as to prevent cheat bots from using this API.  No more than 8 game streams can be opened at the same time from the same IP address. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'lishogi'
+
+api_instance = Lishogi::GamesApi.new
+id = 'LuGQwhBb' # String | 
+
+begin
+  # Stream moves of a game
+  result = api_instance.stream_game(id)
+  p result
+rescue Lishogi::ApiError => e
+  puts "Error when calling GamesApi->stream_game: #{e}"
+end
+```
+
+#### Using the stream_game_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> stream_game_with_http_info(id)
+
+```ruby
+begin
+  # Stream moves of a game
+  data, status_code, headers = api_instance.stream_game_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue Lishogi::ApiError => e
+  puts "Error when calling GamesApi->stream_game_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/x-ndjson
+

data/docs/LightUser.md

@@ -0,0 +1,24 @@
+# Lishogi::LightUser
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  | [optional] |
+| **title** | [**LightUserTitle**](LightUserTitle.md) |  | [optional] |
+| **patron** | **Boolean** |  | [optional] |
+| **id** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'lishogi'
+
+instance = Lishogi::LightUser.new(
+  name: Shogi_Harbour,
+  title: null,
+  patron: true,
+  id: shogi_harbour
+)
+```
+

data/docs/LightUserTitle.md

@@ -0,0 +1,49 @@
+# Lishogi::LightUserTitle
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'lishogi'
+
+Lishogi::LightUserTitle.openapi_one_of
+# =>
+# [
+#   :'LP',
+#   :'String'
+# ]
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'lishogi'
+
+Lishogi::LightUserTitle.build(data)
+# => #<LP:0x00007fdd4aab02a0>
+
+Lishogi::LightUserTitle.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `LP`
+- `String`
+- `nil` (if no type matches)
+

data/docs/MessagingApi.md

@@ -0,0 +1,79 @@
+# Lishogi::MessagingApi
+
+All URIs are relative to *https://lishogi.org*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**inbox_username**](MessagingApi.md#inbox_username) | **POST** /inbox/{username} | Send a private message |
+
+
+## inbox_username
+
+> <Ok> inbox_username(username, text)
+
+Send a private message
+
+Send a private message to another player. 
+
+### 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::MessagingApi.new
+username = 'wandererxii' # String | 
+text = 'text_example' # String | 
+
+begin
+  # Send a private message
+  result = api_instance.inbox_username(username, text)
+  p result
+rescue Lishogi::ApiError => e
+  puts "Error when calling MessagingApi->inbox_username: #{e}"
+end
+```
+
+#### Using the inbox_username_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Ok>, Integer, Hash)> inbox_username_with_http_info(username, text)
+
+```ruby
+begin
+  # Send a private message
+  data, status_code, headers = api_instance.inbox_username_with_http_info(username, text)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Ok>
+rescue Lishogi::ApiError => e
+  puts "Error when calling MessagingApi->inbox_username_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **username** | **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
+

data/docs/Move.md

@@ -0,0 +1,28 @@
+# Lishogi::Move
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **usi** | **String** |  | [optional] |
+| **checkmate** | **Boolean** |  | [optional] |
+| **stalemate** | **Boolean** |  | [optional] |
+| **variant_win** | **Boolean** |  | [optional] |
+| **variant_loss** | **Boolean** |  | [optional] |
+| **insufficient_material** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'lishogi'
+
+instance = Lishogi::Move.new(
+  usi: 7g7f+,
+  checkmate: null,
+  stalemate: null,
+  variant_win: null,
+  variant_loss: null,
+  insufficient_material: null
+)
+```
+

data/docs/NotFound.md

@@ -0,0 +1,18 @@
+# Lishogi::NotFound
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'lishogi'
+
+instance = Lishogi::NotFound.new(
+  error: null
+)
+```
+

data/docs/OAuthError.md

@@ -0,0 +1,20 @@
+# Lishogi::OAuthError
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | **String** | The cause of the error. | [optional] |
+| **error_description** | **String** | The reason why the request was rejected. | [optional] |
+
+## Example
+
+```ruby
+require 'lishogi'
+
+instance = Lishogi::OAuthError.new(
+  error: null,
+  error_description: null
+)
+```
+