Class: ESI::ContractsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/esi-client-bvv/api/contracts_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ContractsApi

Returns a new instance of ContractsApi.



19
20
21
 
# File 'lib/esi-client-bvv/api/contracts_api.rb', line 19

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/esi-client-bvv/api/contracts_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_characters_character_id_contracts(character_id, opts = {}) ⇒ Array<GetCharactersCharacterIdContracts200Ok>

Get contracts Returns contracts available to a character, only if the character is issuer, acceptor or assignee. Only returns contracts no older than 30 days, or if the status is "in_progress". — 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)

  • :if_none_match (String) —

    ETag from a previous request. A 304 will be returned if this matches the current ETag

  • :page (Integer) —

    Which page of results to return (default to 1)

  • :token (String) —

    Access token to use if unable to set a header

Returns:



32
33
34
35
 
# File 'lib/esi-client-bvv/api/contracts_api.rb', line 32

def get_characters_character_id_contracts(character_id, opts = {})
  data, _status_code, _headers = get_characters_character_id_contracts_with_http_info(character_id, opts)
  return data
end

#get_characters_character_id_contracts_contract_id_bids(character_id, contract_id, opts = {}) ⇒ Array<GetCharactersCharacterIdContractsContractIdBids200Ok>

Get contract bids Lists bids on a particular auction contract — This route is cached for up to 300 seconds

Parameters:

  • character_id —

    An EVE character ID

  • contract_id —

    ID of a contract

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

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

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

  • :if_none_match (String) —

    ETag from a previous request. A 304 will be returned if this matches the current ETag

  • :token (String) —

    Access token to use if unable to set a header

Returns:



110
111
112
113
 
# File 'lib/esi-client-bvv/api/contracts_api.rb', line 110

def get_characters_character_id_contracts_contract_id_bids(character_id, contract_id, opts = {})
  data, _status_code, _headers = get_characters_character_id_contracts_contract_id_bids_with_http_info(character_id, contract_id, opts)
  return data
end

#get_characters_character_id_contracts_contract_id_bids_with_http_info(character_id, contract_id, opts = {}) ⇒ Array<(Array<GetCharactersCharacterIdContractsContractIdBids200Ok>, Fixnum, Hash)>

Get contract bids Lists bids on a particular auction contract — This route is cached for up to 300 seconds

Parameters:

  • character_id —

    An EVE character ID

  • contract_id —

    ID of a contract

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

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from

  • :if_none_match (String) —

    ETag from a previous request. A 304 will be returned if this matches the current ETag

  • :token (String) —

    Access token to use if unable to set a header

Returns:



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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/esi-client-bvv/api/contracts_api.rb', line 124

