lishogi 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/Gemfile +9 -0
- data/LICENSE +661 -0
- data/LICENSE~ +1 -0
- data/Makefile +39 -0
- data/Makefile~ +7 -0
- data/README.md +276 -0
- data/Rakefile +10 -0
- data/docs/Account200Response.md +20 -0
- data/docs/AccountApi.md +345 -0
- data/docs/AccountEmail200Response.md +18 -0
- data/docs/AccountKid200Response.md +18 -0
- data/docs/AnalysisApi.md +77 -0
- data/docs/ApiStreamEvent200Response.md +53 -0
- data/docs/ApiUsersStatus200ResponseInner.md +30 -0
- data/docs/ArenaTournaments.md +22 -0
- data/docs/ArenaTournamentsApi.md +601 -0
- data/docs/BoardApi.md +659 -0
- data/docs/BoardGameStream200Response.md +51 -0
- data/docs/BoardGameTakebackAcceptParameter.md +15 -0
- data/docs/BotApi.md +634 -0
- data/docs/ChallengeDeclinedEvent.md +20 -0
- data/docs/ChallengeEvent.md +20 -0
- data/docs/ChallengeJson.md +42 -0
- data/docs/ChallengeJsonPerf.md +20 -0
- data/docs/ChallengeJsonTimeControl.md +51 -0
- data/docs/ChallengeJsonTimeControlOneOf.md +28 -0
- data/docs/ChallengeJsonTimeControlOneOf1.md +20 -0
- data/docs/ChallengeJsonTimeControlOneOf2.md +18 -0
- data/docs/ChallengeUser.md +30 -0
- data/docs/ChallengesApi.md +414 -0
- data/docs/ChatLineEvent.md +24 -0
- data/docs/Clock.md +24 -0
- data/docs/Count.md +38 -0
- data/docs/Error.md +18 -0
- data/docs/GameEventInfo.md +22 -0
- data/docs/GameEventInfoCompat.md +20 -0
- data/docs/GameEventPlayer.md +28 -0
- data/docs/GameFinishEvent.md +20 -0
- data/docs/GameFullEvent.md +42 -0
- data/docs/GameFullEventPerf.md +18 -0
- data/docs/GameJson.md +50 -0
- data/docs/GameJsonAnalysisInner.md +24 -0
- data/docs/GameJsonAnalysisInnerJudgment.md +20 -0
- data/docs/GameJsonClock.md +26 -0
- data/docs/GameJsonPlayers.md +20 -0
- data/docs/GameStartEvent.md +20 -0
- data/docs/GameStateEvent.md +38 -0
- data/docs/GameStatus.md +15 -0
- data/docs/GameUser.md +32 -0
- data/docs/GameUserAnalysis.md +24 -0
- data/docs/GamesApi.md +473 -0
- data/docs/LightUser.md +24 -0
- data/docs/LightUserTitle.md +49 -0
- data/docs/MessagingApi.md +79 -0
- data/docs/Move.md +28 -0
- data/docs/NotFound.md +18 -0
- data/docs/OAuthError.md +20 -0
- data/docs/Ok.md +18 -0
- data/docs/Perf.md +26 -0
- data/docs/PerfType.md +15 -0
- data/docs/Perfs.md +30 -0
- data/docs/PlayTime.md +20 -0
- data/docs/Profile.md +28 -0
- data/docs/PuzzleRoundJson.md +24 -0
- data/docs/PuzzlesApi.md +211 -0
- data/docs/SimulsApi.md +69 -0
- data/docs/Speed.md +15 -0
- data/docs/StudiesApi.md +233 -0
- data/docs/TVApi.md +208 -0
- data/docs/Team.md +32 -0
- data/docs/TeamAll200Response.md +30 -0
- data/docs/TeamRequest.md +24 -0
- data/docs/TeamRequestWithUser.md +20 -0
- data/docs/TeamsApi.md +702 -0
- data/docs/Title.md +15 -0
- data/docs/User.md +42 -0
- data/docs/UserExtended.md +60 -0
- data/docs/UserPreferences.md +72 -0
- data/docs/UsersApi.md +667 -0
- data/docs/Variant.md +22 -0
- data/docs/VariantKey.md +15 -0
- data/git_push.sh +57 -0
- data/lib/lishogi/api/account_api.rb +314 -0
- data/lib/lishogi/api/analysis_api.rb +92 -0
- data/lib/lishogi/api/arena_tournaments_api.rb +681 -0
- data/lib/lishogi/api/board_api.rb +685 -0
- data/lib/lishogi/api/bot_api.rb +608 -0
- data/lib/lishogi/api/challenges_api.rb +554 -0
- data/lib/lishogi/api/games_api.rb +514 -0
- data/lib/lishogi/api/messaging_api.rb +97 -0
- data/lib/lishogi/api/puzzles_api.rb +210 -0
- data/lib/lishogi/api/simuls_api.rb +79 -0
- data/lib/lishogi/api/studies_api.rb +244 -0
- data/lib/lishogi/api/teams_api.rb +678 -0
- data/lib/lishogi/api/tv_api.rb +222 -0
- data/lib/lishogi/api/users_api.rb +677 -0
- data/lib/lishogi/api_client.rb +437 -0
- data/lib/lishogi/api_error.rb +58 -0
- data/lib/lishogi/configuration.rb +392 -0
- data/lib/lishogi/models/account200_response.rb +223 -0
- data/lib/lishogi/models/account_email200_response.rb +214 -0
- data/lib/lishogi/models/account_kid200_response.rb +214 -0
- data/lib/lishogi/models/api_stream_event200_response.rb +107 -0
- data/lib/lishogi/models/api_users_status200_response_inner.rb +273 -0
- data/lib/lishogi/models/arena_tournaments.rb +238 -0
- data/lib/lishogi/models/board_game_stream200_response.rb +106 -0
- data/lib/lishogi/models/board_game_takeback_accept_parameter.rb +104 -0
- data/lib/lishogi/models/challenge_declined_event.rb +257 -0
- data/lib/lishogi/models/challenge_event.rb +257 -0
- data/lib/lishogi/models/challenge_json.rb +453 -0
- data/lib/lishogi/models/challenge_json_perf.rb +223 -0
- data/lib/lishogi/models/challenge_json_time_control.rb +106 -0
- data/lib/lishogi/models/challenge_json_time_control_one_of.rb +259 -0
- data/lib/lishogi/models/challenge_json_time_control_one_of1.rb +223 -0
- data/lib/lishogi/models/challenge_json_time_control_one_of2.rb +214 -0
- data/lib/lishogi/models/challenge_user.rb +275 -0
- data/lib/lishogi/models/chat_line_event.rb +315 -0
- data/lib/lishogi/models/clock.rb +242 -0
- data/lib/lishogi/models/count.rb +304 -0
- data/lib/lishogi/models/error.rb +215 -0
- data/lib/lishogi/models/game_event_info.rb +266 -0
- data/lib/lishogi/models/game_event_info_compat.rb +223 -0
- data/lib/lishogi/models/game_event_player.rb +260 -0
- data/lib/lishogi/models/game_finish_event.rb +257 -0
- data/lib/lishogi/models/game_full_event.rb +436 -0
- data/lib/lishogi/models/game_full_event_perf.rb +215 -0
- data/lib/lishogi/models/game_json.rb +457 -0
- data/lib/lishogi/models/game_json_analysis_inner.rb +251 -0
- data/lib/lishogi/models/game_json_analysis_inner_judgment.rb +258 -0
- data/lib/lishogi/models/game_json_clock.rb +250 -0
- data/lib/lishogi/models/game_json_players.rb +223 -0
- data/lib/lishogi/models/game_start_event.rb +257 -0
- data/lib/lishogi/models/game_state_event.rb +396 -0
- data/lib/lishogi/models/game_status.rb +52 -0
- data/lib/lishogi/models/game_user.rb +277 -0
- data/lib/lishogi/models/game_user_analysis.rb +269 -0
- data/lib/lishogi/models/light_user.rb +241 -0
- data/lib/lishogi/models/light_user_title.rb +105 -0
- data/lib/lishogi/models/move.rb +259 -0
- data/lib/lishogi/models/not_found.rb +214 -0
- data/lib/lishogi/models/o_auth_error.rb +225 -0
- data/lib/lishogi/models/ok.rb +214 -0
- data/lib/lishogi/models/perf.rb +250 -0
- data/lib/lishogi/models/perf_type.rb +49 -0
- data/lib/lishogi/models/perfs.rb +268 -0
- data/lib/lishogi/models/play_time.rb +223 -0
- data/lib/lishogi/models/profile.rb +259 -0
- data/lib/lishogi/models/puzzle_round_json.rb +241 -0
- data/lib/lishogi/models/speed.rb +44 -0
- data/lib/lishogi/models/team.rb +280 -0
- data/lib/lishogi/models/team_all200_response.rb +272 -0
- data/lib/lishogi/models/team_request.rb +241 -0
- data/lib/lishogi/models/team_request_with_user.rb +223 -0
- data/lib/lishogi/models/title.rb +64 -0
- data/lib/lishogi/models/user.rb +322 -0
- data/lib/lishogi/models/user_extended.rb +410 -0
- data/lib/lishogi/models/user_preferences.rb +515 -0
- data/lib/lishogi/models/variant.rb +256 -0
- data/lib/lishogi/models/variant_key.rb +44 -0
- data/lib/lishogi/version.rb +15 -0
- data/lib/lishogi.rb +112 -0
- data/lishogi-api.patched.yaml +5806 -0
- data/lishogi-api.yaml +5811 -0
- data/lishogi.gemspec +41 -0
- data/manifest.scm +1 -0
- data/manifest.scm~ +1 -0
- data/patch +5 -0
- data/patch~ +1 -0
- data/pkg/lishogi-0.1.0.gem +0 -0
- data/smoke +5 -0
- data/smoke~ +2 -0
- data/spec/api/account_api_spec.rb +91 -0
- data/spec/api/analysis_api_spec.rb +49 -0
- data/spec/api/arena_tournaments_api_spec.rb +160 -0
- data/spec/api/board_api_spec.rb +154 -0
- data/spec/api/bot_api_spec.rb +144 -0
- data/spec/api/challenges_api_spec.rb +123 -0
- data/spec/api/games_api_spec.rb +135 -0
- data/spec/api/messaging_api_spec.rb +48 -0
- data/spec/api/puzzles_api_spec.rb +70 -0
- data/spec/api/simuls_api_spec.rb +46 -0
- data/spec/api/studies_api_spec.rb +81 -0
- data/spec/api/teams_api_spec.rb +160 -0
- data/spec/api/tv_api_spec.rb +74 -0
- data/spec/api/users_api_spec.rb +157 -0
- data/spec/models/account200_response_spec.rb +42 -0
- data/spec/models/account_email200_response_spec.rb +36 -0
- data/spec/models/account_kid200_response_spec.rb +36 -0
- data/spec/models/api_stream_event200_response_spec.rb +32 -0
- data/spec/models/api_users_status200_response_inner_spec.rb +72 -0
- data/spec/models/arena_tournaments_spec.rb +48 -0
- data/spec/models/board_game_stream200_response_spec.rb +32 -0
- data/spec/models/board_game_takeback_accept_parameter_spec.rb +21 -0
- data/spec/models/challenge_declined_event_spec.rb +46 -0
- data/spec/models/challenge_event_spec.rb +46 -0
- data/spec/models/challenge_json_perf_spec.rb +42 -0
- data/spec/models/challenge_json_spec.rb +120 -0
- data/spec/models/challenge_json_time_control_one_of1_spec.rb +42 -0
- data/spec/models/challenge_json_time_control_one_of2_spec.rb +36 -0
- data/spec/models/challenge_json_time_control_one_of_spec.rb +66 -0
- data/spec/models/challenge_json_time_control_spec.rb +32 -0
- data/spec/models/challenge_user_spec.rb +72 -0
- data/spec/models/chat_line_event_spec.rb +62 -0
- data/spec/models/clock_spec.rb +54 -0
- data/spec/models/count_spec.rb +96 -0
- data/spec/models/error_spec.rb +36 -0
- data/spec/models/game_event_info_compat_spec.rb +42 -0
- data/spec/models/game_event_info_spec.rb +52 -0
- data/spec/models/game_event_player_spec.rb +66 -0
- data/spec/models/game_finish_event_spec.rb +46 -0
- data/spec/models/game_full_event_perf_spec.rb +36 -0
- data/spec/models/game_full_event_spec.rb +112 -0
- data/spec/models/game_json_analysis_inner_judgment_spec.rb +46 -0
- data/spec/models/game_json_analysis_inner_spec.rb +54 -0
- data/spec/models/game_json_clock_spec.rb +60 -0
- data/spec/models/game_json_players_spec.rb +42 -0
- data/spec/models/game_json_spec.rb +136 -0
- data/spec/models/game_start_event_spec.rb +46 -0
- data/spec/models/game_state_event_spec.rb +100 -0
- data/spec/models/game_status_spec.rb +30 -0
- data/spec/models/game_user_analysis_spec.rb +54 -0
- data/spec/models/game_user_spec.rb +78 -0
- data/spec/models/light_user_spec.rb +54 -0
- data/spec/models/light_user_title_spec.rb +32 -0
- data/spec/models/move_spec.rb +66 -0
- data/spec/models/not_found_spec.rb +36 -0
- data/spec/models/o_auth_error_spec.rb +42 -0
- data/spec/models/ok_spec.rb +36 -0
- data/spec/models/perf_spec.rb +60 -0
- data/spec/models/perf_type_spec.rb +30 -0
- data/spec/models/perfs_spec.rb +72 -0
- data/spec/models/play_time_spec.rb +42 -0
- data/spec/models/profile_spec.rb +66 -0
- data/spec/models/puzzle_round_json_spec.rb +54 -0
- data/spec/models/speed_spec.rb +30 -0
- data/spec/models/team_all200_response_spec.rb +72 -0
- data/spec/models/team_request_spec.rb +54 -0
- data/spec/models/team_request_with_user_spec.rb +42 -0
- data/spec/models/team_spec.rb +78 -0
- data/spec/models/title_spec.rb +30 -0
- data/spec/models/user_extended_spec.rb +162 -0
- data/spec/models/user_preferences_spec.rb +210 -0
- data/spec/models/user_spec.rb +108 -0
- data/spec/models/variant_key_spec.rb +30 -0
- data/spec/models/variant_spec.rb +48 -0
- data/spec/spec_helper.rb +111 -0
- metadata +446 -0
data/LICENSE~
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
https://www.gnu.org/licenses/agpl-3.0.txt
|
data/Makefile
ADDED
@@ -0,0 +1,39 @@
|
|
1
|
+
# Copyright (C) 2024 gemmaro
|
2
|
+
#
|
3
|
+
# This program is free software: you can redistribute it and/or modify it
|
4
|
+
# under the terms of the GNU Affero General Public License as published by the
|
5
|
+
# Free Software Foundation, either version 3 of the License, or (at your
|
6
|
+
# option) any later version.
|
7
|
+
#
|
8
|
+
# This program is distributed in the hope that it will be useful, but WITHOUT
|
9
|
+
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
10
|
+
# FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License
|
11
|
+
# for more details.
|
12
|
+
#
|
13
|
+
# You should have received a copy of the GNU Affero General Public License
|
14
|
+
# along with this program. If not, see <https://www.gnu.org/licenses/>.
|
15
|
+
|
16
|
+
OpenAPI-specification = https://lishogi1.org/assets/doc/lishogi-api.yaml
|
17
|
+
|
18
|
+
all: lishogi-api.patched.yaml
|
19
|
+
openapi-generator-cli generate \
|
20
|
+
--input-spec lishogi-api.patched.yaml \
|
21
|
+
--output . \
|
22
|
+
--generator-name ruby \
|
23
|
+
--additional-properties gemAuthor=gemmaro \
|
24
|
+
--additional-properties gemAuthorEmail=gemmaro.dev@gmail.com \
|
25
|
+
--additional-properties gemLicense=AGPL-3.0-later \
|
26
|
+
--additional-properties gemName=lishogi \
|
27
|
+
--additional-properties gemRequiredRubyVersion='>=3.1' \
|
28
|
+
--additional-properties gemSummary='Lishogi.org REST API client' \
|
29
|
+
--additional-properties gemVersion=0.1.0 \
|
30
|
+
--additional-properties gemHomepage='https://git.disroot.org/gemmaro/lishogi' \
|
31
|
+
--additional-properties library=faraday \
|
32
|
+
--additional-properties moduleName=Lishogi
|
33
|
+
.PHONY: all
|
34
|
+
|
35
|
+
lishogi-api.patched.yaml: lishogi-api.yaml
|
36
|
+
./patch < $< > $@
|
37
|
+
|
38
|
+
lishogi-api.yaml:
|
39
|
+
wget --output-document $@ ${OpenAPI-specification}
|
data/Makefile~
ADDED
data/README.md
ADDED
@@ -0,0 +1,276 @@
|
|
1
|
+
# lishogi
|
2
|
+
|
3
|
+
Lishogi - the Ruby gem for the Lishogi.org API reference
|
4
|
+
|
5
|
+
# Introduction
|
6
|
+
Welcome to the reference for the Lishogi API! Lishogi is free/libre,
|
7
|
+
open-source shogi server forked from lichess powered by volunteers and donations.
|
8
|
+
|
9
|
+
Currently this page is a work in progress, certain information here might be wrong and incorrect!
|
10
|
+
Expect it to be done during 2022.
|
11
|
+
- Get help in the [Lishogi Discord channel](https://discord.gg/YFtpMGg3rR)
|
12
|
+
- [Contribute to this documentation on Github](https://github.com/WandererXII/lishogi/blob/master/public/doc/lishogi-api.yaml)
|
13
|
+
- Check out [Lishogi widgets to embed in your website](https://lishogi.org/developers)
|
14
|
+
|
15
|
+
## Endpoint
|
16
|
+
All requests go to `https://lishogi.org` (unless otherwise specified).
|
17
|
+
|
18
|
+
## Rate limiting
|
19
|
+
All requests are rate limited using various strategies,
|
20
|
+
to ensure the API remains responsive for everyone.
|
21
|
+
Only make one request at a time.
|
22
|
+
If you receive an HTTP response with a [429 status](https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#429),
|
23
|
+
please wait a full minute before resuming API usage.
|
24
|
+
|
25
|
+
## Streaming with ND-JSON
|
26
|
+
Some API endpoints stream their responses as [Newline Delimited JSON a.k.a. **nd-json**](http://ndjson.org/), with one JSON object per line.
|
27
|
+
|
28
|
+
Here's a [JavaScript utility function (for lichess)](https://gist.github.com/ornicar/a097406810939cf7be1df8ea30e94f3e) to help reading NDJSON streamed responses.
|
29
|
+
|
30
|
+
|
31
|
+
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
32
|
+
|
33
|
+
- API version: 2.0.0
|
34
|
+
- Package version: 0.1.0
|
35
|
+
- Generator version: 7.10.0
|
36
|
+
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
37
|
+
For more information, please visit [https://lishogi.org/api](https://lishogi.org/api)
|
38
|
+
|
39
|
+
## Installation
|
40
|
+
|
41
|
+
### Build a gem
|
42
|
+
|
43
|
+
To build the Ruby code into a gem:
|
44
|
+
|
45
|
+
```shell
|
46
|
+
gem build lishogi.gemspec
|
47
|
+
```
|
48
|
+
|
49
|
+
Then either install the gem locally:
|
50
|
+
|
51
|
+
```shell
|
52
|
+
gem install ./lishogi-0.1.0.gem
|
53
|
+
```
|
54
|
+
|
55
|
+
(for development, run `gem install --dev ./lishogi-0.1.0.gem` to install the development dependencies)
|
56
|
+
|
57
|
+
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
58
|
+
|
59
|
+
Finally add this to the Gemfile:
|
60
|
+
|
61
|
+
gem 'lishogi', '~> 0.1.0'
|
62
|
+
|
63
|
+
### Install from Git
|
64
|
+
|
65
|
+
If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
|
66
|
+
|
67
|
+
gem 'lishogi', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
|
68
|
+
|
69
|
+
### Include the Ruby code directly
|
70
|
+
|
71
|
+
Include the Ruby code directly using `-I` as follows:
|
72
|
+
|
73
|
+
```shell
|
74
|
+
ruby -Ilib script.rb
|
75
|
+
```
|
76
|
+
|
77
|
+
## Getting Started
|
78
|
+
|
79
|
+
Please follow the [installation](#installation) procedure and then run the following code:
|
80
|
+
|
81
|
+
```ruby
|
82
|
+
# Load the gem
|
83
|
+
require 'lishogi'
|
84
|
+
|
85
|
+
# Setup authorization
|
86
|
+
Lishogi.configure do |config|
|
87
|
+
# Configure OAuth2 access token for authorization: OAuth2
|
88
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
89
|
+
# Configure a proc to get access tokens in lieu of the static access_token configuration
|
90
|
+
config.access_token_getter = -> { 'YOUR TOKEN GETTER PROC' }
|
91
|
+
# Configure faraday connection
|
92
|
+
config.configure_faraday_connection { |connection| 'YOUR CONNECTION CONFIG PROC' }
|
93
|
+
end
|
94
|
+
|
95
|
+
api_instance = Lishogi::AccountApi.new
|
96
|
+
|
97
|
+
begin
|
98
|
+
#Get my preferences
|
99
|
+
result = api_instance.account
|
100
|
+
p result
|
101
|
+
rescue Lishogi::ApiError => e
|
102
|
+
puts "Exception when calling AccountApi->account: #{e}"
|
103
|
+
end
|
104
|
+
|
105
|
+
```
|
106
|
+
|
107
|
+
## Documentation for API Endpoints
|
108
|
+
|
109
|
+
All URIs are relative to *https://lishogi.org*
|
110
|
+
|
111
|
+
Class | Method | HTTP request | Description
|
112
|
+
------------ | ------------- | ------------- | -------------
|
113
|
+
*Lishogi::AccountApi* | [**account**](docs/AccountApi.md#account) | **GET** /api/account/preferences | Get my preferences
|
114
|
+
*Lishogi::AccountApi* | [**account_email**](docs/AccountApi.md#account_email) | **GET** /api/account/email | Get my email address
|
115
|
+
*Lishogi::AccountApi* | [**account_kid**](docs/AccountApi.md#account_kid) | **GET** /api/account/kid | Get my kid mode status
|
116
|
+
*Lishogi::AccountApi* | [**account_kid_post**](docs/AccountApi.md#account_kid_post) | **POST** /api/account/kid | Set my kid mode status
|
117
|
+
*Lishogi::AccountApi* | [**account_me**](docs/AccountApi.md#account_me) | **GET** /api/account | Get my profile
|
118
|
+
*Lishogi::AnalysisApi* | [**api_cloud_eval**](docs/AnalysisApi.md#api_cloud_eval) | **GET** /api/cloud-eval | Get cloud evaluation of a position.
|
119
|
+
*Lishogi::ArenaTournamentsApi* | [**api_team_arena**](docs/ArenaTournamentsApi.md#api_team_arena) | **GET** /api/team/{teamId}/arena | Get team Arena tournaments
|
120
|
+
*Lishogi::ArenaTournamentsApi* | [**api_tournament**](docs/ArenaTournamentsApi.md#api_tournament) | **GET** /api/tournament | Get current tournaments
|
121
|
+
*Lishogi::ArenaTournamentsApi* | [**api_tournament_post**](docs/ArenaTournamentsApi.md#api_tournament_post) | **POST** /api/tournament | Create a new Arena tournament
|
122
|
+
*Lishogi::ArenaTournamentsApi* | [**api_user_name_tournament_created**](docs/ArenaTournamentsApi.md#api_user_name_tournament_created) | **GET** /api/user/{username}/tournament/created | Get tournaments created by a user
|
123
|
+
*Lishogi::ArenaTournamentsApi* | [**games_by_tournament**](docs/ArenaTournamentsApi.md#games_by_tournament) | **GET** /api/tournament/{id}/games | Export games of an Arena tournament
|
124
|
+
*Lishogi::ArenaTournamentsApi* | [**results_by_tournament**](docs/ArenaTournamentsApi.md#results_by_tournament) | **GET** /api/tournament/{id}/results | Get results of an Arena tournament
|
125
|
+
*Lishogi::ArenaTournamentsApi* | [**teams_by_tournament**](docs/ArenaTournamentsApi.md#teams_by_tournament) | **GET** /api/tournament/{id}/teams | Get team standing of a team battle
|
126
|
+
*Lishogi::ArenaTournamentsApi* | [**tournament**](docs/ArenaTournamentsApi.md#tournament) | **GET** /api/tournament/{id} | Get info about an Arena tournament
|
127
|
+
*Lishogi::BoardApi* | [**api_board_seek**](docs/BoardApi.md#api_board_seek) | **POST** /api/board/seek | Create a seek
|
128
|
+
*Lishogi::BoardApi* | [**api_stream_event**](docs/BoardApi.md#api_stream_event) | **GET** /api/stream/event | Stream incoming events
|
129
|
+
*Lishogi::BoardApi* | [**board_game_abort**](docs/BoardApi.md#board_game_abort) | **POST** /api/board/game/{gameId}/abort | Abort a game
|
130
|
+
*Lishogi::BoardApi* | [**board_game_chat_get**](docs/BoardApi.md#board_game_chat_get) | **GET** /api/board/game/{gameId}/chat | Fetch the game chat
|
131
|
+
*Lishogi::BoardApi* | [**board_game_chat_post**](docs/BoardApi.md#board_game_chat_post) | **POST** /api/board/game/{gameId}/chat | Write in the chat
|
132
|
+
*Lishogi::BoardApi* | [**board_game_move**](docs/BoardApi.md#board_game_move) | **POST** /api/board/game/{gameId}/move/{move} | Make a Board move
|
133
|
+
*Lishogi::BoardApi* | [**board_game_resign**](docs/BoardApi.md#board_game_resign) | **POST** /api/board/game/{gameId}/resign | Resign a game
|
134
|
+
*Lishogi::BoardApi* | [**board_game_stream**](docs/BoardApi.md#board_game_stream) | **GET** /api/board/game/stream/{gameId} | Stream Board game state
|
135
|
+
*Lishogi::BoardApi* | [**board_game_takeback**](docs/BoardApi.md#board_game_takeback) | **POST** /api/board/game/{gameId}/takeback/{accept} | Handle takeback offers
|
136
|
+
*Lishogi::BotApi* | [**api_bot_online**](docs/BotApi.md#api_bot_online) | **GET** /api/bot/online | Get online bots
|
137
|
+
*Lishogi::BotApi* | [**api_stream_event**](docs/BotApi.md#api_stream_event) | **GET** /api/stream/event | Stream incoming events
|
138
|
+
*Lishogi::BotApi* | [**bot_account_upgrade**](docs/BotApi.md#bot_account_upgrade) | **POST** /api/bot/account/upgrade | Upgrade to Bot account
|
139
|
+
*Lishogi::BotApi* | [**bot_game_abort**](docs/BotApi.md#bot_game_abort) | **POST** /api/bot/game/{gameId}/abort | Abort a game
|
140
|
+
*Lishogi::BotApi* | [**bot_game_chat**](docs/BotApi.md#bot_game_chat) | **POST** /api/bot/game/{gameId}/chat | Write in the chat
|
141
|
+
*Lishogi::BotApi* | [**bot_game_chat_get**](docs/BotApi.md#bot_game_chat_get) | **GET** /api/bot/game/{gameId}/chat | Fetch the game chat
|
142
|
+
*Lishogi::BotApi* | [**bot_game_move**](docs/BotApi.md#bot_game_move) | **POST** /api/bot/game/{gameId}/move/{move} | Make a Bot move
|
143
|
+
*Lishogi::BotApi* | [**bot_game_resign**](docs/BotApi.md#bot_game_resign) | **POST** /api/bot/game/{gameId}/resign | Resign a game
|
144
|
+
*Lishogi::BotApi* | [**bot_game_stream**](docs/BotApi.md#bot_game_stream) | **GET** /api/bot/game/stream/{gameId} | Stream Bot game state
|
145
|
+
*Lishogi::ChallengesApi* | [**challenge_accept**](docs/ChallengesApi.md#challenge_accept) | **POST** /api/challenge/{challengeId}/accept | Accept a challenge
|
146
|
+
*Lishogi::ChallengesApi* | [**challenge_ai**](docs/ChallengesApi.md#challenge_ai) | **POST** /api/challenge/ai | Challenge the AI
|
147
|
+
*Lishogi::ChallengesApi* | [**challenge_create**](docs/ChallengesApi.md#challenge_create) | **POST** /api/challenge/{username} | Create a challenge
|
148
|
+
*Lishogi::ChallengesApi* | [**challenge_decline**](docs/ChallengesApi.md#challenge_decline) | **POST** /api/challenge/{challengeId}/decline | Decline a challenge
|
149
|
+
*Lishogi::ChallengesApi* | [**challenge_open**](docs/ChallengesApi.md#challenge_open) | **POST** /api/challenge/open | Open-ended challenge
|
150
|
+
*Lishogi::GamesApi* | [**api_account_playing**](docs/GamesApi.md#api_account_playing) | **GET** /api/account/playing | Get my ongoing games
|
151
|
+
*Lishogi::GamesApi* | [**api_games_user**](docs/GamesApi.md#api_games_user) | **GET** /api/games/user/{username} | Export games of a user
|
152
|
+
*Lishogi::GamesApi* | [**api_user_current_game**](docs/GamesApi.md#api_user_current_game) | **GET** /api/user/{username}/current-game | Export ongoing game of a user
|
153
|
+
*Lishogi::GamesApi* | [**game_kif**](docs/GamesApi.md#game_kif) | **GET** /game/export/{gameId} | Export one game
|
154
|
+
*Lishogi::GamesApi* | [**games_by_users**](docs/GamesApi.md#games_by_users) | **POST** /api/stream/games-by-users | Stream games of users
|
155
|
+
*Lishogi::GamesApi* | [**stream_game**](docs/GamesApi.md#stream_game) | **GET** /api/stream/game/{id} | Stream moves of a game
|
156
|
+
*Lishogi::MessagingApi* | [**inbox_username**](docs/MessagingApi.md#inbox_username) | **POST** /inbox/{username} | Send a private message
|
157
|
+
*Lishogi::PuzzlesApi* | [**api_puzzle_activity**](docs/PuzzlesApi.md#api_puzzle_activity) | **GET** /api/puzzle/activity | Get your puzzle activity
|
158
|
+
*Lishogi::PuzzlesApi* | [**api_puzzle_daily**](docs/PuzzlesApi.md#api_puzzle_daily) | **GET** /api/puzzle/daily | Get the daily puzzle
|
159
|
+
*Lishogi::PuzzlesApi* | [**api_puzzle_dashboard**](docs/PuzzlesApi.md#api_puzzle_dashboard) | **GET** /api/puzzle/dashboard/{days} | Get your puzzle dashboard
|
160
|
+
*Lishogi::SimulsApi* | [**api_simul**](docs/SimulsApi.md#api_simul) | **GET** /api/simul | Get current simuls
|
161
|
+
*Lishogi::StudiesApi* | [**study_all_chapters_kif**](docs/StudiesApi.md#study_all_chapters_kif) | **GET** /api/study/{studyId}.kif | Export all chapters
|
162
|
+
*Lishogi::StudiesApi* | [**study_chapter_kif**](docs/StudiesApi.md#study_chapter_kif) | **GET** /study/{studyId}/{chapterId}.kif | Export one study chapter
|
163
|
+
*Lishogi::StudiesApi* | [**study_export_all_kif**](docs/StudiesApi.md#study_export_all_kif) | **GET** /study/by/{username}/export.kif | Export all studies of a user
|
164
|
+
*Lishogi::TVApi* | [**tv_channel_games**](docs/TVApi.md#tv_channel_games) | **GET** /api/tv/{channel} | Get best ongoing games of a TV channel
|
165
|
+
*Lishogi::TVApi* | [**tv_channels**](docs/TVApi.md#tv_channels) | **GET** /api/tv/channels | Get current TV games
|
166
|
+
*Lishogi::TVApi* | [**tv_feed**](docs/TVApi.md#tv_feed) | **GET** /api/tv/feed | Stream current TV game
|
167
|
+
*Lishogi::TeamsApi* | [**api_team_arena**](docs/TeamsApi.md#api_team_arena) | **GET** /api/team/{teamId}/arena | Get team Arena tournaments
|
168
|
+
*Lishogi::TeamsApi* | [**team_all**](docs/TeamsApi.md#team_all) | **GET** /api/team/all | Get popular teams
|
169
|
+
*Lishogi::TeamsApi* | [**team_id_join**](docs/TeamsApi.md#team_id_join) | **POST** /team/{teamId}/join | Join a team
|
170
|
+
*Lishogi::TeamsApi* | [**team_id_kick_user_id**](docs/TeamsApi.md#team_id_kick_user_id) | **POST** /team/{teamId}/kick/{userId} | Kick a user from your team
|
171
|
+
*Lishogi::TeamsApi* | [**team_id_pm_all**](docs/TeamsApi.md#team_id_pm_all) | **POST** /team/{teamId}/pm-all | Message all members
|
172
|
+
*Lishogi::TeamsApi* | [**team_id_quit**](docs/TeamsApi.md#team_id_quit) | **POST** /team/{teamId}/quit | Leave a team
|
173
|
+
*Lishogi::TeamsApi* | [**team_id_users**](docs/TeamsApi.md#team_id_users) | **GET** /api/team/{teamId}/users | Get members of a team
|
174
|
+
*Lishogi::TeamsApi* | [**team_of_username**](docs/TeamsApi.md#team_of_username) | **GET** /api/team/of/{username} | Teams of a player
|
175
|
+
*Lishogi::TeamsApi* | [**team_search**](docs/TeamsApi.md#team_search) | **GET** /api/team/search | Search teams
|
176
|
+
*Lishogi::TeamsApi* | [**team_show**](docs/TeamsApi.md#team_show) | **GET** /api/team/{teamId} | Get a single team
|
177
|
+
*Lishogi::UsersApi* | [**api_crosstable**](docs/UsersApi.md#api_crosstable) | **GET** /api/crosstable/{user1}/{user2} | Get crosstable
|
178
|
+
*Lishogi::UsersApi* | [**api_user**](docs/UsersApi.md#api_user) | **GET** /api/user/{username} | Get user public data
|
179
|
+
*Lishogi::UsersApi* | [**api_user_activity**](docs/UsersApi.md#api_user_activity) | **GET** /api/user/{username}/activity | Get user activity
|
180
|
+
*Lishogi::UsersApi* | [**api_user_rating_history**](docs/UsersApi.md#api_user_rating_history) | **GET** /api/user/{username}/rating-history | Get rating history of a user
|
181
|
+
*Lishogi::UsersApi* | [**api_users**](docs/UsersApi.md#api_users) | **POST** /api/users | Get users by ID
|
182
|
+
*Lishogi::UsersApi* | [**api_users_status**](docs/UsersApi.md#api_users_status) | **GET** /api/users/status | Get real-time users status
|
183
|
+
*Lishogi::UsersApi* | [**player**](docs/UsersApi.md#player) | **GET** /player | Get all top 10
|
184
|
+
*Lishogi::UsersApi* | [**player_top_nb_perf_type**](docs/UsersApi.md#player_top_nb_perf_type) | **GET** /player/top/{nb}/{perfType} | Get one leaderboard
|
185
|
+
*Lishogi::UsersApi* | [**streamer_live**](docs/UsersApi.md#streamer_live) | **GET** /streamer/live | Get live streamers
|
186
|
+
*Lishogi::UsersApi* | [**team_id_users**](docs/UsersApi.md#team_id_users) | **GET** /api/team/{teamId}/users | Get members of a team
|
187
|
+
|
188
|
+
|
189
|
+
## Documentation for Models
|
190
|
+
|
191
|
+
- [Lishogi::Account200Response](docs/Account200Response.md)
|
192
|
+
- [Lishogi::AccountEmail200Response](docs/AccountEmail200Response.md)
|
193
|
+
- [Lishogi::AccountKid200Response](docs/AccountKid200Response.md)
|
194
|
+
- [Lishogi::ApiStreamEvent200Response](docs/ApiStreamEvent200Response.md)
|
195
|
+
- [Lishogi::ApiUsersStatus200ResponseInner](docs/ApiUsersStatus200ResponseInner.md)
|
196
|
+
- [Lishogi::ArenaTournaments](docs/ArenaTournaments.md)
|
197
|
+
- [Lishogi::BoardGameStream200Response](docs/BoardGameStream200Response.md)
|
198
|
+
- [Lishogi::BoardGameTakebackAcceptParameter](docs/BoardGameTakebackAcceptParameter.md)
|
199
|
+
- [Lishogi::ChallengeDeclinedEvent](docs/ChallengeDeclinedEvent.md)
|
200
|
+
- [Lishogi::ChallengeEvent](docs/ChallengeEvent.md)
|
201
|
+
- [Lishogi::ChallengeJson](docs/ChallengeJson.md)
|
202
|
+
- [Lishogi::ChallengeJsonPerf](docs/ChallengeJsonPerf.md)
|
203
|
+
- [Lishogi::ChallengeJsonTimeControl](docs/ChallengeJsonTimeControl.md)
|
204
|
+
- [Lishogi::ChallengeJsonTimeControlOneOf](docs/ChallengeJsonTimeControlOneOf.md)
|
205
|
+
- [Lishogi::ChallengeJsonTimeControlOneOf1](docs/ChallengeJsonTimeControlOneOf1.md)
|
206
|
+
- [Lishogi::ChallengeJsonTimeControlOneOf2](docs/ChallengeJsonTimeControlOneOf2.md)
|
207
|
+
- [Lishogi::ChallengeUser](docs/ChallengeUser.md)
|
208
|
+
- [Lishogi::ChatLineEvent](docs/ChatLineEvent.md)
|
209
|
+
- [Lishogi::Clock](docs/Clock.md)
|
210
|
+
- [Lishogi::Count](docs/Count.md)
|
211
|
+
- [Lishogi::Error](docs/Error.md)
|
212
|
+
- [Lishogi::GameEventInfo](docs/GameEventInfo.md)
|
213
|
+
- [Lishogi::GameEventInfoCompat](docs/GameEventInfoCompat.md)
|
214
|
+
- [Lishogi::GameEventPlayer](docs/GameEventPlayer.md)
|
215
|
+
- [Lishogi::GameFinishEvent](docs/GameFinishEvent.md)
|
216
|
+
- [Lishogi::GameFullEvent](docs/GameFullEvent.md)
|
217
|
+
- [Lishogi::GameFullEventPerf](docs/GameFullEventPerf.md)
|
218
|
+
- [Lishogi::GameJson](docs/GameJson.md)
|
219
|
+
- [Lishogi::GameJsonAnalysisInner](docs/GameJsonAnalysisInner.md)
|
220
|
+
- [Lishogi::GameJsonAnalysisInnerJudgment](docs/GameJsonAnalysisInnerJudgment.md)
|
221
|
+
- [Lishogi::GameJsonClock](docs/GameJsonClock.md)
|
222
|
+
- [Lishogi::GameJsonPlayers](docs/GameJsonPlayers.md)
|
223
|
+
- [Lishogi::GameStartEvent](docs/GameStartEvent.md)
|
224
|
+
- [Lishogi::GameStateEvent](docs/GameStateEvent.md)
|
225
|
+
- [Lishogi::GameStatus](docs/GameStatus.md)
|
226
|
+
- [Lishogi::GameUser](docs/GameUser.md)
|
227
|
+
- [Lishogi::GameUserAnalysis](docs/GameUserAnalysis.md)
|
228
|
+
- [Lishogi::LightUser](docs/LightUser.md)
|
229
|
+
- [Lishogi::LightUserTitle](docs/LightUserTitle.md)
|
230
|
+
- [Lishogi::Move](docs/Move.md)
|
231
|
+
- [Lishogi::NotFound](docs/NotFound.md)
|
232
|
+
- [Lishogi::OAuthError](docs/OAuthError.md)
|
233
|
+
- [Lishogi::Ok](docs/Ok.md)
|
234
|
+
- [Lishogi::Perf](docs/Perf.md)
|
235
|
+
- [Lishogi::PerfType](docs/PerfType.md)
|
236
|
+
- [Lishogi::Perfs](docs/Perfs.md)
|
237
|
+
- [Lishogi::PlayTime](docs/PlayTime.md)
|
238
|
+
- [Lishogi::Profile](docs/Profile.md)
|
239
|
+
- [Lishogi::PuzzleRoundJson](docs/PuzzleRoundJson.md)
|
240
|
+
- [Lishogi::Speed](docs/Speed.md)
|
241
|
+
- [Lishogi::Team](docs/Team.md)
|
242
|
+
- [Lishogi::TeamAll200Response](docs/TeamAll200Response.md)
|
243
|
+
- [Lishogi::TeamRequest](docs/TeamRequest.md)
|
244
|
+
- [Lishogi::TeamRequestWithUser](docs/TeamRequestWithUser.md)
|
245
|
+
- [Lishogi::User](docs/User.md)
|
246
|
+
- [Lishogi::UserExtended](docs/UserExtended.md)
|
247
|
+
- [Lishogi::UserPreferences](docs/UserPreferences.md)
|
248
|
+
- [Lishogi::Variant](docs/Variant.md)
|
249
|
+
- [Lishogi::VariantKey](docs/VariantKey.md)
|
250
|
+
|
251
|
+
|
252
|
+
## Documentation for Authorization
|
253
|
+
|
254
|
+
|
255
|
+
Authentication schemes defined for the API:
|
256
|
+
### OAuth2
|
257
|
+
|
258
|
+
|
259
|
+
- **Type**: OAuth
|
260
|
+
- **Flow**: accessCode
|
261
|
+
- **Authorization URL**: https://lishogi.org/oauth
|
262
|
+
- **Scopes**:
|
263
|
+
- preference:read: Read your preferences
|
264
|
+
- preference:write: Write your preferences
|
265
|
+
- email:read: Read your email address
|
266
|
+
- challenge:read: Read incoming challenges
|
267
|
+
- challenge:write: Create, accept, decline challenges
|
268
|
+
- study:read: Read private studies
|
269
|
+
- study:write: Create, update and delete studies
|
270
|
+
- tournament:write: Create tournaments
|
271
|
+
- puzzle:read: Read puzzle activity
|
272
|
+
- team:write: Join, leave, and manage teams
|
273
|
+
- msg:write: Send private messages to other players
|
274
|
+
- board:play: Play with the Board API
|
275
|
+
- bot:play: Play with the Bot API. Only for [Bot accounts](#operation/botAccountUpgrade)
|
276
|
+
|
data/Rakefile
ADDED
@@ -0,0 +1,20 @@
|
|
1
|
+
# Lishogi::Account200Response
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **prefs** | [**UserPreferences**](UserPreferences.md) | | [optional] |
|
8
|
+
| **language** | **String** | | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'lishogi'
|
14
|
+
|
15
|
+
instance = Lishogi::Account200Response.new(
|
16
|
+
prefs: null,
|
17
|
+
language: en-GB
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|