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.



870
871
872
 
# File 'lib/platform-api/client.rb', line 870

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



877
878
879
 
# File 'lib/platform-api/client.rb', line 877

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



884
885
886
 
# File 'lib/platform-api/client.rb', line 884

def delete(app_id_or_app_name)
  @client.app.delete(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



891
892
893
 
# File 'lib/platform-api/client.rb', line 891

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

#list ⇒ Object

List existing apps.



896
897
898
 
# File 'lib/platform-api/client.rb', line 896

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 organization 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



903
904
905
 
# File 'lib/platform-api/client.rb', line 903

def list_owned_and_collaborated()
  @client.app.list_owned_and_collaborated()
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



911
912
913
 
# File 'lib/platform-api/client.rb', line 911

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