Class: HaloMspApi::Resources::Users

Inherits:
Base
  • Object
show all
Defined in:
lib/halo_msp_api/resources/users.rb

Overview

Resource class for Users

Instance Attribute Summary

Attributes inherited from Base

#client_instance

Instance Method Summary collapse

Methods inherited from Base

#initialize

Constructor Details

This class inherits a constructor from HaloMspApi::Resources::Base

Instance Method Details

#changes(params = {}) ⇒ Object

User Change methods GET /UserChange - List User changes



44
45
46
 
# File 'lib/halo_msp_api/resources/users.rb', line 44

def changes(params = {})
  list_resource('UserChange', params)
end

#create_change(data) ⇒ Object

POST /UserChange - Create User change



49
50
51
 
# File 'lib/halo_msp_api/resources/users.rb', line 49

def create_change(data)
  create_resource('UserChange', data)
end

#create_role(data) ⇒ Object

POST /UserRoles - Create User role



65
66
67
 
# File 'lib/halo_msp_api/resources/users.rb', line 65

def create_role(data)
  create_resource('UserRoles', data)
end

#create_user(data) ⇒ Object

POST /Users - Create a new User



18
19
20
 
# File 'lib/halo_msp_api/resources/users.rb', line 18

def create_user(data)
  create_resource('Users', data)
end

#delete_role(id) ⇒ Object

DELETE /UserRoles/id - Delete User role



75
76
77
 
# File 'lib/halo_msp_api/resources/users.rb', line 75

def delete_role(id)
  delete_resource('UserRoles', id)
end

#delete_user(id) ⇒ Object

DELETE /Users/id - Delete a User



28
29
30
 
# File 'lib/halo_msp_api/resources/users.rb', line 28

def delete_user(id)
  delete_resource('Users', id)
end

#preferences(params = {}) ⇒ Object

GET /Users/prefs - Get User preferences



33
34
35
 
# File 'lib/halo_msp_api/resources/users.rb', line 33

def preferences(params = {})
  get(resource_path('Users', nil, 'prefs'), params)
end

#role(id, params = {}) ⇒ Object

GET /UserRoles/id - Get specific User role



60
61
62
 
# File 'lib/halo_msp_api/resources/users.rb', line 60

def role(id, params = {})
  get_resource('UserRoles', id, params)
end

#roles(params = {}) ⇒ Object

User Roles methods GET /UserRoles - List User roles



55
56
57
 
# File 'lib/halo_msp_api/resources/users.rb', line 55

def roles(params = {})
  list_resource('UserRoles', params)
end

#update_preferences(data) ⇒ Object

POST /Users/prefs - Update User preferences



38
39
40
 
# File 'lib/halo_msp_api/resources/users.rb', line 38

def update_preferences(data)
  post(resource_path('Users', nil, 'prefs'), data)
end

#update_role(id, data) ⇒ Object

PUT /UserRoles/id - Update User role



70
71
72
 
# File 'lib/halo_msp_api/resources/users.rb', line 70

def update_role(id, data)
  update_resource('UserRoles', id, data)
end

#update_user(id, data) ⇒ Object

PUT /Users/id - Update a User



23
24
25
 
# File 'lib/halo_msp_api/resources/users.rb', line 23

def update_user(id, data)
  update_resource('Users', id, data)
end

#user(id, params = {}) ⇒ Object

GET /Users/id - Get a specific User



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

def user(id, params = {})
  get_resource('Users', id, params)
end

#users(params = {}) ⇒ Object

GET /Users - List of Users



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

def users(params = {})
  list_resource('Users', params)
end