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.



3287
3288
3289
 
# File 'lib/platform-api/client.rb', line 3287

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



3314
3315
3316
 
# File 'lib/platform-api/client.rb', line 3314

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



3321
3322
3323
 
# File 'lib/platform-api/client.rb', line 3321

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



3299
3300
3301
 
# File 'lib/platform-api/client.rb', line 3299

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.



3292
3293
3294
 
# File 'lib/platform-api/client.rb', line 3292

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



3307
3308
3309
 
# File 'lib/platform-api/client.rb', line 3307

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