stormgate_world

StormgateWorld - the Ruby gem for the api

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

This SDK is automatically generated by the OpenAPI Generator project:

• API version: 0.1.1
• Package version: 1.0.0
• Build package: org.openapitools.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build stormgate_world.gemspec

Then either install the gem locally:

gem install ./stormgate_world-1.0.0.gem

(for development, run gem install --dev ./stormgate_world-1.0.0.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'stormgate_world', '~> 1.0.0'

Install from Git

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:

gem 'stormgate_world', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'stormgate_world'

api_instance = StormgateWorld::LeaderboardEntriesApi.new
leaderboard_entry_id = 'leaderboard_entry_id_example' # String | Player Leaderboard Entry ID
opts = {
  resolution: StormgateWorld::Resolution::MINUTE, # Resolution | 
  aggregation: StormgateWorld::Aggregation::LAST # Aggregation | 
}

begin
  result = api_instance.get_leaderboard_entry_history(leaderboard_entry_id, opts)
  p result
rescue StormgateWorld::ApiError => e
  puts "Exception when calling LeaderboardEntriesApi->get_leaderboard_entry_history: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://api.stormgateworld.com

Class	Method	HTTP request	Description
StormgateWorld::LeaderboardEntriesApi	get_leaderboard_entry_history	GET /v0/leaderboard-entries/{leaderboard_entry_id}/history
StormgateWorld::LeaderboardsApi	get_leaderboard	GET /v0/leaderboards/ranked_1v1
StormgateWorld::LeaderboardsApi	get_leaderboard_dump	GET /v0/leaderboards/ranked_1v1/dump
StormgateWorld::MatchesApi	get_matches	GET /v0/matches
StormgateWorld::PlayersApi	get_player	GET /v0/players/{player_id}
StormgateWorld::PlayersApi	get_player_last_match	GET /v0/players/{player_id}/matches/last
StormgateWorld::PlayersApi	get_player_matches	GET /v0/players/{player_id}/matches
StormgateWorld::PlayersApi	get_player_statistics_activity	GET /v0/players/{player_id}/statistics/activity
StormgateWorld::PlayersApi	get_player_statistics_matchups	GET /v0/players/{player_id}/statistics/matchups
StormgateWorld::PlayersApi	get_player_statistics_opponents	GET /v0/players/{player_id}/statistics/opponents
StormgateWorld::StatisticsApi	get_statistics	GET /v0/statistics/ranked_1v1
StormgateWorld::StatisticsApi	get_statistics_activity	GET /v0/statistics/activity
StormgateWorld::StatisticsApi	get_statistics_countries	GET /v0/statistics/countries
StormgateWorld::StatisticsApi	get_statistics_servers	GET /v0/statistics/servers

Documentation for Models

• StormgateWorld::ActivityStatistics
• StormgateWorld::ActivityStatisticsActivity
• StormgateWorld::ActivityStatisticsEntry
• StormgateWorld::Aggregation
• StormgateWorld::CountriesStatistics
• StormgateWorld::CountriesStatisticsEntry
• StormgateWorld::DumpFormat
• StormgateWorld::ErrorResponse
• StormgateWorld::Leaderboard
• StormgateWorld::LeaderboardDumpResponse
• StormgateWorld::LeaderboardEntryHistory
• StormgateWorld::LeaderboardEntryHistoryRow
• StormgateWorld::LeaderboardEntryResponse
• StormgateWorld::LeaderboardOrder
• StormgateWorld::LeaderboardResponse
• StormgateWorld::League
• StormgateWorld::MatchParticipantPlayerLeaderboardEntryResponse
• StormgateWorld::MatchParticipantPlayerResponse
• StormgateWorld::MatchParticipantResponse
• StormgateWorld::MatchResponse
• StormgateWorld::MatchResult
• StormgateWorld::MatchState
• StormgateWorld::MatchesResponse
• StormgateWorld::PlayerActivityStats
• StormgateWorld::PlayerActivityStatsRace
• StormgateWorld::PlayerMatchesResponse
• StormgateWorld::PlayerMatchupsStats
• StormgateWorld::PlayerMatchupsStatsEntry
• StormgateWorld::PlayerMatchupsStatsMatchup
• StormgateWorld::PlayerOpponentsStats
• StormgateWorld::PlayerOpponentsStatsOpponent
• StormgateWorld::PlayerResponse
• StormgateWorld::PlayerStatsEntry
• StormgateWorld::PlayerStatsEntryAggregated
• StormgateWorld::PlayerStatsEntryNumBreakdown
• StormgateWorld::ProfilePrivacy
• StormgateWorld::Race
• StormgateWorld::Resolution
• StormgateWorld::ServersStatistics
• StormgateWorld::ServersStatisticsEntry
• StormgateWorld::StatsByTime
• StormgateWorld::StatsByTimeEntry
• StormgateWorld::StatsByTimeHistoryPoint
• StormgateWorld::StatsByTimeMatchLength
• StormgateWorld::StatsByTimeMatchLengthEntry

Documentation for Authorization

Authentication schemes defined for the API:

api_key

• Type: API key
• API key parameter name: api-key
• Location: HTTP header