class Reggora::User

Public Class Methods

new(client) click to toggle source
# File lib/reggora/Entity/Lender/user.rb, line 3
def initialize(client)
  @model = 'user'
  @client = client
end

Public Instance Methods

all(params = {}) click to toggle source

returns a list of all the users in the requesting lender.

# File lib/reggora/Entity/Lender/user.rb, line 9
def all(params = {})
  @client.get("/#{@model}s", params)
end
create(user_params) click to toggle source

creates a user to the reggora platform.

# File lib/reggora/Entity/Lender/user.rb, line 25
def create(user_params)
  @client.post("/#{@model}s", user_params)
end
delete(user_id) click to toggle source
# File lib/reggora/Entity/Lender/user.rb, line 35
def delete(user_id)
  @client.delete("/#{@model}s/#{user_id}")
end
edit(user_id, user_params) click to toggle source

updates a user's information. No fields are required and only the supplied fields will be updated on the user.

# File lib/reggora/Entity/Lender/user.rb, line 31
def edit(user_id, user_params)
  @client.put("/#{@model}s/#{user_id}", user_params)
end
find(user_id) click to toggle source

takes a user ID as a URL parameter and returns a user object.

# File lib/reggora/Entity/Lender/user.rb, line 14
def find(user_id)
  @client.get("/#{@model}s/#{user_id}")
end
invite(email, role, firstname, lastname, phone_number) click to toggle source

invites a user to the reggora platform

# File lib/reggora/Entity/Lender/user.rb, line 19
def invite(email, role, firstname, lastname, phone_number)
  invite_params = invite_params(email, role, firstname, lastname, phone_number)
  @client.post("/#{@model}s/invite", invite_params)
end
invite_params(email, role, firstname, lastname, phone_number) click to toggle source
# File lib/reggora/Entity/Lender/user.rb, line 52
def invite_params(email, role, firstname, lastname, phone_number)
  {
      email: email,
      role: role,
      firstname: firstname,
      lastname: lastname,
      phone_number: phone_number
  }
end
query_params(ordering = '-created', offset = 0, limit = 0, search = '') click to toggle source
# File lib/reggora/Entity/Lender/user.rb, line 62
def query_params(ordering = '-created', offset = 0, limit = 0, search = '')
  {
      ordering: ordering,
      offset: offset,
      limit: limit,
      search: search
  }
end
sample_data() click to toggle source
# File lib/reggora/Entity/Lender/user.rb, line 71
def sample_data
  s = (0...50).map { ('a'..'z').to_a[rand(26)] }.join
  {
      email: "fake#{s[1...4]}@reggora.com",
      role: "Admin",
      firstname: "Fake",
      lastname: "Person#{s[1...4]}",
      phone_number: "#{rand(100000...99999)}",
      branch_id: '',
      nmls_id: '',
      matched_users: []
  }
end
user_attributes(email, role, firstname, lastname, phone_number, branch_id = '', nmls_id = '', matched_users = []) click to toggle source
# File lib/reggora/Entity/Lender/user.rb, line 39
def user_attributes(email, role, firstname, lastname, phone_number, branch_id = '', nmls_id = '', matched_users = [])
  {
      email: email,
      role: role,
      firstname: firstname,
      lastname: lastname,
      phone_number: phone_number,
      branch_id: branch_id,
      nmls_id: nmls_id,
      matched_users: matched_users
  }
end