class PlatformAPI::TeamMember
A team member is an individual with access to a team.
Public Class Methods
# File lib/platform-api/client.rb, line 3322 def initialize(client) @client = client end
Public Instance Methods
Create a new team member.
@param team_name_or_team_id: unique name of team or unique identifier of team @param body: the object to pass as the request payload
# File lib/platform-api/client.rb, line 3338 def create(team_name_or_team_id, body = {}) @client.team_member.create(team_name_or_team_id, body) end
Create a new team member, or update their role.
@param team_name_or_team_id: unique name of team or unique identifier of team @param body: the object to pass as the request payload
# File lib/platform-api/client.rb, line 3330 def create_or_update(team_name_or_team_id, body = {}) @client.team_member.create_or_update(team_name_or_team_id, body) end
Remove a member from the team.
@param team_name_or_team_id: unique name of team or unique identifier of team @param team_member_email_or_team_member_id: email address of the team member or unique identifier of the team member
# File lib/platform-api/client.rb, line 3354 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 members of the team.
@param team_name_or_team_id: unique name of team or unique identifier of team
# File lib/platform-api/client.rb, line 3361 def list(team_name_or_team_id) @client.team_member.list(team_name_or_team_id) end
List the apps of a team member.
@param team_name_or_team_id: unique name of team or unique identifier of team @param team_member_email_or_team_member_id: email address of the team member or unique identifier of the team member
# File lib/platform-api/client.rb, line 3369 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 a team member.
@param team_name_or_team_id: unique name of team or unique identifier of team @param body: the object to pass as the request payload
# File lib/platform-api/client.rb, line 3346 def update(team_name_or_team_id, body = {}) @client.team_member.update(team_name_or_team_id, body) end