lishogi 0.1.0

data/docs/TeamsApi.md

@@ -0,0 +1,702 @@
+# Lishogi::TeamsApi
+
+All URIs are relative to *https://lishogi.org*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**api_team_arena**](TeamsApi.md#api_team_arena) | **GET** /api/team/{teamId}/arena | Get team Arena tournaments |
+| [**team_all**](TeamsApi.md#team_all) | **GET** /api/team/all | Get popular teams |
+| [**team_id_join**](TeamsApi.md#team_id_join) | **POST** /team/{teamId}/join | Join a team |
+| [**team_id_kick_user_id**](TeamsApi.md#team_id_kick_user_id) | **POST** /team/{teamId}/kick/{userId} | Kick a user from your team |
+| [**team_id_pm_all**](TeamsApi.md#team_id_pm_all) | **POST** /team/{teamId}/pm-all | Message all members |
+| [**team_id_quit**](TeamsApi.md#team_id_quit) | **POST** /team/{teamId}/quit | Leave a team |
+| [**team_id_users**](TeamsApi.md#team_id_users) | **GET** /api/team/{teamId}/users | Get members of a team |
+| [**team_of_username**](TeamsApi.md#team_of_username) | **GET** /api/team/of/{username} | Teams of a player |
+| [**team_search**](TeamsApi.md#team_search) | **GET** /api/team/search | Search teams |
+| [**team_show**](TeamsApi.md#team_show) | **GET** /api/team/{teamId} | Get a single team |
+
+
+## api_team_arena
+
+> Array<Object> api_team_arena(team_id, opts)
+
+Get team Arena tournaments
+
+Get all Arena tournaments relevant to a team.  Tournaments are sorted by reverse chronological order of start date (last starting first).  Tournaments are streamed as [ndjson](#section/Introduction/Streaming-with-ND-JSON). 
+
+### Examples
+
+```ruby
+require 'time'
+require 'lishogi'
+
+api_instance = Lishogi::TeamsApi.new
+team_id = 'team_id_example' # String | ID of the team
+opts = {
+  max: 56 # Integer | How many tournaments to download.
+}
+
+begin
+  # Get team Arena tournaments
+  result = api_instance.api_team_arena(team_id, opts)
+  p result
+rescue Lishogi::ApiError => e
+  puts "Error when calling TeamsApi->api_team_arena: #{e}"
+end
+```
+
+#### Using the api_team_arena_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_team_arena_with_http_info(team_id, opts)
+
+```ruby
+begin
+  # Get team Arena tournaments
+  data, status_code, headers = api_instance.api_team_arena_with_http_info(team_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Array&lt;Object&gt;
+rescue Lishogi::ApiError => e
+  puts "Error when calling TeamsApi->api_team_arena_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **team_id** | **String** | ID of the team |  |
+| **max** | **Integer** | How many tournaments to download. | [optional][default to 100] |
+
+### Return type
+
+**Array&lt;Object&gt;**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## team_all
+
+> <TeamAll200Response> team_all(opts)
+
+Get popular teams
+
+Paginator of the most popular teams. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'lishogi'
+
+api_instance = Lishogi::TeamsApi.new
+opts = {
+  page: 1 # Float | 
+}
+
+begin
+  # Get popular teams
+  result = api_instance.team_all(opts)
+  p result
+rescue Lishogi::ApiError => e
+  puts "Error when calling TeamsApi->team_all: #{e}"
+end
+```
+
+#### Using the team_all_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<TeamAll200Response>, Integer, Hash)> team_all_with_http_info(opts)
+
+```ruby
+begin
+  # Get popular teams
+  data, status_code, headers = api_instance.team_all_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TeamAll200Response>
+rescue Lishogi::ApiError => e
+  puts "Error when calling TeamsApi->team_all_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **page** | **Float** |  | [optional][default to 1] |
+
+### Return type
+
+[**TeamAll200Response**](TeamAll200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## team_id_join
+
+> <Ok> team_id_join(team_id, opts)
+
+Join a team
+
+Join a team. If the team join policy requires a confirmation but the `message` parameter is not given, then the call fails with `403 Forbidden`. 
+
+### 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::TeamsApi.new
+team_id = 'shogi-is-hard' # String | 
+opts = {
+  message: 'message_example' # String | Optional request message, if the team requires one.
+}
+
+begin
+  # Join a team
+  result = api_instance.team_id_join(team_id, opts)
+  p result
+rescue Lishogi::ApiError => e
+  puts "Error when calling TeamsApi->team_id_join: #{e}"
+end
+```
+
+#### Using the team_id_join_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Ok>, Integer, Hash)> team_id_join_with_http_info(team_id, opts)
+
+```ruby
+begin
+  # Join a team
+  data, status_code, headers = api_instance.team_id_join_with_http_info(team_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Ok>
+rescue Lishogi::ApiError => e
+  puts "Error when calling TeamsApi->team_id_join_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **team_id** | **String** |  |  |
+| **message** | **String** | Optional request message, if the team requires one. | [optional] |
+
+### Return type
+
+[**Ok**](Ok.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: application/x-www-form-urlencoded
+- **Accept**: application/json
+
+
+## team_id_kick_user_id
+
+> <Ok> team_id_kick_user_id(team_id, user_id)
+
+Kick a user from your team
+
+Kick a member out of one of your teams. - <https://lishogi.org/team> 
+
+### 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::TeamsApi.new
+team_id = 'shogi-is-hard' # String | 
+user_id = 'yohaansethnathan' # String | 
+
+begin
+  # Kick a user from your team
+  result = api_instance.team_id_kick_user_id(team_id, user_id)
+  p result
+rescue Lishogi::ApiError => e
+  puts "Error when calling TeamsApi->team_id_kick_user_id: #{e}"
+end
+```
+
+#### Using the team_id_kick_user_id_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Ok>, Integer, Hash)> team_id_kick_user_id_with_http_info(team_id, user_id)
+
+```ruby
+begin
+  # Kick a user from your team
+  data, status_code, headers = api_instance.team_id_kick_user_id_with_http_info(team_id, user_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Ok>
+rescue Lishogi::ApiError => e
+  puts "Error when calling TeamsApi->team_id_kick_user_id_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **team_id** | **String** |  |  |
+| **user_id** | **String** |  |  |
+
+### Return type
+
+[**Ok**](Ok.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## team_id_pm_all
+
+> <Ok> team_id_pm_all(team_id, opts)
+
+Message all members
+
+Send a private message to all members of a team. You must own the team. 
+
+### 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::TeamsApi.new
+team_id = 'shogi-is-hard' # String | 
+opts = {
+  message: 'message_example' # String | The message to send to all your team members.
+}
+
+begin
+  # Message all members
+  result = api_instance.team_id_pm_all(team_id, opts)
+  p result
+rescue Lishogi::ApiError => e
+  puts "Error when calling TeamsApi->team_id_pm_all: #{e}"
+end
+```
+
+#### Using the team_id_pm_all_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Ok>, Integer, Hash)> team_id_pm_all_with_http_info(team_id, opts)
+
+```ruby
+begin
+  # Message all members
+  data, status_code, headers = api_instance.team_id_pm_all_with_http_info(team_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Ok>
+rescue Lishogi::ApiError => e
+  puts "Error when calling TeamsApi->team_id_pm_all_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **team_id** | **String** |  |  |
+| **message** | **String** | The message to send to all your team members. | [optional] |
+
+### Return type
+
+[**Ok**](Ok.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: application/x-www-form-urlencoded
+- **Accept**: application/json
+
+
+## team_id_quit
+
+> <Ok> team_id_quit(team_id)
+
+Leave a team
+
+Leave a team. - <https://lishogi.org/team> 
+
+### 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::TeamsApi.new
+team_id = 'shogi-is-hard' # String | 
+
+begin
+  # Leave a team
+  result = api_instance.team_id_quit(team_id)
+  p result
+rescue Lishogi::ApiError => e
+  puts "Error when calling TeamsApi->team_id_quit: #{e}"
+end
+```
+
+#### Using the team_id_quit_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Ok>, Integer, Hash)> team_id_quit_with_http_info(team_id)
+
+```ruby
+begin
+  # Leave a team
+  data, status_code, headers = api_instance.team_id_quit_with_http_info(team_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Ok>
+rescue Lishogi::ApiError => e
+  puts "Error when calling TeamsApi->team_id_quit_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **team_id** | **String** |  |  |
+
+### Return type
+
+[**Ok**](Ok.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### 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::TeamsApi.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 TeamsApi->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 TeamsApi->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
+
+
+## team_of_username
+
+> <Array<Team>> team_of_username(username)
+
+Teams of a player
+
+All the teams a player is a member of. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'lishogi'
+
+api_instance = Lishogi::TeamsApi.new
+username = 'wandererxii' # String | 
+
+begin
+  # Teams of a player
+  result = api_instance.team_of_username(username)
+  p result
+rescue Lishogi::ApiError => e
+  puts "Error when calling TeamsApi->team_of_username: #{e}"
+end
+```
+
+#### Using the team_of_username_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<Team>>, Integer, Hash)> team_of_username_with_http_info(username)
+
+```ruby
+begin
+  # Teams of a player
+  data, status_code, headers = api_instance.team_of_username_with_http_info(username)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<Team>>
+rescue Lishogi::ApiError => e
+  puts "Error when calling TeamsApi->team_of_username_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **username** | **String** |  |  |
+
+### Return type
+
+[**Array&lt;Team&gt;**](Team.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## team_search
+
+> <Array<Team>> team_search(opts)
+
+Search teams
+
+Paginator of team search results for a keyword. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'lishogi'
+
+api_instance = Lishogi::TeamsApi.new
+opts = {
+  text: 'shogi-is-hard', # String | 
+  page: 1 # Float | 
+}
+
+begin
+  # Search teams
+  result = api_instance.team_search(opts)
+  p result
+rescue Lishogi::ApiError => e
+  puts "Error when calling TeamsApi->team_search: #{e}"
+end
+```
+
+#### Using the team_search_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<Team>>, Integer, Hash)> team_search_with_http_info(opts)
+
+```ruby
+begin
+  # Search teams
+  data, status_code, headers = api_instance.team_search_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<Team>>
+rescue Lishogi::ApiError => e
+  puts "Error when calling TeamsApi->team_search_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **text** | **String** |  | [optional] |
+| **page** | **Float** |  | [optional][default to 1] |
+
+### Return type
+
+[**Array&lt;Team&gt;**](Team.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## team_show
+
+> <Team> team_show(team_id)
+
+Get a single team
+
+Infos about a team
+
+### Examples
+
+```ruby
+require 'time'
+require 'lishogi'
+
+api_instance = Lishogi::TeamsApi.new
+team_id = 'team_id_example' # String | 
+
+begin
+  # Get a single team
+  result = api_instance.team_show(team_id)
+  p result
+rescue Lishogi::ApiError => e
+  puts "Error when calling TeamsApi->team_show: #{e}"
+end
+```
+
+#### Using the team_show_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Team>, Integer, Hash)> team_show_with_http_info(team_id)
+
+```ruby
+begin
+  # Get a single team
+  data, status_code, headers = api_instance.team_show_with_http_info(team_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Team>
+rescue Lishogi::ApiError => e
+  puts "Error when calling TeamsApi->team_show_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **team_id** | **String** |  |  |
+
+### Return type
+
+[**Team**](Team.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/Title.md

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