lishogi 0.1.0

data/docs/TVApi.md

@@ -0,0 +1,208 @@
+# Lishogi::TVApi
+
+All URIs are relative to *https://lishogi.org*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**tv_channel_games**](TVApi.md#tv_channel_games) | **GET** /api/tv/{channel} | Get best ongoing games of a TV channel |
+| [**tv_channels**](TVApi.md#tv_channels) | **GET** /api/tv/channels | Get current TV games |
+| [**tv_feed**](TVApi.md#tv_feed) | **GET** /api/tv/feed | Stream current TV game |
+
+
+## tv_channel_games
+
+> Object tv_channel_games(channel, opts)
+
+Get best ongoing games of a TV channel
+
+Get a list of ongoing games for a given TV channel. Similar to [lishogi.org/games](https://lishogi.org/games).  Available in kifu or [ndjson](#section/Introduction/Streaming-with-ND-JSON) format, depending on the request Accept header. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'lishogi'
+
+api_instance = Lishogi::TVApi.new
+channel = 'channel_example' # String | The name of the channel in camel case.
+opts = {
+  nb: 8.14, # Float | Number of games to fetch.
+  moves: true, # Boolean | Include the KIF moves.
+  notation_in_json: true, # Boolean | Include the full KIF within the JSON response, in a `notation` field.
+  tags: true, # Boolean | Include the KIF tags.
+  clocks: true # Boolean | Include clock comments in the KIF moves, when available.  Example: `2. exd5 { [%clk 1:01:27] } e5 { [%clk 1:01:28] }` 
+}
+
+begin
+  # Get best ongoing games of a TV channel
+  result = api_instance.tv_channel_games(channel, opts)
+  p result
+rescue Lishogi::ApiError => e
+  puts "Error when calling TVApi->tv_channel_games: #{e}"
+end
+```
+
+#### Using the tv_channel_games_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> tv_channel_games_with_http_info(channel, opts)
+
+```ruby
+begin
+  # Get best ongoing games of a TV channel
+  data, status_code, headers = api_instance.tv_channel_games_with_http_info(channel, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue Lishogi::ApiError => e
+  puts "Error when calling TVApi->tv_channel_games_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **channel** | **String** | The name of the channel in camel case. |  |
+| **nb** | **Float** | Number of games to fetch. | [optional][default to 10] |
+| **moves** | **Boolean** | Include the KIF moves. | [optional][default to true] |
+| **notation_in_json** | **Boolean** | Include the full KIF within the JSON response, in a &#x60;notation&#x60; field. | [optional][default to false] |
+| **tags** | **Boolean** | Include the KIF tags. | [optional][default to true] |
+| **clocks** | **Boolean** | Include clock comments in the KIF moves, when available.  Example: &#x60;2. exd5 { [%clk 1:01:27] } e5 { [%clk 1:01:28] }&#x60;  | [optional][default to false] |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: text/plain, application/x-ndjson
+
+
+## tv_channels
+
+> Object tv_channels
+
+Get current TV games
+
+Get basic info about the best games being played for each speed and variant, but also computer games and bot games.  See [lishogi.org/tv](https://lishogi.org/tv). 
+
+### Examples
+
+```ruby
+require 'time'
+require 'lishogi'
+
+api_instance = Lishogi::TVApi.new
+
+begin
+  # Get current TV games
+  result = api_instance.tv_channels
+  p result
+rescue Lishogi::ApiError => e
+  puts "Error when calling TVApi->tv_channels: #{e}"
+end
+```
+
+#### Using the tv_channels_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> tv_channels_with_http_info
+
+```ruby
+begin
+  # Get current TV games
+  data, status_code, headers = api_instance.tv_channels_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue Lishogi::ApiError => e
+  puts "Error when calling TVApi->tv_channels_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/json
+
+
+## tv_feed
+
+> Object tv_feed
+
+Stream current TV game
+
+Stream positions and moves of the current [TV game](https://lishogi.org/tv) in [ndjson](#section/Introduction/Streaming-with-ND-JSON). A summary of the game is sent as a first message, and when the featured game changes.  Try it with `curl https://lishogi.org/api/tv/feed`. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'lishogi'
+
+api_instance = Lishogi::TVApi.new
+
+begin
+  # Stream current TV game
+  result = api_instance.tv_feed
+  p result
+rescue Lishogi::ApiError => e
+  puts "Error when calling TVApi->tv_feed: #{e}"
+end
+```
+
+#### Using the tv_feed_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> tv_feed_with_http_info
+
+```ruby
+begin
+  # Stream current TV game
+  data, status_code, headers = api_instance.tv_feed_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue Lishogi::ApiError => e
+  puts "Error when calling TVApi->tv_feed_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
+

data/docs/Team.md

@@ -0,0 +1,32 @@
+# Lishogi::Team
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **description** | **String** |  | [optional] |
+| **open** | **Boolean** |  | [optional] |
+| **leader** | [**LightUser**](LightUser.md) |  | [optional] |
+| **leaders** | [**Array<LightUser>**](LightUser.md) |  | [optional] |
+| **nb_members** | **Integer** |  | [optional] |
+| **location** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'lishogi'
+
+instance = Lishogi::Team.new(
+  id: shogi-is-hard,
+  name: Shogi is hard,
+  description: For beginners like me, Shogi can be hard so I made this team so we can all help each other get through the first steps of playing. Shoutout to @jiroro for getting #1 in the wolverine team battle and representing our team! I'm also looking for possible team leaders. DM me if you want to become a team mod/leader.,
+  open: true,
+  leader: null,
+  leaders: null,
+  nb_members: 3129,
+  location: Anywhere
+)
+```
+

data/docs/TeamAll200Response.md

@@ -0,0 +1,30 @@
+# Lishogi::TeamAll200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **current_page** | **Float** |  | [optional] |
+| **max_per_page** | **Float** |  | [optional] |
+| **current_page_results** | [**Array<Team>**](Team.md) |  | [optional] |
+| **nb_results** | **Float** |  | [optional] |
+| **previous_page** | **Float** |  | [optional] |
+| **next_page** | **Float** |  | [optional] |
+| **nb_pages** | **Float** |  | [optional] |
+
+## Example
+
+```ruby
+require 'lishogi'
+
+instance = Lishogi::TeamAll200Response.new(
+  current_page: 4,
+  max_per_page: 15,
+  current_page_results: null,
+  nb_results: 205194,
+  previous_page: 3,
+  next_page: 5,
+  nb_pages: 13680
+)
+```
+

data/docs/TeamRequest.md

@@ -0,0 +1,24 @@
+# Lishogi::TeamRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **team_id** | **String** |  | [optional] |
+| **user_id** | **String** |  | [optional] |
+| **date** | **Float** |  | [optional] |
+| **message** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'lishogi'
+
+instance = Lishogi::TeamRequest.new(
+  team_id: shogi-is-hard,
+  user_id: YoGazeFish,
+  date: 1514505150384,
+  message: Hello, I would like to join the team!
+)
+```
+

data/docs/TeamRequestWithUser.md

@@ -0,0 +1,20 @@
+# Lishogi::TeamRequestWithUser
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **request** | [**TeamRequest**](TeamRequest.md) |  | [optional] |
+| **user** | [**User**](User.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'lishogi'
+
+instance = Lishogi::TeamRequestWithUser.new(
+  request: null,
+  user: null
+)
+```
+