Module: Epitech::Api::SearchApi

Included in:

Connection

Defined in:

lib/api/search_api.rb

Instance Method Summary

• #get_logins(opts = {}) ⇒ Array

  Used to search logins across the Ionis users through 3 criterias : * Schoolname * Promo * City.

• #search(query) ⇒ Array

  Used to search across the Ionis users.

Instance Method Details

#get_logins(opts = {}) ⇒ Array

Used to search logins across the Ionis users through 3 criterias :

• Schoolname

• Promo

• City

Parameters:

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

  A Hash that should contain at least one of the 3 criterias

Returns:

• (Array) —

  An Array of logins

# File 'lib/api/search_api.rb', line 17

def get_logins(opts={})
  call_api(action: 'get_logins', school: opts[:school], promo: opts[:promo], city: opts[:city])
end

#search(query) ⇒ Array

Used to search across the Ionis users

Parameters:

• query (String) —

  First/Last Name or Login (or a part of it) of who you are looking for.

Returns:

• (Array) —

  An Array of logins

# File 'lib/api/search_api.rb', line 7

def search(query)
  call_api(action: 'search', query: query)
end