Class: PlatformAPI::Plan

Inherits:
Object
  • Object
show all
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 collapse

Constructor Details

#initialize(client) ⇒ Plan

Returns a new instance of Plan.


2176
2177
2178
# File 'lib/platform-api/client.rb', line 2176

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 add-on-service or unique name of this add-on-service

  • plan_id_or_plan_name:

    unique identifier of this plan or unique name of this plan


2184
2185
2186
# File 'lib/platform-api/client.rb', line 2184

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 add-on-service or unique name of this add-on-service


2191
2192
2193
# File 'lib/platform-api/client.rb', line 2191

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