class PlatformAPI::AddonAttachment
An add-on attachment represents a connection between an app and an add-on that it has been given access to.
Public Class Methods
# File lib/platform-api/client.rb, line 893 def initialize(client) @client = client end
Public Instance Methods
Create a new add-on attachment.
@param body: the object to pass as the request payload
# File lib/platform-api/client.rb, line 900 def create(body = {}) @client.addon_attachment.create(body) end
Delete an existing add-on attachment.
@param addon_attachment_id: unique identifier of this add-on attachment
# File lib/platform-api/client.rb, line 907 def delete(addon_attachment_id) @client.addon_attachment.delete(addon_attachment_id) end
Info for existing add-on attachment.
@param addon_attachment_id: unique identifier of this add-on attachment
# File lib/platform-api/client.rb, line 914 def info(addon_attachment_id) @client.addon_attachment.info(addon_attachment_id) end
Info for existing add-on attachment for an app.
@param app_id_or_app_name: unique identifier of app or unique name of app @param addon_attachment_id_or_addon_attachment_name: unique identifier of this add-on attachment or unique name for this add-on attachment to this app
# File lib/platform-api/client.rb, line 941 def info_by_app(app_id_or_app_name, addon_attachment_id_or_addon_attachment_name) @client.addon_attachment.info_by_app(app_id_or_app_name, addon_attachment_id_or_addon_attachment_name) end
List existing add-on attachments.
# File lib/platform-api/client.rb, line 919 def list() @client.addon_attachment.list() end
List existing add-on attachments for an 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 926 def list_by_addon(addon_id_or_addon_name) @client.addon_attachment.list_by_addon(addon_id_or_addon_name) end
List existing add-on attachments 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 933 def list_by_app(app_id_or_app_name) @client.addon_attachment.list_by_app(app_id_or_app_name) end
Resolve an add-on attachment from a name, optionally passing an app name. If there are matches it returns at least one add-on attachment (exact match) or many.
@param body: the object to pass as the request payload
# File lib/platform-api/client.rb, line 948 def resolution(body = {}) @client.addon_attachment.resolution(body) end