Class: PlatformAPI::Addon

Inherits:

Object

• Object
• PlatformAPI::Addon

Defined in:

lib/platform-api/client.rb

Overview

Add-ons represent add-ons that have been provisioned and attached to one or more apps.

Instance Method Summary

• #create(app_id_or_app_name, body = {}) ⇒ Object
• #delete(app_id_or_app_name, addon_id_or_addon_name) ⇒ Object
• #info(addon_id_or_addon_name) ⇒ Object
• #info_by_app(app_id_or_app_name, addon_id_or_addon_name) ⇒ Object
• #initialize(client) ⇒ Addon constructor

  A new instance of Addon.

• #list ⇒ Object

  List all existing add-ons.

• #list_by_app(app_id_or_app_name) ⇒ Object
• #list_by_team(team_name_or_team_id) ⇒ Object
• #list_by_user(account_email_or_account_id_or_account_self) ⇒ Object
• #resolution(body = {}) ⇒ Object
• #update(app_id_or_app_name, addon_id_or_addon_name, body = {}) ⇒ Object

Constructor Details

#initialize(client) ⇒ Addon

Returns a new instance of Addon.

# File 'lib/platform-api/client.rb', line 1435

def initialize(client)
  @client = client
end

Instance Method Details

#create(app_id_or_app_name, body = {}) ⇒ Object

# File 'lib/platform-api/client.rb', line 1468

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

# File 'lib/platform-api/client.rb', line 1482

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

# File 'lib/platform-api/client.rb', line 1454

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

#info_by_app(app_id_or_app_name, addon_id_or_addon_name) ⇒ Object

# File 'lib/platform-api/client.rb', line 1496

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

#list ⇒ Object

List all existing add-ons.

# File 'lib/platform-api/client.rb', line 1442

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

#list_by_app(app_id_or_app_name) ⇒ Object

# File 'lib/platform-api/client.rb', line 1508

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

#list_by_team(team_name_or_team_id) ⇒ Object

# File 'lib/platform-api/client.rb', line 1548

def list_by_team(team_name_or_team_id)
  @client.addon.list_by_team(team_name_or_team_id)
end

#list_by_user(account_email_or_account_id_or_account_self) ⇒ Object

# File 'lib/platform-api/client.rb', line 1536

def list_by_user(account_email_or_account_id_or_account_self)
  @client.addon.list_by_user(account_email_or_account_id_or_account_self)
end

#resolution(body = {}) ⇒ Object

# File 'lib/platform-api/client.rb', line 1560

def resolution(body = {})
  @client.addon.resolution(body)
end

#update(app_id_or_app_name, addon_id_or_addon_name, body = {}) ⇒ Object

# File 'lib/platform-api/client.rb', line 1524

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