Class: ESI::DogmaApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DogmaApi

Returns a new instance of DogmaApi.



19
20
21
 
# File 'lib/ruby-esi/api/dogma_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/ruby-esi/api/dogma_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_dogma_attributes(opts = {}) ⇒ Array<Integer>

Get attributes Get a list of dogma attribute ids — Alternate route: ‘/dev/dogma/attributes/` Alternate route: `/legacy/dogma/attributes/` Alternate route: `/v1/dogma/attributes/` — This route expires daily at 11:05

Parameters:

  • 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

Returns:

  • (Array<Integer>) 


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

def get_dogma_attributes(opts = {})
  data, _status_code, _headers = get_dogma_attributes_with_http_info(opts)
  data
end

#get_dogma_attributes_attribute_id(attribute_id, opts = {}) ⇒ GetDogmaAttributesAttributeIdOk

Get attribute information Get information on a dogma attribute — Alternate route: ‘/dev/dogma/attributes/attribute_id/` Alternate route: `/legacy/dogma/attributes/attribute_id/` Alternate route: `/v1/dogma/attributes/attribute_id/` — This route expires daily at 11:05

Parameters:

  • attribute_id —

    A dogma attribute 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

Returns:



86
87
88
89
 
# File 'lib/ruby-esi/api/dogma_api.rb', line 86

def get_dogma_attributes_attribute_id(attribute_id, opts = {})
  data, _status_code, _headers = get_dogma_attributes_attribute_id_with_http_info(attribute_id, opts)
  data
end

#get_dogma_attributes_attribute_id_with_http_info(attribute_id, opts = {}) ⇒ Array<(GetDogmaAttributesAttributeIdOk, Fixnum, Hash)>

Get attribute information Get information on a dogma attribute — Alternate route: &#x60;/dev/dogma/attributes/attribute_id/&#x60; Alternate route: &#x60;/legacy/dogma/attributes/attribute_id/&#x60; Alternate route: &#x60;/v1/dogma/attributes/attribute_id/&#x60; — This route expires daily at 11:05

Parameters:

  • attribute_id —

    A dogma attribute 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

Returns:



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/ruby-esi/api/dogma_api.rb', line 98

