lishogi 0.1.0

data/docs/AccountApi.md

@@ -0,0 +1,345 @@
+# Lishogi::AccountApi
+
+All URIs are relative to *https://lishogi.org*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**account**](AccountApi.md#account) | **GET** /api/account/preferences | Get my preferences |
+| [**account_email**](AccountApi.md#account_email) | **GET** /api/account/email | Get my email address |
+| [**account_kid**](AccountApi.md#account_kid) | **GET** /api/account/kid | Get my kid mode status |
+| [**account_kid_post**](AccountApi.md#account_kid_post) | **POST** /api/account/kid | Set my kid mode status |
+| [**account_me**](AccountApi.md#account_me) | **GET** /api/account | Get my profile |
+
+
+## account
+
+> <Account200Response> account
+
+Get my preferences
+
+Read the preferences of the logged in user.  - <https://lishogi.org/account/preferences/game-display> - <https://github.com/WandererXII/lishogi/blob/master/modules/pref/src/main/Pref.scala> 
+
+### 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::AccountApi.new
+
+begin
+  # Get my preferences
+  result = api_instance.account
+  p result
+rescue Lishogi::ApiError => e
+  puts "Error when calling AccountApi->account: #{e}"
+end
+```
+
+#### Using the account_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Account200Response>, Integer, Hash)> account_with_http_info
+
+```ruby
+begin
+  # Get my preferences
+  data, status_code, headers = api_instance.account_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Account200Response>
+rescue Lishogi::ApiError => e
+  puts "Error when calling AccountApi->account_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Account200Response**](Account200Response.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## account_email
+
+> <AccountEmail200Response> account_email
+
+Get my email address
+
+Read the email address of the logged in user. 
+
+### 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::AccountApi.new
+
+begin
+  # Get my email address
+  result = api_instance.account_email
+  p result
+rescue Lishogi::ApiError => e
+  puts "Error when calling AccountApi->account_email: #{e}"
+end
+```
+
+#### Using the account_email_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AccountEmail200Response>, Integer, Hash)> account_email_with_http_info
+
+```ruby
+begin
+  # Get my email address
+  data, status_code, headers = api_instance.account_email_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AccountEmail200Response>
+rescue Lishogi::ApiError => e
+  puts "Error when calling AccountApi->account_email_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**AccountEmail200Response**](AccountEmail200Response.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## account_kid
+
+> <AccountKid200Response> account_kid
+
+Get my kid mode status
+
+Read the kid mode status of the logged in user.  - <https://lishogi.org/account/kid> 
+
+### 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::AccountApi.new
+
+begin
+  # Get my kid mode status
+  result = api_instance.account_kid
+  p result
+rescue Lishogi::ApiError => e
+  puts "Error when calling AccountApi->account_kid: #{e}"
+end
+```
+
+#### Using the account_kid_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AccountKid200Response>, Integer, Hash)> account_kid_with_http_info
+
+```ruby
+begin
+  # Get my kid mode status
+  data, status_code, headers = api_instance.account_kid_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AccountKid200Response>
+rescue Lishogi::ApiError => e
+  puts "Error when calling AccountApi->account_kid_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**AccountKid200Response**](AccountKid200Response.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## account_kid_post
+
+> <Ok> account_kid_post(v)
+
+Set my kid mode status
+
+Set the kid mode status of the logged in user.  - <https://lishogi.org/account/kid> 
+
+### 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::AccountApi.new
+v = true # Boolean | Kid mode status
+
+begin
+  # Set my kid mode status
+  result = api_instance.account_kid_post(v)
+  p result
+rescue Lishogi::ApiError => e
+  puts "Error when calling AccountApi->account_kid_post: #{e}"
+end
+```
+
+#### Using the account_kid_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Ok>, Integer, Hash)> account_kid_post_with_http_info(v)
+
+```ruby
+begin
+  # Set my kid mode status
+  data, status_code, headers = api_instance.account_kid_post_with_http_info(v)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Ok>
+rescue Lishogi::ApiError => e
+  puts "Error when calling AccountApi->account_kid_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **v** | **Boolean** | Kid mode status |  |
+
+### Return type
+
+[**Ok**](Ok.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## account_me
+
+> <UserExtended> account_me
+
+Get my profile
+
+Public information about the logged in user. 
+
+### 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::AccountApi.new
+
+begin
+  # Get my profile
+  result = api_instance.account_me
+  p result
+rescue Lishogi::ApiError => e
+  puts "Error when calling AccountApi->account_me: #{e}"
+end
+```
+
+#### Using the account_me_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<UserExtended>, Integer, Hash)> account_me_with_http_info
+
+```ruby
+begin
+  # Get my profile
+  data, status_code, headers = api_instance.account_me_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <UserExtended>
+rescue Lishogi::ApiError => e
+  puts "Error when calling AccountApi->account_me_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**UserExtended**](UserExtended.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/AccountEmail200Response.md

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

data/docs/AccountKid200Response.md

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

data/docs/AnalysisApi.md

@@ -0,0 +1,77 @@
+# Lishogi::AnalysisApi
+
+All URIs are relative to *https://lishogi.org*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**api_cloud_eval**](AnalysisApi.md#api_cloud_eval) | **GET** /api/cloud-eval | Get cloud evaluation of a position. |
+
+
+## api_cloud_eval
+
+> api_cloud_eval(sfen, opts)
+
+Get cloud evaluation of a position.
+
+Get the cached evaluation of a position, if available.  Opening positions have more chances of being available. There are about 500 thousand positions in the database.  Up to 5 variations may be available. Variants are supported. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'lishogi'
+
+api_instance = Lishogi::AnalysisApi.new
+sfen = 'rnbqkbnr/ppp1pppp/8/3pP3/8/8/PPPP1PPP/RNBQKBNR b KQkq - 0 2' # String | SFEN of the position
+opts = {
+  multi_pv: 8.14, # Float | Number of variations
+  variant: Lishogi::VariantKey::STANDARD # VariantKey | Variant
+}
+
+begin
+  # Get cloud evaluation of a position.
+  api_instance.api_cloud_eval(sfen, opts)
+rescue Lishogi::ApiError => e
+  puts "Error when calling AnalysisApi->api_cloud_eval: #{e}"
+end
+```
+
+#### Using the api_cloud_eval_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_cloud_eval_with_http_info(sfen, opts)
+
+```ruby
+begin
+  # Get cloud evaluation of a position.
+  data, status_code, headers = api_instance.api_cloud_eval_with_http_info(sfen, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Lishogi::ApiError => e
+  puts "Error when calling AnalysisApi->api_cloud_eval_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **sfen** | **String** | SFEN of the position |  |
+| **multi_pv** | **Float** | Number of variations | [optional][default to 1] |
+| **variant** | [**VariantKey**](.md) | Variant | [optional][default to &#39;standard&#39;] |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/ApiStreamEvent200Response.md

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

data/docs/ApiUsersStatus200ResponseInner.md

@@ -0,0 +1,30 @@
+# Lishogi::ApiUsersStatus200ResponseInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **title** | **String** |  | [optional] |
+| **online** | **Boolean** |  | [optional] |
+| **playing** | **Boolean** |  | [optional] |
+| **streaming** | **Boolean** |  | [optional] |
+| **patron** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'lishogi'
+
+instance = Lishogi::ApiUsersStatus200ResponseInner.new(
+  id: null,
+  name: null,
+  title: null,
+  online: null,
+  playing: null,
+  streaming: null,
+  patron: null
+)
+```
+

data/docs/ArenaTournaments.md

@@ -0,0 +1,22 @@
+# Lishogi::ArenaTournaments
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **created** | **Array<Object>** |  | [optional] |
+| **started** | **Array<Object>** |  | [optional] |
+| **finished** | **Array<Object>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'lishogi'
+
+instance = Lishogi::ArenaTournaments.new(
+  created: null,
+  started: null,
+  finished: null
+)
+```
+