Class: Lishogi::PuzzlesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/lishogi/api/puzzles_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PuzzlesApi

Returns a new instance of PuzzlesApi.



19
20
21
 
# File 'lib/lishogi/api/puzzles_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/lishogi/api/puzzles_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#api_puzzle_activity(opts = {}) ⇒ PuzzleRoundJson

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.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :max (Integer) —

    How many entries to download. Leave empty to download all activity.

Returns:



27
28
29
30
 
# File 'lib/lishogi/api/puzzles_api.rb', line 27

def api_puzzle_activity(opts = {})
  data, _status_code, _headers = api_puzzle_activity_with_http_info(opts)
  data
end

#api_puzzle_activity_with_http_info(opts = {}) ⇒ Array<(PuzzleRoundJson, Integer, Hash)>

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.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :max (Integer) —

    How many entries to download. Leave empty to download all activity.

Returns:

  • (Array<(PuzzleRoundJson, Integer, Hash)>) —

    PuzzleRoundJson data, response status code and response headers



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/lishogi/api/puzzles_api.rb', line 37

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

#api_puzzle_daily(opts = {}) ⇒ Object

Get the daily puzzle Get the daily Lishogi puzzle in JSON format.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Object) 


90
91
92
93
 
# File 'lib/lishogi/api/puzzles_api.rb', line 90

def api_puzzle_daily(opts = {})
  data, _status_code, _headers = api_puzzle_daily_with_http_info(opts)
  data
end

#api_puzzle_daily_with_http_info(opts = {}) ⇒ Array<(Object, Integer, Hash)>

Get the daily puzzle Get the daily Lishogi puzzle in JSON format.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/lishogi/api/puzzles_api.rb', line 99

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

#api_puzzle_dashboard(days, opts = {}) ⇒ Object

Get your puzzle dashboard Download your [puzzle dashboard](lishogi.org/training/dashboard/30/dashboard) as JSON. Also includes all puzzle themes played, with aggregated results. Allows re-creating the [improvement/strengths](lishogi.org/training/dashboard/30/improvementAreas) interfaces.

Parameters:

  • days (Integer) —

    How many days to look back when aggregating puzzle results. 30 is sensible.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Object) 


148
149
150
151
 
# File 'lib/lishogi/api/puzzles_api.rb', line 148

def api_puzzle_dashboard(days, opts = {})
  data, _status_code, _headers = api_puzzle_dashboard_with_http_info(days, opts)
  data
end

#api_puzzle_dashboard_with_http_info(days, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Get your puzzle dashboard Download your [puzzle dashboard](lishogi.org/training/dashboard/30/dashboard) as JSON. Also includes all puzzle themes played, with aggregated results. Allows re-creating the [improvement/strengths](lishogi.org/training/dashboard/30/improvementAreas) interfaces.

Parameters:

  • days (Integer) —

    How many days to look back when aggregating puzzle results. 30 is sensible.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/lishogi/api/puzzles_api.rb', line 158

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