lishogi 0.1.0

data/lishogi.gemspec

@@ -0,0 +1,41 @@
+# -*- encoding: utf-8 -*-
+
+=begin
+#Lishogi.org API reference
+
+## Introduction Welcome to the reference for the Lishogi API! Lishogi is free/libre, open-source shogi server forked from lichess powered by volunteers and donations.  Currently this page is a work in progress, certain information here might be wrong and incorrect! Expect it to be done during 2022. - Get help in the [Lishogi Discord channel](https://discord.gg/YFtpMGg3rR) - [Contribute to this documentation on Github](https://github.com/WandererXII/lishogi/blob/master/public/doc/lishogi-api.yaml) - Check out [Lishogi widgets to embed in your website](https://lishogi.org/developers)  ## Endpoint All requests go to `https://lishogi.org` (unless otherwise specified).  ## Rate limiting All requests are rate limited using various strategies, to ensure the API remains responsive for everyone. Only make one request at a time. If you receive an HTTP response with a [429 status](https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#429), please wait a full minute before resuming API usage.  ## Streaming with ND-JSON Some API endpoints stream their responses as [Newline Delimited JSON a.k.a. **nd-json**](http://ndjson.org/), with one JSON object per line.  Here's a [JavaScript utility function (for lichess)](https://gist.github.com/ornicar/a097406810939cf7be1df8ea30e94f3e) to help reading NDJSON streamed responses. 
+
+The version of the OpenAPI document: 2.0.0
+Contact: contact@lishogi.org
+Generated by: https://openapi-generator.tech
+Generator version: 7.10.0
+
+=end
+
+$:.push File.expand_path("../lib", __FILE__)
+require "lishogi/version"
+
+Gem::Specification.new do |s|
+  s.name        = "lishogi"
+  s.version     = Lishogi::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["gemmaro"]
+  s.email       = ["gemmaro.dev@gmail.com"]
+  s.homepage    = "https://git.disroot.org/gemmaro/lishogi"
+  s.summary     = "Lishogi.org REST API client"
+  s.description = "# Introduction Welcome to the reference for the Lishogi API! Lishogi is free/libre, open-source shogi server forked from lichess powered by volunteers and donations.  Currently this page is a work in progress, certain information here might be wrong and incorrect! Expect it to be done during 2022. - Get help in the [Lishogi Discord channel](https://discord.gg/YFtpMGg3rR) - [Contribute to this documentation on Github](https://github.com/WandererXII/lishogi/blob/master/public/doc/lishogi-api.yaml) - Check out [Lishogi widgets to embed in your website](https://lishogi.org/developers)  ## Endpoint All requests go to `https://lishogi.org` (unless otherwise specified).  ## Rate limiting All requests are rate limited using various strategies, to ensure the API remains responsive for everyone. Only make one request at a time. If you receive an HTTP response with a [429 status](https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#429), please wait a full minute before resuming API usage.  ## Streaming with ND-JSON Some API endpoints stream their responses as [Newline Delimited JSON a.k.a. **nd-json**](http://ndjson.org/), with one JSON object per line.  Here's a [JavaScript utility function (for lichess)](https://gist.github.com/ornicar/a097406810939cf7be1df8ea30e94f3e) to help reading NDJSON streamed responses. "
+  s.license     = "AGPL-3.0-later"
+  s.required_ruby_version = ">=3.1"
+  s.metadata    = {}
+
+  s.add_runtime_dependency 'faraday', '>= 1.0.1', '< 3.0'
+  s.add_runtime_dependency 'faraday-multipart'
+  s.add_runtime_dependency 'marcel'
+
+  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+
+  s.files         = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end

data/manifest.scm

@@ -0,0 +1 @@
+(specifications->manifest (list "ruby@3.1" "ruby-faraday" "ruby-faraday-multipart" "ruby-marcel"))

data/manifest.scm~

@@ -0,0 +1 @@
+(specifications->manifest (list "ruby@3.1" "ruby-faraday"))

data/patch

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+require "yaml"
+spec = YAML.load($stdin)
+spec["components"]["schemas"]["Title"].delete("enum")
+YAML.dump(spec, $stdout)

