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.



893
894
895
# File 'lib/platform-api/client.rb', line 893

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



900
901
902
# File 'lib/platform-api/client.rb', line 900

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



907
908
909
# File 'lib/platform-api/client.rb', line 907

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



914
915
916
# File 'lib/platform-api/client.rb', line 914

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



941
942
943
# 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

#listObject

List existing add-on attachments.



919
920
921
# File 'lib/platform-api/client.rb', line 919

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



926
927
928
# 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_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



933
934
935
# 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

#resolution(body = {}) ⇒ Object

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.

Parameters:

  • body:

    the object to pass as the request payload



948
949
950
# File 'lib/platform-api/client.rb', line 948

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