Class: ESIClient::FittingsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/esi_client/api/fittings_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ FittingsApi

Returns a new instance of FittingsApi.



19
20
21
 
# File 'lib/esi_client/api/fittings_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/api/fittings_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#delete_characters_character_id_fittings_fitting_id(character_id, fitting_id, opts = {}) ⇒ nil

Delete fitting Delete a fitting from a character —

Parameters:

  • character_id —

    An EVE character ID

  • fitting_id —

    ID for a fitting of this character

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

  • (nil) 


32
33
34
35
 
# File 'lib/esi_client/api/fittings_api.rb', line 32

def delete_characters_character_id_fittings_fitting_id(character_id, fitting_id, opts = {})
  delete_characters_character_id_fittings_fitting_id_with_http_info(character_id, fitting_id, opts)
  nil
end

#delete_characters_character_id_fittings_fitting_id_with_http_info(character_id, fitting_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete fitting Delete a fitting from a character —

Parameters:

  • character_id —

    An EVE character ID

  • fitting_id —

    ID for a fitting of this character

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

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

    nil, response status code and response headers



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
 
# File 'lib/esi_client/api/fittings_api.rb', line 47

def delete_characters_character_id_fittings_fitting_id_with_http_info(character_id, fitting_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FittingsApi.delete_characters_character_id_fittings_fitting_id ...'
  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 FittingsApi.delete_characters_character_id_fittings_fitting_id"
  end
  if @api_client.config.client_side_validation && character_id < 1
    fail ArgumentError, 'invalid value for "character_id" when calling FittingsApi.delete_characters_character_id_fittings_fitting_id, must be greater than or equal to 1.'
  end

  # verify the required parameter 'fitting_id' is set
  if @api_client.config.client_side_validation && fitting_id.nil?
    fail ArgumentError, "Missing the required parameter 'fitting_id' when calling FittingsApi.delete_characters_character_id_fittings_fitting_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
  # resource path
  local_var_path = '/v1/characters/{character_id}/fittings/{fitting_id}/'.sub('{' + 'character_id' + '}', character_id.to_s).sub('{' + 'fitting_id' + '}', fitting_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(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FittingsApi#delete_characters_character_id_fittings_fitting_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_characters_character_id_fittings(character_id, opts = {}) ⇒ Array<GetCharactersCharacterIdFittings200Ok>

Get fittings Return fittings of a character — 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:



107
108
109
110
 
# File 'lib/esi_client/api/fittings_api.rb', line 107

def get_characters_character_id_fittings(character_id, opts = {})
  data, _status_code, _headers = get_characters_character_id_fittings_with_http_info(character_id, opts)
  data
end

#get_characters_character_id_fittings_with_http_info(character_id, opts = {}) ⇒ Array<(Array<GetCharactersCharacterIdFittings200Ok>, Fixnum, Hash)>

Get fittings Return fittings of a character — 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:



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
164
165
166
167
168
 
# File 'lib/esi_client/api/fittings_api.rb', line 121

def get_characters_character_id_fittings_with_http_info(character_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FittingsApi.get_characters_character_id_fittings ...'
  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 FittingsApi.get_characters_character_id_fittings"
  end
  if @api_client.config.client_side_validation && character_id < 1
    fail ArgumentError, 'invalid value for "character_id" when calling FittingsApi.get_characters_character_id_fittings, 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/characters/{character_id}/fittings/'.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<GetCharactersCharacterIdFittings200Ok>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FittingsApi#get_characters_character_id_fittings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_characters_character_id_fittings(character_id, fitting, opts = {}) ⇒ PostCharactersCharacterIdFittingsCreated

Create fitting Save a new fitting for a character —

Parameters:

  • character_id —

    An EVE character ID

  • fitting —

    Details about the new fitting

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



179
180
181
182
 
# File 'lib/esi_client/api/fittings_api.rb', line 179

def post_characters_character_id_fittings(character_id, fitting, opts = {})
  data, _status_code, _headers = post_characters_character_id_fittings_with_http_info(character_id, fitting, opts)
  data
end

#post_characters_character_id_fittings_with_http_info(character_id, fitting, opts = {}) ⇒ Array<(PostCharactersCharacterIdFittingsCreated, Fixnum, Hash)>

Create fitting Save a new fitting for a character —

Parameters:

  • character_id —

    An EVE character ID

  • fitting —

    Details about the new fitting

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



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
238
239
240
241
242
243
244
245
 
# File 'lib/esi_client/api/fittings_api.rb', line 194

def post_characters_character_id_fittings_with_http_info(character_id, fitting, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FittingsApi.post_characters_character_id_fittings ...'
  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 FittingsApi.post_characters_character_id_fittings"
  end
  if @api_client.config.client_side_validation && character_id < 1
    fail ArgumentError, 'invalid value for "character_id" when calling FittingsApi.post_characters_character_id_fittings, must be greater than or equal to 1.'
  end

  # verify the required parameter 'fitting' is set
  if @api_client.config.client_side_validation && fitting.nil?
    fail ArgumentError, "Missing the required parameter 'fitting' when calling FittingsApi.post_characters_character_id_fittings"
  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}/fittings/'.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 = @api_client.object_to_http_body(fitting)
  auth_names = ['evesso']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PostCharactersCharacterIdFittingsCreated')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FittingsApi#post_characters_character_id_fittings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end