Class: ESIClient::CalendarApi

Inherits:
Object
  • Object
show all
Defined in:
lib/esi_client/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.



18
19
20
 
# File 'lib/esi_client/api/calendar_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_client/api/calendar_api.rb', line 16

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 event ID is given, the resource will return the next 50 chronological event summaries from now. If an event ID is specified, it will return the next 50 chronological event summaries from after that event. — This route is cached for up to 5 seconds

Parameters:

  • character_id —

    The character to retrieve events from

  • 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

  • :token (String) —

    Access token to use, if preferred over a header

  • :user_agent (String) —

    Client identifier, takes precedence over headers

  • :x_user_agent (String) —

    Client identifier, takes precedence over User-Agent

Returns:



32
33
34
35
 
# File 'lib/esi_client/api/calendar_api.rb', line 32

def get_characters_character_id_calendar(character_id, opts = {})
  data, _status_code, _headers = get_characters_character_id_calendar_with_http_info(character_id, opts)
  return 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 — This route is cached for up to 5 seconds

Parameters:

  • character_id —

    The character id requesting the event

  • event_id —

    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)

  • :token (String) —

    Access token to use, if preferred over a header

  • :user_agent (String) —

    Client identifier, takes precedence over headers

  • :x_user_agent (String) —

    Client identifier, takes precedence over User-Agent

Returns:



101
102
103
104
 
# File 'lib/esi_client/api/calendar_api.rb', line 101

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)
  return data
end

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

Get an event Get all the information for a specific event — This route is cached for up to 5 seconds

Parameters:

  • character_id —

    The character id requesting the event

  • event_id —

    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

  • :token (String) —

    Access token to use, if preferred over a header

  • :user_agent (String) —

    Client identifier, takes precedence over headers

  • :x_user_agent (String) —

    Client identifier, takes precedence over User-Agent

Returns:



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
155
156
157
158
159
 
# File 'lib/esi_client/api/calendar_api.rb', line 116

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

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

List calendar event summaries Get 50 event summaries from the calendar. If no event ID is given, the resource will return the next 50 chronological event summaries from now. If an event ID is specified, it will return the next 50 chronological event summaries from after that event. — This route is cached for up to 5 seconds

Parameters:

  • character_id —

    The character to retrieve events from

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

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from

  • :from_event (Integer) —

    The event ID to retrieve events from

  • :token (String) —

    Access token to use, if preferred over a header

  • :user_agent (String) —

    Client identifier, takes precedence over headers

  • :x_user_agent (String) —

    Client identifier, takes precedence over User-Agent

Returns:



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
 
# File 'lib/esi_client/api/calendar_api.rb', line 47

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
  fail ArgumentError, "Missing the required parameter 'character_id' when calling CalendarApi.get_characters_character_id_calendar" if character_id.nil?
  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 = "/v1/characters/{character_id}/calendar/".sub('{format}','json').sub('{' + 'character_id' + '}', character_id.to_s)

  # query parameters
  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?
  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 = ['evesso']
  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<GetCharactersCharacterIdCalendar200Ok>')
  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