Class: EsiClient::IncursionsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ IncursionsApi

Returns a new instance of IncursionsApi.



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

def api_client
  @api_client
end

Instance Method Details

#get_incursions(opts = {}) ⇒ Array<GetIncursions200Ok>

List incursions Return a list of current incursions — Alternate route: ‘/v1/incursions/` Alternate route: `/legacy/incursions/` Alternate route: `/dev/incursions/` — This route is cached for up to 300 seconds

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from (default to tranquility)

  • :user_agent (String) —

    Client identifier, takes precedence over headers

  • :x_user_agent (String) —

    Client identifier, takes precedence over User-Agent

Returns:



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

def get_incursions(opts = {})
  data, _status_code, _headers = get_incursions_with_http_info(opts)
  return data
end

#get_incursions_with_http_info(opts = {}) ⇒ Array<(Array<GetIncursions200Ok>, Fixnum, Hash)>

List incursions Return a list of current incursions — Alternate route: &#x60;/v1/incursions/&#x60; Alternate route: &#x60;/legacy/incursions/&#x60; Alternate route: &#x60;/dev/incursions/&#x60; — This route is cached for up to 300 seconds

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from

  • :user_agent (String) —

    Client identifier, takes precedence over headers

  • :x_user_agent (String) —

    Client identifier, takes precedence over User-Agent

Returns:

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

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



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

def get_incursions_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IncursionsApi.get_incursions ..."
  end
  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 = "/incursions/".sub('{format}','json')

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