Class: ESI::SearchApi

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



19
20
21
 
# File 'lib/esi-client-bvv/api/search_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/esi-client-bvv/api/search_api.rb', line 17

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. — 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-us)

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

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



36
37
38
39
 
# File 'lib/esi-client-bvv/api/search_api.rb', line 36

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

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

Search on a string Search for entities that match a given sub-string. — 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:



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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/esi-client-bvv/api/search_api.rb', line 54

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
  if @api_client.config.client_side_validation && categories.length > 11
    fail ArgumentError, 'invalid value for "categories" when calling SearchApi.get_characters_character_id_search, number of items must be less than or equal to 11.'
  end

  if @api_client.config.client_side_validation && categories.length < 1
    fail ArgumentError, 'invalid value for "categories" when calling SearchApi.get_characters_character_id_search, number of items must be greater than or equal to 1.'
  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
  if @api_client.config.client_side_validation && character_id < 1
    fail ArgumentError, 'invalid value for "character_id" when calling SearchApi.get_characters_character_id_search, must be greater than or equal to 1.'
  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 && search.to_s.length < 3
    fail ArgumentError, 'invalid value for "search" when calling SearchApi.get_characters_character_id_search, the character length must be great than or equal to 3.'
  end

  if @api_client.config.client_side_validation && opts[:'accept_language'] && !['de', 'en-us', 'fr', 'ja', 'ru', 'zh'].include?(opts[:'accept_language'])
    fail ArgumentError, 'invalid value for "accept_language", must be one of de, en-us, fr, ja, ru, zh'
  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
  if @api_client.config.client_side_validation && opts[:'language'] && !['de', 'en-us', 'fr', 'ja', 'ru', 'zh'].include?(opts[:'language'])
    fail ArgumentError, 'invalid value for "language", must be one of de, en-us, fr, ja, ru, zh'
  end
  # resource path
  local_var_path = "/v3/characters/{character_id}/search/".sub('{' + 'character_id' + '}', character_id.to_s)

  # query parameters
  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 = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['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 = {}

  # 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 => 'GetCharactersCharacterIdSearchOk')
  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

#get_search(categories, search, opts = {}) ⇒ GetSearchOk

Search on a string Search for entities that match a given sub-string. — This route is cached for up to 3600 seconds

Parameters:

  • categories —

    Type of entities to search for

  • 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-us)

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

  • :strict (BOOLEAN) —

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

Returns:



146
147
148
149
 
# File 'lib/esi-client-bvv/api/search_api.rb', line 146

def get_search(categories, search, opts = {})
  data, _status_code, _headers = get_search_with_http_info(categories, search, opts)
  return data
end

#get_search_with_http_info(categories, search, opts = {}) ⇒ Array<(GetSearchOk, Fixnum, Hash)>

Search on a string Search for entities that match a given sub-string. — This route is cached for up to 3600 seconds

Parameters:

  • categories —

    Type of entities to search for

  • 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

Returns:

  • (Array<(GetSearchOk, Fixnum, Hash)>) —

    GetSearchOk data, response status code and response headers



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
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/esi-client-bvv/api/search_api.rb', line 162

def get_search_with_http_info(categories, search, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SearchApi.get_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_search"
  end
  if @api_client.config.client_side_validation && categories.length > 10
    fail ArgumentError, 'invalid value for "categories" when calling SearchApi.get_search, number of items must be less than or equal to 10.'
  end

  if @api_client.config.client_side_validation && categories.length < 1
    fail ArgumentError, 'invalid value for "categories" when calling SearchApi.get_search, number of items must be greater than or equal to 1.'
  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_search"
  end
  if @api_client.config.client_side_validation && search.to_s.length < 3
    fail ArgumentError, 'invalid value for "search" when calling SearchApi.get_search, the character length must be great than or equal to 3.'
  end

  if @api_client.config.client_side_validation && opts[:'accept_language'] && !['de', 'en-us', 'fr', 'ja', 'ru', 'zh'].include?(opts[:'accept_language'])
    fail ArgumentError, 'invalid value for "accept_language", must be one of de, en-us, fr, ja, ru, zh'
  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
  if @api_client.config.client_side_validation && opts[:'language'] && !['de', 'en-us', 'fr', 'ja', 'ru', 'zh'].include?(opts[:'language'])
    fail ArgumentError, 'invalid value for "language", must be one of de, en-us, fr, ja, ru, zh'
  end
  # resource path
  local_var_path = "/v2/search/"

  # query parameters
  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?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['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 = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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 => 'GetSearchOk')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SearchApi#get_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end