lishogi 0.1.0

data/docs/Ok.md

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

data/docs/Perf.md

@@ -0,0 +1,26 @@
+# Lishogi::Perf
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **games** | **Integer** |  | [optional] |
+| **rating** | **Integer** |  | [optional] |
+| **rd** | **Integer** |  | [optional] |
+| **prog** | **Integer** |  | [optional] |
+| **prov** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'lishogi'
+
+instance = Lishogi::Perf.new(
+  games: 2945,
+  rating: 1609,
+  rd: 60,
+  prog: -22,
+  prov: null
+)
+```
+

data/docs/PerfType.md

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

data/docs/Perfs.md

@@ -0,0 +1,30 @@
+# Lishogi::Perfs
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ultra_bullet** | [**Perf**](Perf.md) |  | [optional] |
+| **blitz** | [**Perf**](Perf.md) |  | [optional] |
+| **bullet** | [**Perf**](Perf.md) |  | [optional] |
+| **correspondence** | [**Perf**](Perf.md) |  | [optional] |
+| **puzzle** | [**Perf**](Perf.md) |  | [optional] |
+| **classical** | [**Perf**](Perf.md) |  | [optional] |
+| **rapid** | [**Perf**](Perf.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'lishogi'
+
+instance = Lishogi::Perfs.new(
+  ultra_bullet: null,
+  blitz: null,
+  bullet: null,
+  correspondence: null,
+  puzzle: null,
+  classical: null,
+  rapid: null
+)
+```
+

data/docs/PlayTime.md

@@ -0,0 +1,20 @@
+# Lishogi::PlayTime
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **total** | **Integer** |  | [optional] |
+| **tv** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'lishogi'
+
+instance = Lishogi::PlayTime.new(
+  total: 3296897,
+  tv: 12134
+)
+```
+

data/docs/Profile.md

@@ -0,0 +1,28 @@
+# Lishogi::Profile
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **country** | **String** |  | [optional] |
+| **location** | **String** |  | [optional] |
+| **bio** | **String** |  | [optional] |
+| **first_name** | **String** |  | [optional] |
+| **last_name** | **String** |  | [optional] |
+| **links** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'lishogi'
+
+instance = Lishogi::Profile.new(
+  country: EC,
+  location: null,
+  bio: Free bugs!,
+  first_name: Yohaan,
+  last_name: Seth Nathan,
+  links: github.com/TheYoBots
+)
+```
+

data/docs/PuzzleRoundJson.md

@@ -0,0 +1,24 @@
+# Lishogi::PuzzleRoundJson
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **date** | **Float** |  | [optional] |
+| **win** | **Boolean** |  | [optional] |
+| **puzzle_rating** | **Float** |  | [optional] |
+
+## Example
+
+```ruby
+require 'lishogi'
+
+instance = Lishogi::PuzzleRoundJson.new(
+  id: BwPiW,
+  date: 1514505150384,
+  win: true,
+  puzzle_rating: 1877
+)
+```
+

data/docs/PuzzlesApi.md

