Class: EsiClient::ContractsApi

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



18
19
20
 
# File 'lib/esi-ruby/api/contracts_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/contracts_api.rb', line 16

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

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



31
32
33
34
 
# File 'lib/esi-ruby/api/contracts_api.rb', line 31

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

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



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

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

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



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
 
# File 'lib/esi-ruby/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
  fail ArgumentError, "Missing the required parameter 'character_id' when calling ContractsApi.get_characters_character_id_contracts_contract_id_bids" if character_id.nil?
  # verify the required parameter 'contract_id' is set
  fail ArgumentError, "Missing the required parameter 'contract_id' when calling ContractsApi.get_characters_character_id_contracts_contract_id_bids" if contract_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}/contracts/{contract_id}/bids/".sub('{format}','json').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?
  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<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 and details of a particular contract — Alternate route: ‘/v1/characters/character_id/contracts/contract_id/items/` Alternate route: `/legacy/characters/character_id/contracts/contract_id/items/` Alternate route: `/dev/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)

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



168
169
170
171
 
# File 'lib/esi-ruby/api/contracts_api.rb', line 168

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

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



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
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/esi-ruby/api/contracts_api.rb', line 183

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
  fail ArgumentError, "Missing the required parameter 'character_id' when calling ContractsApi.get_characters_character_id_contracts_contract_id_items" if character_id.nil?
  # verify the required parameter 'contract_id' is set
  fail ArgumentError, "Missing the required parameter 'contract_id' when calling ContractsApi.get_characters_character_id_contracts_contract_id_items" if contract_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}/contracts/{contract_id}/items/".sub('{format}','json').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?
  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<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;. — Alternate route: &#x60;/v1/characters/character_id/contracts/&#x60; Alternate route: &#x60;/legacy/characters/character_id/contracts/&#x60; Alternate route: &#x60;/dev/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

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



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

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
  fail ArgumentError, "Missing the required parameter 'character_id' when calling ContractsApi.get_characters_character_id_contracts" 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}/contracts/".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[:'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<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