Class: ESI::SovereigntyApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SovereigntyApi

Returns a new instance of SovereigntyApi.



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

def api_client
  @api_client
end

Instance Method Details

#get_sovereignty_campaigns(opts = {}) ⇒ Array<GetSovereigntyCampaigns200Ok>

List sovereignty campaigns Shows sovereignty data for campaigns. — Alternate route: /dev/sovereignty/campaigns/ Alternate route: /legacy/sovereignty/campaigns/ Alternate route: /v1/sovereignty/campaigns/ — This route is cached for up to 5 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’)

  • :if_none_match (String) —

    ETag from a previous request. A 304 will be returned if this matches the current ETag

Returns:



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

def get_sovereignty_campaigns(opts = {})
  data, _status_code, _headers = get_sovereignty_campaigns_with_http_info(opts)
  data
end

#get_sovereignty_campaigns_with_http_info(opts = {}) ⇒ Array<(Array<GetSovereigntyCampaigns200Ok>, Integer, Hash)>

List sovereignty campaigns Shows sovereignty data for campaigns. — Alternate route: &#x60;/dev/sovereignty/campaigns/&#x60; Alternate route: &#x60;/legacy/sovereignty/campaigns/&#x60; Alternate route: &#x60;/v1/sovereignty/campaigns/&#x60; — This route is cached for up to 5 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’)

  • :if_none_match (String) —

    ETag from a previous request. A 304 will be returned if this matches the current ETag

Returns:

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

    Array<GetSovereigntyCampaigns200Ok> 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
79
80
81
82
83
84
85
86
87
 
# File 'lib/ruby-esi/api/sovereignty_api.rb', line 39

def get_sovereignty_campaigns_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SovereigntyApi.get_sovereignty_campaigns ...'
  end
  allowable_values = ["tranquility"]
  if @api_client.config.client_side_validation && opts[:'datasource'] && !allowable_values.include?(opts[:'datasource'])
    fail ArgumentError, "invalid value for \"datasource\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/sovereignty/campaigns/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<GetSovereigntyCampaigns200Ok>'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"SovereigntyApi.get_sovereignty_campaigns",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SovereigntyApi#get_sovereignty_campaigns\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_sovereignty_map(opts = {}) ⇒ Array<GetSovereigntyMap200Ok>

List sovereignty of systems Shows sovereignty information for solar systems — Alternate route: /dev/sovereignty/map/ Alternate route: /legacy/sovereignty/map/ Alternate route: /v1/sovereignty/map/ — This route is cached for up to 3600 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’)

  • :if_none_match (String) —

    ETag from a previous request. A 304 will be returned if this matches the current ETag

Returns:



95
96
97
98
 
# File 'lib/ruby-esi/api/sovereignty_api.rb', line 95

def get_sovereignty_map(opts = {})
  data, _status_code, _headers = get_sovereignty_map_with_http_info(opts)
  data
end

#get_sovereignty_map_with_http_info(opts = {}) ⇒ Array<(Array<GetSovereigntyMap200Ok>, Integer, Hash)>

List sovereignty of systems Shows sovereignty information for solar systems — Alternate route: &#x60;/dev/sovereignty/map/&#x60; Alternate route: &#x60;/legacy/sovereignty/map/&#x60; Alternate route: &#x60;/v1/sovereignty/map/&#x60; — This route is cached for up to 3600 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’)

  • :if_none_match (String) —

    ETag from a previous request. A 304 will be returned if this matches the current ETag

Returns:

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

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



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
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/ruby-esi/api/sovereignty_api.rb', line 106

def get_sovereignty_map_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SovereigntyApi.get_sovereignty_map ...'
  end
  allowable_values = ["tranquility"]
  if @api_client.config.client_side_validation && opts[:'datasource'] && !allowable_values.include?(opts[:'datasource'])
    fail ArgumentError, "invalid value for \"datasource\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/sovereignty/map/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<GetSovereigntyMap200Ok>'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"SovereigntyApi.get_sovereignty_map",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SovereigntyApi#get_sovereignty_map\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_sovereignty_structures(opts = {}) ⇒ Array<GetSovereigntyStructures200Ok>

List sovereignty structures Shows sovereignty data for structures. — Alternate route: /dev/sovereignty/structures/ Alternate route: /legacy/sovereignty/structures/ Alternate route: /v1/sovereignty/structures/ — This route is cached for up to 120 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’)

  • :if_none_match (String) —

    ETag from a previous request. A 304 will be returned if this matches the current ETag

Returns:



162
163
164
165
 
# File 'lib/ruby-esi/api/sovereignty_api.rb', line 162

def get_sovereignty_structures(opts = {})
  data, _status_code, _headers = get_sovereignty_structures_with_http_info(opts)
  data
end

#get_sovereignty_structures_with_http_info(opts = {}) ⇒ Array<(Array<GetSovereigntyStructures200Ok>, Integer, Hash)>

List sovereignty structures Shows sovereignty data for structures. — Alternate route: &#x60;/dev/sovereignty/structures/&#x60; Alternate route: &#x60;/legacy/sovereignty/structures/&#x60; Alternate route: &#x60;/v1/sovereignty/structures/&#x60; — This route is cached for up to 120 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’)

  • :if_none_match (String) —

    ETag from a previous request. A 304 will be returned if this matches the current ETag

Returns:

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

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



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
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/ruby-esi/api/sovereignty_api.rb', line 173

def get_sovereignty_structures_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SovereigntyApi.get_sovereignty_structures ...'
  end
  allowable_values = ["tranquility"]
  if @api_client.config.client_side_validation && opts[:'datasource'] && !allowable_values.include?(opts[:'datasource'])
    fail ArgumentError, "invalid value for \"datasource\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/sovereignty/structures/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<GetSovereigntyStructures200Ok>'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"SovereigntyApi.get_sovereignty_structures",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SovereigntyApi#get_sovereignty_structures\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end