Class: ESI::ContractsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/ruby-esi/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.



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

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



14
15
16
 
# File 'lib/ruby-esi/api/contracts_api.rb', line 14

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". — Alternate route: ‘/dev/characters/character_id/contracts/` Alternate route: `/legacy/characters/character_id/contracts/` Alternate route: `/v1/characters/character_id/contracts/` — 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:



28
29
30
31
 
# File 'lib/ruby-esi/api/contracts_api.rb', line 28

def get_characters_character_id_contracts(character_id, opts = {})
  data, _status_code, _headers = get_characters_character_id_contracts_with_http_info(character_id, opts)
  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 — Alternate route: ‘/dev/characters/character_id/contracts/contract_id/bids/` Alternate route: `/legacy/characters/character_id/contracts/contract_id/bids/` Alternate route: `/v1/characters/character_id/contracts/contract_id/bids/` — 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:



99
100
101
102
 
# File 'lib/ruby-esi/api/contracts_api.rb', line 99

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)
  data
end

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

Get contract bids Lists bids on a particular auction contract — Alternate route: &#x60;/dev/characters/character_id/contracts/contract_id/bids/&#x60; Alternate route: &#x60;/legacy/characters/character_id/contracts/contract_id/bids/&#x60; Alternate route: &#x60;/v1/characters/character_id/contracts/contract_id/bids/&#x60; — 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:



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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/ruby-esi/api/contracts_api.rb', line 113

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
  # 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'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility'
  end
  # resource path
  local_var_path = '/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 = opts[:query_params] || {}
  query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil?
  query_params[:'token'] = opts[:'token'] if !opts[:'token'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'Array<GetCharactersCharacterIdContractsContractIdBids200Ok>' 

  auth_names = opts[: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 => return_type)

  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 — Alternate route: ‘/dev/characters/character_id/contracts/contract_id/items/` Alternate route: `/legacy/characters/character_id/contracts/contract_id/items/` Alternate route: `/v1/characters/character_id/contracts/contract_id/items/` — 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:



173
174
175
176
 
# File 'lib/ruby-esi/api/contracts_api.rb', line 173

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)
  data
end

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

Get contract items Lists items of a particular contract — Alternate route: &#x60;/dev/characters/character_id/contracts/contract_id/items/&#x60; Alternate route: &#x60;/legacy/characters/character_id/contracts/contract_id/items/&#x60; Alternate route: &#x60;/v1/characters/character_id/contracts/contract_id/items/&#x60; — 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:



187
188
189
190
191
192
193
194
195
196
197
198
199
200
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
 
