Module: Teamlab::PeopleRemove

Included in:
People
Defined in:
lib/teamlab/modules/people/people_remove.rb

Overview

Module for people removing process

Instance Method Summary collapse

Instance Method Details

#remove_progress(user_id) ⇒ Hash

Returns the progress of the started remove process

Parameters:

  • userId (String) —

    guid of user to remove

Returns:

  • (Hash) —

    remove progress data



16
17
18
 
# File 'lib/teamlab/modules/people/people_remove.rb', line 16

def remove_progress(user_id)
  @request.get(%w[remove progress], userId: user_id)
end

#start_remove(user_id) ⇒ Hash

Start a remove process

Parameters:

  • userId (String) —

    guid of user to remove

Returns:

  • (Hash) —

    remove progress data



9
10
11
 
# File 'lib/teamlab/modules/people/people_remove.rb', line 9

def start_remove(user_id)
  @request.post(%w[remove start], userId: user_id)
end

#terminate_remove(user_id) ⇒ Void

Terminate remove process

Parameters:

  • userId (String) —

    guid of user to remove

Returns:

  • (Void) 


23
24
25
 
# File 'lib/teamlab/modules/people/people_remove.rb', line 23

def terminate_remove(user_id)
  @request.put(%w[remove terminate], userId: user_id)
end