stormgate_world 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (137) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +9 -0
  3. data/README.md +141 -0
  4. data/Rakefile +10 -0
  5. data/docs/ErrorResponse.md +26 -0
  6. data/docs/Leaderboard.md +15 -0
  7. data/docs/LeaderboardDumpResponse.md +22 -0
  8. data/docs/LeaderboardEntriesApi.md +70 -0
  9. data/docs/LeaderboardEntryHistory.md +18 -0
  10. data/docs/LeaderboardEntryHistoryEntry.md +24 -0
  11. data/docs/LeaderboardEntryResponse.md +52 -0
  12. data/docs/LeaderboardOrder.md +15 -0
  13. data/docs/LeaderboardResponse.md +24 -0
  14. data/docs/LeaderboardsApi.md +140 -0
  15. data/docs/MatchParticipantPlayerLeaderboardEntryResponse.md +32 -0
  16. data/docs/MatchParticipantPlayerResponse.md +22 -0
  17. data/docs/MatchParticipantResponse.md +38 -0
  18. data/docs/MatchResponse.md +34 -0
  19. data/docs/MatchResult.md +15 -0
  20. data/docs/MatchState.md +15 -0
  21. data/docs/MatchesApi.md +76 -0
  22. data/docs/MatchesResponse.md +24 -0
  23. data/docs/PlayerActivityStats.md +24 -0
  24. data/docs/PlayerActivityStatsRace.md +20 -0
  25. data/docs/PlayerMatchesResponse.md +22 -0
  26. data/docs/PlayerMatchupsStats.md +20 -0
  27. data/docs/PlayerMatchupsStatsEntry.md +34 -0
  28. data/docs/PlayerMatchupsStatsMatchup.md +24 -0
  29. data/docs/PlayerOpponentsStats.md +22 -0
  30. data/docs/PlayerOpponentsStatsOpponent.md +34 -0
  31. data/docs/PlayerPreferences.md +18 -0
  32. data/docs/PlayerResponse.md +28 -0
  33. data/docs/PlayerStatsEntry.md +36 -0
  34. data/docs/PlayerStatsEntryAggregated.md +34 -0
  35. data/docs/PlayerStatsEntryNumBreakdown.md +24 -0
  36. data/docs/PlayersApi.md +531 -0
  37. data/docs/ProfilePrivacy.md +15 -0
  38. data/docs/Race.md +15 -0
  39. data/docs/StatisticsApi.md +72 -0
  40. data/docs/StatsByTime.md +30 -0
  41. data/docs/StatsByTimeEntry.md +22 -0
  42. data/docs/StatsByTimeHistoryPoint.md +34 -0
  43. data/docs/StatsByTimeMatchLength.md +20 -0
  44. data/docs/StatsByTimeMatchLengthEntry.md +28 -0
  45. data/git_push.sh +57 -0
  46. data/lib/stormgate_world/api/leaderboard_entries_api.rb +81 -0
  47. data/lib/stormgate_world/api/leaderboards_api.rb +151 -0
  48. data/lib/stormgate_world/api/matches_api.rb +92 -0
  49. data/lib/stormgate_world/api/players_api.rb +512 -0
  50. data/lib/stormgate_world/api/statistics_api.rb +78 -0
  51. data/lib/stormgate_world/api_client.rb +394 -0
  52. data/lib/stormgate_world/api_error.rb +58 -0
  53. data/lib/stormgate_world/configuration.rb +298 -0
  54. data/lib/stormgate_world/models/error_response.rb +289 -0
  55. data/lib/stormgate_world/models/leaderboard.rb +41 -0
  56. data/lib/stormgate_world/models/leaderboard_dump_response.rb +274 -0
  57. data/lib/stormgate_world/models/leaderboard_entry_history.rb +223 -0
  58. data/lib/stormgate_world/models/leaderboard_entry_history_entry.rb +257 -0
  59. data/lib/stormgate_world/models/leaderboard_entry_response.rb +461 -0
  60. data/lib/stormgate_world/models/leaderboard_order.rb +40 -0
  61. data/lib/stormgate_world/models/leaderboard_response.rb +328 -0
  62. data/lib/stormgate_world/models/match_participant_player_leaderboard_entry_response.rb +309 -0
  63. data/lib/stormgate_world/models/match_participant_player_response.rb +241 -0
  64. data/lib/stormgate_world/models/match_participant_response.rb +361 -0
  65. data/lib/stormgate_world/models/match_response.rb +355 -0
  66. data/lib/stormgate_world/models/match_result.rb +41 -0
  67. data/lib/stormgate_world/models/match_state.rb +40 -0
  68. data/lib/stormgate_world/models/matches_response.rb +328 -0
  69. data/lib/stormgate_world/models/player_activity_stats.rb +267 -0
  70. data/lib/stormgate_world/models/player_activity_stats_race.rb +233 -0
  71. data/lib/stormgate_world/models/player_matches_response.rb +293 -0
  72. data/lib/stormgate_world/models/player_matchups_stats.rb +239 -0
  73. data/lib/stormgate_world/models/player_matchups_stats_entry.rb +337 -0
  74. data/lib/stormgate_world/models/player_matchups_stats_matchup.rb +293 -0
  75. data/lib/stormgate_world/models/player_opponents_stats.rb +274 -0
  76. data/lib/stormgate_world/models/player_opponents_stats_opponent.rb +343 -0
  77. data/lib/stormgate_world/models/player_preferences.rb +237 -0
  78. data/lib/stormgate_world/models/player_response.rb +285 -0
  79. data/lib/stormgate_world/models/player_stats_entry.rb +369 -0
  80. data/lib/stormgate_world/models/player_stats_entry_aggregated.rb +343 -0
  81. data/lib/stormgate_world/models/player_stats_entry_num_breakdown.rb +245 -0
  82. data/lib/stormgate_world/models/profile_privacy.rb +40 -0
  83. data/lib/stormgate_world/models/race.rb +41 -0
  84. data/lib/stormgate_world/models/stats_by_time.rb +332 -0
  85. data/lib/stormgate_world/models/stats_by_time_entry.rb +277 -0
  86. data/lib/stormgate_world/models/stats_by_time_history_point.rb +303 -0
  87. data/lib/stormgate_world/models/stats_by_time_match_length.rb +239 -0
  88. data/lib/stormgate_world/models/stats_by_time_match_length_entry.rb +265 -0
  89. data/lib/stormgate_world/version.rb +15 -0
  90. data/lib/stormgate_world.rb +79 -0
  91. data/openapitools.json +7 -0
  92. data/pkg/stormgate_world_client-1.0.0.gem +0 -0
  93. data/spec/api/leaderboard_entries_api_spec.rb +45 -0
  94. data/spec/api/leaderboards_api_spec.rb +58 -0
  95. data/spec/api/matches_api_spec.rb +47 -0
  96. data/spec/api/players_api_spec.rb +117 -0
  97. data/spec/api/statistics_api_spec.rb +45 -0
  98. data/spec/models/error_response_spec.rb +60 -0
  99. data/spec/models/leaderboard_dump_response_spec.rb +48 -0
  100. data/spec/models/leaderboard_entry_history_entry_spec.rb +54 -0
  101. data/spec/models/leaderboard_entry_history_spec.rb +36 -0
  102. data/spec/models/leaderboard_entry_response_spec.rb +138 -0
  103. data/spec/models/leaderboard_order_spec.rb +30 -0
  104. data/spec/models/leaderboard_response_spec.rb +54 -0
  105. data/spec/models/leaderboard_spec.rb +30 -0
  106. data/spec/models/match_participant_player_leaderboard_entry_response_spec.rb +78 -0
  107. data/spec/models/match_participant_player_response_spec.rb +48 -0
  108. data/spec/models/match_participant_response_spec.rb +96 -0
  109. data/spec/models/match_response_spec.rb +84 -0
  110. data/spec/models/match_result_spec.rb +30 -0
  111. data/spec/models/match_state_spec.rb +30 -0
  112. data/spec/models/matches_response_spec.rb +54 -0
  113. data/spec/models/player_activity_stats_race_spec.rb +42 -0
  114. data/spec/models/player_activity_stats_spec.rb +54 -0
  115. data/spec/models/player_matches_response_spec.rb +48 -0
  116. data/spec/models/player_matchups_stats_entry_spec.rb +84 -0
  117. data/spec/models/player_matchups_stats_matchup_spec.rb +54 -0
  118. data/spec/models/player_matchups_stats_spec.rb +42 -0
  119. data/spec/models/player_opponents_stats_opponent_spec.rb +84 -0
  120. data/spec/models/player_opponents_stats_spec.rb +48 -0
  121. data/spec/models/player_preferences_spec.rb +36 -0
  122. data/spec/models/player_response_spec.rb +66 -0
  123. data/spec/models/player_stats_entry_aggregated_spec.rb +84 -0
  124. data/spec/models/player_stats_entry_num_breakdown_spec.rb +54 -0
  125. data/spec/models/player_stats_entry_spec.rb +90 -0
  126. data/spec/models/profile_privacy_spec.rb +30 -0
  127. data/spec/models/race_spec.rb +30 -0
  128. data/spec/models/stats_by_time_entry_spec.rb +48 -0
  129. data/spec/models/stats_by_time_history_point_spec.rb +84 -0
  130. data/spec/models/stats_by_time_match_length_entry_spec.rb +66 -0
  131. data/spec/models/stats_by_time_match_length_spec.rb +42 -0
  132. data/spec/models/stats_by_time_spec.rb +72 -0
  133. data/spec/spec_helper.rb +111 -0
  134. data/stormgate_world.gemspec +40 -0
  135. data/stormgate_world.json +1 -0
  136. data/update.sh +4 -0
  137. metadata +260 -0
