Class: PlatformAPI::TeamMember
- Inherits:
-
Object
- Object
- PlatformAPI::TeamMember
- Defined in:
- lib/platform-api/client.rb
Overview
A team member is an individual with access to a team.
Instance Method Summary collapse
-
#create(team_name_or_team_id, body = {}) ⇒ Object
Create a new team member.
-
#create_or_update(team_name_or_team_id, body = {}) ⇒ Object
Create a new team member, or update their role.
-
#delete(team_name_or_team_id, team_member_email_or_team_member_id) ⇒ Object
Remove a member from the team.
-
#initialize(client) ⇒ TeamMember
constructor
A new instance of TeamMember.
-
#list(team_name_or_team_id) ⇒ Object
List members of the team.
-
#list_by_member(team_name_or_team_id, team_member_email_or_team_member_id) ⇒ Object
List the apps of a team member.
-
#update(team_name_or_team_id, body = {}) ⇒ Object
Update a team member.
Constructor Details
#initialize(client) ⇒ TeamMember
Returns a new instance of TeamMember.
3268 3269 3270 |
# File 'lib/platform-api/client.rb', line 3268 def initialize(client) @client = client end |
Instance Method Details
#create(team_name_or_team_id, body = {}) ⇒ Object
Create a new team member.
3284 3285 3286 |
# File 'lib/platform-api/client.rb', line 3284 def create(team_name_or_team_id, body = {}) @client.team_member.create(team_name_or_team_id, body) end |
#create_or_update(team_name_or_team_id, body = {}) ⇒ Object
Create a new team member, or update their role.
3276 3277 3278 |
# File 'lib/platform-api/client.rb', line 3276 def create_or_update(team_name_or_team_id, body = {}) @client.team_member.create_or_update(team_name_or_team_id, body) end |
#delete(team_name_or_team_id, team_member_email_or_team_member_id) ⇒ Object
Remove a member from the team.
3300 3301 3302 |
# File 'lib/platform-api/client.rb', line 3300 def delete(team_name_or_team_id, team_member_email_or_team_member_id) @client.team_member.delete(team_name_or_team_id, team_member_email_or_team_member_id) end |
#list(team_name_or_team_id) ⇒ Object
List members of the team.
3307 3308 3309 |
# File 'lib/platform-api/client.rb', line 3307 def list(team_name_or_team_id) @client.team_member.list(team_name_or_team_id) end |
#list_by_member(team_name_or_team_id, team_member_email_or_team_member_id) ⇒ Object
List the apps of a team member.
3315 3316 3317 |
# File 'lib/platform-api/client.rb', line 3315 def list_by_member(team_name_or_team_id, team_member_email_or_team_member_id) @client.team_member.list_by_member(team_name_or_team_id, team_member_email_or_team_member_id) end |
#update(team_name_or_team_id, body = {}) ⇒ Object
Update a team member.
3292 3293 3294 |
# File 'lib/platform-api/client.rb', line 3292 def update(team_name_or_team_id, body = {}) @client.team_member.update(team_name_or_team_id, body) end |