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.



514
515
516
 
# File 'lib/platform-api/client.rb', line 514

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



521
522
523
 
# File 'lib/platform-api/client.rb', line 521

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



528
529
530
 
# File 'lib/platform-api/client.rb', line 528

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



535
536
537
 
# File 'lib/platform-api/client.rb', line 535

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

#list ⇒ Object

List existing apps.



540
541
542
 
# File 'lib/platform-api/client.rb', line 540

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



548
549
550
 
# File 'lib/platform-api/client.rb', line 548

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