class PlatformAPI::App
An app represents the program that you would like to deploy and run on Heroku.
Public Class Methods
# File lib/platform-api/client.rb, line 1421 def initialize(client) @client = client end
Public Instance Methods
Create a new app.
@param body: the object to pass as the request payload
# File lib/platform-api/client.rb, line 1428 def create(body = {}) @client.app.create(body) end
Delete an existing app.
@param app_id_or_app_name: unique identifier of app or unique name of app
# File lib/platform-api/client.rb, line 1435 def delete(app_id_or_app_name) @client.app.delete(app_id_or_app_name) end
Disable ACM flag for an app
@param app_id_or_app_name: unique identifier of app or unique name of app
# File lib/platform-api/client.rb, line 1476 def disable_acm(app_id_or_app_name) @client.app.disable_acm(app_id_or_app_name) end
Enable ACM flag for an app
@param app_id_or_app_name: unique identifier of app or unique name of app
# File lib/platform-api/client.rb, line 1469 def enable_acm(app_id_or_app_name) @client.app.enable_acm(app_id_or_app_name) end
Info for existing app.
@param app_id_or_app_name: unique identifier of app or unique name of app
# File lib/platform-api/client.rb, line 1442 def info(app_id_or_app_name) @client.app.info(app_id_or_app_name) end
List existing apps.
# File lib/platform-api/client.rb, line 1447 def list() @client.app.list() end
List owned and collaborated apps (excludes team apps).
@param 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
# File lib/platform-api/client.rb, line 1454 def list_owned_and_collaborated(account_email_or_account_id_or_account_self) @client.app.list_owned_and_collaborated(account_email_or_account_id_or_account_self) end
Refresh ACM for an app
@param app_id_or_app_name: unique identifier of app or unique name of app
# File lib/platform-api/client.rb, line 1483 def refresh_acm(app_id_or_app_name) @client.app.refresh_acm(app_id_or_app_name) end
Update an existing app.
@param app_id_or_app_name: unique identifier of app or unique name of app @param body: the object to pass as the request payload
# File lib/platform-api/client.rb, line 1462 def update(app_id_or_app_name, body = {}) @client.app.update(app_id_or_app_name, body) end