def get_dogma_attributes_attribute_id_with_http_info(attribute_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DogmaApi.get_dogma_attributes_attribute_id ...'
  end
  # verify the required parameter 'attribute_id' is set
  if @api_client.config.client_side_validation && attribute_id.nil?
    fail ArgumentError, "Missing the required parameter 'attribute_id' when calling DogmaApi.get_dogma_attributes_attribute_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 = '/dogma/attributes/{attribute_id}/'.sub('{' + 'attribute_id' + '}', attribute_id.to_s)

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

#get_dogma_attributes_with_http_info(opts = {}) ⇒ Array<(Array<Integer>, Fixnum, Hash)>

Get attributes Get a list of dogma attribute ids — Alternate route: &#x60;/dev/dogma/attributes/&#x60; Alternate route: &#x60;/legacy/dogma/attributes/&#x60; Alternate route: &#x60;/v1/dogma/attributes/&#x60; — This route expires daily at 11:05

Parameters:

  • 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

Returns:

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

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



39
40
41
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
 
# File 'lib/ruby-esi/api/dogma_api.rb', line 39

def get_dogma_attributes_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DogmaApi.get_dogma_attributes ...'
  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 = '/dogma/attributes/'

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

#get_dogma_dynamic_items_type_id_item_id(item_id, type_id, opts = {}) ⇒ GetDogmaDynamicItemsTypeIdItemIdOk

Get dynamic item information Returns info about a dynamic item resulting from mutation with a mutaplasmid. — Alternate route: ‘/dev/dogma/dynamic/items/type_id/item_id/` Alternate route: `/legacy/dogma/dynamic/items/type_id/item_id/` Alternate route: `/v1/dogma/dynamic/items/type_id/item_id/` — This route expires daily at 11:05

Parameters:

  • item_id —

    item_id integer

  • type_id —

    type_id integer

  • 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

Returns:



150
151
152
153
 
# File 'lib/ruby-esi/api/dogma_api.rb', line 150

def get_dogma_dynamic_items_type_id_item_id(item_id, type_id, opts = {})
  data, _status_code, _headers = get_dogma_dynamic_items_type_id_item_id_with_http_info(item_id, type_id, opts)
  data
end

#get_dogma_dynamic_items_type_id_item_id_with_http_info(item_id, type_id, opts = {}) ⇒ Array<(GetDogmaDynamicItemsTypeIdItemIdOk, Fixnum, Hash)>

Get dynamic item information Returns info about a dynamic item resulting from mutation with a mutaplasmid. — Alternate route: &#x60;/dev/dogma/dynamic/items/type_id/item_id/&#x60; Alternate route: &#x60;/legacy/dogma/dynamic/items/type_id/item_id/&#x60; Alternate route: &#x60;/v1/dogma/dynamic/items/type_id/item_id/&#x60; — This route expires daily at 11:05

Parameters:

  • item_id —

    item_id integer

  • type_id —

    type_id integer

  • 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

Returns:



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/ruby-esi/api/dogma_api.rb', line 163

def get_dogma_dynamic_items_type_id_item_id_with_http_info(item_id, type_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DogmaApi.get_dogma_dynamic_items_type_id_item_id ...'
  end
  # verify the required parameter 'item_id' is set
  if @api_client.config.client_side_validation && item_id.nil?
    fail ArgumentError, "Missing the required parameter 'item_id' when calling DogmaApi.get_dogma_dynamic_items_type_id_item_id"
  end
  # verify the required parameter 'type_id' is set
  if @api_client.config.client_side_validation && type_id.nil?
    fail ArgumentError, "Missing the required parameter 'type_id' when calling DogmaApi.get_dogma_dynamic_items_type_id_item_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 = '/dogma/dynamic/items/{type_id}/{item_id}/'.sub('{' + 'item_id' + '}', item_id.to_s).sub('{' + 'type_id' + '}', type_id.to_s)

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

#get_dogma_effects(opts = {}) ⇒ Array<Integer>

Get effects Get a list of dogma effect ids — Alternate route: ‘/dev/dogma/effects/` Alternate route: `/legacy/dogma/effects/` Alternate route: `/v1/dogma/effects/` — This route expires daily at 11:05

Parameters:

  • 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

Returns:

  • (Array<Integer>) 


217
218
219
220
 
# File 'lib/ruby-esi/api/dogma_api.rb', line 217

def get_dogma_effects(opts = {})
  data, _status_code, _headers = get_dogma_effects_with_http_info(opts)
  data
end

#get_dogma_effects_effect_id(effect_id, opts = {}) ⇒ GetDogmaEffectsEffectIdOk

Get effect information Get information on a dogma effect — Alternate route: ‘/dev/dogma/effects/effect_id/` Alternate route: `/v2/dogma/effects/effect_id/` — This route expires daily at 11:05

Parameters:

  • effect_id —

    A dogma effect 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

Returns:



275
276
277
278
 
# File 'lib/ruby-esi/api/dogma_api.rb', line 275

def get_dogma_effects_effect_id(effect_id, opts = {})
  data, _status_code, _headers = get_dogma_effects_effect_id_with_http_info(effect_id, opts)
  data
end

#get_dogma_effects_effect_id_with_http_info(effect_id, opts = {}) ⇒ Array<(GetDogmaEffectsEffectIdOk, Fixnum, Hash)>

Get effect information Get information on a dogma effect — Alternate route: &#x60;/dev/dogma/effects/effect_id/&#x60; Alternate route: &#x60;/v2/dogma/effects/effect_id/&#x60; — This route expires daily at 11:05

Parameters:

  • effect_id —

    A dogma effect 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

Returns:

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

    GetDogmaEffectsEffectIdOk data, response status code and response headers



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
325
326
327
328
329
330
 
# File 'lib/ruby-esi/api/dogma_api.rb', line 287

def get_dogma_effects_effect_id_with_http_info(effect_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DogmaApi.get_dogma_effects_effect_id ...'
  end
  # verify the required parameter 'effect_id' is set
  if @api_client.config.client_side_validation && effect_id.nil?
    fail ArgumentError, "Missing the required parameter 'effect_id' when calling DogmaApi.get_dogma_effects_effect_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 = '/dogma/effects/{effect_id}/'.sub('{' + 'effect_id' + '}', effect_id.to_s)

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

#get_dogma_effects_with_http_info(opts = {}) ⇒ Array<(Array<Integer>, Fixnum, Hash)>

Get effects Get a list of dogma effect ids — Alternate route: &#x60;/dev/dogma/effects/&#x60; Alternate route: &#x60;/legacy/dogma/effects/&#x60; Alternate route: &#x60;/v1/dogma/effects/&#x60; — This route expires daily at 11:05

Parameters:

  • 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

Returns:

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

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



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
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/ruby-esi/api/dogma_api.rb', line 228

def get_dogma_effects_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DogmaApi.get_dogma_effects ...'
  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 = '/dogma/effects/'

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