Class: PlatformAPI::TeamMember

Inherits:
Object
  • Object
show all
Defined in:
lib/platform-api/client.rb

Overview

A team member is an individual with access to a team.

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ TeamMember

Returns a new instance of TeamMember.



2945
2946
2947
 
# File 'lib/platform-api/client.rb', line 2945

def initialize(client)
  @client = client
end

Instance Method Details

#create(team_name_or_team_id, body = {}) ⇒ Object

Create a new team member.

Parameters:

  • team_name_or_team_id: —

    unique name of team or unique identifier of team

  • body: —

    the object to pass as the request payload



2961
2962
2963
 
# File 'lib/platform-api/client.rb', line 2961

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.

Parameters:

  • team_name_or_team_id: —

    unique name of team or unique identifier of team

  • body: —

    the object to pass as the request payload



2953
2954
2955
 
# File 'lib/platform-api/client.rb', line 2953

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.

Parameters:

  • team_name_or_team_id: —

    unique name of team or unique identifier of team

  • team_member_email_or_team_member_id: —

    email address of the team member or unique identifier of the team member



2977
2978
2979
 
# File 'lib/platform-api/client.rb', line 2977

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.

Parameters:

  • team_name_or_team_id: —

    unique name of team or unique identifier of team



2984
2985
2986
 
# File 'lib/platform-api/client.rb', line 2984

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.

Parameters:

  • team_name_or_team_id: —

    unique name of team or unique identifier of team

  • team_member_email_or_team_member_id: —

    email address of the team member or unique identifier of the team member



2992
2993
2994
 
# File 'lib/platform-api/client.rb', line 2992

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.

Parameters:

  • team_name_or_team_id: —

    unique name of team or unique identifier of team

  • body: —

    the object to pass as the request payload



2969
2970
2971
 
# File 'lib/platform-api/client.rb', line 2969

def update(team_name_or_team_id, body = {})
  @client.team_member.update(team_name_or_team_id, body)
end