lishogi 0.1.0

data/docs/UsersApi.md

@@ -0,0 +1,667 @@
+# Lishogi::UsersApi
+
+All URIs are relative to *https://lishogi.org*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**api_crosstable**](UsersApi.md#api_crosstable) | **GET** /api/crosstable/{user1}/{user2} | Get crosstable |
+| [**api_user**](UsersApi.md#api_user) | **GET** /api/user/{username} | Get user public data |
+| [**api_user_activity**](UsersApi.md#api_user_activity) | **GET** /api/user/{username}/activity | Get user activity |
+| [**api_user_rating_history**](UsersApi.md#api_user_rating_history) | **GET** /api/user/{username}/rating-history | Get rating history of a user |
+| [**api_users**](UsersApi.md#api_users) | **POST** /api/users | Get users by ID |
+| [**api_users_status**](UsersApi.md#api_users_status) | **GET** /api/users/status | Get real-time users status |
+| [**player**](UsersApi.md#player) | **GET** /player | Get all top 10 |
+| [**player_top_nb_perf_type**](UsersApi.md#player_top_nb_perf_type) | **GET** /player/top/{nb}/{perfType} | Get one leaderboard |
+| [**streamer_live**](UsersApi.md#streamer_live) | **GET** /streamer/live | Get live streamers |
+| [**team_id_users**](UsersApi.md#team_id_users) | **GET** /api/team/{teamId}/users | Get members of a team |
+
+
+## api_crosstable
+
+> Object api_crosstable(user1, user2, opts)
+
+Get crosstable
+
+Get total number of games, and current score, of any two users.  If the `matchup` flag is provided, and the users are currently playing, also gets the current match game number and scores. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'lishogi'
+
+api_instance = Lishogi::UsersApi.new
+user1 = 'user1_example' # String | 
+user2 = 'user2_example' # String | 
+opts = {
+  matchup: true # Boolean | Whether to get the current match data, if any
+}
+
+begin
+  # Get crosstable
+  result = api_instance.api_crosstable(user1, user2, opts)
+  p result
+rescue Lishogi::ApiError => e
+  puts "Error when calling UsersApi->api_crosstable: #{e}"
+end
+```
+
+#### Using the api_crosstable_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> api_crosstable_with_http_info(user1, user2, opts)
+
+```ruby
+begin
+  # Get crosstable
+  data, status_code, headers = api_instance.api_crosstable_with_http_info(user1, user2, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue Lishogi::ApiError => e
+  puts "Error when calling UsersApi->api_crosstable_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user1** | **String** |  |  |
+| **user2** | **String** |  |  |
+| **matchup** | **Boolean** | Whether to get the current match data, if any | [optional] |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## api_user
+
+> <UserExtended> api_user(username)
+
+Get user public data
+
+Read public data of a user. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'lishogi'
+
+api_instance = Lishogi::UsersApi.new
+username = 'username_example' # String | 
+
+begin
+  # Get user public data
+  result = api_instance.api_user(username)
+  p result
+rescue Lishogi::ApiError => e
+  puts "Error when calling UsersApi->api_user: #{e}"
+end
+```
+
+#### Using the api_user_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<UserExtended>, Integer, Hash)> api_user_with_http_info(username)
+
+```ruby
+begin
+  # Get user public data
+  data, status_code, headers = api_instance.api_user_with_http_info(username)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <UserExtended>
+rescue Lishogi::ApiError => e
+  puts "Error when calling UsersApi->api_user_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **username** | **String** |  |  |
+
+### Return type
+
+[**UserExtended**](UserExtended.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## api_user_activity
+
+> api_user_activity(username)
+
+Get user activity
+
+Read data to generate the activity feed of a user. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'lishogi'
+
+api_instance = Lishogi::UsersApi.new
+username = 'username_example' # String | 
+
+begin
+  # Get user activity
+  api_instance.api_user_activity(username)
+rescue Lishogi::ApiError => e
+  puts "Error when calling UsersApi->api_user_activity: #{e}"
+end
+```
+
+#### Using the api_user_activity_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_user_activity_with_http_info(username)
+
+```ruby
+begin
+  # Get user activity
+  data, status_code, headers = api_instance.api_user_activity_with_http_info(username)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Lishogi::ApiError => e
+  puts "Error when calling UsersApi->api_user_activity_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **username** | **String** |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## api_user_rating_history
+
+> Object api_user_rating_history(username)
+
+Get rating history of a user
+
+Read rating history of a user, for all perf types. There is at most one entry per day. Format of an entry is `[year, month, day, rating]`. `month` starts at zero (January). 
+
+### Examples
+
+```ruby
+require 'time'
+require 'lishogi'
+
+api_instance = Lishogi::UsersApi.new
+username = 'username_example' # String | 
+
+begin
+  # Get rating history of a user
+  result = api_instance.api_user_rating_history(username)
+  p result
+rescue Lishogi::ApiError => e
+  puts "Error when calling UsersApi->api_user_rating_history: #{e}"
+end
+```
+
+#### Using the api_user_rating_history_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> api_user_rating_history_with_http_info(username)
+
+```ruby
+begin
+  # Get rating history of a user
+  data, status_code, headers = api_instance.api_user_rating_history_with_http_info(username)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue Lishogi::ApiError => e
+  puts "Error when calling UsersApi->api_user_rating_history_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **username** | **String** |  |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## api_users
+
+> <Array<User>> api_users(body)
+
+Get users by ID
+
+Get up to 300 users by their IDs. Users are returned in the same order as the IDs.  The method is `POST` so a longer list of IDs can be sent in the request body. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'lishogi'
+
+api_instance = Lishogi::UsersApi.new
+body = 'yokoyamatomoki,shogi_harbour,yohaansethnathan' # String | User IDs separated by commas.
+
+begin
+  # Get users by ID
+  result = api_instance.api_users(body)
+  p result
+rescue Lishogi::ApiError => e
+  puts "Error when calling UsersApi->api_users: #{e}"
+end
+```
+
+#### Using the api_users_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<User>>, Integer, Hash)> api_users_with_http_info(body)
+
+```ruby
+begin
+  # Get users by ID
+  data, status_code, headers = api_instance.api_users_with_http_info(body)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<User>>
+rescue Lishogi::ApiError => e
+  puts "Error when calling UsersApi->api_users_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **body** | **String** | User IDs separated by commas. |  |
+
+### Return type
+
+[**Array&lt;User&gt;**](User.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: text/plain
+- **Accept**: application/json
+
+
+## api_users_status
+
+> <Array<ApiUsersStatus200ResponseInner>> api_users_status(ids, opts)
+
+Get real-time users status
+
+Read the `online`, `playing` and `streaming` flags of several users.  This API is very fast and cheap on lishogi side. So you can call it quite often (like once every 5 seconds).  Use it to track players and know when they're connected on lishogi and playing games. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'lishogi'
+
+api_instance = Lishogi::UsersApi.new
+ids = 'yokoyamatomoki,shogi_harbour,yohaansethnathan' # String | User IDs separated by commas. Up to 100 IDs.
+opts = {
+  with_game_ids: true # Boolean | Also return the ID of the game being played, if any, for each player, in a `playingId` field. Defaults to `false` to preserve server resources. 
+}
+
+begin
+  # Get real-time users status
+  result = api_instance.api_users_status(ids, opts)
+  p result
+rescue Lishogi::ApiError => e
+  puts "Error when calling UsersApi->api_users_status: #{e}"
+end
+```
+
+#### Using the api_users_status_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<ApiUsersStatus200ResponseInner>>, Integer, Hash)> api_users_status_with_http_info(ids, opts)
+
+```ruby
+begin
+  # Get real-time users status
+  data, status_code, headers = api_instance.api_users_status_with_http_info(ids, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<ApiUsersStatus200ResponseInner>>
+rescue Lishogi::ApiError => e
+  puts "Error when calling UsersApi->api_users_status_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ids** | **String** | User IDs separated by commas. Up to 100 IDs. |  |
+| **with_game_ids** | **Boolean** | Also return the ID of the game being played, if any, for each player, in a &#x60;playingId&#x60; field. Defaults to &#x60;false&#x60; to preserve server resources.  | [optional] |
+
+### Return type
+
+[**Array&lt;ApiUsersStatus200ResponseInner&gt;**](ApiUsersStatus200ResponseInner.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## player
+
+> Object player
+
+Get all top 10
+
+Get the top 10 players for each speed and variant.  See <https://lishogi.org/player>. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'lishogi'
+
+api_instance = Lishogi::UsersApi.new
+
+begin
+  # Get all top 10
+  result = api_instance.player
+  p result
+rescue Lishogi::ApiError => e
+  puts "Error when calling UsersApi->player: #{e}"
+end
+```
+
+#### Using the player_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> player_with_http_info
+
+```ruby
+begin
+  # Get all top 10
+  data, status_code, headers = api_instance.player_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue Lishogi::ApiError => e
+  puts "Error when calling UsersApi->player_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/vnd.lishogi.v3+json
+
+
+## player_top_nb_perf_type
+
+> Object player_top_nb_perf_type(nb, perf_type)
+
+Get one leaderboard
+
+Get the leaderboard for a single speed or variant (a.k.a. `perfType`). There is no leaderboard for correspondence or puzzles.  See <https://lishogi.org/player/top/200/bullet>. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'lishogi'
+
+api_instance = Lishogi::UsersApi.new
+nb = 100 # Integer | How many users to fetch
+perf_type = 'ultraBullet' # String | The speed or variant
+
+begin
+  # Get one leaderboard
+  result = api_instance.player_top_nb_perf_type(nb, perf_type)
+  p result
+rescue Lishogi::ApiError => e
+  puts "Error when calling UsersApi->player_top_nb_perf_type: #{e}"
+end
+```
+
+#### Using the player_top_nb_perf_type_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> player_top_nb_perf_type_with_http_info(nb, perf_type)
+
+```ruby
+begin
+  # Get one leaderboard
+  data, status_code, headers = api_instance.player_top_nb_perf_type_with_http_info(nb, perf_type)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue Lishogi::ApiError => e
+  puts "Error when calling UsersApi->player_top_nb_perf_type_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **nb** | **Integer** | How many users to fetch |  |
+| **perf_type** | **String** | The speed or variant |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/vnd.lishogi.v3+json
+
+
+## streamer_live
+
+> <Array<LightUser>> streamer_live
+
+Get live streamers
+
+Get basic info about currently streaming users.  This API is very fast and cheap on lishogi side. So you can call it quite often (like once every 5 seconds). 
+
+### Examples
+
+```ruby
+require 'time'
+require 'lishogi'
+
+api_instance = Lishogi::UsersApi.new
+
+begin
+  # Get live streamers
+  result = api_instance.streamer_live
+  p result
+rescue Lishogi::ApiError => e
+  puts "Error when calling UsersApi->streamer_live: #{e}"
+end
+```
+
+#### Using the streamer_live_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<LightUser>>, Integer, Hash)> streamer_live_with_http_info
+
+```ruby
+begin
+  # Get live streamers
+  data, status_code, headers = api_instance.streamer_live_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<LightUser>>
+rescue Lishogi::ApiError => e
+  puts "Error when calling UsersApi->streamer_live_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array&lt;LightUser&gt;**](LightUser.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## team_id_users
+
+> <UserExtended> team_id_users(team_id)
+
+Get members of a team
+
+Members are sorted by reverse chronological order of joining the team (most recent first). OAuth only required if the list of members is private.  Members are streamed as [ndjson](#section/Introduction/Streaming-with-ND-JSON). 
+
+### 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::UsersApi.new
+team_id = 'shogi-is-hard' # String | 
+
+begin
+  # Get members of a team
+  result = api_instance.team_id_users(team_id)
+  p result
+rescue Lishogi::ApiError => e
+  puts "Error when calling UsersApi->team_id_users: #{e}"
+end
+```
+
+#### Using the team_id_users_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<UserExtended>, Integer, Hash)> team_id_users_with_http_info(team_id)
+
+```ruby
+begin
+  # Get members of a team
+  data, status_code, headers = api_instance.team_id_users_with_http_info(team_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <UserExtended>
+rescue Lishogi::ApiError => e
+  puts "Error when calling UsersApi->team_id_users_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **team_id** | **String** |  |  |
+
+### Return type
+
+[**UserExtended**](UserExtended.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/x-ndjson
+

data/docs/Variant.md

@@ -0,0 +1,22 @@
+# Lishogi::Variant
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **key** | [**VariantKey**](VariantKey.md) |  | [optional][default to 'standard'] |
+| **name** | **String** |  | [optional] |
+| **short** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'lishogi'
+
+instance = Lishogi::Variant.new(
+  key: null,
+  name: null,
+  short: null
+)
+```
+

data/docs/VariantKey.md

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