Class: PlatformAPI::OrganizationApp

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

Overview

An organization app encapsulates the organization specific functionality of Heroku apps.

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ OrganizationApp

Returns a new instance of OrganizationApp.



1580
1581
1582
 
# File 'lib/platform-api/client.rb', line 1580

def initialize(client)
  @client = client
end

Instance Method Details

#create(body) ⇒ Object

Create a new app in the specified organization, in the default organization if unspecified, or in personal account, if default organization is not set.

Parameters:

  • body: —

    the object to pass as the request payload



1587
1588
1589
 
# File 'lib/platform-api/client.rb', line 1587

def create(body)
  @client.organization_app.create(body)
end

#info(app_name) ⇒ Object

Info for an organization app.

Parameters:

  • app_name: —

    unique name of app



1606
1607
1608
 
# File 'lib/platform-api/client.rb', line 1606

def info(app_name)
  @client.organization_app.info(app_name)
end

#list ⇒ Object

List apps in the default organization, or in personal account, if default organization is not set.



1592
1593
1594
 
# File 'lib/platform-api/client.rb', line 1592

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

#list_for_organization(organization_name) ⇒ Object

List organization apps.

Parameters:

  • organization_name: —

    unique name of organization



1599
1600
1601
 
# File 'lib/platform-api/client.rb', line 1599

def list_for_organization(organization_name)
  @client.organization_app.list_for_organization(organization_name)
end

#transfer_to_account(app_name, body) ⇒ Object

Transfer an existing organization app to another Heroku account.

Parameters:

  • app_name: —

    unique name of app

  • body: —

    the object to pass as the request payload



1622
1623
1624
 
# File 'lib/platform-api/client.rb', line 1622

def (app_name, body)
  @client.organization_app.(app_name, body)
end

#transfer_to_organization(app_name, body) ⇒ Object

Transfer an existing organization app to another organization.

Parameters:

  • app_name: —

    unique name of app

  • body: —

    the object to pass as the request payload



1630
1631
1632
 
# File 'lib/platform-api/client.rb', line 1630

def transfer_to_organization(app_name, body)
  @client.organization_app.transfer_to_organization(app_name, body)
end

#update_locked(app_name, body) ⇒ Object

Lock or unlock an organization app.

Parameters:

  • app_name: —

    unique name of app

  • body: —

    the object to pass as the request payload



1614
1615
1616
 
# File 'lib/platform-api/client.rb', line 1614

def update_locked(app_name, body)
  @client.organization_app.update_locked(app_name, body)
end