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 collapse
-
#create(app_id_or_app_name, body = {}) ⇒ Object
Create a new add-on.
-
#delete(app_id_or_app_name, addon_id_or_addon_name) ⇒ Object
Delete an existing add-on.
-
#info(addon_id_or_addon_name) ⇒ Object
Info for an existing add-on.
-
#info_by_app(app_id_or_app_name, addon_id_or_addon_name) ⇒ Object
Info for an existing add-on.
-
#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 existing add-ons for an app.
-
#list_by_team(team_name_or_team_id) ⇒ Object
List add-ons used across all Team apps.
-
#list_by_user(account_email_or_account_id_or_account_self) ⇒ Object
List all existing add-ons a user has access to.
-
#resolution(body = {}) ⇒ Object
Resolve an add-on from a name, optionally passing an app name.
-
#update(app_id_or_app_name, addon_id_or_addon_name, body = {}) ⇒ Object
Change add-on plan.
Constructor Details
#initialize(client) ⇒ Addon
Returns a new instance of Addon.
1099 1100 1101 |
# File 'lib/platform-api/client.rb', line 1099 def initialize(client) @client = client end |
Instance Method Details
#create(app_id_or_app_name, body = {}) ⇒ Object
Create a new add-on.
1119 1120 1121 |
# File 'lib/platform-api/client.rb', line 1119 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.
1127 1128 1129 |
# File 'lib/platform-api/client.rb', line 1127 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.
1111 1112 1113 |
# File 'lib/platform-api/client.rb', line 1111 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
Info for an existing add-on.
1135 1136 1137 |
# File 'lib/platform-api/client.rb', line 1135 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.
1104 1105 1106 |
# File 'lib/platform-api/client.rb', line 1104 def list() @client.addon.list() end |
#list_by_app(app_id_or_app_name) ⇒ Object
List existing add-ons for an app.
1142 1143 1144 |
# File 'lib/platform-api/client.rb', line 1142 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
List add-ons used across all Team apps
1165 1166 1167 |
# File 'lib/platform-api/client.rb', line 1165 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
List all existing add-ons a user has access to
1158 1159 1160 |
# File 'lib/platform-api/client.rb', line 1158 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
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.
1172 1173 1174 |
# File 'lib/platform-api/client.rb', line 1172 def resolution(body = {}) @client.addon.resolution(body) 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.
1151 1152 1153 |
# File 'lib/platform-api/client.rb', line 1151 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 |