data/patch~

@@ -0,0 +1 @@
+#!/usr/bin/env ruby

data/smoke

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+$LOAD_PATH << File.expand_path(File.join(__dir__, "lib"))
+require "lishogi"
+api = Lishogi::UsersApi.new
+pp api.api_user("gemmaro")

data/smoke~

@@ -0,0 +1,2 @@
+#!/usr/bin/ruby
+require ""

data/spec/api/account_api_spec.rb

@@ -0,0 +1,91 @@
+=begin
+#Lishogi.org API reference
+
+## Introduction Welcome to the reference for the Lishogi API! Lishogi is free/libre, open-source shogi server forked from lichess powered by volunteers and donations.  Currently this page is a work in progress, certain information here might be wrong and incorrect! Expect it to be done during 2022. - Get help in the [Lishogi Discord channel](https://discord.gg/YFtpMGg3rR) - [Contribute to this documentation on Github](https://github.com/WandererXII/lishogi/blob/master/public/doc/lishogi-api.yaml) - Check out [Lishogi widgets to embed in your website](https://lishogi.org/developers)  ## Endpoint All requests go to `https://lishogi.org` (unless otherwise specified).  ## Rate limiting All requests are rate limited using various strategies, to ensure the API remains responsive for everyone. Only make one request at a time. If you receive an HTTP response with a [429 status](https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#429), please wait a full minute before resuming API usage.  ## Streaming with ND-JSON Some API endpoints stream their responses as [Newline Delimited JSON a.k.a. **nd-json**](http://ndjson.org/), with one JSON object per line.  Here's a [JavaScript utility function (for lichess)](https://gist.github.com/ornicar/a097406810939cf7be1df8ea30e94f3e) to help reading NDJSON streamed responses. 
+
+The version of the OpenAPI document: 2.0.0
+Contact: contact@lishogi.org
+Generated by: https://openapi-generator.tech
+Generator version: 7.10.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Lishogi::AccountApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'AccountApi' do
+  before do
+    # run before each test
+    @api_instance = Lishogi::AccountApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of AccountApi' do
+    it 'should create an instance of AccountApi' do
+      expect(@api_instance).to be_instance_of(Lishogi::AccountApi)
+    end
+  end
+
+  # unit tests for 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> 
+  # @param [Hash] opts the optional parameters
+  # @return [Account200Response]
+  describe 'account test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for account_email
+  # Get my email address
+  # Read the email address of the logged in user. 
+  # @param [Hash] opts the optional parameters
+  # @return [AccountEmail200Response]
+  describe 'account_email test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for account_kid
+  # Get my kid mode status
+  # Read the kid mode status of the logged in user.  - <https://lishogi.org/account/kid> 
+  # @param [Hash] opts the optional parameters
+  # @return [AccountKid200Response]
+  describe 'account_kid test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for account_kid_post
+  # Set my kid mode status
+  # Set the kid mode status of the logged in user.  - <https://lishogi.org/account/kid> 
+  # @param v Kid mode status
+  # @param [Hash] opts the optional parameters
+  # @return [Ok]
+  describe 'account_kid_post test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for account_me
+  # Get my profile
+  # Public information about the logged in user. 
+  # @param [Hash] opts the optional parameters
+  # @return [UserExtended]
+  describe 'account_me test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/api/analysis_api_spec.rb

