Module: Swiftype::Client::User

Included in:
Swiftype::Client
Defined in:
lib/swiftype/client.rb

Instance Method Summary collapse

Instance Method Details

#create_user ⇒ Object

Create a new user for the configured application.



229
230
231
232
233
234
235
 
# File 'lib/swiftype/client.rb', line 229

def create_user
  params = {
    :client_id => Swiftype.platform_client_id,
    :client_secret => Swiftype.platform_client_secret
  }
  post("users.json", params)
end

#user(user_id) ⇒ Object

Return a user created by the configured application.

Parameters:

  • user_id (String) —

    the Swiftype User ID



240
241
242
243
244
245
246
 
# File 'lib/swiftype/client.rb', line 240

def user(user_id)
  params = {
    :client_id => Swiftype.platform_client_id,
    :client_secret => Swiftype.platform_client_secret
  }
  get("users/#{user_id}.json", params)
end

#users(options = {}) ⇒ Object

List users for the configured application.

Parameters:

  • options (Hash) (defaults to: {})

Options Hash (options):

  • :page (Integer) —

    page number of users to fetch (server defaults to 1)

  • :per_page (Integer) —

    users to return per page (server defaults to 50)



220
221
222
223
224
225
226
 
# File 'lib/swiftype/client.rb', line 220

def users(options={})
  params = {
    :client_id => Swiftype.platform_client_id,
    :client_secret => Swiftype.platform_client_secret
  }
  get("users.json", params.merge(options))
end