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.



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

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



3467
3468
3469
# File 'lib/platform-api/client.rb', line 3467

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



3489
3490
3491
# File 'lib/platform-api/client.rb', line 3489

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



3474
3475
3476
# File 'lib/platform-api/client.rb', line 3474

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



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

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

#listObject

List teams in which you are a member.



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

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



3481
3482
3483
# File 'lib/platform-api/client.rb', line 3481

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



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

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