lishogi 0.1.0

data/docs/BoardApi.md

@@ -0,0 +1,659 @@
+# Lishogi::BoardApi
+
+All URIs are relative to *https://lishogi.org*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**api_board_seek**](BoardApi.md#api_board_seek) | **POST** /api/board/seek | Create a seek |
+| [**api_stream_event**](BoardApi.md#api_stream_event) | **GET** /api/stream/event | Stream incoming events |
+| [**board_game_abort**](BoardApi.md#board_game_abort) | **POST** /api/board/game/{gameId}/abort | Abort a game |
+| [**board_game_chat_get**](BoardApi.md#board_game_chat_get) | **GET** /api/board/game/{gameId}/chat | Fetch the game chat |
+| [**board_game_chat_post**](BoardApi.md#board_game_chat_post) | **POST** /api/board/game/{gameId}/chat | Write in the chat |
+| [**board_game_move**](BoardApi.md#board_game_move) | **POST** /api/board/game/{gameId}/move/{move} | Make a Board move |
+| [**board_game_resign**](BoardApi.md#board_game_resign) | **POST** /api/board/game/{gameId}/resign | Resign a game |
+| [**board_game_stream**](BoardApi.md#board_game_stream) | **GET** /api/board/game/stream/{gameId} | Stream Board game state |
+| [**board_game_takeback**](BoardApi.md#board_game_takeback) | **POST** /api/board/game/{gameId}/takeback/{accept} | Handle takeback offers |
+
+
+## api_board_seek
+
+> api_board_seek(opts)
+
+Create a seek
+
+   Create a public seek, to start a game with a random player.    ### Real-time seek    Specify the `time`, `increment`, `byoyomi` and `periods` clock values.  The response is streamed but doesn't contain any information.    **Keep the connection open to keep the seek active**.    If the client closes the connection, the seek is canceled. This way, if the client terminates, the user won't be paired in a game they wouldn't play.   When the seek is accepted, or expires, the server closes the connection.    **Make sure to also have an [Event stream](#operation/apiStreamEvent) open**, to be notified when a game starts.   We recommend opening the [Event stream](#operation/apiStreamEvent) first, then the seek stream. This way,   you won't miss the game event if the seek is accepted immediately.    ### Correspondence seek    Specify the `days` per turn value.  The response is not streamed, it immediately completes with the seek ID. The seek remains active on the server until it is joined by someone.
+
+### 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::BoardApi.new
+opts = {
+  rated: true, # Boolean | Whether the game is rated and impacts players ratings.
+  time: 8.14, # Float | Clock initial time in minutes. Required for real-time seeks.
+  increment: 56, # Integer | Clock increment in seconds. Required for real-time seeks.
+  byoyomi: 56, # Integer | Clock byoyomi in seconds. Required for real-time seeks.
+  periods: 56, # Integer | Clock periods for byoyomi in seconds. Required for real-time seeks.
+  days: 1, # Integer | Days per turn. Required for correspondence seeks.
+  variant: Lishogi::VariantKey::STANDARD, # VariantKey | 
+  color: 'random', # String | The color to play. Better left empty to automatically get a random color.
+  rating_range: 'rating_range_example' # String | The rating range of potential opponents. Better left empty. Example: 1500-1800 
+}
+
+begin
+  # Create a seek
+  api_instance.api_board_seek(opts)
+rescue Lishogi::ApiError => e
+  puts "Error when calling BoardApi->api_board_seek: #{e}"
+end
+```
+
+#### Using the api_board_seek_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> api_board_seek_with_http_info(opts)
+
+```ruby
+begin
+  # Create a seek
+  data, status_code, headers = api_instance.api_board_seek_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Lishogi::ApiError => e
+  puts "Error when calling BoardApi->api_board_seek_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **rated** | **Boolean** | Whether the game is rated and impacts players ratings. | [optional][default to false] |
+| **time** | **Float** | Clock initial time in minutes. Required for real-time seeks. | [optional] |
+| **increment** | **Integer** | Clock increment in seconds. Required for real-time seeks. | [optional] |
+| **byoyomi** | **Integer** | Clock byoyomi in seconds. Required for real-time seeks. | [optional] |
+| **periods** | **Integer** | Clock periods for byoyomi in seconds. Required for real-time seeks. | [optional] |
+| **days** | **Integer** | Days per turn. Required for correspondence seeks. | [optional] |
+| **variant** | [**VariantKey**](VariantKey.md) |  | [optional][default to &#39;standard&#39;] |
+| **color** | **String** | The color to play. Better left empty to automatically get a random color. | [optional][default to &#39;random&#39;] |
+| **rating_range** | **String** | The rating range of potential opponents. Better left empty. Example: 1500-1800  | [optional] |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: application/x-www-form-urlencoded
+- **Accept**: text/plain, application/json
+
+
+## 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::BoardApi.new
+
+begin
+  # Stream incoming events
+  result = api_instance.api_stream_event
+  p result
+rescue Lishogi::ApiError => e
+  puts "Error when calling BoardApi->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 BoardApi->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
+
+
+## board_game_abort
+
+> <Ok> board_game_abort(game_id)
+
+Abort a game
+
+Abort a game being played with the Board 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::BoardApi.new
+game_id = '5IrD6Gzz' # String | 
+
+begin
+  # Abort a game
+  result = api_instance.board_game_abort(game_id)
+  p result
+rescue Lishogi::ApiError => e
+  puts "Error when calling BoardApi->board_game_abort: #{e}"
+end
+```
+
+#### Using the board_game_abort_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Ok>, Integer, Hash)> board_game_abort_with_http_info(game_id)
+
+```ruby
+begin
+  # Abort a game
+  data, status_code, headers = api_instance.board_game_abort_with_http_info(game_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Ok>
+rescue Lishogi::ApiError => e
+  puts "Error when calling BoardApi->board_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
+
+
+## board_game_chat_get
+
+> Object board_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::BoardApi.new
+game_id = '5IrD6Gzz' # String | 
+
+begin
+  # Fetch the game chat
+  result = api_instance.board_game_chat_get(game_id)
+  p result
+rescue Lishogi::ApiError => e
+  puts "Error when calling BoardApi->board_game_chat_get: #{e}"
+end
+```
+
+#### Using the board_game_chat_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> board_game_chat_get_with_http_info(game_id)
+
+```ruby
+begin
+  # Fetch the game chat
+  data, status_code, headers = api_instance.board_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 BoardApi->board_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
+
+
+## board_game_chat_post
+
+> <Ok> board_game_chat_post(game_id, room, text)
+
+Write in the chat
+
+Post a message to the player or spectator chat, in a game being played with the Board 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::BoardApi.new
+game_id = '5IrD6Gzz' # String | 
+room = 'player' # String | 
+text = 'text_example' # String | 
+
+begin
+  # Write in the chat
+  result = api_instance.board_game_chat_post(game_id, room, text)
+  p result
+rescue Lishogi::ApiError => e
+  puts "Error when calling BoardApi->board_game_chat_post: #{e}"
+end
+```
+
+#### Using the board_game_chat_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Ok>, Integer, Hash)> board_game_chat_post_with_http_info(game_id, room, text)
+
+```ruby
+begin
+  # Write in the chat
+  data, status_code, headers = api_instance.board_game_chat_post_with_http_info(game_id, room, text)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Ok>
+rescue Lishogi::ApiError => e
+  puts "Error when calling BoardApi->board_game_chat_post_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
+
+
+## board_game_move
+
+> <Ok> board_game_move(game_id, move)
+
+Make a Board move
+
+Make a move in a game being played with the Board 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::BoardApi.new
+game_id = '5IrD6Gzz' # String | 
+move = '7g7f' # String | The move to play, in USI format
+
+begin
+  # Make a Board move
+  result = api_instance.board_game_move(game_id, move)
+  p result
+rescue Lishogi::ApiError => e
+  puts "Error when calling BoardApi->board_game_move: #{e}"
+end
+```
+
+#### Using the board_game_move_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Ok>, Integer, Hash)> board_game_move_with_http_info(game_id, move)
+
+```ruby
+begin
+  # Make a Board move
+  data, status_code, headers = api_instance.board_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 BoardApi->board_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
+
+
+## board_game_resign
+
+> <Ok> board_game_resign(game_id)
+
+Resign a game
+
+Resign a game being played with the Board 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::BoardApi.new
+game_id = '5IrD6Gzz' # String | 
+
+begin
+  # Resign a game
+  result = api_instance.board_game_resign(game_id)
+  p result
+rescue Lishogi::ApiError => e
+  puts "Error when calling BoardApi->board_game_resign: #{e}"
+end
+```
+
+#### Using the board_game_resign_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Ok>, Integer, Hash)> board_game_resign_with_http_info(game_id)
+
+```ruby
+begin
+  # Resign a game
+  data, status_code, headers = api_instance.board_game_resign_with_http_info(game_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Ok>
+rescue Lishogi::ApiError => e
+  puts "Error when calling BoardApi->board_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
+
+
+## board_game_stream
+
+> <BoardGameStream200Response> board_game_stream(game_id)
+
+Stream Board game state
+
+ Stream the state of a game being played with the Board API, as [ndjson](#section/Introduction/Streaming-with-ND-JSON).  Use this endpoint to get updates about the game in real-time, with a single request.  Each line is a JSON object containing a `type` field. Possible values are:   - `gameFull` Full game data. All values are immutable, except for the `state` field.   - `gameState` Current state of the game. Immutable values not included. Sent when a move is played, or when the game ends.   - `chatLine` Chat message sent by a user in the `room` \"player\" or \"spectator\".    The first line is always of type `gameFull`.    The server closes the stream when the game ends, or if the game has already ended.
+
+### 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::BoardApi.new
+game_id = '5IrD6Gzz' # String | 
+
+begin
+  # Stream Board game state
+  result = api_instance.board_game_stream(game_id)
+  p result
+rescue Lishogi::ApiError => e
+  puts "Error when calling BoardApi->board_game_stream: #{e}"
+end
+```
+
+#### Using the board_game_stream_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<BoardGameStream200Response>, Integer, Hash)> board_game_stream_with_http_info(game_id)
+
+```ruby
+begin
+  # Stream Board game state
+  data, status_code, headers = api_instance.board_game_stream_with_http_info(game_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <BoardGameStream200Response>
+rescue Lishogi::ApiError => e
+  puts "Error when calling BoardApi->board_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
+
+
+## board_game_takeback
+
+> <Ok> board_game_takeback(game_id, accept)
+
+Handle takeback offers
+
+Create/accept/decline takebacks. - `yes`: Propose a takeback, or accept the opponent's takeback offer. - `no`: Decline a takeback offer from the opponent. 
+
+### 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::BoardApi.new
+game_id = '5IrD6Gzz' # String | 
+accept = Lishogi::BoardGameTakebackAcceptParameter.new # BoardGameTakebackAcceptParameter | 
+
+begin
+  # Handle takeback offers
+  result = api_instance.board_game_takeback(game_id, accept)
+  p result
+rescue Lishogi::ApiError => e
+  puts "Error when calling BoardApi->board_game_takeback: #{e}"
+end
+```
+
+#### Using the board_game_takeback_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Ok>, Integer, Hash)> board_game_takeback_with_http_info(game_id, accept)
+
+```ruby
+begin
+  # Handle takeback offers
+  data, status_code, headers = api_instance.board_game_takeback_with_http_info(game_id, accept)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Ok>
+rescue Lishogi::ApiError => e
+  puts "Error when calling BoardApi->board_game_takeback_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **game_id** | **String** |  |  |
+| **accept** | [**BoardGameTakebackAcceptParameter**](.md) |  |  |
+
+### Return type
+
+[**Ok**](Ok.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/BoardGameStream200Response.md

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