Class: PlatformAPI::TeamApp

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

Overview

A 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.



3117
3118
3119
 
# File 'lib/platform-api/client.rb', line 3117

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



3124
3125
3126
 
# File 'lib/platform-api/client.rb', line 3124

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



3131
3132
3133
 
# File 'lib/platform-api/client.rb', line 3131

def info(app_name)
  @client.team_app.info(app_name)
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



3162
3163
3164
 
# File 'lib/platform-api/client.rb', line 3162

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



3147
3148
3149
 
# File 'lib/platform-api/client.rb', line 3147

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



3155
3156
3157
 
# File 'lib/platform-api/client.rb', line 3155

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



3139
3140
3141
 
# File 'lib/platform-api/client.rb', line 3139

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