class EsiClient::IndustryApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/esi-ruby/api/industry_api.rb, line 18
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

get_characters_character_id_industry_jobs(character_id, opts = {}) click to toggle source

List character industry jobs List industry jobs placed by a character — Alternate route: `/v1/characters/{character_id}/industry/jobs/` Alternate route: `/legacy/characters/{character_id}/industry/jobs/` Alternate route: `/dev/characters/{character_id}/industry/jobs/` — This route is cached for up to 300 seconds @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 [BOOLEAN] :include_completed Whether retrieve completed character industry jobs as well @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<GetCharactersCharacterIdIndustryJobs200Ok>]

# File lib/esi-ruby/api/industry_api.rb, line 32
def get_characters_character_id_industry_jobs(character_id, opts = {})
  data, _status_code, _headers = get_characters_character_id_industry_jobs_with_http_info(character_id, opts)
  return data
end
get_characters_character_id_industry_jobs_with_http_info(character_id, opts = {}) click to toggle source

List character industry jobs List industry jobs placed by a character — Alternate route: &#x60;/v1/characters/{character_id}/industry/jobs/&#x60; Alternate route: &#x60;/legacy/characters/{character_id}/industry/jobs/&#x60; Alternate route: &#x60;/dev/characters/{character_id}/industry/jobs/&#x60; — This route is cached for up to 300 seconds @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 [BOOLEAN] :include_completed Whether retrieve completed character industry jobs as well @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<(Array<GetCharactersCharacterIdIndustryJobs200Ok>, Fixnum, Hash)>] Array<GetCharactersCharacterIdIndustryJobs200Ok> data, response status code and response headers

# File lib/esi-ruby/api/industry_api.rb, line 47
def get_characters_character_id_industry_jobs_with_http_info(character_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IndustryApi.get_characters_character_id_industry_jobs ..."
  end
  # verify the required parameter 'character_id' is set
  fail ArgumentError, "Missing the required parameter 'character_id' when calling IndustryApi.get_characters_character_id_industry_jobs" if character_id.nil?
  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 = "/characters/{character_id}/industry/jobs/".sub('{format}','json').sub('{' + 'character_id' + '}', character_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil?
  query_params[:'include_completed'] = opts[:'include_completed'] if !opts[:'include_completed'].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 => 'Array<GetCharactersCharacterIdIndustryJobs200Ok>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IndustryApi#get_characters_character_id_industry_jobs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_industry_facilities(opts = {}) click to toggle source

List industry facilities Return a list of industry facilities — Alternate route: `/v1/industry/facilities/` Alternate route: `/legacy/industry/facilities/` Alternate route: `/dev/industry/facilities/` — 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<GetIndustryFacilities200Ok>]

# File lib/esi-ruby/api/industry_api.rb, line 98
def get_industry_facilities(opts = {})
  data, _status_code, _headers = get_industry_facilities_with_http_info(opts)
  return data
end
get_industry_facilities_with_http_info(opts = {}) click to toggle source

List industry facilities Return a list of industry facilities — Alternate route: &#x60;/v1/industry/facilities/&#x60; Alternate route: &#x60;/legacy/industry/facilities/&#x60; Alternate route: &#x60;/dev/industry/facilities/&#x60; — 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<GetIndustryFacilities200Ok>, Fixnum, Hash)>] Array<GetIndustryFacilities200Ok> data, response status code and response headers

# File lib/esi-ruby/api/industry_api.rb, line 110
def get_industry_facilities_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IndustryApi.get_industry_facilities ..."
  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 = "/industry/facilities/".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<GetIndustryFacilities200Ok>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IndustryApi#get_industry_facilities\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_industry_systems(opts = {}) click to toggle source

List solar system cost indices Return cost indices for solar systems — Alternate route: `/v1/industry/systems/` Alternate route: `/legacy/industry/systems/` Alternate route: `/dev/industry/systems/` — 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<GetIndustrySystems200Ok>]

# File lib/esi-ruby/api/industry_api.rb, line 157
def get_industry_systems(opts = {})
  data, _status_code, _headers = get_industry_systems_with_http_info(opts)
  return data
end
get_industry_systems_with_http_info(opts = {}) click to toggle source

List solar system cost indices Return cost indices for solar systems — Alternate route: &#x60;/v1/industry/systems/&#x60; Alternate route: &#x60;/legacy/industry/systems/&#x60; Alternate route: &#x60;/dev/industry/systems/&#x60; — 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<GetIndustrySystems200Ok>, Fixnum, Hash)>] Array<GetIndustrySystems200Ok> data, response status code and response headers

# File lib/esi-ruby/api/industry_api.rb, line 169
def get_industry_systems_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IndustryApi.get_industry_systems ..."
  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 = "/industry/systems/".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<GetIndustrySystems200Ok>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IndustryApi#get_industry_systems\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end