# File 'lib/ruby-esi/api/contracts_api.rb', line 187

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
  # 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'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility'
  end
  # resource path
  local_var_path = '/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 = opts[:query_params] || {}
  query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil?
  query_params[:'token'] = opts[:'token'] if !opts[:'token'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'Array<GetCharactersCharacterIdContractsContractIdItems200Ok>' 

  auth_names = opts[: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 => return_type)

  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>, Integer, 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;. — Alternate route: &#x60;/dev/characters/character_id/contracts/&#x60; Alternate route: &#x60;/legacy/characters/character_id/contracts/&#x60; Alternate route: &#x60;/v1/characters/character_id/contracts/&#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

  • :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:



42
43
44
45
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
 
# File 'lib/ruby-esi/api/contracts_api.rb', line 42

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 && opts[:'datasource'] && !['tranquility'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility'
  end
  # resource path
  local_var_path = '/characters/{character_id}/contracts/'.sub('{' + 'character_id' + '}', character_id.to_s)

  # query parameters
  query_params = opts[: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 = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'Array<GetCharactersCharacterIdContracts200Ok>' 

  auth_names = opts[: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 => return_type)

  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 — Alternate route: ‘/dev/contracts/public/bids/contract_id/` Alternate route: `/legacy/contracts/public/bids/contract_id/` Alternate route: `/v1/contracts/public/bids/contract_id/` — 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:



246
247
248
249
 
# File 'lib/ruby-esi/api/contracts_api.rb', line 246

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)
  data
end

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

Get public contract bids Lists bids on a public auction contract — Alternate route: &#x60;/dev/contracts/public/bids/contract_id/&#x60; Alternate route: &#x60;/legacy/contracts/public/bids/contract_id/&#x60; Alternate route: &#x60;/v1/contracts/public/bids/contract_id/&#x60; — 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:



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
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
 
# File 'lib/ruby-esi/api/contracts_api.rb', line 259

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'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility'
  end
  # resource path
  local_var_path = '/contracts/public/bids/{contract_id}/'.sub('{' + 'contract_id' + '}', contract_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'Array<GetContractsPublicBidsContractId200Ok>' 

  auth_names = opts[: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 => return_type)

  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 — Alternate route: ‘/dev/contracts/public/items/contract_id/` Alternate route: `/legacy/contracts/public/items/contract_id/` Alternate route: `/v1/contracts/public/items/contract_id/` — 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:



314
315
316
317
 
# File 'lib/ruby-esi/api/contracts_api.rb', line 314

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)
  data
end

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

Get public contract items Lists items of a public contract — Alternate route: &#x60;/dev/contracts/public/items/contract_id/&#x60; Alternate route: &#x60;/legacy/contracts/public/items/contract_id/&#x60; Alternate route: &#x60;/v1/contracts/public/items/contract_id/&#x60; — 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:



327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
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
 
# File 'lib/ruby-esi/api/contracts_api.rb', line 327

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'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility'
  end
  # resource path
  local_var_path = '/contracts/public/items/{contract_id}/'.sub('{' + 'contract_id' + '}', contract_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'Array<GetContractsPublicItemsContractId200Ok>' 

  auth_names = opts[: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 => return_type)

  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 — Alternate route: ‘/dev/contracts/public/region_id/` Alternate route: `/legacy/contracts/public/region_id/` Alternate route: `/v1/contracts/public/region_id/` — 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:



382
383
384
385
 
# File 'lib/ruby-esi/api/contracts_api.rb', line 382

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

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

Get public contracts Returns a paginated list of all public contracts in the given region — Alternate route: &#x60;/dev/contracts/public/region_id/&#x60; Alternate route: &#x60;/legacy/contracts/public/region_id/&#x60; Alternate route: &#x60;/v1/contracts/public/region_id/&#x60; — 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>, Integer, Hash)>) —

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



395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
 
# File 'lib/ruby-esi/api/contracts_api.rb', line 395

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'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility'
  end
  # resource path
  local_var_path = '/contracts/public/{region_id}/'.sub('{' + 'region_id' + '}', region_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'Array<GetContractsPublicRegionId200Ok>' 

  auth_names = opts[: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 => return_type)

  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". — Alternate route: ‘/dev/corporations/corporation_id/contracts/` Alternate route: `/legacy/corporations/corporation_id/contracts/` Alternate route: `/v1/corporations/corporation_id/contracts/` — 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:



451
452
453
454
 
# File 'lib/ruby-esi/api/contracts_api.rb', line 451

def get_corporations_corporation_id_contracts(corporation_id, opts = {})
  data, _status_code, _headers = get_corporations_corporation_id_contracts_with_http_info(corporation_id, opts)
  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 — Alternate route: ‘/dev/corporations/corporation_id/contracts/contract_id/bids/` Alternate route: `/legacy/corporations/corporation_id/contracts/contract_id/bids/` Alternate route: `/v1/corporations/corporation_id/contracts/contract_id/bids/` — 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:



523
524
525
526
 
# File 'lib/ruby-esi/api/contracts_api.rb', line 523

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)
  data
end

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

Get corporation contract bids Lists bids on a particular auction contract — Alternate route: &#x60;/dev/corporations/corporation_id/contracts/contract_id/bids/&#x60; Alternate route: &#x60;/legacy/corporations/corporation_id/contracts/contract_id/bids/&#x60; Alternate route: &#x60;/v1/corporations/corporation_id/contracts/contract_id/bids/&#x60; — 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:



538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
 
# File 'lib/ruby-esi/api/contracts_api.rb', line 538

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 && opts[:'datasource'] && !['tranquility'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility'
  end
  # resource path
  local_var_path = '/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 = opts[: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 = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'Array<GetCorporationsCorporationIdContractsContractIdBids200Ok>' 

  auth_names = opts[: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 => return_type)

  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 — Alternate route: ‘/dev/corporations/corporation_id/contracts/contract_id/items/` Alternate route: `/legacy/corporations/corporation_id/contracts/contract_id/items/` Alternate route: `/v1/corporations/corporation_id/contracts/contract_id/items/` — 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:



599
600
601
602
 
# File 'lib/ruby-esi/api/contracts_api.rb', line 599

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)
  data
end

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

Get corporation contract items Lists items of a particular contract — Alternate route: &#x60;/dev/corporations/corporation_id/contracts/contract_id/items/&#x60; Alternate route: &#x60;/legacy/corporations/corporation_id/contracts/contract_id/items/&#x60; Alternate route: &#x60;/v1/corporations/corporation_id/contracts/contract_id/items/&#x60; — 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:



613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
 
# File 'lib/ruby-esi/api/contracts_api.rb', line 613

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 && opts[:'datasource'] && !['tranquility'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility'
  end
  # resource path
  local_var_path = '/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 = opts[:query_params] || {}
  query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil?
  query_params[:'token'] = opts[:'token'] if !opts[:'token'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'Array<GetCorporationsCorporationIdContractsContractIdItems200Ok>' 

  auth_names = opts[: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 => return_type)

  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>, Integer, 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;. — Alternate route: &#x60;/dev/corporations/corporation_id/contracts/&#x60; Alternate route: &#x60;/legacy/corporations/corporation_id/contracts/&#x60; Alternate route: &#x60;/v1/corporations/corporation_id/contracts/&#x60; — 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:



465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
 
# File 'lib/ruby-esi/api/contracts_api.rb', line 465

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 && opts[:'datasource'] && !['tranquility'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility'
  end
  # resource path
  local_var_path = '/corporations/{corporation_id}/contracts/'.sub('{' + 'corporation_id' + '}', corporation_id.to_s)

  # query parameters
  query_params = opts[: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 = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'Array<GetCorporationsCorporationIdContracts200Ok>' 

  auth_names = opts[: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 => return_type)

  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