@@ -0,0 +1,49 @@
+=begin
+#Lishogi.org API reference
+
+## Introduction Welcome to the reference for the Lishogi API! Lishogi is free/libre, open-source shogi server forked from lichess powered by volunteers and donations.  Currently this page is a work in progress, certain information here might be wrong and incorrect! Expect it to be done during 2022. - Get help in the [Lishogi Discord channel](https://discord.gg/YFtpMGg3rR) - [Contribute to this documentation on Github](https://github.com/WandererXII/lishogi/blob/master/public/doc/lishogi-api.yaml) - Check out [Lishogi widgets to embed in your website](https://lishogi.org/developers)  ## Endpoint All requests go to `https://lishogi.org` (unless otherwise specified).  ## Rate limiting All requests are rate limited using various strategies, to ensure the API remains responsive for everyone. Only make one request at a time. If you receive an HTTP response with a [429 status](https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#429), please wait a full minute before resuming API usage.  ## Streaming with ND-JSON Some API endpoints stream their responses as [Newline Delimited JSON a.k.a. **nd-json**](http://ndjson.org/), with one JSON object per line.  Here's a [JavaScript utility function (for lichess)](https://gist.github.com/ornicar/a097406810939cf7be1df8ea30e94f3e) to help reading NDJSON streamed responses. 
+
+The version of the OpenAPI document: 2.0.0
+Contact: contact@lishogi.org
+Generated by: https://openapi-generator.tech
+Generator version: 7.10.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Lishogi::AnalysisApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'AnalysisApi' do
+  before do
+    # run before each test
+    @api_instance = Lishogi::AnalysisApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of AnalysisApi' do
+    it 'should create an instance of AnalysisApi' do
+      expect(@api_instance).to be_instance_of(Lishogi::AnalysisApi)
+    end
+  end
+
+  # unit tests for api_cloud_eval
+  # 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. 
+  # @param sfen SFEN of the position
+  # @param [Hash] opts the optional parameters
+  # @option opts [Float] :multi_pv Number of variations
+  # @option opts [VariantKey] :variant Variant
+  # @return [nil]
+  describe 'api_cloud_eval test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/api/arena_tournaments_api_spec.rb

