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.


2558
2559
2560
# File 'lib/platform-api/client.rb', line 2558

def initialize(client)
  @client = client
end

Instance Method Details

#create(organization_name_or_organization_id, body = {}) ⇒ Object

Whitelist an Add-on Service

Parameters:

  • organization_name_or_organization_id:

    unique name of organization or unique identifier of organization

  • body:

    the object to pass as the request payload


2573
2574
2575
# File 'lib/platform-api/client.rb', line 2573

def create(organization_name_or_organization_id, body = {})
  @client.whitelisted_addon_service.create(organization_name_or_organization_id, body)
end

#delete(organization_name_or_organization_id, whitelisted_addon_service_id_or_addon_service_name) ⇒ Object

Remove a whitelisted entity

Parameters:

  • organization_name_or_organization_id:

    unique name of organization or unique identifier of organization

  • whitelisted_addon_service_id_or_addon_service_name:

    unique identifier for this whitelisting entity or unique name of this add-on-service


2581
2582
2583
# File 'lib/platform-api/client.rb', line 2581

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

#list(organization_name_or_organization_id) ⇒ Object

List all whitelisted Add-on Services for an Organization

Parameters:

  • organization_name_or_organization_id:

    unique name of organization or unique identifier of organization


2565
2566
2567
# File 'lib/platform-api/client.rb', line 2565

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