Class: ESI::SearchApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SearchApi

Returns a new instance of SearchApi.



16
17
18
 
# File 'lib/ruby-esi/api/search_api.rb', line 16

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



14
15
16
 
# File 'lib/ruby-esi/api/search_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#get_characters_character_id_search(categories, character_id, search, opts = {}) ⇒ GetCharactersCharacterIdSearchOk

Search on a string Search for entities that match a given sub-string. — Alternate route: ‘/dev/characters/character_id/search/` Alternate route: `/legacy/characters/character_id/search/` Alternate route: `/v3/characters/character_id/search/` — This route is cached for up to 3600 seconds

Parameters:

  • categories —

    Type of entities to search for

  • character_id —

    An EVE character ID

  • search —

    The string to search on

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

    the optional parameters

Options Hash (opts):

  • :accept_language (String) —

    Language to use in the response (default to en)

  • :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

  • :language (String) —

    Language to use in the response, takes precedence over Accept-Language (default to en)

  • :strict (BOOLEAN) —

    Whether the search should be a strict match (default to false)

  • :token (String) —

    Access token to use if unable to set a header

Returns:



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

def get_characters_character_id_search(categories, character_id, search, opts = {})
  data, _status_code, _headers = get_characters_character_id_search_with_http_info(categories, character_id, search, opts)
  data
end

#get_characters_character_id_search_with_http_info(categories, character_id, search, opts = {}) ⇒ Array<(GetCharactersCharacterIdSearchOk, Integer, Hash)>

Search on a string Search for entities that match a given sub-string. — Alternate route: &#x60;/dev/characters/character_id/search/&#x60; Alternate route: &#x60;/legacy/characters/character_id/search/&#x60; Alternate route: &#x60;/v3/characters/character_id/search/&#x60; — This route is cached for up to 3600 seconds

Parameters:

  • categories —

    Type of entities to search for

  • character_id —

    An EVE character ID

  • search —

    The string to search on

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

    the optional parameters

Options Hash (opts):

  • :accept_language (String) —

    Language to use in the response

  • :datasource (String) —

    The server name you would like data from

  • :if_none_match (String) —

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

  • :language (String) —

    Language to use in the response, takes precedence over Accept-Language

  • :strict (BOOLEAN) —

    Whether the search should be a strict match

  • :token (String) —

    Access token to use if unable to set a header

Returns:



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
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/ruby-esi/api/search_api.rb', line 50

def get_characters_character_id_search_with_http_info(categories, character_id, search, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SearchApi.get_characters_character_id_search ...'
  end
  # verify the required parameter 'categories' is set
  if @api_client.config.client_side_validation && categories.nil?
    fail ArgumentError, "Missing the required parameter 'categories' when calling SearchApi.get_characters_character_id_search"
  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 SearchApi.get_characters_character_id_search"
  end
  # verify the required parameter 'search' is set
  if @api_client.config.client_side_validation && search.nil?
    fail ArgumentError, "Missing the required parameter 'search' when calling SearchApi.get_characters_character_id_search"
  end
  if @api_client.config.client_side_validation && opts[:'accept_language'] && !['en', 'en-us', 'de', 'fr', 'ja', 'ru', 'zh', 'ko', 'es'].include?(opts[:'accept_language'])
    fail ArgumentError, 'invalid value for "accept_language", must be one of en, en-us, de, fr, ja, ru, zh, ko, es'
  end
  if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility'
  end
  if @api_client.config.client_side_validation && opts[:'language'] && !['en', 'en-us', 'de', 'fr', 'ja', 'ru', 'zh', 'ko', 'es'].include?(opts[:'language'])
    fail ArgumentError, 'invalid value for "language", must be one of en, en-us, de, fr, ja, ru, zh, ko, es'
  end
  # resource path
  local_var_path = '/characters/{character_id}/search/'.sub('{' + 'character_id' + '}', character_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'categories'] = @api_client.build_collection_param(categories, :csv)
  query_params[:'search'] = search
  query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil?
  query_params[:'language'] = opts[:'language'] if !opts[:'language'].nil?
  query_params[:'strict'] = opts[:'strict'] if !opts[:'strict'].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'])
  header_params[:'Accept-Language'] = opts[:'accept_language'] if !opts[:'accept_language'].nil?
  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[:body] 

  return_type = opts[:return_type] || 'GetCharactersCharacterIdSearchOk' 

  auth_names = opts[: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 => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SearchApi#get_characters_character_id_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end