Class: PlatformAPI::App

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

Overview

An app represents the program that you would like to deploy and run on Heroku.

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ App

Returns a new instance of App.



1314
1315
1316
 
# File 'lib/platform-api/client.rb', line 1314

def initialize(client)
  @client = client
end

Instance Method Details

#create(body = {}) ⇒ Object

Create a new app.

Parameters:

  • body: —

    the object to pass as the request payload



1321
1322
1323
 
# File 'lib/platform-api/client.rb', line 1321

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

#delete(app_id_or_app_name) ⇒ Object

Delete an existing app.

Parameters:

  • app_id_or_app_name: —

    unique identifier of app or unique name of app



1328
1329
1330
 
# File 'lib/platform-api/client.rb', line 1328

def delete(app_id_or_app_name)
  @client.app.delete(app_id_or_app_name)
end

#disable_acm(app_id_or_app_name) ⇒ Object

Disable ACM flag for an app

Parameters:

  • app_id_or_app_name: —

    unique identifier of app or unique name of app



1369
1370
1371
 
# File 'lib/platform-api/client.rb', line 1369

def disable_acm(app_id_or_app_name)
  @client.app.disable_acm(app_id_or_app_name)
end

#enable_acm(app_id_or_app_name) ⇒ Object

Enable ACM flag for an app

Parameters:

  • app_id_or_app_name: —

    unique identifier of app or unique name of app



1362
1363
1364
 
# File 'lib/platform-api/client.rb', line 1362

def enable_acm(app_id_or_app_name)
  @client.app.enable_acm(app_id_or_app_name)
end

#info(app_id_or_app_name) ⇒ Object

Info for existing app.

Parameters:

  • app_id_or_app_name: —

    unique identifier of app or unique name of app



1335
1336
1337
 
# File 'lib/platform-api/client.rb', line 1335

def info(app_id_or_app_name)
  @client.app.info(app_id_or_app_name)
end

#list ⇒ Object

List existing apps.



1340
1341
1342
 
# File 'lib/platform-api/client.rb', line 1340

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

#list_owned_and_collaborated(account_email_or_account_id_or_account_self) ⇒ Object

List owned and collaborated apps (excludes team apps).

Parameters:

  • account_email_or_account_id_or_account_self: —

    unique email address of account or unique identifier of an account or Implicit reference to currently authorized user



1347
1348
1349
 
# File 'lib/platform-api/client.rb', line 1347

def list_owned_and_collaborated()
  @client.app.list_owned_and_collaborated()
end

#refresh_acm(app_id_or_app_name) ⇒ Object

Refresh ACM for an app

Parameters:

  • app_id_or_app_name: —

    unique identifier of app or unique name of app



1376
1377
1378
 
# File 'lib/platform-api/client.rb', line 1376

def refresh_acm(app_id_or_app_name)
  @client.app.refresh_acm(app_id_or_app_name)
end

#update(app_id_or_app_name, body = {}) ⇒ Object

Update an existing app.

Parameters:

  • app_id_or_app_name: —

    unique identifier of app or unique name of app

  • body: —

    the object to pass as the request payload



1355
1356
1357
 
# File 'lib/platform-api/client.rb', line 1355

def update(app_id_or_app_name, body = {})
  @client.app.update(app_id_or_app_name, body)
end