Class: FreeAgent::UsersResource

Inherits:
Resource
  • Object
show all
Defined in:
lib/free_agent/resources/users.rb

Instance Attribute Summary

Attributes inherited from Resource

#client

Instance Method Summary collapse

Methods inherited from Resource

#initialize

Constructor Details

This class inherits a constructor from FreeAgent::Resource

Instance Method Details

#create(email:, first_name:, last_name:, role:, opening_mileage: 0, **params) ⇒ Object 



18
19
20
21
22
23
 
# File 'lib/free_agent/resources/users.rb', line 18

def create(email:, first_name:, last_name:, role:, opening_mileage: 0,  **params)
  attributes = { email: email, first_name: first_name, last_name: last_name, role: role, opening_mileage: opening_mileage }

  response = post_request("users", body: attributes.merge(params))
  User.new(response.body["user"]) if response.success?
end

#delete(id:) ⇒ Object 



35
36
37
38
 
# File 'lib/free_agent/resources/users.rb', line 35

def delete(id:)
  response = delete_request("users/#{id}")
  response.success?
end

#list(**params) ⇒ Object 



8
9
10
11
 
# File 'lib/free_agent/resources/users.rb', line 8

def list(**params)
  response = get_request("users", params: params)
  Collection.from_response(response, type: User)
end

#me ⇒ Object 



3
4
5
6
 
# File 'lib/free_agent/resources/users.rb', line 3

def me
  response = get_request("users/me")
  User.new(response.body["user"])
end

#retrieve(id:) ⇒ Object 



13
14
15
16
 
# File 'lib/free_agent/resources/users.rb', line 13

def retrieve(id:)
  response = get_request("users/#{id}")
  User.new(response.body["user"])
end

#update(id:, **params) ⇒ Object 



25
26
27
28
 
# File 'lib/free_agent/resources/users.rb', line 25

def update(id:, **params)
  response = put_request("users/#{id}", body: params)
  User.new(response.body["user"]) if response.success?
end

#update_me(**params) ⇒ Object 



30
31
32
33
 
# File 'lib/free_agent/resources/users.rb', line 30

def update_me(**params)
  response = put_request("users/me", body: { user: params })
  User.new(response.body["user"]) if response.success?
end