Class: StormgateWorld::PlayersApi

Inherits:
Object
  • Object
show all
Defined in:
lib/stormgate_world/api/players_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PlayersApi

Returns a new instance of PlayersApi.



19
20
21
 
# File 'lib/stormgate_world/api/players_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/stormgate_world/api/players_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_player(player_id, opts = {}) ⇒ PlayerResponse

Parameters:

  • player_id (String) —

    Player ID

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

    the optional parameters

Returns:



25
26
27
28
 
# File 'lib/stormgate_world/api/players_api.rb', line 25

def get_player(player_id, opts = {})
  data, _status_code, _headers = get_player_with_http_info(player_id, opts)
  data
end

#get_player_last_match(player_id, opts = {}) ⇒ MatchResponse

Parameters:

  • player_id (String) —

    Player ID

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

    the optional parameters

Returns:



84
85
86
87
 
# File 'lib/stormgate_world/api/players_api.rb', line 84

def get_player_last_match(player_id, opts = {})
  data, _status_code, _headers = get_player_last_match_with_http_info(player_id, opts)
  data
end

#get_player_last_match_with_http_info(player_id, opts = {}) ⇒ Array<(MatchResponse, Integer, Hash)>

Returns MatchResponse data, response status code and response headers.

Parameters:

  • player_id (String) —

    Player ID

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

    the optional parameters

Returns:

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

    MatchResponse data, response status code and response headers



92
93
94
95
96
97
98
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
 
# File 'lib/stormgate_world/api/players_api.rb', line 92

