class EsiClient::CalendarApi

Attributes

api_client[RW]

Public Class Methods

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

Public Instance Methods

get_characters_character_id_calendar(character_id, opts = {}) click to toggle source

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. — Alternate route: `/v1/characters/{character_id}/calendar/` Alternate route: `/legacy/characters/{character_id}/calendar/` Alternate route: `/dev/characters/{character_id}/calendar/` — This route is cached for up to 5 seconds @param character_id An EVE character ID @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from (default to tranquility) @option opts [Integer] :from_event The event ID to retrieve events from @option opts [String] :token Access token to use if unable to set a header @option opts [String] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [Array<GetCharactersCharacterIdCalendar200Ok>]

# File lib/esi-ruby/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 = {}) click to toggle source

Get an event Get all the information for a specific event — Alternate route: `/v3/characters/{character_id}/calendar/{event_id}/` Alternate route: `/dev/characters/{character_id}/calendar/{event_id}/` — This route is cached for up to 5 seconds @param character_id An EVE character ID @param event_id The id of the event requested @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from (default to tranquility) @option opts [String] :token Access token to use if unable to set a header @option opts [String] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [GetCharactersCharacterIdCalendarEventIdOk]

# File lib/esi-ruby/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 = {}) click to toggle source

Get an event Get all the information for a specific event — Alternate route: &#x60;/v3/characters/{character_id}/calendar/{event_id}/&#x60; Alternate route: &#x60;/dev/characters/{character_id}/calendar/{event_id}/&#x60; — This route is cached for up to 5 seconds @param character_id An EVE character ID @param event_id The id of the event requested @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from @option opts [String] :token Access token to use if unable to set a header @option opts [String] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [Array<(GetCharactersCharacterIdCalendarEventIdOk, Fixnum, Hash)>] GetCharactersCharacterIdCalendarEventIdOk data, response status code and response headers

# File lib/esi-ruby/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 = "/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 = {}) click to toggle source

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. — Alternate route: &#x60;/v1/characters/{character_id}/calendar/&#x60; Alternate route: &#x60;/legacy/characters/{character_id}/calendar/&#x60; Alternate route: &#x60;/dev/characters/{character_id}/calendar/&#x60; — This route is cached for up to 5 seconds @param character_id An EVE character ID @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from @option opts [Integer] :from_event The event ID to retrieve events from @option opts [String] :token Access token to use if unable to set a header @option opts [String] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [Array<(Array<GetCharactersCharacterIdCalendar200Ok>, Fixnum, Hash)>] Array<GetCharactersCharacterIdCalendar200Ok> data, response status code and response headers

# File lib/esi-ruby/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 = "/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
put_characters_character_id_calendar_event_id(character_id, event_id, response, opts = {}) click to toggle source

Respond to an event Set your response status to an event — Alternate route: `/v3/characters/{character_id}/calendar/{event_id}/` Alternate route: `/dev/characters/{character_id}/calendar/{event_id}/` @param character_id An EVE character ID @param event_id The ID of the event requested @param response The response value to set, overriding current value. @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from (default to tranquility) @option opts [String] :token Access token to use if unable to set a header @option opts [String] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [nil]

# File lib/esi-ruby/api/calendar_api.rb, line 172
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)
  return nil
end
put_characters_character_id_calendar_event_id_with_http_info(character_id, event_id, response, opts = {}) click to toggle source

Respond to an event Set your response status to an event — Alternate route: &#x60;/v3/characters/{character_id}/calendar/{event_id}/&#x60; Alternate route: &#x60;/dev/characters/{character_id}/calendar/{event_id}/&#x60; @param character_id An EVE character ID @param event_id The ID of the event requested @param response The response value to set, overriding current value. @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from @option opts [String] :token Access token to use if unable to set a header @option opts [String] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/esi-ruby/api/calendar_api.rb, line 188
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
  fail ArgumentError, "Missing the required parameter 'character_id' when calling CalendarApi.put_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.put_characters_character_id_calendar_event_id" if event_id.nil?
  # verify the required parameter 'response' is set
  fail ArgumentError, "Missing the required parameter 'response' when calling CalendarApi.put_characters_character_id_calendar_event_id" if response.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 = "/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 = @api_client.object_to_http_body(response)
  auth_names = ['evesso']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  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