Class: PlatformAPI::Team

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

Overview

Teams allow you to manage access to a shared group of applications and other resources.

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Team

Returns a new instance of Team.



3021
3022
3023
 
# File 'lib/platform-api/client.rb', line 3021

def initialize(client)
  @client = client
end

Instance Method Details

#create(body = {}) ⇒ Object

Create a new team.

Parameters:

  • body: —

    the object to pass as the request payload



3048
3049
3050
 
# File 'lib/platform-api/client.rb', line 3048

def create(body = {})
  @client.team.create(body)
end

#delete(team_name_or_team_id) ⇒ Object

Delete an existing team.

Parameters:

  • team_name_or_team_id: —

    unique name of team or unique identifier of team



3055
3056
3057
 
# File 'lib/platform-api/client.rb', line 3055

def delete(team_name_or_team_id)
  @client.team.delete(team_name_or_team_id)
end

#info(team_name_or_team_id) ⇒ Object

Info for a team.

Parameters:

  • team_name_or_team_id: —

    unique name of team or unique identifier of team



3033
3034
3035
 
# File 'lib/platform-api/client.rb', line 3033

def info(team_name_or_team_id)
  @client.team.info(team_name_or_team_id)
end

#list ⇒ Object

List teams in which you are a member.



3026
3027
3028
 
# File 'lib/platform-api/client.rb', line 3026

def list()
  @client.team.list()
end

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

Update team properties.

Parameters:

  • team_name_or_team_id: —

    unique name of team or unique identifier of team

  • body: —

    the object to pass as the request payload



3041
3042
3043
 
# File 'lib/platform-api/client.rb', line 3041

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