Class: PlatformAPI::WhitelistedAddonService

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

Overview

Entities that have been whitelisted to be used by an Organization

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ WhitelistedAddonService

Returns a new instance of WhitelistedAddonService.



2216
2217
2218
 
# File 'lib/platform-api/client.rb', line 2216

def initialize(client)
  @client = client
end

Instance Method Details

#create(organization_name, body) ⇒ Object

Whitelist an Add-on Service

Parameters:

  • organization_name: —

    unique name of organization

  • body: —

    the object to pass as the request payload



2231
2232
2233
 
# File 'lib/platform-api/client.rb', line 2231

def create(organization_name, body)
  @client.whitelisted_addon_service.create(organization_name, body)
end

#delete(organization_name, whitelisted_addon_service_id_or_addon_service_name) ⇒ Object

Remove a whitelisted entity

Parameters:

  • organization_name: —

    unique name of organization

  • whitelisted_addon_service_id_or_addon_service_name: —

    unique identifier for this whitelisting entity or unique name of this addon-service



2239
2240
2241
 
# File 'lib/platform-api/client.rb', line 2239

def delete(organization_name, whitelisted_addon_service_id_or_addon_service_name)
  @client.whitelisted_addon_service.delete(organization_name, whitelisted_addon_service_id_or_addon_service_name)
end

#list(organization_name) ⇒ Object

List all whitelisted Add-on Services for an Organization

Parameters:

  • organization_name: —

    unique name of organization



2223
2224
2225
 
# File 'lib/platform-api/client.rb', line 2223

def list(organization_name)
  @client.whitelisted_addon_service.list(organization_name)
end