class PlatformAPI::Addon

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

Public Class Methods

new(client) click to toggle source
# File lib/platform-api/client.rb, line 1120
def initialize(client)
  @client = client
end

Public Instance Methods

create(app_id_or_app_name, body = {}) click to toggle source

Create a new add-on.

@param app_id_or_app_name: unique identifier of app or unique name of app @param body: the object to pass as the request payload

# File lib/platform-api/client.rb, line 1140
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) click to toggle source

Delete an existing add-on.

@param app_id_or_app_name: unique identifier of app or unique name of app @param addon_id_or_addon_name: unique identifier of add-on or globally unique name of the add-on

# File lib/platform-api/client.rb, line 1148
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) click to toggle source

Info for an existing add-on.

@param addon_id_or_addon_name: unique identifier of add-on or globally unique name of the add-on

# File lib/platform-api/client.rb, line 1132
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) click to toggle source

Info for an existing add-on.

@param app_id_or_app_name: unique identifier of app or unique name of app @param addon_id_or_addon_name: unique identifier of add-on or globally unique name of the add-on

# File lib/platform-api/client.rb, line 1156
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() click to toggle source

List all existing add-ons.

# File lib/platform-api/client.rb, line 1125
def list()
  @client.addon.list()
end
list_by_app(app_id_or_app_name) click to toggle source

List existing add-ons for an app.

@param app_id_or_app_name: unique identifier of app or unique name of app

# File lib/platform-api/client.rb, line 1163
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) click to toggle source

List add-ons used across all Team apps

@param team_name_or_team_id: unique name of team or unique identifier of team

# File lib/platform-api/client.rb, line 1186
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) click to toggle source

List all existing add-ons a user has access to

@param account_email_or_account_id_or_account_self: unique email address of account or unique identifier of an account or Implicit reference to currently authorized user

# File lib/platform-api/client.rb, line 1179
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 = {}) click to toggle source

Resolve an add-on from a name, optionally passing an app name. If there are matches it returns at least one add-on (exact match) or many.

@param body: the object to pass as the request payload

# File lib/platform-api/client.rb, line 1193
def resolution(body = {})
  @client.addon.resolution(body)
end
update(app_id_or_app_name, addon_id_or_addon_name, body = {}) click to toggle source

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

@param app_id_or_app_name: unique identifier of app or unique name of app @param addon_id_or_addon_name: unique identifier of add-on or globally unique name of the add-on @param body: the object to pass as the request payload

# File lib/platform-api/client.rb, line 1172
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