lishogi 0.1.0

data/lib/lishogi/api/puzzles_api.rb

@@ -0,0 +1,210 @@
+=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 PuzzlesApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get your puzzle activity
+    # Download your puzzle activity in [ndjson](#section/Introduction/Streaming-with-ND-JSON) format.  Puzzle activity is sorted by reverse chronological order (most recent first)  We recommend streaming the response, for it can be very long. 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :max How many entries to download. Leave empty to download all activity.
+    # @return [PuzzleRoundJson]
+    def api_puzzle_activity(opts = {})
+      data, _status_code, _headers = api_puzzle_activity_with_http_info(opts)
+      data
+    end
+
+    # Get your puzzle activity
+    # Download your puzzle activity in [ndjson](#section/Introduction/Streaming-with-ND-JSON) format.  Puzzle activity is sorted by reverse chronological order (most recent first)  We recommend streaming the response, for it can be very long. 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :max How many entries to download. Leave empty to download all activity.
+    # @return [Array<(PuzzleRoundJson, Integer, Hash)>] PuzzleRoundJson data, response status code and response headers
+    def api_puzzle_activity_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PuzzlesApi.api_puzzle_activity ...'
+      end
+      if @api_client.config.client_side_validation && !opts[:'max'].nil? && opts[:'max'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"max"]" when calling PuzzlesApi.api_puzzle_activity, must be greater than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/api/puzzle/activity'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'max'] = opts[:'max'] if !opts[:'max'].nil?
+
+      # 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] || 'PuzzleRoundJson'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :operation => :"PuzzlesApi.api_puzzle_activity",
+        :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: PuzzlesApi#api_puzzle_activity\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get the daily puzzle
+    # Get the daily Lishogi puzzle in JSON format. 
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def api_puzzle_daily(opts = {})
+      data, _status_code, _headers = api_puzzle_daily_with_http_info(opts)
+      data
+    end
+
+    # Get the daily puzzle
+    # Get the daily Lishogi puzzle in JSON format. 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def api_puzzle_daily_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PuzzlesApi.api_puzzle_daily ...'
+      end
+      # resource path
+      local_var_path = '/api/puzzle/daily'
+
+      # 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 => :"PuzzlesApi.api_puzzle_daily",
+        :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: PuzzlesApi#api_puzzle_daily\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get your puzzle dashboard
+    # Download your [puzzle dashboard](https://lishogi.org/training/dashboard/30/dashboard) as JSON.  Also includes all puzzle themes played, with aggregated results.  Allows re-creating the [improvement/strengths](https://lishogi.org/training/dashboard/30/improvementAreas) interfaces. 
+    # @param days [Integer] How many days to look back when aggregating puzzle results. 30 is sensible.
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def api_puzzle_dashboard(days, opts = {})
+      data, _status_code, _headers = api_puzzle_dashboard_with_http_info(days, opts)
+      data
+    end
+
+    # Get your puzzle dashboard
+    # Download your [puzzle dashboard](https://lishogi.org/training/dashboard/30/dashboard) as JSON.  Also includes all puzzle themes played, with aggregated results.  Allows re-creating the [improvement/strengths](https://lishogi.org/training/dashboard/30/improvementAreas) interfaces. 
+    # @param days [Integer] How many days to look back when aggregating puzzle results. 30 is sensible.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def api_puzzle_dashboard_with_http_info(days, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PuzzlesApi.api_puzzle_dashboard ...'
+      end
+      # verify the required parameter 'days' is set
+      if @api_client.config.client_side_validation && days.nil?
+        fail ArgumentError, "Missing the required parameter 'days' when calling PuzzlesApi.api_puzzle_dashboard"
+      end
+      if @api_client.config.client_side_validation && days < 1
+        fail ArgumentError, 'invalid value for "days" when calling PuzzlesApi.api_puzzle_dashboard, must be greater than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/api/puzzle/dashboard/{days}'.sub('{' + 'days' + '}', CGI.escape(days.to_s))
+
+      # 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] || ['OAuth2']
+
+      new_options = opts.merge(
+        :operation => :"PuzzlesApi.api_puzzle_dashboard",
+        :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: PuzzlesApi#api_puzzle_dashboard\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/lishogi/api/simuls_api.rb

@@ -0,0 +1,79 @@
+=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 SimulsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get current simuls
+    # Get recently finished, ongoing, and upcoming simuls. 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<Object>]
+    def api_simul(opts = {})
+      data, _status_code, _headers = api_simul_with_http_info(opts)
+      data
+    end
+
+    # Get current simuls
+    # Get recently finished, ongoing, and upcoming simuls. 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Array<Object>, Integer, Hash)>] Array<Object> data, response status code and response headers
+    def api_simul_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SimulsApi.api_simul ...'
+      end
+      # resource path
+      local_var_path = '/api/simul'
+
+      # 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] || 'Array<Object>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"SimulsApi.api_simul",
+        :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: SimulsApi#api_simul\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/lishogi/api/studies_api.rb

@@ -0,0 +1,244 @@
+=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 StudiesApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Export all chapters
+    # Download all chapters of a study in KIF format. 
+    # @param study_id [String] The study ID (8 characters).
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :clocks Include clock comments in the KIF moves, when available.  Example: `22   同　玉(51)   (00:02/00:00:13)`  (default to true)
+    # @option opts [Boolean] :comments Include analysis and annotator comments in the KIF moves, when available.  Example: `1   ３六歩(37)  * Good move  * 次に▲35歩で角道を遮る！  * [%csl P3d,P2b][%cal P3f3e]`  (default to true)
+    # @option opts [Boolean] :variations Include non-mainline moves, when available.  Example: `7   ４八銀(39)  * [%cal P4h3g,P3g4f,P3f3e]`  (default to true)
+    # @return [Object]
+    def study_all_chapters_kif(study_id, opts = {})
+      data, _status_code, _headers = study_all_chapters_kif_with_http_info(study_id, opts)
+      data
+    end
+
+    # Export all chapters
+    # Download all chapters of a study in KIF format. 
+    # @param study_id [String] The study ID (8 characters).
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :clocks Include clock comments in the KIF moves, when available.  Example: `22   同　玉(51)   (00:02/00:00:13)`  (default to true)
+    # @option opts [Boolean] :comments Include analysis and annotator comments in the KIF moves, when available.  Example: `1   ３六歩(37)  * Good move  * 次に▲35歩で角道を遮る！  * [%csl P3d,P2b][%cal P3f3e]`  (default to true)
+    # @option opts [Boolean] :variations Include non-mainline moves, when available.  Example: `7   ４八銀(39)  * [%cal P4h3g,P3g4f,P3f3e]`  (default to true)
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def study_all_chapters_kif_with_http_info(study_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: StudiesApi.study_all_chapters_kif ...'
+      end
+      # verify the required parameter 'study_id' is set
+      if @api_client.config.client_side_validation && study_id.nil?
+        fail ArgumentError, "Missing the required parameter 'study_id' when calling StudiesApi.study_all_chapters_kif"
+      end
+      # resource path
+      local_var_path = '/api/study/{studyId}.kif'.sub('{' + 'studyId' + '}', CGI.escape(study_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'clocks'] = opts[:'clocks'] if !opts[:'clocks'].nil?
+      query_params[:'comments'] = opts[:'comments'] if !opts[:'comments'].nil?
+      query_params[:'variations'] = opts[:'variations'] if !opts[:'variations'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['text/plain']) 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 => :"StudiesApi.study_all_chapters_kif",
+        :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: StudiesApi#study_all_chapters_kif\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Export one study chapter
+    # Download one study chapter in KIF format. 
+    # @param study_id [String] The study ID (8 characters).
+    # @param chapter_id [String] The chapter ID (8 characters).
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :clocks Include clock comments in the KIF moves, when available.  Example: &#x60;22   同　玉(51)   (00:02/00:00:13)&#x60;  (default to true)
+    # @option opts [Boolean] :comments Include analysis and annotator comments in the KIF moves, when available.  Example: &#x60;1   ３六歩(37)  * Good move  * 次に▲35歩で角道を遮る！  * [%csl P3d,P2b][%cal P3f3e]&#x60;  (default to true)
+    # @option opts [Boolean] :variations Include non-mainline moves, when available.  Example: &#x60;7   ４八銀(39)  * [%cal P4h3g,P3g4f,P3f3e]&#x60;  (default to true)
+    # @return [Object]
+    def study_chapter_kif(study_id, chapter_id, opts = {})
+      data, _status_code, _headers = study_chapter_kif_with_http_info(study_id, chapter_id, opts)
+      data
+    end
+
+    # Export one study chapter
+    # Download one study chapter in KIF format. 
+    # @param study_id [String] The study ID (8 characters).
+    # @param chapter_id [String] The chapter ID (8 characters).
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :clocks Include clock comments in the KIF moves, when available.  Example: &#x60;22   同　玉(51)   (00:02/00:00:13)&#x60;  (default to true)
+    # @option opts [Boolean] :comments Include analysis and annotator comments in the KIF moves, when available.  Example: &#x60;1   ３六歩(37)  * Good move  * 次に▲35歩で角道を遮る！  * [%csl P3d,P2b][%cal P3f3e]&#x60;  (default to true)
+    # @option opts [Boolean] :variations Include non-mainline moves, when available.  Example: &#x60;7   ４八銀(39)  * [%cal P4h3g,P3g4f,P3f3e]&#x60;  (default to true)
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def study_chapter_kif_with_http_info(study_id, chapter_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: StudiesApi.study_chapter_kif ...'
+      end
+      # verify the required parameter 'study_id' is set
+      if @api_client.config.client_side_validation && study_id.nil?
+        fail ArgumentError, "Missing the required parameter 'study_id' when calling StudiesApi.study_chapter_kif"
+      end
+      # verify the required parameter 'chapter_id' is set
+      if @api_client.config.client_side_validation && chapter_id.nil?
+        fail ArgumentError, "Missing the required parameter 'chapter_id' when calling StudiesApi.study_chapter_kif"
+      end
+      # resource path
+      local_var_path = '/study/{studyId}/{chapterId}.kif'.sub('{' + 'studyId' + '}', CGI.escape(study_id.to_s)).sub('{' + 'chapterId' + '}', CGI.escape(chapter_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'clocks'] = opts[:'clocks'] if !opts[:'clocks'].nil?
+      query_params[:'comments'] = opts[:'comments'] if !opts[:'comments'].nil?
+      query_params[:'variations'] = opts[:'variations'] if !opts[:'variations'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['text/plain']) 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 => :"StudiesApi.study_chapter_kif",
+        :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: StudiesApi#study_chapter_kif\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Export all studies of a user
+    # Download all chapters of all studies of a user in KIF format.  If authenticated, then all public, unlisted, and private studies are included.  If not, only public, listed studies are included. 
+    # @param username [String] The user whose studies we export
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :clocks Include clock comments in the KIF moves, when available.  Example: &#x60;22   同　玉(51)   (00:02/00:00:13)&#x60;  (default to true)
+    # @option opts [Boolean] :comments Include analysis and annotator comments in the KIF moves, when available.  Example: &#x60;1   ３六歩(37)  * Good move  * 次に▲35歩で角道を遮る  * [%csl P3d,P2b][%cal P3f3e]&#x60;  (default to true)
+    # @option opts [Boolean] :variations Include non-mainline moves, when available.  Example: &#x60;7   ４八銀(39)  * [%cal P4h3g,P3g4f,P3f3e]&#x60;  (default to true)
+    # @return [Object]
+    def study_export_all_kif(username, opts = {})
+      data, _status_code, _headers = study_export_all_kif_with_http_info(username, opts)
+      data
+    end
+
+    # Export all studies of a user
+    # Download all chapters of all studies of a user in KIF format.  If authenticated, then all public, unlisted, and private studies are included.  If not, only public, listed studies are included. 
+    # @param username [String] The user whose studies we export
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :clocks Include clock comments in the KIF moves, when available.  Example: &#x60;22   同　玉(51)   (00:02/00:00:13)&#x60;  (default to true)
+    # @option opts [Boolean] :comments Include analysis and annotator comments in the KIF moves, when available.  Example: &#x60;1   ３六歩(37)  * Good move  * 次に▲35歩で角道を遮る  * [%csl P3d,P2b][%cal P3f3e]&#x60;  (default to true)
+    # @option opts [Boolean] :variations Include non-mainline moves, when available.  Example: &#x60;7   ４八銀(39)  * [%cal P4h3g,P3g4f,P3f3e]&#x60;  (default to true)
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def study_export_all_kif_with_http_info(username, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: StudiesApi.study_export_all_kif ...'
+      end
+      # verify the required parameter 'username' is set
+      if @api_client.config.client_side_validation && username.nil?
+        fail ArgumentError, "Missing the required parameter 'username' when calling StudiesApi.study_export_all_kif"
+      end
+      # resource path
+      local_var_path = '/study/by/{username}/export.kif'.sub('{' + 'username' + '}', CGI.escape(username.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'clocks'] = opts[:'clocks'] if !opts[:'clocks'].nil?
+      query_params[:'comments'] = opts[:'comments'] if !opts[:'comments'].nil?
+      query_params[:'variations'] = opts[:'variations'] if !opts[:'variations'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['text/plain']) 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] || ['OAuth2']
+
+      new_options = opts.merge(
+        :operation => :"StudiesApi.study_export_all_kif",
+        :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: StudiesApi#study_export_all_kif\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end