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.



3386
3387
3388
 
# File 'lib/platform-api/client.rb', line 3386

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



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

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

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

Create a team in an enterprise account.

Parameters:

  • enterprise_account_id: —

    unique identifier of the enterprise account

  • body: —

    the object to pass as the request payload



3435
3436
3437
 
# File 'lib/platform-api/client.rb', line 3435

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



3420
3421
3422
 
# File 'lib/platform-api/client.rb', line 3420

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



3398
3399
3400
 
# File 'lib/platform-api/client.rb', line 3398

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.



3391
3392
3393
 
# File 'lib/platform-api/client.rb', line 3391

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

#list_by_enterprise_account(enterprise_account_id) ⇒ Object

List teams for an enterprise account.

Parameters:

  • enterprise_account_id: —

    unique identifier of the enterprise account



3427
3428
3429
 
# File 'lib/platform-api/client.rb', line 3427

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



3406
3407
3408
 
# File 'lib/platform-api/client.rb', line 3406

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