Class: PlatformAPI::Plan

Inherits:

Object

• Object
• PlatformAPI::Plan

Defined in:

lib/platform-api/client.rb

Overview

Plans represent different configurations of add-ons that may be added to apps. Endpoints under add-on services can be accessed without authentication.

Instance Method Summary

• #info(addon_service_id_or_addon_service_name, plan_id_or_plan_name) ⇒ Object

  Info for existing plan.

• #initialize(client) ⇒ Plan constructor

  A new instance of Plan.

• #list(addon_service_id_or_addon_service_name) ⇒ Object

  List existing plans.

Constructor Details

#initialize(client) ⇒ Plan

Returns a new instance of Plan.

# File 'lib/platform-api/client.rb', line 2018

def initialize(client)
  @client = client
end

Instance Method Details

#info(addon_service_id_or_addon_service_name, plan_id_or_plan_name) ⇒ Object

Info for existing plan.

Parameters:

• addon_service_id_or_addon_service_name: —

  unique identifier of this addon-service or unique name of this addon-service

• plan_id_or_plan_name: —

  unique identifier of this plan or unique name of this plan

# File 'lib/platform-api/client.rb', line 2026

def info(addon_service_id_or_addon_service_name, plan_id_or_plan_name)
  @client.plan.info(addon_service_id_or_addon_service_name, plan_id_or_plan_name)
end

#list(addon_service_id_or_addon_service_name) ⇒ Object

List existing plans.

Parameters:

• addon_service_id_or_addon_service_name: —

  unique identifier of this addon-service or unique name of this addon-service

# File 'lib/platform-api/client.rb', line 2033

def list(addon_service_id_or_addon_service_name)
  @client.plan.list(addon_service_id_or_addon_service_name)
end