class ESI::DogmaApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/ruby-esi/api/dogma_api.rb, line 19
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

get_dogma_attributes(opts = {}) click to toggle source

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 @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from (default to tranquility) @option opts [String] :if_none_match ETag from a previous request. A 304 will be returned if this matches the current ETag @return [Array<Integer>]

# 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 = {}) click to toggle source

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 @param attribute_id A dogma attribute ID @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from (default to tranquility) @option opts [String] :if_none_match ETag from a previous request. A 304 will be returned if this matches the current ETag @return [GetDogmaAttributesAttributeIdOk]

# 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 = {}) click to toggle source

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 @param attribute_id A dogma attribute ID @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from @option opts [String] :if_none_match ETag from a previous request. A 304 will be returned if this matches the current ETag @return [Array<(GetDogmaAttributesAttributeIdOk, Fixnum, Hash)>] GetDogmaAttributesAttributeIdOk data, response status code and response headers

# 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 = {}) click to toggle source

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 @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from @option opts [String] :if_none_match ETag from a previous request. A 304 will be returned if this matches the current ETag @return [Array<(Array<Integer>, Fixnum, Hash)>] Array<Integer> data, response status code and response headers

# 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 = {}) click to toggle source

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 @param item_id item_id integer @param type_id type_id integer @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from (default to tranquility) @option opts [String] :if_none_match ETag from a previous request. A 304 will be returned if this matches the current ETag @return [GetDogmaDynamicItemsTypeIdItemIdOk]

# 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 = {}) click to toggle source

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 @param item_id item_id integer @param type_id type_id integer @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from @option opts [String] :if_none_match ETag from a previous request. A 304 will be returned if this matches the current ETag @return [Array<(GetDogmaDynamicItemsTypeIdItemIdOk, Fixnum, Hash)>] GetDogmaDynamicItemsTypeIdItemIdOk data, response status code and response headers

# 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 = {}) click to toggle source

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 @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from (default to tranquility) @option opts [String] :if_none_match ETag from a previous request. A 304 will be returned if this matches the current ETag @return [Array<Integer>]

# 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 = {}) click to toggle source

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 @param effect_id A dogma effect ID @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from (default to tranquility) @option opts [String] :if_none_match ETag from a previous request. A 304 will be returned if this matches the current ETag @return [GetDogmaEffectsEffectIdOk]

# 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 = {}) click to toggle source

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 @param effect_id A dogma effect ID @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from @option opts [String] :if_none_match ETag from a previous request. A 304 will be returned if this matches the current ETag @return [Array<(GetDogmaEffectsEffectIdOk, Fixnum, Hash)>] GetDogmaEffectsEffectIdOk data, response status code and response headers

# 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 = {}) click to toggle source

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 @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from @option opts [String] :if_none_match ETag from a previous request. A 304 will be returned if this matches the current ETag @return [Array<(Array<Integer>, Fixnum, Hash)>] Array<Integer> data, response status code and response headers

# 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