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.


1740
1741
1742
# File 'lib/platform-api/client.rb', line 1740

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


1747
1748
1749
# File 'lib/platform-api/client.rb', line 1747

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


1766
1767
1768
# File 'lib/platform-api/client.rb', line 1766

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

#listObject

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


1752
1753
1754
# File 'lib/platform-api/client.rb', line 1752

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

#list_for_organization(organization_name_or_organization_id) ⇒ Object

List organization apps.

Parameters:

  • organization_name_or_organization_id:

    unique name of organization or unique identifier of organization


1759
1760
1761
# File 'lib/platform-api/client.rb', line 1759

def list_for_organization(organization_name_or_organization_id)
  @client.organization_app.list_for_organization(organization_name_or_organization_id)
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


1782
1783
1784
# File 'lib/platform-api/client.rb', line 1782

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


1790
1791
1792
# File 'lib/platform-api/client.rb', line 1790

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


1774
1775
1776
# File 'lib/platform-api/client.rb', line 1774

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