class EsiClient::SovereigntyApi
Attributes
Public Class Methods
# File lib/esi-ruby/api/sovereignty_api.rb, line 18 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
List sovereignty campaigns Shows sovereignty data for campaigns. — Alternate route: `/v1/sovereignty/campaigns/` Alternate route: `/legacy/sovereignty/campaigns/` Alternate route: `/dev/sovereignty/campaigns/` — This route is cached for up to 5 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<GetSovereigntyCampaigns200Ok>]
# File lib/esi-ruby/api/sovereignty_api.rb, line 29 def get_sovereignty_campaigns(opts = {}) data, _status_code, _headers = get_sovereignty_campaigns_with_http_info(opts) return data end
List sovereignty campaigns Shows sovereignty data for campaigns. — Alternate route: `/v1/sovereignty/campaigns/` Alternate route: `/legacy/sovereignty/campaigns/` Alternate route: `/dev/sovereignty/campaigns/` — This route is cached for up to 5 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<GetSovereigntyCampaigns200Ok>, Fixnum, Hash)>] Array<GetSovereigntyCampaigns200Ok> data, response status code and response headers
# File lib/esi-ruby/api/sovereignty_api.rb, line 41 def get_sovereignty_campaigns_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: SovereigntyApi.get_sovereignty_campaigns ..." end if 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 = "/sovereignty/campaigns/".sub('{format}','json') # 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<GetSovereigntyCampaigns200Ok>') if @api_client.config.debugging @api_client.config.logger.debug "API called: SovereigntyApi#get_sovereignty_campaigns\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
List sovereignty of systems Shows sovereignty information for solar systems — Alternate route: `/v1/sovereignty/map/` Alternate route: `/legacy/sovereignty/map/` Alternate route: `/dev/sovereignty/map/` — 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] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [Array<GetSovereigntyMap200Ok>]
# File lib/esi-ruby/api/sovereignty_api.rb, line 88 def get_sovereignty_map(opts = {}) data, _status_code, _headers = get_sovereignty_map_with_http_info(opts) return data end
List sovereignty of systems Shows sovereignty information for solar systems — Alternate route: `/v1/sovereignty/map/` Alternate route: `/legacy/sovereignty/map/` Alternate route: `/dev/sovereignty/map/` — 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] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [Array<(Array<GetSovereigntyMap200Ok>, Fixnum, Hash)>] Array<GetSovereigntyMap200Ok> data, response status code and response headers
# File lib/esi-ruby/api/sovereignty_api.rb, line 100 def get_sovereignty_map_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: SovereigntyApi.get_sovereignty_map ..." end if 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 = "/sovereignty/map/".sub('{format}','json') # 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<GetSovereigntyMap200Ok>') if @api_client.config.debugging @api_client.config.logger.debug "API called: SovereigntyApi#get_sovereignty_map\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
List sovereignty structures Shows sovereignty data for structures. — Alternate route: `/v1/sovereignty/structures/` Alternate route: `/legacy/sovereignty/structures/` Alternate route: `/dev/sovereignty/structures/` — This route is cached for up to 120 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<GetSovereigntyStructures200Ok>]
# File lib/esi-ruby/api/sovereignty_api.rb, line 147 def get_sovereignty_structures(opts = {}) data, _status_code, _headers = get_sovereignty_structures_with_http_info(opts) return data end
List sovereignty structures Shows sovereignty data for structures. — Alternate route: `/v1/sovereignty/structures/` Alternate route: `/legacy/sovereignty/structures/` Alternate route: `/dev/sovereignty/structures/` — This route is cached for up to 120 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<GetSovereigntyStructures200Ok>, Fixnum, Hash)>] Array<GetSovereigntyStructures200Ok> data, response status code and response headers
# File lib/esi-ruby/api/sovereignty_api.rb, line 159 def get_sovereignty_structures_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: SovereigntyApi.get_sovereignty_structures ..." end if 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 = "/sovereignty/structures/".sub('{format}','json') # 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<GetSovereigntyStructures200Ok>') if @api_client.config.debugging @api_client.config.logger.debug "API called: SovereigntyApi#get_sovereignty_structures\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end