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 Team

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ WhitelistedAddonService

Returns a new instance of WhitelistedAddonService.



3574
3575
3576
# File 'lib/platform-api/client.rb', line 3574

def initialize(client)
  @client = client
end

Instance Method Details

#create_by_team(team_name_or_team_id, body = {}) ⇒ Object

Whitelist an Add-on Service

Parameters:

  • team_name_or_team_id:

    unique name of team or unique identifier of team

  • body:

    the object to pass as the request payload



3589
3590
3591
# File 'lib/platform-api/client.rb', line 3589

def create_by_team(team_name_or_team_id, body = {})
  @client.whitelisted_addon_service.create_by_team(team_name_or_team_id, body)
end

#delete_by_team(team_name_or_team_id, whitelisted_addon_service_id_or_addon_service_name) ⇒ Object

Remove a whitelisted entity

Parameters:

  • team_name_or_team_id:

    unique name of team or unique identifier of team

  • whitelisted_addon_service_id_or_addon_service_name:

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



3597
3598
3599
# File 'lib/platform-api/client.rb', line 3597

def delete_by_team(team_name_or_team_id, whitelisted_addon_service_id_or_addon_service_name)
  @client.whitelisted_addon_service.delete_by_team(team_name_or_team_id, whitelisted_addon_service_id_or_addon_service_name)
end

#list_by_team(team_name_or_team_id) ⇒ Object

List all whitelisted Add-on Services for an Team

Parameters:

  • team_name_or_team_id:

    unique name of team or unique identifier of team



3581
3582
3583
# File 'lib/platform-api/client.rb', line 3581

def list_by_team(team_name_or_team_id)
  @client.whitelisted_addon_service.list_by_team(team_name_or_team_id)
end