Class: PlatformAPI::Team

Inherits:

Object

• Object
• PlatformAPI::Team

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

• #create(body = {}) ⇒ Object

  Create a new team.

• #create_in_enterprise_account(enterprise_account_id_or_enterprise_account_name, body = {}) ⇒ Object

  Create a team in an enterprise account.

• #delete(team_name_or_team_id) ⇒ Object

  Delete an existing team.

• #info(team_name_or_team_id) ⇒ Object

  Info for a team.

• #initialize(client) ⇒ Team constructor

  A new instance of Team.

• #list ⇒ Object

  List teams in which you are a member.

• #list_by_enterprise_account(enterprise_account_id_or_enterprise_account_name) ⇒ Object

  List teams for an enterprise account.

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

  Update team properties.

Constructor Details

#initialize(client) ⇒ Team

Returns a new instance of Team.

# File 'lib/platform-api/client.rb', line 3413

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

# File 'lib/platform-api/client.rb', line 3440

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

#create_in_enterprise_account(enterprise_account_id_or_enterprise_account_name, body = {}) ⇒ Object

Create a team in an enterprise account.

Parameters:

• enterprise_account_id_or_enterprise_account_name: —

  unique identifier of the enterprise account or unique name of the enterprise account

• body: —

  the object to pass as the request payload

# File 'lib/platform-api/client.rb', line 3462

def create_in_enterprise_account(enterprise_account_id_or_enterprise_account_name, body = {})
  @client.team.create_in_enterprise_account(enterprise_account_id_or_enterprise_account_name, 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

# File 'lib/platform-api/client.rb', line 3447

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

# File 'lib/platform-api/client.rb', line 3425

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.

# File 'lib/platform-api/client.rb', line 3418

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

#list_by_enterprise_account(enterprise_account_id_or_enterprise_account_name) ⇒ Object

List teams for an enterprise account.

Parameters:

• enterprise_account_id_or_enterprise_account_name: —

  unique identifier of the enterprise account or unique name of the enterprise account

# File 'lib/platform-api/client.rb', line 3454

def list_by_enterprise_account(enterprise_account_id_or_enterprise_account_name)
  @client.team.list_by_enterprise_account(enterprise_account_id_or_enterprise_account_name)
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

# File 'lib/platform-api/client.rb', line 3433

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