class ESI::AllianceApi
Attributes
Public Class Methods
# File lib/esi-client-bvv/api/alliance_api.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
List all alliances List all active player alliances — This route is cached for up to 3600 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] :if_none_match ETag from a previous request. A 304 will be returned if this matches the current ETag @return [Array<Integer>]
# File lib/esi-client-bvv/api/alliance_api.rb, line 29 def get_alliances(opts = {}) data, _status_code, _headers = get_alliances_with_http_info(opts) return data end
Get alliance information Public information about an alliance — This route is cached for up to 3600 seconds @param alliance_id An EVE alliance 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] :if_none_match ETag from a previous request. A 304 will be returned if this matches the current ETag @return [GetAlliancesAllianceIdOk]
# File lib/esi-client-bvv/api/alliance_api.rb, line 88 def get_alliances_alliance_id(alliance_id, opts = {}) data, _status_code, _headers = get_alliances_alliance_id_with_http_info(alliance_id, opts) return data end
List alliance's corporations List all current member corporations of an alliance — This route is cached for up to 3600 seconds @param alliance_id An EVE alliance 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] :if_none_match ETag from a previous request. A 304 will be returned if this matches the current ETag @return [Array<Integer>]
# File lib/esi-client-bvv/api/alliance_api.rb, line 156 def get_alliances_alliance_id_corporations(alliance_id, opts = {}) data, _status_code, _headers = get_alliances_alliance_id_corporations_with_http_info(alliance_id, opts) return data end
List alliance's corporations List all current member corporations of an alliance — This route is cached for up to 3600 seconds @param alliance_id An EVE alliance ID @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from @option opts [String] :if_none_match ETag from a previous request. A 304 will be returned if this matches the current ETag @return [Array<(Array<Integer>, Fixnum, Hash)>] Array<Integer> data, response status code and response headers
# File lib/esi-client-bvv/api/alliance_api.rb, line 168 def get_alliances_alliance_id_corporations_with_http_info(alliance_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AllianceApi.get_alliances_alliance_id_corporations ..." end # verify the required parameter 'alliance_id' is set if @api_client.config.client_side_validation && alliance_id.nil? fail ArgumentError, "Missing the required parameter 'alliance_id' when calling AllianceApi.get_alliances_alliance_id_corporations" end if @api_client.config.client_side_validation && alliance_id < 1 fail ArgumentError, 'invalid value for "alliance_id" when calling AllianceApi.get_alliances_alliance_id_corporations, 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/alliances/{alliance_id}/corporations/".sub('{' + 'alliance_id' + '}', alliance_id.to_s) # query parameters query_params = {} query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].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<Integer>') if @api_client.config.debugging @api_client.config.logger.debug "API called: AllianceApi#get_alliances_alliance_id_corporations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get alliance icon Get the icon urls for a alliance — This route expires daily at 11:05 @param alliance_id An EVE alliance 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] :if_none_match ETag from a previous request. A 304 will be returned if this matches the current ETag @return [GetAlliancesAllianceIdIconsOk]
# File lib/esi-client-bvv/api/alliance_api.rb, line 224 def get_alliances_alliance_id_icons(alliance_id, opts = {}) data, _status_code, _headers = get_alliances_alliance_id_icons_with_http_info(alliance_id, opts) return data end
Get alliance icon Get the icon urls for a alliance — This route expires daily at 11:05 @param alliance_id An EVE alliance ID @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from @option opts [String] :if_none_match ETag from a previous request. A 304 will be returned if this matches the current ETag @return [Array<(GetAlliancesAllianceIdIconsOk
, Fixnum, Hash)>] GetAlliancesAllianceIdIconsOk
data, response status code and response headers
# File lib/esi-client-bvv/api/alliance_api.rb, line 236 def get_alliances_alliance_id_icons_with_http_info(alliance_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AllianceApi.get_alliances_alliance_id_icons ..." end # verify the required parameter 'alliance_id' is set if @api_client.config.client_side_validation && alliance_id.nil? fail ArgumentError, "Missing the required parameter 'alliance_id' when calling AllianceApi.get_alliances_alliance_id_icons" end if @api_client.config.client_side_validation && alliance_id < 1 fail ArgumentError, 'invalid value for "alliance_id" when calling AllianceApi.get_alliances_alliance_id_icons, 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/alliances/{alliance_id}/icons/".sub('{' + 'alliance_id' + '}', alliance_id.to_s) # query parameters query_params = {} query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].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 => 'GetAlliancesAllianceIdIconsOk') if @api_client.config.debugging @api_client.config.logger.debug "API called: AllianceApi#get_alliances_alliance_id_icons\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get alliance information Public information about an alliance — This route is cached for up to 3600 seconds @param alliance_id An EVE alliance ID @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from @option opts [String] :if_none_match ETag from a previous request. A 304 will be returned if this matches the current ETag @return [Array<(GetAlliancesAllianceIdOk
, Fixnum, Hash)>] GetAlliancesAllianceIdOk
data, response status code and response headers
# File lib/esi-client-bvv/api/alliance_api.rb, line 100 def get_alliances_alliance_id_with_http_info(alliance_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AllianceApi.get_alliances_alliance_id ..." end # verify the required parameter 'alliance_id' is set if @api_client.config.client_side_validation && alliance_id.nil? fail ArgumentError, "Missing the required parameter 'alliance_id' when calling AllianceApi.get_alliances_alliance_id" end if @api_client.config.client_side_validation && alliance_id < 1 fail ArgumentError, 'invalid value for "alliance_id" when calling AllianceApi.get_alliances_alliance_id, 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 = "/v3/alliances/{alliance_id}/".sub('{' + 'alliance_id' + '}', alliance_id.to_s) # query parameters query_params = {} query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].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 => 'GetAlliancesAllianceIdOk') if @api_client.config.debugging @api_client.config.logger.debug "API called: AllianceApi#get_alliances_alliance_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
List all alliances List all active player alliances — This route is cached for up to 3600 seconds @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from @option opts [String] :if_none_match ETag from a previous request. A 304 will be returned if this matches the current ETag @return [Array<(Array<Integer>, Fixnum, Hash)>] Array<Integer> data, response status code and response headers
# File lib/esi-client-bvv/api/alliance_api.rb, line 40 def get_alliances_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AllianceApi.get_alliances ..." 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/alliances/" # query parameters query_params = {} query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].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<Integer>') if @api_client.config.debugging @api_client.config.logger.debug "API called: AllianceApi#get_alliances\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end