stormgate_world 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/Gemfile +9 -0
- data/README.md +141 -0
- data/Rakefile +10 -0
- data/docs/ErrorResponse.md +26 -0
- data/docs/Leaderboard.md +15 -0
- data/docs/LeaderboardDumpResponse.md +22 -0
- data/docs/LeaderboardEntriesApi.md +70 -0
- data/docs/LeaderboardEntryHistory.md +18 -0
- data/docs/LeaderboardEntryHistoryEntry.md +24 -0
- data/docs/LeaderboardEntryResponse.md +52 -0
- data/docs/LeaderboardOrder.md +15 -0
- data/docs/LeaderboardResponse.md +24 -0
- data/docs/LeaderboardsApi.md +140 -0
- data/docs/MatchParticipantPlayerLeaderboardEntryResponse.md +32 -0
- data/docs/MatchParticipantPlayerResponse.md +22 -0
- data/docs/MatchParticipantResponse.md +38 -0
- data/docs/MatchResponse.md +34 -0
- data/docs/MatchResult.md +15 -0
- data/docs/MatchState.md +15 -0
- data/docs/MatchesApi.md +76 -0
- data/docs/MatchesResponse.md +24 -0
- data/docs/PlayerActivityStats.md +24 -0
- data/docs/PlayerActivityStatsRace.md +20 -0
- data/docs/PlayerMatchesResponse.md +22 -0
- data/docs/PlayerMatchupsStats.md +20 -0
- data/docs/PlayerMatchupsStatsEntry.md +34 -0
- data/docs/PlayerMatchupsStatsMatchup.md +24 -0
- data/docs/PlayerOpponentsStats.md +22 -0
- data/docs/PlayerOpponentsStatsOpponent.md +34 -0
- data/docs/PlayerPreferences.md +18 -0
- data/docs/PlayerResponse.md +28 -0
- data/docs/PlayerStatsEntry.md +36 -0
- data/docs/PlayerStatsEntryAggregated.md +34 -0
- data/docs/PlayerStatsEntryNumBreakdown.md +24 -0
- data/docs/PlayersApi.md +531 -0
- data/docs/ProfilePrivacy.md +15 -0
- data/docs/Race.md +15 -0
- data/docs/StatisticsApi.md +72 -0
- data/docs/StatsByTime.md +30 -0
- data/docs/StatsByTimeEntry.md +22 -0
- data/docs/StatsByTimeHistoryPoint.md +34 -0
- data/docs/StatsByTimeMatchLength.md +20 -0
- data/docs/StatsByTimeMatchLengthEntry.md +28 -0
- data/git_push.sh +57 -0
- data/lib/stormgate_world/api/leaderboard_entries_api.rb +81 -0
- data/lib/stormgate_world/api/leaderboards_api.rb +151 -0
- data/lib/stormgate_world/api/matches_api.rb +92 -0
- data/lib/stormgate_world/api/players_api.rb +512 -0
- data/lib/stormgate_world/api/statistics_api.rb +78 -0
- data/lib/stormgate_world/api_client.rb +394 -0
- data/lib/stormgate_world/api_error.rb +58 -0
- data/lib/stormgate_world/configuration.rb +298 -0
- data/lib/stormgate_world/models/error_response.rb +289 -0
- data/lib/stormgate_world/models/leaderboard.rb +41 -0
- data/lib/stormgate_world/models/leaderboard_dump_response.rb +274 -0
- data/lib/stormgate_world/models/leaderboard_entry_history.rb +223 -0
- data/lib/stormgate_world/models/leaderboard_entry_history_entry.rb +257 -0
- data/lib/stormgate_world/models/leaderboard_entry_response.rb +461 -0
- data/lib/stormgate_world/models/leaderboard_order.rb +40 -0
- data/lib/stormgate_world/models/leaderboard_response.rb +328 -0
- data/lib/stormgate_world/models/match_participant_player_leaderboard_entry_response.rb +309 -0
- data/lib/stormgate_world/models/match_participant_player_response.rb +241 -0
- data/lib/stormgate_world/models/match_participant_response.rb +361 -0
- data/lib/stormgate_world/models/match_response.rb +355 -0
- data/lib/stormgate_world/models/match_result.rb +41 -0
- data/lib/stormgate_world/models/match_state.rb +40 -0
- data/lib/stormgate_world/models/matches_response.rb +328 -0
- data/lib/stormgate_world/models/player_activity_stats.rb +267 -0
- data/lib/stormgate_world/models/player_activity_stats_race.rb +233 -0
- data/lib/stormgate_world/models/player_matches_response.rb +293 -0
- data/lib/stormgate_world/models/player_matchups_stats.rb +239 -0
- data/lib/stormgate_world/models/player_matchups_stats_entry.rb +337 -0
- data/lib/stormgate_world/models/player_matchups_stats_matchup.rb +293 -0
- data/lib/stormgate_world/models/player_opponents_stats.rb +274 -0
- data/lib/stormgate_world/models/player_opponents_stats_opponent.rb +343 -0
- data/lib/stormgate_world/models/player_preferences.rb +237 -0
- data/lib/stormgate_world/models/player_response.rb +285 -0
- data/lib/stormgate_world/models/player_stats_entry.rb +369 -0
- data/lib/stormgate_world/models/player_stats_entry_aggregated.rb +343 -0
- data/lib/stormgate_world/models/player_stats_entry_num_breakdown.rb +245 -0
- data/lib/stormgate_world/models/profile_privacy.rb +40 -0
- data/lib/stormgate_world/models/race.rb +41 -0
- data/lib/stormgate_world/models/stats_by_time.rb +332 -0
- data/lib/stormgate_world/models/stats_by_time_entry.rb +277 -0
- data/lib/stormgate_world/models/stats_by_time_history_point.rb +303 -0
- data/lib/stormgate_world/models/stats_by_time_match_length.rb +239 -0
- data/lib/stormgate_world/models/stats_by_time_match_length_entry.rb +265 -0
- data/lib/stormgate_world/version.rb +15 -0
- data/lib/stormgate_world.rb +79 -0
- data/openapitools.json +7 -0
- data/pkg/stormgate_world_client-1.0.0.gem +0 -0
- data/spec/api/leaderboard_entries_api_spec.rb +45 -0
- data/spec/api/leaderboards_api_spec.rb +58 -0
- data/spec/api/matches_api_spec.rb +47 -0
- data/spec/api/players_api_spec.rb +117 -0
- data/spec/api/statistics_api_spec.rb +45 -0
- data/spec/models/error_response_spec.rb +60 -0
- data/spec/models/leaderboard_dump_response_spec.rb +48 -0
- data/spec/models/leaderboard_entry_history_entry_spec.rb +54 -0
- data/spec/models/leaderboard_entry_history_spec.rb +36 -0
- data/spec/models/leaderboard_entry_response_spec.rb +138 -0
- data/spec/models/leaderboard_order_spec.rb +30 -0
- data/spec/models/leaderboard_response_spec.rb +54 -0
- data/spec/models/leaderboard_spec.rb +30 -0
- data/spec/models/match_participant_player_leaderboard_entry_response_spec.rb +78 -0
- data/spec/models/match_participant_player_response_spec.rb +48 -0
- data/spec/models/match_participant_response_spec.rb +96 -0
- data/spec/models/match_response_spec.rb +84 -0
- data/spec/models/match_result_spec.rb +30 -0
- data/spec/models/match_state_spec.rb +30 -0
- data/spec/models/matches_response_spec.rb +54 -0
- data/spec/models/player_activity_stats_race_spec.rb +42 -0
- data/spec/models/player_activity_stats_spec.rb +54 -0
- data/spec/models/player_matches_response_spec.rb +48 -0
- data/spec/models/player_matchups_stats_entry_spec.rb +84 -0
- data/spec/models/player_matchups_stats_matchup_spec.rb +54 -0
- data/spec/models/player_matchups_stats_spec.rb +42 -0
- data/spec/models/player_opponents_stats_opponent_spec.rb +84 -0
- data/spec/models/player_opponents_stats_spec.rb +48 -0
- data/spec/models/player_preferences_spec.rb +36 -0
- data/spec/models/player_response_spec.rb +66 -0
- data/spec/models/player_stats_entry_aggregated_spec.rb +84 -0
- data/spec/models/player_stats_entry_num_breakdown_spec.rb +54 -0
- data/spec/models/player_stats_entry_spec.rb +90 -0
- data/spec/models/profile_privacy_spec.rb +30 -0
- data/spec/models/race_spec.rb +30 -0
- data/spec/models/stats_by_time_entry_spec.rb +48 -0
- data/spec/models/stats_by_time_history_point_spec.rb +84 -0
- data/spec/models/stats_by_time_match_length_entry_spec.rb +66 -0
- data/spec/models/stats_by_time_match_length_spec.rb +42 -0
- data/spec/models/stats_by_time_spec.rb +72 -0
- data/spec/spec_helper.rb +111 -0
- data/stormgate_world.gemspec +40 -0
- data/stormgate_world.json +1 -0
- data/update.sh +4 -0
- metadata +260 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 7d51bfbd44ae7b88b9471617c59a7131aac7398873c2fe1ba4358da0a337152f
|
4
|
+
data.tar.gz: 01c8e171ae53f1d98b8703e1f0cf8039fb3b784a537ae1733ceae5fa0e247d1c
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 9f6f486327c8c8df79961a5c4a2ca4e5ca0d53c02fb5b94fe736dac30fbb772c3141f5e1366204b12e045938f78cf655f08a6931f1c01cb622f2acb4f4c45081
|
7
|
+
data.tar.gz: d1898e40da9424640cbf7786af0fec80d2d1072637ed77993251eb860719402ea399366c85787eb40c2c234caf5c620ba68e275fcae9831f92da6db3e58bc518
|
data/Gemfile
ADDED
data/README.md
ADDED
@@ -0,0 +1,141 @@
|
|
1
|
+
# stormgate_world
|
2
|
+
|
3
|
+
StormgateWorld - the Ruby gem for the api
|
4
|
+
|
5
|
+
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
6
|
+
|
7
|
+
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
8
|
+
|
9
|
+
- API version: 0.1.1
|
10
|
+
- Package version: 1.0.0
|
11
|
+
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
12
|
+
|
13
|
+
## Installation
|
14
|
+
|
15
|
+
### Build a gem
|
16
|
+
|
17
|
+
To build the Ruby code into a gem:
|
18
|
+
|
19
|
+
```shell
|
20
|
+
gem build stormgate_world.gemspec
|
21
|
+
```
|
22
|
+
|
23
|
+
Then either install the gem locally:
|
24
|
+
|
25
|
+
```shell
|
26
|
+
gem install ./stormgate_world-1.0.0.gem
|
27
|
+
```
|
28
|
+
|
29
|
+
(for development, run `gem install --dev ./stormgate_world-1.0.0.gem` to install the development dependencies)
|
30
|
+
|
31
|
+
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
32
|
+
|
33
|
+
Finally add this to the Gemfile:
|
34
|
+
|
35
|
+
gem 'stormgate_world', '~> 1.0.0'
|
36
|
+
|
37
|
+
### Install from Git
|
38
|
+
|
39
|
+
If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
|
40
|
+
|
41
|
+
gem 'stormgate_world', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
|
42
|
+
|
43
|
+
### Include the Ruby code directly
|
44
|
+
|
45
|
+
Include the Ruby code directly using `-I` as follows:
|
46
|
+
|
47
|
+
```shell
|
48
|
+
ruby -Ilib script.rb
|
49
|
+
```
|
50
|
+
|
51
|
+
## Getting Started
|
52
|
+
|
53
|
+
Please follow the [installation](#installation) procedure and then run the following code:
|
54
|
+
|
55
|
+
```ruby
|
56
|
+
# Load the gem
|
57
|
+
require 'stormgate_world'
|
58
|
+
|
59
|
+
api_instance = StormgateWorld::LeaderboardEntriesApi.new
|
60
|
+
leaderboard_entry_id = 'leaderboard_entry_id_example' # String | Player Leaderboard Entry ID
|
61
|
+
|
62
|
+
begin
|
63
|
+
result = api_instance.get_leaderboard_entry_history(leaderboard_entry_id)
|
64
|
+
p result
|
65
|
+
rescue StormgateWorld::ApiError => e
|
66
|
+
puts "Exception when calling LeaderboardEntriesApi->get_leaderboard_entry_history: #{e}"
|
67
|
+
end
|
68
|
+
|
69
|
+
```
|
70
|
+
|
71
|
+
## Documentation for API Endpoints
|
72
|
+
|
73
|
+
All URIs are relative to *https://api.stormgateworld.com*
|
74
|
+
|
75
|
+
Class | Method | HTTP request | Description
|
76
|
+
------------ | ------------- | ------------- | -------------
|
77
|
+
*StormgateWorld::LeaderboardEntriesApi* | [**get_leaderboard_entry_history**](docs/LeaderboardEntriesApi.md#get_leaderboard_entry_history) | **GET** /v0/leaderboard-entries/{leaderboard_entry_id}/history |
|
78
|
+
*StormgateWorld::LeaderboardsApi* | [**get_leaderboard**](docs/LeaderboardsApi.md#get_leaderboard) | **GET** /v0/leaderboards/ranked_1v1 |
|
79
|
+
*StormgateWorld::LeaderboardsApi* | [**get_leaderboard_dump**](docs/LeaderboardsApi.md#get_leaderboard_dump) | **GET** /v0/leaderboards/ranked_1v1/dump |
|
80
|
+
*StormgateWorld::MatchesApi* | [**get_matches**](docs/MatchesApi.md#get_matches) | **GET** /v0/matches |
|
81
|
+
*StormgateWorld::PlayersApi* | [**get_player**](docs/PlayersApi.md#get_player) | **GET** /v0/players/{player_id} |
|
82
|
+
*StormgateWorld::PlayersApi* | [**get_player_last_match**](docs/PlayersApi.md#get_player_last_match) | **GET** /v0/players/{player_id}/matches/last |
|
83
|
+
*StormgateWorld::PlayersApi* | [**get_player_matches**](docs/PlayersApi.md#get_player_matches) | **GET** /v0/players/{player_id}/matches |
|
84
|
+
*StormgateWorld::PlayersApi* | [**get_player_preferences**](docs/PlayersApi.md#get_player_preferences) | **GET** /v0/players/{player_id}/preferences |
|
85
|
+
*StormgateWorld::PlayersApi* | [**get_player_statistics_activity**](docs/PlayersApi.md#get_player_statistics_activity) | **GET** /v0/players/{player_id}/statistics/activity |
|
86
|
+
*StormgateWorld::PlayersApi* | [**get_player_statistics_matchups**](docs/PlayersApi.md#get_player_statistics_matchups) | **GET** /v0/players/{player_id}/statistics/matchups |
|
87
|
+
*StormgateWorld::PlayersApi* | [**get_player_statistics_opponents**](docs/PlayersApi.md#get_player_statistics_opponents) | **GET** /v0/players/{player_id}/statistics/opponents |
|
88
|
+
*StormgateWorld::PlayersApi* | [**update_player_preferences**](docs/PlayersApi.md#update_player_preferences) | **PUT** /v0/players/{player_id}/preferences |
|
89
|
+
*StormgateWorld::StatisticsApi* | [**get_statistics**](docs/StatisticsApi.md#get_statistics) | **GET** /v0/statistics/ranked_1v1 |
|
90
|
+
|
91
|
+
|
92
|
+
## Documentation for Models
|
93
|
+
|
94
|
+
- [StormgateWorld::ErrorResponse](docs/ErrorResponse.md)
|
95
|
+
- [StormgateWorld::Leaderboard](docs/Leaderboard.md)
|
96
|
+
- [StormgateWorld::LeaderboardDumpResponse](docs/LeaderboardDumpResponse.md)
|
97
|
+
- [StormgateWorld::LeaderboardEntryHistory](docs/LeaderboardEntryHistory.md)
|
98
|
+
- [StormgateWorld::LeaderboardEntryHistoryEntry](docs/LeaderboardEntryHistoryEntry.md)
|
99
|
+
- [StormgateWorld::LeaderboardEntryResponse](docs/LeaderboardEntryResponse.md)
|
100
|
+
- [StormgateWorld::LeaderboardOrder](docs/LeaderboardOrder.md)
|
101
|
+
- [StormgateWorld::LeaderboardResponse](docs/LeaderboardResponse.md)
|
102
|
+
- [StormgateWorld::MatchParticipantPlayerLeaderboardEntryResponse](docs/MatchParticipantPlayerLeaderboardEntryResponse.md)
|
103
|
+
- [StormgateWorld::MatchParticipantPlayerResponse](docs/MatchParticipantPlayerResponse.md)
|
104
|
+
- [StormgateWorld::MatchParticipantResponse](docs/MatchParticipantResponse.md)
|
105
|
+
- [StormgateWorld::MatchResponse](docs/MatchResponse.md)
|
106
|
+
- [StormgateWorld::MatchResult](docs/MatchResult.md)
|
107
|
+
- [StormgateWorld::MatchState](docs/MatchState.md)
|
108
|
+
- [StormgateWorld::MatchesResponse](docs/MatchesResponse.md)
|
109
|
+
- [StormgateWorld::PlayerActivityStats](docs/PlayerActivityStats.md)
|
110
|
+
- [StormgateWorld::PlayerActivityStatsRace](docs/PlayerActivityStatsRace.md)
|
111
|
+
- [StormgateWorld::PlayerMatchesResponse](docs/PlayerMatchesResponse.md)
|
112
|
+
- [StormgateWorld::PlayerMatchupsStats](docs/PlayerMatchupsStats.md)
|
113
|
+
- [StormgateWorld::PlayerMatchupsStatsEntry](docs/PlayerMatchupsStatsEntry.md)
|
114
|
+
- [StormgateWorld::PlayerMatchupsStatsMatchup](docs/PlayerMatchupsStatsMatchup.md)
|
115
|
+
- [StormgateWorld::PlayerOpponentsStats](docs/PlayerOpponentsStats.md)
|
116
|
+
- [StormgateWorld::PlayerOpponentsStatsOpponent](docs/PlayerOpponentsStatsOpponent.md)
|
117
|
+
- [StormgateWorld::PlayerPreferences](docs/PlayerPreferences.md)
|
118
|
+
- [StormgateWorld::PlayerResponse](docs/PlayerResponse.md)
|
119
|
+
- [StormgateWorld::PlayerStatsEntry](docs/PlayerStatsEntry.md)
|
120
|
+
- [StormgateWorld::PlayerStatsEntryAggregated](docs/PlayerStatsEntryAggregated.md)
|
121
|
+
- [StormgateWorld::PlayerStatsEntryNumBreakdown](docs/PlayerStatsEntryNumBreakdown.md)
|
122
|
+
- [StormgateWorld::ProfilePrivacy](docs/ProfilePrivacy.md)
|
123
|
+
- [StormgateWorld::Race](docs/Race.md)
|
124
|
+
- [StormgateWorld::StatsByTime](docs/StatsByTime.md)
|
125
|
+
- [StormgateWorld::StatsByTimeEntry](docs/StatsByTimeEntry.md)
|
126
|
+
- [StormgateWorld::StatsByTimeHistoryPoint](docs/StatsByTimeHistoryPoint.md)
|
127
|
+
- [StormgateWorld::StatsByTimeMatchLength](docs/StatsByTimeMatchLength.md)
|
128
|
+
- [StormgateWorld::StatsByTimeMatchLengthEntry](docs/StatsByTimeMatchLengthEntry.md)
|
129
|
+
|
130
|
+
|
131
|
+
## Documentation for Authorization
|
132
|
+
|
133
|
+
|
134
|
+
Authentication schemes defined for the API:
|
135
|
+
### api_key
|
136
|
+
|
137
|
+
|
138
|
+
- **Type**: API key
|
139
|
+
- **API key parameter name**: api-key
|
140
|
+
- **Location**: HTTP header
|
141
|
+
|
data/Rakefile
ADDED
@@ -0,0 +1,26 @@
|
|
1
|
+
# StormgateWorld::ErrorResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **code** | **Integer** | | |
|
8
|
+
| **error** | **String** | | |
|
9
|
+
| **full_error** | **Array<String>** | | [optional] |
|
10
|
+
| **backtrace** | **Array<String>** | | [optional] |
|
11
|
+
| **full_backtrace** | **Array<String>** | | [optional] |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'stormgate_world'
|
17
|
+
|
18
|
+
instance = StormgateWorld::ErrorResponse.new(
|
19
|
+
code: null,
|
20
|
+
error: null,
|
21
|
+
full_error: null,
|
22
|
+
backtrace: null,
|
23
|
+
full_backtrace: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
data/docs/Leaderboard.md
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
# StormgateWorld::LeaderboardDumpResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **count** | **Integer** | | |
|
8
|
+
| **cached_at** | **Time** | | |
|
9
|
+
| **entries** | [**Array<LeaderboardEntryResponse>**](LeaderboardEntryResponse.md) | | |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'stormgate_world'
|
15
|
+
|
16
|
+
instance = StormgateWorld::LeaderboardDumpResponse.new(
|
17
|
+
count: null,
|
18
|
+
cached_at: null,
|
19
|
+
entries: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -0,0 +1,70 @@
|
|
1
|
+
# StormgateWorld::LeaderboardEntriesApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.stormgateworld.com*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**get_leaderboard_entry_history**](LeaderboardEntriesApi.md#get_leaderboard_entry_history) | **GET** /v0/leaderboard-entries/{leaderboard_entry_id}/history | |
|
8
|
+
|
9
|
+
|
10
|
+
## get_leaderboard_entry_history
|
11
|
+
|
12
|
+
> <LeaderboardEntryHistory> get_leaderboard_entry_history(leaderboard_entry_id)
|
13
|
+
|
14
|
+
|
15
|
+
|
16
|
+
### Examples
|
17
|
+
|
18
|
+
```ruby
|
19
|
+
require 'time'
|
20
|
+
require 'stormgate_world'
|
21
|
+
|
22
|
+
api_instance = StormgateWorld::LeaderboardEntriesApi.new
|
23
|
+
leaderboard_entry_id = 'leaderboard_entry_id_example' # String | Player Leaderboard Entry ID
|
24
|
+
|
25
|
+
begin
|
26
|
+
|
27
|
+
result = api_instance.get_leaderboard_entry_history(leaderboard_entry_id)
|
28
|
+
p result
|
29
|
+
rescue StormgateWorld::ApiError => e
|
30
|
+
puts "Error when calling LeaderboardEntriesApi->get_leaderboard_entry_history: #{e}"
|
31
|
+
end
|
32
|
+
```
|
33
|
+
|
34
|
+
#### Using the get_leaderboard_entry_history_with_http_info variant
|
35
|
+
|
36
|
+
This returns an Array which contains the response data, status code and headers.
|
37
|
+
|
38
|
+
> <Array(<LeaderboardEntryHistory>, Integer, Hash)> get_leaderboard_entry_history_with_http_info(leaderboard_entry_id)
|
39
|
+
|
40
|
+
```ruby
|
41
|
+
begin
|
42
|
+
|
43
|
+
data, status_code, headers = api_instance.get_leaderboard_entry_history_with_http_info(leaderboard_entry_id)
|
44
|
+
p status_code # => 2xx
|
45
|
+
p headers # => { ... }
|
46
|
+
p data # => <LeaderboardEntryHistory>
|
47
|
+
rescue StormgateWorld::ApiError => e
|
48
|
+
puts "Error when calling LeaderboardEntriesApi->get_leaderboard_entry_history_with_http_info: #{e}"
|
49
|
+
end
|
50
|
+
```
|
51
|
+
|
52
|
+
### Parameters
|
53
|
+
|
54
|
+
| Name | Type | Description | Notes |
|
55
|
+
| ---- | ---- | ----------- | ----- |
|
56
|
+
| **leaderboard_entry_id** | **String** | Player Leaderboard Entry ID | |
|
57
|
+
|
58
|
+
### Return type
|
59
|
+
|
60
|
+
[**LeaderboardEntryHistory**](LeaderboardEntryHistory.md)
|
61
|
+
|
62
|
+
### Authorization
|
63
|
+
|
64
|
+
No authorization required
|
65
|
+
|
66
|
+
### HTTP request headers
|
67
|
+
|
68
|
+
- **Content-Type**: Not defined
|
69
|
+
- **Accept**: application/json
|
70
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# StormgateWorld::LeaderboardEntryHistory
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **history** | [**Array<LeaderboardEntryHistoryEntry>**](LeaderboardEntryHistoryEntry.md) | | |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'stormgate_world'
|
13
|
+
|
14
|
+
instance = StormgateWorld::LeaderboardEntryHistory.new(
|
15
|
+
history: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# StormgateWorld::LeaderboardEntryHistoryEntry
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **time** | **Time** | | |
|
8
|
+
| **mmr** | **Float** | | |
|
9
|
+
| **max_confirmed_mmr** | **Float** | | [optional] |
|
10
|
+
| **points** | **Float** | | [optional] |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'stormgate_world'
|
16
|
+
|
17
|
+
instance = StormgateWorld::LeaderboardEntryHistoryEntry.new(
|
18
|
+
time: null,
|
19
|
+
mmr: null,
|
20
|
+
max_confirmed_mmr: null,
|
21
|
+
points: null
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
@@ -0,0 +1,52 @@
|
|
1
|
+
# StormgateWorld::LeaderboardEntryResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **leaderboard_entry_id** | **String** | | |
|
8
|
+
| **leaderboard** | [**Leaderboard**](Leaderboard.md) | | |
|
9
|
+
| **player_id** | **String** | | [optional] |
|
10
|
+
| **anonymous** | **Boolean** | | |
|
11
|
+
| **nickname** | **String** | | [optional] |
|
12
|
+
| **nickname_discriminator** | **String** | | [optional] |
|
13
|
+
| **rank** | **Integer** | | [optional] |
|
14
|
+
| **race** | [**Race**](Race.md) | | |
|
15
|
+
| **league** | **String** | | [optional] |
|
16
|
+
| **tier** | **Integer** | | [optional] |
|
17
|
+
| **mmr** | **Float** | | |
|
18
|
+
| **max_confirmed_mmr** | **Float** | | [optional] |
|
19
|
+
| **points** | **Float** | | [optional] |
|
20
|
+
| **wins** | **Integer** | | |
|
21
|
+
| **losses** | **Integer** | | |
|
22
|
+
| **ties** | **Integer** | | [optional] |
|
23
|
+
| **matches** | **Integer** | | |
|
24
|
+
| **win_rate** | **Float** | | |
|
25
|
+
|
26
|
+
## Example
|
27
|
+
|
28
|
+
```ruby
|
29
|
+
require 'stormgate_world'
|
30
|
+
|
31
|
+
instance = StormgateWorld::LeaderboardEntryResponse.new(
|
32
|
+
leaderboard_entry_id: null,
|
33
|
+
leaderboard: null,
|
34
|
+
player_id: null,
|
35
|
+
anonymous: null,
|
36
|
+
nickname: null,
|
37
|
+
nickname_discriminator: null,
|
38
|
+
rank: null,
|
39
|
+
race: null,
|
40
|
+
league: null,
|
41
|
+
tier: null,
|
42
|
+
mmr: null,
|
43
|
+
max_confirmed_mmr: null,
|
44
|
+
points: null,
|
45
|
+
wins: null,
|
46
|
+
losses: null,
|
47
|
+
ties: null,
|
48
|
+
matches: null,
|
49
|
+
win_rate: null
|
50
|
+
)
|
51
|
+
```
|
52
|
+
|
@@ -0,0 +1,15 @@
|
|
1
|
+
# StormgateWorld::LeaderboardOrder
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
|
8
|
+
## Example
|
9
|
+
|
10
|
+
```ruby
|
11
|
+
require 'stormgate_world'
|
12
|
+
|
13
|
+
instance = StormgateWorld::LeaderboardOrder.new()
|
14
|
+
```
|
15
|
+
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# StormgateWorld::LeaderboardResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **page** | **Integer** | | |
|
8
|
+
| **count** | **Integer** | | |
|
9
|
+
| **total** | **Integer** | | |
|
10
|
+
| **entries** | [**Array<LeaderboardEntryResponse>**](LeaderboardEntryResponse.md) | | |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'stormgate_world'
|
16
|
+
|
17
|
+
instance = StormgateWorld::LeaderboardResponse.new(
|
18
|
+
page: null,
|
19
|
+
count: null,
|
20
|
+
total: null,
|
21
|
+
entries: null
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
@@ -0,0 +1,140 @@
|
|
1
|
+
# StormgateWorld::LeaderboardsApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.stormgateworld.com*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**get_leaderboard**](LeaderboardsApi.md#get_leaderboard) | **GET** /v0/leaderboards/ranked_1v1 | |
|
8
|
+
| [**get_leaderboard_dump**](LeaderboardsApi.md#get_leaderboard_dump) | **GET** /v0/leaderboards/ranked_1v1/dump | |
|
9
|
+
|
10
|
+
|
11
|
+
## get_leaderboard
|
12
|
+
|
13
|
+
> <LeaderboardResponse> get_leaderboard(opts)
|
14
|
+
|
15
|
+
|
16
|
+
|
17
|
+
### Examples
|
18
|
+
|
19
|
+
```ruby
|
20
|
+
require 'time'
|
21
|
+
require 'stormgate_world'
|
22
|
+
|
23
|
+
api_instance = StormgateWorld::LeaderboardsApi.new
|
24
|
+
opts = {
|
25
|
+
race: StormgateWorld::Race::INFERNALS, # Race |
|
26
|
+
page: 789, # Integer |
|
27
|
+
count: 789, # Integer |
|
28
|
+
order: StormgateWorld::LeaderboardOrder::POINTS, # LeaderboardOrder |
|
29
|
+
query: 'query_example' # String |
|
30
|
+
}
|
31
|
+
|
32
|
+
begin
|
33
|
+
|
34
|
+
result = api_instance.get_leaderboard(opts)
|
35
|
+
p result
|
36
|
+
rescue StormgateWorld::ApiError => e
|
37
|
+
puts "Error when calling LeaderboardsApi->get_leaderboard: #{e}"
|
38
|
+
end
|
39
|
+
```
|
40
|
+
|
41
|
+
#### Using the get_leaderboard_with_http_info variant
|
42
|
+
|
43
|
+
This returns an Array which contains the response data, status code and headers.
|
44
|
+
|
45
|
+
> <Array(<LeaderboardResponse>, Integer, Hash)> get_leaderboard_with_http_info(opts)
|
46
|
+
|
47
|
+
```ruby
|
48
|
+
begin
|
49
|
+
|
50
|
+
data, status_code, headers = api_instance.get_leaderboard_with_http_info(opts)
|
51
|
+
p status_code # => 2xx
|
52
|
+
p headers # => { ... }
|
53
|
+
p data # => <LeaderboardResponse>
|
54
|
+
rescue StormgateWorld::ApiError => e
|
55
|
+
puts "Error when calling LeaderboardsApi->get_leaderboard_with_http_info: #{e}"
|
56
|
+
end
|
57
|
+
```
|
58
|
+
|
59
|
+
### Parameters
|
60
|
+
|
61
|
+
| Name | Type | Description | Notes |
|
62
|
+
| ---- | ---- | ----------- | ----- |
|
63
|
+
| **race** | [**Race**](.md) | | [optional] |
|
64
|
+
| **page** | **Integer** | | [optional] |
|
65
|
+
| **count** | **Integer** | | [optional] |
|
66
|
+
| **order** | [**LeaderboardOrder**](.md) | | [optional] |
|
67
|
+
| **query** | **String** | | [optional] |
|
68
|
+
|
69
|
+
### Return type
|
70
|
+
|
71
|
+
[**LeaderboardResponse**](LeaderboardResponse.md)
|
72
|
+
|
73
|
+
### Authorization
|
74
|
+
|
75
|
+
No authorization required
|
76
|
+
|
77
|
+
### HTTP request headers
|
78
|
+
|
79
|
+
- **Content-Type**: Not defined
|
80
|
+
- **Accept**: application/json
|
81
|
+
|
82
|
+
|
83
|
+
## get_leaderboard_dump
|
84
|
+
|
85
|
+
> <LeaderboardDumpResponse> get_leaderboard_dump
|
86
|
+
|
87
|
+
|
88
|
+
|
89
|
+
### Examples
|
90
|
+
|
91
|
+
```ruby
|
92
|
+
require 'time'
|
93
|
+
require 'stormgate_world'
|
94
|
+
|
95
|
+
api_instance = StormgateWorld::LeaderboardsApi.new
|
96
|
+
|
97
|
+
begin
|
98
|
+
|
99
|
+
result = api_instance.get_leaderboard_dump
|
100
|
+
p result
|
101
|
+
rescue StormgateWorld::ApiError => e
|
102
|
+
puts "Error when calling LeaderboardsApi->get_leaderboard_dump: #{e}"
|
103
|
+
end
|
104
|
+
```
|
105
|
+
|
106
|
+
#### Using the get_leaderboard_dump_with_http_info variant
|
107
|
+
|
108
|
+
This returns an Array which contains the response data, status code and headers.
|
109
|
+
|
110
|
+
> <Array(<LeaderboardDumpResponse>, Integer, Hash)> get_leaderboard_dump_with_http_info
|
111
|
+
|
112
|
+
```ruby
|
113
|
+
begin
|
114
|
+
|
115
|
+
data, status_code, headers = api_instance.get_leaderboard_dump_with_http_info
|
116
|
+
p status_code # => 2xx
|
117
|
+
p headers # => { ... }
|
118
|
+
p data # => <LeaderboardDumpResponse>
|
119
|
+
rescue StormgateWorld::ApiError => e
|
120
|
+
puts "Error when calling LeaderboardsApi->get_leaderboard_dump_with_http_info: #{e}"
|
121
|
+
end
|
122
|
+
```
|
123
|
+
|
124
|
+
### Parameters
|
125
|
+
|
126
|
+
This endpoint does not need any parameter.
|
127
|
+
|
128
|
+
### Return type
|
129
|
+
|
130
|
+
[**LeaderboardDumpResponse**](LeaderboardDumpResponse.md)
|
131
|
+
|
132
|
+
### Authorization
|
133
|
+
|
134
|
+
No authorization required
|
135
|
+
|
136
|
+
### HTTP request headers
|
137
|
+
|
138
|
+
- **Content-Type**: Not defined
|
139
|
+
- **Accept**: application/json
|
140
|
+
|
@@ -0,0 +1,32 @@
|
|
1
|
+
# StormgateWorld::MatchParticipantPlayerLeaderboardEntryResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **leaderboard_entry_id** | **String** | | |
|
8
|
+
| **league** | **String** | | [optional] |
|
9
|
+
| **tier** | **Integer** | | [optional] |
|
10
|
+
| **rank** | **Integer** | | [optional] |
|
11
|
+
| **wins** | **Integer** | | |
|
12
|
+
| **losses** | **Integer** | | |
|
13
|
+
| **ties** | **Integer** | | [optional] |
|
14
|
+
| **win_rate** | **Float** | | |
|
15
|
+
|
16
|
+
## Example
|
17
|
+
|
18
|
+
```ruby
|
19
|
+
require 'stormgate_world'
|
20
|
+
|
21
|
+
instance = StormgateWorld::MatchParticipantPlayerLeaderboardEntryResponse.new(
|
22
|
+
leaderboard_entry_id: null,
|
23
|
+
league: null,
|
24
|
+
tier: null,
|
25
|
+
rank: null,
|
26
|
+
wins: null,
|
27
|
+
losses: null,
|
28
|
+
ties: null,
|
29
|
+
win_rate: null
|
30
|
+
)
|
31
|
+
```
|
32
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# StormgateWorld::MatchParticipantPlayerResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **player_id** | **String** | | |
|
8
|
+
| **nickname** | **String** | | [optional] |
|
9
|
+
| **nickname_discriminator** | **String** | | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'stormgate_world'
|
15
|
+
|
16
|
+
instance = StormgateWorld::MatchParticipantPlayerResponse.new(
|
17
|
+
player_id: null,
|
18
|
+
nickname: null,
|
19
|
+
nickname_discriminator: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -0,0 +1,38 @@
|
|
1
|
+
# StormgateWorld::MatchParticipantResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **player** | [**MatchParticipantPlayerResponse**](MatchParticipantPlayerResponse.md) | | [optional] |
|
8
|
+
| **player_leaderboard_entry** | [**MatchParticipantPlayerLeaderboardEntryResponse**](MatchParticipantPlayerLeaderboardEntryResponse.md) | | [optional] |
|
9
|
+
| **race** | [**Race**](Race.md) | | |
|
10
|
+
| **team** | **Integer** | | |
|
11
|
+
| **party** | **Integer** | | |
|
12
|
+
| **mmr** | **Float** | | |
|
13
|
+
| **mmr_updated** | **Float** | | [optional] |
|
14
|
+
| **mmr_diff** | **Float** | | [optional] |
|
15
|
+
| **result** | [**MatchResult**](MatchResult.md) | | [optional] |
|
16
|
+
| **ping** | **Integer** | | [optional] |
|
17
|
+
| **scores** | **Object** | | [optional] |
|
18
|
+
|
19
|
+
## Example
|
20
|
+
|
21
|
+
```ruby
|
22
|
+
require 'stormgate_world'
|
23
|
+
|
24
|
+
instance = StormgateWorld::MatchParticipantResponse.new(
|
25
|
+
player: null,
|
26
|
+
player_leaderboard_entry: null,
|
27
|
+
race: null,
|
28
|
+
team: null,
|
29
|
+
party: null,
|
30
|
+
mmr: null,
|
31
|
+
mmr_updated: null,
|
32
|
+
mmr_diff: null,
|
33
|
+
result: null,
|
34
|
+
ping: null,
|
35
|
+
scores: null
|
36
|
+
)
|
37
|
+
```
|
38
|
+
|