Class: EsiClient::IndustryApi

Inherits:
Object
  • Object
show all
Defined in:
lib/esi-ruby/api/industry_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ IndustryApi

Returns a new instance of IndustryApi.



18
19
20
 
# File 'lib/esi-ruby/api/industry_api.rb', line 18

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



16
17
18
 
# File 'lib/esi-ruby/api/industry_api.rb', line 16

def api_client
  @api_client
end

Instance Method Details

#get_characters_character_id_industry_jobs(character_id, opts = {}) ⇒ Array<GetCharactersCharacterIdIndustryJobs200Ok>

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

Parameters:

  • character_id —

    An EVE character ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from (default to tranquility)

  • :include_completed (BOOLEAN) —

    Whether retrieve completed character industry jobs as well

  • :token (String) —

    Access token to use if unable to set a header

  • :user_agent (String) —

    Client identifier, takes precedence over headers

  • :x_user_agent (String) —

    Client identifier, takes precedence over User-Agent

Returns:



32
33
34
35
 
# 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 = {}) ⇒ Array<(Array<GetCharactersCharacterIdIndustryJobs200Ok>, Fixnum, Hash)>

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

Parameters:

  • character_id —

    An EVE character ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from

  • :include_completed (BOOLEAN) —

    Whether retrieve completed character industry jobs as well

  • :token (String) —

    Access token to use if unable to set a header

  • :user_agent (String) —

    Client identifier, takes precedence over headers

  • :x_user_agent (String) —

    Client identifier, takes precedence over User-Agent

Returns:



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# 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 = {}) ⇒ Array<GetIndustryFacilities200Ok>

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

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from (default to tranquility)

  • :user_agent (String) —

    Client identifier, takes precedence over headers

  • :x_user_agent (String) —

    Client identifier, takes precedence over User-Agent

Returns:



98
99
100
101
 
# 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 = {}) ⇒ Array<(Array<GetIndustryFacilities200Ok>, Fixnum, Hash)>

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

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from

  • :user_agent (String) —

    Client identifier, takes precedence over headers

  • :x_user_agent (String) —

    Client identifier, takes precedence over User-Agent

Returns:

  • (Array<(Array<GetIndustryFacilities200Ok>, Fixnum, Hash)>) —

    Array<GetIndustryFacilities200Ok> data, response status code and response headers



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# 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 = {}) ⇒ Array<GetIndustrySystems200Ok>

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

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from (default to tranquility)

  • :user_agent (String) —

    Client identifier, takes precedence over headers

  • :x_user_agent (String) —

    Client identifier, takes precedence over User-Agent

Returns:



157
158
159
160
 
# 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 = {}) ⇒ Array<(Array<GetIndustrySystems200Ok>, Fixnum, Hash)>

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

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from

  • :user_agent (String) —

    Client identifier, takes precedence over headers

  • :x_user_agent (String) —

    Client identifier, takes precedence over User-Agent

Returns:

  • (Array<(Array<GetIndustrySystems200Ok>, Fixnum, Hash)>) —

    Array<GetIndustrySystems200Ok> data, response status code and response headers



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# 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