Class: PlatformAPI::AddonConfig

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

Overview

Configuration of an Add-on

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ AddonConfig

Returns a new instance of AddonConfig.


727
728
729
# File 'lib/platform-api/client.rb', line 727

def initialize(client)
  @client = client
end

Instance Method Details

#list(addon_id_or_addon_name) ⇒ Object

Get an add-on's config. Accessible by customers with access and by the add-on partner providing this add-on.

Parameters:

  • addon_id_or_addon_name:

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


734
735
736
# File 'lib/platform-api/client.rb', line 734

def list(addon_id_or_addon_name)
  @client.addon_config.list(addon_id_or_addon_name)
end

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

Update an add-on's config. Can only be accessed by the add-on partner providing this add-on.

Parameters:

  • 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


742
743
744
# File 'lib/platform-api/client.rb', line 742

def update(addon_id_or_addon_name, body = {})
  @client.addon_config.update(addon_id_or_addon_name, body)
end