Module: Swiftype::Client::User

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

Instance Method Summary collapse

Instance Method Details

#create_userObject

Create a new user for the configured application.


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

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


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

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)


210
211
212
213
214
215
216
# File 'lib/swiftype/client.rb', line 210

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