Class: ESI::CalendarApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CalendarApi

Returns a new instance of CalendarApi.



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

def api_client
  @api_client
end

Instance Method Details

#get_characters_character_id_calendar(character_id, opts = {}) ⇒ Array<GetCharactersCharacterIdCalendar200Ok>

List calendar event summaries Get 50 event summaries from the calendar. If no from_event ID is given, the resource will return the next 50 chronological event summaries from now. If a from_event ID is specified, it will return the next 50 chronological event summaries from after that event — Alternate route: ‘/dev/characters/character_id/calendar/` Alternate route: `/legacy/characters/character_id/calendar/` Alternate route: `/v1/characters/character_id/calendar/` Alternate route: `/v2/characters/character_id/calendar/` — This route is cached for up to 5 seconds

Parameters:

  • character_id (Integer) —

    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’)

  • :from_event (Integer) —

    The event ID to retrieve events from

  • :if_none_match (String) —

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

  • :token (String) —

    Access token to use if unable to set a header

Returns:



31
32
33
34
 
# File 'lib/ruby-esi/api/calendar_api.rb', line 31

def get_characters_character_id_calendar(character_id, opts = {})
  data, _status_code, _headers = get_characters_character_id_calendar_with_http_info(character_id, opts)
  data
end

#get_characters_character_id_calendar_event_id(character_id, event_id, opts = {}) ⇒ GetCharactersCharacterIdCalendarEventIdOk

Get an event Get all the information for a specific event — Alternate route: ‘/dev/characters/character_id/calendar/event_id/` Alternate route: `/legacy/characters/character_id/calendar/event_id/` Alternate route: `/v3/characters/character_id/calendar/event_id/` Alternate route: `/v4/characters/character_id/calendar/event_id/` — This route is cached for up to 5 seconds

Parameters:

  • character_id (Integer) —

    An EVE character ID

  • event_id (Integer) —

    The id of the event requested

  • 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

  • :token (String) —

    Access token to use if unable to set a header

Returns:



114
115
116
117
 
# File 'lib/ruby-esi/api/calendar_api.rb', line 114

def get_characters_character_id_calendar_event_id(character_id, event_id, opts = {})
  data, _status_code, _headers = get_characters_character_id_calendar_event_id_with_http_info(character_id, event_id, opts)
  data
end

#get_characters_character_id_calendar_event_id_attendees(character_id, event_id, opts = {}) ⇒ Array<GetCharactersCharacterIdCalendarEventIdAttendees200Ok>

