class ESIClient::FactionWarfareApi
Attributes
Public Class Methods
# File lib/esi_client/api/faction_warfare_api.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Overview of a character involved in faction warfare Statistical overview of a character involved in faction warfare — This route expires daily at 11:05 @param character_id An EVE character ID @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from (default to tranquility) @option opts [String] :token Access token to use if unable to set a header @option opts [String] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [GetCharactersCharacterIdFwStatsOk]
# File lib/esi_client/api/faction_warfare_api.rb, line 31 def get_characters_character_id_fw_stats(character_id, opts = {}) data, _status_code, _headers = get_characters_character_id_fw_stats_with_http_info(character_id, opts) data end
Overview of a character involved in faction warfare Statistical overview of a character involved in faction warfare — This route expires daily at 11:05 @param character_id An EVE character ID @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from @option opts [String] :token Access token to use if unable to set a header @option opts [String] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [Array<(GetCharactersCharacterIdFwStatsOk
, Fixnum, Hash)>] GetCharactersCharacterIdFwStatsOk
data, response status code and response headers
# File lib/esi_client/api/faction_warfare_api.rb, line 45 def get_characters_character_id_fw_stats_with_http_info(character_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: FactionWarfareApi.get_characters_character_id_fw_stats ...' end # verify the required parameter 'character_id' is set if @api_client.config.client_side_validation && character_id.nil? fail ArgumentError, "Missing the required parameter 'character_id' when calling FactionWarfareApi.get_characters_character_id_fw_stats" end if @api_client.config.client_side_validation && character_id < 1 fail ArgumentError, 'invalid value for "character_id" when calling FactionWarfareApi.get_characters_character_id_fw_stats, must be greater than or equal to 1.' end if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource']) fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity' end # resource path local_var_path = '/v1/characters/{character_id}/fw/stats/'.sub('{' + 'character_id' + '}', character_id.to_s) # query parameters query_params = {} query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil? query_params[:'token'] = opts[:'token'] if !opts[:'token'].nil? query_params[:'user_agent'] = opts[:'user_agent'] if !opts[:'user_agent'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) header_params[:'X-User-Agent'] = opts[:'x_user_agent'] if !opts[:'x_user_agent'].nil? # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['evesso'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'GetCharactersCharacterIdFwStatsOk') if @api_client.config.debugging @api_client.config.logger.debug "API called: FactionWarfareApi#get_characters_character_id_fw_stats\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Overview of a corporation involved in faction warfare Statistics about a corporation involved in faction warfare — This route expires daily at 11:05 @param corporation_id An EVE corporation ID @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from (default to tranquility) @option opts [String] :token Access token to use if unable to set a header @option opts [String] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [GetCorporationsCorporationIdFwStatsOk]
# File lib/esi_client/api/faction_warfare_api.rb, line 102 def get_corporations_corporation_id_fw_stats(corporation_id, opts = {}) data, _status_code, _headers = get_corporations_corporation_id_fw_stats_with_http_info(corporation_id, opts) data end
Overview of a corporation involved in faction warfare Statistics about a corporation involved in faction warfare — This route expires daily at 11:05 @param corporation_id An EVE corporation ID @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from @option opts [String] :token Access token to use if unable to set a header @option opts [String] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [Array<(GetCorporationsCorporationIdFwStatsOk
, Fixnum, Hash)>] GetCorporationsCorporationIdFwStatsOk
data, response status code and response headers
# File lib/esi_client/api/faction_warfare_api.rb, line 116 def get_corporations_corporation_id_fw_stats_with_http_info(corporation_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: FactionWarfareApi.get_corporations_corporation_id_fw_stats ...' end # verify the required parameter 'corporation_id' is set if @api_client.config.client_side_validation && corporation_id.nil? fail ArgumentError, "Missing the required parameter 'corporation_id' when calling FactionWarfareApi.get_corporations_corporation_id_fw_stats" end if @api_client.config.client_side_validation && corporation_id < 1 fail ArgumentError, 'invalid value for "corporation_id" when calling FactionWarfareApi.get_corporations_corporation_id_fw_stats, must be greater than or equal to 1.' end if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource']) fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity' end # resource path local_var_path = '/v1/corporations/{corporation_id}/fw/stats/'.sub('{' + 'corporation_id' + '}', corporation_id.to_s) # query parameters query_params = {} query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil? query_params[:'token'] = opts[:'token'] if !opts[:'token'].nil? query_params[:'user_agent'] = opts[:'user_agent'] if !opts[:'user_agent'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) header_params[:'X-User-Agent'] = opts[:'x_user_agent'] if !opts[:'x_user_agent'].nil? # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['evesso'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'GetCorporationsCorporationIdFwStatsOk') if @api_client.config.debugging @api_client.config.logger.debug "API called: FactionWarfareApi#get_corporations_corporation_id_fw_stats\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
List of the top factions in faction warfare Top 4 leaderboard of factions for kills and victory points separated by total, last week and yesterday. — This route expires daily at 11:05 @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from (default to tranquility) @option opts [String] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [GetFwLeaderboardsOk]
# File lib/esi_client/api/faction_warfare_api.rb, line 171 def get_fw_leaderboards(opts = {}) data, _status_code, _headers = get_fw_leaderboards_with_http_info(opts) data end
List of the top pilots in faction warfare Top 100 leaderboard of pilots for kills and victory points separated by total, last week and yesterday. — This route expires daily at 11:05 @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from (default to tranquility) @option opts [String] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [GetFwLeaderboardsCharactersOk]
# File lib/esi_client/api/faction_warfare_api.rb, line 229 def get_fw_leaderboards_characters(opts = {}) data, _status_code, _headers = get_fw_leaderboards_characters_with_http_info(opts) data end
List of the top pilots in faction warfare Top 100 leaderboard of pilots for kills and victory points separated by total, last week and yesterday. — This route expires daily at 11:05 @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from @option opts [String] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [Array<(GetFwLeaderboardsCharactersOk
, Fixnum, Hash)>] GetFwLeaderboardsCharactersOk
data, response status code and response headers
# File lib/esi_client/api/faction_warfare_api.rb, line 241 def get_fw_leaderboards_characters_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: FactionWarfareApi.get_fw_leaderboards_characters ...' end if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource']) fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity' end # resource path local_var_path = '/v1/fw/leaderboards/characters/' # query parameters query_params = {} query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil? query_params[:'user_agent'] = opts[:'user_agent'] if !opts[:'user_agent'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) header_params[:'X-User-Agent'] = opts[:'x_user_agent'] if !opts[:'x_user_agent'].nil? # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'GetFwLeaderboardsCharactersOk') if @api_client.config.debugging @api_client.config.logger.debug "API called: FactionWarfareApi#get_fw_leaderboards_characters\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
List of the top corporations in faction warfare Top 10 leaderboard of corporations for kills and victory points separated by total, last week and yesterday. — This route expires daily at 11:05 @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from (default to tranquility) @option opts [String] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [GetFwLeaderboardsCorporationsOk]
# File lib/esi_client/api/faction_warfare_api.rb, line 287 def get_fw_leaderboards_corporations(opts = {}) data, _status_code, _headers = get_fw_leaderboards_corporations_with_http_info(opts) data end
List of the top corporations in faction warfare Top 10 leaderboard of corporations for kills and victory points separated by total, last week and yesterday. — This route expires daily at 11:05 @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from @option opts [String] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [Array<(GetFwLeaderboardsCorporationsOk
, Fixnum, Hash)>] GetFwLeaderboardsCorporationsOk
data, response status code and response headers
# File lib/esi_client/api/faction_warfare_api.rb, line 299 def get_fw_leaderboards_corporations_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: FactionWarfareApi.get_fw_leaderboards_corporations ...' end if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource']) fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity' end # resource path local_var_path = '/v1/fw/leaderboards/corporations/' # query parameters query_params = {} query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil? query_params[:'user_agent'] = opts[:'user_agent'] if !opts[:'user_agent'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) header_params[:'X-User-Agent'] = opts[:'x_user_agent'] if !opts[:'x_user_agent'].nil? # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'GetFwLeaderboardsCorporationsOk') if @api_client.config.debugging @api_client.config.logger.debug "API called: FactionWarfareApi#get_fw_leaderboards_corporations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
List of the top factions in faction warfare Top 4 leaderboard of factions for kills and victory points separated by total, last week and yesterday. — This route expires daily at 11:05 @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from @option opts [String] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [Array<(GetFwLeaderboardsOk
, Fixnum, Hash)>] GetFwLeaderboardsOk
data, response status code and response headers
# File lib/esi_client/api/faction_warfare_api.rb, line 183 def get_fw_leaderboards_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: FactionWarfareApi.get_fw_leaderboards ...' end if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource']) fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity' end # resource path local_var_path = '/v1/fw/leaderboards/' # query parameters query_params = {} query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil? query_params[:'user_agent'] = opts[:'user_agent'] if !opts[:'user_agent'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) header_params[:'X-User-Agent'] = opts[:'x_user_agent'] if !opts[:'x_user_agent'].nil? # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'GetFwLeaderboardsOk') if @api_client.config.debugging @api_client.config.logger.debug "API called: FactionWarfareApi#get_fw_leaderboards\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
An overview of statistics about factions involved in faction warfare Statistical overviews of factions involved in faction warfare — This route expires daily at 11:05 @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from (default to tranquility) @option opts [String] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [Array<GetFwStats200Ok>]
# File lib/esi_client/api/faction_warfare_api.rb, line 345 def get_fw_stats(opts = {}) data, _status_code, _headers = get_fw_stats_with_http_info(opts) data end
An overview of statistics about factions involved in faction warfare Statistical overviews of factions involved in faction warfare — This route expires daily at 11:05 @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from @option opts [String] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [Array<(Array<GetFwStats200Ok>, Fixnum, Hash)>] Array<GetFwStats200Ok> data, response status code and response headers
# File lib/esi_client/api/faction_warfare_api.rb, line 357 def get_fw_stats_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: FactionWarfareApi.get_fw_stats ...' end if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource']) fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity' end # resource path local_var_path = '/v1/fw/stats/' # query parameters query_params = {} query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil? query_params[:'user_agent'] = opts[:'user_agent'] if !opts[:'user_agent'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) header_params[:'X-User-Agent'] = opts[:'x_user_agent'] if !opts[:'x_user_agent'].nil? # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Array<GetFwStats200Ok>') if @api_client.config.debugging @api_client.config.logger.debug "API called: FactionWarfareApi#get_fw_stats\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Ownership of faction warfare systems An overview of the current ownership of faction warfare solar systems — This route is cached for up to 1800 seconds @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from (default to tranquility) @option opts [String] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [Array<GetFwSystems200Ok>]
# File lib/esi_client/api/faction_warfare_api.rb, line 403 def get_fw_systems(opts = {}) data, _status_code, _headers = get_fw_systems_with_http_info(opts) data end
Ownership of faction warfare systems An overview of the current ownership of faction warfare solar systems — This route is cached for up to 1800 seconds @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from @option opts [String] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [Array<(Array<GetFwSystems200Ok>, Fixnum, Hash)>] Array<GetFwSystems200Ok> data, response status code and response headers
# File lib/esi_client/api/faction_warfare_api.rb, line 415 def get_fw_systems_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: FactionWarfareApi.get_fw_systems ...' end if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource']) fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity' end # resource path local_var_path = '/v1/fw/systems/' # query parameters query_params = {} query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil? query_params[:'user_agent'] = opts[:'user_agent'] if !opts[:'user_agent'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) header_params[:'X-User-Agent'] = opts[:'x_user_agent'] if !opts[:'x_user_agent'].nil? # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Array<GetFwSystems200Ok>') if @api_client.config.debugging @api_client.config.logger.debug "API called: FactionWarfareApi#get_fw_systems\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Data about which NPC factions are at war Data about which NPC factions are at war — This route expires daily at 11:05 @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from (default to tranquility) @option opts [String] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [Array<GetFwWars200Ok>]
# File lib/esi_client/api/faction_warfare_api.rb, line 461 def get_fw_wars(opts = {}) data, _status_code, _headers = get_fw_wars_with_http_info(opts) data end
Data about which NPC factions are at war Data about which NPC factions are at war — This route expires daily at 11:05 @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from @option opts [String] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [Array<(Array<GetFwWars200Ok>, Fixnum, Hash)>] Array<GetFwWars200Ok> data, response status code and response headers
# File lib/esi_client/api/faction_warfare_api.rb, line 473 def get_fw_wars_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: FactionWarfareApi.get_fw_wars ...' end if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource']) fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity' end # resource path local_var_path = '/v1/fw/wars/' # query parameters query_params = {} query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil? query_params[:'user_agent'] = opts[:'user_agent'] if !opts[:'user_agent'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) header_params[:'X-User-Agent'] = opts[:'x_user_agent'] if !opts[:'x_user_agent'].nil? # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Array<GetFwWars200Ok>') if @api_client.config.debugging @api_client.config.logger.debug "API called: FactionWarfareApi#get_fw_wars\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end