lishogi 0.1.0

data/lib/lishogi/api/challenges_api.rb

@@ -0,0 +1,554 @@
+=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 ChallengesApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Accept a challenge
+    # Accept an incoming challenge.  You should receive a `gameStart` event on the [incoming events stream](#operation/apiStreamEvent). 
+    # @param challenge_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Ok]
+    def challenge_accept(challenge_id, opts = {})
+      data, _status_code, _headers = challenge_accept_with_http_info(challenge_id, opts)
+      data
+    end
+
+    # Accept a challenge
+    # Accept an incoming challenge.  You should receive a `gameStart` event on the [incoming events stream](#operation/apiStreamEvent). 
+    # @param challenge_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Ok, Integer, Hash)>] Ok data, response status code and response headers
+    def challenge_accept_with_http_info(challenge_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ChallengesApi.challenge_accept ...'
+      end
+      # verify the required parameter 'challenge_id' is set
+      if @api_client.config.client_side_validation && challenge_id.nil?
+        fail ArgumentError, "Missing the required parameter 'challenge_id' when calling ChallengesApi.challenge_accept"
+      end
+      # resource path
+      local_var_path = '/api/challenge/{challengeId}/accept'.sub('{' + 'challengeId' + '}', CGI.escape(challenge_id.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] || 'Ok'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :operation => :"ChallengesApi.challenge_accept",
+        :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(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ChallengesApi#challenge_accept\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Challenge the AI
+    # Start a game with Lishogi AI.  You will be notified on the [event stream](#operation/apiStreamEvent) that a new game has started. 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Float] :level AI strength
+    # @option opts [Float] :clock_limit Clock initial time in seconds. If empty, a correspondence game is created.
+    # @option opts [Integer] :clock_increment Clock increment in seconds. If empty, a correspondence game is created.
+    # @option opts [Integer] :clock_byoyomi Clock byoyomi in seconds. If empty, a correspondence game is created.
+    # @option opts [Integer] :clock_periods Clock periods for byoyomi in seconds. If empty, a correspondence game is created.
+    # @option opts [Integer] :days Days per move, for correspondence games. Clock settings must be omitted.
+    # @option opts [String] :color Which color you get to play (default to 'random')
+    # @option opts [VariantKey] :variant  (default to 'standard')
+    # @option opts [String] :sfen Custom initial position (in SFEN). Variant must be standard, and the game cannot be rated. (default to 'rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq - 0 1')
+    # @return [GameJson]
+    def challenge_ai(opts = {})
+      data, _status_code, _headers = challenge_ai_with_http_info(opts)
+      data
+    end
+
+    # Challenge the AI
+    # Start a game with Lishogi AI.  You will be notified on the [event stream](#operation/apiStreamEvent) that a new game has started. 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Float] :level AI strength
+    # @option opts [Float] :clock_limit Clock initial time in seconds. If empty, a correspondence game is created.
+    # @option opts [Integer] :clock_increment Clock increment in seconds. If empty, a correspondence game is created.
+    # @option opts [Integer] :clock_byoyomi Clock byoyomi in seconds. If empty, a correspondence game is created.
+    # @option opts [Integer] :clock_periods Clock periods for byoyomi in seconds. If empty, a correspondence game is created.
+    # @option opts [Integer] :days Days per move, for correspondence games. Clock settings must be omitted.
+    # @option opts [String] :color Which color you get to play (default to 'random')
+    # @option opts [VariantKey] :variant  (default to 'standard')
+    # @option opts [String] :sfen Custom initial position (in SFEN). Variant must be standard, and the game cannot be rated. (default to 'rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq - 0 1')
+    # @return [Array<(GameJson, Integer, Hash)>] GameJson data, response status code and response headers
+    def challenge_ai_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ChallengesApi.challenge_ai ...'
+      end
+      if @api_client.config.client_side_validation && !opts[:'level'].nil? && opts[:'level'] > 8
+        fail ArgumentError, 'invalid value for "opts[:"level"]" when calling ChallengesApi.challenge_ai, must be smaller than or equal to 8.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'level'].nil? && opts[:'level'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"level"]" when calling ChallengesApi.challenge_ai, must be greater than or equal to 1.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'clock_limit'].nil? && opts[:'clock_limit'] > 10800
+        fail ArgumentError, 'invalid value for "opts[:"clock_limit"]" when calling ChallengesApi.challenge_ai, must be smaller than or equal to 10800.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'clock_limit'].nil? && opts[:'clock_limit'] < 0
+        fail ArgumentError, 'invalid value for "opts[:"clock_limit"]" when calling ChallengesApi.challenge_ai, must be greater than or equal to 0.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'clock_increment'].nil? && opts[:'clock_increment'] > 60
+        fail ArgumentError, 'invalid value for "opts[:"clock_increment"]" when calling ChallengesApi.challenge_ai, must be smaller than or equal to 60.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'clock_increment'].nil? && opts[:'clock_increment'] < 0
+        fail ArgumentError, 'invalid value for "opts[:"clock_increment"]" when calling ChallengesApi.challenge_ai, must be greater than or equal to 0.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'clock_byoyomi'].nil? && opts[:'clock_byoyomi'] > 60
+        fail ArgumentError, 'invalid value for "opts[:"clock_byoyomi"]" when calling ChallengesApi.challenge_ai, must be smaller than or equal to 60.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'clock_byoyomi'].nil? && opts[:'clock_byoyomi'] < 0
+        fail ArgumentError, 'invalid value for "opts[:"clock_byoyomi"]" when calling ChallengesApi.challenge_ai, must be greater than or equal to 0.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'clock_periods'].nil? && opts[:'clock_periods'] > 5
+        fail ArgumentError, 'invalid value for "opts[:"clock_periods"]" when calling ChallengesApi.challenge_ai, must be smaller than or equal to 5.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'clock_periods'].nil? && opts[:'clock_periods'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"clock_periods"]" when calling ChallengesApi.challenge_ai, must be greater than or equal to 1.'
+      end
+
+      allowable_values = [1, 2, 3, 5, 7, 10, 14]
+      if @api_client.config.client_side_validation && opts[:'days'] && !allowable_values.include?(opts[:'days'])
+        fail ArgumentError, "invalid value for \"days\", must be one of #{allowable_values}"
+      end
+      allowable_values = ["random", "sente", "gote"]
+      if @api_client.config.client_side_validation && opts[:'color'] && !allowable_values.include?(opts[:'color'])
+        fail ArgumentError, "invalid value for \"color\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/api/challenge/ai'
+
+      # 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']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+      form_params['level'] = opts[:'level'] if !opts[:'level'].nil?
+      form_params['clock.limit'] = opts[:'clock_limit'] if !opts[:'clock_limit'].nil?
+      form_params['clock.increment'] = opts[:'clock_increment'] if !opts[:'clock_increment'].nil?
+      form_params['clock.byoyomi'] = opts[:'clock_byoyomi'] if !opts[:'clock_byoyomi'].nil?
+      form_params['clock.periods'] = opts[:'clock_periods'] if !opts[:'clock_periods'].nil?
+      form_params['days'] = opts[:'days'] if !opts[:'days'].nil?
+      form_params['color'] = opts[:'color'] if !opts[:'color'].nil?
+      form_params['variant'] = opts[:'variant'] if !opts[:'variant'].nil?
+      form_params['sfen'] = opts[:'sfen'] if !opts[:'sfen'].nil?
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'GameJson'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :operation => :"ChallengesApi.challenge_ai",
+        :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(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ChallengesApi#challenge_ai\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Create a challenge
+    # Challenge someone to play. The targeted player can choose to accept or decline.  If the challenge is accepted, you will be notified on the [event stream](#operation/apiStreamEvent) that a new game has started. The game ID will be the same as the challenge ID.  If you also have an OAuth token with `challenge:write` scope for the receiving user, you can make them accept the challenge immediately by setting the `acceptByToken` field.  Challenges for realtime games (not correspondence) expire after 20s if not accepted. To prevent that, use the `keepAliveStream` flag described below. 
+    # @param username [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :rated Game is rated and impacts players ratings
+    # @option opts [Float] :clock_limit Clock initial time in seconds. If empty, a correspondence game is created.
+    # @option opts [Integer] :clock_increment Clock increment in seconds. If empty, a correspondence game is created.
+    # @option opts [Integer] :clock_byoyomi Clock byoyomi in seconds. If empty, a correspondence game is created.
+    # @option opts [Integer] :clock_periods Clock periods for byoyomi in seconds. If empty, a correspondence game is created.
+    # @option opts [Integer] :days Days per move, for correspondence games. Clock settings must be omitted.
+    # @option opts [String] :color Which color you get to play (default to 'random')
+    # @option opts [VariantKey] :variant  (default to 'standard')
+    # @option opts [String] :sfen Custom initial position (in SFEN). Variant must be standard, and the game cannot be rated. (default to 'rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq - 0 1')
+    # @option opts [Boolean] :keep_alive_stream If set, the response is streamed as [ndjson](#section/Introduction/Streaming-with-ND-JSON). The challenge is kept alive until the connection is closed by the client. When the challenge is accepted or declined, a message of the form &#x60;{\\\&quot;done\\\&quot;:\\\&quot;accepted\\\&quot;}&#x60; is sent, then the connection is closed by the server. If not set, the response is not streamed, and the challenge expires after 20s if not accepted. 
+    # @option opts [String] :accept_by_token Immediately accept the challenge and create the game. Pass in an OAuth token (with the &#x60;challenge:write&#x60; scope) for the receiving user. On success, the response will contain a &#x60;game&#x60; field instead of a &#x60;challenge&#x60; field. 
+    # @option opts [String] :message **Only if &#x60;acceptByToken&#x60; is set.**  Message that is sent to each player, when the game is created. It is sent from your user account.  &#x60;{opponent}&#x60;, &#x60;{player}&#x60; and &#x60;{game}&#x60; are placeholders that will be replaced with the opponent name, player name, and the game URLs.  You can omit this field to send the default message, but if you set your own message, it must at least contain the &#x60;{game}&#x60; placeholder.  (default to 'Your game with {opponent} is ready: {game}.')
+    # @return [ChallengeJson]
+    def challenge_create(username, opts = {})
+      data, _status_code, _headers = challenge_create_with_http_info(username, opts)
+      data
+    end
+
+    # Create a challenge
+    # Challenge someone to play. The targeted player can choose to accept or decline.  If the challenge is accepted, you will be notified on the [event stream](#operation/apiStreamEvent) that a new game has started. The game ID will be the same as the challenge ID.  If you also have an OAuth token with &#x60;challenge:write&#x60; scope for the receiving user, you can make them accept the challenge immediately by setting the &#x60;acceptByToken&#x60; field.  Challenges for realtime games (not correspondence) expire after 20s if not accepted. To prevent that, use the &#x60;keepAliveStream&#x60; flag described below. 
+    # @param username [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :rated Game is rated and impacts players ratings
+    # @option opts [Float] :clock_limit Clock initial time in seconds. If empty, a correspondence game is created.
+    # @option opts [Integer] :clock_increment Clock increment in seconds. If empty, a correspondence game is created.
+    # @option opts [Integer] :clock_byoyomi Clock byoyomi in seconds. If empty, a correspondence game is created.
+    # @option opts [Integer] :clock_periods Clock periods for byoyomi in seconds. If empty, a correspondence game is created.
+    # @option opts [Integer] :days Days per move, for correspondence games. Clock settings must be omitted.
+    # @option opts [String] :color Which color you get to play (default to 'random')
+    # @option opts [VariantKey] :variant  (default to 'standard')
+    # @option opts [String] :sfen Custom initial position (in SFEN). Variant must be standard, and the game cannot be rated. (default to 'rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq - 0 1')
+    # @option opts [Boolean] :keep_alive_stream If set, the response is streamed as [ndjson](#section/Introduction/Streaming-with-ND-JSON). The challenge is kept alive until the connection is closed by the client. When the challenge is accepted or declined, a message of the form &#x60;{\\\&quot;done\\\&quot;:\\\&quot;accepted\\\&quot;}&#x60; is sent, then the connection is closed by the server. If not set, the response is not streamed, and the challenge expires after 20s if not accepted. 
+    # @option opts [String] :accept_by_token Immediately accept the challenge and create the game. Pass in an OAuth token (with the &#x60;challenge:write&#x60; scope) for the receiving user. On success, the response will contain a &#x60;game&#x60; field instead of a &#x60;challenge&#x60; field. 
+    # @option opts [String] :message **Only if &#x60;acceptByToken&#x60; is set.**  Message that is sent to each player, when the game is created. It is sent from your user account.  &#x60;{opponent}&#x60;, &#x60;{player}&#x60; and &#x60;{game}&#x60; are placeholders that will be replaced with the opponent name, player name, and the game URLs.  You can omit this field to send the default message, but if you set your own message, it must at least contain the &#x60;{game}&#x60; placeholder.  (default to 'Your game with {opponent} is ready: {game}.')
+    # @return [Array<(ChallengeJson, Integer, Hash)>] ChallengeJson data, response status code and response headers
+    def challenge_create_with_http_info(username, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ChallengesApi.challenge_create ...'
+      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 ChallengesApi.challenge_create"
+      end
+      if @api_client.config.client_side_validation && !opts[:'clock_limit'].nil? && opts[:'clock_limit'] > 10800
+        fail ArgumentError, 'invalid value for "opts[:"clock_limit"]" when calling ChallengesApi.challenge_create, must be smaller than or equal to 10800.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'clock_limit'].nil? && opts[:'clock_limit'] < 0
+        fail ArgumentError, 'invalid value for "opts[:"clock_limit"]" when calling ChallengesApi.challenge_create, must be greater than or equal to 0.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'clock_increment'].nil? && opts[:'clock_increment'] > 60
+        fail ArgumentError, 'invalid value for "opts[:"clock_increment"]" when calling ChallengesApi.challenge_create, must be smaller than or equal to 60.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'clock_increment'].nil? && opts[:'clock_increment'] < 0
+        fail ArgumentError, 'invalid value for "opts[:"clock_increment"]" when calling ChallengesApi.challenge_create, must be greater than or equal to 0.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'clock_byoyomi'].nil? && opts[:'clock_byoyomi'] > 60
+        fail ArgumentError, 'invalid value for "opts[:"clock_byoyomi"]" when calling ChallengesApi.challenge_create, must be smaller than or equal to 60.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'clock_byoyomi'].nil? && opts[:'clock_byoyomi'] < 0
+        fail ArgumentError, 'invalid value for "opts[:"clock_byoyomi"]" when calling ChallengesApi.challenge_create, must be greater than or equal to 0.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'clock_periods'].nil? && opts[:'clock_periods'] > 5
+        fail ArgumentError, 'invalid value for "opts[:"clock_periods"]" when calling ChallengesApi.challenge_create, must be smaller than or equal to 5.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'clock_periods'].nil? && opts[:'clock_periods'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"clock_periods"]" when calling ChallengesApi.challenge_create, must be greater than or equal to 1.'
+      end
+
+      allowable_values = [1, 2, 3, 5, 7, 10, 14]
+      if @api_client.config.client_side_validation && opts[:'days'] && !allowable_values.include?(opts[:'days'])
+        fail ArgumentError, "invalid value for \"days\", must be one of #{allowable_values}"
+      end
+      allowable_values = ["random", "sente", "gote"]
+      if @api_client.config.client_side_validation && opts[:'color'] && !allowable_values.include?(opts[:'color'])
+        fail ArgumentError, "invalid value for \"color\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/api/challenge/{username}'.sub('{' + 'username' + '}', CGI.escape(username.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']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+      form_params['rated'] = opts[:'rated'] if !opts[:'rated'].nil?
+      form_params['clock.limit'] = opts[:'clock_limit'] if !opts[:'clock_limit'].nil?
+      form_params['clock.increment'] = opts[:'clock_increment'] if !opts[:'clock_increment'].nil?
+      form_params['clock.byoyomi'] = opts[:'clock_byoyomi'] if !opts[:'clock_byoyomi'].nil?
+      form_params['clock.periods'] = opts[:'clock_periods'] if !opts[:'clock_periods'].nil?
+      form_params['days'] = opts[:'days'] if !opts[:'days'].nil?
+      form_params['color'] = opts[:'color'] if !opts[:'color'].nil?
+      form_params['variant'] = opts[:'variant'] if !opts[:'variant'].nil?
+      form_params['sfen'] = opts[:'sfen'] if !opts[:'sfen'].nil?
+      form_params['keepAliveStream'] = opts[:'keep_alive_stream'] if !opts[:'keep_alive_stream'].nil?
+      form_params['acceptByToken'] = opts[:'accept_by_token'] if !opts[:'accept_by_token'].nil?
+      form_params['message'] = opts[:'message'] if !opts[:'message'].nil?
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ChallengeJson'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :operation => :"ChallengesApi.challenge_create",
+        :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(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ChallengesApi#challenge_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Decline a challenge
+    # Decline an incoming challenge. 
+    # @param challenge_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Ok]
+    def challenge_decline(challenge_id, opts = {})
+      data, _status_code, _headers = challenge_decline_with_http_info(challenge_id, opts)
+      data
+    end
+
+    # Decline a challenge
+    # Decline an incoming challenge. 
+    # @param challenge_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Ok, Integer, Hash)>] Ok data, response status code and response headers
+    def challenge_decline_with_http_info(challenge_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ChallengesApi.challenge_decline ...'
+      end
+      # verify the required parameter 'challenge_id' is set
+      if @api_client.config.client_side_validation && challenge_id.nil?
+        fail ArgumentError, "Missing the required parameter 'challenge_id' when calling ChallengesApi.challenge_decline"
+      end
+      # resource path
+      local_var_path = '/api/challenge/{challengeId}/decline'.sub('{' + 'challengeId' + '}', CGI.escape(challenge_id.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] || 'Ok'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :operation => :"ChallengesApi.challenge_decline",
+        :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(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ChallengesApi#challenge_decline\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Open-ended challenge
+    # Create a challenge that any 2 players can join.  Share the URL of the challenge. the first 2 players to click it will be paired for a game.  The response body also contains `senteUrl` and `goteUrl`. You can control which color each player gets by giving them these URLs, instead of the main challenge URL.  Open challenges expire after 24h.  To directly pair 2 known players, use [this endpoint](#operation/challengeCreate) instead, with the `acceptByToken` parameter. 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :rated Game is rated and impacts players ratings
+    # @option opts [Float] :clock_limit Clock initial time in seconds. If empty, a correspondence game is created.
+    # @option opts [Integer] :clock_increment Clock increment in seconds. If empty, a correspondence game is created.
+    # @option opts [Integer] :clock_byoyomi Clock byoyomi in seconds. If empty, a correspondence game is created.
+    # @option opts [Integer] :clock_periods Clock periods for byoyomi in seconds. If empty, a correspondence game is created.
+    # @option opts [Integer] :days Days per turn. For correspondence challenges.
+    # @option opts [VariantKey] :variant  (default to 'standard')
+    # @option opts [String] :sfen Custom initial position (in SFEN). Variant must be standard, and the game cannot be rated. (default to 'rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq - 0 1')
+    # @option opts [String] :name Optional name for the challenge, that players will see on the challenge page.
+    # @return [Object]
+    def challenge_open(opts = {})
+      data, _status_code, _headers = challenge_open_with_http_info(opts)
+      data
+    end
+
+    # Open-ended challenge
+    # Create a challenge that any 2 players can join.  Share the URL of the challenge. the first 2 players to click it will be paired for a game.  The response body also contains &#x60;senteUrl&#x60; and &#x60;goteUrl&#x60;. You can control which color each player gets by giving them these URLs, instead of the main challenge URL.  Open challenges expire after 24h.  To directly pair 2 known players, use [this endpoint](#operation/challengeCreate) instead, with the &#x60;acceptByToken&#x60; parameter. 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :rated Game is rated and impacts players ratings
+    # @option opts [Float] :clock_limit Clock initial time in seconds. If empty, a correspondence game is created.
+    # @option opts [Integer] :clock_increment Clock increment in seconds. If empty, a correspondence game is created.
+    # @option opts [Integer] :clock_byoyomi Clock byoyomi in seconds. If empty, a correspondence game is created.
+    # @option opts [Integer] :clock_periods Clock periods for byoyomi in seconds. If empty, a correspondence game is created.
+    # @option opts [Integer] :days Days per turn. For correspondence challenges.
+    # @option opts [VariantKey] :variant  (default to 'standard')
+    # @option opts [String] :sfen Custom initial position (in SFEN). Variant must be standard, and the game cannot be rated. (default to 'rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq - 0 1')
+    # @option opts [String] :name Optional name for the challenge, that players will see on the challenge page.
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def challenge_open_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ChallengesApi.challenge_open ...'
+      end
+      if @api_client.config.client_side_validation && !opts[:'clock_limit'].nil? && opts[:'clock_limit'] > 10800
+        fail ArgumentError, 'invalid value for "opts[:"clock_limit"]" when calling ChallengesApi.challenge_open, must be smaller than or equal to 10800.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'clock_limit'].nil? && opts[:'clock_limit'] < 0
+        fail ArgumentError, 'invalid value for "opts[:"clock_limit"]" when calling ChallengesApi.challenge_open, must be greater than or equal to 0.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'clock_increment'].nil? && opts[:'clock_increment'] > 60
+        fail ArgumentError, 'invalid value for "opts[:"clock_increment"]" when calling ChallengesApi.challenge_open, must be smaller than or equal to 60.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'clock_increment'].nil? && opts[:'clock_increment'] < 0
+        fail ArgumentError, 'invalid value for "opts[:"clock_increment"]" when calling ChallengesApi.challenge_open, must be greater than or equal to 0.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'clock_byoyomi'].nil? && opts[:'clock_byoyomi'] > 60
+        fail ArgumentError, 'invalid value for "opts[:"clock_byoyomi"]" when calling ChallengesApi.challenge_open, must be smaller than or equal to 60.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'clock_byoyomi'].nil? && opts[:'clock_byoyomi'] < 0
+        fail ArgumentError, 'invalid value for "opts[:"clock_byoyomi"]" when calling ChallengesApi.challenge_open, must be greater than or equal to 0.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'clock_periods'].nil? && opts[:'clock_periods'] > 5
+        fail ArgumentError, 'invalid value for "opts[:"clock_periods"]" when calling ChallengesApi.challenge_open, must be smaller than or equal to 5.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'clock_periods'].nil? && opts[:'clock_periods'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"clock_periods"]" when calling ChallengesApi.challenge_open, must be greater than or equal to 1.'
+      end
+
+      allowable_values = [1, 2, 3, 5, 7, 10, 14]
+      if @api_client.config.client_side_validation && opts[:'days'] && !allowable_values.include?(opts[:'days'])
+        fail ArgumentError, "invalid value for \"days\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/api/challenge/open'
+
+      # 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']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+      form_params['rated'] = opts[:'rated'] if !opts[:'rated'].nil?
+      form_params['clock.limit'] = opts[:'clock_limit'] if !opts[:'clock_limit'].nil?
+      form_params['clock.increment'] = opts[:'clock_increment'] if !opts[:'clock_increment'].nil?
+      form_params['clock.byoyomi'] = opts[:'clock_byoyomi'] if !opts[:'clock_byoyomi'].nil?
+      form_params['clock.periods'] = opts[:'clock_periods'] if !opts[:'clock_periods'].nil?
+      form_params['days'] = opts[:'days'] if !opts[:'days'].nil?
+      form_params['variant'] = opts[:'variant'] if !opts[:'variant'].nil?
+      form_params['sfen'] = opts[:'sfen'] if !opts[:'sfen'].nil?
+      form_params['name'] = opts[:'name'] if !opts[:'name'].nil?
+
+      # 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 => :"ChallengesApi.challenge_open",
+        :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(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ChallengesApi#challenge_open\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end