Get attendees Get all invited attendees for a given event — Alternate route: ‘/dev/characters/character_id/calendar/event_id/attendees/` Alternate route: `/legacy/characters/character_id/calendar/event_id/attendees/` Alternate route: `/v1/characters/character_id/calendar/event_id/attendees/` Alternate route: `/v2/characters/character_id/calendar/event_id/attendees/` — This route is cached for up to 600 seconds

Parameters:

  • character_id (Integer) —

    An EVE character ID

  • event_id (Integer) —

    The id of the event requested

  • 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

  • :token (String) —

    Access token to use if unable to set a header

Returns:



200
201
202
203
 
# File 'lib/ruby-esi/api/calendar_api.rb', line 200

def get_characters_character_id_calendar_event_id_attendees(character_id, event_id, opts = {})
  data, _status_code, _headers = get_characters_character_id_calendar_event_id_attendees_with_http_info(character_id, event_id, opts)
  data
end

#get_characters_character_id_calendar_event_id_attendees_with_http_info(character_id, event_id, opts = {}) ⇒ Array<(Array<GetCharactersCharacterIdCalendarEventIdAttendees200Ok>, Integer, Hash)>

Get attendees Get all invited attendees for a given event — Alternate route: &#x60;/dev/characters/character_id/calendar/event_id/attendees/&#x60; Alternate route: &#x60;/legacy/characters/character_id/calendar/event_id/attendees/&#x60; Alternate route: &#x60;/v1/characters/character_id/calendar/event_id/attendees/&#x60; Alternate route: &#x60;/v2/characters/character_id/calendar/event_id/attendees/&#x60; — This route is cached for up to 600 seconds

Parameters:

  • character_id (Integer) —

    An EVE character ID

  • event_id (Integer) —

    The id of the event requested

  • 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

  • :token (String) —

    Access token to use if unable to set a header

Returns:



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
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/ruby-esi/api/calendar_api.rb', line 214

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

  # verify the required parameter 'event_id' is set
  if @api_client.config.client_side_validation && event_id.nil?
    fail ArgumentError, "Missing the required parameter 'event_id' when calling CalendarApi.get_characters_character_id_calendar_event_id_attendees"
  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 = '/characters/{character_id}/calendar/{event_id}/attendees/'.sub('{' + 'character_id' + '}', CGI.escape(character_id.to_s)).sub('{' + 'event_id' + '}', CGI.escape(event_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil?
  query_params[:'token'] = opts[:'token'] if !opts[:'token'].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<GetCharactersCharacterIdCalendarEventIdAttendees200Ok>'

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

  new_options = opts.merge(
    :operation => :"CalendarApi.get_characters_character_id_calendar_event_id_attendees",
    :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: CalendarApi#get_characters_character_id_calendar_event_id_attendees\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_characters_character_id_calendar_event_id_with_http_info(character_id, event_id, opts = {}) ⇒ Array<(GetCharactersCharacterIdCalendarEventIdOk, Integer, Hash)>

Get an event Get all the information for a specific event — Alternate route: &#x60;/dev/characters/character_id/calendar/event_id/&#x60; Alternate route: &#x60;/legacy/characters/character_id/calendar/event_id/&#x60; Alternate route: &#x60;/v3/characters/character_id/calendar/event_id/&#x60; Alternate route: &#x60;/v4/characters/character_id/calendar/event_id/&#x60; — This route is cached for up to 5 seconds

Parameters:

  • character_id (Integer) —

    An EVE character ID

  • event_id (Integer) —

    The id of the event requested

  • 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

  • :token (String) —

    Access token to use if unable to set a header

Returns:



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
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/ruby-esi/api/calendar_api.rb', line 128

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

  # verify the required parameter 'event_id' is set
  if @api_client.config.client_side_validation && event_id.nil?
    fail ArgumentError, "Missing the required parameter 'event_id' when calling CalendarApi.get_characters_character_id_calendar_event_id"
  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 = '/characters/{character_id}/calendar/{event_id}/'.sub('{' + 'character_id' + '}', CGI.escape(character_id.to_s)).sub('{' + 'event_id' + '}', CGI.escape(event_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil?
  query_params[:'token'] = opts[:'token'] if !opts[:'token'].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] || 'GetCharactersCharacterIdCalendarEventIdOk'

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

  new_options = opts.merge(
    :operation => :"CalendarApi.get_characters_character_id_calendar_event_id",
    :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: CalendarApi#get_characters_character_id_calendar_event_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_characters_character_id_calendar_with_http_info(character_id, opts = {}) ⇒ Array<(Array<GetCharactersCharacterIdCalendar200Ok>, Integer, Hash)>

List calendar event summaries Get 50 event summaries from the calendar. If no from_event ID is given, the resource will return the next 50 chronological event summaries from now. If a from_event ID is specified, it will return the next 50 chronological event summaries from after that event — Alternate route: &#x60;/dev/characters/character_id/calendar/&#x60; Alternate route: &#x60;/legacy/characters/character_id/calendar/&#x60; Alternate route: &#x60;/v1/characters/character_id/calendar/&#x60; Alternate route: &#x60;/v2/characters/character_id/calendar/&#x60; — This route is cached for up to 5 seconds

Parameters:

  • character_id (Integer) —

    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’)

  • :from_event (Integer) —

    The event ID to retrieve events from

  • :if_none_match (String) —

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

  • :token (String) —

    Access token to use if unable to set a header

Returns:



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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/ruby-esi/api/calendar_api.rb', line 45

def get_characters_character_id_calendar_with_http_info(character_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CalendarApi.get_characters_character_id_calendar ...'
  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 CalendarApi.get_characters_character_id_calendar"
  end
  if @api_client.config.client_side_validation && character_id < 1
    fail ArgumentError, 'invalid value for "character_id" when calling CalendarApi.get_characters_character_id_calendar, must be greater than or equal to 1.'
  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 = '/characters/{character_id}/calendar/'.sub('{' + 'character_id' + '}', CGI.escape(character_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil?
  query_params[:'from_event'] = opts[:'from_event'] if !opts[:'from_event'].nil?
  query_params[:'token'] = opts[:'token'] if !opts[:'token'].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<GetCharactersCharacterIdCalendar200Ok>'

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

  new_options = opts.merge(
    :operation => :"CalendarApi.get_characters_character_id_calendar",
    :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: CalendarApi#get_characters_character_id_calendar\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_characters_character_id_calendar_event_id(character_id, event_id, response, opts = {}) ⇒ nil

Respond to an event Set your response status to an event — Alternate route: ‘/dev/characters/character_id/calendar/event_id/` Alternate route: `/legacy/characters/character_id/calendar/event_id/` Alternate route: `/v3/characters/character_id/calendar/event_id/` Alternate route: `/v4/characters/character_id/calendar/event_id/` — This route is cached for up to 5 seconds

