lishogi 0.1.0

data/docs/Count.md

@@ -0,0 +1,38 @@
+# Lishogi::Count
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **all** | **Integer** |  | [optional] |
+| **rated** | **Integer** |  | [optional] |
+| **ai** | **Integer** |  | [optional] |
+| **loss** | **Integer** |  | [optional] |
+| **loss_h** | **Integer** |  | [optional] |
+| **win** | **Integer** |  | [optional] |
+| **win_h** | **Integer** |  | [optional] |
+| **bookmark** | **Integer** |  | [optional] |
+| **playing** | **Integer** |  | [optional] |
+| **import** | **Integer** |  | [optional] |
+| **me** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'lishogi'
+
+instance = Lishogi::Count.new(
+  all: 9265,
+  rated: 7157,
+  ai: 531,
+  loss: 4480,
+  loss_h: 4207,
+  win: 4440,
+  win_h: 4378,
+  bookmark: 71,
+  playing: 6,
+  import: 66,
+  me: 0
+)
+```
+

data/docs/Error.md

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

data/docs/GameEventInfo.md

@@ -0,0 +1,22 @@
+# Lishogi::GameEventInfo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **source** | **String** |  | [optional] |
+| **compat** | [**GameEventInfoCompat**](GameEventInfoCompat.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'lishogi'
+
+instance = Lishogi::GameEventInfo.new(
+  id: null,
+  source: null,
+  compat: null
+)
+```
+

data/docs/GameEventInfoCompat.md

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

data/docs/GameEventPlayer.md

@@ -0,0 +1,28 @@
+# Lishogi::GameEventPlayer
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ai_level** | **Float** |  | [optional] |
+| **id** | **String** |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **title** | **String** |  | [optional] |
+| **rating** | **Float** |  | [optional] |
+| **provisional** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'lishogi'
+
+instance = Lishogi::GameEventPlayer.new(
+  ai_level: null,
+  id: null,
+  name: null,
+  title: null,
+  rating: null,
+  provisional: null
+)
+```
+

data/docs/GameFinishEvent.md

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

data/docs/GameFullEvent.md

@@ -0,0 +1,42 @@
+# Lishogi::GameFullEvent
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** |  |  |
+| **id** | **String** |  |  |
+| **variant** | [**Variant**](Variant.md) |  |  |
+| **clock** | [**Clock**](Clock.md) |  |  |
+| **speed** | [**Speed**](Speed.md) |  |  |
+| **perf** | [**GameFullEventPerf**](GameFullEventPerf.md) |  |  |
+| **rated** | **Boolean** |  |  |
+| **created_at** | **Float** |  |  |
+| **sente** | [**GameEventPlayer**](GameEventPlayer.md) |  |  |
+| **gote** | [**GameEventPlayer**](GameEventPlayer.md) |  |  |
+| **initial_sfen** | **String** |  | [default to 'startpos'] |
+| **state** | [**GameStateEvent**](GameStateEvent.md) |  |  |
+| **tournament_id** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'lishogi'
+
+instance = Lishogi::GameFullEvent.new(
+  type: null,
+  id: null,
+  variant: null,
+  clock: null,
+  speed: null,
+  perf: null,
+  rated: null,
+  created_at: null,
+  sente: null,
+  gote: null,
+  initial_sfen: null,
+  state: null,
+  tournament_id: null
+)
+```
+

data/docs/GameFullEventPerf.md

