class PlatformAPI::App

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

Public Class Methods

new(client) click to toggle source
# File lib/platform-api/client.rb, line 1421
def initialize(client)
  @client = client
end

Public Instance Methods

create(body = {}) click to toggle source

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(app_id_or_app_name) click to toggle source

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(app_id_or_app_name) click to toggle source

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(app_id_or_app_name) click to toggle source

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(app_id_or_app_name) click to toggle source

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() click to toggle source

List existing apps.

# File lib/platform-api/client.rb, line 1447
def list()
  @client.app.list()
end
list_owned_and_collaborated(account_email_or_account_id_or_account_self) click to toggle source

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(app_id_or_app_name) click to toggle source

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(app_id_or_app_name, body = {}) click to toggle source

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