@@ -0,0 +1,531 @@
1
+ # StormgateWorld::PlayersApi
2
+
3
+ All URIs are relative to *https://api.stormgateworld.com*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**get_player**](PlayersApi.md#get_player) | **GET** /v0/players/{player_id} | |
8
+ | [**get_player_last_match**](PlayersApi.md#get_player_last_match) | **GET** /v0/players/{player_id}/matches/last | |
9
+ | [**get_player_matches**](PlayersApi.md#get_player_matches) | **GET** /v0/players/{player_id}/matches | |
10
+ | [**get_player_preferences**](PlayersApi.md#get_player_preferences) | **GET** /v0/players/{player_id}/preferences | |
11
+ | [**get_player_statistics_activity**](PlayersApi.md#get_player_statistics_activity) | **GET** /v0/players/{player_id}/statistics/activity | |
12
+ | [**get_player_statistics_matchups**](PlayersApi.md#get_player_statistics_matchups) | **GET** /v0/players/{player_id}/statistics/matchups | |
13
+ | [**get_player_statistics_opponents**](PlayersApi.md#get_player_statistics_opponents) | **GET** /v0/players/{player_id}/statistics/opponents | |
14
+ | [**update_player_preferences**](PlayersApi.md#update_player_preferences) | **PUT** /v0/players/{player_id}/preferences | |
15
+
16
+
17
+ ## get_player
18
+
19
+ > <PlayerResponse> get_player(player_id)
20
+
21
+
22
+
23
+ ### Examples
24
+
25
+ ```ruby
26
+ require 'time'
27
+ require 'stormgate_world'
28
+
29
+ api_instance = StormgateWorld::PlayersApi.new
30
+ player_id = 'player_id_example' # String | Player ID
31
+
32
+ begin
33
+
34
+ result = api_instance.get_player(player_id)
35
+ p result
36
+ rescue StormgateWorld::ApiError => e
37
+ puts "Error when calling PlayersApi->get_player: #{e}"
38
+ end
39
+ ```
40
+
41
+ #### Using the get_player_with_http_info variant
42
+
43
+ This returns an Array which contains the response data, status code and headers.
44
+
45
+ > <Array(<PlayerResponse>, Integer, Hash)> get_player_with_http_info(player_id)
46
+
47
+ ```ruby
48
+ begin
49
+
50
+ data, status_code, headers = api_instance.get_player_with_http_info(player_id)
51
+ p status_code # => 2xx
52
+ p headers # => { ... }
53
+ p data # => <PlayerResponse>
54
+ rescue StormgateWorld::ApiError => e
55
+ puts "Error when calling PlayersApi->get_player_with_http_info: #{e}"
56
+ end
57
+ ```
58
+
59
+ ### Parameters
60
+
61
+ | Name | Type | Description | Notes |
62
+ | ---- | ---- | ----------- | ----- |
63
+ | **player_id** | **String** | Player ID | |
64
+
65
+ ### Return type
66
+
67
+ [**PlayerResponse**](PlayerResponse.md)
68
+
69
+ ### Authorization
70
+
71
+ No authorization required
72
+
73
+ ### HTTP request headers
74
+
75
+ - **Content-Type**: Not defined
76
+ - **Accept**: application/json
77
+
78
+
79
+ ## get_player_last_match
80
+
81
+ > <MatchResponse> get_player_last_match(player_id)
82
+
83
+
84
+
85
+ ### Examples
86
+
87
+ ```ruby
88
+ require 'time'
89
+ require 'stormgate_world'
90
+
91
+ api_instance = StormgateWorld::PlayersApi.new
92
+ player_id = 'player_id_example' # String | Player ID
93
+
94
+ begin
95
+
96
+ result = api_instance.get_player_last_match(player_id)
97
+ p result
98
+ rescue StormgateWorld::ApiError => e
99
+ puts "Error when calling PlayersApi->get_player_last_match: #{e}"
100
+ end
101
+ ```
102
+
103
+ #### Using the get_player_last_match_with_http_info variant
104
+
105
+ This returns an Array which contains the response data, status code and headers.
106
+
107
+ > <Array(<MatchResponse>, Integer, Hash)> get_player_last_match_with_http_info(player_id)
108
+
109
+ ```ruby
110
+ begin
111
+
112
+ data, status_code, headers = api_instance.get_player_last_match_with_http_info(player_id)
113
+ p status_code # => 2xx
114
+ p headers # => { ... }
115
+ p data # => <MatchResponse>
116
+ rescue StormgateWorld::ApiError => e
117
+ puts "Error when calling PlayersApi->get_player_last_match_with_http_info: #{e}"
118
+ end
119
+ ```
120
+
121
+ ### Parameters
122
+
123
+ | Name | Type | Description | Notes |
124
+ | ---- | ---- | ----------- | ----- |
125
+ | **player_id** | **String** | Player ID | |
126
+
127
+ ### Return type
128
+
129
+ [**MatchResponse**](MatchResponse.md)
130
+
131
+ ### Authorization
132
+
133
+ No authorization required
134
+
135
+ ### HTTP request headers
136
+
137
+ - **Content-Type**: Not defined
138
+ - **Accept**: application/json
139
+
140
+
141
+ ## get_player_matches
142
+
143
+ > <PlayerMatchesResponse> get_player_matches(player_id)
144
+
145
+
146
+
147
+ ### Examples
148
+
149
+ ```ruby
150
+ require 'time'
151
+ require 'stormgate_world'
152
+
153
+ api_instance = StormgateWorld::PlayersApi.new
154
+ player_id = 'player_id_example' # String | Player ID
155
+
156
+ begin
157
+
158
+ result = api_instance.get_player_matches(player_id)
159
+ p result
160
+ rescue StormgateWorld::ApiError => e
161
+ puts "Error when calling PlayersApi->get_player_matches: #{e}"
162
+ end
163
+ ```
164
+
165
+ #### Using the get_player_matches_with_http_info variant
166
+
167
+ This returns an Array which contains the response data, status code and headers.
168
+
169
+ > <Array(<PlayerMatchesResponse>, Integer, Hash)> get_player_matches_with_http_info(player_id)
170
+
171
+ ```ruby
172
+ begin
173
+
174
+ data, status_code, headers = api_instance.get_player_matches_with_http_info(player_id)
175
+ p status_code # => 2xx
176
+ p headers # => { ... }
177
+ p data # => <PlayerMatchesResponse>
178
+ rescue StormgateWorld::ApiError => e
179
+ puts "Error when calling PlayersApi->get_player_matches_with_http_info: #{e}"
180
+ end
181
+ ```
182
+
183
+ ### Parameters
184
+
185
+ | Name | Type | Description | Notes |
186
+ | ---- | ---- | ----------- | ----- |
187
+ | **player_id** | **String** | Player ID | |
188
+
189
+ ### Return type
190
+
191
+ [**PlayerMatchesResponse**](PlayerMatchesResponse.md)
192
+
193
+ ### Authorization
194
+
195
+ No authorization required
196
+
197
+ ### HTTP request headers
198
+
199
+ - **Content-Type**: Not defined
200
+ - **Accept**: application/json
201
+
202
+
203
+ ## get_player_preferences
204
+
205
+ > <PlayerPreferences> get_player_preferences(player_id)
206
+
207
+
208
+
209
+ ### Examples
210
+
211
+ ```ruby
212
+ require 'time'
213
+ require 'stormgate_world'
214
+ # setup authorization
215
+ StormgateWorld.configure do |config|
216
+ # Configure API key authorization: api_key
217
+ config.api_key['api_key'] = 'YOUR API KEY'
218
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
219
+ # config.api_key_prefix['api_key'] = 'Bearer'
220
+ end
221
+
222
+ api_instance = StormgateWorld::PlayersApi.new
223
+ player_id = 'player_id_example' # String | Player ID
224
+
225
+ begin
226
+
227
+ result = api_instance.get_player_preferences(player_id)
228
+ p result
229
+ rescue StormgateWorld::ApiError => e
230
+ puts "Error when calling PlayersApi->get_player_preferences: #{e}"
231
+ end
232
+ ```
233
+
234
+ #### Using the get_player_preferences_with_http_info variant
235
+
236
+ This returns an Array which contains the response data, status code and headers.
237
+
238
+ > <Array(<PlayerPreferences>, Integer, Hash)> get_player_preferences_with_http_info(player_id)
239
+
240
+ ```ruby
241
+ begin
242
+
243
+ data, status_code, headers = api_instance.get_player_preferences_with_http_info(player_id)
244
+ p status_code # => 2xx
245
+ p headers # => { ... }
246
+ p data # => <PlayerPreferences>
247
+ rescue StormgateWorld::ApiError => e
248
+ puts "Error when calling PlayersApi->get_player_preferences_with_http_info: #{e}"
249
+ end
250
+ ```
251
+
252
+ ### Parameters
253
+
254
+ | Name | Type | Description | Notes |
255
+ | ---- | ---- | ----------- | ----- |
256
+ | **player_id** | **String** | Player ID | |
257
+
258
+ ### Return type
259
+
260
+ [**PlayerPreferences**](PlayerPreferences.md)
261
+
262
+ ### Authorization
263
+
264
+ [api_key](../README.md#api_key)
265
+
266
+ ### HTTP request headers
267
+
268
+ - **Content-Type**: Not defined
269
+ - **Accept**: application/json
270
+
271
+
272
+ ## get_player_statistics_activity
273
+
274
+ > <PlayerActivityStats> get_player_statistics_activity(player_id)
275
+
276
+
277
+
278
+ ### Examples
279
+
280
+ ```ruby
281
+ require 'time'
282
+ require 'stormgate_world'
283
+
284
+ api_instance = StormgateWorld::PlayersApi.new
285
+ player_id = 'player_id_example' # String | Player ID
286
+
287
+ begin
288
+
289
+ result = api_instance.get_player_statistics_activity(player_id)
290
+ p result
291
+ rescue StormgateWorld::ApiError => e
292
+ puts "Error when calling PlayersApi->get_player_statistics_activity: #{e}"
293
+ end
294
+ ```
295
+
296
+ #### Using the get_player_statistics_activity_with_http_info variant
297
+
298
+ This returns an Array which contains the response data, status code and headers.
299
+
300
+ > <Array(<PlayerActivityStats>, Integer, Hash)> get_player_statistics_activity_with_http_info(player_id)
301
+
302
+ ```ruby
303
+ begin
304
+
305
+ data, status_code, headers = api_instance.get_player_statistics_activity_with_http_info(player_id)
306
+ p status_code # => 2xx
307
+ p headers # => { ... }
308
+ p data # => <PlayerActivityStats>
309
+ rescue StormgateWorld::ApiError => e
310
+ puts "Error when calling PlayersApi->get_player_statistics_activity_with_http_info: #{e}"
311
+ end
312
+ ```
313
+
314
+ ### Parameters
315
+
316
+ | Name | Type | Description | Notes |
317
+ | ---- | ---- | ----------- | ----- |
318
+ | **player_id** | **String** | Player ID | |
319
+
320
+ ### Return type
321
+
322
+ [**PlayerActivityStats**](PlayerActivityStats.md)
323
+
324
+ ### Authorization
325
+
326
+ No authorization required
327
+
328
+ ### HTTP request headers
329
+
330
+ - **Content-Type**: Not defined
331
+ - **Accept**: application/json
332
+
333
+
334
+ ## get_player_statistics_matchups
335
+
336
+ > <PlayerMatchupsStats> get_player_statistics_matchups(player_id)
337
+
338
+
339
+
340
+ ### Examples
341
+
342
+ ```ruby
343
+ require 'time'
344
+ require 'stormgate_world'
345
+
346
+ api_instance = StormgateWorld::PlayersApi.new
347
+ player_id = 'player_id_example' # String | Player ID
348
+
349
+ begin
350
+
351
+ result = api_instance.get_player_statistics_matchups(player_id)
352
+ p result
353
+ rescue StormgateWorld::ApiError => e
354
+ puts "Error when calling PlayersApi->get_player_statistics_matchups: #{e}"
355
+ end
356
+ ```
357
+
358
+ #### Using the get_player_statistics_matchups_with_http_info variant
359
+
360
+ This returns an Array which contains the response data, status code and headers.
361
+
362
+ > <Array(<PlayerMatchupsStats>, Integer, Hash)> get_player_statistics_matchups_with_http_info(player_id)
363
+
364
+ ```ruby
365
+ begin
366
+
367
+ data, status_code, headers = api_instance.get_player_statistics_matchups_with_http_info(player_id)
368
+ p status_code # => 2xx
369
+ p headers # => { ... }
370
+ p data # => <PlayerMatchupsStats>
371
+ rescue StormgateWorld::ApiError => e
372
+ puts "Error when calling PlayersApi->get_player_statistics_matchups_with_http_info: #{e}"
373
+ end
374
+ ```
375
+
376
+ ### Parameters
377
+
378
+ | Name | Type | Description | Notes |
379
+ | ---- | ---- | ----------- | ----- |
380
+ | **player_id** | **String** | Player ID | |
381
+
382
+ ### Return type
383
+
384
+ [**PlayerMatchupsStats**](PlayerMatchupsStats.md)
385
+
386
+ ### Authorization
387
+
388
+ No authorization required
389
+
390
+ ### HTTP request headers
391
+
392
+ - **Content-Type**: Not defined
393
+ - **Accept**: application/json
394
+
395
+
396
+ ## get_player_statistics_opponents
397
+
398
+ > <PlayerOpponentsStats> get_player_statistics_opponents(player_id, opts)
399
+
400
+
401
+
402
+ ### Examples
403
+
404
+ ```ruby
405
+ require 'time'
406
+ require 'stormgate_world'
407
+
408
+ api_instance = StormgateWorld::PlayersApi.new
409
+ player_id = 'player_id_example' # String | Player ID
410
+ opts = {
411
+ count: 789 # Integer |
412
+ }
413
+
414
+ begin
415
+
416
+ result = api_instance.get_player_statistics_opponents(player_id, opts)
417
+ p result
418
+ rescue StormgateWorld::ApiError => e
419
+ puts "Error when calling PlayersApi->get_player_statistics_opponents: #{e}"
420
+ end
421
+ ```
422
+
423
+ #### Using the get_player_statistics_opponents_with_http_info variant
424
+
425
+ This returns an Array which contains the response data, status code and headers.
426
+
427
+ > <Array(<PlayerOpponentsStats>, Integer, Hash)> get_player_statistics_opponents_with_http_info(player_id, opts)
428
+
429
+ ```ruby
430
+ begin
431
+
432
+ data, status_code, headers = api_instance.get_player_statistics_opponents_with_http_info(player_id, opts)
433
+ p status_code # => 2xx
434
+ p headers # => { ... }
435
+ p data # => <PlayerOpponentsStats>
436
+ rescue StormgateWorld::ApiError => e
437
+ puts "Error when calling PlayersApi->get_player_statistics_opponents_with_http_info: #{e}"
438
+ end
439
+ ```
440
+
441
+ ### Parameters
442
+
443
+ | Name | Type | Description | Notes |
444
+ | ---- | ---- | ----------- | ----- |
445
+ | **player_id** | **String** | Player ID | |
446
+ | **count** | **Integer** | | [optional] |
447
+
448
+ ### Return type
449
+
450
+ [**PlayerOpponentsStats**](PlayerOpponentsStats.md)
451
+
452
+ ### Authorization
453
+
454
+ No authorization required
455
+
456
+ ### HTTP request headers
457
+
458
+ - **Content-Type**: Not defined
459
+ - **Accept**: application/json
460
+
461
+
462
+ ## update_player_preferences
463
+
464
+ > <PlayerPreferences> update_player_preferences(player_id, player_preferences)
465
+
466
+
467
+
468
+ ### Examples
469
+
470
+ ```ruby
471
+ require 'time'
472
+ require 'stormgate_world'
473
+ # setup authorization
474
+ StormgateWorld.configure do |config|
475
+ # Configure API key authorization: api_key
476
+ config.api_key['api_key'] = 'YOUR API KEY'
477
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
478
+ # config.api_key_prefix['api_key'] = 'Bearer'
479
+ end
480
+
481
+ api_instance = StormgateWorld::PlayersApi.new
482
+ player_id = 'player_id_example' # String | Player ID
483
+ player_preferences = StormgateWorld::PlayerPreferences.new # PlayerPreferences |
484
+
485
+ begin
486
+
487
+ result = api_instance.update_player_preferences(player_id, player_preferences)
488
+ p result
489
+ rescue StormgateWorld::ApiError => e
490
+ puts "Error when calling PlayersApi->update_player_preferences: #{e}"
491
+ end
492
+ ```
493
+
494
+ #### Using the update_player_preferences_with_http_info variant
495
+
496
+ This returns an Array which contains the response data, status code and headers.
497
+
498
+ > <Array(<PlayerPreferences>, Integer, Hash)> update_player_preferences_with_http_info(player_id, player_preferences)
499
+
500
+ ```ruby
501
+ begin
502
+
503
+ data, status_code, headers = api_instance.update_player_preferences_with_http_info(player_id, player_preferences)
504
+ p status_code # => 2xx
505
+ p headers # => { ... }
506
+ p data # => <PlayerPreferences>
507
+ rescue StormgateWorld::ApiError => e
508
+ puts "Error when calling PlayersApi->update_player_preferences_with_http_info: #{e}"
509
+ end
510
+ ```
511
+
512
+ ### Parameters
513
+
514
+ | Name | Type | Description | Notes |
515
+ | ---- | ---- | ----------- | ----- |
516
+ | **player_id** | **String** | Player ID | |
517
+ | **player_preferences** | [**PlayerPreferences**](PlayerPreferences.md) | | |
518
+
519
+ ### Return type
520
+
521
+ [**PlayerPreferences**](PlayerPreferences.md)
522
+
523
+ ### Authorization
524
+
525
+ [api_key](../README.md#api_key)
526
+
527
+ ### HTTP request headers
528
+
529
+ - **Content-Type**: application/json
530
+ - **Accept**: application/json
531
+
@@ -0,0 +1,15 @@
1
+ # StormgateWorld::ProfilePrivacy
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+
8
+ ## Example
9
+
10
+ ```ruby
11
+ require 'stormgate_world'
12
+
13
+ instance = StormgateWorld::ProfilePrivacy.new()
14
+ ```
15
+
data/docs/Race.md ADDED
@@ -0,0 +1,15 @@
1
+ # StormgateWorld::Race
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+
8
+ ## Example
9
+
10
+ ```ruby
11
+ require 'stormgate_world'
12
+
13
+ instance = StormgateWorld::Race.new()
14
+ ```
15
+
@@ -0,0 +1,72 @@
1
+ # StormgateWorld::StatisticsApi
2
+
3
+ All URIs are relative to *https://api.stormgateworld.com*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**get_statistics**](StatisticsApi.md#get_statistics) | **GET** /v0/statistics/ranked_1v1 | |
8
+
9
+
10
+ ## get_statistics
11
+
12
+ > <StatsByTime> get_statistics(opts)
13
+
14
+
15
+
16
+ ### Examples
17
+
18
+ ```ruby
19
+ require 'time'
20
+ require 'stormgate_world'
21
+
22
+ api_instance = StormgateWorld::StatisticsApi.new
23
+ opts = {
24
+ league: 'league_example' # String |
25
+ }
26
+
27
+ begin
28
+
29
+ result = api_instance.get_statistics(opts)
30
+ p result
31
+ rescue StormgateWorld::ApiError => e
32
+ puts "Error when calling StatisticsApi->get_statistics: #{e}"
33
+ end
34
+ ```
35
+
36
+ #### Using the get_statistics_with_http_info variant
37
+
38
+ This returns an Array which contains the response data, status code and headers.
39
+
40
+ > <Array(<StatsByTime>, Integer, Hash)> get_statistics_with_http_info(opts)
41
+
42
+ ```ruby
43
+ begin
44
+
45
+ data, status_code, headers = api_instance.get_statistics_with_http_info(opts)
46
+ p status_code # => 2xx
47
+ p headers # => { ... }
48
+ p data # => <StatsByTime>
49
+ rescue StormgateWorld::ApiError => e
50
+ puts "Error when calling StatisticsApi->get_statistics_with_http_info: #{e}"
51
+ end
52
+ ```
53
+
54
+ ### Parameters
55
+
56
+ | Name | Type | Description | Notes |
57
+ | ---- | ---- | ----------- | ----- |
58
+ | **league** | **String** | | [optional] |
59
+
60
+ ### Return type
61
+
62
+ [**StatsByTime**](StatsByTime.md)
63
+
64
+ ### Authorization
65
+
66
+ No authorization required
67
+
68
+ ### HTTP request headers
69
+
70
+ - **Content-Type**: Not defined
71
+ - **Accept**: application/json
72
+
@@ -0,0 +1,30 @@
1
+ # StormgateWorld::StatsByTime
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **cached_at** | **Time** | | |
8
+ | **updated_at** | **Time** | | |
9
+ | **period** | **String** | | |
10
+ | **count** | **Integer** | | |
11
+ | **league** | **String** | | [optional] |
12
+ | **races** | [**Array&lt;StatsByTimeEntry&gt;**](StatsByTimeEntry.md) | | |
13
+ | **match_length** | [**StatsByTimeMatchLength**](StatsByTimeMatchLength.md) | | |
14
+
15
+ ## Example
16
+
17
+ ```ruby
18
+ require 'stormgate_world'
19
+
20
+ instance = StormgateWorld::StatsByTime.new(
21
+ cached_at: null,
22
+ updated_at: null,
23
+ period: null,
24
+ count: null,
25
+ league: null,
26
+ races: null,
27
+ match_length: null
28
+ )
29
+ ```
30
+
@@ -0,0 +1,22 @@
1
+ # StormgateWorld::StatsByTimeEntry
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **race** | [**Race**](Race.md) | | |
8
+ | **aggregated** | [**StatsByTimeHistoryPoint**](StatsByTimeHistoryPoint.md) | | |
9
+ | **history** | [**Array&lt;StatsByTimeHistoryPoint&gt;**](StatsByTimeHistoryPoint.md) | | |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'stormgate_world'
15
+
16
+ instance = StormgateWorld::StatsByTimeEntry.new(
17
+ race: null,
18
+ aggregated: null,
19
+ history: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,34 @@
1
+ # StormgateWorld::StatsByTimeHistoryPoint
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **date** | **Date** | | [optional] |
8
+ | **win_rate** | **Float** | | [optional] |
9
+ | **win_rate_by_match_length** | **Hash&lt;String, Float&gt;** | | |
10
+ | **pick_rate** | **Float** | | [optional] |
11
+ | **players_count** | **Integer** | | [optional] |
12
+ | **matches_count** | **Integer** | | [optional] |
13
+ | **wins_count** | **Integer** | | [optional] |
14
+ | **losses_count** | **Integer** | | [optional] |
15
+ | **matches_count_with_mirror** | **Integer** | | [optional] |
16
+
17
+ ## Example
18
+
19
+ ```ruby
20
+ require 'stormgate_world'
21
+
22
+ instance = StormgateWorld::StatsByTimeHistoryPoint.new(
23
+ date: null,
24
+ win_rate: null,
25
+ win_rate_by_match_length: null,
26
+ pick_rate: null,
27
+ players_count: null,
28
+ matches_count: null,
29
+ wins_count: null,
30
+ losses_count: null,
31
+ matches_count_with_mirror: null
32
+ )
33
+ ```
34
+