@@ -0,0 +1,18 @@
+# Lishogi::GameFullEventPerf
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Translated perf name (e.g. \"Classical\" or \"Blitz\") | [optional] |
+
+## Example
+
+```ruby
+require 'lishogi'
+
+instance = Lishogi::GameFullEventPerf.new(
+  name: null
+)
+```
+

data/docs/GameJson.md

@@ -0,0 +1,50 @@
+# Lishogi::GameJson
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **rated** | **Boolean** |  |  |
+| **variant** | [**VariantKey**](VariantKey.md) |  | [default to 'standard'] |
+| **speed** | [**Speed**](Speed.md) |  |  |
+| **perf** | **String** |  |  |
+| **created_at** | **Float** |  |  |
+| **last_move_at** | **Float** |  |  |
+| **status** | [**GameStatus**](GameStatus.md) |  |  |
+| **players** | [**GameJsonPlayers**](GameJsonPlayers.md) |  |  |
+| **initial_sfen** | **String** |  | [optional] |
+| **winner** | **String** |  | [optional] |
+| **moves** | **String** |  | [optional] |
+| **notation** | **String** |  | [optional] |
+| **days_per_turn** | **Float** |  | [optional] |
+| **analysis** | [**Array<GameJsonAnalysisInner>**](GameJsonAnalysisInner.md) |  | [optional] |
+| **tournament** | **String** |  | [optional] |
+| **clock** | [**GameJsonClock**](GameJsonClock.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'lishogi'
+
+instance = Lishogi::GameJson.new(
+  id: null,
+  rated: null,
+  variant: null,
+  speed: null,
+  perf: null,
+  created_at: null,
+  last_move_at: null,
+  status: null,
+  players: null,
+  initial_sfen: null,
+  winner: null,
+  moves: null,
+  notation: null,
+  days_per_turn: null,
+  analysis: null,
+  tournament: null,
+  clock: null
+)
+```
+

data/docs/GameJsonAnalysisInner.md

@@ -0,0 +1,24 @@
+# Lishogi::GameJsonAnalysisInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **eval** | **Float** | Evaluation in centipawns |  |
+| **best** | **String** | Best move in USI notation (only if played move was inaccurate) | [optional] |
+| **variation** | **String** | Best variation in USI notation (only if played move was inaccurate) | [optional] |
+| **judgment** | [**GameJsonAnalysisInnerJudgment**](GameJsonAnalysisInnerJudgment.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'lishogi'
+
+instance = Lishogi::GameJsonAnalysisInner.new(
+  eval: null,
+  best: c2c3,
+  variation: 7g7f 2h2b,
+  judgment: null
+)
+```
+

data/docs/GameJsonAnalysisInnerJudgment.md

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

data/docs/GameJsonClock.md

@@ -0,0 +1,26 @@
+# Lishogi::GameJsonClock
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **initial** | **Float** |  | [optional] |
+| **increment** | **Float** |  | [optional] |
+| **byoyomi** | **Float** |  | [optional] |
+| **periods** | **Float** |  | [optional] |
+| **total_time** | **Float** |  | [optional] |
+
+## Example
+
+```ruby
+require 'lishogi'
+
+instance = Lishogi::GameJsonClock.new(
+  initial: null,
+  increment: null,
+  byoyomi: null,
+  periods: null,
+  total_time: null
+)
+```
+

data/docs/GameJsonPlayers.md

@@ -0,0 +1,20 @@
+# Lishogi::GameJsonPlayers
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **sente** | [**GameUser**](GameUser.md) |  | [optional] |
+| **gote** | [**GameUser**](GameUser.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'lishogi'
+
+instance = Lishogi::GameJsonPlayers.new(
+  sente: null,
+  gote: null
+)
+```
+

data/docs/GameStartEvent.md

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

data/docs/GameStateEvent.md

@@ -0,0 +1,38 @@
+# Lishogi::GameStateEvent
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** |  |  |
+| **moves** | **String** | Current moves in USI format |  |
+| **btime** | **Integer** | Integer of milliseconds sente has left on the clock |  |
+| **qtime** | **Integer** | Integer of milliseconds Gote has left on the clock | [optional] |
+| **binc** | **Integer** | Integer of Sente Fisher increment. |  |
+| **winc** | **Integer** | Integer of Gote Fisher increment. |  |
+| **byo** | **Integer** | Integer of Byoyomi |  |
+| **status** | [**GameStatus**](GameStatus.md) |  |  |
+| **winner** | **String** | Color of the winner, if any | [optional] |
+| **btakeback** | **Boolean** | true if sente is proposing takeback, else omitted | [optional] |
+| **qtakeback** | **Boolean** | true if gote is proposing takeback, else omitted | [optional] |
+
+## Example
+
+```ruby
+require 'lishogi'
+
+instance = Lishogi::GameStateEvent.new(
+  type: null,
+  moves: null,
+  btime: null,
+  qtime: null,
+  binc: null,
+  winc: null,
+  byo: null,
+  status: null,
+  winner: null,
+  btakeback: null,
+  qtakeback: null
+)
+```
+

data/docs/GameStatus.md

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

data/docs/GameUser.md

@@ -0,0 +1,32 @@
+# Lishogi::GameUser
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user** | [**LightUser**](LightUser.md) |  | [optional] |
+| **rating** | **Float** |  | [optional] |
+| **rating_diff** | **Float** |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **provisional** | **Boolean** |  | [optional] |
+| **ai_level** | **Float** |  | [optional] |
+| **analysis** | [**GameUserAnalysis**](GameUserAnalysis.md) |  | [optional] |
+| **team** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'lishogi'
+
+instance = Lishogi::GameUser.new(
+  user: null,
+  rating: null,
+  rating_diff: null,
+  name: null,
+  provisional: null,
+  ai_level: null,
+  analysis: null,
+  team: null
+)
+```
+

data/docs/GameUserAnalysis.md

@@ -0,0 +1,24 @@
+# Lishogi::GameUserAnalysis
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **inaccuracy** | **Float** |  |  |
+| **mistake** | **Float** |  |  |
+| **blunder** | **Float** |  |  |
+| **acpl** | **Float** |  |  |
+
+## Example
+
+```ruby
+require 'lishogi'
+
+instance = Lishogi::GameUserAnalysis.new(
+  inaccuracy: null,
+  mistake: null,
+  blunder: null,
+  acpl: null
+)
+```
+