class EsiClient::CorporationApi

Attributes

api_client[RW]

Public Class Methods

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

Public Instance Methods

get_corporations_corporation_id(corporation_id, opts = {}) click to toggle source

Get corporation information Public information about a corporation — Alternate route: `/v3/corporations/{corporation_id}/` Alternate route: `/dev/corporations/{corporation_id}/` — This route is cached for up to 3600 seconds @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] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [GetCorporationsCorporationIdOk]

# File lib/esi-ruby/api/corporation_api.rb, line 30
def get_corporations_corporation_id(corporation_id, opts = {})
  data, _status_code, _headers = get_corporations_corporation_id_with_http_info(corporation_id, opts)
  return data
end
get_corporations_corporation_id_alliancehistory(corporation_id, opts = {}) click to toggle source

Get alliance history Get a list of all the alliances a corporation has been a member of — Alternate route: `/v1/corporations/{corporation_id}/alliancehistory/` Alternate route: `/legacy/corporations/{corporation_id}/alliancehistory/` — This route is cached for up to 3600 seconds @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] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [Array<GetCorporationsCorporationIdAlliancehistory200Ok>]

# File lib/esi-ruby/api/corporation_api.rb, line 93
def get_corporations_corporation_id_alliancehistory(corporation_id, opts = {})
  data, _status_code, _headers = get_corporations_corporation_id_alliancehistory_with_http_info(corporation_id, opts)
  return data
end
get_corporations_corporation_id_alliancehistory_with_http_info(corporation_id, opts = {}) click to toggle source

Get alliance history Get a list of all the alliances a corporation has been a member of — Alternate route: &#x60;/v1/corporations/{corporation_id}/alliancehistory/&#x60; Alternate route: &#x60;/legacy/corporations/{corporation_id}/alliancehistory/&#x60; — This route is cached for up to 3600 seconds @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] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [Array<(Array<GetCorporationsCorporationIdAlliancehistory200Ok>, Fixnum, Hash)>] Array<GetCorporationsCorporationIdAlliancehistory200Ok> data, response status code and response headers

# File lib/esi-ruby/api/corporation_api.rb, line 106
def get_corporations_corporation_id_alliancehistory_with_http_info(corporation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CorporationApi.get_corporations_corporation_id_alliancehistory ..."
  end
  # verify the required parameter 'corporation_id' is set
  fail ArgumentError, "Missing the required parameter 'corporation_id' when calling CorporationApi.get_corporations_corporation_id_alliancehistory" if corporation_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 = "/corporations/{corporation_id}/alliancehistory/".sub('{format}','json').sub('{' + 'corporation_id' + '}', corporation_id.to_s)

  # 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<GetCorporationsCorporationIdAlliancehistory200Ok>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CorporationApi#get_corporations_corporation_id_alliancehistory\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_corporations_corporation_id_icons(corporation_id, opts = {}) click to toggle source

Get corporation icon Get the icon urls for a corporation — Alternate route: `/v1/corporations/{corporation_id}/icons/` Alternate route: `/legacy/corporations/{corporation_id}/icons/` Alternate route: `/dev/corporations/{corporation_id}/icons/` — This route is cached for up to 3600 seconds @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] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [GetCorporationsCorporationIdIconsOk]

# File lib/esi-ruby/api/corporation_api.rb, line 156
def get_corporations_corporation_id_icons(corporation_id, opts = {})
  data, _status_code, _headers = get_corporations_corporation_id_icons_with_http_info(corporation_id, opts)
  return data
end
get_corporations_corporation_id_icons_with_http_info(corporation_id, opts = {}) click to toggle source

Get corporation icon Get the icon urls for a corporation — Alternate route: &#x60;/v1/corporations/{corporation_id}/icons/&#x60; Alternate route: &#x60;/legacy/corporations/{corporation_id}/icons/&#x60; Alternate route: &#x60;/dev/corporations/{corporation_id}/icons/&#x60; — This route is cached for up to 3600 seconds @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] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [Array<(GetCorporationsCorporationIdIconsOk, Fixnum, Hash)>] GetCorporationsCorporationIdIconsOk data, response status code and response headers

