Class: AddonsApi::Client::Team::Addon::Action
- Inherits:
-
Object
- Object
- AddonsApi::Client::Team::Addon::Action
- Defined in:
- lib/addons-api/client.rb
Overview
Addon Actions are lifecycle operations for addon provisioning and deprovisioning. They allow addon providers to (de)provision addons in the background and then report back when (de)provisioning is complete.
Instance Method Summary collapse
-
#deprovision(team_id, addon_id) ⇒ Object
Mark an addon as deprovisioned.
-
#deprovision_with_callback_url(callback_url) ⇒ Object
Mark an addon as deprovisioned with callback URL.
-
#initialize(client) ⇒ Action
constructor
A new instance of Action.
-
#provision(team_id, addon_id) ⇒ Object
Mark an addon as provisioned.
-
#provision_with_callback_url(callback_url) ⇒ Object
Mark an addon as provisioned with callback URL.
Constructor Details
#initialize(client) ⇒ Action
Returns a new instance of Action.
328 329 330 |
# File 'lib/addons-api/client.rb', line 328 def initialize(client) @client = client end |
Instance Method Details
#deprovision(team_id, addon_id) ⇒ Object
Mark an addon as deprovisioned.
343 344 345 |
# File 'lib/addons-api/client.rb', line 343 def deprovision(team_id, addon_id) @client.request(:post, "#{BASE_PATH}/#{team_id}/addons/#{addon_id}/actions/deprovision") end |
#deprovision_with_callback_url(callback_url) ⇒ Object
Mark an addon as deprovisioned with callback URL.
348 349 350 |
# File 'lib/addons-api/client.rb', line 348 def deprovision_with_callback_url(callback_url) @client.request(:post, "actions/deprovision", base_url: callback_url) end |
#provision(team_id, addon_id) ⇒ Object
Mark an addon as provisioned.
333 334 335 |
# File 'lib/addons-api/client.rb', line 333 def provision(team_id, addon_id) @client.request(:post, "#{BASE_PATH}/#{team_id}/addons/#{addon_id}/actions/provision") end |
#provision_with_callback_url(callback_url) ⇒ Object
Mark an addon as provisioned with callback URL.
338 339 340 |
# File 'lib/addons-api/client.rb', line 338 def provision_with_callback_url(callback_url) @client.request(:post, "actions/provision", base_url: callback_url) end |