@@ -0,0 +1,211 @@
+# Lishogi::PuzzlesApi
+
+All URIs are relative to *https://lishogi.org*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**api_puzzle_activity**](PuzzlesApi.md#api_puzzle_activity) | **GET** /api/puzzle/activity | Get your puzzle activity |
+| [**api_puzzle_daily**](PuzzlesApi.md#api_puzzle_daily) | **GET** /api/puzzle/daily | Get the daily puzzle |
+| [**api_puzzle_dashboard**](PuzzlesApi.md#api_puzzle_dashboard) | **GET** /api/puzzle/dashboard/{days} | Get your puzzle dashboard |
+
+
+## api_puzzle_activity
+
+> <PuzzleRoundJson> api_puzzle_activity(opts)
+
+Get your puzzle activity
+
+Download your puzzle activity in [ndjson](#section/Introduction/Streaming-with-ND-JSON) format.  Puzzle activity is sorted by reverse chronological order (most recent first)  We recommend streaming the response, for it can be very long. 
+
+### 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::PuzzlesApi.new
+opts = {
+  max: 56 # Integer | How many entries to download. Leave empty to download all activity.
+}
+
+begin
+  # Get your puzzle activity
+  result = api_instance.api_puzzle_activity(opts)
+  p result
+rescue Lishogi::ApiError => e
+  puts "Error when calling PuzzlesApi->api_puzzle_activity: #{e}"
+end
+```
+
+#### Using the api_puzzle_activity_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PuzzleRoundJson>, Integer, Hash)> api_puzzle_activity_with_http_info(opts)
+
+```ruby
+begin
+  # Get your puzzle activity
+  data, status_code, headers = api_instance.api_puzzle_activity_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PuzzleRoundJson>
+rescue Lishogi::ApiError => e
+  puts "Error when calling PuzzlesApi->api_puzzle_activity_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **max** | **Integer** | How many entries to download. Leave empty to download all activity. | [optional] |
+
+### Return type
+
+[**PuzzleRoundJson**](PuzzleRoundJson.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/x-ndjson
+
+
+## api_puzzle_daily
+
+> Object api_puzzle_daily
+
+Get the daily puzzle
+
+Get the daily Lishogi puzzle in JSON format. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'lishogi'
+
+api_instance = Lishogi::PuzzlesApi.new
+
+begin
+  # Get the daily puzzle
+  result = api_instance.api_puzzle_daily
+  p result
+rescue Lishogi::ApiError => e
+  puts "Error when calling PuzzlesApi->api_puzzle_daily: #{e}"
+end
+```
+
+#### Using the api_puzzle_daily_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> api_puzzle_daily_with_http_info
+
+```ruby
+begin
+  # Get the daily puzzle
+  data, status_code, headers = api_instance.api_puzzle_daily_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue Lishogi::ApiError => e
+  puts "Error when calling PuzzlesApi->api_puzzle_daily_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/x-ndjson
+
+
+## api_puzzle_dashboard
+
+> Object api_puzzle_dashboard(days)
+
+Get your puzzle dashboard
+
+Download your [puzzle dashboard](https://lishogi.org/training/dashboard/30/dashboard) as JSON.  Also includes all puzzle themes played, with aggregated results.  Allows re-creating the [improvement/strengths](https://lishogi.org/training/dashboard/30/improvementAreas) interfaces. 
+
+### 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::PuzzlesApi.new
+days = 56 # Integer | How many days to look back when aggregating puzzle results. 30 is sensible.
+
+begin
+  # Get your puzzle dashboard
+  result = api_instance.api_puzzle_dashboard(days)
+  p result
+rescue Lishogi::ApiError => e
+  puts "Error when calling PuzzlesApi->api_puzzle_dashboard: #{e}"
+end
+```
+
+#### Using the api_puzzle_dashboard_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> api_puzzle_dashboard_with_http_info(days)
+
+```ruby
+begin
+  # Get your puzzle dashboard
+  data, status_code, headers = api_instance.api_puzzle_dashboard_with_http_info(days)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue Lishogi::ApiError => e
+  puts "Error when calling PuzzlesApi->api_puzzle_dashboard_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **days** | **Integer** | How many days to look back when aggregating puzzle results. 30 is sensible. |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/SimulsApi.md

@@ -0,0 +1,69 @@
+# Lishogi::SimulsApi
+
+All URIs are relative to *https://lishogi.org*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**api_simul**](SimulsApi.md#api_simul) | **GET** /api/simul | Get current simuls |
+
+
+## api_simul
+
+> Array<Object> api_simul
+
+Get current simuls
+
+Get recently finished, ongoing, and upcoming simuls. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'lishogi'
+
+api_instance = Lishogi::SimulsApi.new
+
+begin
+  # Get current simuls
+  result = api_instance.api_simul
+  p result
+rescue Lishogi::ApiError => e
+  puts "Error when calling SimulsApi->api_simul: #{e}"
+end
+```
+
+#### Using the api_simul_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Array&lt;Object&gt;, Integer, Hash)> api_simul_with_http_info
+
+```ruby
+begin
+  # Get current simuls
+  data, status_code, headers = api_instance.api_simul_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Array&lt;Object&gt;
+rescue Lishogi::ApiError => e
+  puts "Error when calling SimulsApi->api_simul_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+**Array&lt;Object&gt;**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/Speed.md

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

data/docs/StudiesApi.md

@@ -0,0 +1,233 @@
+# Lishogi::StudiesApi
+
+All URIs are relative to *https://lishogi.org*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**study_all_chapters_kif**](StudiesApi.md#study_all_chapters_kif) | **GET** /api/study/{studyId}.kif | Export all chapters |
+| [**study_chapter_kif**](StudiesApi.md#study_chapter_kif) | **GET** /study/{studyId}/{chapterId}.kif | Export one study chapter |
+| [**study_export_all_kif**](StudiesApi.md#study_export_all_kif) | **GET** /study/by/{username}/export.kif | Export all studies of a user |
+
+
+## study_all_chapters_kif
+
+> Object study_all_chapters_kif(study_id, opts)
+
+Export all chapters
+
+Download all chapters of a study in KIF format. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'lishogi'
+
+api_instance = Lishogi::StudiesApi.new
+study_id = 'study_id_example' # String | The study ID (8 characters).
+opts = {
+  clocks: true, # Boolean | Include clock comments in the KIF moves, when available.  Example: `22   同　玉(51)   (00:02/00:00:13)` 
+  comments: true, # Boolean | Include analysis and annotator comments in the KIF moves, when available.  Example: `1   ３六歩(37)  * Good move  * 次に▲35歩で角道を遮る！  * [%csl P3d,P2b][%cal P3f3e]` 
+  variations: true # Boolean | Include non-mainline moves, when available.  Example: `7   ４八銀(39)  * [%cal P4h3g,P3g4f,P3f3e]` 
+}
+
+begin
+  # Export all chapters
+  result = api_instance.study_all_chapters_kif(study_id, opts)
+  p result
+rescue Lishogi::ApiError => e
+  puts "Error when calling StudiesApi->study_all_chapters_kif: #{e}"
+end
+```
+
+#### Using the study_all_chapters_kif_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> study_all_chapters_kif_with_http_info(study_id, opts)
+
+```ruby
+begin
+  # Export all chapters
+  data, status_code, headers = api_instance.study_all_chapters_kif_with_http_info(study_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue Lishogi::ApiError => e
+  puts "Error when calling StudiesApi->study_all_chapters_kif_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **study_id** | **String** | The study ID (8 characters). |  |
+| **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] |
+| **comments** | **Boolean** | Include analysis and annotator comments in the KIF moves, when available.  Example: &#x60;1   ３六歩(37)  * Good move  * 次に▲35歩で角道を遮る！  * [%csl P3d,P2b][%cal P3f3e]&#x60;  | [optional][default to true] |
+| **variations** | **Boolean** | Include non-mainline moves, when available.  Example: &#x60;7   ４八銀(39)  * [%cal P4h3g,P3g4f,P3f3e]&#x60;  | [optional][default to true] |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: text/plain
+
+
+## study_chapter_kif
+
+> Object study_chapter_kif(study_id, chapter_id, opts)
+
+Export one study chapter
+
+Download one study chapter in KIF format. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'lishogi'
+
+api_instance = Lishogi::StudiesApi.new
+study_id = 'study_id_example' # String | The study ID (8 characters).
+chapter_id = 'chapter_id_example' # String | The chapter ID (8 characters).
+opts = {
+  clocks: true, # Boolean | Include clock comments in the KIF moves, when available.  Example: `22   同　玉(51)   (00:02/00:00:13)` 
+  comments: true, # Boolean | Include analysis and annotator comments in the KIF moves, when available.  Example: `1   ３六歩(37)  * Good move  * 次に▲35歩で角道を遮る！  * [%csl P3d,P2b][%cal P3f3e]` 
+  variations: true # Boolean | Include non-mainline moves, when available.  Example: `7   ４八銀(39)  * [%cal P4h3g,P3g4f,P3f3e]` 
+}
+
+begin
+  # Export one study chapter
+  result = api_instance.study_chapter_kif(study_id, chapter_id, opts)
+  p result
+rescue Lishogi::ApiError => e
+  puts "Error when calling StudiesApi->study_chapter_kif: #{e}"
+end
+```
+
+#### Using the study_chapter_kif_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> study_chapter_kif_with_http_info(study_id, chapter_id, opts)
+
+```ruby
+begin
+  # Export one study chapter
+  data, status_code, headers = api_instance.study_chapter_kif_with_http_info(study_id, chapter_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue Lishogi::ApiError => e
+  puts "Error when calling StudiesApi->study_chapter_kif_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **study_id** | **String** | The study ID (8 characters). |  |
+| **chapter_id** | **String** | The chapter ID (8 characters). |  |
+| **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] |
+| **comments** | **Boolean** | Include analysis and annotator comments in the KIF moves, when available.  Example: &#x60;1   ３六歩(37)  * Good move  * 次に▲35歩で角道を遮る！  * [%csl P3d,P2b][%cal P3f3e]&#x60;  | [optional][default to true] |
+| **variations** | **Boolean** | Include non-mainline moves, when available.  Example: &#x60;7   ４八銀(39)  * [%cal P4h3g,P3g4f,P3f3e]&#x60;  | [optional][default to true] |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: text/plain
+
+
+## study_export_all_kif
+
+> Object study_export_all_kif(username, opts)
+
+Export all studies of a user
+
+Download all chapters of all studies of a user in KIF format.  If authenticated, then all public, unlisted, and private studies are included.  If not, only public, listed studies are included. 
+
+### 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::StudiesApi.new
+username = 'username_example' # String | The user whose studies we export
+opts = {
+  clocks: true, # Boolean | Include clock comments in the KIF moves, when available.  Example: `22   同　玉(51)   (00:02/00:00:13)` 
+  comments: true, # Boolean | Include analysis and annotator comments in the KIF moves, when available.  Example: `1   ３六歩(37)  * Good move  * 次に▲35歩で角道を遮る  * [%csl P3d,P2b][%cal P3f3e]` 
+  variations: true # Boolean | Include non-mainline moves, when available.  Example: `7   ４八銀(39)  * [%cal P4h3g,P3g4f,P3f3e]` 
+}
+
+begin
+  # Export all studies of a user
+  result = api_instance.study_export_all_kif(username, opts)
+  p result
+rescue Lishogi::ApiError => e
+  puts "Error when calling StudiesApi->study_export_all_kif: #{e}"
+end
+```
+
+#### Using the study_export_all_kif_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> study_export_all_kif_with_http_info(username, opts)
+
+```ruby
+begin
+  # Export all studies of a user
+  data, status_code, headers = api_instance.study_export_all_kif_with_http_info(username, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue Lishogi::ApiError => e
+  puts "Error when calling StudiesApi->study_export_all_kif_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **username** | **String** | The user whose studies we export |  |
+| **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] |
+| **comments** | **Boolean** | Include analysis and annotator comments in the KIF moves, when available.  Example: &#x60;1   ３六歩(37)  * Good move  * 次に▲35歩で角道を遮る  * [%csl P3d,P2b][%cal P3f3e]&#x60;  | [optional][default to true] |
+| **variations** | **Boolean** | Include non-mainline moves, when available.  Example: &#x60;7   ４八銀(39)  * [%cal P4h3g,P3g4f,P3f3e]&#x60;  | [optional][default to true] |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: text/plain
+