# File lib/esi-ruby/api/corporation_api.rb, line 169
def get_corporations_corporation_id_icons_with_http_info(corporation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CorporationApi.get_corporations_corporation_id_icons ..."
  end
  # verify the required parameter 'corporation_id' is set
  fail ArgumentError, "Missing the required parameter 'corporation_id' when calling CorporationApi.get_corporations_corporation_id_icons" if corporation_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 = "/corporations/{corporation_id}/icons/".sub('{format}','json').sub('{' + 'corporation_id' + '}', corporation_id.to_s)

  # 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 => 'GetCorporationsCorporationIdIconsOk')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CorporationApi#get_corporations_corporation_id_icons\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_corporations_corporation_id_members(corporation_id, opts = {}) click to toggle source

Get corporation members Read the current list of members if the calling character is a member. — Alternate route: `/v2/corporations/{corporation_id}/members/` Alternate route: `/legacy/corporations/{corporation_id}/members/` — This route is cached for up to 3600 seconds @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 [Array<GetCorporationsCorporationIdMembers200Ok>]

# File lib/esi-ruby/api/corporation_api.rb, line 220
def get_corporations_corporation_id_members(corporation_id, opts = {})
  data, _status_code, _headers = get_corporations_corporation_id_members_with_http_info(corporation_id, opts)
  return data
end
get_corporations_corporation_id_members_with_http_info(corporation_id, opts = {}) click to toggle source

Get corporation members Read the current list of members if the calling character is a member. — Alternate route: &#x60;/v2/corporations/{corporation_id}/members/&#x60; Alternate route: &#x60;/legacy/corporations/{corporation_id}/members/&#x60; — This route is cached for up to 3600 seconds @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<(Array<GetCorporationsCorporationIdMembers200Ok>, Fixnum, Hash)>] Array<GetCorporationsCorporationIdMembers200Ok> data, response status code and response headers

# File lib/esi-ruby/api/corporation_api.rb, line 234
def get_corporations_corporation_id_members_with_http_info(corporation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CorporationApi.get_corporations_corporation_id_members ..."
  end
  # verify the required parameter 'corporation_id' is set
  fail ArgumentError, "Missing the required parameter 'corporation_id' when calling CorporationApi.get_corporations_corporation_id_members" if corporation_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 = "/corporations/{corporation_id}/members/".sub('{format}','json').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 => 'Array<GetCorporationsCorporationIdMembers200Ok>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CorporationApi#get_corporations_corporation_id_members\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_corporations_corporation_id_roles(corporation_id, opts = {}) click to toggle source

Get corporation member roles Return the roles of all members if the character has the personnel manager role or any grantable role. — Alternate route: `/v1/corporations/{corporation_id}/roles/` Alternate route: `/legacy/corporations/{corporation_id}/roles/` Alternate route: `/dev/corporations/{corporation_id}/roles/` — This route is cached for up to 3600 seconds @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 [Array<GetCorporationsCorporationIdRoles200Ok>]

# File lib/esi-ruby/api/corporation_api.rb, line 286
def get_corporations_corporation_id_roles(corporation_id, opts = {})
  data, _status_code, _headers = get_corporations_corporation_id_roles_with_http_info(corporation_id, opts)
  return data
end
get_corporations_corporation_id_roles_with_http_info(corporation_id, opts = {}) click to toggle source

Get corporation member roles Return the roles of all members if the character has the personnel manager role or any grantable role. — Alternate route: &#x60;/v1/corporations/{corporation_id}/roles/&#x60; Alternate route: &#x60;/legacy/corporations/{corporation_id}/roles/&#x60; Alternate route: &#x60;/dev/corporations/{corporation_id}/roles/&#x60; — This route is cached for up to 3600 seconds @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<(Array<GetCorporationsCorporationIdRoles200Ok>, Fixnum, Hash)>] Array<GetCorporationsCorporationIdRoles200Ok> data, response status code and response headers

# File lib/esi-ruby/api/corporation_api.rb, line 300
def get_corporations_corporation_id_roles_with_http_info(corporation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CorporationApi.get_corporations_corporation_id_roles ..."
  end
  # verify the required parameter 'corporation_id' is set
  fail ArgumentError, "Missing the required parameter 'corporation_id' when calling CorporationApi.get_corporations_corporation_id_roles" if corporation_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 = "/corporations/{corporation_id}/roles/".sub('{format}','json').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 => 'Array<GetCorporationsCorporationIdRoles200Ok>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CorporationApi#get_corporations_corporation_id_roles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_corporations_corporation_id_structures(corporation_id, opts = {}) click to toggle source

Get corporation structures Get a list of corporation structures — Alternate route: `/v1/corporations/{corporation_id}/structures/` Alternate route: `/legacy/corporations/{corporation_id}/structures/` Alternate route: `/dev/corporations/{corporation_id}/structures/` — This route is cached for up to 3600 seconds @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] :language Language to use in the response (default to en-us) @option opts [Integer] :page Which page of results to return (default to 1) @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<GetCorporationsCorporationIdStructures200Ok>]

# File lib/esi-ruby/api/corporation_api.rb, line 354
def get_corporations_corporation_id_structures(corporation_id, opts = {})
  data, _status_code, _headers = get_corporations_corporation_id_structures_with_http_info(corporation_id, opts)
  return data
end
get_corporations_corporation_id_structures_with_http_info(corporation_id, opts = {}) click to toggle source

Get corporation structures Get a list of corporation structures — Alternate route: &#x60;/v1/corporations/{corporation_id}/structures/&#x60; Alternate route: &#x60;/legacy/corporations/{corporation_id}/structures/&#x60; Alternate route: &#x60;/dev/corporations/{corporation_id}/structures/&#x60; — This route is cached for up to 3600 seconds @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] :language Language to use in the response @option opts [Integer] :page Which page of results to return @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<GetCorporationsCorporationIdStructures200Ok>, Fixnum, Hash)>] Array<GetCorporationsCorporationIdStructures200Ok> data, response status code and response headers

# File lib/esi-ruby/api/corporation_api.rb, line 370
def get_corporations_corporation_id_structures_with_http_info(corporation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CorporationApi.get_corporations_corporation_id_structures ..."
  end
  # verify the required parameter 'corporation_id' is set
  fail ArgumentError, "Missing the required parameter 'corporation_id' when calling CorporationApi.get_corporations_corporation_id_structures" if corporation_id.nil?
  if opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity'
  end
  if opts[:'language'] && !['de', 'en-us', 'fr', 'ja', 'ru', 'zh'].include?(opts[:'language'])
    fail ArgumentError, 'invalid value for "language", must be one of de, en-us, fr, ja, ru, zh'
  end
  # resource path
  local_var_path = "/corporations/{corporation_id}/structures/".sub('{format}','json').sub('{' + 'corporation_id' + '}', corporation_id.to_s)

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

Get corporation information Public information about a corporation — Alternate route: &#x60;/v3/corporations/{corporation_id}/&#x60; Alternate route: &#x60;/dev/corporations/{corporation_id}/&#x60; — This route is cached for up to 3600 seconds @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] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [Array<(GetCorporationsCorporationIdOk, Fixnum, Hash)>] GetCorporationsCorporationIdOk data, response status code and response headers

# File lib/esi-ruby/api/corporation_api.rb, line 43
def get_corporations_corporation_id_with_http_info(corporation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CorporationApi.get_corporations_corporation_id ..."
  end
  # verify the required parameter 'corporation_id' is set
  fail ArgumentError, "Missing the required parameter 'corporation_id' when calling CorporationApi.get_corporations_corporation_id" if corporation_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 = "/corporations/{corporation_id}/".sub('{format}','json').sub('{' + 'corporation_id' + '}', corporation_id.to_s)

  # 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 => 'GetCorporationsCorporationIdOk')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CorporationApi#get_corporations_corporation_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_corporations_names(corporation_ids, opts = {}) click to toggle source

Get corporation names Resolve a set of corporation IDs to corporation names — Alternate route: `/v1/corporations/names/` Alternate route: `/legacy/corporations/names/` — This route is cached for up to 3600 seconds @param corporation_ids A comma separated list of corporation IDs @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<GetCorporationsNames200Ok>]

# File lib/esi-ruby/api/corporation_api.rb, line 426
def get_corporations_names(corporation_ids, opts = {})
  data, _status_code, _headers = get_corporations_names_with_http_info(corporation_ids, opts)
  return data
end
get_corporations_names_with_http_info(corporation_ids, opts = {}) click to toggle source

Get corporation names Resolve a set of corporation IDs to corporation names — Alternate route: &#x60;/v1/corporations/names/&#x60; Alternate route: &#x60;/legacy/corporations/names/&#x60; — This route is cached for up to 3600 seconds @param corporation_ids A comma separated list of corporation IDs @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<GetCorporationsNames200Ok>, Fixnum, Hash)>] Array<GetCorporationsNames200Ok> data, response status code and response headers

# File lib/esi-ruby/api/corporation_api.rb, line 439
def get_corporations_names_with_http_info(corporation_ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CorporationApi.get_corporations_names ..."
  end
  # verify the required parameter 'corporation_ids' is set
  fail ArgumentError, "Missing the required parameter 'corporation_ids' when calling CorporationApi.get_corporations_names" if corporation_ids.nil?
  if corporation_ids.length > 100
    fail ArgumentError, 'invalid value for "corporation_ids" when calling CorporationApi.get_corporations_names, number of items must be less than or equal to 100.'
  end

  if corporation_ids.length < 1
    fail ArgumentError, 'invalid value for "corporation_ids" when calling CorporationApi.get_corporations_names, number of items must be greater than or equal to 1.'
  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 = "/corporations/names/".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'corporation_ids'] = @api_client.build_collection_param(corporation_ids, :csv)
  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<GetCorporationsNames200Ok>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CorporationApi#get_corporations_names\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_corporations_npccorps(opts = {}) click to toggle source

Get npc corporations Get a list of npc corporations — Alternate route: `/v1/corporations/npccorps/` Alternate route: `/legacy/corporations/npccorps/` Alternate route: `/dev/corporations/npccorps/` — 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<Integer>]

# File lib/esi-ruby/api/corporation_api.rb, line 497
def get_corporations_npccorps(opts = {})
  data, _status_code, _headers = get_corporations_npccorps_with_http_info(opts)
  return data
end
get_corporations_npccorps_with_http_info(opts = {}) click to toggle source

Get npc corporations Get a list of npc corporations — Alternate route: &#x60;/v1/corporations/npccorps/&#x60; Alternate route: &#x60;/legacy/corporations/npccorps/&#x60; Alternate route: &#x60;/dev/corporations/npccorps/&#x60; — 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<Integer>, Fixnum, Hash)>] Array<Integer> data, response status code and response headers

# File lib/esi-ruby/api/corporation_api.rb, line 509
def get_corporations_npccorps_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CorporationApi.get_corporations_npccorps ..."
  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 = "/corporations/npccorps/".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<Integer>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CorporationApi#get_corporations_npccorps\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
put_corporations_corporation_id_structures_structure_id(corporation_id, new_schedule, structure_id, opts = {}) click to toggle source

Update structure vulnerability schedule Update the vulnerability window schedule of a corporation structure — Alternate route: `/v1/corporations/{corporation_id}/structures/{structure_id}/` Alternate route: `/legacy/corporations/{corporation_id}/structures/{structure_id}/` Alternate route: `/dev/corporations/{corporation_id}/structures/{structure_id}/` @param corporation_id An EVE corporation ID @param new_schedule New vulnerability window schedule for the structure @param structure_id A structure 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 [nil]

# File lib/esi-ruby/api/corporation_api.rb, line 560
def put_corporations_corporation_id_structures_structure_id(corporation_id, new_schedule, structure_id, opts = {})
  put_corporations_corporation_id_structures_structure_id_with_http_info(corporation_id, new_schedule, structure_id, opts)
  return nil
end
put_corporations_corporation_id_structures_structure_id_with_http_info(corporation_id, new_schedule, structure_id, opts = {}) click to toggle source

Update structure vulnerability schedule Update the vulnerability window schedule of a corporation structure — Alternate route: &#x60;/v1/corporations/{corporation_id}/structures/{structure_id}/&#x60; Alternate route: &#x60;/legacy/corporations/{corporation_id}/structures/{structure_id}/&#x60; Alternate route: &#x60;/dev/corporations/{corporation_id}/structures/{structure_id}/&#x60; @param corporation_id An EVE corporation ID @param new_schedule New vulnerability window schedule for the structure @param structure_id A structure 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<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/esi-ruby/api/corporation_api.rb, line 576
def put_corporations_corporation_id_structures_structure_id_with_http_info(corporation_id, new_schedule, structure_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CorporationApi.put_corporations_corporation_id_structures_structure_id ..."
  end
  # verify the required parameter 'corporation_id' is set
  fail ArgumentError, "Missing the required parameter 'corporation_id' when calling CorporationApi.put_corporations_corporation_id_structures_structure_id" if corporation_id.nil?
  # verify the required parameter 'new_schedule' is set
  fail ArgumentError, "Missing the required parameter 'new_schedule' when calling CorporationApi.put_corporations_corporation_id_structures_structure_id" if new_schedule.nil?
  # verify the required parameter 'structure_id' is set
  fail ArgumentError, "Missing the required parameter 'structure_id' when calling CorporationApi.put_corporations_corporation_id_structures_structure_id" if structure_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 = "/corporations/{corporation_id}/structures/{structure_id}/".sub('{format}','json').sub('{' + 'corporation_id' + '}', corporation_id.to_s).sub('{' + 'structure_id' + '}', structure_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 = @api_client.object_to_http_body(new_schedule)
  auth_names = ['evesso']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CorporationApi#put_corporations_corporation_id_structures_structure_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end