Parameters:

  • character_id (Integer) —

    An EVE character ID

  • event_id (Integer) —

    The ID of the event requested

  • response (PutCharactersCharacterIdCalendarEventIdResponse) —

    The response value to set, overriding current value

  • 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

Returns:

  • (nil) 


286
287
288
289
 
# File 'lib/ruby-esi/api/calendar_api.rb', line 286

def put_characters_character_id_calendar_event_id(character_id, event_id, response, opts = {})
  put_characters_character_id_calendar_event_id_with_http_info(character_id, event_id, response, opts)
  nil
end

#put_characters_character_id_calendar_event_id_with_http_info(character_id, event_id, response, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Respond to an event Set your response status to an event — Alternate route: &#x60;/dev/characters/character_id/calendar/event_id/&#x60; Alternate route: &#x60;/legacy/characters/character_id/calendar/event_id/&#x60; Alternate route: &#x60;/v3/characters/character_id/calendar/event_id/&#x60; Alternate route: &#x60;/v4/characters/character_id/calendar/event_id/&#x60; — This route is cached for up to 5 seconds

Parameters:

  • character_id (Integer) —

    An EVE character ID

  • event_id (Integer) —

    The ID of the event requested

  • response (PutCharactersCharacterIdCalendarEventIdResponse) —

    The response value to set, overriding current value

  • 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

Returns:

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

    nil, response status code and response headers



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
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
 
# File 'lib/ruby-esi/api/calendar_api.rb', line 300

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

  # verify the required parameter 'event_id' is set
  if @api_client.config.client_side_validation && event_id.nil?
    fail ArgumentError, "Missing the required parameter 'event_id' when calling CalendarApi.put_characters_character_id_calendar_event_id"
  end
  # verify the required parameter 'response' is set
  if @api_client.config.client_side_validation && response.nil?
    fail ArgumentError, "Missing the required parameter 'response' when calling CalendarApi.put_characters_character_id_calendar_event_id"
  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 = '/characters/{character_id}/calendar/{event_id}/'.sub('{' + 'character_id' + '}', CGI.escape(character_id.to_s)).sub('{' + 'event_id' + '}', CGI.escape(event_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil?
  query_params[:'token'] = opts[:'token'] if !opts[:'token'].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']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(response)

  # return_type
  return_type = opts[:debug_return_type]

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

  new_options = opts.merge(
    :operation => :"CalendarApi.put_characters_character_id_calendar_event_id",
    :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(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CalendarApi#put_characters_character_id_calendar_event_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end