class ESIClient::BookmarksApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/esi_client/api/bookmarks_api.rb, line 19
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

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

List bookmarks A list of your character's personal bookmarks — This route is cached for up to 3600 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] :page Which page of results to return (default to 1) @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<GetCharactersCharacterIdBookmarks200Ok>]

# File lib/esi_client/api/bookmarks_api.rb, line 32
def get_characters_character_id_bookmarks(character_id, opts = {})
  data, _status_code, _headers = get_characters_character_id_bookmarks_with_http_info(character_id, opts)
  data
end
get_characters_character_id_bookmarks_folders(character_id, opts = {}) click to toggle source

List bookmark folders A list of your character's personal bookmark folders — This route is cached for up to 3600 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] :page Which page of results to return (default to 1) @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<GetCharactersCharacterIdBookmarksFolders200Ok>]

# File lib/esi_client/api/bookmarks_api.rb, line 106
def get_characters_character_id_bookmarks_folders(character_id, opts = {})
  data, _status_code, _headers = get_characters_character_id_bookmarks_folders_with_http_info(character_id, opts)
  data
end
get_characters_character_id_bookmarks_folders_with_http_info(character_id, opts = {}) click to toggle source

List bookmark folders A list of your character&#39;s personal bookmark folders — This route is cached for up to 3600 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] :page Which page of results to return @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<GetCharactersCharacterIdBookmarksFolders200Ok>, Fixnum, Hash)>] Array<GetCharactersCharacterIdBookmarksFolders200Ok> data, response status code and response headers

# File lib/esi_client/api/bookmarks_api.rb, line 121
def get_characters_character_id_bookmarks_folders_with_http_info(character_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BookmarksApi.get_characters_character_id_bookmarks_folders ...'
  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 BookmarksApi.get_characters_character_id_bookmarks_folders"
  end
  if @api_client.config.client_side_validation && character_id < 1
    fail ArgumentError, 'invalid value for "character_id" when calling BookmarksApi.get_characters_character_id_bookmarks_folders, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && 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 = '/v2/characters/{character_id}/bookmarks/folders/'.sub('{' + 'character_id' + '}', character_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].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<GetCharactersCharacterIdBookmarksFolders200Ok>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BookmarksApi#get_characters_character_id_bookmarks_folders\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_characters_character_id_bookmarks_with_http_info(character_id, opts = {}) click to toggle source

List bookmarks A list of your character&#39;s personal bookmarks — This route is cached for up to 3600 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] :page Which page of results to return @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<GetCharactersCharacterIdBookmarks200Ok>, Fixnum, Hash)>] Array<GetCharactersCharacterIdBookmarks200Ok> data, response status code and response headers

# File lib/esi_client/api/bookmarks_api.rb, line 47
def get_characters_character_id_bookmarks_with_http_info(character_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BookmarksApi.get_characters_character_id_bookmarks ...'
  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 BookmarksApi.get_characters_character_id_bookmarks"
  end
  if @api_client.config.client_side_validation && character_id < 1
    fail ArgumentError, 'invalid value for "character_id" when calling BookmarksApi.get_characters_character_id_bookmarks, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && 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 = '/v2/characters/{character_id}/bookmarks/'.sub('{' + 'character_id' + '}', character_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].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<GetCharactersCharacterIdBookmarks200Ok>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BookmarksApi#get_characters_character_id_bookmarks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_corporations_corporation_id_bookmarks(corporation_id, opts = {}) click to toggle source

List corporation bookmarks A list of your corporation's bookmarks — This route is cached for up to 3600 seconds @param corporation_id An EVE corporation 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] :page Which page of results to return (default to 1) @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<GetCorporationsCorporationIdBookmarks200Ok>]

# File lib/esi_client/api/bookmarks_api.rb, line 180
def get_corporations_corporation_id_bookmarks(corporation_id, opts = {})
  data, _status_code, _headers = get_corporations_corporation_id_bookmarks_with_http_info(corporation_id, opts)
  data
end
get_corporations_corporation_id_bookmarks_folders(corporation_id, opts = {}) click to toggle source

List corporation bookmark folders A list of your corporation's bookmark folders — This route is cached for up to 3600 seconds @param corporation_id An EVE corporation 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] :page Which page of results to return (default to 1) @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<GetCorporationsCorporationIdBookmarksFolders200Ok>]

# File lib/esi_client/api/bookmarks_api.rb, line 254
def get_corporations_corporation_id_bookmarks_folders(corporation_id, opts = {})
  data, _status_code, _headers = get_corporations_corporation_id_bookmarks_folders_with_http_info(corporation_id, opts)
  data
end
get_corporations_corporation_id_bookmarks_folders_with_http_info(corporation_id, opts = {}) click to toggle source

List corporation bookmark folders A list of your corporation&#39;s bookmark folders — This route is cached for up to 3600 seconds @param corporation_id An EVE corporation ID @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from @option opts [Integer] :page Which page of results to return @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<GetCorporationsCorporationIdBookmarksFolders200Ok>, Fixnum, Hash)>] Array<GetCorporationsCorporationIdBookmarksFolders200Ok> data, response status code and response headers

# File lib/esi_client/api/bookmarks_api.rb, line 269
def get_corporations_corporation_id_bookmarks_folders_with_http_info(corporation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BookmarksApi.get_corporations_corporation_id_bookmarks_folders ...'
  end
  # verify the required parameter 'corporation_id' is set
  if @api_client.config.client_side_validation && corporation_id.nil?
    fail ArgumentError, "Missing the required parameter 'corporation_id' when calling BookmarksApi.get_corporations_corporation_id_bookmarks_folders"
  end
  if @api_client.config.client_side_validation && corporation_id < 1
    fail ArgumentError, 'invalid value for "corporation_id" when calling BookmarksApi.get_corporations_corporation_id_bookmarks_folders, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && 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/corporations/{corporation_id}/bookmarks/folders/'.sub('{' + 'corporation_id' + '}', corporation_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].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<GetCorporationsCorporationIdBookmarksFolders200Ok>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BookmarksApi#get_corporations_corporation_id_bookmarks_folders\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_corporations_corporation_id_bookmarks_with_http_info(corporation_id, opts = {}) click to toggle source

List corporation bookmarks A list of your corporation&#39;s bookmarks — This route is cached for up to 3600 seconds @param corporation_id An EVE corporation ID @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from @option opts [Integer] :page Which page of results to return @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<GetCorporationsCorporationIdBookmarks200Ok>, Fixnum, Hash)>] Array<GetCorporationsCorporationIdBookmarks200Ok> data, response status code and response headers

# File lib/esi_client/api/bookmarks_api.rb, line 195
def get_corporations_corporation_id_bookmarks_with_http_info(corporation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BookmarksApi.get_corporations_corporation_id_bookmarks ...'
  end
  # verify the required parameter 'corporation_id' is set
  if @api_client.config.client_side_validation && corporation_id.nil?
    fail ArgumentError, "Missing the required parameter 'corporation_id' when calling BookmarksApi.get_corporations_corporation_id_bookmarks"
  end
  if @api_client.config.client_side_validation && corporation_id < 1
    fail ArgumentError, 'invalid value for "corporation_id" when calling BookmarksApi.get_corporations_corporation_id_bookmarks, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && 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/corporations/{corporation_id}/bookmarks/'.sub('{' + 'corporation_id' + '}', corporation_id.to_s)

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