Class: PlatformAPI::TeamApp

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

Overview

An team app encapsulates the team specific functionality of Heroku apps.

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ TeamApp

Returns a new instance of TeamApp.



2800
2801
2802
 
# File 'lib/platform-api/client.rb', line 2800

def initialize(client)
  @client = client
end

Instance Method Details

#create(body = {}) ⇒ Object

Create a new app in the specified team, in the default team if unspecified, or in personal account, if default team is not set.

Parameters:

  • body: —

    the object to pass as the request payload



2807
2808
2809
 
# File 'lib/platform-api/client.rb', line 2807

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

#info(app_name) ⇒ Object

Info for a team app.

Parameters:

  • app_name: —

    unique name of app



2819
2820
2821
 
# File 'lib/platform-api/client.rb', line 2819

def info(app_name)
  @client.team_app.info(app_name)
end

#list ⇒ Object

List apps in the default team, or in personal account, if default team is not set.



2812
2813
2814
 
# File 'lib/platform-api/client.rb', line 2812

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

#list_by_team(team_name_or_team_id) ⇒ Object

List team apps.

Parameters:

  • team_name_or_team_id: —

    unique name of team or unique identifier of team



2850
2851
2852
 
# File 'lib/platform-api/client.rb', line 2850

def list_by_team(team_name_or_team_id)
  @client.team_app.list_by_team(team_name_or_team_id)
end

#transfer_to_account(app_name, body = {}) ⇒ Object

Transfer an existing team app to another Heroku account.

Parameters:

  • app_name: —

    unique name of app

  • body: —

    the object to pass as the request payload



2835
2836
2837
 
# File 'lib/platform-api/client.rb', line 2835

def (app_name, body = {})
  @client.team_app.(app_name, body)
end

#transfer_to_team(app_name, body = {}) ⇒ Object

Transfer an existing team app to another team.

Parameters:

  • app_name: —

    unique name of app

  • body: —

    the object to pass as the request payload



2843
2844
2845
 
# File 'lib/platform-api/client.rb', line 2843

def transfer_to_team(app_name, body = {})
  @client.team_app.transfer_to_team(app_name, body)
end

#update_locked(app_name, body = {}) ⇒ Object

Lock or unlock a team app.

Parameters:

  • app_name: —

    unique name of app

  • body: —

    the object to pass as the request payload



2827
2828
2829
 
# File 'lib/platform-api/client.rb', line 2827

def update_locked(app_name, body = {})
  @client.team_app.update_locked(app_name, body)
end