Class: PlatformAPI::AddonAttachment

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

Overview

An add-on attachment represents a connection between an app and an add-on that it has been given access to.

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ AddonAttachment

Returns a new instance of AddonAttachment.


672
673
674
# File 'lib/platform-api/client.rb', line 672

def initialize(client)
  @client = client
end

Instance Method Details

#create(body = {}) ⇒ Object

Create a new add-on attachment.

Parameters:

  • body:

    the object to pass as the request payload


679
680
681
# File 'lib/platform-api/client.rb', line 679

def create(body = {})
  @client.addon_attachment.create(body)
end

#delete(addon_attachment_id) ⇒ Object

Delete an existing add-on attachment.

Parameters:

  • addon_attachment_id:

    unique identifier of this add-on attachment


686
687
688
# File 'lib/platform-api/client.rb', line 686

def delete(addon_attachment_id)
  @client.addon_attachment.delete(addon_attachment_id)
end

#info(addon_attachment_id) ⇒ Object

Info for existing add-on attachment.

Parameters:

  • addon_attachment_id:

    unique identifier of this add-on attachment


693
694
695
# File 'lib/platform-api/client.rb', line 693

def info(addon_attachment_id)
  @client.addon_attachment.info(addon_attachment_id)
end

#info_by_app(app_id_or_app_name, addon_attachment_id_or_addon_attachment_name) ⇒ Object

Info for existing add-on attachment for an app.

Parameters:

  • app_id_or_app_name:

    unique identifier of app or unique name of app

  • 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


720
721
722
# File 'lib/platform-api/client.rb', line 720

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

#listObject

List existing add-on attachments.


698
699
700
# File 'lib/platform-api/client.rb', line 698

def list()
  @client.addon_attachment.list()
end

#list_by_addon(addon_id_or_addon_name) ⇒ Object

List existing add-on attachments for an add-on.

Parameters:

  • addon_id_or_addon_name:

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


705
706
707
# File 'lib/platform-api/client.rb', line 705

def list_by_addon(addon_id_or_addon_name)
  @client.addon_attachment.list_by_addon(addon_id_or_addon_name)
end

#list_by_app(app_id_or_app_name) ⇒ Object

List existing add-on attachments for an app.

Parameters:

  • app_id_or_app_name:

    unique identifier of app or unique name of app


712
713
714
# File 'lib/platform-api/client.rb', line 712

def list_by_app(app_id_or_app_name)
  @client.addon_attachment.list_by_app(app_id_or_app_name)
end