def get_player_last_match_with_http_info(player_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlayersApi.get_player_last_match ...'
  end
  # verify the required parameter 'player_id' is set
  if @api_client.config.client_side_validation && player_id.nil?
    fail ArgumentError, "Missing the required parameter 'player_id' when calling PlayersApi.get_player_last_match"
  end
  # resource path
  local_var_path = '/v0/players/{player_id}/matches/last'.sub('{' + 'player_id' + '}', CGI.escape(player_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'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'MatchResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"PlayersApi.get_player_last_match",
    :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: PlayersApi#get_player_last_match\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_player_matches(player_id, opts = {}) ⇒ PlayerMatchesResponse

Parameters:

  • player_id (String) —

    Player ID

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

    the optional parameters

Options Hash (opts):

  • :race (Race)
  • :opponent_player_id (String)
  • :page (Integer)
  • :count (Integer)

Returns:



147
148
149
150
 
# File 'lib/stormgate_world/api/players_api.rb', line 147

def get_player_matches(player_id, opts = {})
  data, _status_code, _headers = get_player_matches_with_http_info(player_id, opts)
  data
end

#get_player_matches_with_http_info(player_id, opts = {}) ⇒ Array<(PlayerMatchesResponse, Integer, Hash)>

Returns PlayerMatchesResponse data, response status code and response headers.

Parameters:

  • player_id (String) —

    Player ID

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

    the optional parameters

Options Hash (opts):

  • :race (Race)
  • :opponent_player_id (String)
  • :page (Integer)
  • :count (Integer)

Returns:

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

    PlayerMatchesResponse data, response status code and response headers



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
209
210
211
212
213
214
215
216
217
 
# File 'lib/stormgate_world/api/players_api.rb', line 159

def get_player_matches_with_http_info(player_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlayersApi.get_player_matches ...'
  end
  # verify the required parameter 'player_id' is set
  if @api_client.config.client_side_validation && player_id.nil?
    fail ArgumentError, "Missing the required parameter 'player_id' when calling PlayersApi.get_player_matches"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 0
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling PlayersApi.get_player_matches, must be greater than or equal to 0.'
  end

  if @api_client.config.client_side_validation && !opts[:'count'].nil? && opts[:'count'] < 0
    fail ArgumentError, 'invalid value for "opts[:"count"]" when calling PlayersApi.get_player_matches, must be greater than or equal to 0.'
  end

  # resource path
  local_var_path = '/v0/players/{player_id}/matches'.sub('{' + 'player_id' + '}', CGI.escape(player_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'race'] = opts[:'race'] if !opts[:'race'].nil?
  query_params[:'opponent_player_id'] = opts[:'opponent_player_id'] if !opts[:'opponent_player_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'PlayerMatchesResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"PlayersApi.get_player_matches",
    :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: PlayersApi#get_player_matches\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_player_statistics_activity(player_id, opts = {}) ⇒ PlayerActivityStats

Parameters:

  • player_id (String) —

    Player ID

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

    the optional parameters

Returns:



222
223
224
225
 
# File 'lib/stormgate_world/api/players_api.rb', line 222

def get_player_statistics_activity(player_id, opts = {})
  data, _status_code, _headers = get_player_statistics_activity_with_http_info(player_id, opts)
  data
end

#get_player_statistics_activity_with_http_info(player_id, opts = {}) ⇒ Array<(PlayerActivityStats, Integer, Hash)>

Returns PlayerActivityStats data, response status code and response headers.

Parameters:

  • player_id (String) —

    Player ID

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

    the optional parameters

Returns:

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

    PlayerActivityStats data, response status code and response headers



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/stormgate_world/api/players_api.rb', line 230

def get_player_statistics_activity_with_http_info(player_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlayersApi.get_player_statistics_activity ...'
  end
  # verify the required parameter 'player_id' is set
  if @api_client.config.client_side_validation && player_id.nil?
    fail ArgumentError, "Missing the required parameter 'player_id' when calling PlayersApi.get_player_statistics_activity"
  end
  # resource path
  local_var_path = '/v0/players/{player_id}/statistics/activity'.sub('{' + 'player_id' + '}', CGI.escape(player_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'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'PlayerActivityStats'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"PlayersApi.get_player_statistics_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: PlayersApi#get_player_statistics_activity\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_player_statistics_matchups(player_id, opts = {}) ⇒ PlayerMatchupsStats

Parameters:

  • player_id (String) —

    Player ID

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

    the optional parameters

Returns:



281
282
283
284
 
# File 'lib/stormgate_world/api/players_api.rb', line 281

def get_player_statistics_matchups(player_id, opts = {})
  data, _status_code, _headers = get_player_statistics_matchups_with_http_info(player_id, opts)
  data
end

#get_player_statistics_matchups_with_http_info(player_id, opts = {}) ⇒ Array<(PlayerMatchupsStats, Integer, Hash)>

Returns PlayerMatchupsStats data, response status code and response headers.

Parameters:

  • player_id (String) —

    Player ID

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

    the optional parameters

Returns:

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

    PlayerMatchupsStats data, response status code and response headers



289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/stormgate_world/api/players_api.rb', line 289

def get_player_statistics_matchups_with_http_info(player_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlayersApi.get_player_statistics_matchups ...'
  end
  # verify the required parameter 'player_id' is set
  if @api_client.config.client_side_validation && player_id.nil?
    fail ArgumentError, "Missing the required parameter 'player_id' when calling PlayersApi.get_player_statistics_matchups"
  end
  # resource path
  local_var_path = '/v0/players/{player_id}/statistics/matchups'.sub('{' + 'player_id' + '}', CGI.escape(player_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'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'PlayerMatchupsStats'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"PlayersApi.get_player_statistics_matchups",
    :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: PlayersApi#get_player_statistics_matchups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_player_statistics_opponents(player_id, opts = {}) ⇒ PlayerOpponentsStats

Parameters:

  • player_id (String) —

    Player ID

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

    the optional parameters

Options Hash (opts):

  • :count (Integer)

Returns:



341
342
343
344
 
# File 'lib/stormgate_world/api/players_api.rb', line 341

def get_player_statistics_opponents(player_id, opts = {})
  data, _status_code, _headers = get_player_statistics_opponents_with_http_info(player_id, opts)
  data
end

#get_player_statistics_opponents_with_http_info(player_id, opts = {}) ⇒ Array<(PlayerOpponentsStats, Integer, Hash)>

Returns PlayerOpponentsStats data, response status code and response headers.

Parameters:

  • player_id (String) —

    Player ID

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

    the optional parameters

Options Hash (opts):

  • :count (Integer)

Returns:

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

    PlayerOpponentsStats data, response status code and response headers



350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
 
# File 'lib/stormgate_world/api/players_api.rb', line 350

def get_player_statistics_opponents_with_http_info(player_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlayersApi.get_player_statistics_opponents ...'
  end
  # verify the required parameter 'player_id' is set
  if @api_client.config.client_side_validation && player_id.nil?
    fail ArgumentError, "Missing the required parameter 'player_id' when calling PlayersApi.get_player_statistics_opponents"
  end
  if @api_client.config.client_side_validation && !opts[:'count'].nil? && opts[:'count'] < 0
    fail ArgumentError, 'invalid value for "opts[:"count"]" when calling PlayersApi.get_player_statistics_opponents, must be greater than or equal to 0.'
  end

  # resource path
  local_var_path = '/v0/players/{player_id}/statistics/opponents'.sub('{' + 'player_id' + '}', CGI.escape(player_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'PlayerOpponentsStats'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"PlayersApi.get_player_statistics_opponents",
    :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: PlayersApi#get_player_statistics_opponents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_player_with_http_info(player_id, opts = {}) ⇒ Array<(PlayerResponse, Integer, Hash)>

Returns PlayerResponse data, response status code and response headers.

Parameters:

  • player_id (String) —

    Player ID

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

    the optional parameters

Returns:

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

    PlayerResponse data, response status code and response headers



33
34
35
36
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
 
# File 'lib/stormgate_world/api/players_api.rb', line 33

def get_player_with_http_info(player_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlayersApi.get_player ...'
  end
  # verify the required parameter 'player_id' is set
  if @api_client.config.client_side_validation && player_id.nil?
    fail ArgumentError, "Missing the required parameter 'player_id' when calling PlayersApi.get_player"
  end
  # resource path
  local_var_path = '/v0/players/{player_id}'.sub('{' + 'player_id' + '}', CGI.escape(player_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'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'PlayerResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"PlayersApi.get_player",
    :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: PlayersApi#get_player\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end