Class: PlatformAPI::OrganizationApp

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

Overview

Deprecated: 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.



2125
2126
2127
 
# File 'lib/platform-api/client.rb', line 2125

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



2132
2133
2134
 
# File 'lib/platform-api/client.rb', line 2132

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



2146
2147
2148
 
# File 'lib/platform-api/client.rb', line 2146

def info(app_name)
  @client.organization_app.info(app_name)
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



2139
2140
2141
 
# File 'lib/platform-api/client.rb', line 2139

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



2162
2163
2164
 
# File 'lib/platform-api/client.rb', line 2162

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



2170
2171
2172
 
# File 'lib/platform-api/client.rb', line 2170

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



2154
2155
2156
 
# File 'lib/platform-api/client.rb', line 2154

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