Class: FolioClient::Users

Inherits:
Object
  • Object
show all
Defined in:
lib/folio_client/users.rb

Overview

Query user records in Folio; see s3.amazonaws.com/foliodocs/api/mod-users/r/users.html

Instance Method Summary collapse

Instance Method Details

#fetch_list(query: nil, limit: 10_000, offset: 0, lang: 'en') ⇒ Object

Parameters:

  • query (String) (defaults to: nil) —

    an optional query to limit the number of users returned

  • limit (Integer) (defaults to: 10_000) —

    the number of results to return (defaults to 10,000)

  • offset (Integer) (defaults to: 0) —

    the offset for results returned (defaults to 0)

  • lang (String) (defaults to: 'en') —

    language code for returned results (defaults to ‘en’)



11
12
13
14
15
 
# File 'lib/folio_client/users.rb', line 11

def fetch_list(query: nil, limit: 10_000, offset: 0, lang: 'en')
  params = { limit: limit, offset: offset, lang: lang }
  params[:query] = query if query
  client.get('/users', params)
end

#fetch_user_details(id:, lang: 'en') ⇒ Object

Parameters:

  • id (String) —

    id for requested user

  • lang (String) (defaults to: 'en') —

    language code for returned results (defaults to ‘en’)



19
20
21
22
23
 
# File 'lib/folio_client/users.rb', line 19

def fetch_user_details(id:, lang: 'en')
  client.get("/users/#{id}", {
               lang: lang
             })
end