lishogi 0.1.0

data/docs/ChallengeJson.md

@@ -0,0 +1,42 @@
+# Lishogi::ChallengeJson
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **url** | **String** |  |  |
+| **status** | **String** |  |  |
+| **challenger** | [**ChallengeUser**](ChallengeUser.md) |  |  |
+| **dest_user** | [**ChallengeUser**](ChallengeUser.md) |  |  |
+| **variant** | [**Variant**](Variant.md) |  |  |
+| **rated** | **Boolean** |  |  |
+| **speed** | [**Speed**](Speed.md) |  |  |
+| **time_control** | [**ChallengeJsonTimeControl**](ChallengeJsonTimeControl.md) |  |  |
+| **color** | **String** |  |  |
+| **perf** | [**ChallengeJsonPerf**](ChallengeJsonPerf.md) |  |  |
+| **direction** | **String** |  | [optional] |
+| **initial_sfen** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'lishogi'
+
+instance = Lishogi::ChallengeJson.new(
+  id: null,
+  url: null,
+  status: null,
+  challenger: null,
+  dest_user: null,
+  variant: null,
+  rated: null,
+  speed: null,
+  time_control: null,
+  color: null,
+  perf: null,
+  direction: null,
+  initial_sfen: null
+)
+```
+

data/docs/ChallengeJsonPerf.md

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

data/docs/ChallengeJsonTimeControl.md

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

data/docs/ChallengeJsonTimeControlOneOf.md

@@ -0,0 +1,28 @@
+# Lishogi::ChallengeJsonTimeControlOneOf
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** |  | [optional] |
+| **limit** | **Float** |  | [optional] |
+| **increment** | **Float** |  | [optional] |
+| **byoyomi** | **Float** |  | [optional] |
+| **periods** | **Float** |  | [optional] |
+| **show** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'lishogi'
+
+instance = Lishogi::ChallengeJsonTimeControlOneOf.new(
+  type: clock,
+  limit: null,
+  increment: null,
+  byoyomi: null,
+  periods: null,
+  show: 5+2
+)
+```
+

data/docs/ChallengeJsonTimeControlOneOf1.md

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

data/docs/ChallengeJsonTimeControlOneOf2.md

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

data/docs/ChallengeUser.md

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

data/docs/ChallengesApi.md