def get_characters_character_id_contracts_contract_id_bids_with_http_info(character_id, contract_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ContractsApi.get_characters_character_id_contracts_contract_id_bids ..."
  end
  # verify the required parameter 'character_id' is set
  if @api_client.config.client_side_validation && character_id.nil?
    fail ArgumentError, "Missing the required parameter 'character_id' when calling ContractsApi.get_characters_character_id_contracts_contract_id_bids"
  end
  if @api_client.config.client_side_validation && character_id < 1
    fail ArgumentError, 'invalid value for "character_id" when calling ContractsApi.get_characters_character_id_contracts_contract_id_bids, must be greater than or equal to 1.'
  end

  # verify the required parameter 'contract_id' is set
  if @api_client.config.client_side_validation && contract_id.nil?
    fail ArgumentError, "Missing the required parameter 'contract_id' when calling ContractsApi.get_characters_character_id_contracts_contract_id_bids"
  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/characters/{character_id}/contracts/{contract_id}/bids/".sub('{' + 'character_id' + '}', character_id.to_s).sub('{' + 'contract_id' + '}', contract_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?

  # 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 = ['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<GetCharactersCharacterIdContractsContractIdBids200Ok>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContractsApi#get_characters_character_id_contracts_contract_id_bids\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_characters_character_id_contracts_contract_id_items(character_id, contract_id, opts = {}) ⇒ Array<GetCharactersCharacterIdContractsContractIdItems200Ok>

Get contract items Lists items of a particular contract — This route is cached for up to 3600 seconds

Parameters:

  • character_id —

    An EVE character ID

  • contract_id —

    ID of a contract

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

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

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

  • :if_none_match (String) —

    ETag from a previous request. A 304 will be returned if this matches the current ETag

  • :token (String) —

    Access token to use if unable to set a header

Returns:



187
188
189
190
 
# File 'lib/esi-client-bvv/api/contracts_api.rb', line 187

def get_characters_character_id_contracts_contract_id_items(character_id, contract_id, opts = {})
  data, _status_code, _headers = get_characters_character_id_contracts_contract_id_items_with_http_info(character_id, contract_id, opts)
  return data
end

#get_characters_character_id_contracts_contract_id_items_with_http_info(character_id, contract_id, opts = {}) ⇒ Array<(Array<GetCharactersCharacterIdContractsContractIdItems200Ok>, Fixnum, Hash)>

Get contract items Lists items of a particular contract — This route is cached for up to 3600 seconds

Parameters:

  • character_id —

    An EVE character ID

  • contract_id —

    ID of a contract

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

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from

  • :if_none_match (String) —

    ETag from a previous request. A 304 will be returned if this matches the current ETag

  • :token (String) —

    Access token to use if unable to set a header

Returns:



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/esi-client-bvv/api/contracts_api.rb', line 201

def get_characters_character_id_contracts_contract_id_items_with_http_info(character_id, contract_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ContractsApi.get_characters_character_id_contracts_contract_id_items ..."
  end
  # verify the required parameter 'character_id' is set
  if @api_client.config.client_side_validation && character_id.nil?
    fail ArgumentError, "Missing the required parameter 'character_id' when calling ContractsApi.get_characters_character_id_contracts_contract_id_items"
  end
  if @api_client.config.client_side_validation && character_id < 1
    fail ArgumentError, 'invalid value for "character_id" when calling ContractsApi.get_characters_character_id_contracts_contract_id_items, must be greater than or equal to 1.'
  end

  # verify the required parameter 'contract_id' is set
  if @api_client.config.client_side_validation && contract_id.nil?
    fail ArgumentError, "Missing the required parameter 'contract_id' when calling ContractsApi.get_characters_character_id_contracts_contract_id_items"
  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/characters/{character_id}/contracts/{contract_id}/items/".sub('{' + 'character_id' + '}', character_id.to_s).sub('{' + 'contract_id' + '}', contract_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?

  # 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 = ['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<GetCharactersCharacterIdContractsContractIdItems200Ok>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContractsApi#get_characters_character_id_contracts_contract_id_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_characters_character_id_contracts_with_http_info(character_id, opts = {}) ⇒ Array<(Array<GetCharactersCharacterIdContracts200Ok>, Fixnum, Hash)>

Get contracts Returns contracts available to a character, only if the character is issuer, acceptor or assignee. Only returns contracts no older than 30 days, or if the status is &quot;in_progress&quot;. — 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

  • :if_none_match (String) —

    ETag from a previous request. A 304 will be returned if this matches the current ETag

  • :page (Integer) —

    Which page of results to return

  • :token (String) —

    Access token to use if unable to set a header

Returns:



46
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
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/esi-client-bvv/api/contracts_api.rb', line 46

def get_characters_character_id_contracts_with_http_info(character_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ContractsApi.get_characters_character_id_contracts ..."
  end
  # verify the required parameter 'character_id' is set
  if @api_client.config.client_side_validation && character_id.nil?
    fail ArgumentError, "Missing the required parameter 'character_id' when calling ContractsApi.get_characters_character_id_contracts"
  end
  if @api_client.config.client_side_validation && character_id < 1
    fail ArgumentError, 'invalid value for "character_id" when calling ContractsApi.get_characters_character_id_contracts, 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
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling ContractsApi.get_characters_character_id_contracts, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = "/v1/characters/{character_id}/contracts/".sub('{' + 'character_id' + '}', character_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'token'] = opts[:'token'] if !opts[:'token'].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 = ['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<GetCharactersCharacterIdContracts200Ok>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContractsApi#get_characters_character_id_contracts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_contracts_public_bids_contract_id(contract_id, opts = {}) ⇒ Array<GetContractsPublicBidsContractId200Ok>

Get public contract bids Lists bids on a public auction contract — This route is cached for up to 300 seconds

Parameters:

  • contract_id —

    ID of a contract

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

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

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

  • :if_none_match (String) —

    ETag from a previous request. A 304 will be returned if this matches the current ETag

  • :page (Integer) —

    Which page of results to return (default to 1)

Returns:



263
264
265
266
 
# File 'lib/esi-client-bvv/api/contracts_api.rb', line 263

def get_contracts_public_bids_contract_id(contract_id, opts = {})
  data, _status_code, _headers = get_contracts_public_bids_contract_id_with_http_info(contract_id, opts)
  return data
end

#get_contracts_public_bids_contract_id_with_http_info(contract_id, opts = {}) ⇒ Array<(Array<GetContractsPublicBidsContractId200Ok>, Fixnum, Hash)>

Get public contract bids Lists bids on a public auction contract — This route is cached for up to 300 seconds

Parameters:

  • contract_id —

    ID of a contract

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

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from

  • :if_none_match (String) —

    ETag from a previous request. A 304 will be returned if this matches the current ETag

  • :page (Integer) —

    Which page of results to return

Returns:



276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/esi-client-bvv/api/contracts_api.rb', line 276

def get_contracts_public_bids_contract_id_with_http_info(contract_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ContractsApi.get_contracts_public_bids_contract_id ..."
  end
  # verify the required parameter 'contract_id' is set
  if @api_client.config.client_side_validation && contract_id.nil?
    fail ArgumentError, "Missing the required parameter 'contract_id' when calling ContractsApi.get_contracts_public_bids_contract_id"
  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
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling ContractsApi.get_contracts_public_bids_contract_id, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = "/v1/contracts/public/bids/{contract_id}/".sub('{' + 'contract_id' + '}', contract_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].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<GetContractsPublicBidsContractId200Ok>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContractsApi#get_contracts_public_bids_contract_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_contracts_public_items_contract_id(contract_id, opts = {}) ⇒ Array<GetContractsPublicItemsContractId200Ok>

Get public contract items Lists items of a public contract — This route is cached for up to 3600 seconds

Parameters:

  • contract_id —

    ID of a contract

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

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

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

  • :if_none_match (String) —

    ETag from a previous request. A 304 will be returned if this matches the current ETag

  • :page (Integer) —

    Which page of results to return (default to 1)

Returns:



334
335
336
337
 
# File 'lib/esi-client-bvv/api/contracts_api.rb', line 334

def get_contracts_public_items_contract_id(contract_id, opts = {})
  data, _status_code, _headers = get_contracts_public_items_contract_id_with_http_info(contract_id, opts)
  return data
end

#get_contracts_public_items_contract_id_with_http_info(contract_id, opts = {}) ⇒ Array<(Array<GetContractsPublicItemsContractId200Ok>, Fixnum, Hash)>

Get public contract items Lists items of a public contract — This route is cached for up to 3600 seconds

Parameters:

  • contract_id —

    ID of a contract

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

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from

  • :if_none_match (String) —

    ETag from a previous request. A 304 will be returned if this matches the current ETag

  • :page (Integer) —

    Which page of results to return

Returns:



347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
 
# File 'lib/esi-client-bvv/api/contracts_api.rb', line 347

def get_contracts_public_items_contract_id_with_http_info(contract_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ContractsApi.get_contracts_public_items_contract_id ..."
  end
  # verify the required parameter 'contract_id' is set
  if @api_client.config.client_side_validation && contract_id.nil?
    fail ArgumentError, "Missing the required parameter 'contract_id' when calling ContractsApi.get_contracts_public_items_contract_id"
  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
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling ContractsApi.get_contracts_public_items_contract_id, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = "/v1/contracts/public/items/{contract_id}/".sub('{' + 'contract_id' + '}', contract_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].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<GetContractsPublicItemsContractId200Ok>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContractsApi#get_contracts_public_items_contract_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_contracts_public_region_id(region_id, opts = {}) ⇒ Array<GetContractsPublicRegionId200Ok>

Get public contracts Returns a paginated list of all public contracts in the given region — This route is cached for up to 1800 seconds

Parameters:

  • region_id —

    An EVE region id

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

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

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

  • :if_none_match (String) —

    ETag from a previous request. A 304 will be returned if this matches the current ETag

  • :page (Integer) —

    Which page of results to return (default to 1)

Returns:



405
406
407
408
 
# File 'lib/esi-client-bvv/api/contracts_api.rb', line 405

def get_contracts_public_region_id(region_id, opts = {})
  data, _status_code, _headers = get_contracts_public_region_id_with_http_info(region_id, opts)
  return data
end

#get_contracts_public_region_id_with_http_info(region_id, opts = {}) ⇒ Array<(Array<GetContractsPublicRegionId200Ok>, Fixnum, Hash)>

Get public contracts Returns a paginated list of all public contracts in the given region — This route is cached for up to 1800 seconds

Parameters:

  • region_id —

    An EVE region id

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

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from

  • :if_none_match (String) —

    ETag from a previous request. A 304 will be returned if this matches the current ETag

  • :page (Integer) —

    Which page of results to return

Returns:

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

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



418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
 
# File 'lib/esi-client-bvv/api/contracts_api.rb', line 418

def get_contracts_public_region_id_with_http_info(region_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ContractsApi.get_contracts_public_region_id ..."
  end
  # verify the required parameter 'region_id' is set
  if @api_client.config.client_side_validation && region_id.nil?
    fail ArgumentError, "Missing the required parameter 'region_id' when calling ContractsApi.get_contracts_public_region_id"
  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
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling ContractsApi.get_contracts_public_region_id, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = "/v1/contracts/public/{region_id}/".sub('{' + 'region_id' + '}', region_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].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<GetContractsPublicRegionId200Ok>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContractsApi#get_contracts_public_region_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_corporations_corporation_id_contracts(corporation_id, opts = {}) ⇒ Array<GetCorporationsCorporationIdContracts200Ok>

Get corporation contracts Returns contracts available to a corporation, only if the corporation is issuer, acceptor or assignee. Only returns contracts no older than 30 days, or if the status is "in_progress". — This route is cached for up to 300 seconds

Parameters:

  • corporation_id —

    An EVE corporation ID

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

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

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

  • :if_none_match (String) —

    ETag from a previous request. A 304 will be returned if this matches the current ETag

  • :page (Integer) —

    Which page of results to return (default to 1)

  • :token (String) —

    Access token to use if unable to set a header

Returns:



477
478
479
480
 
# File 'lib/esi-client-bvv/api/contracts_api.rb', line 477

def get_corporations_corporation_id_contracts(corporation_id, opts = {})
  data, _status_code, _headers = get_corporations_corporation_id_contracts_with_http_info(corporation_id, opts)
  return data
end

#get_corporations_corporation_id_contracts_contract_id_bids(contract_id, corporation_id, opts = {}) ⇒ Array<GetCorporationsCorporationIdContractsContractIdBids200Ok>

Get corporation contract bids Lists bids on a particular auction contract — This route is cached for up to 3600 seconds

Parameters:

  • contract_id —

    ID of a contract

  • corporation_id —

    An EVE corporation ID

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

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

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

  • :if_none_match (String) —

    ETag from a previous request. A 304 will be returned if this matches the current ETag

  • :page (Integer) —

    Which page of results to return (default to 1)

  • :token (String) —

    Access token to use if unable to set a header

Returns:



556
557
558
559
 
# File 'lib/esi-client-bvv/api/contracts_api.rb', line 556

def get_corporations_corporation_id_contracts_contract_id_bids(contract_id, corporation_id, opts = {})
  data, _status_code, _headers = get_corporations_corporation_id_contracts_contract_id_bids_with_http_info(contract_id, corporation_id, opts)
  return data
end

#get_corporations_corporation_id_contracts_contract_id_bids_with_http_info(contract_id, corporation_id, opts = {}) ⇒ Array<(Array<GetCorporationsCorporationIdContractsContractIdBids200Ok>, Fixnum, Hash)>

Get corporation contract bids Lists bids on a particular auction contract — This route is cached for up to 3600 seconds

Parameters:

  • contract_id —

    ID of a contract

  • corporation_id —

    An EVE corporation ID

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

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from

  • :if_none_match (String) —

    ETag from a previous request. A 304 will be returned if this matches the current ETag

  • :page (Integer) —

    Which page of results to return

  • :token (String) —

    Access token to use if unable to set a header

Returns:



571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
 
# File 'lib/esi-client-bvv/api/contracts_api.rb', line 571

def get_corporations_corporation_id_contracts_contract_id_bids_with_http_info(contract_id, corporation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ContractsApi.get_corporations_corporation_id_contracts_contract_id_bids ..."
  end
  # verify the required parameter 'contract_id' is set
  if @api_client.config.client_side_validation && contract_id.nil?
    fail ArgumentError, "Missing the required parameter 'contract_id' when calling ContractsApi.get_corporations_corporation_id_contracts_contract_id_bids"
  end
  # verify the required parameter 'corporation_id' is set
  if @api_client.config.client_side_validation && corporation_id.nil?
    fail ArgumentError, "Missing the required parameter 'corporation_id' when calling ContractsApi.get_corporations_corporation_id_contracts_contract_id_bids"
  end
  if @api_client.config.client_side_validation && corporation_id < 1
    fail ArgumentError, 'invalid value for "corporation_id" when calling ContractsApi.get_corporations_corporation_id_contracts_contract_id_bids, 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
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling ContractsApi.get_corporations_corporation_id_contracts_contract_id_bids, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = "/v1/corporations/{corporation_id}/contracts/{contract_id}/bids/".sub('{' + 'contract_id' + '}', contract_id.to_s).sub('{' + 'corporation_id' + '}', corporation_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'token'] = opts[:'token'] if !opts[:'token'].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 = ['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<GetCorporationsCorporationIdContractsContractIdBids200Ok>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContractsApi#get_corporations_corporation_id_contracts_contract_id_bids\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_corporations_corporation_id_contracts_contract_id_items(contract_id, corporation_id, opts = {}) ⇒ Array<GetCorporationsCorporationIdContractsContractIdItems200Ok>

Get corporation contract items Lists items of a particular contract — This route is cached for up to 3600 seconds

Parameters:

  • contract_id —

    ID of a contract

  • corporation_id —

    An EVE corporation ID

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

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

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

  • :if_none_match (String) —

    ETag from a previous request. A 304 will be returned if this matches the current ETag

  • :token (String) —

    Access token to use if unable to set a header

Returns:



639
640
641
642
 
# File 'lib/esi-client-bvv/api/contracts_api.rb', line 639

def get_corporations_corporation_id_contracts_contract_id_items(contract_id, corporation_id, opts = {})
  data, _status_code, _headers = get_corporations_corporation_id_contracts_contract_id_items_with_http_info(contract_id, corporation_id, opts)
  return data
end

#get_corporations_corporation_id_contracts_contract_id_items_with_http_info(contract_id, corporation_id, opts = {}) ⇒ Array<(Array<GetCorporationsCorporationIdContractsContractIdItems200Ok>, Fixnum, Hash)>

Get corporation contract items Lists items of a particular contract — This route is cached for up to 3600 seconds

Parameters:

  • contract_id —

    ID of a contract

  • corporation_id —

    An EVE corporation ID

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

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from

  • :if_none_match (String) —

    ETag from a previous request. A 304 will be returned if this matches the current ETag

  • :token (String) —

    Access token to use if unable to set a header

Returns:



653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
 
# File 'lib/esi-client-bvv/api/contracts_api.rb', line 653

def get_corporations_corporation_id_contracts_contract_id_items_with_http_info(contract_id, corporation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ContractsApi.get_corporations_corporation_id_contracts_contract_id_items ..."
  end
  # verify the required parameter 'contract_id' is set
  if @api_client.config.client_side_validation && contract_id.nil?
    fail ArgumentError, "Missing the required parameter 'contract_id' when calling ContractsApi.get_corporations_corporation_id_contracts_contract_id_items"
  end
  # verify the required parameter 'corporation_id' is set
  if @api_client.config.client_side_validation && corporation_id.nil?
    fail ArgumentError, "Missing the required parameter 'corporation_id' when calling ContractsApi.get_corporations_corporation_id_contracts_contract_id_items"
  end
  if @api_client.config.client_side_validation && corporation_id < 1
    fail ArgumentError, 'invalid value for "corporation_id" when calling ContractsApi.get_corporations_corporation_id_contracts_contract_id_items, 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/corporations/{corporation_id}/contracts/{contract_id}/items/".sub('{' + 'contract_id' + '}', contract_id.to_s).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?

  # 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 = ['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<GetCorporationsCorporationIdContractsContractIdItems200Ok>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContractsApi#get_corporations_corporation_id_contracts_contract_id_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_corporations_corporation_id_contracts_with_http_info(corporation_id, opts = {}) ⇒ Array<(Array<GetCorporationsCorporationIdContracts200Ok>, Fixnum, Hash)>

Get corporation contracts Returns contracts available to a corporation, only if the corporation is issuer, acceptor or assignee. Only returns contracts no older than 30 days, or if the status is &quot;in_progress&quot;. — This route is cached for up to 300 seconds

Parameters:

  • corporation_id —

    An EVE corporation ID

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

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from

  • :if_none_match (String) —

    ETag from a previous request. A 304 will be returned if this matches the current ETag

  • :page (Integer) —

    Which page of results to return

  • :token (String) —

    Access token to use if unable to set a header

Returns:



491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
 
# File 'lib/esi-client-bvv/api/contracts_api.rb', line 491

def get_corporations_corporation_id_contracts_with_http_info(corporation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ContractsApi.get_corporations_corporation_id_contracts ..."
  end
  # verify the required parameter 'corporation_id' is set
  if @api_client.config.client_side_validation && corporation_id.nil?
    fail ArgumentError, "Missing the required parameter 'corporation_id' when calling ContractsApi.get_corporations_corporation_id_contracts"
  end
  if @api_client.config.client_side_validation && corporation_id < 1
    fail ArgumentError, 'invalid value for "corporation_id" when calling ContractsApi.get_corporations_corporation_id_contracts, 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
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling ContractsApi.get_corporations_corporation_id_contracts, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = "/v1/corporations/{corporation_id}/contracts/".sub('{' + 'corporation_id' + '}', corporation_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'token'] = opts[:'token'] if !opts[:'token'].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 = ['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<GetCorporationsCorporationIdContracts200Ok>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContractsApi#get_corporations_corporation_id_contracts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end