@@ -0,0 +1,160 @@
+=begin
+#Lishogi.org API reference
+
+## Introduction Welcome to the reference for the Lishogi API! Lishogi is free/libre, open-source shogi server forked from lichess powered by volunteers and donations.  Currently this page is a work in progress, certain information here might be wrong and incorrect! Expect it to be done during 2022. - Get help in the [Lishogi Discord channel](https://discord.gg/YFtpMGg3rR) - [Contribute to this documentation on Github](https://github.com/WandererXII/lishogi/blob/master/public/doc/lishogi-api.yaml) - Check out [Lishogi widgets to embed in your website](https://lishogi.org/developers)  ## Endpoint All requests go to `https://lishogi.org` (unless otherwise specified).  ## Rate limiting All requests are rate limited using various strategies, to ensure the API remains responsive for everyone. Only make one request at a time. If you receive an HTTP response with a [429 status](https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#429), please wait a full minute before resuming API usage.  ## Streaming with ND-JSON Some API endpoints stream their responses as [Newline Delimited JSON a.k.a. **nd-json**](http://ndjson.org/), with one JSON object per line.  Here's a [JavaScript utility function (for lichess)](https://gist.github.com/ornicar/a097406810939cf7be1df8ea30e94f3e) to help reading NDJSON streamed responses. 
+
+The version of the OpenAPI document: 2.0.0
+Contact: contact@lishogi.org
+Generated by: https://openapi-generator.tech
+Generator version: 7.10.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Lishogi::ArenaTournamentsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'ArenaTournamentsApi' do
+  before do
+    # run before each test
+    @api_instance = Lishogi::ArenaTournamentsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of ArenaTournamentsApi' do
+    it 'should create an instance of ArenaTournamentsApi' do
+      expect(@api_instance).to be_instance_of(Lishogi::ArenaTournamentsApi)
+    end
+  end
+
+  # unit tests for api_team_arena
+  # 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). 
+  # @param team_id ID of the team
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :max How many tournaments to download.
+  # @return [Array<Object>]
+  describe 'api_team_arena test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for api_tournament
+  # Get current tournaments
+  # Get recently finished, ongoing, and upcoming tournaments.  This API is used to display the [Lishogi tournament schedule](https://lishogi.org/tournament). 
+  # @param [Hash] opts the optional parameters
+  # @return [ArenaTournaments]
+  describe 'api_tournament test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for api_tournament_post
+  # Create a new Arena tournament
+  # Create a public or private Arena tournament.  This endpoint mirrors the form on &lt;https://lishogi.org/tournament/new&gt;.  You can create up to 12 public tournaments per day, or 24 private tournaments.  A team battle can be created by specifying the &#x60;teambBattleByTeam&#x60; argument. 
+  # @param clock_time Clock initial time in minutes
+  # @param clock_increment Clock increment in seconds
+  # @param clock_byoyomi Clock byoyomi in seconds
+  # @param periods Clock periods for byoyomi
+  # @param minutes How long the tournament lasts, in minutes
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :name The tournament name. Leave empty to get a random Grandmaster name
+  # @option opts [Integer] :wait_minutes How long to wait before starting the tournament, from now, in minutes
+  # @option opts [Integer] :start_date Timestamp to start the tournament at a given date and time. Overrides the &#x60;waitMinutes&#x60; setting
+  # @option opts [VariantKey] :variant 
+  # @option opts [Boolean] :rated Games are rated and impact players ratings
+  # @option opts [String] :position Custom initial position (in SFEN) for all games of the tournament. Must be a legal shogi position. Only works with standard shogi, not variants.
+  # @option opts [Boolean] :berserkable Whether the players can use berserk
+  # @option opts [Boolean] :streakable After 2 wins, consecutive wins grant 4 points instead of 2.
+  # @option opts [Boolean] :has_chat Whether the players can discuss in a chat
+  # @option opts [String] :description Anything you want to tell players about the tournament
+  # @option opts [String] :password Make the tournament private, and restrict access with a password. You can also [generate user-specific entry codes](https://github.com/lishogi-org/api/tree/master/example/tournament-entry-code) based on this password. 
+  # @option opts [String] :team_battle_by_team Set the ID of a team you lead to create a team battle. The other teams can be added using the [team battle edit endpoint](#operation/apiTournamentTeamBattlePost). 
+  # @option opts [String] :conditions_team_member_team_id Restrict entry to members of a team.  The teamId is the last part of a team URL, e.g. &#x60;https://lishogi.org/team/shogi-is-hard&#x60; has teamId &#x3D; &#x60;shogi-is-hard&#x60;.  Leave empty to let everyone join the tournament.  Do not use this to create team battles, use &#x60;teamBattleByTeam&#x60; instead. 
+  # @option opts [Integer] :conditions_min_rating_rating Minimum rating to join. Leave empty to let everyone join the tournament.
+  # @option opts [Integer] :conditions_max_rating_rating Maximum rating to join. Based on best rating reached in the last 7 days. Leave empty to let everyone join the tournament.
+  # @option opts [Integer] :conditions_nb_rated_game_nb Minimum number of rated games required to join.
+  # @return [Object]
+  describe 'api_tournament_post test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for api_user_name_tournament_created
+  # Get tournaments created by a user
+  # Get all tournaments created by a given user.  Tournaments are sorted by reverse chronological order of start date (last starting first).  Tournaments are streamed as [ndjson](#section/Introduction/Streaming-with-ND-JSON). 
+  # @param username The user whose created tournaments to fetch
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :status Include tournaments in the given status: \&quot;Created\&quot; (10), \&quot;Started\&quot; (20), \&quot;Finished\&quot; (30)  You can add this parameter more than once to include tournaments in different statuses.   Example: &#x60;?status&#x3D;10&amp;status&#x3D;20&#x60; 
+  # @return [Object]
+  describe 'api_user_name_tournament_created test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for games_by_tournament
+  # Export games of an Arena tournament
+  # Download games of a tournament in KIF or [ndjson](#section/Introduction/Streaming-with-ND-JSON) format.  Games are sorted by reverse chronological order (most recent first).  The game stream is throttled, depending on who is making the request:   - Anonymous request: 20 games per second   - [OAuth2 authenticated](#section/Authentication) request: 30 games per second 
+  # @param id The tournament ID.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :player Only games of a particular player. Leave empty to fetch games of all players.
+  # @option opts [Boolean] :moves Include the KIF moves.
+  # @option opts [Boolean] :pgn_in_json Include the full KIF within the JSON response, in a &#x60;notation&#x60; field.
+  # @option opts [Boolean] :tags Include the KIF tags.
+  # @option opts [Boolean] :clocks Include clock comments in the KIF moves, when available.  Example: &#x60;22   同　玉(51)   (00:02/00:00:13)&#x60; 
+  # @option opts [Boolean] :evals Include analysis evaluation comments in the KIF, when available.  Example: &#x60;9   ７八銀(79)   * [%eval -1.48]&#x60; 
+  # @return [Object]
+  describe 'games_by_tournament test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for results_by_tournament
+  # Get results of an Arena tournament
+  # Players of an Arena tournament, with their score and performance, sorted by rank (best first).  **Players are streamed as [ndjson](#section/Introduction/Streaming-with-ND-JSON)**, i.e. one JSON object per line.  If called on an ongoing tournament, results can be inconsistent due to ranking changes while the players are being streamed. Use on finished tournaments for guaranteed consistency. 
+  # @param id The tournament ID.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :nb Max number of players to fetch
+  # @return [Object]
+  describe 'results_by_tournament test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for teams_by_tournament
+  # Get team standing of a team battle
+  # Teams of a team battle tournament, with top players, sorted by rank (best first). 
+  # @param id The tournament ID.
+  # @param [Hash] opts the optional parameters
+  # @return [Object]
+  describe 'teams_by_tournament test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for tournament
+  # Get info about an Arena tournament
+  # Get detailed info about recently finished, current, or upcoming tournament&#39;s duels, player standings, and other info. 
+  # @param id The tournament ID.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Float] :page Specify which page of player standings to view.
+  # @return [Object]
+  describe 'tournament test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/api/board_api_spec.rb

