Class: PlatformAPI::Addon

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

Overview

Add-ons represent add-ons that have been provisioned for an app.

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Addon

Returns a new instance of Addon.



494
495
496
 
# File 'lib/platform-api/client.rb', line 494

def initialize(client)
  @client = client
end

Instance Method Details

#create(app_id_or_app_name, body) ⇒ Object

Create a new add-on.

Parameters:

  • app_id_or_app_name: —

    unique identifier of app or unique name of app

  • body: —

    the object to pass as the request payload



502
503
504
 
# File 'lib/platform-api/client.rb', line 502

def create(app_id_or_app_name, body)
  @client.addon.create(app_id_or_app_name, body)
end

#delete(app_id_or_app_name, addon_id_or_addon_name) ⇒ Object

Delete an existing add-on.

Parameters:

  • app_id_or_app_name: —

    unique identifier of app or unique name of app

  • addon_id_or_addon_name: —

    unique identifier of add-on or globally unique name of the add-on



510
511
512
 
# File 'lib/platform-api/client.rb', line 510

def delete(app_id_or_app_name, addon_id_or_addon_name)
  @client.addon.delete(app_id_or_app_name, addon_id_or_addon_name)
end

#info(addon_id_or_addon_name) ⇒ Object

Info for an existing add-on.

Parameters:

  • addon_id_or_addon_name: —

    unique identifier of add-on or globally unique name of the add-on



517
518
519
 
# File 'lib/platform-api/client.rb', line 517

def info(addon_id_or_addon_name)
  @client.addon.info(addon_id_or_addon_name)
end

#list ⇒ Object

List all existing add-ons.



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

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

#list_by_app(app_id_or_app_name) ⇒ Object

List existing add-ons for an app.

Parameters:

  • app_id_or_app_name: —

    unique identifier of app or unique name of app



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

def list_by_app(app_id_or_app_name)
  @client.addon.list_by_app(app_id_or_app_name)
end

#update(app_id_or_app_name, addon_id_or_addon_name, body) ⇒ Object

Change add-on plan. Some add-ons may not support changing plans. In that case, an error will be returned.

Parameters:

  • app_id_or_app_name: —

    unique identifier of app or unique name of app

  • addon_id_or_addon_name: —

    unique identifier of add-on or globally unique name of the add-on

  • body: —

    the object to pass as the request payload



538
539
540
 
# File 'lib/platform-api/client.rb', line 538

def update(app_id_or_app_name, addon_id_or_addon_name, body)
  @client.addon.update(app_id_or_app_name, addon_id_or_addon_name, body)
end