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.



1033
1034
1035
 
# File 'lib/platform-api/client.rb', line 1033

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



1040
1041
1042
 
# File 'lib/platform-api/client.rb', line 1040

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

#info(app_id_or_app_name) ⇒ Object

Info for an organization app.

Parameters:

  • app_id_or_app_name: —

    unique identifier of app or unique name of app



1059
1060
1061
 
# File 'lib/platform-api/client.rb', line 1059

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

#list ⇒ Object

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



1045
1046
1047
 
# File 'lib/platform-api/client.rb', line 1045

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

#list_for_organization(organization_name) ⇒ Object

List organization apps.

Parameters:

  • organization_name: —

    unique name of organization



1052
1053
1054
 
# File 'lib/platform-api/client.rb', line 1052

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

#transfer_to_account(app_id_or_app_name, body) ⇒ Object

Transfer an existing organization app to another Heroku account.

Parameters:

  • app_id_or_app_name: —

    unique identifier of app or unique name of app

  • body: —

    the object to pass as the request payload



1075
1076
1077
 
# File 'lib/platform-api/client.rb', line 1075

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

#transfer_to_organization(app_id_or_app_name, body) ⇒ Object

Transfer an existing organization app to another organization.

Parameters:

  • app_id_or_app_name: —

    unique identifier of app or unique name of app

  • body: —

    the object to pass as the request payload



1083
1084
1085
 
# File 'lib/platform-api/client.rb', line 1083

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

#update_locked(app_id_or_app_name, body) ⇒ Object

Lock or unlock an organization 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



1067
1068
1069
 
# File 'lib/platform-api/client.rb', line 1067

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