@@ -0,0 +1,154 @@
+=begin
+#Lishogi.org API reference
+
+## Introduction Welcome to the reference for the Lishogi API! Lishogi is free/libre, open-source shogi server forked from lichess powered by volunteers and donations.  Currently this page is a work in progress, certain information here might be wrong and incorrect! Expect it to be done during 2022. - Get help in the [Lishogi Discord channel](https://discord.gg/YFtpMGg3rR) - [Contribute to this documentation on Github](https://github.com/WandererXII/lishogi/blob/master/public/doc/lishogi-api.yaml) - Check out [Lishogi widgets to embed in your website](https://lishogi.org/developers)  ## Endpoint All requests go to `https://lishogi.org` (unless otherwise specified).  ## Rate limiting All requests are rate limited using various strategies, to ensure the API remains responsive for everyone. Only make one request at a time. If you receive an HTTP response with a [429 status](https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#429), please wait a full minute before resuming API usage.  ## Streaming with ND-JSON Some API endpoints stream their responses as [Newline Delimited JSON a.k.a. **nd-json**](http://ndjson.org/), with one JSON object per line.  Here's a [JavaScript utility function (for lichess)](https://gist.github.com/ornicar/a097406810939cf7be1df8ea30e94f3e) to help reading NDJSON streamed responses. 
+
+The version of the OpenAPI document: 2.0.0
+Contact: contact@lishogi.org
+Generated by: https://openapi-generator.tech
+Generator version: 7.10.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Lishogi::BoardApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'BoardApi' do
+  before do
+    # run before each test
+    @api_instance = Lishogi::BoardApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of BoardApi' do
+    it 'should create an instance of BoardApi' do
+      expect(@api_instance).to be_instance_of(Lishogi::BoardApi)
+    end
+  end
+
+  # unit tests for api_board_seek
+  # Create a seek
+  #    Create a public seek, to start a game with a random player.    ### Real-time seek    Specify the `time`, `increment`, `byoyomi` and `periods` clock values.  The response is streamed but doesn't contain any information.    **Keep the connection open to keep the seek active**.    If the client closes the connection, the seek is canceled. This way, if the client terminates, the user won't be paired in a game they wouldn't play.   When the seek is accepted, or expires, the server closes the connection.    **Make sure to also have an [Event stream](#operation/apiStreamEvent) open**, to be notified when a game starts.   We recommend opening the [Event stream](#operation/apiStreamEvent) first, then the seek stream. This way,   you won't miss the game event if the seek is accepted immediately.    ### Correspondence seek    Specify the `days` per turn value.  The response is not streamed, it immediately completes with the seek ID. The seek remains active on the server until it is joined by someone.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Boolean] :rated Whether the game is rated and impacts players ratings.
+  # @option opts [Float] :time Clock initial time in minutes. Required for real-time seeks.
+  # @option opts [Integer] :increment Clock increment in seconds. Required for real-time seeks.
+  # @option opts [Integer] :byoyomi Clock byoyomi in seconds. Required for real-time seeks.
+  # @option opts [Integer] :periods Clock periods for byoyomi in seconds. Required for real-time seeks.
+  # @option opts [Integer] :days Days per turn. Required for correspondence seeks.
+  # @option opts [VariantKey] :variant 
+  # @option opts [String] :color The color to play. Better left empty to automatically get a random color.
+  # @option opts [String] :rating_range The rating range of potential opponents. Better left empty. Example: 1500-1800 
+  # @return [nil]
+  describe 'api_board_seek test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for api_stream_event
+  # Stream incoming events
+  #    Stream the events reaching a lishogi user in real time as [ndjson](#section/Introduction/Streaming-with-ND-JSON).    Each line is a JSON object containing a `type` field. Possible values are:   - `gameStart` Start of a game   - `gameFinish` Completion of a game   - `challenge` A player sends you a challenge or you challenge someone   - `challengeDeclined` The opponent declines your challenge     When the stream opens, all current challenges and games are sent.
+  # @param [Hash] opts the optional parameters
+  # @return [ApiStreamEvent200Response]
+  describe 'api_stream_event test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for board_game_abort
+  # Abort a game
+  # Abort a game being played with the Board API. 
+  # @param game_id 
+  # @param [Hash] opts the optional parameters
+  # @return [Ok]
+  describe 'board_game_abort test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for board_game_chat_get
+  # Fetch the game chat
+  # Get the messages posted in the game chat 
+  # @param game_id 
+  # @param [Hash] opts the optional parameters
+  # @return [Object]
+  describe 'board_game_chat_get test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for board_game_chat_post
+  # Write in the chat
+  # Post a message to the player or spectator chat, in a game being played with the Board API. 
+  # @param game_id 
+  # @param room 
+  # @param text 
+  # @param [Hash] opts the optional parameters
+  # @return [Ok]
+  describe 'board_game_chat_post test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for board_game_move
+  # Make a Board move
+  # Make a move in a game being played with the Board API. 
+  # @param game_id 
+  # @param move The move to play, in USI format
+  # @param [Hash] opts the optional parameters
+  # @return [Ok]
+  describe 'board_game_move test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for board_game_resign
+  # Resign a game
+  # Resign a game being played with the Board API. 
+  # @param game_id 
+  # @param [Hash] opts the optional parameters
+  # @return [Ok]
+  describe 'board_game_resign test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for board_game_stream
+  # Stream Board game state
+  #  Stream the state of a game being played with the Board API, as [ndjson](#section/Introduction/Streaming-with-ND-JSON).  Use this endpoint to get updates about the game in real-time, with a single request.  Each line is a JSON object containing a `type` field. Possible values are:   - `gameFull` Full game data. All values are immutable, except for the `state` field.   - `gameState` Current state of the game. Immutable values not included. Sent when a move is played, or when the game ends.   - `chatLine` Chat message sent by a user in the `room` \"player\" or \"spectator\".    The first line is always of type `gameFull`.    The server closes the stream when the game ends, or if the game has already ended.
+  # @param game_id 
+  # @param [Hash] opts the optional parameters
+  # @return [BoardGameStream200Response]
+  describe 'board_game_stream test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for board_game_takeback
+  # Handle takeback offers
+  # Create/accept/decline takebacks. - `yes`: Propose a takeback, or accept the opponent's takeback offer. - `no`: Decline a takeback offer from the opponent. 
+  # @param game_id 
+  # @param accept 
+  # @param [Hash] opts the optional parameters
+  # @return [Ok]
+  describe 'board_game_takeback test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end