@@ -0,0 +1,414 @@
+# Lishogi::ChallengesApi
+
+All URIs are relative to *https://lishogi.org*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**challenge_accept**](ChallengesApi.md#challenge_accept) | **POST** /api/challenge/{challengeId}/accept | Accept a challenge |
+| [**challenge_ai**](ChallengesApi.md#challenge_ai) | **POST** /api/challenge/ai | Challenge the AI |
+| [**challenge_create**](ChallengesApi.md#challenge_create) | **POST** /api/challenge/{username} | Create a challenge |
+| [**challenge_decline**](ChallengesApi.md#challenge_decline) | **POST** /api/challenge/{challengeId}/decline | Decline a challenge |
+| [**challenge_open**](ChallengesApi.md#challenge_open) | **POST** /api/challenge/open | Open-ended challenge |
+
+
+## challenge_accept
+
+> <Ok> challenge_accept(challenge_id)
+
+Accept a challenge
+
+Accept an incoming challenge.  You should receive a `gameStart` event on the [incoming events stream](#operation/apiStreamEvent). 
+
+### 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::ChallengesApi.new
+challenge_id = '5IrD6Gzz' # String | 
+
+begin
+  # Accept a challenge
+  result = api_instance.challenge_accept(challenge_id)
+  p result
+rescue Lishogi::ApiError => e
+  puts "Error when calling ChallengesApi->challenge_accept: #{e}"
+end
+```
+
+#### Using the challenge_accept_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Ok>, Integer, Hash)> challenge_accept_with_http_info(challenge_id)
+
+```ruby
+begin
+  # Accept a challenge
+  data, status_code, headers = api_instance.challenge_accept_with_http_info(challenge_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Ok>
+rescue Lishogi::ApiError => e
+  puts "Error when calling ChallengesApi->challenge_accept_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **challenge_id** | **String** |  |  |
+
+### Return type
+
+[**Ok**](Ok.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## challenge_ai
+
+> <GameJson> challenge_ai(opts)
+
+Challenge the AI
+
+Start a game with Lishogi AI.  You will be notified on the [event stream](#operation/apiStreamEvent) that a new game has started. 
+
+### 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::ChallengesApi.new
+opts = {
+  level: 8.14, # Float | AI strength
+  clock_limit: 8.14, # Float | Clock initial time in seconds. If empty, a correspondence game is created.
+  clock_increment: 56, # Integer | Clock increment in seconds. If empty, a correspondence game is created.
+  clock_byoyomi: 56, # Integer | Clock byoyomi in seconds. If empty, a correspondence game is created.
+  clock_periods: 56, # Integer | Clock periods for byoyomi in seconds. If empty, a correspondence game is created.
+  days: 1, # Integer | Days per move, for correspondence games. Clock settings must be omitted.
+  color: 'random', # String | Which color you get to play
+  variant: Lishogi::VariantKey::STANDARD, # VariantKey | 
+  sfen: 'sfen_example' # String | Custom initial position (in SFEN). Variant must be standard, and the game cannot be rated.
+}
+
+begin
+  # Challenge the AI
+  result = api_instance.challenge_ai(opts)
+  p result
+rescue Lishogi::ApiError => e
+  puts "Error when calling ChallengesApi->challenge_ai: #{e}"
+end
+```
+
+#### Using the challenge_ai_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GameJson>, Integer, Hash)> challenge_ai_with_http_info(opts)
+
+```ruby
+begin
+  # Challenge the AI
+  data, status_code, headers = api_instance.challenge_ai_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GameJson>
+rescue Lishogi::ApiError => e
+  puts "Error when calling ChallengesApi->challenge_ai_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **level** | **Float** | AI strength | [optional] |
+| **clock_limit** | **Float** | Clock initial time in seconds. If empty, a correspondence game is created. | [optional] |
+| **clock_increment** | **Integer** | Clock increment in seconds. If empty, a correspondence game is created. | [optional] |
+| **clock_byoyomi** | **Integer** | Clock byoyomi in seconds. If empty, a correspondence game is created. | [optional] |
+| **clock_periods** | **Integer** | Clock periods for byoyomi in seconds. If empty, a correspondence game is created. | [optional] |
+| **days** | **Integer** | Days per move, for correspondence games. Clock settings must be omitted. | [optional] |
+| **color** | **String** | Which color you get to play | [optional][default to &#39;random&#39;] |
+| **variant** | [**VariantKey**](VariantKey.md) |  | [optional][default to &#39;standard&#39;] |
+| **sfen** | **String** | Custom initial position (in SFEN). Variant must be standard, and the game cannot be rated. | [optional][default to &#39;rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq - 0 1&#39;] |
+
+### Return type
+
+[**GameJson**](GameJson.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: application/x-www-form-urlencoded
+- **Accept**: application/json
+
+
+## challenge_create
+
+> <ChallengeJson> challenge_create(username, opts)
+
+Create a challenge
+
+Challenge someone to play. The targeted player can choose to accept or decline.  If the challenge is accepted, you will be notified on the [event stream](#operation/apiStreamEvent) that a new game has started. The game ID will be the same as the challenge ID.  If you also have an OAuth token with `challenge:write` scope for the receiving user, you can make them accept the challenge immediately by setting the `acceptByToken` field.  Challenges for realtime games (not correspondence) expire after 20s if not accepted. To prevent that, use the `keepAliveStream` flag described below. 
+
+### 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::ChallengesApi.new
+username = 'YoBot_v2' # String | 
+opts = {
+  rated: true, # Boolean | Game is rated and impacts players ratings
+  clock_limit: 8.14, # Float | Clock initial time in seconds. If empty, a correspondence game is created.
+  clock_increment: 56, # Integer | Clock increment in seconds. If empty, a correspondence game is created.
+  clock_byoyomi: 56, # Integer | Clock byoyomi in seconds. If empty, a correspondence game is created.
+  clock_periods: 56, # Integer | Clock periods for byoyomi in seconds. If empty, a correspondence game is created.
+  days: 1, # Integer | Days per move, for correspondence games. Clock settings must be omitted.
+  color: 'random', # String | Which color you get to play
+  variant: Lishogi::VariantKey::STANDARD, # VariantKey | 
+  sfen: 'sfen_example', # String | Custom initial position (in SFEN). Variant must be standard, and the game cannot be rated.
+  keep_alive_stream: true, # Boolean | If set, the response is streamed as [ndjson](#section/Introduction/Streaming-with-ND-JSON). The challenge is kept alive until the connection is closed by the client. When the challenge is accepted or declined, a message of the form `{\\\"done\\\":\\\"accepted\\\"}` is sent, then the connection is closed by the server. If not set, the response is not streamed, and the challenge expires after 20s if not accepted. 
+  accept_by_token: 'accept_by_token_example', # String | Immediately accept the challenge and create the game. Pass in an OAuth token (with the `challenge:write` scope) for the receiving user. On success, the response will contain a `game` field instead of a `challenge` field. 
+  message: 'message_example' # String | **Only if `acceptByToken` is set.**  Message that is sent to each player, when the game is created. It is sent from your user account.  `{opponent}`, `{player}` and `{game}` are placeholders that will be replaced with the opponent name, player name, and the game URLs.  You can omit this field to send the default message, but if you set your own message, it must at least contain the `{game}` placeholder. 
+}
+
+begin
+  # Create a challenge
+  result = api_instance.challenge_create(username, opts)
+  p result
+rescue Lishogi::ApiError => e
+  puts "Error when calling ChallengesApi->challenge_create: #{e}"
+end
+```
+
+#### Using the challenge_create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ChallengeJson>, Integer, Hash)> challenge_create_with_http_info(username, opts)
+
+```ruby
+begin
+  # Create a challenge
+  data, status_code, headers = api_instance.challenge_create_with_http_info(username, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ChallengeJson>
+rescue Lishogi::ApiError => e
+  puts "Error when calling ChallengesApi->challenge_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **username** | **String** |  |  |
+| **rated** | **Boolean** | Game is rated and impacts players ratings | [optional] |
+| **clock_limit** | **Float** | Clock initial time in seconds. If empty, a correspondence game is created. | [optional] |
+| **clock_increment** | **Integer** | Clock increment in seconds. If empty, a correspondence game is created. | [optional] |
+| **clock_byoyomi** | **Integer** | Clock byoyomi in seconds. If empty, a correspondence game is created. | [optional] |
+| **clock_periods** | **Integer** | Clock periods for byoyomi in seconds. If empty, a correspondence game is created. | [optional] |
+| **days** | **Integer** | Days per move, for correspondence games. Clock settings must be omitted. | [optional] |
+| **color** | **String** | Which color you get to play | [optional][default to &#39;random&#39;] |
+| **variant** | [**VariantKey**](VariantKey.md) |  | [optional][default to &#39;standard&#39;] |
+| **sfen** | **String** | Custom initial position (in SFEN). Variant must be standard, and the game cannot be rated. | [optional][default to &#39;rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq - 0 1&#39;] |
+| **keep_alive_stream** | **Boolean** | If set, the response is streamed as [ndjson](#section/Introduction/Streaming-with-ND-JSON). The challenge is kept alive until the connection is closed by the client. When the challenge is accepted or declined, a message of the form &#x60;{\\\&quot;done\\\&quot;:\\\&quot;accepted\\\&quot;}&#x60; is sent, then the connection is closed by the server. If not set, the response is not streamed, and the challenge expires after 20s if not accepted.  | [optional] |
+| **accept_by_token** | **String** | Immediately accept the challenge and create the game. Pass in an OAuth token (with the &#x60;challenge:write&#x60; scope) for the receiving user. On success, the response will contain a &#x60;game&#x60; field instead of a &#x60;challenge&#x60; field.  | [optional] |
+| **message** | **String** | **Only if &#x60;acceptByToken&#x60; is set.**  Message that is sent to each player, when the game is created. It is sent from your user account.  &#x60;{opponent}&#x60;, &#x60;{player}&#x60; and &#x60;{game}&#x60; are placeholders that will be replaced with the opponent name, player name, and the game URLs.  You can omit this field to send the default message, but if you set your own message, it must at least contain the &#x60;{game}&#x60; placeholder.  | [optional][default to &#39;Your game with {opponent} is ready: {game}.&#39;] |
+
+### Return type
+
+[**ChallengeJson**](ChallengeJson.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: application/x-www-form-urlencoded
+- **Accept**: application/json
+
+
+## challenge_decline
+
+> <Ok> challenge_decline(challenge_id)
+
+Decline a challenge
+
+Decline an incoming challenge. 
+
+### 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::ChallengesApi.new
+challenge_id = '5IrD6Gzz' # String | 
+
+begin
+  # Decline a challenge
+  result = api_instance.challenge_decline(challenge_id)
+  p result
+rescue Lishogi::ApiError => e
+  puts "Error when calling ChallengesApi->challenge_decline: #{e}"
+end
+```
+
+#### Using the challenge_decline_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Ok>, Integer, Hash)> challenge_decline_with_http_info(challenge_id)
+
+```ruby
+begin
+  # Decline a challenge
+  data, status_code, headers = api_instance.challenge_decline_with_http_info(challenge_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Ok>
+rescue Lishogi::ApiError => e
+  puts "Error when calling ChallengesApi->challenge_decline_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **challenge_id** | **String** |  |  |
+
+### Return type
+
+[**Ok**](Ok.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## challenge_open
+
+> Object challenge_open(opts)
+
+Open-ended challenge
+
+Create a challenge that any 2 players can join.  Share the URL of the challenge. the first 2 players to click it will be paired for a game.  The response body also contains `senteUrl` and `goteUrl`. You can control which color each player gets by giving them these URLs, instead of the main challenge URL.  Open challenges expire after 24h.  To directly pair 2 known players, use [this endpoint](#operation/challengeCreate) instead, with the `acceptByToken` parameter. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'lishogi'
+
+api_instance = Lishogi::ChallengesApi.new
+opts = {
+  rated: true, # Boolean | Game is rated and impacts players ratings
+  clock_limit: 8.14, # Float | Clock initial time in seconds. If empty, a correspondence game is created.
+  clock_increment: 56, # Integer | Clock increment in seconds. If empty, a correspondence game is created.
+  clock_byoyomi: 56, # Integer | Clock byoyomi in seconds. If empty, a correspondence game is created.
+  clock_periods: 56, # Integer | Clock periods for byoyomi in seconds. If empty, a correspondence game is created.
+  days: 1, # Integer | Days per turn. For correspondence challenges.
+  variant: Lishogi::VariantKey::STANDARD, # VariantKey | 
+  sfen: 'sfen_example', # String | Custom initial position (in SFEN). Variant must be standard, and the game cannot be rated.
+  name: 'name_example' # String | Optional name for the challenge, that players will see on the challenge page.
+}
+
+begin
+  # Open-ended challenge
+  result = api_instance.challenge_open(opts)
+  p result
+rescue Lishogi::ApiError => e
+  puts "Error when calling ChallengesApi->challenge_open: #{e}"
+end
+```
+
+#### Using the challenge_open_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> challenge_open_with_http_info(opts)
+
+```ruby
+begin
+  # Open-ended challenge
+  data, status_code, headers = api_instance.challenge_open_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue Lishogi::ApiError => e
+  puts "Error when calling ChallengesApi->challenge_open_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **rated** | **Boolean** | Game is rated and impacts players ratings | [optional] |
+| **clock_limit** | **Float** | Clock initial time in seconds. If empty, a correspondence game is created. | [optional] |
+| **clock_increment** | **Integer** | Clock increment in seconds. If empty, a correspondence game is created. | [optional] |
+| **clock_byoyomi** | **Integer** | Clock byoyomi in seconds. If empty, a correspondence game is created. | [optional] |
+| **clock_periods** | **Integer** | Clock periods for byoyomi in seconds. If empty, a correspondence game is created. | [optional] |
+| **days** | **Integer** | Days per turn. For correspondence challenges. | [optional] |
+| **variant** | [**VariantKey**](VariantKey.md) |  | [optional][default to &#39;standard&#39;] |
+| **sfen** | **String** | Custom initial position (in SFEN). Variant must be standard, and the game cannot be rated. | [optional][default to &#39;rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq - 0 1&#39;] |
+| **name** | **String** | Optional name for the challenge, that players will see on the challenge page. | [optional] |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/x-www-form-urlencoded
+- **Accept**: application/json
+

data/docs/ChatLineEvent.md

@@ -0,0 +1,24 @@
+# Lishogi::ChatLineEvent
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** |  |  |
+| **room** | **String** |  |  |
+| **username** | **String** |  |  |
+| **text** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'lishogi'
+
+instance = Lishogi::ChatLineEvent.new(
+  type: null,
+  room: null,
+  username: null,
+  text: null
+)
+```
+

data/docs/Clock.md

@@ -0,0 +1,24 @@
+# Lishogi::Clock
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **limit** | **Integer** |  | [optional] |
+| **increment** | **Integer** |  | [optional] |
+| **byoyomi** | **Integer** |  | [optional] |
+| **periods** | **Object** |  | [optional] |
+
+## Example
+
+```ruby
+require 'lishogi'
+
+instance = Lishogi::Clock.new(
+  limit: null,
+  increment: null,
+  byoyomi: null,
+  periods: null
+)
+```
+