lishogi 0.1.0

data/lib/lishogi/api/tv_api.rb

@@ -0,0 +1,222 @@
+=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 'cgi'
+
+module Lishogi
+  class TVApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # 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. 
+    # @param channel [String] The name of the channel in camel case.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Float] :nb Number of games to fetch. (default to 10)
+    # @option opts [Boolean] :moves Include the KIF moves. (default to true)
+    # @option opts [Boolean] :notation_in_json Include the full KIF within the JSON response, in a `notation` field. (default to false)
+    # @option opts [Boolean] :tags Include the KIF tags. (default to true)
+    # @option opts [Boolean] :clocks Include clock comments in the KIF moves, when available.  Example: `2. exd5 { [%clk 1:01:27] } e5 { [%clk 1:01:28] }`  (default to false)
+    # @return [Object]
+    def tv_channel_games(channel, opts = {})
+      data, _status_code, _headers = tv_channel_games_with_http_info(channel, opts)
+      data
+    end
+
+    # 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. 
+    # @param channel [String] The name of the channel in camel case.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Float] :nb Number of games to fetch. (default to 10)
+    # @option opts [Boolean] :moves Include the KIF moves. (default to true)
+    # @option opts [Boolean] :notation_in_json Include the full KIF within the JSON response, in a `notation` field. (default to false)
+    # @option opts [Boolean] :tags Include the KIF tags. (default to true)
+    # @option opts [Boolean] :clocks Include clock comments in the KIF moves, when available.  Example: `2. exd5 { [%clk 1:01:27] } e5 { [%clk 1:01:28] }`  (default to false)
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def tv_channel_games_with_http_info(channel, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: TVApi.tv_channel_games ...'
+      end
+      # verify the required parameter 'channel' is set
+      if @api_client.config.client_side_validation && channel.nil?
+        fail ArgumentError, "Missing the required parameter 'channel' when calling TVApi.tv_channel_games"
+      end
+      if @api_client.config.client_side_validation && !opts[:'nb'].nil? && opts[:'nb'] > 30
+        fail ArgumentError, 'invalid value for "opts[:"nb"]" when calling TVApi.tv_channel_games, must be smaller than or equal to 30.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'nb'].nil? && opts[:'nb'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"nb"]" when calling TVApi.tv_channel_games, must be greater than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/api/tv/{channel}'.sub('{' + 'channel' + '}', CGI.escape(channel.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'nb'] = opts[:'nb'] if !opts[:'nb'].nil?
+      query_params[:'moves'] = opts[:'moves'] if !opts[:'moves'].nil?
+      query_params[:'notationInJson'] = opts[:'notation_in_json'] if !opts[:'notation_in_json'].nil?
+      query_params[:'tags'] = opts[:'tags'] if !opts[:'tags'].nil?
+      query_params[:'clocks'] = opts[:'clocks'] if !opts[:'clocks'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/x-ndjson']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"TVApi.tv_channel_games",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: TVApi#tv_channel_games\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # 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). 
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def tv_channels(opts = {})
+      data, _status_code, _headers = tv_channels_with_http_info(opts)
+      data
+    end
+
+    # 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). 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def tv_channels_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: TVApi.tv_channels ...'
+      end
+      # resource path
+      local_var_path = '/api/tv/channels'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"TVApi.tv_channels",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: TVApi#tv_channels\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # 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`. 
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def tv_feed(opts = {})
+      data, _status_code, _headers = tv_feed_with_http_info(opts)
+      data
+    end
+
+    # 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 &#x60;curl https://lishogi.org/api/tv/feed&#x60;. 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def tv_feed_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: TVApi.tv_feed ...'
+      end
+      # resource path
+      local_var_path = '/api/tv/feed'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/x-ndjson']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"TVApi.tv_feed",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: TVApi#tv_feed\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end