class PlatformAPI::Plan

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

Public Class Methods

new(client) click to toggle source
# File lib/platform-api/client.rb, line 2634
def initialize(client)
  @client = client
end

Public Instance Methods

info(plan_id_or_plan_name) click to toggle source

Info for existing plan.

@param plan_id_or_plan_name: unique identifier of this plan or unique name of this plan

# File lib/platform-api/client.rb, line 2641
def info(plan_id_or_plan_name)
  @client.plan.info(plan_id_or_plan_name)
end
info_by_addon(addon_service_id_or_addon_service_name, plan_id_or_plan_name) click to toggle source

Info for existing plan by Add-on.

@param addon_service_id_or_addon_service_name: unique identifier of this add-on-service or unique name of this add-on-service @param plan_id_or_plan_name: unique identifier of this plan or unique name of this plan

# File lib/platform-api/client.rb, line 2649
def info_by_addon(addon_service_id_or_addon_service_name, plan_id_or_plan_name)
  @client.plan.info_by_addon(addon_service_id_or_addon_service_name, plan_id_or_plan_name)
end
list_by_addon(addon_service_id_or_addon_service_name) click to toggle source

List existing plans by Add-on.

@param addon_service_id_or_addon_service_name: unique identifier of this add-on-service or unique name of this add-on-service

# File lib/platform-api/client.rb, line 2656
def list_by_addon(addon_service_id_or_addon_service_name)
  @client.plan.list_by_addon(addon_service_id_or_addon_service_name)
end