Module: BridgeAPI::Client::User

Defined in:
lib/bridge_api/client/user.rb

Instance Method Summary collapse

Instance Method Details

#add_user(params = {}) ⇒ Object 



4
5
6
 
# File 'lib/bridge_api/client/user.rb', line 4

def add_user(params = {})
  post("#{API_PATH}#{ADMIN_PATH}#{USER_PATH}", params)
end

#add_user_to_role_batch(user_id, params = {}) ⇒ Object 



40
41
42
 
# File 'lib/bridge_api/client/user.rb', line 40

def add_user_to_role_batch(user_id, params = {})
  put("#{API_PATH}#{ADMIN_PATH}#{USER_PATH}/#{user_id}#{ROLE_PATH}#{BATCH_PATH}", params)
end

#delete_user(user_id, params = {}) ⇒ Object 



12
13
14
 
# File 'lib/bridge_api/client/user.rb', line 12

def delete_user(user_id, params = {})
  delete("#{API_PATH}#{ADMIN_PATH}#{USER_PATH}/#{user_id}", params)
end

#get_all_users(params = {}) ⇒ Object 



36
37
38
 
# File 'lib/bridge_api/client/user.rb', line 36

def get_all_users(params = {})
  get("#{API_PATH}#{AUTHOR_PATH}#{USER_PATH}", params)
end

#get_user(user_id, params = {}) ⇒ Object 



8
9
10
 
# File 'lib/bridge_api/client/user.rb', line 8

def get_user(user_id, params = {})
  get("#{API_PATH}#{AUTHOR_PATH}#{USER_PATH}/#{user_id}", params)
end

#restore_deleted_user(user_id, params = {}) ⇒ Object 



20
21
22
 
# File 'lib/bridge_api/client/user.rb', line 20

def restore_deleted_user(user_id, params = {})
  post("#{API_PATH}#{AUTHOR_PATH}#{USER_PATH}/#{user_id}#{RESTORE_PATH}", params)
end

#update_user(user_id, params = {}) ⇒ Object 



16
17
18
 
# File 'lib/bridge_api/client/user.rb', line 16

def update_user(user_id, params = {})
  put("#{API_PATH}#{AUTHOR_PATH}#{USER_PATH}/#{user_id}", params)
end

#update_user_with_custom_values(user_id, custom_params, params = {}) ⇒ Object

Used for easier handling of updating custom params. This method will handle the lookup of existing custom_field_value ids and insert them as needed. user_id Bridge user ID custom_params See build_custom_values_payload method for formatting. params any bridge allowed params to be updated on the user



29
30
31
32
33
34
 
# File 'lib/bridge_api/client/user.rb', line 29

def update_user_with_custom_values(user_id, custom_params, params = {})
  params ||= {}
  params['user'] ||= {}
  params['user']['custom_field_values'] = build_custom_values_payload(user_id, custom_params)
  update_user(user_id, params)
end